From c75cfd387e5486f318254c215cf720b85740be13 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:37:40 -0400 Subject: [PATCH 01/35] Retire source-text tests - Delete 22 test classes whose assertions only read production .java text and check call ordering or literal presence - Remove 77 source-text assertion methods from 34 test classes that keep real behavioural coverage - Replace the core process-stream source grep with an ASM gate over compiled core classes in CoreProcessStreamPurityGateTest - Replace the packs-root source grep in PacksFolderContractTest with an ASM call-site gate over compiled core classes - Replace the IrisData registered-root regex in PackTypeBukkitPurityGateTest with an ASM scan of the registerLoader class constants - Trim six mixed tests down to their behavioural assertions and drop their source-text tails - Drop the eight iris.*Source and three iris.moddedCommonSources test system properties now that nothing reads them --- adapters/bukkit/plugin/build.gradle | 8 - .../iris/IrisDiagnosticLogLevelTest.java | 58 --- .../iris/core/IrisStartupOrderingTest.java | 72 --- .../core/IrisWorldGeneratorResolverTest.java | 98 ---- ...CommandDeveloperGenerationHistoryTest.java | 26 -- ...ommandIrisCreateOverwriteContractTest.java | 24 - .../CommandIrisDownloadContractTest.java | 17 - .../commands/CommandJigsawContractTest.java | 48 -- .../iris/core/link/IrisPapiExpansionTest.java | 16 - .../iris/core/link/IrisPapiLifecycleTest.java | 137 ------ .../runtime/StudioPlayerModeContractTest.java | 53 --- .../service/IrisApiWiringContractTest.java | 195 -------- adapters/fabric/build.gradle | 1 - adapters/forge/build.gradle | 1 - .../modded/IrisModLanguageAssetsTest.java | 12 +- .../IrisModdedChunkGeneratorSpawnTest.java | 21 - .../modded/IrisModdedStructureParityTest.java | 155 +------ ...ddedDynamicLevelLifecycleContractTest.java | 91 ---- .../ModdedGenerationBootstrapBindingTest.java | 64 --- ...dGenerationHistoryRoutingContractTest.java | 203 -------- .../ModdedGenerationLeaseContractTest.java | 244 ---------- .../ModdedIrisLogLevelCoverageTest.java | 58 --- .../modded/ModdedLevelDataAttachmentTest.java | 23 - .../ModdedLifecycleFailureContractTest.java | 436 ------------------ .../modded/ModdedSpawnerRarityParityTest.java | 37 -- ...StructurePlacementFailureContractTest.java | 30 -- .../ModdedStructureTemplateCacheTest.java | 15 +- .../iris/modded/ModdedWorldCheckTest.java | 29 -- .../NativeStructureFailureContractTest.java | 90 ---- .../IrisModdedStructureCommandTest.java | 183 -------- .../ModdedRiverLocateContractTest.java | 28 -- .../ModdedStructureHistoryContractTest.java | 34 -- .../ModdedStudioTeleportContractTest.java | 89 ---- adapters/neoforge/build.gradle | 1 - .../core/DiagnosticSeverityPolicyTest.java | 182 -------- .../art/arcane/iris/core/IrisWorldsTest.java | 22 - .../iris/core/ProgressBossBarToggleTest.java | 52 --- ...erConfiguratorDatapackFingerprintTest.java | 37 -- .../ServerConfiguratorStartupRestartTest.java | 34 -- .../iris/core/SettingsHotloadWatchTest.java | 18 - ...DatapackIngestRuntimeInvalidationTest.java | 51 -- .../datapack/DatapackIngestServiceTest.java | 56 --- .../WorldLifecycleUnloadAsyncTest.java | 36 -- .../core/link/MultiverseCoreLinkTest.java | 12 - .../iris/core/pack/PackExportClosureTest.java | 45 -- .../PregenMantleCleanupContractTest.java | 144 ------ .../runtime/StudioEntitySpawningTest.java | 29 -- .../StudioOpenCoordinatorOpenKindTest.java | 209 --------- ...enCoordinatorSpawnStuckRegressionTest.java | 24 - .../service/JigsawStudioLifecycleTest.java | 20 - .../PackDownloadProgressReporterTest.java | 20 - .../StudioSVCPackDownloadContractTest.java | 87 ---- ...tudioSVCWorldPackFeedbackContractTest.java | 35 -- .../StudioSVCWorldPackPublishTest.java | 62 --- ...isPersistentWorldCreationContractTest.java | 75 --- .../WorldCreationProgressReporterTest.java | 18 - .../EngineRuntimePublicationContractTest.java | 130 ------ .../EngineShutdownOwnershipContractTest.java | 74 --- ...ructureBootstrapLifecycleContractTest.java | 107 ----- ...tChunkGeneratorInitializationModeTest.java | 17 - .../CoreProcessStreamPurityGateTest.java | 91 ++++ .../purity/PackTypeBukkitPurityGateTest.java | 64 ++- .../iris/spi/PacksFolderContractTest.java | 115 ++++- .../specialhandlers/StructureHandlerTest.java | 31 -- .../scheduling/JRegionFutureContractTest.java | 24 - 65 files changed, 245 insertions(+), 4273 deletions(-) delete mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisStartupOrderingTest.java delete mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandDeveloperGenerationHistoryTest.java delete mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiLifecycleTest.java delete mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/runtime/StudioPlayerModeContractTest.java delete mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/service/IrisApiWiringContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedDynamicLevelLifecycleContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationHistoryRoutingContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationLeaseContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLifecycleFailureContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructurePlacementFailureContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedRiverLocateContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStructureHistoryContractTest.java delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStudioTeleportContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/core/DiagnosticSeverityPolicyTest.java delete mode 100644 core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestRuntimeInvalidationTest.java delete mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/methods/PregenMantleCleanupContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackFeedbackContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/core/tools/IrisPersistentWorldCreationContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/engine/EngineRuntimePublicationContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/engine/EngineShutdownOwnershipContractTest.java delete mode 100644 core/src/test/java/art/arcane/iris/engine/NativeStructureBootstrapLifecycleContractTest.java create mode 100644 core/src/test/java/art/arcane/iris/purity/CoreProcessStreamPurityGateTest.java delete mode 100644 core/src/test/java/art/arcane/iris/util/common/scheduling/JRegionFutureContractTest.java diff --git a/adapters/bukkit/plugin/build.gradle b/adapters/bukkit/plugin/build.gradle index f0ecff140..f0a3df139 100644 --- a/adapters/bukkit/plugin/build.gradle +++ b/adapters/bukkit/plugin/build.gradle @@ -59,12 +59,4 @@ tasks.named('jar', Jar).configure { } tasks.named('test').configure { - systemProperty('iris.pregeneratorJobSource', rootProject.file('core/src/main/java/art/arcane/iris/core/gui/PregeneratorJob.java').absolutePath) - systemProperty('iris.bukkitEnginePlatformHooksSource', file('src/main/java/art/arcane/iris/core/runtime/BukkitEnginePlatformHooks.java').absolutePath) - systemProperty('iris.engineSvcSource', file('src/main/java/art/arcane/iris/core/service/IrisEngineSVC.java').absolutePath) - systemProperty('iris.terrainSvcSource', file('src/main/java/art/arcane/iris/core/service/IrisTerrainSVC.java').absolutePath) - systemProperty('iris.apiEventSvcSource', file('src/main/java/art/arcane/iris/core/service/IrisApiEventSVC.java').absolutePath) - systemProperty('iris.worldInfoFactorySource', file('src/main/java/art/arcane/iris/core/service/terrain/IrisWorldInfoFactory.java').absolutePath) - systemProperty('iris.startupSource', file('src/main/java/art/arcane/iris/Iris.java').absolutePath) - systemProperty('iris.readmeSource', rootProject.file('README.md').absolutePath) } diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/IrisDiagnosticLogLevelTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/IrisDiagnosticLogLevelTest.java index e6842d9c1..2cd3c60c5 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/IrisDiagnosticLogLevelTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/IrisDiagnosticLogLevelTest.java @@ -3,14 +3,10 @@ package art.arcane.iris; import art.arcane.iris.spi.LogLevel; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.logging.Level; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertTrue; /** * Core states a severity on every message it logs and the modded adapters honour it. Bukkit must preserve @@ -33,58 +29,4 @@ public class IrisDiagnosticLogLevelTest { public void lifecycleNoticesReachThePluginLoggerAtInfo() { assertEquals(Level.INFO, Iris.diagnosticLevel(LogLevel.NOTICE)); } - - @Test - public void adapterSideWarningsCarryTheSameSeverityAsCoreWarnings() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/Iris.java")).replace("\r\n", "\n"); - - String warn = method(source, "public static void warn(String format, Object... objs)"); - assertTrue(warn, warn.contains("diagnostic(Level.WARNING")); - assertFalse(warn, warn.contains("msg(")); - - String error = method(source, "public static void error(String format, Object... objs)"); - assertTrue(error, error.contains("diagnostic(Level.SEVERE")); - assertFalse(error, error.contains("msg(")); - } - - @Test - public void theCoreLogBridgeRoutesDiagnosticsToThePluginLogger() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/Iris.java")).replace("\r\n", "\n"); - String bridge = method(source, "private static void bridgeLog(LogLevel level, String message)"); - - assertTrue(bridge, bridge.contains("diagnosticLevel(target)")); - assertTrue(bridge, bridge.contains("diagnostic(diagnostic, message)")); - String diagnostic = method(source, "private static void diagnostic(Level level, String message)"); - assertTrue(diagnostic, diagnostic.contains("ComponentLog.log(")); - assertTrue(diagnostic, diagnostic.contains("ComponentText.literal(line)")); - } - - @Test - public void informationalMessagesUseTheSharedComponentLogger() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/Iris.java")).replace("\r\n", "\n"); - String message = method(source, "public static void msg(String string)"); - - assertTrue(message, message.contains("ComponentLog.logMarkup(")); - assertTrue(message, message.contains("logPrefix(plugin)")); - assertFalse(message, message.contains("getSender().sendMessage")); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("method not found: " + signature, start >= 0); - int open = source.indexOf('{', start); - int depth = 0; - for (int i = open; i < source.length(); i++) { - char c = source.charAt(i); - if (c == '{') { - depth++; - } else if (c == '}') { - depth--; - if (depth == 0) { - return source.substring(start, i + 1); - } - } - } - throw new AssertionError("unterminated method: " + signature); - } } diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisStartupOrderingTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisStartupOrderingTest.java deleted file mode 100644 index 00365eba2..000000000 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisStartupOrderingTest.java +++ /dev/null @@ -1,72 +0,0 @@ -package art.arcane.iris.core; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertTrue; - -public class IrisStartupOrderingTest { - @Test - public void admissionGateIsRegisteredBeforeStartupValidationBegins() throws Exception { - String source = Files.readString(Path.of(System.getProperty("iris.startupSource"))); - String onEnable = section(source, "public void onEnable()", "public void onDisable()"); - - assertOrdered(onEnable, - "IrisStartupValidation.begin();", - "registerEvents(new IrisStartupAdmissionListener(), this);", - "enable();"); - } - - @Test - public void externalDatapacksValidateBeforeDimensionPacks() throws Exception { - String source = Files.readString(Path.of(System.getProperty("iris.startupSource"))); - String enable = section(source, "private boolean enable()", "public void addShutdownHook()"); - - assertOrdered(enable, - "DatapackIngestService.validateOnStartup();", - "generatorResolver.validateAllPacks();"); - } - - @Test - public void externalProvidersEnableBeforePackValidation() throws Exception { - String source = Files.readString(Path.of(System.getProperty("iris.startupSource"))); - String enable = section(source, "private boolean enable()", "public void addShutdownHook()"); - - assertOrdered(enable, - "service.onEnable();", - "setContentChangeListener(generatorResolver::requestExternalContentRefresh)", - "generatorResolver.validateAllPacks();"); - } - - @Test - public void restartRequiredStartupTerminatesAfterPluginInitialization() throws Exception { - String source = Files.readString(Path.of(System.getProperty("iris.startupSource"))); - String onEnable = section(source, "public void onEnable()", "public void onDisable()"); - - assertOrdered(onEnable, - "BukkitGuiHost.install();", - "super.onEnable();", - "IrisStartupValidation.isRestartRequired()", - "ServerConfigurator.restartAtStartupBoundary(restartReason);"); - } - - private static String section(String source, String startMarker, String endMarker) { - int start = source.indexOf(startMarker); - int end = source.indexOf(endMarker, start); - assertTrue("Missing source section starting with " + startMarker, start >= 0); - assertTrue("Missing source section ending with " + endMarker, end > start); - return source.substring(start, end); - } - - private static void assertOrdered(String source, String... markers) { - int previous = -1; - for (String marker : markers) { - int current = source.indexOf(marker); - assertTrue("Missing source marker " + marker, current >= 0); - assertTrue("Source marker is out of order: " + marker, current > previous); - previous = current; - } - } -} diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisWorldGeneratorResolverTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisWorldGeneratorResolverTest.java index 4b57daca7..72c15df4a 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisWorldGeneratorResolverTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/IrisWorldGeneratorResolverTest.java @@ -140,23 +140,6 @@ public class IrisWorldGeneratorResolverTest { } } - @Test - public void startupValidationPublishesFingerprintBoundExactRootResults() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java")).replace("\r\n", "\n"); - int validateAll = source.indexOf("public void validateAllPacks()"); - int snapshot = source.indexOf("ServerConfigurator.computePackContentSnapshot(packsRoot)", validateAll); - int perPackFingerprint = source.indexOf("contentSnapshot.packContents()", snapshot); - int exactRootPublish = source.indexOf( - "PackValidationRegistry.publish(packDirectory.toPath(), result, packFingerprint)", - perPackFingerprint); - - assertTrue(validateAll >= 0); - assertTrue(snapshot > validateAll); - assertTrue(perPackFingerprint > snapshot); - assertTrue(exactRootPublish > perPackFingerprint); - } - @Test public void paperStartupAliasResolvesToCanonicalRuntimeKey() throws Exception { File levelRoot = ownedLevelRoot("startup-alias", "moon"); @@ -251,87 +234,6 @@ public class IrisWorldGeneratorResolverTest { return levelRoot; } - @Test - public void configuredWorldResolutionUsesOnlyActiveImmutableGenerationPack() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java")).replace("\r\n", "\n"); - int resolverStart = source.indexOf("private ChunkGenerator resolveFrozenWorldGenerator("); - int resolverEnd = source.indexOf("private record FreshValidation", resolverStart); - String resolver = source.substring(resolverStart, resolverEnd); - - int dimensionRoot = resolver.indexOf("IrisWorldStorage.requireFrozenDimensionRoot("); - int currentPlatformRoot = resolver.indexOf("WorldCreatorCompat.persistentDimensionRoot(worldKey)"); - int layoutRefusal = resolver.indexOf( - "Frozen Iris world storage does not match the current platform layout", - currentPlatformRoot - ); - int history = resolver.indexOf("requireGenerationHistory(dimensionRoot, id, worldSeed)"); - int snapshotRoot = resolver.indexOf("requireActivePack(history)", history); - int validation = resolver.indexOf("requireSnapshotLoadable(snapshotRoot)"); - int exactLoad = resolver.indexOf("requireHistoricalDimension(history, snapshotRoot, id)"); - int canonicalIdentity = resolver.indexOf(".platformIdentity(worldKey.toString())"); - int historicalSeed = resolver.indexOf(".seed(history.activeEpoch().worldSeed())"); - int resolvedStorage = resolver.indexOf(".worldFolder(dimensionRoot)"); - - assertTrue(dimensionRoot >= 0); - assertTrue(currentPlatformRoot > dimensionRoot); - assertTrue(layoutRefusal > currentPlatformRoot); - assertTrue(history > layoutRefusal); - assertTrue(snapshotRoot > history); - assertTrue(validation > snapshotRoot); - assertTrue(exactLoad > validation); - assertTrue(canonicalIdentity > exactLoad); - assertTrue(historicalSeed > canonicalIdentity); - assertTrue(resolvedStorage > historicalSeed); - assertFalse(resolver.contains("loadDimension(")); - assertFalse(resolver.contains("loadAnyDimension(")); - assertFalse(resolver.contains("replaceIntoWorld(")); - assertFalse(resolver.contains("installIntoWorld(")); - assertFalse(resolver.contains(".seed(1337)")); - assertTrue(resolver.contains("GenerationHistory.openIfPresent(root, worldSeed)")); - assertTrue(resolver.contains("GenerationHistory.adoptLegacyPack(")); - assertTrue(resolver.contains("GenerationRegistryContractFactory.captureRequiredDefinitions(")); - } - - @Test - public void ownedWorldSnapshotFailureStopsStartupAndRethrows() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java")).replace("\r\n", "\n"); - int resolverStart = source.indexOf("public ChunkGenerator resolveDefaultWorldGenerator("); - int resolverEnd = source.indexOf("private ChunkGenerator resolveFrozenWorldGenerator(", resolverStart); - String resolver = source.substring(resolverStart, resolverEnd); - - int plotSquaredProbe = resolver.indexOf("isPlotSquaredGeneratorDiscoveryProbe(worldName, id)"); - int probe = resolver.indexOf("isGeneratorDiscoveryProbe(worldName, id)", plotSquaredProbe); - int denial = resolver.indexOf("IrisStartupValidation.denialReason()", probe); - int failClosed = resolver.indexOf("IrisFailClosedChunkGenerator.startupLock(", denial); - int staged = resolver.indexOf("WorldLifecycleStaging.consumeGenerator(worldName)", failClosed); - int duplicateGuard = resolver.indexOf("requireWorldKeyAvailable(worldName, worldKey)"); - int ownership = resolver.indexOf("requireOwnedWorld(worldName, levelRoot, worldKey)"); - int frozen = resolver.indexOf("return resolveFrozenWorldGenerator(", ownership); - int failureCapture = resolver.indexOf("catch (RuntimeException failure)", frozen); - int report = resolver.indexOf("Iris.reportError(", failureCapture); - int shutdown = resolver.indexOf("Bukkit.shutdown()", report); - int rethrow = resolver.indexOf("throw failure", shutdown); - - assertTrue(plotSquaredProbe >= 0); - assertTrue(probe > plotSquaredProbe); - assertTrue(denial > probe); - assertTrue(failClosed > denial); - assertTrue(staged > failClosed); - assertTrue(duplicateGuard > staged); - assertTrue(ownership > duplicateGuard); - assertTrue(frozen > ownership); - assertTrue(failureCapture > frozen); - assertTrue(report > failureCapture); - assertTrue(shutdown > report); - assertTrue(rethrow > shutdown); - - String shutdownScope = "the fail-fast shutdown must stay scoped to the frozen snapshot of an owned world"; - assertEquals(shutdownScope, resolverStart + shutdown, source.indexOf("Bukkit.shutdown()")); - assertEquals(shutdownScope, resolverStart + shutdown, source.lastIndexOf("Bukkit.shutdown()")); - } - @Test public void plotSquaredDiscoveryProbeIsIgnoredQuietly() { try (MockedStatic bukkit = mockStatic(Bukkit.class); diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandDeveloperGenerationHistoryTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandDeveloperGenerationHistoryTest.java deleted file mode 100644 index c2308b371..000000000 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandDeveloperGenerationHistoryTest.java +++ /dev/null @@ -1,26 +0,0 @@ -package art.arcane.iris.core.commands; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public final class CommandDeveloperGenerationHistoryTest { - @Test - public void updateWorldStagesThePackWithTheLiveWorldSeed() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandDeveloper.java" - )).replace("\r\n", "\n"); - int updateStart = source.indexOf("public void updateWorld("); - int updateEnd = source.indexOf("@Director(description = \"Test\"", updateStart); - String update = source.substring(updateStart, updateEnd); - - assertTrue(update.contains( - "replaceIntoWorld(sender(), pack, folder, world.getSeed())" - )); - assertFalse(update.contains("iris/pack")); - } -} diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisCreateOverwriteContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisCreateOverwriteContractTest.java index 70fcb612b..1ad9b1891 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisCreateOverwriteContractTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisCreateOverwriteContractTest.java @@ -7,8 +7,6 @@ import org.junit.Test; import java.lang.reflect.Method; import java.lang.reflect.Parameter; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.Arrays; import static org.junit.Assert.assertEquals; @@ -73,26 +71,4 @@ public class CommandIrisCreateOverwriteContractTest { assertEquals(Long.valueOf(Long.MAX_VALUE), handler.parse(Long.toString(Long.MAX_VALUE), false)); assertThrows(DirectorParsingException.class, () -> handler.parse("9223372036854775808", false)); } - - @Test - public void createAndReplaceUseLocalizedStyledMissingDimensionFeedback() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandIris.java" - )).replace("\r\n", "\n"); - - assertEquals(2, occurrences(source, "COMMAND_IRIS_DIMENSION_NOT_FOUND")); - assertEquals(2, occurrences(source, "COMMAND_IRIS_INSTALL_PACK_AND_RESTART")); - assertFalse(source.contains("sendMessage(\"Could not find dimension")); - assertFalse(source.contains("sendMessage(\"Install its pack with")); - } - - private static int occurrences(String value, String match) { - int count = 0; - int offset = 0; - while ((offset = value.indexOf(match, offset)) >= 0) { - count++; - offset += match.length(); - } - return count; - } } diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisDownloadContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisDownloadContractTest.java index 7de9dff59..6cf1bb112 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisDownloadContractTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandIrisDownloadContractTest.java @@ -5,13 +5,10 @@ import org.junit.Test; import java.lang.reflect.Method; import java.lang.reflect.Parameter; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.Arrays; import java.util.List; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; @@ -47,20 +44,6 @@ public class CommandIrisDownloadContractTest { assertThrows(Exception.class, () -> handler.parse("custom", false)); } - @Test - public void commandDelegatesAcceptedDownloadsWithoutRawPreamble() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandIris.java" - )).replace("\r\n", "\n"); - String download = method(source, "public void download("); - - assertTrue(download.contains("downloadBuiltIn(sender(), builtInPack)")); - assertTrue(download.contains("downloadUrl(sender(), directLink)")); - assertFalse(download.contains("Downloading built-in Iris pack")); - assertFalse(download.contains("Downloading Iris pack from")); - assertFalse(download.contains("sendMessage(directLink")); - } - private static String method(String source, String signature) { int start = source.indexOf(signature); assertTrue(start >= 0); diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java index 36965b6bc..58e5a00b3 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java @@ -115,21 +115,6 @@ public class CommandJigsawContractTest { new IllegalStateException("Unexpected Studio failure"))); } - @Test - public void committedActivationStartsInitialEvaluationBeforePlayerBinding() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java")).replace("\r\n", "\n"); - int commit = source.indexOf("JigsawStudioActivation.commit(staged)"); - int evaluation = source.indexOf( - "studioService.activationCommitted(world, request.requestId())", - commit); - int binding = source.indexOf("PLAYER_PACKS.put", evaluation); - - assertTrue(commit >= 0); - assertTrue(evaluation > commit); - assertTrue(binding > evaluation); - } - @Test public void convertIsAddOnlyWorkflowWithAliasesAndDefaults() throws Exception { Method convert = CommandJigsaw.class.getDeclaredMethod( @@ -358,20 +343,6 @@ public class CommandJigsawContractTest { .getAnnotation(Director.class)); } - @Test - public void pieceCreateUsesResolvedWorkcellCapacityInsteadOfLayoutDefault() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java")).replace("\r\n", "\n"); - int pieceCommands = source.indexOf("public static class CommandJigsawPiece"); - int create = source.indexOf("public void create(", pieceCommands); - int add = source.indexOf("public void add(", create); - String createSource = source.substring(create, add); - - assertTrue(createSource.contains("targetWorkcell = contextual;")); - assertTrue(createSource.contains("JigsawStudioCellDimensions dimensions = targetWorkcell.capacity();")); - assertFalse(createSource.contains("layout().cellDimensions()")); - } - @Test public void pieceAddUsesCanonicalAxesForRotatedRectangularPlanarWorkcells() { JigsawStudioLayout layout = nonuniformPlanarLayout(); @@ -510,25 +481,6 @@ public class CommandJigsawContractTest { assertEquals(1, releases.get()); } - @Test - public void exportSourceAcquiresStudioLeaseBeforeStaticLeaseAndReleasesBothPaths() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java")).replace("\r\n", "\n"); - int serviceLease = source.indexOf("studioService.tryBeginExport(requestId, playerId)"); - int staticLease = source.indexOf("beginExport(playerId, destination)", serviceLease); - int dispatch = source.indexOf("J.a(() -> runExport(operation))", staticLease); - int schedulingRelease = source.indexOf("operation.lease().release()", dispatch); - int exporter = source.indexOf("new VanillaJigsawDatapackExporter().export(operation.request())", dispatch); - int completionRelease = source.indexOf("operation.lease().release()", exporter); - - assertTrue(serviceLease >= 0); - assertTrue(staticLease > serviceLease); - assertTrue(dispatch > staticLease); - assertTrue(schedulingRelease > dispatch); - assertTrue(exporter > schedulingRelease); - assertTrue(completionRelease > exporter); - } - private static void assertCommand(String name, Class... parameterTypes) throws Exception { Method method = CommandJigsaw.class.getDeclaredMethod(name, parameterTypes); assertNotNull(method.getAnnotation(Director.class)); diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiExpansionTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiExpansionTest.java index 5871fd757..633dad4b1 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiExpansionTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiExpansionTest.java @@ -7,8 +7,6 @@ import org.bukkit.OfflinePlayer; import org.bukkit.World; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import java.util.Locale; import java.util.UUID; @@ -212,20 +210,6 @@ public class IrisPapiExpansionTest { assertTrue(expansion.persist()); } - @Test - public void theReadmeDocumentsEveryPublishedKeyAndEveryRetiredOne() throws Exception { - String readme = Files.readString(Path.of(System.getProperty("iris.readmeSource"))); - - for (String key : PUBLISHED_KEYS) { - assertTrue("README must document %iris_" + key + "%", readme.contains("%iris_" + key + "%")); - } - - for (String retired : RETIRED_KEYS) { - assertTrue("README must carry the migration row for %iris_" + retired + "%", - readme.contains("%iris_" + retired + "%")); - } - } - @Test public void theTerrainServiceIsTheOnlyDoorIntoIris() { IrisTerrainService service = new FakeIrisTerrainService(); diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiLifecycleTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiLifecycleTest.java deleted file mode 100644 index 919fa76ea..000000000 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/link/IrisPapiLifecycleTest.java +++ /dev/null @@ -1,137 +0,0 @@ -package art.arcane.iris.core.link; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class IrisPapiLifecycleTest { - private static final Path PLUGIN_SOURCE = Path.of("src/main/java/art/arcane/iris/Iris.java"); - private static final String SETUP = "private void setupPapi() {"; - private static final String TEARDOWN = "private void teardownPapi() {"; - - private static String source() throws Exception { - // The assertions below match against literals written with \n, so a CRLF checkout has to - // be folded first or every multi-line expectation misses. - return Files.readString(PLUGIN_SOURCE).replace("\r\n", "\n"); - } - - private static String body(String declaration) throws Exception { - String source = source(); - int start = source.indexOf(declaration); - - assertTrue("Iris.java must declare " + declaration, start >= 0); - - int open = source.indexOf('{', start); - int depth = 0; - - for (int index = open; index < source.length(); index++) { - char character = source.charAt(index); - - if (character == '{') { - depth++; - continue; - } - - if (character != '}') { - continue; - } - - depth--; - - if (depth == 0) { - return source.substring(open + 1, index); - } - } - - throw new AssertionError(declaration + " is not brace balanced"); - } - - @Test - public void registrationIsGatedOnPlaceholderApiBeingEnabled() throws Exception { - assertTrue("setupPapi must bail out when PlaceholderAPI is absent", - body(SETUP).contains("if (!PlaceholderRegistration.isPlaceholderApiEnabled()) {")); - } - - @Test - public void theRegistrationTheListenerAndTheStateAreAllRetained() throws Exception { - String source = source(); - - assertTrue(source.contains("private volatile PlaceholderRegistration papiRegistration;")); - assertTrue(source.contains("private volatile IrisPapiListener papiListener;")); - assertTrue(source.contains("private volatile IrisPapiState papiState;")); - } - - @Test - public void teardownUnregistersTheExpansionTheListenerAndClearsTheState() throws Exception { - String teardown = body(TEARDOWN); - - assertTrue("the retained registration must be unregistered inside teardownPapi", - teardown.contains("registration.unregister();")); - assertTrue("the retained listener must be detached inside teardownPapi", - teardown.contains("HandlerList.unregisterAll(listener);")); - assertTrue("the retained state must drop every held world reference inside teardownPapi", - teardown.contains("state.clear();")); - assertTrue("teardownPapi must drop the retained listener", teardown.contains("papiListener = null;")); - assertTrue("teardownPapi must drop the retained registration", teardown.contains("papiRegistration = null;")); - assertTrue("teardownPapi must drop the retained state", teardown.contains("papiState = null;")); - } - - @Test - public void bothDisablePathsTearThePlaceholderSurfaceDown() throws Exception { - String disable = body("public void onDisable() {"); - String preUnload = body("public void onPreUnload(ReloadAware.PreUnloadReason reason) {"); - int disableTeardown = disable.indexOf("teardownPapi();"); - int preUnloadTeardown = preUnload.indexOf("teardownPapi();"); - - assertTrue("onDisable must tear the expansion down before branching into runtime shutdown", - disableTeardown >= 0 && disableTeardown < disable.indexOf("IrisToolbelt.isServerStopping()")); - assertTrue("the BileTools pre-unload hook must tear the expansion down before any shutdown branch", - preUnloadTeardown >= 0 && preUnloadTeardown < preUnload.indexOf("IrisToolbelt.isServerStopping()")); - } - - @Test - public void aFailedListenerAttachDoesNotLeaveTheExpansionRegistered() throws Exception { - String setup = body(SETUP); - int attach = setup.indexOf("registerEvents(listener, this)"); - - assertTrue("the listener must be attached inside setupPapi", attach >= 0); - - int rescue = setup.indexOf("} catch (Throwable failure) {", attach); - - assertTrue("the attach must be guarded inside setupPapi", rescue > attach); - - int rollback = setup.indexOf("registration.unregister();", rescue); - - assertTrue("a failed attach must roll the registration back inside setupPapi", rollback > rescue); - - int bail = setup.indexOf("return;", rollback); - - assertTrue("a failed attach must leave setupPapi", bail > rollback); - - int retained = setup.indexOf("papiRegistration = registration;"); - - assertTrue("setupPapi must retain the registration", retained > 0); - assertTrue("the registration may only be retained after a successful attach", retained > bail); - } - - @Test - public void theExpansionIsNeverConstructedFromAPluginStatic() throws Exception { - String setup = body(SETUP); - - assertFalse("the plugin class must not construct the expansion: that forces PlaceholderExpansion to load during enable and crashes a server without PlaceholderAPI", - setup.contains("new IrisPapiExpansion(")); - assertTrue("the expansion takes its state as a constructor argument, built inside the installer", - installerSource().contains("new IrisPapiExpansion(state, logger)")); - assertFalse("the hand rolled PlaceholderAPI presence check must be gone", - source().contains("isPluginEnabled(\"PlaceholderAPI\")")); - } - - private static String installerSource() throws Exception { - return java.nio.file.Files.readString(java.nio.file.Path.of( - "src/main/java/art/arcane/iris/core/link/IrisPapiInstaller.java")).replace("\r\n", "\n"); - } -} diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/runtime/StudioPlayerModeContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/runtime/StudioPlayerModeContractTest.java deleted file mode 100644 index 0e7eeba9d..000000000 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/runtime/StudioPlayerModeContractTest.java +++ /dev/null @@ -1,53 +0,0 @@ -package art.arcane.iris.core.runtime; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class StudioPlayerModeContractTest { - @Test - public void autoStartedStudioUsesSpectatorMode() throws IOException { - String plugin = Files.readString(Path.of("src/main/java/art/arcane/iris/Iris.java")).replace("\r\n", "\n"); - String commands = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandStudio.java")).replace("\r\n", "\n"); - - assertFalse(plugin.contains("GameMode.CREATIVE")); - assertFalse(commands.contains("GameMode.CREATIVE")); - assertTrue(plugin.contains("GameMode.SPECTATOR")); - } - - @Test - public void tpStudioUsesThePreparedCoordinatorEntry() throws IOException { - String commands = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandStudio.java")).replace("\r\n", "\n"); - int methodStart = commands.indexOf("public void tpstudio()"); - int methodEnd = commands.indexOf("\n @Director", methodStart); - String method = commands.substring(methodStart, methodEnd); - - assertTrue(method.contains("StudioSVC studioService = Iris.service(StudioSVC.class)")); - assertTrue(method.contains("studioService.teleportToActiveProject(player)")); - assertFalse(method.contains("setGameMode(")); - assertFalse(method.contains("getActiveProject()")); - assertFalse(method.contains("BukkitPlatform.teleportAsync")); - assertFalse(method.contains("BukkitWorldBinding.spawnLocation")); - } - - @Test - public void editingStudiosRemainCreative() throws IOException { - String objectCommands = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandObject.java")).replace("\r\n", "\n"); - String jigsawCommands = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java")).replace("\r\n", "\n"); - - assertTrue(objectCommands.contains("GameMode.CREATIVE")); - assertTrue(objectCommands.contains("StudioOpenCoordinator.StudioOpenKind.OBJECT")); - assertTrue(jigsawCommands.contains("GameMode.CREATIVE")); - assertFalse(objectCommands.contains("GameMode.SPECTATOR")); - assertFalse(jigsawCommands.contains("GameMode.SPECTATOR")); - } -} diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/service/IrisApiWiringContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/service/IrisApiWiringContractTest.java deleted file mode 100644 index cfadd6843..000000000 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/service/IrisApiWiringContractTest.java +++ /dev/null @@ -1,195 +0,0 @@ -package art.arcane.iris.core.service; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class IrisApiWiringContractTest { - @Test - public void theTerrainServiceRegistersOnBothRegistriesAndReleasesBoth() throws IOException { - String source = source("iris.terrainSvcSource"); - String onEnable = method(source, "public void onEnable()"); - String onDisable = method(source, "public void onDisable()"); - - assertTrue(onEnable.contains("Bukkit.getServicesManager().register(")); - assertTrue(onEnable.contains("IrisTerrainService.class")); - assertTrue(onEnable.contains("IrisServices.register(IrisTerrainService.class, this)")); - assertTrue(onDisable.contains("Bukkit.getServicesManager().unregister(IrisTerrainService.class, this)")); - assertTrue(onDisable.contains("IrisServices.remove(IrisTerrainService.class)")); - assertBefore(onDisable, "serviceEnabled.set(false)", "Bukkit.getServicesManager().unregister("); - } - - @Test - public void theTerrainServiceNeverForcesEngineInitialisationOrLoadsTheMantle() throws IOException { - String source = source("iris.terrainSvcSource"); - - assertFalse("isIrisWorld must not touch the generator", source.contains("IrisToolbelt")); - assertFalse("isIrisWorld must not touch the generator", source.contains(".touch(")); - assertFalse("terrain queries must not load mantle chunks", source.contains("getMantle()")); - assertFalse("terrain queries must not load mantle chunks", source.contains("getObjectsAt(")); - assertFalse("terrain queries must not load mantle chunks", source.contains("getPOIsAt(")); - assertFalse("terrain queries must not load mantle chunks", source.contains("getCaveOrMantleBiome(")); - assertFalse("terrain queries must never block", source.contains(".join()")); - assertFalse("terrain queries must never block", source.contains("synchronized")); - assertFalse("terrain queries must never block", source.contains("J.sfut(")); - } - - @Test - public void sampleColumnsBoundsTheQueryBeforeItWalksAndTreatsAThrowingSinkAsARefusal() throws IOException { - String sampleColumns = method(source("iris.terrainSvcSource"), - "public boolean sampleColumns(World world, IrisColumnQuery query, IrisColumnSink sink)"); - - assertBefore(sampleColumns, "IrisSampleLimits.withinLimits(", "IrisColumnWalk.walk("); - assertBefore(sampleColumns, "IrisColumnWalk.walk(", "catch (Throwable error)"); - assertTrue(sampleColumns.contains("reportSinkFault(world, error)")); - assertTrue(sampleColumns.contains("return false;")); - assertTrue("the walk must abort when the engine closes underneath it", - sampleColumns.contains("engine.isClosed()")); - } - - @Test - public void thePregeneratorDispatchesPhasesFromItsExistingTickAndNeverBlocksOnTheSink() throws IOException { - String source = source("iris.pregeneratorJobSource"); - String dispatch = method(source, "private void dispatchApiPhases(List phases)"); - - assertTrue(dispatch.contains("IrisServices.getOrNull(PregenApiSink.class)")); - assertTrue(dispatch.contains("catch (Throwable error)")); - assertBefore(dispatch, "sink.pregen(phase, progress)", "catch (Throwable error)"); - assertFalse(dispatch.contains(".join()")); - - assertTrue(method(source, "public void onTick(").contains("dispatchApiPhases(apiPhases.onTick(paused()))")); - assertTrue(method(source, "public void onSaving()").contains("dispatchApiPhases(apiPhases.onSaving())")); - assertTrue(method(source, "public void onClose()").contains("dispatchApiPhases(apiPhases.onClose(reachedTotal()))")); - } - - @Test - public void worldPhasesAreFiredOutsideTheRegistrationLock() throws IOException { - String source = source("iris.engineSvcSource"); - - String add = method(source, "private void add(World world)"); - assertBefore(add, "catch (RejectedExecutionException exception)", "phases.ready(world)"); - assertBefore(add, "registered = true;", "phases.ready(world)"); - - String remove = method(source, - "private boolean remove(World world, CompletionStage unloadBoundary)"); - assertBefore(remove, "registered = worlds.remove(world)", "phases.closing(world)"); - assertBefore(remove, "phases.closing(world)", - "deferCloseUntilWorldUnload(world, registered, closing, unloadBoundary)"); - } - - @Test - public void everyRegisteredWorldIsAnnouncedClosingWhenTheServiceShutsDown() throws IOException { - String onDisable = method(source("iris.engineSvcSource"), "public void onDisable()"); - - assertTrue("service shutdown must announce ENGINE_CLOSING for every registered world", - onDisable.contains("phases.closing(teardown.world())")); - assertBefore(onDisable, "worlds.clear()", "phases.closing(teardown.world())"); - assertBefore(onDisable, "phases.closing(teardown.world())", "shutdownAndDrain(activeService)"); - assertBefore(onDisable, "phases.closing(teardown.world())", - "startClose(teardown.registered(), teardown.closing())"); - } - - @Test - public void aReplacedEngineIsAnnouncedClosingBeforeTheRetryReRegistersTheWorld() throws IOException { - String add = method(source("iris.engineSvcSource"), "private void add(World world)"); - - assertBefore(add, "catch (RejectedExecutionException exception)", "phases.closing(world)"); - assertBefore(add, "phases.closing(world)", "retryRegistrationAfterClose(world, retryAfter)"); - assertBefore(add, "phases.closing(world)", "startClose(replaced, replacementClose)"); - } - - @Test - public void aWorldPhaseIsNeverConditionalOnAnotherServicesRegistration() throws IOException { - String source = source("iris.apiEventSvcSource"); - String fire = method(source, "public static void fireWorldPhase(World world, IrisWorldPhase phase)"); - - assertFalse("world lifecycle must not resolve a swappable service to build its payload", - fire.contains("IrisServices")); - assertFalse("world lifecycle must not resolve a swappable service to build its payload", - fire.contains("IrisTerrainService")); - assertTrue(fire.contains("deliver(new IrisWorldEngineEvent(world, phase, describe(world, phase)))")); - - String describe = method(source, "private static IrisWorldInfo describe(World world, IrisWorldPhase phase)"); - assertTrue(describe.contains("IrisWorldInfoFactory.forWorld(world)")); - assertTrue("an undescribable world must be reported, not swallowed", - describe.contains("IrisLogging.reportError(")); - assertTrue("an undescribable world must still deliver the phase", describe.contains("return null;")); - } - - @Test - public void aWorldPhaseRaisedFromAServerThreadIsDeliveredBeforeThatThreadMovesOn() throws IOException { - String deliver = method(source("iris.apiEventSvcSource"), "private static void deliver(Event event)"); - - assertBefore(deliver, "Bukkit.isPrimaryThread()", "Bukkit.getPluginManager().callEvent(event)"); - assertBefore(deliver, "Bukkit.getPluginManager().callEvent(event)", "Iris.callEvent(event)"); - } - - @Test - public void theWorldInfoFactoryNeverForcesEngineInitialisationOrLoadsTheMantle() throws IOException { - String source = source("iris.worldInfoFactorySource"); - - assertFalse("the factory must not touch the generator", source.contains("IrisToolbelt")); - assertFalse("the factory must not touch the generator", source.contains(".touch(")); - assertFalse("the factory must not load mantle chunks", source.contains("getMantle()")); - assertFalse("the factory must never block", source.contains(".join()")); - assertFalse("the factory must never block", source.contains("synchronized")); - assertTrue("the factory must refuse a closed engine", source.contains("engine.isClosed()")); - } - - @Test - public void theHotloadHookStillFiresTheLegacyEventAlongsideTheApiEvent() throws IOException { - String hook = method(source("iris.bukkitEnginePlatformHooksSource"), "public void fireHotloadEvent(Engine engine)"); - - assertBefore(hook, "new IrisEngineHotloadEvent(engine)", - "IrisApiEventSVC.fireWorldPhase(BukkitWorldBinding.world(engine.getWorld()), IrisWorldPhase.ENGINE_HOTLOADED)"); - } - - @Test - public void theEventServiceNeverLetsAThirdPartyFailureEscapeALifecyclePath() throws IOException { - String fire = method(source("iris.apiEventSvcSource"), - "public static void fireWorldPhase(World world, IrisWorldPhase phase)"); - - assertTrue(fire.contains("catch (Throwable error)")); - assertTrue(fire.contains("IrisLogging.reportError(")); - assertFalse(fire.contains("printStackTrace")); - } - - private static String source(String property) throws IOException { - String path = System.getProperty(property); - assertTrue("missing source property " + property, path != null && !path.isBlank()); - return Files.readString(Path.of(path)); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source contract token: " + first, firstIndex >= 0); - assertTrue("Missing source contract token: " + second, secondIndex >= 0); - assertTrue(first + " must occur before " + second, firstIndex < secondIndex); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("Missing source contract signature: " + signature, start >= 0); - int openBrace = source.indexOf('{', start); - assertTrue("Missing source contract method body: " + signature, openBrace >= 0); - int depth = 0; - for (int index = openBrace; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } -} diff --git a/adapters/fabric/build.gradle b/adapters/fabric/build.gradle index 8a914a412..8725b0e34 100644 --- a/adapters/fabric/build.gradle +++ b/adapters/fabric/build.gradle @@ -207,7 +207,6 @@ tasks.named('compileJava', JavaCompile).configure { } tasks.named('test').configure { - systemProperty('iris.moddedCommonSources', file('../modded-common/src/main/java').absolutePath) } loom { diff --git a/adapters/forge/build.gradle b/adapters/forge/build.gradle index 925193d05..68d7280ae 100644 --- a/adapters/forge/build.gradle +++ b/adapters/forge/build.gradle @@ -240,7 +240,6 @@ tasks.named('compileJava', JavaCompile).configure { } tasks.named('test').configure { - systemProperty('iris.moddedCommonSources', file('../modded-common/src/main/java').absolutePath) } processResources { diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModLanguageAssetsTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModLanguageAssetsTest.java index c11c983cd..12d0eea95 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModLanguageAssetsTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModLanguageAssetsTest.java @@ -73,15 +73,9 @@ public class IrisModLanguageAssetsTest { private Set resourceFiles() throws Exception { URL resource = IrisModLanguageAssetsTest.class.getClassLoader().getResource(ROOT); - Path directory; - if (resource != null && "file".equals(resource.getProtocol())) { - directory = Path.of(resource.toURI()); - } else { - String sources = System.getProperty("iris.moddedCommonSources"); - assertNotNull("Missing mod language resource directory and source root", sources); - directory = Path.of(sources).getParent() - .resolve("resources").resolve(ROOT); - } + assertNotNull("Missing mod language resource directory: " + ROOT, resource); + assertEquals("Mod language resources must resolve to a directory on disk", "file", resource.getProtocol()); + Path directory = Path.of(resource.toURI()); try (Stream paths = Files.list(directory)) { return paths .filter(Files::isRegularFile) diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedChunkGeneratorSpawnTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedChunkGeneratorSpawnTest.java index 23be3cd5f..9b2c34c5f 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedChunkGeneratorSpawnTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedChunkGeneratorSpawnTest.java @@ -9,13 +9,9 @@ import net.minecraft.world.level.biome.MobSpawnSettings; import org.junit.Test; import org.junit.BeforeClass; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; public class IrisModdedChunkGeneratorSpawnTest { @BeforeClass @@ -48,21 +44,4 @@ public class IrisModdedChunkGeneratorSpawnTest { assertEquals(explicitCow, entries.get(2).value()); assertEquals(3, entries.get(2).weight()); } - - @Test - public void vanillaChunkGenerationMobsUseTheVisibleBiomesVanillaDerivative() throws IOException { - Path sourcePath = Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedChunkGenerator.java"); - String source = Files.readString(sourcePath); - int spawnStart = source.indexOf("public void spawnOriginalMobs"); - int spawnEnd = source.indexOf("@Override", spawnStart + 1); - String spawn = source.substring(spawnStart, spawnEnd); - - assertTrue(spawn.contains("spawnTables.initializeVanillaSpawnBiomes(registry)")); - assertTrue(spawn.contains("structureBiomeSource.getVisibleSurfaceBiome(")); - assertTrue(spawn.contains("spawnTables.vanillaSpawnBiome(visibleBiome.value())")); - assertTrue(spawn.contains("NaturalSpawner.spawnMobsForChunkGeneration(")); - assertTrue(spawn.contains("new LegacyRandomSource(RandomSupport.generateUniqueSeed())")); - assertTrue(spawn.contains("random.setDecorationSeed(region.getSeed()")); - } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedStructureParityTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedStructureParityTest.java index 8fc284d9c..f8ae89eae 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedStructureParityTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/IrisModdedStructureParityTest.java @@ -14,9 +14,6 @@ import net.minecraft.server.Bootstrap; import org.junit.BeforeClass; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import java.util.Locale; import java.util.Set; @@ -64,16 +61,10 @@ public class IrisModdedStructureParityTest { } @Test - public void strongholdRingSearchSamplesOneQuartColumnPerChunk() throws IOException { + public void strongholdRingSearchSamplesOneQuartColumnPerChunk() { assertEquals(4, IrisModdedBiomeSource.horizontalBiomeSearchQuartStep(0, 112)); assertEquals(1, IrisModdedBiomeSource.horizontalBiomeSearchQuartStep(1, 112)); assertEquals(1, IrisModdedBiomeSource.horizontalBiomeSearchQuartStep(0, 111)); - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - assertTrue(source.contains("x, y, z, searchRadius, quartStep, allowed, random, false, sampler")); - assertTrue(source.contains( - "return super.findBiomeHorizontal(x, y, z, searchRadius, allowed, random, sampler)")); } @Test @@ -130,126 +121,12 @@ public class IrisModdedStructureParityTest { } @Test - public void visibleBiomeResolutionSelectsStackOwnershipBeforeHostCaves() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - int resolutionStart = source.indexOf("private BiomeResolution resolveBiomeResolution("); - int resolutionEnd = source.indexOf("private Holder resolveRequiredStructureBiome(", resolutionStart); - - assertTrue(resolutionStart >= 0); - assertTrue(resolutionEnd > resolutionStart); - String resolution = source.substring(resolutionStart, resolutionEnd); - - assertTrue(resolution.contains("resolveDimensionStackLayer(")); - assertTrue(resolution.contains("!stackLayer.terrainContext().isSelfReferencing()")); - assertTrue(resolution.indexOf("resolveDimensionStackLayer(") - < resolution.indexOf("boolean underground")); - assertTrue(resolution.contains("includeDimensionStack")); - assertTrue(resolution.contains( - "return resolveBiomeResolution(engine, quartX, quartY, quartZ, false)")); - assertTrue(source.contains("resolution.packName(), resolution.dimension(), customBiome.getId()")); - int helperStart = source.indexOf("private static IrisBiome resolveSurfaceStructureBiome("); - int helperEnd = source.indexOf("private static Set registeredBiomeKeys(", helperStart); - String helper = source.substring(helperStart, helperEnd); - assertTrue(helper.contains("engine.getComplex().getTrueBiomeStream().get(blockX, blockZ)")); - assertFalse(helper.contains("getDimensionStackContext()")); - assertFalse(helper.contains("getSurfaceBiome(")); - } - - @Test - public void stackBiomesAreVisibleButExcludedFromStructureReachability() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - - assertTrue(source.contains("return biomeKeySets().structureRequired()")); - assertTrue(source.contains("generatedBiomeKeys.addAll(keys.visibleRequired())")); - assertTrue(source.contains("collectStructureBiomeKeys(")); - assertTrue(source.contains("dimension.getReachableBiomes(() -> data)")); - } - - @Test - public void biomeLocatorSearchesTheVisibleStack() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - int start = source.indexOf("public Pair> findClosestBiome3d("); - int end = source.indexOf("private Holder getNoiseBiome(", start); - String method = source.substring(start, end); - - assertTrue(method.contains("modded_locate_visible_biome")); - assertTrue(method.contains("return super.findClosestBiome3d(")); - assertTrue(method.contains("collectVisibleBiomeHolders()")); - assertTrue(method.contains("QuartPos.toBlock(quartX), QuartPos.toBlock(quartZ)")); - assertTrue(method.contains("resolveVisibleBiome(")); - assertFalse(method.contains("Holder structureBiome = getNoiseBiome(")); - assertTrue(method.indexOf("tryAcquireGenerationLease(engine, \"modded_locate_visible_biome\")") - < method.indexOf("engine.getDimensionStackContext()")); - } - - @Test - public void surfaceSpawnBiomeUsesTheVisibleQuartCell() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - int start = source.indexOf("Holder getVisibleSurfaceBiome("); - int end = source.indexOf("boolean isStructureReachable(", start); - String method = source.substring(start, end); - - assertTrue(method.contains("QuartPos.fromBlock(blockX)")); - assertTrue(method.contains("QuartPos.toBlock(quartX)")); - assertTrue(method.contains("QuartPos.fromBlock(internalY + engine.getMinHeight())")); - assertTrue(method.contains("stackContext.getLayout(sampleX, sampleZ).surfaceLayer()")); - assertTrue(method.contains("visibleBiomeCache")); - assertTrue(method.contains("isBiomeCacheable(engine, sampleX, sampleZ)")); - assertTrue(method.indexOf("boolean cacheable = isBiomeCacheable(engine, sampleX, sampleZ)") - < method.indexOf("Engine.hostHeight(engine, sampleX, sampleZ, true)")); - assertCacheGuarded(method, "visibleBiomeCache"); - } - - @Test - public void temporaryNaturalBiomeAnswersAreNotMemoized() throws IOException { + public void temporaryNaturalBiomeAnswersAreNotMemoized() { Engine engine = mock(Engine.class); when(engine.answersFromNaturalTerrain(12, -8)).thenReturn(true); assertFalse(IrisModdedBiomeSource.isBiomeCacheable(engine, 12, -8)); when(engine.answersFromNaturalTerrain(12, -8)).thenReturn(false); assertTrue(IrisModdedBiomeSource.isBiomeCacheable(engine, 12, -8)); - - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/IrisModdedBiomeSource.java")); - int structureStart = source.indexOf("private Holder getNoiseBiome(Engine engine"); - int structureEnd = source.indexOf("Holder getVisibleNoiseBiome(", structureStart); - String structure = source.substring(structureStart, structureEnd); - assertTrue(structure.contains("QuartPos.toBlock(quartX)")); - assertTrue(structure.contains("QuartPos.toBlock(quartZ)")); - assertCacheGuarded(structure, "structureBiomeCache"); - - int visibleStart = source.indexOf( - "private Holder getVisibleNoiseBiomeWithActiveGenerationLease("); - int visibleEnd = source.indexOf("Holder getVisibleSurfaceBiome(", visibleStart); - String visible = source.substring(visibleStart, visibleEnd); - assertTrue(visible.contains("QuartPos.toBlock(quartX)")); - assertTrue(visible.contains("QuartPos.toBlock(quartZ)")); - assertCacheGuarded(visible, "visibleBiomeCache"); - - int predicateStart = source.indexOf("static boolean isBiomeCacheable("); - int predicateEnd = source.indexOf("static boolean isMonumentSurfaceBiomeQuery(", predicateStart); - String predicate = source.substring(predicateStart, predicateEnd); - assertTrue(predicate.contains("return !engine.answersFromNaturalTerrain(blockX, blockZ)")); - assertFalse(predicate.contains("getDimensionStackContext()")); - } - - @Test - public void importedFeaturesCollectOnlyHostOwnedStackCells() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedImportedFeatureStage.java")); - - assertTrue(source.contains("stackContext.getLayerAt(")); - assertTrue(source.contains("layer.terrainContext().isSelfReferencing()")); - assertTrue(source.contains("section.getBiomes().get(quartX, quartY, quartZ)")); } @Test @@ -281,17 +158,6 @@ public class IrisModdedStructureParityTest { assertTrue(recursiveKeys.contains("layers:sky/aurora")); } - @Test - public void biomeWriterDerivativeFallbackMatchesCanonicalRecursiveKeys() throws IOException { - String source = Files.readString(Path.of( - System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedBiomeWriter.java")); - - assertTrue(source.contains( - "key.equalsIgnoreCase(dimension.getCustomBiomeKey(custom.getId()))")); - assertFalse(source.contains("String dimensionLoadKey = key.substring(0, colon)")); - } - @Test public void structureStateRejectsBiomesOutsideThePackContract() { Set generated = Set.of("minecraft:deep_ocean", "minecraft:dark_forest"); @@ -410,21 +276,4 @@ public class IrisModdedStructureParityTest { public void initialEntitySpawnsUseThePaperCompletionMarker() { assertSame(MantleFlag.INITIAL_SPAWNED_MARKER, ModdedWorldManager.INITIAL_SPAWN_COMPLETION_FLAG); } - - private static void assertCacheGuarded(String method, String cacheName) { - int predicate = method.indexOf("boolean cacheable = isBiomeCacheable("); - int cache = method.indexOf("BiomeHolderTable cache = " + cacheName, predicate); - int read = method.indexOf("cache.get(", predicate); - int readGuard = method.lastIndexOf("if (cacheable)", read); - int write = method.indexOf("cache.put(", read); - int writeGuard = method.lastIndexOf("if (cacheable)", write); - - assertTrue(predicate >= 0); - assertTrue(cache >= 0); - assertTrue(read > predicate); - assertTrue(readGuard >= predicate); - assertTrue(write > read); - assertTrue(writeGuard > read); - } - } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedDynamicLevelLifecycleContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedDynamicLevelLifecycleContractTest.java deleted file mode 100644 index 2ba2ce090..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedDynamicLevelLifecycleContractTest.java +++ /dev/null @@ -1,91 +0,0 @@ -package art.arcane.iris.modded; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertTrue; - -public class ModdedDynamicLevelLifecycleContractTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - - @Test - public void sharedManagerPublishesDynamicLoadAndUnloadAroundRegistration() throws IOException { - String manager = commonSource("ModdedDimensionManager.java"); - String loader = commonSource("ModdedLoader.java"); - String injection = method(manager, "private static Handle inject("); - String removal = method(manager, "public static boolean remove("); - String injectionRollback = method(manager, "private static void rollbackInjection("); - String removalRollback = method(manager, "private static void rollbackRemoval("); - - assertTrue(loader.contains("void fireDynamicLevelLoad(MinecraftServer server, ServerLevel level);")); - assertTrue(loader.contains("void fireDynamicLevelUnload(MinecraftServer server, ServerLevel level);")); - assertBefore(injection, "serverAccess.putLevelIfAbsent(server, key, level);", - "fireDynamicLevelLoad(server, level);"); - assertBefore(removal, "fireDynamicLevelUnload(server, level);", - "serverAccess.removeLevel(server, key);"); - assertTrue(injectionRollback.contains("fireDynamicLevelUnload(server, level);")); - assertTrue(removalRollback.contains("fireDynamicLevelLoad(server, level);")); - } - - @Test - public void everyLoaderUsesItsNativeLifecycleBus() throws IOException { - String fabric = loaderSource("fabric", "art/arcane/iris/fabric/FabricModdedLoader.java"); - String forge = loaderSource("forge", "art/arcane/iris/forge/ForgeModdedLoader.java"); - String neoForge = loaderSource("neoforge", "art/arcane/iris/neoforge/NeoForgeModdedLoader.java"); - - assertTrue(fabric.contains("ServerLevelEvents.LOAD.invoker().onLevelLoad(server, level);")); - assertTrue(fabric.contains("ServerLevelEvents.UNLOAD.invoker().onLevelUnload(server, level);")); - assertTrue(forge.contains("LevelEvent.Load.BUS.post(new LevelEvent.Load(level));")); - assertTrue(forge.contains("LevelEvent.Unload.BUS.post(new LevelEvent.Unload(level));")); - assertTrue(neoForge.contains("NeoForge.EVENT_BUS.post(new LevelEvent.Load(level));")); - assertTrue(neoForge.contains("NeoForge.EVENT_BUS.post(new LevelEvent.Unload(level));")); - } - - private static String commonSource(String file) throws IOException { - return Files.readString(commonRoot().resolve("art/arcane/iris/modded").resolve(file)) - .replace("\r\n", "\n"); - } - - private static String loaderSource(String loader, String relative) throws IOException { - Path adaptersRoot = commonRoot().getParent().getParent().getParent().getParent(); - return Files.readString(adaptersRoot.resolve(loader).resolve("src/main/java").resolve(relative)) - .replace("\r\n", "\n"); - } - - private static Path commonRoot() { - String root = System.getProperty(SOURCE_ROOT_PROPERTY); - if (root == null || root.isBlank()) { - throw new IllegalStateException("Missing test property " + SOURCE_ROOT_PROPERTY); - } - return Path.of(root); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - if (start < 0) { - throw new IllegalArgumentException("Missing source method " + signature); - } - int open = source.indexOf('{', start); - int depth = 0; - for (int index = open; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}' && --depth == 0) { - return source.substring(start, index + 1); - } - } - throw new IllegalArgumentException("Unclosed source method " + signature); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source token " + first, firstIndex >= 0); - assertTrue("Missing source token " + second, secondIndex >= 0); - assertTrue(first + " must precede " + second, firstIndex < secondIndex); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationBootstrapBindingTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationBootstrapBindingTest.java index e53978e84..c45012ffe 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationBootstrapBindingTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationBootstrapBindingTest.java @@ -7,12 +7,8 @@ import net.minecraft.world.level.Level; import net.minecraft.world.level.chunk.ChunkGenerator; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; -import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertThrows; @@ -24,8 +20,6 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class ModdedGenerationBootstrapBindingTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - @Test public void publishedLevelRequiresCurrentGeneratorIdentity() { IrisModdedChunkGenerator generator = mock(IrisModdedChunkGenerator.class, CALLS_REAL_METHODS); @@ -89,62 +83,4 @@ public class ModdedGenerationBootstrapBindingTest { assertSame(dynamicLevel, generator.resolveBoundLevel(server, List.of(dynamicLevel))); verify(server, never()).getLevel(Level.OVERWORLD); } - - @Test - public void firstGenerationStagesProvideAuthoritativeLevelContext() throws IOException { - String source = source("IrisModdedChunkGenerator.java"); - String structures = method(source, "public void createStructures("); - String references = method(source, "public void createReferences("); - assertTrue(structures.contains("Engine current = engine(levelKey);")); - assertTrue(references.contains("Engine current = engine(level.getLevel());")); - - String publishedBinding = method(source, "private Engine engine(ResourceKey levelKey)"); - assertTrue(publishedBinding.contains("requirePublishedLevel(ModdedEngineBootstrap.currentServer(), levelKey)")); - assertTrue(publishedBinding.contains("return bindGenerationLevel(level);")); - assertFalse(publishedBinding.contains("ModdedServerLevels.level(")); - - String fullBinding = method(source, "private Engine bindGenerationLevel(ServerLevel level)"); - assertTrue(fullBinding.contains("bindLevel(level);")); - assertTrue(fullBinding.contains("Engine bound = readyEngine();")); - - String genericBinding = method(source, "Engine engine()"); - assertTrue(genericBinding.contains("return bindGenerationLevel(level);")); - } - - @Test - public void constructorMixinIsNotPartOfGenerationBootstrap() throws IOException { - String sourceRoot = System.getProperty(SOURCE_ROOT_PROPERTY); - assertTrue(sourceRoot != null && !sourceRoot.isBlank()); - Path root = Path.of(sourceRoot); - assertFalse(Files.exists(root.resolve(Path.of("art", "arcane", "iris", "modded", "mixin", - "ServerLevelBindingMixin.java")))); - String mixinConfig = Files.readString(root.getParent().resolve("resources/irisworldgen.entity.mixins.json")); - assertFalse(mixinConfig.contains("ServerLevelBindingMixin")); - } - - private String source(String fileName) throws IOException { - String sourceRoot = System.getProperty(SOURCE_ROOT_PROPERTY); - assertTrue(sourceRoot != null && !sourceRoot.isBlank()); - return Files.readString(Path.of(sourceRoot, "art", "arcane", "iris", "modded", fileName)); - } - - private String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue(start >= 0); - int body = source.indexOf('{', start); - assertTrue(body >= 0); - int depth = 0; - for (int index = body; index < source.length(); index++) { - char token = source.charAt(index); - if (token == '{') { - depth++; - } else if (token == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationHistoryRoutingContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationHistoryRoutingContractTest.java deleted file mode 100644 index 552b0bbae..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationHistoryRoutingContractTest.java +++ /dev/null @@ -1,203 +0,0 @@ -package art.arcane.iris.modded; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class ModdedGenerationHistoryRoutingContractTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - - @Test - public void startupPublishesOnlyAnImmutableHistoryBoundRuntime() throws IOException { - String source = source("ModdedWorldEngines.java"); - String create = method(source, "private static Engine create("); - String createHistoryEngine = method(source, "private static Engine createHistoryEngine("); - String buildEngine = method(source, "private static IrisEngine buildEngine("); - - assertTrue(create.contains("ModdedGenerationHistoryStorage.openOrAdopt(")); - assertFalse(create.contains("resolvePack(")); - assertTrue(createHistoryEngine.contains("candidate.attachGenerationHistory(")); - assertTrue(createHistoryEngine.contains("IrisBoundarySignatureSampler.INSTANCE")); - assertTrue(createHistoryEngine.contains("getGenerationTransitionWidthBlocks()")); - assertTrue(createHistoryEngine.contains("router.preloadActiveRuntimes();")); - assertBefore(createHistoryEngine, "history.prepareCurrentGenerator(", - "opened = ModdedGenerationHistoryStorage.resolveActive(history)"); - assertBefore(createHistoryEngine, "opened = ModdedGenerationHistoryStorage.resolveActive(history)", - "IrisEngine candidate = buildEngine(level, seed, opened)"); - String promoted = method(createHistoryEngine, - "if (history.activeActivation().activationId() != openedActivationId)"); - assertBefore(promoted, "close(candidate);", "ModdedGenerationHistoryStorage.resolveActive(history)"); - assertBefore(promoted, "ModdedGenerationHistoryStorage.resolveActive(history)", - "candidate = buildEngine(level, seed, promoted)"); - assertTrue(createHistoryEngine.contains("GenerationHistoryRuntimeRouter.attach(")); - assertTrue(buildEngine.contains("active.packRoot().toFile()")); - assertTrue(buildEngine.contains("history.paths().activationMantleRoot(activation.activationId())")); - assertTrue(buildEngine.contains("epoch.kernelVersion()")); - assertTrue(buildEngine.contains("transitionPlan")); - } - - @Test - public void onlyExplicitTransientStudioEnginesBypassHistory() throws IOException { - String manager = source("ModdedDimensionManager.java"); - String transientCreate = method(manager, "public static Handle createTransientStudio("); - String persistentCreate = method(manager, "public static Handle createPersistent("); - String engines = source("ModdedWorldEngines.java"); - String studio = method(engines, "private static IrisEngine createTransientStudioEngine("); - String generator = source("IrisModdedChunkGenerator.java"); - String bypass = method(generator, "boolean allowsGenerationHistoryBypass("); - String route = method(generator, "private GenerationHistoryRuntimeRouter.RuntimeRoute openHistoryRoute("); - - assertTrue(transientCreate.contains("ModdedGenerationMode.TRANSIENT_STUDIO")); - assertTrue(persistentCreate.contains("ModdedGenerationMode.PERSISTENT_CREATE")); - assertTrue(studio.contains("IrisData.openRuntime(packDir)")); - assertTrue(studio.contains("IrisEngine.InitializationMode.STUDIO")); - assertFalse(studio.contains("ModdedGenerationHistoryStorage")); - assertFalse(studio.contains("attachGenerationHistory(")); - assertTrue(bypass.contains("generationMode != ModdedGenerationMode.TRANSIENT_STUDIO")); - assertTrue(bypass.contains("irisEngine.isStudio()")); - assertTrue(bypass.contains("Only an explicitly transient Iris Studio engine")); - assertBefore(route, "allowsGenerationHistoryBypass(current)", "requireHistoryRouter(current, operation)"); - } - - @Test - public void everyCoordinateBearingChunkStageOpensItsRoutedRuntime() throws IOException { - String source = source("IrisModdedChunkGenerator.java"); - - assertRuntimeRoute(source, "public Pair> findNearestMapStructure("); - assertCoordinateRoute(source, "public WeightedList getMobsAt("); - assertRuntimeRoute(source, "public CompletableFuture createBiomes("); - assertRuntimeRoute(source, "public void applyCarvers("); - assertRuntimeRoute(source, "public void buildSurface("); - assertRuntimeRoute(source, "public void applyBiomeDecoration("); - assertRuntimeRoute(source, "public void createStructures("); - assertRuntimeRoute(source, "public void createReferences("); - assertRuntimeRoute(source, "public void spawnOriginalMobs("); - assertCoordinateRoute(source, "public int getBaseHeight("); - assertCoordinateRoute(source, "public NoiseColumn getBaseColumn("); - } - - @Test - public void asyncTerrainKeepsTheRouteUntilDurableSemanticClaim() throws IOException { - String source = source("IrisModdedChunkGenerator.java"); - String fill = method(source, "public CompletableFuture fillFromNoise("); - String terrain = method(source, "private ChunkAccess generateTerrain("); - String completion = method(source, "private static CompletableFuture closeRouteOnCompletion("); - - assertBefore(fill, "openHistoryRoute(", "CompletableFuture.supplyAsync("); - assertTrue(fill.contains("generateTerrain(chunk, generationEngine, pos, air, route)")); - assertTrue(fill.contains("return closeRouteOnCompletion(pipeline, route);")); - assertTrue(terrain.contains("openHistoryRuntimeScope(route)")); - assertBefore(terrain, "generationEngine.generate(", "writeBlocks(chunk, blocks, dimMinY, height)"); - assertBefore(terrain, "writeBlocks(chunk, blocks, dimMinY, height)", "route.claimGeneratedSemantics("); - assertTrue(terrain.contains("chunk.getBlockState(position.set(x, dimMinY + y, z))")); - assertTrue(terrain.contains("state.isAir() || state.liquid()")); - assertBefore(terrain, "route.claimGeneratedSemantics(", "ModdedNativeTerrainReceipts.persist(chunk, route)"); - assertBefore(terrain, "ModdedNativeTerrainReceipts.persist(chunk, route)", "return chunk;"); - assertTrue(completion.contains("pipeline.whenComplete(")); - assertTrue(completion.contains("route.close();")); - assertBefore(completion, "pipeline.whenComplete(", "route.detachThread()"); - assertBefore(completion, "route.detachThread()", "return completion;"); - } - - @Test - public void biomeQueriesRouteEachCoordinateAndKeepRuntimeSpecificCaches() throws IOException { - String source = source("IrisModdedBiomeSource.java"); - String structure = method(source, "public Holder getNoiseBiome("); - String visible = method(source, "Holder getVisibleNoiseBiome("); - String batch = method(source, "public Set> getBiomesWithin("); - String resolution = method(source, "private Holder resolveVisibleBiome("); - - assertTrue(structure.contains("openHistoryCoordinateScope(")); - assertTrue(visible.contains("openHistoryCoordinateScope(")); - assertTrue(batch.contains("quartX << 2, quartZ << 2")); - assertTrue(source.contains("int runtimeIdentity = engine.getCacheID();")); - assertTrue(source.contains("cache.get(runtimeIdentity, key)")); - assertTrue(source.contains("cache.put(runtimeIdentity, key, resolved)")); - assertBefore(resolution, "historicalPhysicalBiomeKeyAt(", "ModdedWorldgenIds.biomeRef(engine"); - } - - @Test - public void pendingNativeStagesPreserveSavedStartsAndGuardNewFeatureFootprints() throws IOException { - String generator = source("IrisModdedChunkGenerator.java"); - String discrete = method(generator, "private boolean allowsRoutedDiscreteGeneration("); - String decoration = method(generator, "public void applyBiomeDecoration("); - String structures = method(generator, "public void createStructures("); - String mobs = method(generator, "public void spawnOriginalMobs("); - String nativeStage = source("ModdedNativeStructureStage.java"); - String adjust = method(nativeStage, "void adjustGeneratedStructures("); - String place = method(nativeStage, "void placeVanillaStructures("); - String savedStart = method(nativeStage, "private boolean isHistoricalStructureStart("); - - assertTrue(discrete.contains("chunk.getPersistedStatus().isOrAfter(stage)")); - assertFalse(discrete.contains("router.history().activeActivation().activationId()")); - assertFalse(discrete.contains("return true;")); - assertTrue(discrete.contains("allowsNewGenerationChunk(")); - assertTrue(discrete.contains("NativeGenerationWriteGuard.allowsPendingStage(current, chunk, stage)")); - assertTrue(decoration.contains("ChunkStatus.FEATURES")); - assertTrue(structures.contains("ChunkStatus.STRUCTURE_STARTS")); - assertTrue(mobs.contains("ChunkStatus.SPAWN")); - assertBefore(decoration, "chunk.getPersistedStatus().isOrAfter(ChunkStatus.FEATURES)", - "nativeStructures.placeVanillaStructures("); - assertBefore(decoration, "nativeStructures.placeVanillaStructures(", "allowsRoutedDiscreteGeneration("); - assertBefore(decoration, "allowsRoutedDiscreteGeneration(", "importedFeatures.run("); - assertBefore(decoration, "NativeGenerationWriteGuard.allowsDecoration(", "importedFeatures.run("); - assertBefore(structures, "allowsRoutedDiscreteGeneration(", "super.createStructures("); - assertBefore(mobs, "allowsRoutedDiscreteGeneration(", "NaturalSpawner.spawnMobsForChunkGeneration("); - assertBefore(adjust, "allowsNewGenerationFootprint(", "recordWorldCheckStructureShift("); - assertBefore(place, "!isHistoricalStructureStart(current, world, start)", "allowsNewGenerationFootprint("); - assertTrue(savedStart.contains("world.getChunk(origin.x(), origin.z(), ChunkStatus.EMPTY, false)")); - assertTrue(savedStart.contains("ModdedNativeTerrainReceipts.structureActivation(source)")); - assertBefore(structures, "super.createStructures(", "ModdedNativeTerrainReceipts.persistStructureActivation("); - } - - private static void assertRuntimeRoute(String source, String signature) { - String body = method(source, signature); - assertTrue(signature + " must open a generation-history route", body.contains("openHistoryRoute(")); - assertTrue(signature + " must open its routed runtime", body.contains("openHistoryRuntimeScope(route)")); - } - - private static void assertCoordinateRoute(String source, String signature) { - String body = method(source, signature); - assertTrue(signature + " must route its coordinate", body.contains("openHistoryCoordinateScope(")); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source contract token: " + first, firstIndex >= 0); - assertTrue("Missing source contract token: " + second, secondIndex >= 0); - assertTrue(first + " must occur before " + second, firstIndex < secondIndex); - } - - private static String source(String fileName) throws IOException { - String sourceRoot = System.getProperty(SOURCE_ROOT_PROPERTY); - assertTrue("Missing system property " + SOURCE_ROOT_PROPERTY, - sourceRoot != null && !sourceRoot.isBlank()); - return Files.readString(Path.of(sourceRoot, "art", "arcane", "iris", "modded", fileName)); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("Missing source contract signature: " + signature, start >= 0); - int openBrace = source.indexOf('{', start); - assertTrue("Missing source contract method body: " + signature, openBrace >= 0); - int depth = 0; - for (int index = openBrace; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationLeaseContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationLeaseContractTest.java deleted file mode 100644 index 6bb7d329a..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedGenerationLeaseContractTest.java +++ /dev/null @@ -1,244 +0,0 @@ -package art.arcane.iris.modded; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class ModdedGenerationLeaseContractTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - - @Test - public void biomeRuntimeReadsAreGenerationLeased() throws IOException { - String source = source("art/arcane/iris/modded/IrisModdedBiomeSource.java"); - - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_structure_biome\")")); - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_visible_biome\")")); - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_biomes_within\")")); - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_structure_reachability\")")); - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_structure_state_biome\")")); - assertTrue(source.contains("tryAcquireGenerationLease(engine, \"modded_structure_biome_keys\")")); - assertTrue(source.contains("engine == null || engine.isClosed()")); - assertTrue(source.contains("catch (GenerationSessionException e)")); - assertTrue(source.contains("e.isExpectedTeardown()")); - assertTrue(source.contains("Iris structure biome key lookup was rejected during an engine transition")); - assertTrue(source.contains("int runtimeIdentity = engine.getCacheID();")); - assertTrue(source.contains("cache.get(runtimeIdentity, key)")); - assertTrue(source.contains("cache.put(runtimeIdentity, key, resolved)")); - } - - @Test - public void terrainAndHeightQueriesShareGenerationSessions() throws IOException { - String source = source("art/arcane/iris/modded/IrisModdedChunkGenerator.java"); - - assertTrue(source.contains("generationEngine.acquireGenerationLease(\"modded_chunk_pipeline\")")); - assertTrue(source.contains("current.acquireGenerationLease(\"modded_base_height\")")); - assertTrue(source.contains("current.acquireGenerationLease(\"modded_base_column\")")); - assertTrue(source.contains("current.acquireGenerationLease(\"modded_configured_biome_keys\")")); - assertTrue(source.contains("generationEngine.isClosing() || e.isExpectedTeardown()")); - String terrain = method(source, "private ChunkAccess generateTerrain("); - int sessionFailure = terrain.indexOf("catch (GenerationSessionException e)"); - int generalFailure = terrain.indexOf("catch (Throwable e)", sessionFailure); - String sessionHandler = terrain.substring(sessionFailure, generalFailure); - assertTrue(sessionHandler.contains("throw new IllegalStateException")); - assertFalse(sessionHandler.contains("return chunk;")); - - String references = method(source, "public void createReferences("); - assertTrue(references.contains("requireGenerationLease(current, \"modded_create_references\")")); - assertTrue(references.contains("IrisContext.open(current, lease.sessionId(), null)")); - assertTrue(references.contains("NativeStructureReferenceRepair.createReferences(")); - assertFalse(references.contains("super.createReferences(level, structureManager, chunk);")); - } - - @Test - public void preservationDereferencesSharedPackData() throws IOException { - String source = source("art/arcane/iris/modded/service/ModdedPreservationService.java"); - int dereference = source.indexOf("public void dereference()"); - int irisData = source.indexOf("IrisData.dereference();", dereference); - int trackedResources = source.indexOf("threads.removeIf", dereference); - - assertTrue(dereference >= 0); - assertTrue(irisData > dereference); - assertTrue(trackedResources > irisData); - } - - @Test - public void hotloadShutdownOnlyTargetsItsOwnWorld() throws IOException { - String source = source("art/arcane/iris/modded/service/ModdedStudioHotloadService.java"); - int shutdown = source.indexOf("public void shutdownPregenerator(Engine engine)"); - int nextMethod = source.indexOf("private boolean throttled", shutdown); - String method = source.substring(shutdown, nextMethod); - - assertTrue(method.contains("ModdedPregenJob.shutdownForWorld(world.identity());")); - assertFalse(method.contains("PregeneratorJob.shutdownInstance();")); - } - - @Test - public void maintenanceOwnsOneGenerationSessionUntilWorkCompletes() throws IOException { - String source = source("art/arcane/iris/modded/service/ModdedEngineMaintenanceService.java"); - String maintain = method(source, "private void maintain(Engine engine, long scheduledAt)"); - - assertTrue(maintain.contains("engine.acquireGenerationLease(\"modded_engine_maintenance\")")); - assertTrue(maintain.contains("IrisContext.open(engine, lease.sessionId(), null)")); - assertTrue(maintain.contains("exception.isExpectedTeardown()")); - assertTrue(source.contains("active.awaitTermination(INTERRUPT_DRAIN_TIMEOUT_SECONDS, TimeUnit.SECONDS)")); - } - - @Test - public void packDownloadAdmissionPrecedesAsyncDispatch() throws IOException { - String source = source("art/arcane/iris/modded/command/IrisModdedCommands.java"); - String download = method(source, "static int download(CommandSourceStack source, String rawRequest)"); - int admission = download.indexOf("LifecycleOperationCoordinator.get().acquire("); - int executionTracking = download.indexOf("new PackDownloadExecution("); - int dispatch = download.indexOf("scheduler.asyncIfRunning(execution, execution::cancel)"); - - assertTrue(admission >= 0); - assertTrue(executionTracking > admission); - assertTrue(dispatch > admission); - assertTrue(download.contains("execution.cancel();")); - - String execution = method(source, "private static void executeDownload("); - assertTrue(execution.contains("PackDownloader.DownloadCancellation cancellation")); - assertTrue(execution.contains("catch (PackDownloader.PackDownloadCancelledException error)")); - assertTrue(execution.contains("dispatchDownloadFeedback(source,")); - assertFalse(execution.contains("scheduler.global(")); - assertFalse(execution.contains("lease.close();")); - - String feedback = method(source, "private static void dispatchDownloadFeedback("); - assertTrue(feedback.contains("source.getServer().execute(feedback);")); - } - - @Test - public void packDownloadsDrainBeforeModdedSchedulerShutdown() throws IOException { - String commands = source("art/arcane/iris/modded/command/IrisModdedCommands.java"); - String shutdownDownloads = method(commands, "public static void shutdownDownloads()"); - assertTrue(shutdownDownloads.contains("downloadAdmissionOpen = false;")); - assertTrue(shutdownDownloads.contains("execution.cancel();")); - assertTrue(shutdownDownloads.contains("execution.await(")); - - String bootstrap = source("art/arcane/iris/modded/ModdedEngineBootstrap.java"); - String stop = method(bootstrap, "public static void stop()"); - int downloads = stop.indexOf("IrisModdedCommands::shutdownDownloads"); - int scheduler = stop.indexOf("scheduler::shutdown"); - assertTrue(downloads >= 0); - assertTrue(scheduler > downloads); - } - - @Test - public void moddedSchedulerRejectsAndCancelsAbandonedDownloadSubmissions() throws IOException { - String scheduler = source("art/arcane/iris/modded/ModdedScheduler.java"); - String dispatch = method(scheduler, "public boolean asyncIfRunning(Runnable task, Runnable rejection)"); - assertTrue(dispatch.contains("RejectionAwareTask")); - assertTrue(dispatch.contains("Objects.requireNonNull(rejection")); - - String shutdown = method(scheduler, "public void shutdown()"); - assertTrue(shutdown.contains("asyncExecutor.shutdownNow()")); - assertTrue(shutdown.contains("rejectAbandonedTasks(abandonedTasks);")); - - String reset = method(scheduler, "public void reset()"); - assertTrue(reset.contains("asyncExecutor.getQueue().drainTo(abandonedTasks);")); - assertTrue(reset.contains("rejectAbandonedTasks(abandonedTasks);")); - - String rejection = method(scheduler, "private static void rejectAbandonedTasks("); - assertTrue(rejection.contains("rejectionAwareTask.reject();")); - } - - @Test - public void blockingPregenShutdownDefersItsFinalSaveToTheServerThread() throws IOException { - String jobSource = source("art/arcane/iris/modded/command/ModdedPregenJob.java"); - String shutdown = method(jobSource, "private static boolean shutdownAndSave("); - assertTrue(shutdown.contains("deferFinalSaveToServerThread()")); - assertTrue(shutdown.contains("completeDeferredFinalSave()")); - assertTrue(shutdown.contains("cancelDeferredFinalSave()")); - - String methodSource = source("art/arcane/iris/modded/command/ModdedPregenMethod.java"); - String close = method(methodSource, "public void close()"); - assertTrue(close.contains("deferFinalSaveIfRequested()")); - - String await = method(methodSource, "private void awaitFinalSave("); - assertTrue(await.contains("FINAL_SAVE_POLL_MILLIS")); - assertTrue(await.contains("deferFinalSaveIfRequested()")); - - String complete = method(methodSource, "void completeDeferredFinalSave()"); - int cancel = complete.indexOf("cancelQueuedFinalSave();"); - int directSave = complete.indexOf("saveLevelOnServerThread();"); - assertTrue(cancel >= 0); - assertTrue(directSave > cancel); - - String queuedSave = method(methodSource, "private void executeFinalSave("); - assertTrue(queuedSave.contains("if (!request.claim())")); - String cancelRequest = method(methodSource, "private void cancelQueuedFinalSave()"); - assertTrue(cancelRequest.contains("request.cancel();")); - String pending = method(methodSource, "boolean hasPendingFinalSave()"); - assertTrue(pending.contains("queuedFinalSave.get() != null")); - } - - @Test - public void firstPregenChunkFailureRetainsItsFullCause() throws IOException { - String methodSource = source("art/arcane/iris/modded/command/ModdedPregenMethod.java"); - String logFailure = method(methodSource, "private void logChunkFailure("); - - assertTrue(methodSource.contains("AtomicBoolean failureDetailLogged")); - assertTrue(logFailure.contains("unwrap(failure)")); - assertTrue(logFailure.contains("failureDetailLogged.compareAndSet(false, true)")); - assertTrue(logFailure.contains("x, z, cause);")); - assertTrue(logFailure.contains("cause.toString()")); - } - - @Test - public void pregenReportsOnlyCleanupCallbacksFromCoveredTargets() throws IOException { - String source = source("art/arcane/iris/modded/command/ModdedPregenMethod.java"); - String cleanup = method(source, "private void cleanupMantleChunksCoveredBy("); - - assertTrue(source.contains("cleanupMantleChunksCoveredBy(x, z, listener);")); - assertFalse(source.contains("cleanupMantleChunk(x, z);")); - assertTrue(cleanup.contains("cleanupChunksCoveredBy(x, z, true, listener::onChunkCleaned)")); - assertFalse(cleanup.contains("forceCleanupChunk")); - } - - @Test - public void invalidPregenBoundsFailBeforeRuntimeMutation() throws IOException { - String jobSource = source("art/arcane/iris/modded/command/ModdedPregenJob.java"); - String start = method(jobSource, "public static boolean start("); - int taskConstruction = start.indexOf("PregenTask task = PregenTask.builder()"); - int profileMutation = start.indexOf("PregenPerformanceProfile.apply(engine)"); - - assertTrue(taskConstruction >= 0); - assertTrue(profileMutation > taskConstruction); - - String commandSource = source("art/arcane/iris/modded/command/ModdedPregenCommands.java"); - String command = method(commandSource, "static int pregenStart("); - assertTrue(command.contains("catch (IllegalArgumentException failure)")); - assertTrue(command.contains("IrisModdedCommands.fail(source, failure.getMessage())")); - } - - private static String source(String relativePath) throws IOException { - String root = System.getProperty(SOURCE_ROOT_PROPERTY); - assertTrue("Missing system property " + SOURCE_ROOT_PROPERTY, root != null && !root.isBlank()); - return Files.readString(Path.of(root, relativePath)); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("Missing source contract signature: " + signature, start >= 0); - int openBrace = source.indexOf('{', start); - assertTrue("Missing source contract method body: " + signature, openBrace >= 0); - int depth = 0; - for (int index = openBrace; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedIrisLogLevelCoverageTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedIrisLogLevelCoverageTest.java index d9c208f21..2982f7a39 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedIrisLogLevelCoverageTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedIrisLogLevelCoverageTest.java @@ -2,32 +2,9 @@ package art.arcane.iris.modded; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.List; -import java.util.stream.Stream; - import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; -/** - * The level router is a switch statement, which the compiler does not check for exhaustiveness. A level added - * to {@link art.arcane.iris.spi.LogLevel} with no arm here would compile and then drop every message at that - * level without a trace, so the fallback arm is what keeps a new level visible on the modded loaders. - */ public class ModdedIrisLogLevelCoverageTest { - @Test - public void everyLogLevelReachesTheLoggerIncludingOnesAddedLater() throws IOException { - String source = Files.readString(Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedIrisLog.java")); - int router = source.indexOf("public static void log(LogLevel level, String message)"); - assertTrue("log(LogLevel, String) not found", router >= 0); - - String body = source.substring(router, source.indexOf("public static void debug(", router)); - assertTrue(body, body.contains("default -> info(message);")); - } - @Test public void slf4jStyleArgumentsAndTrailingThrowableArePreserved() { RuntimeException failure = new RuntimeException("broken"); @@ -37,39 +14,4 @@ public class ModdedIrisLogLevelCoverageTest { assertEquals("chunk 4,9 failed", rendered.message()); assertEquals(failure, rendered.error()); } - - @Test - public void formattedDebugThrowableUsesTheVisibleDebugRouteWhenEnabled() throws IOException { - String source = Files.readString(Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedIrisLog.java")); - int start = source.indexOf("public static void debug(String format, Object... arguments)"); - int end = source.indexOf("public static void info(String message)", start); - assertTrue("formatted debug overload not found", start >= 0); - assertTrue("formatted debug overload boundary not found", end > start); - String body = source.substring(start, end); - - assertTrue(body, body.contains("if (!debugEnabled())")); - assertTrue(body, body.contains("LOGGER.info(\"[Iris/DEBUG] \" + clean(rendered.message()), rendered.error())")); - } - - @Test - public void moddedProductionUsesTheIrisLogFrontDoor() throws IOException { - Path root = Path.of(System.getProperty("iris.moddedCommonSources")); - try (Stream files = Files.walk(root)) { - List bypasses = files - .filter(path -> path.toString().endsWith(".java")) - .filter(path -> !path.getFileName().toString().equals("ModdedIrisLog.java")) - .filter(path -> { - try { - String source = Files.readString(path); - return source.contains("LoggerFactory.getLogger") - || source.contains("private static final Logger LOGGER"); - } catch (IOException unreadable) { - throw new IllegalStateException(unreadable); - } - }) - .toList(); - assertTrue(bypasses.toString(), bypasses.isEmpty()); - } - } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLevelDataAttachmentTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLevelDataAttachmentTest.java index 541337a32..dc6ed6bde 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLevelDataAttachmentTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLevelDataAttachmentTest.java @@ -2,10 +2,6 @@ package art.arcane.iris.modded; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; @@ -48,25 +44,6 @@ public class ModdedLevelDataAttachmentTest { assertNull(failure.getCause()); } - @Test - public void initializesLevelDataBeforeBindingAndPublication() throws IOException { - String source = Files.readString(sourcePath("ModdedDimensionManager.java")); - int construction = source.indexOf("ServerLevel level = new ServerLevel("); - int initialization = source.indexOf("serverAccess.initializeLevelData(server, level);", construction); - int binding = source.indexOf("generator.bindLevel(level);", initialization); - int publication = source.indexOf("serverAccess.putLevelIfAbsent(server, key, level);", binding); - - assertTrue(construction >= 0); - assertTrue(initialization > construction); - assertTrue(binding > initialization); - assertTrue(publication > binding); - } - - private static Path sourcePath(String fileName) { - return Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded", fileName); - } - public static final class AttachedLevelData { private RootData rootData; private DimensionKey dimensionKey; diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLifecycleFailureContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLifecycleFailureContractTest.java deleted file mode 100644 index 9aee5e796..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedLifecycleFailureContractTest.java +++ /dev/null @@ -1,436 +0,0 @@ -package art.arcane.iris.modded; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class ModdedLifecycleFailureContractTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - - @Test - public void existingDimensionStagesWithoutReplacingTheLiveEngine() throws IOException { - String managerSource = source("ModdedDimensionManager.java"); - String create = method(managerSource, "private static Handle create("); - int existingStart = requiredIndex(create, "if (existing != null"); - int presentStart = requiredIndex(create, "if (serverAccess.hasLevel(server, key))", existingStart + 1); - int injectionStart = requiredIndex(create, "try {", presentStart); - - assertFalse(create.substring(existingStart, presentStart).contains("repointAndBind(")); - assertFalse(create.substring(presentStart, injectionStart).contains("repointAndBind(")); - assertBefore(create, "ModdedGenerationHistoryStorage.createOrStage(", "if (existing != null"); - - String generatorSource = source("IrisModdedChunkGenerator.java"); - String repointAndBind = method(generatorSource, "void repointAndBind("); - assertBefore(repointAndBind, "ModdedWorldEngines.prepareReplacement(", - "ModdedWorldEngines.installReplacement("); - assertBefore(repointAndBind, "ModdedWorldEngines.installReplacement(", "this.activePack = pack;"); - String failure = catchBlock(repointAndBind); - assertTrue(failure.contains("ModdedWorldEngines.closeUnregistered(replacement);")); - assertTrue(failure.contains("addSuppressed(")); - - String worldEnginesSource = source("ModdedWorldEngines.java"); - String installReplacement = method(worldEnginesSource, "static void installReplacement("); - assertTrue(installReplacement.contains("ENGINES.compute(")); - assertBefore(installReplacement, "close(current);", "return activeReplacement;"); - assertFalse(installReplacement.contains("catch (")); - } - - @Test - public void persistentPackUpdatesUseAnExplicitRestartBoundPath() throws IOException { - String managerSource = source("ModdedDimensionManager.java"); - String createPersistent = method(managerSource, "public static Handle createPersistent("); - String update = method(managerSource, "public static UpdateResult stagePersistentUpdate("); - - assertBefore(createPersistent, "if (previous != null)", "ModdedDimensionRegistryStore.put("); - assertTrue(createPersistent.contains("Use the Iris world update command")); - assertTrue(update.contains("ModdedGenerationHistoryStorage.createOrStage(")); - assertTrue(update.contains("active.history().pendingActivation()")); - assertTrue(update.contains("restartRequired()")); - assertFalse(update.contains("inject(")); - assertFalse(update.contains("repointAndBind(")); - assertBefore(update, "ModdedDimensionRegistryStore.put(server, updated);", - "ModdedGenerationHistoryStorage.createOrStage("); - assertTrue(update.contains("ModdedDimensionRegistryStore.put(server, previous);")); - - String commandsSource = source("command/ModdedWorldCommands.java"); - assertTrue(commandsSource.contains("root.then(updateTree());")); - String command = method(commandsSource, "private static int update("); - assertTrue(command.contains("ModdedDimensionManager.stagePersistentUpdate(")); - assertTrue(command.contains("Restart the server to activate it")); - assertTrue(command.contains("running world remains on its current pack")); - } - - @Test - public void injectionBindsBeforeRegistrationAndRollsBackEveryFailure() throws IOException { - String source = source("ModdedDimensionManager.java"); - String injection = method(source, "private static Handle inject("); - - assertBefore(injection, "generator.bindLevel(level);", "serverAccess.putLevelIfAbsent(server, key, level);"); - assertBefore(injection, "serverAccess.putLevelIfAbsent(server, key, level);", - "server.getPlayerList().addWorldborderListener(level);"); - assertFalse(injection.contains("serverAccess.putLevel(server, key, previous);")); - String failure = catchBlock(injection); - assertBefore(failure, "rollbackInjection(", "throw "); - - String rollback = method(source, "void rollbackInjection("); - assertBefore(rollback, "serverAccess.hasLevel(server, key)", "serverAccess.removeLevel(server, key);"); - assertTrue(rollback.contains("generator.unbindEngine(")); - assertTrue(rollback.contains("level.close();")); - assertTrue(rollback.contains("addSuppressed(")); - } - - @Test - public void persistentReinjectionQuarantinesBrokenEntriesAndContinues() throws IOException { - String source = source("ModdedStartup.java"); - String reinjection = method(source, "private static void reinjectPersistentDimensions("); - String failure = catchBlock(reinjection); - - assertTrue(failure.contains("ModdedIrisLog.error(")); - assertFalse(failure.contains("e.toString()")); - assertFalse(failure.contains("throw new IllegalStateException(")); - assertTrue(reinjection.contains("injected++;")); - } - - @Test - public void persistentReinjectionWaitsForPlayerServicesAndServerStarted() throws IOException { - String bootstrapSource = source("ModdedEngineBootstrap.java"); - String start = method(bootstrapSource, "public static void start("); - String serverAboutToStart = method(bootstrapSource, "public static void serverAboutToStart("); - String serverStarted = method(bootstrapSource, "public static void serverStarted("); - - assertFalse(start.contains("ModdedStartup.runOnce(server);")); - assertFalse(serverAboutToStart.contains("ModdedStartup.runOnce(server);")); - assertEquals(1, occurrences(serverStarted, "ModdedStartup.runOnce(server);")); - assertBefore(serverStarted, "bindWorldGenerators(server);", "ModdedStartup.runOnce(server);"); - assertBefore(serverStarted, "ModdedStartup.runOnce(server);", "reconcileSpawn(server);"); - - String startupSource = source("ModdedStartup.java"); - String runOnce = method(startupSource, "public static void runOnce("); - assertBefore(runOnce, "server.getPlayerList() == null", "STARTED.compareAndSet(false, true)"); - } - - @Test - public void dynamicLevelMutationsInvalidateLoaderTickCaches() throws IOException { - String levelsSource = source("ModdedServerLevels.java"); - String put = method(levelsSource, "public ServerLevel putLevel("); - String putIfAbsent = method(levelsSource, "public ServerLevel putLevelIfAbsent("); - String remove = method(levelsSource, "public ServerLevel removeLevel("); - - assertBefore(put, "server.levels.put(key, level);", "levelCacheInvalidator.accept(server);"); - assertTrue(put.contains("if (previous != level)")); - assertBefore(putIfAbsent, "server.levels.putIfAbsent(key, level);", "levelCacheInvalidator.accept(server);"); - assertTrue(putIfAbsent.contains("if (previous == null)")); - assertBefore(remove, "server.levels.remove(key);", "levelCacheInvalidator.accept(server);"); - assertTrue(remove.contains("if (removed != null)")); - - String loaderSource = source("ModdedLoader.java"); - assertTrue(loaderSource.contains("void invalidateLevelCache(MinecraftServer server);")); - String bootstrapSource = source("ModdedEngineBootstrap.java"); - assertTrue(bootstrapSource.contains("new ModdedServerLevels(boundLoader::invalidateLevelCache)")); - } - - @Test - public void persistentRestoreOpensHistoryBeforeConsultingTheGlobalPack() throws IOException { - String source = source("ModdedGenerationHistoryStorage.java"); - String restore = method(source, "static GenerationHistory restoreOrAdopt("); - - assertBefore(restore, "GenerationHistory.openIfPresent(", "sourceSupplier\").get();"); - assertTrue(restore.contains("if (existing.isPresent())")); - assertBefore(restore, "requireRegistryDefinitions(existing.get()", "return existing.get();"); - } - - @Test - public void productionPackResolutionNeverUsesTheParityProbeAsData() throws IOException { - String source = source("ModdedWorldEngines.java"); - String resolvePack = method(source, "static File resolvePack("); - - assertFalse(source.contains("System.getProperty(\"iris.parity\")")); - assertFalse(source.contains("parityPack")); - assertFalse(source.contains("falling back to parity pack")); - assertTrue(resolvePack.contains("throw new IllegalStateException(")); - } - - @Test - public void engineBootstrapResetsStartupExactlyOnceDuringStop() throws IOException { - String source = source("ModdedEngineBootstrap.java"); - String stop = method(source, "public static void stop("); - - assertEquals(1, occurrences(stop, "ModdedStartup::reset")); - } - - @Test - public void engineBootstrapAttemptsEveryShutdownStageAndAggregatesFailures() throws IOException { - String source = source("ModdedEngineBootstrap.java"); - String stop = method(source, "public static void stop("); - - assertBefore(stop, "\"services\"", "\"world engines\""); - assertBefore(stop, "\"world engines\"", "\"dimension manager\""); - assertBefore(stop, "\"server state\"", "if (failure != null)"); - assertFalse(stop.contains("throw")); - assertTrue(stop.contains("ModdedIrisLog.error(\"Iris modded shutdown completed with failures\", failure);")); - - String runStage = method(source, "private static Throwable runStopStage("); - assertTrue(runStage.contains("catch (Throwable stageFailure)")); - assertTrue(runStage.contains("failure.addSuppressed(stageFailure);")); - } - - @Test - public void worldShutdownRemovesOnlySuccessfullyClosedMappings() throws IOException { - String source = source("ModdedWorldEngines.java"); - String shutdown = method(source, "public static void shutdown()"); - - assertTrue(shutdown.contains("new ArrayList<>(ENGINES.entrySet())")); - assertFalse(shutdown.contains("ENGINES.clear()")); - // Bound generators must go through unbindEngine (latch unloading, then strict evict) so a - // late chunk-system drain cannot rebuild an engine nothing closes again. - assertTrue(shutdown.contains("generator.unbindEngine(level);")); - assertBefore(shutdown, "close(engine);", "ENGINES.remove(level, engine)"); - assertTrue(shutdown.contains("ENGINES.containsKey(level)")); - assertTrue(shutdown.contains("failure.addSuppressed(e);")); - assertTrue(shutdown.contains("failed mappings were retained")); - } - - @Test - public void engineEvictionRetainsTheMappingUntilCloseSucceeds() throws IOException { - String source = source("ModdedWorldEngines.java"); - String eviction = method(source, "static void evictOrThrow("); - - assertTrue(eviction.contains("ENGINES.computeIfPresent(")); - assertFalse(eviction.contains("ENGINES.remove(")); - assertBefore(eviction, "close(current);", "return null;"); - } - - @Test - public void generatorUnbindRetainsOwnershipWhenEvictionFails() throws IOException { - String source = source("IrisModdedChunkGenerator.java"); - String unbind = method(source, "synchronized void unbindEngine(ServerLevel level)"); - - assertFalse(unbind.contains("finally")); - assertBefore(unbind, "unloading = true;", "ModdedWorldEngines.evictOrThrow(level);"); - assertBefore(unbind, "ModdedWorldEngines.evictOrThrow(level);", "clearEngineBinding();"); - String binding = method(source, "private Engine bindEngine(ServerLevel level)"); - assertTrue(binding.contains("requireBindingAllowed();")); - assertTrue(binding.contains("requireCompletedShutdown(cached);")); - String bindLevel = method(source, "synchronized void bindLevel(ServerLevel level)"); - assertBefore(bindLevel, "requireCompletedShutdown(engine);", "unloading = false;"); - String boundEngine = method(source, "public Engine engineIfBound()"); - assertTrue(boundEngine.contains("unloading || current == null || current.isClosing() || current.isClosed()")); - } - - @Test - public void loaderUnloadSurfacesCloseFailureAndDynamicRemovalUsesStrictEviction() throws IOException { - String bootstrapSource = source("ModdedEngineBootstrap.java"); - String unload = method(bootstrapSource, "public static void levelUnloaded(ServerLevel level)"); - String failure = catchBlock(unload); - assertTrue(failure.contains("ModdedIrisLog.error(")); - assertTrue(failure.contains("throw ")); - - String managerSource = source("ModdedDimensionManager.java"); - String remove = method(managerSource, "public static boolean remove(MinecraftServer server, String dimensionId, boolean wipeStorage)"); - assertTrue(remove.contains("ModdedWorldEngines.evictOrThrow(level);")); - assertFalse(remove.contains("ModdedWorldEngines.evict(level);")); - assertTrue(remove.contains("unloadEventStarted = true;")); - assertTrue(remove.contains("rollbackRemoval(server, serverAccess, key, level, generator, unloadEventStarted, e);")); - - String rollback = method(managerSource, "private static void rollbackRemoval("); - assertTrue(rollback.contains("serverAccess.hasLevel(server, key)")); - assertTrue(rollback.contains("generator.bindLevel(level);")); - assertTrue(rollback.contains("failure.addSuppressed(rollbackFailure);")); - assertTrue(rollback.contains("ModdedIrisLog.error(")); - } - - @Test - public void engineBootstrapRollsBackEveryPublishedBindingBeforeRethrowing() throws IOException { - String source = source("ModdedEngineBootstrap.java"); - String bind = method(source, "public static ModdedPlatform bind("); - String failure = catchBlock(bind); - - assertBefore(bind, "createdServices.enableAll();", "runtime = new BoundRuntime("); - assertTrue(bind.contains("rollback.add(() -> GuiHost.suppressDesktop(")); - assertTrue(bind.contains("rollback.add(() -> restorePlatform(")); - assertTrue(bind.contains("rollback.add(() -> ModdedDimensionManager.restoreAccess(")); - assertTrue(bind.contains("rollback.add(() -> IrisObjectRotation.restorePlatformRotator(")); - assertTrue(bind.contains("rollback.add(() -> BlockDataMergeSupport.restorePlatformMerger(")); - assertTrue(bind.contains("rollback.add(() -> TileData.restorePlatformReader(")); - assertTrue(bind.contains("rollback.add(() -> TileData.restorePlatformFactory(")); - assertTrue(bind.contains("rollback.add(() -> GuiHost.set(")); - assertTrue(bind.contains("rollback.add(() -> DecoratorPlatformHooks.restore(")); - assertTrue(bind.contains("bindService(PreservationRegistry.class")); - assertTrue(bind.contains("bindService(EngineEffectsProvider.class")); - assertTrue(bind.contains("bindService(EnginePlatformHooks.class")); - assertTrue(bind.contains("bindService(EngineWorldManagerProvider.class")); - assertTrue(bind.contains("rollback.add(customContentDiscovery::rollback);")); - assertBefore(failure, "createdServices.rollback(failure);", "rollback.restore(failure);"); - assertBefore(failure, "rollback.restore(failure);", "throw "); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = requiredIndex(source, first); - int secondIndex = requiredIndex(source, second); - assertTrue(first + " must occur before " + second, firstIndex < secondIndex); - } - - private static int requiredIndex(String source, String needle) { - return requiredIndex(source, needle, 0); - } - - private static int requiredIndex(String source, String needle, int start) { - int index = source.indexOf(needle, start); - assertTrue("Missing source contract token: " + needle, index >= 0); - return index; - } - - private static String source(String fileName) throws IOException { - String sourceRoot = System.getProperty(SOURCE_ROOT_PROPERTY); - assertTrue("Missing system property " + SOURCE_ROOT_PROPERTY, - sourceRoot != null && !sourceRoot.isBlank()); - Path sourcePath = Path.of(sourceRoot, "art", "arcane", "iris", "modded", fileName); - return Files.readString(sourcePath); - } - - private static String method(String source, String signature) { - int start = requiredIndex(source, signature); - int openBrace = openingBrace(source, start); - return source.substring(start, matchingBrace(source, openBrace) + 1); - } - - /** - * Returns the block of the shallowest catch in the method, i.e. the one attached to the - * method's outermost try. Textual first-match would return a nested catch instead, and a - * nested catch handles a different failure than the one these contracts pin. - */ - private static String catchBlock(String source) { - int bodyStart = openingBrace(source, 0); - int depth = 0; - int bestDepth = Integer.MAX_VALUE; - int catchIndex = -1; - int i = bodyStart; - while (i < source.length()) { - int skipped = skipNonCode(source, i); - if (skipped > i) { - i = skipped; - continue; - } - char current = source.charAt(i); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - break; - } - } else if (current == 'c' && depth < bestDepth && source.startsWith("catch (", i)) { - bestDepth = depth; - catchIndex = i; - } - i++; - } - assertTrue("Missing source contract token: catch (", catchIndex >= 0); - return blockAt(source, openingBrace(source, catchIndex)); - } - - private static String blockAt(String source, int openBrace) { - return source.substring(openBrace, matchingBrace(source, openBrace) + 1); - } - - private static int openingBrace(String source, int start) { - int i = start; - while (i < source.length()) { - int skipped = skipNonCode(source, i); - if (skipped > i) { - i = skipped; - continue; - } - if (source.charAt(i) == '{') { - return i; - } - i++; - } - throw new IllegalArgumentException("No source block after offset " + start); - } - - private static int matchingBrace(String source, int openBrace) { - int depth = 0; - int i = openBrace; - while (i < source.length()) { - int skipped = skipNonCode(source, i); - if (skipped > i) { - i = skipped; - continue; - } - char current = source.charAt(i); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return i; - } - } - i++; - } - throw new IllegalArgumentException("Unclosed source block"); - } - - /** - * Advances past a comment, string, char or text block starting at the index, otherwise returns - * the index unchanged. Comments must be skipped: an apostrophe in prose ("generator's") would - * otherwise open a char literal and swallow the rest of the file. - */ - private static int skipNonCode(String source, int index) { - char current = source.charAt(index); - if (current == '/' && index + 1 < source.length()) { - char next = source.charAt(index + 1); - if (next == '/') { - int end = source.indexOf('\n', index); - return end < 0 ? source.length() : end + 1; - } - if (next == '*') { - int end = source.indexOf("*/", index + 2); - return end < 0 ? source.length() : end + 2; - } - return index; - } - if (current == '"' && source.startsWith("\"\"\"", index)) { - int end = source.indexOf("\"\"\"", index + 3); - return end < 0 ? source.length() : end + 3; - } - if (current == '"' || current == '\'') { - return endOfLiteral(source, index, current); - } - return index; - } - - private static int endOfLiteral(String source, int index, char terminator) { - for (int i = index + 1; i < source.length(); i++) { - char current = source.charAt(i); - if (current == '\\') { - i++; - continue; - } - if (current == terminator) { - return i + 1; - } - } - return source.length(); - } - - private static int occurrences(String source, String needle) { - int count = 0; - int offset = 0; - while (true) { - int index = source.indexOf(needle, offset); - if (index < 0) { - return count; - } - count++; - offset = index + needle.length(); - } - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedSpawnerRarityParityTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedSpawnerRarityParityTest.java index 95562cb3c..944315acd 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedSpawnerRarityParityTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedSpawnerRarityParityTest.java @@ -5,13 +5,9 @@ import art.arcane.iris.engine.object.IrisEntitySpawn; import art.arcane.volmlib.util.collection.KList; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; public class ModdedSpawnerRarityParityTest { private static IrisEntitySpawn spawn(int rarity) { @@ -39,37 +35,4 @@ public class ModdedSpawnerRarityParityTest { assertEquals(1, IRare.get(spawn(-5))); assertEquals(3, IRare.get(spawn(3))); } - - @Test - public void perPositionSpawnLoopsDoNotRerollEntryRarity() throws Exception { - String source = Files.readString(Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedWorldManager.java")); - - for (String method : List.of("private int spawnEntry(", "private int spawnEntryAt(")) { - String body = methodBody(source, method); - assertFalse(method + " must not re-roll rarity per position; rarityPick already weighted the pool", - body.contains("getRarity()")); - assertTrue(method + " must keep the min/max spawn-count roll", - body.contains("LootResolver.inclusive(")); - } - } - - private static String methodBody(String source, String declaration) { - int start = source.indexOf(declaration); - assertTrue("ModdedWorldManager must declare " + declaration, start >= 0); - int open = source.indexOf('{', start); - int depth = 0; - for (int index = open; index < source.length(); index++) { - char character = source.charAt(index); - if (character == '{') { - depth++; - } else if (character == '}') { - depth--; - if (depth == 0) { - return source.substring(open + 1, index); - } - } - } - throw new AssertionError(declaration + " is not brace balanced"); - } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructurePlacementFailureContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructurePlacementFailureContractTest.java deleted file mode 100644 index 0efa85911..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructurePlacementFailureContractTest.java +++ /dev/null @@ -1,30 +0,0 @@ -package art.arcane.iris.modded; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class ModdedStructurePlacementFailureContractTest { - @Test - public void structurePlacementPropagatesRuntimeFailuresWithContext() throws IOException { - Path sourcePath = Path.of(System.getProperty("iris.moddedCommonSources"), - "art/arcane/iris/modded/ModdedStructureHooks.java"); - String source = Files.readString(sourcePath); - int methodStart = source.indexOf("public int[] placeStructure("); - int methodEnd = source.indexOf("\n @Override", methodStart + 1); - String method = source.substring(methodStart, methodEnd); - int catchStart = method.indexOf("catch (RuntimeException error)"); - - assertTrue(catchStart >= 0); - String failurePath = method.substring(catchStart); - assertTrue(failurePath.contains("throw NativeStructureGenerationException.failure(")); - assertTrue(failurePath.contains("\"capture placement\", structureKey, chunkX, chunkZ, error")); - assertFalse(failurePath.contains("return null;")); - assertFalse(failurePath.contains("catch (Throwable")); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructureTemplateCacheTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructureTemplateCacheTest.java index edbedc22d..bf3f170da 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructureTemplateCacheTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedStructureTemplateCacheTest.java @@ -4,8 +4,6 @@ import org.junit.Test; import java.io.InputStream; import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.ArrayList; import java.util.List; import java.util.concurrent.ConcurrentHashMap; @@ -64,14 +62,9 @@ public class ModdedStructureTemplateCacheTest { config = new String(input.readAllBytes(), StandardCharsets.UTF_8); } assertTrue(config.contains("\"StructureTemplatePaletteConcurrencyMixin\"")); - - Path source = Path.of(System.getProperty("iris.moddedCommonSources")) - .resolve("art/arcane/iris/modded/mixin/StructureTemplatePaletteConcurrencyMixin.java"); - String mixin = Files.readString(source); - assertTrue(mixin.contains("@Mixin(StructureTemplate.Palette.class)")); - assertTrue(mixin.contains("@Shadow\n @Final\n @Mutable")); - assertTrue(mixin.contains("private Map> cache;")); - assertTrue(mixin.contains("@Inject(method = \"(Ljava/util/List;)V\", at = @At(\"RETURN\"))")); - assertTrue(mixin.contains("cache = new ConcurrentHashMap<>();")); + assertNotNull(Class.forName( + "art.arcane.iris.modded.mixin.StructureTemplatePaletteConcurrencyMixin", + false, + ModdedStructureTemplateCacheTest.class.getClassLoader())); } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedWorldCheckTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedWorldCheckTest.java index ddf92a2c2..3945b87bc 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedWorldCheckTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/ModdedWorldCheckTest.java @@ -5,9 +5,6 @@ import net.minecraft.world.level.ChunkPos; import net.minecraft.world.level.levelgen.structure.BoundingBox; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.ArrayList; import java.util.List; import java.util.concurrent.atomic.AtomicBoolean; @@ -26,32 +23,6 @@ public class ModdedWorldCheckTest { assertTrue(thread.isDaemon()); } - @Test - public void poiAuditRunsInASecondServerTaskAfterVillageGeneration() throws IOException { - Path sourceRoot = Path.of(System.getProperty("iris.moddedCommonSources")); - String source = Files.readString(sourceRoot.resolve("art/arcane/iris/modded/ModdedWorldCheck.java")); - String auditSource = Files.readString( - sourceRoot.resolve("art/arcane/iris/modded/WorldCheckStructureAudit.java")); - int preparationSubmit = source.indexOf( - "WorldCheckPreparation preparation = serverRef.submit(() -> run(serverRef))"); - int completionSubmit = source.indexOf( - "exitCode = serverRef.submit(() -> runAndRequestStop(", preparationSubmit); - int completionMethod = source.indexOf("private static boolean completeWorldCheck"); - int deferredAudit = source.indexOf( - "PoiAudit poi = WorldCheckStructureAudit.auditStructurePois", completionMethod); - int structureMethod = auditSource.indexOf("private static StructureCheckResult checkNativeStructure"); - int structureMethodEnd = auditSource.indexOf("private static StructureStart resolveStructureStart", - structureMethod); - String structureSource = auditSource.substring(structureMethod, structureMethodEnd); - - assertTrue(preparationSubmit >= 0); - assertTrue(completionSubmit > preparationSubmit); - assertTrue(deferredAudit > completionMethod); - assertFalse(structureSource.contains("auditStructurePois")); - assertFalse(source.contains("prepareDeferredAudits")); - assertFalse(auditSource.contains("prepareDeferredAudits")); - } - @Test public void validStructureStartIsGenerationEvidence() { assertTrue(WorldCheckPredicates.hasNativeStructureEvidence(true, 0)); diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/NativeStructureFailureContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/NativeStructureFailureContractTest.java index f6e3c147b..be6e017b2 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/NativeStructureFailureContractTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/NativeStructureFailureContractTest.java @@ -6,11 +6,6 @@ import net.minecraft.server.Bootstrap; import org.junit.BeforeClass; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; @@ -22,25 +17,6 @@ public class NativeStructureFailureContractTest { Bootstrap.bootStrap(); } - @Test - public void structureLocateDoesNotCatchAndFallThroughToAnotherImplementation() throws IOException { - String source = moddedSource("IrisModdedChunkGenerator.java"); - int locateStart = source.indexOf("public Pair> findNearestMapStructure"); - int locateEnd = source.indexOf("public boolean isNativeStructureReachable", locateStart); - String locate = source.substring(locateStart, locateEnd); - String stage = moddedSource("ModdedNativeStructureStage.java"); - int filterStart = stage.indexOf("HolderSet filterReachableNativeStructures"); - int filterEnd = stage.indexOf("void adjustGeneratedStructures", filterStart); - String filter = stage.substring(filterStart, filterEnd); - - assertTrue(locate.contains("Engine current = engine();")); - assertFalse(locate.contains("catch (Throwable")); - assertFalse(locate.contains("return null;\n } catch")); - assertTrue(filter.contains("unregistered structure holder")); - assertFalse(filter.contains("catch (Throwable")); - assertFalse(filter.contains("failed closed")); - } - @Test public void globalStructureDisableRefusesGeneratorBinding() { IrisModdedChunkGenerator.requireGlobalStructureGeneration(true, "overworld:overworld"); @@ -56,66 +32,6 @@ public class NativeStructureFailureContractTest { assertTrue(error.getMessage().contains("importedStructures.disabledExact")); } - @Test - public void structureVegetationCleanupPrecedesTerrainPreparationAndPlacement() throws IOException { - String source = moddedSource("ModdedNativeStructureStage.java"); - int placementStart = source.indexOf("void placeVanillaStructures"); - int placementEnd = source.indexOf("private static String nativeStructureBatchContext", placementStart); - String placement = source.substring(placementStart, placementEnd); - - assertTrue(placement.contains("\"terrain integration\"")); - assertTrue(placement.contains("\"terrain preparation\"")); - assertTrue(placement.contains("\"foundation repair\"")); - assertFalse(placement.contains("\"terrain carving\"")); - assertTrue(placement.contains("visitExistingPois(chunk")); - assertTrue(placement.contains("level.updatePOIOnBlockStateChange(")); - assertTrue(placement.contains("Blocks.AIR.defaultBlockState(), state")); - assertTrue(placement.indexOf("visitExistingPois(chunk") - < placement.indexOf("WorldgenTerrainHeightmaps.primeStructurePlacement(")); - assertTrue(placement.contains("prepareSurfaceStructures")); - assertTrue(placement.contains("clearIntersectingVegetation")); - assertTrue(placement.indexOf("clearIntersectingVegetation") - < placement.indexOf("prepareSurfaceStructures")); - assertTrue(placement.indexOf("prepareSurfaceStructures") - < placement.indexOf("for (NativePlacementGroup group")); - assertTrue(placement.indexOf("repairVacuumFoundations") - > placement.indexOf("for (NativePlacementGroup group")); - } - - @Test - public void structurePlacementPrimesNeighbourWorldgenHeightmapsBeforeTerrainPreparation() throws IOException { - String source = moddedSource("ModdedNativeStructureStage.java"); - int placementStart = source.indexOf("void placeVanillaStructures"); - int placementEnd = source.indexOf("private static String nativeStructureBatchContext", placementStart); - String placement = source.substring(placementStart, placementEnd); - - assertTrue(source.contains("import art.arcane.iris.nativegen.WorldgenTerrainHeightmaps;")); - assertTrue(placement.contains("WorldgenTerrainHeightmaps.primeStructurePlacement(")); - assertTrue(placement.contains("\"heightmap priming\"")); - assertTrue(placement.contains("heightmapStarts.add(start);")); - assertTrue(placement.indexOf("WorldgenTerrainHeightmaps.primeStructurePlacement(") - < placement.indexOf("prepareSurfaceStructures")); - assertTrue(source.contains("Engine.hostHeight(generationEngine, x, z, false) + runtimeMinY + 1")); - assertTrue(source.contains("Engine.hostHeight(generationEngine, x, z, true) + runtimeMinY + 1")); - assertTrue(placement.contains("current.getDimensionStackContext() != null")); - assertTrue(source.contains("int minY = chunk.getMinY() + 1;")); - } - - @Test - public void nativeStructurePostProcessingUsesBoundedWorldgenAccess() throws IOException { - String source = moddedSource("ModdedNativeStructureStage.java"); - int placementStart = source.indexOf("void placeVanillaStructures"); - int placementEnd = source.indexOf("private List> structuresByStep", placementStart); - String placement = source.substring(placementStart, placementEnd); - - assertTrue(placement.contains("ModdedNativeStructureWorldgenAccess.create(")); - assertTrue(placement.contains("nativeStructureProtection(current, staticObjects)")); - assertTrue(placement.contains("Engine.hostHeight(current, x, z, true)")); - assertTrue(placement.contains("placeVanillaStructure(boundedWorld, structureManager")); - assertFalse(placement.contains("NativeStructurePostProcessor.place(world,")); - assertTrue(placement.contains("world.setCurrentlyGenerating(null);")); - } - @Test public void structureFailurePreservesPhaseIdentityChunkAndCause() { IllegalArgumentException cause = new IllegalArgumentException("broken placement"); @@ -128,10 +44,4 @@ public class NativeStructureFailureContractTest { assertTrue(error.getMessage().contains("12,-8")); assertTrue(error.getMessage().contains("aborted")); } - - private static String moddedSource(String fileName) throws IOException { - Path sourcePath = Path.of(System.getProperty("iris.moddedCommonSources"), - "art", "arcane", "iris", "modded", fileName); - return Files.readString(sourcePath); - } } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/IrisModdedStructureCommandTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/IrisModdedStructureCommandTest.java index bd911e2a2..8549f7b06 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/IrisModdedStructureCommandTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/IrisModdedStructureCommandTest.java @@ -7,9 +7,6 @@ import com.mojang.datafixers.util.Pair; import net.minecraft.core.BlockPos; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import java.util.Set; import java.util.concurrent.atomic.AtomicInteger; @@ -48,30 +45,6 @@ public class IrisModdedStructureCommandTest { assertEquals(1, nativeReferences.get()); } - @Test - public void gotoStructureSupportsIrisAndNativeRegistryTargets() throws IOException { - String source = source("ModdedLocateCommands.java"); - String suggestions = source("ModdedCommandSuggestions.java"); - - assertTrue(source.contains("IrisStructureLocator.hasLocatableEditablePlacement(engine, key)")); - assertTrue(source.contains("registry.get(identifier)")); - assertTrue(source.contains("getPlacementsForStructure(holder)")); - assertTrue(source.contains("generator.findNearestMapStructure(")); - assertTrue(source.contains("NATIVE_STRUCTURE_LOCATE_RADIUS = 100")); - assertTrue(source.contains("HolderSet.direct(target.holder())")); - assertFalse(source.contains("NativeStructureLocateCapability")); - assertTrue(source.contains("boolean teleported = player.teleportTo(")); - assertTrue(suggestions.contains("combineStructureKeys(unregisteredIrisKeys, nativeKeys)")); - assertTrue(source.contains("irisGenerator.isNativeStructureReachable(holder)")); - assertTrue(source.contains("LocateStatus.SEARCH_LIMIT_REACHED")); - assertTrue(source.contains("IRIS_MODDED_COMMANDS_UNABLE_LOCATE_IRIS_PLACED_STRUCTURE_DENSITY_SEARCH_SAFETY_LIMIT_WAS")); - assertTrue(source.contains("int targetX = result.originX()")); - assertTrue(source.contains("int targetY = result.baseY() + 2")); - assertTrue(source.contains("int targetZ = result.originZ()")); - assertFalse(source.contains("at[0] + 8")); - assertFalse(source.contains("at[2] + 8")); - } - @Test public void registeredStructureEligibilityMatchesGotoAndSuggestions() { IrisNativeStructureDecision nativeDecision = decision(NativeStructureGenerationStatus.GENERATE_NATIVE); @@ -175,162 +148,6 @@ public class IrisModdedStructureCommandTest { .contains("non-positive density or a Y band outside")); } - @Test - public void unregisteredCommandUsesGotoEligibilityAndPrintsToConsole() throws IOException { - String command = source("ModdedUnregisteredStructures.java"); - String tree = source("ModdedCommandTree.java"); - - assertTrue(tree.contains("Commands.literal(\"unregistered\")")); - assertTrue(tree.contains("ModdedUnregisteredStructures.print(context.getSource())")); - assertTrue(command.contains("ModdedCommandSuggestions.isEligibleRegisteredStructure(")); - assertTrue(command.contains("ModdedLocateCommands.registeredStructureUnavailableMessage(")); - assertTrue(command.contains("engine.getData().getStructureLoader().getPossibleKeys()")); - assertTrue(command.contains("IrisStructureLocator.hasLocatableEditablePlacement(engine, key)")); - assertTrue(command.contains("ModdedIrisLog.info(\"[Iris goto unregistered] [{}] {} - {}\"")); - assertTrue(command.contains("UNREGISTERED(\"unregistered\")")); - assertFalse(command.contains("DatapackIngestService")); - } - - @Test - public void structureSuggestionsUseActiveLevelAvailability() throws IOException { - String suggestions = source("ModdedCommandSuggestions.java"); - int methodStart = suggestions.indexOf("static CompletableFuture suggestStructureKeys("); - int methodEnd = suggestions.indexOf("static boolean isEligibleRegisteredStructure(", methodStart); - String method = suggestions.substring(methodStart, methodEnd); - - assertTrue(method.contains("ServerLevel level = source.getLevel()")); - assertTrue(method.contains("Engine engine = IrisModdedCommands.engineFor(level)")); - assertFalse(method.contains("IrisStructureLocator.locatableKeys(engine)")); - assertTrue(method.contains("IrisStructureLocator.locatableEditableKeys(engine)")); - assertTrue(method.contains("StructureReachability.reachableKeys(engine)")); - assertTrue(method.contains("NativeStructureGenerationPolicy.resolve(engine, key, false)")); - assertTrue(method.contains("IrisStructureLocator.hasLocatableNativePlacement(engine, key)")); - assertTrue(method.contains("IrisStructureLocator.hasLocatableEditablePlacement(engine, key)")); - assertTrue(method.contains("reachableNativeKeys.contains(normalizeKey(key))")); - assertTrue(method.contains("nativeGenerationEnabled")); - assertTrue(method.contains("eligibleUnregisteredEditableKeys(")); - assertTrue(method.contains("IrisStructureLocator.hasNativePlacement(engine, candidate)")); - assertFalse(method.contains("NativeStructureGenerationKeys.active(level)")); - assertFalse(method.contains("getPlacementsForStructure")); - } - - @Test - public void generatorLocateUsesEveryIrisPlacedNativeStructure() throws IOException { - String source = moddedSource("ModdedNativeStructureStage.java"); - int methodStart = source.indexOf("Pair> findNearestIrisStructure("); - int methodEnd = source.indexOf("HolderSet filterReachableNativeStructures(", methodStart); - String method = source.substring(methodStart, methodEnd); - int registryLookup = method.indexOf("level.registryAccess().lookupOrThrow(Registries.STRUCTURE)"); - int placedCheck = method.indexOf( - "if (!IrisStructureLocator.hasNativePlacement(current, structureId))"); - int irisLocate = method.indexOf("NativeStructureLocatePersistence.search(", placedCheck); - int nearestSelection = method.indexOf( - "NativeStructureLocateResults.nearest(pos, predicted, nativeLocated)", irisLocate); - int selectedVerification = method.indexOf("bestSearch.search().verify(bestResult)", nearestSelection); - int selectedReference = method.indexOf( - "selectedSearch.search().reference(selectedStart)", selectedVerification); - - assertTrue(registryLookup >= 0); - assertTrue(placedCheck > registryLookup); - assertTrue(irisLocate > placedCheck); - assertTrue(nearestSelection > irisLocate); - assertTrue(selectedVerification > nearestSelection); - assertTrue(selectedReference > selectedVerification); - assertTrue(method.contains("NativeStructureLocatePersistence.probe(")); - assertTrue(method.contains("findUnexplored")); - assertTrue(method.contains("LocateStatus.SEARCH_LIMIT_REACHED")); - assertTrue(method.contains("verified.ownership().locatorY()")); - assertTrue(method.contains("selectedSearch.search().reference(selectedStart)")); - assertTrue(method.contains("NativeStructureLocateResults.selectAndReference(")); - assertFalse(method.contains("NativeStructureLocateCapability")); - assertTrue(source.contains("structureBiomeSource.isStructureReachable(holder)")); - assertFalse(source.contains("isPaperUnavailable")); - String generator = moddedSource("IrisModdedChunkGenerator.java"); - assertTrue(generator.contains("NativeStructureVanillaLocator.predict(")); - assertFalse(generator.contains("super.findNearestMapStructure(level, reachable")); - } - - @Test - public void commandResolvesNativePolicyBeforeAnyVanillaAliasLookup() throws IOException { - String source = source("ModdedLocateCommands.java"); - int methodStart = source.indexOf("static int gotoStructure("); - int methodEnd = source.indexOf("private static void locateIrisStructure(", methodStart); - String method = source.substring(methodStart, methodEnd); - int nativeResolution = method.indexOf("resolveNativeStructure(source, level, engine, key)"); - int editableIrisLookup = method.indexOf( - "IrisStructureLocator.hasLocatableEditablePlacement(engine, key)", nativeResolution); - int policyResolution = method.indexOf( - "NativeStructureGenerationPolicy.resolve(engine, target.key(), false)", editableIrisLookup); - int eligibilityCheck = method.indexOf( - "ModdedCommandSuggestions.isEligibleRegisteredStructure(", policyResolution); - int replacementLocate = method.indexOf( - "locateIrisStructure(source, level, engine, player, target.key())", eligibilityCheck); - int nativeLocate = method.indexOf("runNativeStructureLocate(source, level, player, target)", - replacementLocate); - - assertTrue(nativeResolution >= 0); - assertTrue(editableIrisLookup > nativeResolution); - assertTrue(policyResolution > editableIrisLookup); - assertTrue(eligibilityCheck > policyResolution); - assertTrue(replacementLocate > eligibilityCheck); - assertTrue(nativeLocate > replacementLocate); - assertTrue(method.contains("IrisStructureLocator.hasLocatableNativePlacement(engine, target.key())")); - assertTrue(method.contains("IrisStructureLocator.hasLocatableEditablePlacement(engine, target.key())")); - assertTrue(method.contains("!IrisStructureLocator.hasNativePlacement(engine, key)")); - assertTrue(method.contains("StructureReachability.isReachable(engine, target.key())")); - assertTrue(method.contains("getWorldGenSettings().options().generateStructures()")); - assertFalse(method.contains("IrisStructureLocator.isPlaced(engine, key)")); - } - - @Test - public void verifyResolvesRegisteredNativeBeforeGenericIrisAliases() throws IOException { - String source = source("ModdedLocateCommands.java"); - int methodStart = source.indexOf("private static int verifyStructure("); - int methodEnd = source.indexOf("private static Optional resolveNativeStructure(", - methodStart); - String method = source.substring(methodStart, methodEnd); - int nativeResolution = method.indexOf("resolveNativeStructure(source, level, engine, key)"); - int genericIrisLookup = method.indexOf("IrisStructureLocator.isPlaced(engine, key)", nativeResolution); - - assertTrue(nativeResolution >= 0); - assertTrue(genericIrisLookup > nativeResolution); - assertTrue(method.contains("NativeStructureAvailability.IRIS_SUPPRESSED")); - } - - @Test - public void structureVerificationNoLongerClaimsNativeGenerationIsMissing() throws IOException { - String source = source("ModdedStructureCommands.java"); - - assertTrue(source.contains("verifyTree(\"verify\")")); - assertTrue(source.contains("verifyTree(\"locateall\")")); - assertTrue(source.contains("IrisModdedCommands.verifyStructures(")); - assertFalse(source.contains("Vanilla structure locate is meaningless here")); - } - - private String source(String fileName) throws IOException { - Path source = commonSourceRoot().resolve("art/arcane/iris/modded/command/") - .resolve(fileName) - .normalize(); - return Files.readString(source); - } - - private String moddedSource(String fileName) throws IOException { - Path source = commonSourceRoot().resolve("art/arcane/iris/modded/") - .resolve(fileName) - .normalize(); - return Files.readString(source); - } - - private Path commonSourceRoot() { - String configuredRoot = System.getProperty("iris.moddedCommonSources"); - if (configuredRoot != null && !configuredRoot.isBlank()) { - return Path.of(configuredRoot); - } - return Path.of(System.getProperty("user.dir")) - .resolve("../modded-common/src/main/java") - .normalize(); - } - private IrisNativeStructureDecision decision(NativeStructureGenerationStatus status) { return new IrisNativeStructureDecision(status, 0, null, false, null, null); } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedRiverLocateContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedRiverLocateContractTest.java deleted file mode 100644 index 120328f1f..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedRiverLocateContractTest.java +++ /dev/null @@ -1,28 +0,0 @@ -package art.arcane.iris.modded.command; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public final class ModdedRiverLocateContractTest { - @Test - public void riverLookupMergesRecordedAndEligibleActiveFeatures() throws IOException { - Path sourcePath = Path.of(System.getProperty("iris.moddedCommonSources")) - .resolve("art/arcane/iris/modded/command/ModdedLocateCommands.java"); - String source = Files.readString(sourcePath); - int methodStart = source.indexOf("static int gotoRiver("); - int methodEnd = source.indexOf("static int gotoStructure(", methodStart); - String method = source.substring(methodStart, methodEnd); - - assertTrue(method.contains("GenerationSemanticQueries.nearestRiver(")); - assertTrue(method.contains("runtime == null")); - assertTrue(method.contains("feature.y() + 2")); - assertFalse(method.contains("runtime.nearestFeature(")); - assertFalse(method.contains("feature.y() + engine.getDimension().getMinHeight()")); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStructureHistoryContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStructureHistoryContractTest.java deleted file mode 100644 index 4acb0a399..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStructureHistoryContractTest.java +++ /dev/null @@ -1,34 +0,0 @@ -package art.arcane.iris.modded.command; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public final class ModdedStructureHistoryContractTest { - @Test - public void retainedStructureNamesReachTheSemanticSearchOnBothAdmissionBranches() throws IOException { - Path root = Path.of(System.getProperty("iris.moddedCommonSources")); - String source = Files.readString(root.resolve("art/arcane/iris/modded/command/ModdedLocateCommands.java")); - int start = source.indexOf("static int gotoStructure("); - int end = source.indexOf("static String registeredStructureUnavailableMessage(", start); - String admission = source.substring(start, end); - String retainedCheck = "GenerationFindCatalog.hasRetainedStructurePlacement(engine, key)"; - int firstCheck = admission.indexOf(retainedCheck); - assertTrue(firstCheck >= 0); - assertTrue(admission.indexOf(retainedCheck, firstCheck + retainedCheck.length()) >= 0); - - int locateStart = source.indexOf("private static void locateIrisStructure("); - int locateEnd = source.indexOf("private static void runNativeStructureLocate(", locateStart); - String locate = source.substring(locateStart, locateEnd); - assertTrue(locate.contains("GenerationSemanticQueries.nearestStructure(")); - assertFalse(locate.contains("IrisStructureLocator.locate(")); - - String suggestions = Files.readString(root.resolve("art/arcane/iris/modded/command/ModdedCommandSuggestions.java")); - assertTrue(suggestions.contains("GenerationFindCatalog.retainedStructureKeys(engine)")); - } -} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStudioTeleportContractTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStudioTeleportContractTest.java deleted file mode 100644 index e7047cadd..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/command/ModdedStudioTeleportContractTest.java +++ /dev/null @@ -1,89 +0,0 @@ -package art.arcane.iris.modded.command; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class ModdedStudioTeleportContractTest { - private static final String SOURCE_ROOT_PROPERTY = "iris.moddedCommonSources"; - - @Test - public void studioOpenSerializesReplacementAndWaitsForTheNativePath() throws IOException { - String source = source("command/ModdedStudioCommands.java"); - String open = method(source, "private static int open("); - String execute = method(source, "private static void executeStudioOpen("); - - assertTrue(open.contains("TRANSITIONS.submit(")); - assertFalse(open.contains("orTimeout(")); - assertFalse(open.contains("deadlineNanos")); - assertBefore(execute, "replaceExistingStudio(", "ModdedDimensionManager.createTransientStudio("); - assertBefore(execute, "ModdedDimensionManager.createTransientStudio(", "ModdedDimensionManager.teleportAsync("); - assertFalse(execute.contains("deadlineNanos")); - assertFalse(source.contains("player.teleportTo(studio")); - } - - @Test - public void studioTeleportAndVisionShareWarmFutureSemantics() throws IOException { - String studio = source("command/ModdedStudioCommands.java"); - String vision = source("command/ModdedVisionOverlay.java"); - String dimensions = source("ModdedDimensionManager.java"); - - assertTrue(studio.contains("private static CompletableFuture teleportToStudio(")); - assertTrue(studio.contains("ModdedDimensionManager.teleportAsync(")); - assertTrue(dimensions.contains("TELEPORT_WARM_RADIUS = 0")); - assertTrue(dimensions.contains("addTicketAndLoadWithRadius(\n" - + " TELEPORT_WARM_TICKET,\n" - + " chunkPos,\n" - + " TELEPORT_WARM_RADIUS)")); - assertTrue(dimensions.contains("removeTicketWithRadius(\n" - + " TELEPORT_WARM_TICKET,\n" - + " chunkPos,\n" - + " TELEPORT_WARM_RADIUS)")); - assertTrue(vision.contains("Math.floor(worldX)")); - assertTrue(vision.contains("Math.floor(worldZ)")); - assertTrue(vision.contains("if (opener != null)")); - assertTrue(vision.contains("ModdedDimensionManager.teleportAsync(")); - assertFalse(vision.contains("level.getHeight(")); - assertFalse(vision.contains("player.teleportTo(")); - } - - private static String source(String relative) throws IOException { - String root = System.getProperty(SOURCE_ROOT_PROPERTY); - if (root == null || root.isBlank()) { - throw new IllegalStateException("Missing test property " + SOURCE_ROOT_PROPERTY); - } - return Files.readString(Path.of(root).resolve("art/arcane/iris/modded").resolve(relative)) - .replace("\r\n", "\n"); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - if (start < 0) { - throw new IllegalArgumentException("Missing source method " + signature); - } - int open = source.indexOf('{', start); - int depth = 0; - for (int index = open; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}' && --depth == 0) { - return source.substring(start, index + 1); - } - } - throw new IllegalArgumentException("Unclosed source method " + signature); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source token " + first, firstIndex >= 0); - assertTrue("Missing source token " + second, secondIndex >= 0); - assertTrue(first + " must precede " + second, firstIndex < secondIndex); - } -} diff --git a/adapters/neoforge/build.gradle b/adapters/neoforge/build.gradle index cde2ef066..ca7ea081c 100644 --- a/adapters/neoforge/build.gradle +++ b/adapters/neoforge/build.gradle @@ -222,7 +222,6 @@ tasks.named('compileJava', JavaCompile).configure { tasks.named('test').configure { useJUnitPlatform() - systemProperty('iris.moddedCommonSources', file('../modded-common/src/main/java').absolutePath) } processResources { diff --git a/core/src/test/java/art/arcane/iris/core/DiagnosticSeverityPolicyTest.java b/core/src/test/java/art/arcane/iris/core/DiagnosticSeverityPolicyTest.java deleted file mode 100644 index 143d5f018..000000000 --- a/core/src/test/java/art/arcane/iris/core/DiagnosticSeverityPolicyTest.java +++ /dev/null @@ -1,182 +0,0 @@ -package art.arcane.iris.core; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.List; -import java.util.stream.Stream; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -/** - * Every core diagnostic keeps its severity through to the server log, so the level a call site picks is the - * level an operator scanning for WARN and SEVERE sees. This pins the two ends of that decision: conditions an - * operator must act on stay at WARN or ERROR, and conditions that repeat per block, per sample or per chunk - - * or that report designed backpressure, a probe on an optional dependency, or a success - do not. - *

- * The pin is on the source rather than on a live engine because most of these call sites need a running world - * to reach, and what is being fixed is the choice of level, not the condition that triggers it. - */ -public class DiagnosticSeverityPolicyTest { - @Test - public void perBlockAndPerSampleConditionsDoNotReachTheServerLogAtWarnLevel() { - assertLoggedWith("util/project/hunk/Hunk.java", "OUT OF BOUNDS ", "debug"); - assertLoggedWith("engine/mantle/MantleWriter.java", "No set? ", "debug"); - assertLoggedWith("engine/mantle/MantleWriter.java", "Mantle Writer Accessed chunk out of bounds", "debug"); - assertLoggedWith("engine/object/IrisDecorator.java", "Empty Block Data for ", "warnOnce"); - assertLoggedWith("engine/object/IrisCompat.java", "Can't find block data for ", "warnOnce"); - assertLoggedWith("engine/data/cache/AtomicCache.java", "Atomic cache supplier failed: %s: %s", "warnOnce"); - assertLoggedWith("engine/IrisComplex.java", "Failed to sample interpolated biome bounds", "warnOnce"); - assertLoggedWith("engine/framework/placer/WorldObjectPlacer.java", "Tried to place custom block at", "warnOnce"); - } - - /** - * Backpressure pausing generation is the design working. It is reported every five seconds for the whole - * duration of a large pregen, so at WARN it would be the only thing a log scan finds. - */ - @Test - public void designedBackpressureIsReportedWithoutRaisingAWarning() { - assertLoggedWith("core/pregenerator/PregenMantleBackpressure.java", "Pregen mantle backpressure: ", "info"); - assertLoggedWith("core/pregenerator/PregenMantleBackpressure.java", "Pregen heap pressure: pausing generation", "info"); - assertLoggedWith("core/pregenerator/MantleHeapPressure.java", "Iris heap remained at", "info"); - assertLoggedWith("core/pregenerator/methods/AsyncPregenMethod.java", "is still pending after", "debug"); - } - - @Test - public void generationTracingStaysAtDebugLevel() { - assertLoggedWith("engine/mantle/components/MantleObjectComponent.java", "Regen object layer start:", "debug"); - assertLoggedWith("engine/mantle/components/MantleObjectComponent.java", "Goldendebug object attempt:", "debug"); - assertLoggedWith("engine/mantle/components/GoldenDebugObjectPlacer.java", "Goldendebug query:", "debug"); - assertLoggedWith("engine/mantle/components/IrisStructureComponent.java", "[StructTrace] ORIGIN", "debug"); - } - - @Test - public void coreProductionDoesNotWriteDirectlyToProcessStreams() throws IOException { - try (Stream files = Files.walk(Path.of("src/main/java"))) { - List bypasses = files - .filter(path -> path.toString().endsWith(".java")) - .filter(path -> { - try { - String source = Files.readString(path); - return source.contains("System.out") - || source.contains("System.err") - || source.contains(".printStackTrace();"); - } catch (IOException unreadable) { - throw new IllegalStateException(unreadable); - } - }) - .toList(); - assertTrue(bypasses.toString(), bypasses.isEmpty()); - } - } - - @Test - public void probesOnOptionalDependenciesAreNotWarnings() throws IOException { - assertLoggedWith("core/link/MultiverseCoreLink.java", "is not reachable; Iris world settings", "info"); - assertLoggedWith("core/link/MultiverseCoreLink.java", "Multiverse will record the live name", "info"); - assertLoggedWith("core/gui/GuiHost.java", "Unable to install the Iris desktop quit guard", "info"); - String slimJar = read("util/common/misc/SlimJar.java"); - assertTrue(slimJar.contains("debug(plugin, \"Failed to inject the library loader")); - assertTrue(slimJar.contains("if (DEBUG)")); - assertTrue(slimJar.contains("plugin.getLogger().info(\"[DEBUG] \" + message)")); - } - - /** - * A refused destructive command is the guard working, and the admin who typed it is told directly. The - * console record of it is not a warning about the server. - */ - @Test - public void aRefusedMultiverseCommandIsRecordedWithoutRaisingAWarning() throws IOException { - String guard = read("core/link/MultiverseGuardListener.java"); - - assertTrue("the console record of a refusal is kept", guard.contains("IrisLogging.info(\"%s %s\", reason, remedy)")); - assertFalse("the refusal is not a warning about the server", guard.contains("IrisLogging.warn(\"%s %s\"")); - } - - @Test - public void decorationAndBlankLinesAreNotEmittedAtAnySeverity() throws IOException { - String safeguard = read("core/safeguard/IrisSafeguard.java"); - assertFalse("a blank record renders as an empty [WARN] line", safeguard.contains("IrisLogging.warn(\"\")")); - assertFalse("a blank record renders as an empty [SEVERE] line", safeguard.contains("IrisLogging.error(\"\")")); - assertFalse("a blank record renders as an empty [INFO] line", safeguard.contains("IrisLogging.info(\"\")")); - assertFalse("a separator rule is not a diagnostic", safeguard.contains("--==<")); - - String configurator = read("core/ServerConfigurator.java"); - assertFalse("a separator rule is not a diagnostic", configurator.contains("IrisLogging.error(\"====")); - assertFalse("a separator rule is not a diagnostic", configurator.contains("IrisLogging.error(\"----")); - } - - /** - * A written debug image is a success, and the method that wrote it had no callers at all. - */ - @Test - public void theUnusedDebugImageWriterIsGone() throws IOException { - assertFalse(read("engine/object/IrisImage.java").contains("writeDebug")); - } - - /** - * The other end of the policy. These are the conditions the promotion exists for. - */ - @Test - public void operatorActionableConditionsKeepTheirSeverity() { - assertLoggedWith("core/lifecycle/VanishedWorldStorage.java", "Iris world storage is gone at", "error"); - assertLoggedWith("core/IrisWorlds.java", "has unusable world storage and is excluded", "error"); - assertLoggedWith("engine/EngineDataStore.java", "Failed to setup Engine Data", "error"); - assertLoggedWith("engine/IrisEngineMantle.java", "Failed to read chunk section, skipping it.", "error"); - assertLoggedWith("engine/IrisEngineMantle.java", "Failed to read chunk, creating a new chunk instead.", "error"); - assertLoggedWith("util/common/reflect/WrappedField.java", "Failed to created WrappedField", "error"); - assertLoggedWith("core/datapack/DatapackIngestService.java", "Repairing modified or corrupt Iris-managed datapack", "warn"); - assertLoggedWith("core/pregenerator/cache/PregenCacheImpl.java", "Pregen cache storage is gone at", "warn"); - assertLoggedWith("core/pregenerator/PregenMantleBackpressure.java", "Pregen mantle backpressure exceeded ", "warn"); - assertLoggedWith("core/pregenerator/PregenMantleBackpressure.java", "Pregen heap pressure wait exceeded ", "warn"); - assertLoggedWith("core/pregenerator/IrisPregenerator.java", "failed chunk(s); failures are not cached", "warn"); - assertLoggedWith("core/service/MultiverseSVC.java", "Multiverse world events are not bindable", "warn"); - } - - /** - * A handful of lifecycle lines an operator reads logs/latest.log to find. NOTICE is the level adapters - * route to the server's own logger rather than to the console sender. - */ - @Test - public void lifecycleLinesAreRaisedAtNoticeLevel() { - assertLoggedWith("engine/IrisEngine.java", "Engine init: ", "notice"); - assertLoggedWith("core/link/MultiverseCoreLink.java", "Adopted %d live Iris world", "notice"); - assertLoggedWith("core/pregenerator/IrisPregenerator.java", "Pregen finished: ", "notice"); - } - - private static void assertLoggedWith(String relativePath, String fragment, String expectedMethod) { - String source; - try { - source = read(relativePath); - } catch (IOException unreadable) { - throw new AssertionError("Cannot read " + relativePath, unreadable); - } - - int occurrences = 0; - for (int at = source.indexOf(fragment); at >= 0; at = source.indexOf(fragment, at + 1)) { - occurrences++; - assertEquals(relativePath + " @ \"" + fragment + "\" occurrence " + occurrences, - expectedMethod, loggingMethodBefore(source, at, relativePath, fragment)); - } - assertTrue(relativePath + " no longer contains \"" + fragment + "\"", occurrences > 0); - } - - private static String loggingMethodBefore(String source, int at, String relativePath, String fragment) { - int call = source.lastIndexOf("IrisLogging.", at); - assertTrue(relativePath + " @ \"" + fragment + "\" is not logged through IrisLogging", call >= 0); - int start = call + "IrisLogging.".length(); - int end = start; - while (end < source.length() && Character.isJavaIdentifierPart(source.charAt(end))) { - end++; - } - return source.substring(start, end); - } - - private static String read(String relativePath) throws IOException { - return Files.readString(Path.of("src/main/java/art/arcane/iris").resolve(relativePath)).replace("\r\n", "\n"); - } -} diff --git a/core/src/test/java/art/arcane/iris/core/IrisWorldsTest.java b/core/src/test/java/art/arcane/iris/core/IrisWorldsTest.java index a1ea35ebf..76942122a 100644 --- a/core/src/test/java/art/arcane/iris/core/IrisWorldsTest.java +++ b/core/src/test/java/art/arcane/iris/core/IrisWorldsTest.java @@ -95,28 +95,6 @@ public class IrisWorldsTest { * asserted against the source: one unusable world folder used to throw out of {@code clean()}, through * the constructor and into the cache, which returned null and NPE'd every caller. */ - @Test - public void oneUnusableWorldIsExcludedInsteadOfFailingTheWholeRegistry() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/IrisWorlds.java")).replace("\r\n", "\n"); - - int accessor = source.indexOf("public static IrisWorlds get()"); - int accessorEnd = source.indexOf("public synchronized void put(", accessor); - assertTrue("get() must not swallow a failure into a null return", - source.substring(accessor, accessorEnd).contains("cache.aquireOnceOrThrow(")); - - int clean = source.indexOf("public synchronized void clean()"); - int cleanEnd = source.indexOf("public synchronized void save()", clean); - String cleanBody = source.substring(clean, cleanEnd); - assertTrue("clean() must isolate an unusable entry", - cleanBody.contains("catch (IllegalStateException e)")); - assertTrue("an unusable entry stays in the registry so /iris remove can still find it", - cleanBody.contains("warnUnusableStorage(entry.getKey(), e);")); - - int loadDimension = source.indexOf("private IrisDimension loadDimension("); - assertTrue("loadDimension must exclude an unusable world rather than propagate", - source.substring(loadDimension).contains("catch (IllegalStateException unusableStorage)")); - } - @Test public void bukkitWorldFilteringRecognizesCurrentCraftBukkitConfiguredStorage() throws Exception { Path worldContainer = temporaryFolder.newFolder("configured-server").toPath(); diff --git a/core/src/test/java/art/arcane/iris/core/ProgressBossBarToggleTest.java b/core/src/test/java/art/arcane/iris/core/ProgressBossBarToggleTest.java index 15eed1c4f..b137b3d9d 100644 --- a/core/src/test/java/art/arcane/iris/core/ProgressBossBarToggleTest.java +++ b/core/src/test/java/art/arcane/iris/core/ProgressBossBarToggleTest.java @@ -3,9 +3,6 @@ package art.arcane.iris.core; import art.arcane.iris.platform.bukkit.BukkitPlatform; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; - import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; @@ -28,55 +25,6 @@ public class ProgressBossBarToggleTest { () -> BukkitPlatform.showProgressLane(null, "iris:job", "Working", 0.5D, 4000L))); } - @Test - public void studioOpenBossBarIsGatedBySettings() throws Exception { - assertGated("core/project/StudioOpenProgressReporter.java"); - } - - @Test - public void worldCreationAlwaysUsesTheActionBarInsteadOfABossBar() throws Exception { - String source = source("core/tools/WorldCreationProgressReporter.java"); - - assertFalse(source.contains("isProgressBossBar()")); - assertFalse(source.contains("Bukkit.createBossBar(")); - assertTrue(source.contains("WORLD_CREATE_LIFECYCLE_ACTION")); - } - - @Test - public void chunkJobBossBarIsGatedBySettings() throws Exception { - assertGated("core/runtime/ChunkJobReporter.java"); - } - - @Test - public void packDownloadLaneIsGatedWhileTheActionBarSurvives() throws Exception { - String source = source("core/service/PackDownloadProgressReporter.java"); - - assertTrue(source.contains("isProgressBossBar()")); - assertTrue("the action bar must keep reporting when boss bars are off", - source.contains("sender.sendAction(snapshot.line())")); - } - - @Test - public void pregenLaneIsGatedWhileTheActionBarSurvives() throws Exception { - String source = source("core/tools/IrisCreator.java"); - int lane = source.indexOf("\"iris:pregen\""); - int gate = source.lastIndexOf("isProgressBossBar()", lane); - - assertTrue("the pregen boss bar lane must sit behind general.progressBossBar", - gate > 0 && lane - gate < 200); - assertTrue("the action bar must keep reporting when boss bars are off", - source.contains("RuntimeProgressMessages.WORLD_PREGEN_ACTION")); - } - - private void assertGated(String relativePath) throws Exception { - assertTrue(relativePath + " must consult general.progressBossBar before creating a boss bar", - source(relativePath).contains("isProgressBossBar()")); - } - - private String source(String relativePath) throws Exception { - return Files.readString(Path.of("src/main/java/art/arcane/iris").resolve(relativePath)).replace("\r\n", "\n"); - } - private void withProgressBossBar(boolean enabled, Runnable body) { IrisSettings previous = IrisSettings.settings; try { diff --git a/core/src/test/java/art/arcane/iris/core/ServerConfiguratorDatapackFingerprintTest.java b/core/src/test/java/art/arcane/iris/core/ServerConfiguratorDatapackFingerprintTest.java index b9b8120fb..7a767d932 100644 --- a/core/src/test/java/art/arcane/iris/core/ServerConfiguratorDatapackFingerprintTest.java +++ b/core/src/test/java/art/arcane/iris/core/ServerConfiguratorDatapackFingerprintTest.java @@ -384,43 +384,6 @@ public class ServerConfiguratorDatapackFingerprintTest { } } - @Test - public void recoveryRunsBeforeRestoredFingerprintReuseHashFallbackAndCompilation() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/ServerConfigurator.java")).replace("\r\n", "\n"); - int installIfChanged = source.indexOf("installDataPacksIfChanged(boolean fullInstall)"); - int recovery = source.indexOf("DatapackIngestService.reapplyFromStaging", installIfChanged); - int restored = source.indexOf("restoredCompilerInputFingerprint()", recovery); - int fingerprint = source.indexOf("computeCurrentDatapackCompilerInputFingerprint", restored); - int earlyReturn = source.indexOf("resultForUnchangedFingerprint", fingerprint); - int compile = source.indexOf("compileDataPacksLocked(", earlyReturn); - int cache = source.indexOf("writeCompilerInputFingerprintCache(cacheFile.toPath(), current)", compile); - - assertTrue(recovery >= 0); - assertTrue(restored > recovery); - assertTrue(fingerprint > restored); - assertTrue(earlyReturn > fingerprint); - assertTrue(compile > earlyReturn); - assertTrue(cache > compile); - } - - @Test - public void studioTimingSeparatesRecoveryFingerprintCompilationAndTotal() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/ServerConfigurator.java")).replace("\r\n", "\n"); - int timedInstall = source.indexOf("BiConsumer timingConsumer"); - int recovery = source.indexOf("\"datapack_external_recovery\"", timedInstall); - int fingerprint = source.indexOf("\"datapack_compiler_input_fingerprint\"", recovery); - int compile = source.indexOf("\"datapack_compile_publish\"", fingerprint); - int total = source.indexOf("\"datapack_install_if_changed_total\"", compile); - - assertTrue(timedInstall >= 0); - assertTrue(recovery > timedInstall); - assertTrue(fingerprint > recovery); - assertTrue(compile > fingerprint); - assertTrue(total > compile); - } - @Test public void loadedRuntimeReuseRequiresAnExactPinnedCompilerInputFingerprint() { assertTrue(ServerConfigurator.reusableRuntimeFingerprint("abc", "abc")); diff --git a/core/src/test/java/art/arcane/iris/core/ServerConfiguratorStartupRestartTest.java b/core/src/test/java/art/arcane/iris/core/ServerConfiguratorStartupRestartTest.java index fc4773c40..2e4b0aefd 100644 --- a/core/src/test/java/art/arcane/iris/core/ServerConfiguratorStartupRestartTest.java +++ b/core/src/test/java/art/arcane/iris/core/ServerConfiguratorStartupRestartTest.java @@ -9,8 +9,6 @@ import org.objectweb.asm.ClassVisitor; import org.objectweb.asm.MethodVisitor; import org.objectweb.asm.Opcodes; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.concurrent.atomic.AtomicBoolean; import static org.junit.Assert.assertFalse; @@ -92,30 +90,6 @@ public class ServerConfiguratorStartupRestartTest { assertFalse(directRestartInvocation.get()); } - @Test - public void startupRestartPathsPromoteTheValidationStateAndBypassTickQueues() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/ServerConfigurator.java")); - String configure = section( - source, - "public static void configure()", - "public static boolean isLoadedDatapackRuntimeReady"); - String startupRestart = section( - source, - "public static void restartAtStartupBoundary", - "public static boolean verifyDataPackInstalled"); - - int restartResult = configure.indexOf("if (result.restartRequired())"); - int validationRestart = configure.indexOf("requireDatapackRestart();", restartResult); - assertTrue(restartResult >= 0); - assertTrue(validationRestart > restartResult); - assertTrue(startupRestart.indexOf("invokeImmediateRestartIfSupported(Bukkit.class)") - < startupRestart.indexOf("Bukkit.shutdown();")); - assertFalse(startupRestart.contains("Bukkit.restart")); - assertFalse(startupRestart.contains("J.s(")); - assertFalse(startupRestart.contains("dispatchCommand")); - } - public static final class RestartCapableApi { private static boolean restarted; @@ -126,12 +100,4 @@ public class ServerConfiguratorStartupRestartTest { public static final class ShutdownOnlyApi { } - - private static String section(String source, String startMarker, String endMarker) { - int start = source.indexOf(startMarker); - int end = source.indexOf(endMarker, start); - assertTrue(start >= 0); - assertTrue(end > start); - return source.substring(start, end); - } } diff --git a/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java b/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java index 5dc9b9fce..af1f73860 100644 --- a/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java +++ b/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java @@ -15,7 +15,6 @@ import java.io.File; import java.io.PrintStream; import java.nio.charset.StandardCharsets; import java.nio.file.Files; -import java.nio.file.Path; import java.nio.file.attribute.FileTime; import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; @@ -255,23 +254,6 @@ public class SettingsHotloadWatchTest { assertEquals("Active " + PERMISSION, permissionMessage()); } - @Test - public void bukkitAndModdedUseTheSameCoreCoordinator() throws Exception { - String bukkit = Files.readString(Path.of( - "../adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java" - )); - String modded = Files.readString(Path.of( - "../adapters/modded-common/src/main/java/art/arcane/iris/modded/service/ModdedSettingsHotloadService.java" - )); - - assertTrue(bukkit.contains("new SettingsHotloadWatch(")); - assertTrue(modded.contains("new SettingsHotloadWatch(")); - assertFalse(bukkit.contains("new ConfigHotloadEngine(")); - assertFalse(modded.contains("new ConfigHotloadEngine(")); - assertFalse(bukkit.contains("IrisLanguage.update()")); - assertFalse(modded.contains("IrisLanguage.update()")); - } - private void awaitPermissionMessage(String expected) throws Exception { long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(6L); while (System.nanoTime() < deadline) { diff --git a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestRuntimeInvalidationTest.java b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestRuntimeInvalidationTest.java deleted file mode 100644 index f5f78a13d..000000000 --- a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestRuntimeInvalidationTest.java +++ /dev/null @@ -1,51 +0,0 @@ -package art.arcane.iris.core.datapack; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertTrue; - -public class DatapackIngestRuntimeInvalidationTest { - @Test - public void everyPublicMutationInvalidatesLoadedRuntimeBeforeLocking() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java")).replace("\r\n", "\n"); - - assertInvalidatesBeforeLock(source, "public static Report ingest("); - assertInvalidatesBeforeLock(source, "public static ReapplyOutcome reapplyFromStaging("); - assertInvalidatesBeforeLock(source, "public static boolean remove("); - } - - @Test - public void noChangeChecksRestoreWhileChangedIngestRemainsRestartBound() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java")).replace("\r\n", "\n"); - int ingest = source.indexOf("public static Report ingest("); - int unlock = source.indexOf("TRANSACTION_LOCK.unlock();", ingest); - int restore = source.indexOf( - "ServerConfigurator.restoreLoadedDatapackRuntimeIfUnchanged(invalidation);", - unlock); - int changed = source.indexOf("else if (report.changed())", restore); - int restart = source.indexOf("ServerConfigurator.restart();", changed); - int restartRequired = source.indexOf("ServerConfigurator.requireDatapackRestart();", restart); - - assertTrue(ingest >= 0); - assertTrue(unlock > ingest); - assertTrue(restore > unlock); - assertTrue(changed > restore); - assertTrue(restart > changed); - assertTrue(restartRequired > restart); - } - - private void assertInvalidatesBeforeLock(String source, String signature) { - int method = source.indexOf(signature); - int invalidation = source.indexOf("ServerConfigurator.invalidateLoadedDatapackRuntime();", method); - int lock = source.indexOf("TRANSACTION_LOCK.lock();", method); - - assertTrue("Missing datapack mutation entry point " + signature, method >= 0); - assertTrue("Loaded runtime must be invalidated before " + signature, invalidation > method); - assertTrue("Loaded runtime invalidation must precede the transaction lock", invalidation < lock); - } -} diff --git a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java index eebb01096..de8447788 100644 --- a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java +++ b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java @@ -246,39 +246,6 @@ public class DatapackIngestServiceTest { validated, "26.2", 4000, true, true, validated.urls)); } - @Test - public void startupChecksCheapCacheContextBeforeHashingManagedDatapacks() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java")).replace("\r\n", "\n"); - int validation = source.indexOf("public static StartupValidationOutcome validateOnStartup()"); - int cacheRead = source.indexOf("readStartupValidationCache", validation); - int contextCheck = source.indexOf("startupValidationContextMatches(", cacheRead); - int fingerprint = source.indexOf("startupValidationFingerprint(", contextCheck); - int fullValidation = source.indexOf("if (autoIngest && !configured.isEmpty())", fingerprint); - - assertTrue(validation >= 0); - assertTrue(cacheRead > validation); - assertTrue(contextCheck > cacheRead); - assertTrue(fingerprint > contextCheck); - assertTrue(fullValidation > fingerprint); - } - - @Test - public void unchangedPostStartupMaintenanceReturnsBeforeFingerprinting() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java")).replace("\r\n", "\n"); - int refresh = source.indexOf( - "refreshStartupValidationAfterMaintenance(boolean maintenanceChanged)"); - int unchangedGuard = source.indexOf("if (!maintenanceChanged)", refresh); - int validatedState = source.indexOf("StartupValidationCache validated", refresh); - int fingerprint = source.indexOf("startupValidationFingerprint(", refresh); - - assertTrue(refresh >= 0); - assertTrue(unchangedGuard > refresh); - assertTrue(validatedState > unchangedGuard); - assertTrue(fingerprint > unchangedGuard); - } - @Test public void packMetadataMustContainAValidPackContract() throws Exception { File valid = temporaryFolder.newFolder("valid"); @@ -894,27 +861,6 @@ public class DatapackIngestServiceTest { assertEquals(expected, ownershipHash(managed)); } - @Test - public void directoryHashRestatsAttributesAndVolumeBeforeOpeningEachFile() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java")).replace("\r\n", "\n"); - int method = source.indexOf("private static String directoryHash(File root)"); - int entries = source.indexOf("List entries = new ArrayList<>()", method); - int loop = source.indexOf("for (Path entry : entries)", entries); - int attributes = source.indexOf("BasicFileAttributes attributes = Files.readAttributes(", loop); - int fileStore = source.indexOf("Files.getFileStore(entry)", attributes); - int open = source.indexOf("Files.newInputStream(", fileStore); - int digest = source.indexOf("return hex(digest.digest())", open); - - assertTrue(method >= 0); - assertTrue(entries > method); - assertTrue(loop > entries); - assertTrue(attributes > loop); - assertTrue(fileStore > attributes); - assertTrue(open > fileStore); - assertTrue(digest > open); - } - @Test public void failedUpdateStagingCannotBeAdoptedByTheCommittedManifest() throws Exception { File staging = datapackDirectory("candidate-staging"); @@ -3880,8 +3826,6 @@ public class DatapackIngestServiceTest { } private static final class DeleteAttemptFile extends File { - private static final long serialVersionUID = 1L; - private final int successfulAttempt; private int deleteAttempts; diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleUnloadAsyncTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleUnloadAsyncTest.java index 45c433f33..83ff1a86c 100644 --- a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleUnloadAsyncTest.java +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleUnloadAsyncTest.java @@ -10,8 +10,6 @@ import org.junit.Test; import org.mockito.MockedStatic; import java.lang.reflect.Method; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionException; import java.util.concurrent.CompletionStage; @@ -59,40 +57,6 @@ public class WorldLifecycleUnloadAsyncTest { } } - @Test - public void paperLikeManualUnloadDetachesBeforeOffThreadChunkDrain() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupport.java")) - .replace("\r\n", "\n"); - int unloadStart = source.indexOf("private static CompletableFuture unloadWorldWithoutAsyncApi("); - int unloadEnd = source.indexOf("static boolean announceManualWorldUnload", unloadStart); - String unloadMethod = source.substring(unloadStart, unloadEnd); - int capabilityFallback = unloadMethod.indexOf( - "capabilities.minecraftServer() == null || capabilities.removeLevelMethod() == null"); - int bukkitUnload = unloadMethod.indexOf("Bukkit.unloadWorld(world, save)", capabilityFallback); - int detach = unloadMethod.indexOf("detachServerLevelAsync(capabilities, serverLevel, world)"); - int drain = unloadMethod.indexOf("drainChunkTasksAsync(world, serverLevel)"); - int close = unloadMethod.indexOf("closeServerLevelAsync(world, serverLevel)"); - int closeStart = source.indexOf("private static CompletableFuture closeServerLevelAsync("); - int closeEnd = source.indexOf("private static CompletableFuture drainChunkTasksAsync(", closeStart); - String closeMethod = source.substring(closeStart, closeEnd); - int drainStart = closeEnd; - int drainEnd = source.indexOf("private static void removeWorldFromCraftServerMap", drainStart); - String drainMethod = source.substring(drainStart, drainEnd); - - assertTrue(capabilityFallback >= 0); - assertTrue(bukkitUnload > capabilityFallback); - assertTrue(detach > bukkitUnload); - assertTrue(drain > detach); - assertTrue(close > drain); - assertTrue(drainMethod.contains("return J.afut(() ->")); - assertTrue(drainMethod.contains("\"moonrise$getChunkTaskScheduler\"")); - assertTrue(drainMethod.contains("\"halt\"")); - assertTrue(closeMethod.contains("return runGlobalAsync(closeTask)")); - assertFalse(closeMethod.contains("J.afut(")); - assertFalse(closeMethod.contains("J.runRegion(")); - } - @Test public void reflectedAsyncUnloadWaitsForTrueCallback() throws Exception { CallbackServer server = new CallbackServer(); diff --git a/core/src/test/java/art/arcane/iris/core/link/MultiverseCoreLinkTest.java b/core/src/test/java/art/arcane/iris/core/link/MultiverseCoreLinkTest.java index 83e9aa9d6..4fd50e2d7 100644 --- a/core/src/test/java/art/arcane/iris/core/link/MultiverseCoreLinkTest.java +++ b/core/src/test/java/art/arcane/iris/core/link/MultiverseCoreLinkTest.java @@ -18,8 +18,6 @@ import org.mvplugins.multiverse.external.vavr.control.Option; import java.io.File; import java.lang.reflect.Method; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.Arrays; import java.util.List; import java.util.Map; @@ -53,16 +51,6 @@ public class MultiverseCoreLinkTest { && method.getParameterCount() == 2)); } - @Test - public void registrationDoesNotRewriteTheRecordedMultiverseName() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/link/MultiverseCoreLink.java")).replace("\r\n", "\n"); - - assertFalse("worlds are created under the startup name, so the recorded name needs no correction", - source.contains("setLegacyWorldName")); - assertTrue("Multiverse still has to be told the live world name it will record", - source.contains("ImportWorldOptions.worldName(world.getName())")); - } - @Test public void lookupNamesAddTheIrisKeyAndRuntimeNameForConfiguredStartupNames() { assertEquals( diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackExportClosureTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackExportClosureTest.java index c3c3aed2c..263785347 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackExportClosureTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackExportClosureTest.java @@ -8,8 +8,6 @@ import art.arcane.iris.engine.object.IrisStaticObject; import art.arcane.volmlib.util.collection.KList; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import java.util.Map; @@ -102,47 +100,4 @@ public class PackExportClosureTest { * Source guard: both packagers must export the ambient-spawning graph. Spawner and marker * folders were silently omitted from exports, leaving dangling entitySpawners references. */ - @Test - public void bothPackagersExportSpawnersMarkersAndTheFullEntityGraph() throws Exception { - String bukkit = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/project/IrisPackageCompiler.java")).replace("\r\n", "\n"); - assertTrue("Bukkit packager must write spawners/", bukkit.contains("\"spawners/\"")); - assertTrue("Bukkit packager must write markers/", bukkit.contains("\"markers/\"")); - assertTrue("Bukkit packager must export region objects alongside biome objects", - bukkit.contains("regions.forEach((r) -> allPlacements.addAll(r.getObjects()))")); - assertTrue("Bukkit packager must export static objects", - bukkit.contains("exportedDimension.getStaticObjects()")); - assertTrue("Bukkit obfuscation must rewrite static object references", - bukkit.contains("placement.setObject(renameObjects.get(placement.getObject()))")); - assertTrue("Bukkit packager must export entity loot tables", bukkit.contains("getLoot().getTables()")); - assertTrue("Bukkit packager must include dimension-stack resources", - bukkit.contains("PackExportClosure.collectDimensionKeys(dimension)")); - assertTrue("Bukkit packager must export expression-backed stack blend styles", - bukkit.contains("dm.getExpressionLoader().getPossibleKeys()") - && bukkit.contains("\"expressions/\"")); - int bukkitValidation = bukkit.indexOf("PackValidator.validateForPackaging(project.getPath())"); - assertTrue("Bukkit packager must validate before opening or mutating package state", - bukkitValidation >= 0 - && bukkitValidation < bukkit.indexOf("IrisData.openRuntime(project.getPath())") - && bukkitValidation < bukkit.indexOf("IO.delete(folder)")); - - String modded = Files.readString(Path.of( - "../adapters/modded-common/src/main/java/art/arcane/iris/modded/command/ModdedStudioCommands.java")).replace("\r\n", "\n"); - assertTrue("modded packager must write spawners/", modded.contains("\"spawners\"")); - assertTrue("modded packager must write markers/", modded.contains("\"markers\"")); - assertTrue("modded packager must include initial spawns", modded.contains("getInitialSpawns")); - assertTrue("modded packager must export region objects", modded.contains("region.getObjects()")); - assertTrue("modded packager must export static objects", - modded.contains("PackExportClosure.collectStaticObjectKeys(exportedDimension.getStaticObjects())")); - assertTrue("modded packager must include dimension-stack resources", - modded.contains("PackExportClosure.collectDimensionKeys(dimension)")); - assertTrue("modded packager must export expression-backed stack blend styles", - modded.contains("dm.getExpressionLoader().getPossibleKeys()") - && modded.contains("\"expressions\"")); - assertTrue("modded packager must retain referenced style snippets", - modded.contains("copyStyleSnippets(packFolder, folder)")); - int moddedValidation = modded.indexOf("PackValidator.validateForPackaging(packFolder)"); - assertTrue("modded packager must validate before mutating package state", - moddedValidation >= 0 && moddedValidation < modded.indexOf("IO.delete(folder)")); - } } diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/methods/PregenMantleCleanupContractTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/methods/PregenMantleCleanupContractTest.java deleted file mode 100644 index fc4d18c93..000000000 --- a/core/src/test/java/art/arcane/iris/core/pregenerator/methods/PregenMantleCleanupContractTest.java +++ /dev/null @@ -1,144 +0,0 @@ -package art.arcane.iris.core.pregenerator.methods; - -import org.junit.Test; - -import java.io.IOException; -import java.net.URISyntaxException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class PregenMantleCleanupContractTest { - @Test - public void normalEngineCleanupRetriesCandidatesCoveredByTheNewestRealChunk() throws IOException { - String source = read("art/arcane/iris/engine/framework/Engine.java"); - String cleanup = method(source, "default void cleanupMantleChunk(int x, int z)"); - - assertTrue(cleanup.contains("cleanupChunksCoveredBy(")); - assertTrue(cleanup.contains("EngineMantle.ChunkCleanupCallback.NONE")); - assertFalse(cleanup.contains(".cleanupChunk(x, z)")); - } - - @Test - public void asyncPregenReportsOnlyCleanupCallbacksFromCoveredTargets() throws IOException { - String source = read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"); - String completion = method(source, "private void completeChunk("); - String cleanup = method(source, "private void cleanupMantleChunksCoveredBy("); - - assertTrue(completion.contains("cleanupMantleChunksCoveredBy(x, z, listener)")); - assertFalse(completion.contains("listener.onChunkCleaned")); - assertTrue(cleanup.contains("cleanupChunksCoveredBy(x, z, true, listener::onChunkCleaned)")); - assertFalse(cleanup.contains("forceCleanupChunk")); - } - - @Test - public void finalChunkFlushUsesTargetedPersistenceWithoutFullWorldSave() throws IOException { - String source = read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"); - String flush = method(source, "private void flushAllRemainingChunks()"); - String medievalSource = read("art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java"); - String medievalFlush = method(medievalSource, "private void unloadAndSaveAllChunks("); - - assertTrue(flush.contains("evictRegion(regionKey)")); - assertTrue(flush.contains("INMS.get().flushChunkIO(world)")); - assertFalse(flush.contains("world.save()")); - assertTrue(medievalFlush.contains("i.unload(true)")); - assertTrue(medievalFlush.contains("INMS.get().flushChunkIO(world)")); - assertFalse(medievalFlush.contains("world.save()")); - } - - @Test - public void foliaFinalEvictionUsesAwaitableRegionOwnedTasks() throws IOException { - String source = read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"); - String eviction = method(source, "private CompletableFuture evictFoliaRegion("); - - assertTrue(eviction.contains("J.runRegionFuture(")); - assertTrue(eviction.contains("CompletableFuture.allOf(")); - assertFalse(eviction.contains("J.runRegion(")); - } - - @Test - public void shutdownReclaimsMantleBeforeReleasingTheJob() throws IOException { - String source = read("art/arcane/iris/core/pregenerator/IrisPregenerator.java"); - String shutdown = method(source, "private void shutdown()"); - int generator = shutdown.indexOf("shutdownStep(\"generator\""); - int interruptBoundary = shutdown.indexOf("Thread.interrupted()", generator); - int mantle = shutdown.indexOf("shutdownStep(\"mantle\""); - int protocol = shutdown.indexOf("shutdownStep(\"protocol\""); - int listener = shutdown.indexOf("shutdownStep(\"listener\""); - - assertTrue(generator >= 0); - assertTrue(interruptBoundary > generator); - assertTrue(mantle > interruptBoundary); - assertTrue(protocol > mantle); - assertTrue(listener > protocol); - } - - @Test - public void directStopDoesNotReleaseTheActiveJobBeforeWorkerCleanup() throws IOException { - String source = read("art/arcane/iris/core/gui/PregeneratorJob.java"); - String stop = method(source, "public void stop()"); - String close = method(source, "public void onClose()"); - - assertTrue(stop.contains("requestStop()")); - assertFalse(stop.contains("instance.compareAndSet")); - assertTrue(close.contains("instance.compareAndSet(this, null)")); - } - - @Test - public void performanceProfilePreparationRunsOnThePregenWorker() throws IOException { - String source = read("art/arcane/iris/core/gui/PregeneratorJob.java"); - String constructor = method(source, "public PregeneratorJob(Configuration configuration)"); - String worker = method(source, "private void runWorker(Runnable preparation)"); - - assertTrue(constructor.contains("runWorker(configuration.preparation())")); - assertBefore(worker, "preparation.run()", "pregenerator.start()"); - } - - private static String read(String relativePath) throws IOException { - Path current; - try { - current = Path.of(PregenMantleCleanupContractTest.class.getProtectionDomain() - .getCodeSource() - .getLocation() - .toURI()); - } catch (URISyntaxException e) { - throw new IOException("Unable to resolve the core source root", e); - } - while (current != null && !Files.isDirectory(current.resolve("src/main/java"))) { - current = current.getParent(); - } - if (current == null) { - throw new IOException("Unable to locate the core source root"); - } - return Files.readString(current.resolve("src/main/java").resolve(relativePath)); - } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("Missing source contract signature: " + signature, start >= 0); - int openBrace = source.indexOf('{', start); - assertTrue("Missing source contract method body: " + signature, openBrace >= 0); - int depth = 0; - for (int index = openBrace; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue(firstIndex >= 0); - assertTrue(secondIndex > firstIndex); - } -} diff --git a/core/src/test/java/art/arcane/iris/core/runtime/StudioEntitySpawningTest.java b/core/src/test/java/art/arcane/iris/core/runtime/StudioEntitySpawningTest.java index f1001852b..e00e2652e 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/StudioEntitySpawningTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/StudioEntitySpawningTest.java @@ -4,9 +4,6 @@ import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.service.ObjectStudioSaveService; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.Arrays; import static org.junit.Assert.assertFalse; @@ -18,32 +15,6 @@ public class StudioEntitySpawningTest { assertTrue(new IrisSettings.IrisSettingsStudio().isEntitySpawning()); } - @Test - public void studioWorldRulesEnableVanillaMobSpawning() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java")).replace("\r\n", "\n"); - int helperStart = source.indexOf("static void enableStudioEntitySpawning"); - int helperEnd = source.indexOf("public boolean applyNoonTimeLock", helperStart); - String helper = source.substring(helperStart, helperEnd); - - assertTrue(source.contains("enableStudioEntitySpawning(world);")); - assertTrue(helper.contains("setBooleanGameRule(world, true, \"DO_MOB_SPAWNING\"")); - assertTrue(helper.contains("setBooleanGameRule(world, true, \"DO_TRADER_SPAWNING\"")); - assertTrue(helper.contains("setBooleanGameRule(world, true, \"DO_PATROL_SPAWNING\"")); - assertTrue(helper.contains("setBooleanGameRule(world, true, \"DO_INSOMNIA\"")); - assertTrue(helper.contains("setBooleanGameRule(world, true, \"DO_WARDEN_SPAWNING\"")); - assertFalse(helper.contains("setBooleanGameRule(world, false, \"DO_MOB_SPAWNING\"")); - } - - @Test - public void standardStudioDefaultsToSpectatorMode() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("request.openKind().teleportThroughStandardEntry()")); - assertTrue(source.contains("GameMode.SPECTATOR")); - } - @Test public void objectStudioDoesNotCancelEntitySpawns() { boolean hasSpawnCanceller = Arrays.stream(ObjectStudioSaveService.class.getDeclaredMethods()) diff --git a/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorOpenKindTest.java b/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorOpenKindTest.java index caa3c772f..d7bfdb834 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorOpenKindTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorOpenKindTest.java @@ -5,9 +5,6 @@ import art.arcane.iris.core.tools.IrisCreator; import org.junit.Test; import java.io.File; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.List; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; @@ -86,210 +83,4 @@ public class StudioOpenCoordinatorOpenKindTest { assertEquals(StudioOpenCoordinator.StudioOpenKind.JIGSAW, request.openKind()); assertTrue(request.requestedAtNanos() > 0L); } - - @Test - public void nativeTeleportWaitsForCompletionWithoutAnArrivalDeadline() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")) - .replace("\r\n", "\n"); - int methodStart = source.indexOf("private void executeOpen("); - int delegation = source.indexOf("WorldRuntimeControlService.get().teleportInMode(", methodStart); - int completion = source.indexOf("nativeTeleportFuture.get();", delegation); - - assertTrue(delegation >= 0); - assertTrue(completion > delegation); - assertFalse(source.substring(methodStart, completion).contains("orTimeout(")); - assertFalse(source.substring(methodStart, completion).contains("deadlineNanos")); - } - - @Test - public void activeStudioTeleportIsSerializedWithoutAnArrivalDeadline() throws Exception { - String coordinator = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")) - .replace("\r\n", "\n"); - String service = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/StudioSVC.java")) - .replace("\r\n", "\n"); - int coordinatorStart = coordinator.indexOf( - "public CompletableFuture teleportPlayerToProject("); - int coordinatorEnd = coordinator.indexOf("private void executeOpen", coordinatorStart); - String coordinatorMethod = coordinator.substring(coordinatorStart, coordinatorEnd); - int serviceStart = service.indexOf( - "public CompletableFuture teleportToActiveProject(Player player)"); - int serviceEnd = service.indexOf("public void open(VolmitSender", serviceStart); - String serviceMethod = service.substring(serviceStart, serviceEnd); - int transitionAdmission = serviceMethod.indexOf("studioTransitions.submit(() ->"); - int projectCapture = serviceMethod.indexOf("IrisProject project = activeProject"); - int nativeDelegation = coordinatorMethod.indexOf( - "WorldRuntimeControlService.get().teleportInMode(player, entry, GameMode.SPECTATOR)"); - - assertTrue(transitionAdmission >= 0); - assertTrue(projectCapture > transitionAdmission); - assertFalse(serviceMethod.contains("orTimeout(")); - assertFalse(serviceMethod.contains("deadlineNanos")); - assertTrue(coordinatorMethod.contains( - "WorldRuntimeControlService.get().resolveEntryAnchor(world, provider)")); - assertTrue(coordinatorMethod.contains( - "project.getActiveOpenKind().teleportThroughStandardEntry()")); - assertFalse(coordinatorMethod.contains("requestChunkAsync(")); - assertFalse(coordinatorMethod.contains("getHighestBlockYAt(")); - assertTrue(nativeDelegation >= 0); - assertFalse(coordinatorMethod.contains("orTimeout(")); - assertFalse(coordinatorMethod.contains("deadlineNanos")); - } - - @Test - public void standardEntryDelegatesWithoutAnExplicitChunkOrSurfaceLookup() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")) - .replace("\r\n", "\n"); - - assertTrue(source.contains("Location entryLocation = entryAnchor;")); - assertFalse(source.contains("prepareStudioEntryChunks(")); - assertFalse(source.contains("findStudioEntryLocation")); - assertFalse(source.contains("EntryChunkResolution")); - assertFalse(source.contains("resolveSafeEntry(world, entryAnchor)")); - assertFalse(source.contains("getHighestBlockYAt(")); - } - - @Test - public void standardEntryBindsSpectatorToTheNativeTeleport() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")) - .replace("\r\n", "\n"); - String runtime = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java")) - .replace("\r\n", "\n"); - int mode = runtime.indexOf("modeRestore.apply(gameMode)"); - int teleport = runtime.indexOf("teleporter.teleport(player, location)", mode); - - assertTrue(source.contains("WorldRuntimeControlService.get().teleportInMode(")); - int openKind = source.indexOf("request.project().setActiveOpenKind(request.openKind())"); - int provider = source.indexOf("request.project().setActiveProvider(provider)", openKind); - assertTrue(openKind >= 0); - assertTrue(provider > openKind); - assertTrue(source.contains("project.setActiveOpenKind(null)")); - assertTrue(mode >= 0); - assertTrue(teleport > mode); - assertTrue(runtime.contains("modeRestore.restore()")); - } - - @Test - public void studioTimingSeparatesOrderedLifecyclePhases() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - int previous = -1; - for (String phase : List.of( - "resolve_dimension_and_cleanup", - "create_world_total", - "apply_world_rules", - "prepare_generator", - "resolve_entry_anchor", - "prepare_structure_rings", - "prepare_generation_caches", - "teleport_standard_entry", - "finalize_open")) { - int current = source.indexOf("\"" + phase + "\"", previous + 1); - assertTrue("Missing or out-of-order Studio timing phase " + phase, current > previous); - previous = current; - } - assertTrue(source.contains("long openStart = System.nanoTime();")); - } - - @Test - public void structureStateCompletesBeforeImmediateNativeTeleport() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - int executeOpen = source.indexOf("private void executeOpen("); - int completionCall = source.indexOf("endStudioEntryBootstrap(entryWorld, entryProvider)", executeOpen); - int completionAwait = source.indexOf("entryBootstrap.get(", completionCall); - int cacheAwait = source.indexOf("irisEngine.awaitGenerationCacheWarm()", completionAwait); - int teleportStart = source.indexOf("WorldRuntimeControlService.get().teleportInMode(", cacheAwait); - int finalizeOpen = source.indexOf( - "updateStage(request, \"finalize_open\", 1.00D)", teleportStart); - int futureComplete = source.indexOf( - "future.complete(new StudioOpenResult(world, entryLocation))", finalizeOpen); - int methodStart = source.indexOf( - "private void endStudioEntryBootstrap(World world, PlatformChunkGenerator provider)"); - int methodEnd = source.indexOf("private void abandonStudioEntryBootstrap", methodStart); - String method = source.substring(methodStart, methodEnd); - int scheduled = method.indexOf("J.sfut(() ->"); - int claim = method.indexOf("activationClaim.compareAndSet(true, false)"); - int activation = method.indexOf("INMS.get().completeStudioStructureBootstrap(world)"); - int gateRelease = method.indexOf("bukkitGenerator::endStudioEntryBootstrap"); - - assertTrue(completionCall >= 0); - assertTrue(completionAwait > completionCall); - assertTrue(cacheAwait > completionAwait); - assertTrue(teleportStart > cacheAwait); - assertTrue(finalizeOpen > teleportStart); - assertTrue(futureComplete > finalizeOpen); - assertFalse(source.contains("requestChunkAsync(")); - assertTrue(scheduled >= 0); - assertTrue(claim > scheduled); - assertTrue(activation > claim); - int ringCompletion = method.indexOf("thenCompose(nativeActivation -> nativeActivation)"); - assertTrue(ringCompletion > activation); - assertTrue(gateRelease > ringCompletion); - assertTrue(source.contains("abandonStudioEntryBootstrap(world, e);")); - } - - @Test - public void failedOpenMarshalsRetainedStateAbandonmentToTheServerScheduler() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - int methodStart = source.indexOf( - "private void abandonStudioEntryBootstrap(World world, Throwable failure)"); - int methodEnd = source.indexOf("private CompletableFuture cleanupFailedOpen", methodStart); - String method = source.substring(methodStart, methodEnd); - - assertTrue(method.contains("if (J.isPrimaryThread())")); - assertTrue(method.contains("CompletableFuture abandonment = J.sfut(")); - assertTrue(method.contains("abandonment.get(STUDIO_STRUCTURE_ACTIVATION_TIMEOUT_SECONDS")); - } - - @Test - public void queuedRestartDefersFailedOpenCleanupWithoutAcquiringALiveCloseLease() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - int openCatch = source.indexOf("} catch (Throwable e) {"); - int restartCheck = source.indexOf( - ".active(LifecycleOperationCoordinator.Domain.SERVER_LIFECYCLE)", - openCatch); - int restartDeferral = source.indexOf( - "deferFailedOpenCleanupToRestart(", - restartCheck); - int liveCleanup = source.indexOf("cleanupFailedOpen(", restartDeferral); - int methodStart = source.indexOf( - "private void deferFailedOpenCleanupToRestart(", - restartDeferral); - int methodEnd = source.indexOf("private boolean transientWorldStorageExists", methodStart); - String method = source.substring(methodStart, methodEnd); - - assertTrue(restartCheck > openCatch); - assertTrue(restartDeferral > restartCheck); - assertTrue(liveCleanup > restartDeferral); - assertTrue(method.contains("queueStartupCleanup(")); - assertFalse(method.contains("closeWorldCoordinated(")); - } - - @Test - public void openFinalizerReturnsToTheServerThreadBeforeCompletion() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - int finalizerCall = source.indexOf("runOpenFinalizer(request.onDone(), world);"); - int futureCompletion = source.indexOf( - "future.complete(new StudioOpenResult(world, entryLocation))", finalizerCall); - int methodStart = source.indexOf( - "private void runOpenFinalizer(Consumer finalizer, World world)"); - int methodEnd = source.indexOf("private long elapsedMillis", methodStart); - String method = source.substring(methodStart, methodEnd); - - assertTrue(finalizerCall >= 0); - assertTrue(futureCompletion > finalizerCall); - assertTrue(method.contains("if (J.isPrimaryThread())")); - assertTrue(method.contains("J.sfut(() -> finalizer.accept(world))")); - assertTrue(method.contains( - "completion.get(STUDIO_STRUCTURE_ACTIVATION_TIMEOUT_SECONDS, TimeUnit.SECONDS)")); - } } diff --git a/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorSpawnStuckRegressionTest.java b/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorSpawnStuckRegressionTest.java index 7eab779f5..732de03bd 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorSpawnStuckRegressionTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/StudioOpenCoordinatorSpawnStuckRegressionTest.java @@ -2,12 +2,9 @@ package art.arcane.iris.core.runtime; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.Arrays; import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; public class StudioOpenCoordinatorSpawnStuckRegressionTest { @Test @@ -30,25 +27,4 @@ public class StudioOpenCoordinatorSpawnStuckRegressionTest { .anyMatch(m -> m.getName().equals("waitForEntryChunk")); assertFalse("waitForEntryChunk retry loop must be removed", found); } - - @Test - public void entryTeleportDoesNotIssueASecondChunkRequest() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("WorldRuntimeControlService.get().teleportInMode(")); - assertFalse(source.contains("prepareStudioEntryChunks(")); - assertFalse(source.contains("requestChunkAsync(")); - } - - @Test - public void foliaEntryPathNeverReadsTerrainOnARegionThread() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/runtime/StudioOpenCoordinator.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("resolveEntryAnchor(world, provider)")); - assertFalse(source.contains("findStudioEntryLocation")); - assertFalse(source.contains("getHighestBlockYAt(")); - assertFalse(source.contains("resolveSafeEntry(world, entryAnchor)")); - } } diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java index 65bf2e3d6..0ee4480e9 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java @@ -23,9 +23,6 @@ import org.mockito.MockedStatic; import java.lang.reflect.Constructor; import java.lang.reflect.Field; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import java.util.Map; import java.util.Optional; @@ -84,23 +81,6 @@ public class JigsawStudioLifecycleTest { CreatureSpawnEvent.SpawnReason.SPAWNER)); } - @Test - public void committedStudioActivationDisablesNaturalMobSpawning() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/JigsawStudioService.java")).replace("\r\n", "\n"); - int registerStart = source.indexOf("public void register("); - int commitStart = source.indexOf("public void activationCommitted(", registerStart); - int commitEnd = source.indexOf("public void markChunkGenerated(", commitStart); - int helperStart = source.indexOf("static void disableNaturalStudioSpawning(", commitEnd); - String register = source.substring(registerStart, commitStart); - String commit = source.substring(commitStart, commitEnd); - String helper = source.substring(helperStart); - - assertFalse(register.contains("disableNaturalStudioSpawning(world)")); - assertTrue(commit.contains("disableNaturalStudioSpawning(world)")); - assertTrue(helper.contains("setGameRule(GameRules.SPAWN_MOBS, false)")); - } - @Test public void closeAuthorizationChecksOwnerDirtyStateAndSaveBarrierAtomically() { assertTrue(JigsawStudioActivation.tryBeginOpen(OWNER)); diff --git a/core/src/test/java/art/arcane/iris/core/service/PackDownloadProgressReporterTest.java b/core/src/test/java/art/arcane/iris/core/service/PackDownloadProgressReporterTest.java index 2cf34baec..22c2404b3 100644 --- a/core/src/test/java/art/arcane/iris/core/service/PackDownloadProgressReporterTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/PackDownloadProgressReporterTest.java @@ -7,8 +7,6 @@ import art.arcane.volmlib.util.format.Form; import org.junit.Test; import org.mockito.ArgumentCaptor; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; import static org.junit.Assert.assertEquals; @@ -182,24 +180,6 @@ public class PackDownloadProgressReporterTest { verify(sender, times(1)).sendMessage(anyString()); } - @Test - public void playerHudAlwaysShowsLoaderLaneAndActionBarWithCleanup() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/PackDownloadProgressReporter.java" - )).replace("\r\n", "\n"); - - assertFalse(source.contains("HudSlotRequest")); - assertFalse(source.contains("HudSurface")); - assertTrue(source.contains("J.ar(this::pulseHud, HUD_PULSE_TICKS)")); - assertTrue(source.contains("BukkitPlatform.hudLanes().show(")); - assertTrue(source.contains("sender.sendAction(snapshot.line())")); - assertTrue(source.contains("HUD_TERMINAL_TICKS, retiredCleanup")); - assertTrue(source.contains("BukkitPlatform.hudLanes().retire(playerId, hudLaneId)")); - assertTrue(source.contains("BukkitPlatform.hudLanes().hide(player, hudLaneId)")); - assertFalse(source.contains("J.runGlobal(cleanup)")); - assertTrue(source.contains("J.car(activeTaskId);")); - } - @Test public void allDownloadPhasesHaveLocalizedLabels() { for (PackDownloader.DownloadPhase phase : PackDownloader.DownloadPhase.values()) { diff --git a/core/src/test/java/art/arcane/iris/core/service/StudioSVCPackDownloadContractTest.java b/core/src/test/java/art/arcane/iris/core/service/StudioSVCPackDownloadContractTest.java index bc2cc0b88..118c51088 100644 --- a/core/src/test/java/art/arcane/iris/core/service/StudioSVCPackDownloadContractTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/StudioSVCPackDownloadContractTest.java @@ -5,76 +5,9 @@ import art.arcane.iris.core.localization.IrisLanguage; import art.arcane.iris.core.localization.PackDownloadMessages; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; - import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; public class StudioSVCPackDownloadContractTest { - @Test - public void downloadsUseReporterCompletionWithoutMutatingLiveDatapacks() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("reporter.succeed(result);")); - assertFalse(method(source, "public void downloadBuiltIn(VolmitSender sender, String key)") - .contains("ServerConfigurator.restart()")); - assertFalse(method(source, "public void downloadUrl(VolmitSender sender, String url)") - .contains("installDataPacksIfChanged")); - } - - @Test - public void downloadLeaseIsAcquiredBeforeUnconditionalIoDispatch() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - int mutationStart = source.indexOf("private void runPackMutation("); - int mutationEnd = source.indexOf("private void executePackMutation(", mutationStart); - String runPackMutation = source.substring(mutationStart, mutationEnd); - int leaseAcquisition = runPackMutation.indexOf("LifecycleOperationCoordinator.get().acquire("); - int executionTracking = runPackMutation.indexOf("new PackDownloadExecution("); - int ioDispatch = runPackMutation.indexOf("MultiBurst.ioBurst.submit("); - - assertTrue(leaseAcquisition >= 0); - assertTrue(executionTracking > leaseAcquisition); - assertTrue(ioDispatch > leaseAcquisition); - assertTrue(runPackMutation.contains("execution.bind(future);")); - assertTrue(runPackMutation.contains("execution.cancel();")); - assertTrue(runPackMutation.contains("finally")); - assertTrue(runPackMutation.contains("reporter.start();")); - assertTrue(runPackMutation.contains("reporter.executionComplete();")); - assertFalse(runPackMutation.contains("runOffPrimaryThread")); - } - - @Test - public void acceptedDownloadsRouteFeedbackProgressAndTerminalStatesThroughReporter() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - String builtIn = method(source, "public void downloadBuiltIn(VolmitSender sender, String key)"); - String remote = method(source, "public void downloadUrl(VolmitSender sender, String url)"); - String execute = method(source, "private void executePackMutation("); - - assertTrue(builtIn.contains("PackDownloadProgressReporter reporter")); - assertTrue(remote.contains("PackDownloadProgressReporter reporter")); - assertTrue(remote.contains("reporter::detail")); - assertTrue(remote.contains("\"remote-zip\", reporter")); - assertTrue(remote.contains("cancellation,")); - assertTrue(remote.contains("reporter")); - assertTrue(execute.contains("reporter.cancel();")); - assertTrue(execute.contains("reporter.fail(e);")); - } - - @Test - public void shutdownClosesAdmissionAndDrainsTrackedDownloadBeforeServiceTeardown() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - String onDisable = method(source, "public void onDisable()"); - String quiesce = method(source, "public void quiesceDownloadsForShutdown()"); - - assertTrue(onDisable.contains("quiesceDownloadsForShutdown();")); - assertTrue(quiesce.contains("downloadAdmissionOpen = false;")); - assertTrue(quiesce.contains("execution.cancel();")); - assertTrue(quiesce.contains("execution.await(")); - assertTrue(quiesce.contains("while (!execution.isComplete())")); - } - @Test public void stackedDownloadUsesLocalizedBusyMessage() { LifecycleOperationCoordinator.ActiveOperation download = new LifecycleOperationCoordinator.ActiveOperation( @@ -99,24 +32,4 @@ public class StudioSVCPackDownloadContractTest { StudioSVC.packMutationBusyMessage(worldCreation) ); } - - private static String method(String source, String signature) { - int start = source.indexOf(signature); - assertTrue("Missing source contract signature: " + signature, start >= 0); - int openBrace = source.indexOf('{', start); - assertTrue("Missing source contract method body: " + signature, openBrace >= 0); - int depth = 0; - for (int index = openBrace; index < source.length(); index++) { - char current = source.charAt(index); - if (current == '{') { - depth++; - } else if (current == '}') { - depth--; - if (depth == 0) { - return source.substring(start, index + 1); - } - } - } - throw new IllegalArgumentException("Unclosed source contract method: " + signature); - } } diff --git a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackFeedbackContractTest.java b/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackFeedbackContractTest.java deleted file mode 100644 index 1b94cd041..000000000 --- a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackFeedbackContractTest.java +++ /dev/null @@ -1,35 +0,0 @@ -package art.arcane.iris.core.service; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; - -public class StudioSVCWorldPackFeedbackContractTest { - @Test - public void persistentPackCopyUsesLifecycleProgressWithoutLegacySnapshotFeedback() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/StudioSVC.java" - )).replace("\r\n", "\n"); - - assertEquals(2, occurrences(source, "STUDIO_S_V_C_PACK_COPY_REQUIRES_ASYNC_THREAD")); - assertEquals(3, occurrences(source, "STUDIO_S_V_C_PACK_INSTALL_FAILED")); - assertFalse(source.contains("STUDIO_S_V_C_INSTALLING_PACKAGE")); - assertFalse(source.contains("Publishing snapshot")); - assertFalse(source.contains("sender.sendMessage(\"Iris refused to copy a pack")); - assertFalse(source.contains("sender.sendMessage(\"Failed to install studio pack")); - } - - private static int occurrences(String value, String match) { - int count = 0; - int offset = 0; - while ((offset = value.indexOf(match, offset)) >= 0) { - count++; - offset += match.length(); - } - return count; - } -} diff --git a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java b/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java index 55be651ae..33ac1df61 100644 --- a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java @@ -172,27 +172,6 @@ public class StudioSVCWorldPackPublishTest { @Test public void replaceExistingRejectsSymbolicTargetBeforePublication() throws Exception { - String sourceCode = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - int install = sourceCode.indexOf("private IrisDimension installIntoDirectory("); - int initialTargetSafety = sourceCode.indexOf( - "requireSafePublicationTarget(target, replaceExisting)", - install); - int beginMutation = sourceCode.indexOf( - "PackValidationRegistry.beginRootMutation(target)", - initialTargetSafety); - int finalTargetSafety = sourceCode.indexOf( - "requireSafePublicationTarget(target, replaceExisting)", - beginMutation); - int publish = sourceCode.indexOf( - "AtomicDirectoryPublisher.publish(stage, target)", - finalTargetSafety); - assertTrue(install >= 0); - assertTrue(initialTargetSafety > install); - assertTrue(beginMutation > initialTargetSafety); - assertTrue(finalTargetSafety > beginMutation); - assertTrue(publish > finalTargetSafety); - Path root = temporaryFolder.newFolder("symbolic-replacement-target").toPath(); Path outside = root.resolve("outside-pack"); Path target = root.resolve("world/iris/pack"); @@ -305,27 +284,6 @@ public class StudioSVCWorldPackPublishTest { @Test public void replacementKeepsTargetUnauthorizedThroughPublishedFingerprintWindow() throws Exception { - String sourceCode = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/StudioSVC.java")).replace("\r\n", "\n"); - int install = sourceCode.indexOf("private IrisDimension installIntoDirectory("); - int beginMutation = sourceCode.indexOf("PackValidationRegistry.beginRootMutation(target)", install); - int publish = sourceCode.indexOf("AtomicDirectoryPublisher.publish(stage, target)", beginMutation); - int fingerprint = sourceCode.indexOf( - "ServerConfigurator.computePackTreeFingerprint(target.toFile())", - publish); - int stageValidation = sourceCode.indexOf( - "validatePublishedPack(target, source, copiedFingerprint, validationMutation)", - fingerprint); - int publishCommit = sourceCode.indexOf("publication.commit()", stageValidation); - int validationCommit = sourceCode.indexOf("validationMutation.commit()", publishCommit); - assertTrue(install >= 0); - assertTrue(beginMutation > install); - assertTrue(publish > beginMutation); - assertTrue(fingerprint > publish); - assertTrue(stageValidation > fingerprint); - assertTrue(publishCommit > stageValidation); - assertTrue(validationCommit > publishCommit); - Path root = temporaryFolder.newFolder("validation-publication-window").toPath(); Path sourcePack = root.resolve("source"); Path target = root.resolve("world/iris/pack"); @@ -454,26 +412,6 @@ public class StudioSVCWorldPackPublishTest { assertEquals("second", second.join()); } - @Test - public void productionWorldPublicationUsesImmutableGenerationHistory() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/service/StudioSVC.java" - )).replace("\r\n", "\n"); - int productionStart = source.indexOf("private IrisDimension publishGenerationHistory("); - int transientStart = source.indexOf("private IrisDimension installIntoDirectory(", productionStart); - String production = source.substring(productionStart, transientStart); - - assertTrue(production.contains("GenerationHistory.create(")); - assertTrue(production.contains("GenerationHistory.openIfPresent(dimensionRoot, worldSeed)")); - assertTrue(production.contains("GenerationHistory.adoptLegacyPack(")); - assertTrue(production.contains("history.stageUpdate(")); - assertTrue(production.contains("getGenerationTransitionWidthBlocks()")); - assertTrue(production.contains("history.activePackRoot()")); - assertFalse(production.contains("AtomicDirectoryPublisher.publish(")); - assertTrue(source.contains("installIntoTransientWorld(")); - assertTrue(source.contains("new File(dimensionRoot, \"iris/pack\")")); - } - private static void writeValidPack(Path packRoot) throws Exception { Files.createDirectories(packRoot.resolve("dimensions")); Files.createDirectories(packRoot.resolve("regions")); diff --git a/core/src/test/java/art/arcane/iris/core/tools/IrisPersistentWorldCreationContractTest.java b/core/src/test/java/art/arcane/iris/core/tools/IrisPersistentWorldCreationContractTest.java deleted file mode 100644 index 7e70ac12f..000000000 --- a/core/src/test/java/art/arcane/iris/core/tools/IrisPersistentWorldCreationContractTest.java +++ /dev/null @@ -1,75 +0,0 @@ -package art.arcane.iris.core.tools; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class IrisPersistentWorldCreationContractTest { - @Test - public void productionCreateFreezesIntoCurrentPlatformStorageBeforeWorldCreation() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/tools/IrisCreator.java")).replace("\r\n", "\n"); - int createStart = source.indexOf("private World createReserved("); - int createEnd = source.indexOf("static Player createTeleportTarget(", createStart); - String create = source.substring(createStart, createEnd); - - int dimensionRoot = create.indexOf("WorldCreatorCompat.persistentDimensionRoot(worldKey)"); - int levelRoot = create.indexOf("WorldCreatorCompat.persistentLevelRoot(worldKey)"); - int existingStorage = create.indexOf("Files.exists(storageRoot.toPath())"); - int freezePack = create.indexOf("studioService.installIntoWorld(sender, resolvedDimension, dimensionRoot, seed)"); - int persistentCreator = create.indexOf(".persistent(!studio && !benchmark)"); - int bukkitCreate = create.indexOf("INMS.get().createWorldAsync(wc, request)"); - int rollbackStorage = create.indexOf( - "rollbackWorldCreation(worldKey, world, stagedGenerator, storageRoot, bukkitRegistered, failure)" - ); - - assertTrue(dimensionRoot >= 0); - assertTrue(levelRoot > dimensionRoot); - assertTrue(existingStorage > levelRoot); - assertTrue(freezePack > existingStorage); - assertTrue(persistentCreator > freezePack); - assertTrue(bukkitCreate > persistentCreator); - assertTrue(rollbackStorage > bukkitCreate); - assertFalse(create.contains("copySeed")); - assertFalse(create.contains("level.dat")); - } - - @Test - public void persistentCreatorPreservesConfiguredNameAndCanonicalIdentity() throws Exception { - String source = Files.readString(Path.of("src/main/java/art/arcane/iris/core/tools/IrisWorldCreator.java")).replace("\r\n", "\n"); - int createStart = source.indexOf("public WorldCreator create()"); - int createEnd = source.indexOf("private World.Environment findEnvironment()", createStart); - String create = source.substring(createStart, createEnd); - - int persistentCreator = create.indexOf("WorldCreatorCompat.ofPersistentKey(worldKey)"); - int persistentStorage = create.indexOf("WorldCreatorCompat.persistentDimensionRoot(worldKey)"); - int canonicalIdentity = create.indexOf(".platformIdentity(worldKey.toString())"); - int configuredName = create.indexOf(".name(creator.name())"); - int history = create.indexOf("requireGenerationHistory(w.worldFolder(), seed)"); - int exactPack = create.indexOf("requireActivePack(generationHistory)"); - - assertTrue(persistentCreator >= 0); - assertTrue(persistentStorage > persistentCreator); - assertTrue(canonicalIdentity > persistentStorage); - assertTrue(configuredName > canonicalIdentity); - assertTrue(history > configuredName); - assertTrue(exactPack > history); - assertTrue(create.contains("new File(w.worldFolder(), \"iris/pack\")")); - } - - @Test - public void publicBukkitBackendRebuildKeepsExactFallbackWorldName() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleRequest.java" - )).replace("\r\n", "\n"); - int rebuildStart = source.indexOf("public WorldCreator toWorldCreator()"); - int rebuildEnd = source.indexOf("return creator;", rebuildStart); - String rebuild = source.substring(rebuildStart, rebuildEnd); - - assertTrue(rebuild.contains("WorldCreatorCompat.ofKey(worldKey, worldName)")); - assertFalse(rebuild.contains("WorldCreatorCompat.ofKey(worldKey)")); - } -} diff --git a/core/src/test/java/art/arcane/iris/core/tools/WorldCreationProgressReporterTest.java b/core/src/test/java/art/arcane/iris/core/tools/WorldCreationProgressReporterTest.java index cd0016599..d948d7930 100644 --- a/core/src/test/java/art/arcane/iris/core/tools/WorldCreationProgressReporterTest.java +++ b/core/src/test/java/art/arcane/iris/core/tools/WorldCreationProgressReporterTest.java @@ -4,11 +4,7 @@ import art.arcane.iris.core.localization.RuntimeProgressMessages; import art.arcane.iris.util.common.format.C; import org.junit.Test; -import java.nio.file.Files; -import java.nio.file.Path; - import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; @@ -79,20 +75,6 @@ public class WorldCreationProgressReporterTest { assertTrue(failed.contains("FAILED | Entering world")); } - @Test - public void playerProgressUsesTheEntityScheduledActionBarWithoutABossBar() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/core/tools/WorldCreationProgressReporter.java" - )).replace("\r\n", "\n"); - - assertFalse(source.contains("Bukkit.createBossBar(")); - assertFalse(source.contains("WORLD_CREATE_BOSSBAR_")); - assertFalse(source.contains("isProgressBossBar()")); - assertTrue(source.contains("RuntimeProgressMessages.WORLD_CREATE_LIFECYCLE_ACTION")); - assertTrue(source.contains("J.runEntity(sender.player(), guardedRender)")); - assertTrue(source.contains("J.runEntity(sender.player(), render)")); - } - private static int occurrences(String value, String match) { int count = 0; int offset = 0; diff --git a/core/src/test/java/art/arcane/iris/engine/EngineRuntimePublicationContractTest.java b/core/src/test/java/art/arcane/iris/engine/EngineRuntimePublicationContractTest.java deleted file mode 100644 index 8015b323a..000000000 --- a/core/src/test/java/art/arcane/iris/engine/EngineRuntimePublicationContractTest.java +++ /dev/null @@ -1,130 +0,0 @@ -package art.arcane.iris.engine; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class EngineRuntimePublicationContractTest { - @Test - public void worldManagerStartsOnlyAfterTheRuntimeSessionIsReady() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineRuntimeBuilder.java")).replace("\r\n", "\n"); - int publishStart = source.indexOf("void publishRuntime("); - int publishEnd = source.indexOf("private void scheduleRuntimeTasks", publishStart); - String publish = source.substring(publishStart, publishEnd); - - assertBefore(publish, "engine.runtime = next", "next.worldManager().start()"); - assertBefore(publish, "activateNextSession()", "next.worldManager().start()"); - assertBefore(publish, "engine.lifecycleState = LifecycleState.RUNNING", "next.worldManager().start()"); - assertBefore(publish, "engine.getClosing().set(false)", "next.worldManager().start()"); - assertBefore(publish, "openBackgroundTaskAdmission()", "next.worldManager().start()"); - } - - @Test - public void failedManagerStartClosesAdmissionBeforeRuntimeCleanup() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineRuntimeBuilder.java")).replace("\r\n", "\n"); - int publishStart = source.indexOf("void publishRuntime("); - int publishEnd = source.indexOf("private void scheduleRuntimeTasks", publishStart); - String publish = source.substring(publishStart, publishEnd); - - assertBefore(publish, "engine.getClosing().set(true)", "cleanupFailure = engine.shutdownSequence.closeRuntime(next, null)"); - assertBefore(publish, "closeBackgroundTaskAdmission()", "cleanupFailure = engine.shutdownSequence.closeRuntime(next, null)"); - assertBefore(publish, "sealAndAwait(", "cleanupFailure = engine.shutdownSequence.closeRuntime(next, null)"); - } - - @Test - public void dimensionStackRegistrationRunsAfterHostStaticObjects() throws IOException { - String builderSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineRuntimeBuilder.java")).replace("\r\n", "\n"); - int buildStart = builderSource.indexOf("private EngineRuntime buildRuntime("); - int buildEnd = builderSource.indexOf("GenerationRuntime buildDetachedGenerationRuntime(", buildStart); - String build = builderSource.substring(buildStart, buildEnd); - - assertBefore(build, "assembly.runtimeKernel.registerStaticObjects(engine, assembly.mode)", - "assembly.runtimeKernel.registerDimensionStack("); - - String kernelSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/history/GenerationKernelV1.java")).replace("\r\n", "\n"); - assertBefore(kernelSource, "staticObjects.apply(engine, x, z, blocks)", - "dimensionStack.actuate(x, z, blocks, multicore, chunkContext)"); - assertBefore(kernelSource, "dimensionStack.actuate(x, z, blocks, multicore, chunkContext)", - "stackCustom.modify(x, z, blocks, multicore, chunkContext)"); - } - - @Test - public void detachedRuntimeBuildDoesNotCreateWorldOwnedServices() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineRuntimeBuilder.java")).replace("\r\n", "\n"); - int buildStart = source.indexOf("GenerationRuntime buildDetachedGenerationRuntime("); - int buildEnd = source.indexOf("void publishRuntime(", buildStart); - String build = source.substring(buildStart, buildEnd); - - assertTrue(build.contains("assembly.runtimeKernel.createComplex(engine, assembly.transitionPlan)")); - assertTrue(build.contains("assembly.runtimeKernel.createMantle(engine, assembly.mantleStorageDirectory)")); - assertTrue(build.contains("assembly.mantle.hotload()")); - assertTrue(build.contains("assembly.runtimeKernel.createMode(engine)")); - assertTrue(build.contains("assembly.runtimeKernel.createUpperContext(engine)")); - assertTrue(build.contains("assembly.runtimeKernel.registerStaticObjects(engine, assembly.mode)")); - assertFalse(build.contains("EngineEffectsProvider")); - assertFalse(build.contains("EngineWorldManagerProvider")); - assertFalse(build.contains("worldManager().start()")); - } - - @Test - public void runtimePublicationTransfersAnIdenticalMantleWithoutClosingIt() throws IOException { - String builderSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineRuntimeBuilder.java")).replace("\r\n", "\n"); - String shutdownSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - - assertTrue(builderSource.contains("next.generation().mantle()")); - assertTrue(shutdownSource.contains("generationRuntime.mantle() != retainedMantle")); - } - - @Test - public void engineAndDetachedRuntimeAcceptExplicitMantleDirectories() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/IrisEngine.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("InitializationMode initializationMode,\n Path mantleStorageDirectory")); - assertTrue(source.contains("EngineTarget runtimeTarget,\n Path mantleStorageDirectory")); - assertTrue(source.contains("exclusive mantle storage directory")); - } - - @Test - public void mantleIoPinsTheRuntimeDataAcrossWorkerThreads() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/IrisEngineMantle.java")).replace("\r\n", "\n"); - - assertTrue(source.contains("runtimeData::get")); - assertTrue(source.contains("runtimeData.set(Objects.requireNonNull(engine.getData()")); - assertFalse(source.contains("createDataAdapter(engine::getData)")); - } - - @Test - public void failedDetachedBuildReleasesTransferredTargetOwnership() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/IrisEngine.java")).replace("\r\n", "\n"); - int buildStart = source.indexOf("public GenerationRuntimeBinding buildDetachedGenerationRuntime("); - int buildEnd = source.indexOf("public void closeDetachedGenerationRuntime(", buildStart); - String build = source.substring(buildStart, buildEnd); - - assertTrue(build.contains("detachedData.registerEngine(this)")); - assertTrue(build.contains("shutdownSequence.closeDetachedTarget(requiredTarget, null)")); - assertTrue(build.contains("shutdownSequence.closeDetachedGenerationRuntime(detached, null)")); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source contract token: " + first, firstIndex >= 0); - assertTrue("Missing source contract token: " + second, secondIndex >= 0); - assertTrue(first + " must occur before " + second, firstIndex < secondIndex); - } -} diff --git a/core/src/test/java/art/arcane/iris/engine/EngineShutdownOwnershipContractTest.java b/core/src/test/java/art/arcane/iris/engine/EngineShutdownOwnershipContractTest.java deleted file mode 100644 index bdadc9a7c..000000000 --- a/core/src/test/java/art/arcane/iris/engine/EngineShutdownOwnershipContractTest.java +++ /dev/null @@ -1,74 +0,0 @@ -package art.arcane.iris.engine; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertTrue; - -public class EngineShutdownOwnershipContractTest { - @Test - public void attachedHistoryRouterClosesBeforeRuntimeOwnershipReleases() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - int closeStart = source.indexOf("void close()"); - int routerClose = source.indexOf("engine::closeAttachedGenerationHistoryRuntimeRouter", closeStart); - int runtimeRelease = source.indexOf("releaseRuntime(failure)", routerClose); - - assertTrue(routerClose > closeStart); - assertTrue(runtimeRelease > routerClose); - } - - @Test - public void ownershipCloseMustSucceedBeforeRuntimeRelease() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - int ownershipClose = source.indexOf("NativeStructureOwnershipStore.close(engine)"); - int ownershipGate = source.indexOf("if (ownershipFailure == null)", ownershipClose); - int runtimeRelease = source.indexOf("releaseRuntime(failure)", ownershipGate); - - assertTrue(ownershipClose >= 0); - assertTrue(ownershipGate > ownershipClose); - assertTrue(runtimeRelease > ownershipGate); - } - - @Test - public void failedConstructionKeepsMantleOpenWhileOwnershipWritesRemain() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - int cleanupStart = source.indexOf("void cleanupFailedConstruction"); - int cleanupEnd = source.indexOf("Throwable closeAssembly", cleanupStart); - String cleanup = source.substring(cleanupStart, cleanupEnd); - int ownershipClose = cleanup.indexOf("NativeStructureOwnershipStore.close(engine)"); - int ownershipGate = cleanup.indexOf("if (ownershipFailure == null)", ownershipClose); - int runtimeRelease = cleanup.indexOf("releaseRuntime(cleanupFailure)", ownershipGate); - int targetRelease = cleanup.indexOf("releaseTarget(cleanupFailure)", runtimeRelease); - int closedPublication = cleanup.indexOf("engine.closed = true", ownershipGate); - - assertTrue(ownershipClose >= 0); - assertTrue(ownershipGate > ownershipClose); - assertTrue(runtimeRelease > ownershipGate); - assertTrue(targetRelease > runtimeRelease); - assertTrue(closedPublication > ownershipGate); - } - - @Test - public void detachedRuntimesCloseBeforeTheBaseRuntimeAndTarget() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - int releaseStart = source.indexOf("private Throwable releaseRuntime("); - int releaseEnd = source.indexOf("private Throwable closeDetachedGenerationRuntimes(", releaseStart); - String release = source.substring(releaseStart, releaseEnd); - int detachedRelease = release.indexOf("closeDetachedGenerationRuntimes(null)"); - int detachedGate = release.indexOf("if (detachedFailure != null)", detachedRelease); - int baseRelease = release.indexOf("closeRuntime(engine.runtime, null)", detachedGate); - int targetRelease = source.indexOf("engine.publishedTarget::close", releaseEnd); - - assertTrue(detachedRelease >= 0); - assertTrue(detachedGate > detachedRelease); - assertTrue(baseRelease > detachedGate); - assertTrue(targetRelease > releaseEnd); - } -} diff --git a/core/src/test/java/art/arcane/iris/engine/NativeStructureBootstrapLifecycleContractTest.java b/core/src/test/java/art/arcane/iris/engine/NativeStructureBootstrapLifecycleContractTest.java deleted file mode 100644 index 46572646b..000000000 --- a/core/src/test/java/art/arcane/iris/engine/NativeStructureBootstrapLifecycleContractTest.java +++ /dev/null @@ -1,107 +0,0 @@ -package art.arcane.iris.engine; - -import org.junit.Test; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertTrue; - -public class NativeStructureBootstrapLifecycleContractTest { - @Test - public void closeWaitsBeforeLifecycleMutationAndGenerationSeal() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineShutdownSequence.java")).replace("\r\n", "\n"); - int closeStart = source.indexOf("void close()"); - int closeEnd = source.indexOf("void cleanupFailedConstruction", closeStart); - String close = source.substring(closeStart, closeEnd); - - assertBefore(close, - "engine.awaitNativeStructureBootstrap(\"close\")", - "engine.lifecycleState = LifecycleState.CLOSING"); - assertBefore(close, - "engine.awaitNativeStructureBootstrap(\"close\")", - "sealAndAwait(\"close\""); - } - - @Test - public void fullAndComplexHotloadWaitBeforeLifecycleMutationAndGenerationSeal() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/EngineHotloader.java")).replace("\r\n", "\n"); - int complexStart = source.indexOf("void hotloadComplex()"); - int fullStart = source.indexOf("void hotloadSilently()", complexStart); - String complex = source.substring(complexStart, fullStart); - int fullEnd = source.indexOf("private void broadcastStudioHotload", fullStart); - String full = source.substring(fullStart, fullEnd); - - assertBefore(complex, - "engine.awaitNativeStructureBootstrap(\"complex hotload\")", - "engine.lifecycleState = LifecycleState.HOTLOADING"); - assertBefore(complex, - "engine.awaitNativeStructureBootstrap(\"complex hotload\")", - "engine.sealForTransition(\"complex hotload\""); - assertBefore(full, - "engine.awaitNativeStructureBootstrap(\"hotload\")", - "engine.lifecycleState = LifecycleState.HOTLOADING"); - assertBefore(full, - "engine.awaitNativeStructureBootstrap(\"hotload\")", - "engine.sealForTransition(\"hotload\""); - } - - @Test - public void ringBootstrapStartsUnderTheSameLifecycleLock() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/IrisEngine.java")).replace("\r\n", "\n"); - int start = source.indexOf("public CompletableFuture startNativeStructureBootstrap("); - int end = source.indexOf("void awaitNativeStructureBootstrap", start); - String method = source.substring(start, end); - - assertBefore(method, "synchronized (lifecycleLock)", - "nativeStructureBootstrapBarrier.start(claim, starter)"); - assertBefore(method, "requireRunning(\"prepare native structure placements\")", - "nativeStructureBootstrapBarrier.start(claim, starter)"); - assertBefore(method, "nativeStructureBootstrapBarrier.start(claim, starter)", - "activation.run()"); - } - - @Test - public void studioVolumeQueriesStayOutsideCachesUntilTheBootstrapGateReleases() throws IOException { - String engineSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/IrisEngine.java")).replace("\r\n", "\n"); - int queryStart = engineSource.indexOf( - "public KList getNativeStructureVolumes("); - int queryEnd = engineSource.indexOf( - "public void setNativeStructureVolumeQueriesEnabled", queryStart); - String query = engineSource.substring(queryStart, queryEnd); - int setterEnd = engineSource.indexOf("public IrisEngineData getEngineData()", queryEnd); - String setter = engineSource.substring(queryEnd, setterEnd); - String generatorSource = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/platform/BukkitChunkGenerator.java")).replace("\r\n", "\n"); - int releaseStart = generatorSource.indexOf("public void endStudioEntryBootstrap()"); - int releaseEnd = generatorSource.indexOf( - "public boolean isStudioEntryBootstrapActive()", releaseStart); - String release = generatorSource.substring(releaseStart, releaseEnd); - - assertTrue(engineSource.contains( - "new AtomicBoolean(!requiredMode.studio())")); - assertBefore(query, - "!nativeStructureVolumeQueriesEnabled.get()", - "nativeStructureVolumeMemo.volumes("); - assertBefore(setter, - "nativeStructureVolumeMemo.clear()", - "nativeStructureVolumeQueriesEnabled.set(true)"); - assertBefore(release, - "irisEngine.setNativeStructureVolumeQueriesEnabled(shouldGenerateNativeStructures(", - "studioEntryBootstrapActive.set(false)"); - } - - private static void assertBefore(String source, String first, String second) { - int firstIndex = source.indexOf(first); - int secondIndex = source.indexOf(second); - assertTrue("Missing source contract token: " + first, firstIndex >= 0); - assertTrue("Missing source contract token: " + second, secondIndex >= 0); - assertTrue(first + " must occur before " + second, firstIndex < secondIndex); - } -} diff --git a/core/src/test/java/art/arcane/iris/engine/platform/BukkitChunkGeneratorInitializationModeTest.java b/core/src/test/java/art/arcane/iris/engine/platform/BukkitChunkGeneratorInitializationModeTest.java index 53e97123a..0dcc26237 100644 --- a/core/src/test/java/art/arcane/iris/engine/platform/BukkitChunkGeneratorInitializationModeTest.java +++ b/core/src/test/java/art/arcane/iris/engine/platform/BukkitChunkGeneratorInitializationModeTest.java @@ -11,11 +11,8 @@ import art.arcane.iris.engine.object.StudioMode; import art.arcane.iris.engine.object.IrisDimension; import org.junit.Test; -import java.io.IOException; import java.lang.reflect.Field; import java.lang.reflect.Method; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.concurrent.CompletableFuture; import java.util.concurrent.TimeUnit; @@ -108,19 +105,6 @@ public class BukkitChunkGeneratorInitializationModeTest { assertEquals(-64, BukkitChunkGenerator.authoringBaseHeight(-64, 0)); } - @Test - public void authoringStartupDoesNotPrefetchTerrainHydrology() throws IOException { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/engine/platform/BukkitChunkGenerator.java")); - int start = source.indexOf("private CompletableFuture prefetchSpawnHydrology("); - int end = source.indexOf("private void updateSpawnLocation(", start); - String prefetch = source.substring(start, end); - - assertTrue(prefetch.indexOf("if (usesFlatStudioTerrain())") >= 0); - assertTrue(prefetch.indexOf("if (usesFlatStudioTerrain())") - < prefetch.indexOf("engine.getComplex()")); - } - @Test public void runtimeAndOrdinaryStudioWarmGenerationCaches() { IrisEngine.InitializationMode runtime = @@ -180,5 +164,4 @@ public class BukkitChunkGeneratorInitializationModeTest { assertFalse(BukkitChunkGenerator.shouldPersistWorldRegistration(true)); assertTrue(BukkitChunkGenerator.shouldPersistWorldRegistration(false)); } - } diff --git a/core/src/test/java/art/arcane/iris/purity/CoreProcessStreamPurityGateTest.java b/core/src/test/java/art/arcane/iris/purity/CoreProcessStreamPurityGateTest.java new file mode 100644 index 000000000..10d786243 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/purity/CoreProcessStreamPurityGateTest.java @@ -0,0 +1,91 @@ +package art.arcane.iris.purity; + +import art.arcane.iris.core.loader.IrisData; +import org.junit.Test; +import org.objectweb.asm.ClassReader; +import org.objectweb.asm.ClassVisitor; +import org.objectweb.asm.MethodVisitor; +import org.objectweb.asm.Opcodes; + +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Stream; + +import static org.junit.Assert.assertTrue; + +public class CoreProcessStreamPurityGateTest { + private static final String SYSTEM_OWNER = "java/lang/System"; + private static final String STACK_TRACE_METHOD = "printStackTrace"; + + @Test + public void coreProductionBytecodeNeverTouchesTheProcessStreams() throws Exception { + Path classes = Path.of(IrisData.class.getProtectionDomain().getCodeSource().getLocation().toURI()); + assertTrue("core classes must be a directory to scan, got " + classes, Files.isDirectory(classes)); + List violations = new ArrayList<>(); + int scanned = 0; + + try (Stream tree = Files.walk(classes)) { + for (Path file : tree.filter(candidate -> candidate.toString().endsWith(".class")).toList()) { + collectViolations(file, violations); + scanned++; + } + } + + assertTrue("the gate scanned only " + scanned + " core classes, so it proves nothing", scanned > 1000); + + assertTrue("Core production code must report through IrisLogging, never the process streams." + + " printStackTrace(PrintStream)/printStackTrace(PrintWriter) write to a caller-supplied" + + " sink and stay allowed:" + String.join("", violations), violations.isEmpty()); + } + + private static void collectViolations(Path classFile, List violations) throws Exception { + ClassReader reader; + try (InputStream input = Files.newInputStream(classFile)) { + reader = new ClassReader(input); + } + String owner = reader.getClassName(); + + reader.accept(new ClassVisitor(Opcodes.ASM9) { + @Override + public MethodVisitor visitMethod( + int access, + String name, + String descriptor, + String signature, + String[] exceptions + ) { + return new MethodVisitor(Opcodes.ASM9) { + @Override + public void visitFieldInsn(int opcode, String fieldOwner, String fieldName, String fieldDescriptor) { + if (opcode != Opcodes.GETSTATIC || !SYSTEM_OWNER.equals(fieldOwner)) { + return; + } + if ("out".equals(fieldName) || "err".equals(fieldName)) { + violations.add(report(owner, name, "System." + fieldName)); + } + } + + @Override + public void visitMethodInsn( + int opcode, + String methodOwner, + String methodName, + String methodDescriptor, + boolean isInterface + ) { + if (STACK_TRACE_METHOD.equals(methodName) && "()V".equals(methodDescriptor)) { + violations.add(report(owner, name, methodOwner.replace('/', '.') + "#printStackTrace()")); + } + } + }; + } + }, ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES); + } + + private static String report(String owner, String method, String detail) { + return "\n " + owner.replace('/', '.') + "#" + method + " -> " + detail; + } +} diff --git a/core/src/test/java/art/arcane/iris/purity/PackTypeBukkitPurityGateTest.java b/core/src/test/java/art/arcane/iris/purity/PackTypeBukkitPurityGateTest.java index c577d0a32..bdcea42cd 100644 --- a/core/src/test/java/art/arcane/iris/purity/PackTypeBukkitPurityGateTest.java +++ b/core/src/test/java/art/arcane/iris/purity/PackTypeBukkitPurityGateTest.java @@ -2,6 +2,11 @@ package art.arcane.iris.purity; import art.arcane.iris.engine.object.annotations.Snippet; import org.junit.Test; +import org.objectweb.asm.ClassReader; +import org.objectweb.asm.ClassVisitor; +import org.objectweb.asm.MethodVisitor; +import org.objectweb.asm.Opcodes; +import org.objectweb.asm.Type; import java.io.File; import java.lang.annotation.Annotation; @@ -10,7 +15,6 @@ import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Modifier; import java.net.URL; -import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; @@ -22,8 +26,6 @@ import java.util.List; import java.util.Locale; import java.util.Set; import java.util.TreeSet; -import java.util.regex.Matcher; -import java.util.regex.Pattern; import java.util.stream.Stream; import java.util.zip.ZipEntry; import java.util.zip.ZipFile; @@ -74,13 +76,12 @@ public class PackTypeBukkitPurityGateTest { /** See {@link #theGateStillCatchesAClassThatNeedsBukkit()}. */ private static final String BUKKIT_DEPENDENT_CANARY = "art.arcane.iris.engine.object.IrisObjectRotation$Faces"; private static final String OBJECT_PACKAGE = "art/arcane/iris/engine/object"; - private static final Path IRIS_DATA_SOURCE = - Paths.get("src", "main", "java", "art", "arcane", "iris", "core", "loader", "IrisData.java"); + private static final String IRIS_DATA = "art.arcane.iris.core.loader.IrisData"; /** * Every type handed to {@code registerLoader} in {@code IrisData.hotloaded()} - i.e. every root * type Gson deserializes from a pack. Kept literal on purpose; {@link - * #registeredRootListMatchesIrisData()} fails if the source drifts away from it. + * #registeredRootListMatchesIrisData()} fails if the compiled registrations drift away from it. */ private static final List GSON_REGISTERED_ROOTS = List.of( "art.arcane.iris.engine.object.IrisLootTable", @@ -140,21 +141,52 @@ public class PackTypeBukkitPurityGateTest { @Test public void registeredRootListMatchesIrisData() throws Exception { - if (!Files.isRegularFile(IRIS_DATA_SOURCE)) { - return; - } - String source = Files.readString(IRIS_DATA_SOURCE, StandardCharsets.UTF_8); - Matcher matcher = Pattern.compile("registerLoader\\((\\w+)\\.class").matcher(source); - Set inSource = new TreeSet<>(); - while (matcher.find()) { - inSource.add(matcher.group(1)); - } + byte[] bytes = BukkitHidingClassLoader.readClassBytes(getClass().getClassLoader(), IRIS_DATA); + assertNotNull("no class bytes for " + IRIS_DATA, bytes); + + Set registered = new TreeSet<>(); + new ClassReader(bytes).accept(new ClassVisitor(Opcodes.ASM9) { + @Override + public MethodVisitor visitMethod( + int access, + String name, + String descriptor, + String signature, + String[] exceptions + ) { + return new MethodVisitor(Opcodes.ASM9) { + private String pendingRegistrant; + + @Override + public void visitLdcInsn(Object value) { + if (value instanceof Type type && type.getSort() == Type.OBJECT) { + pendingRegistrant = type.getClassName(); + } + } + + @Override + public void visitMethodInsn( + int opcode, + String owner, + String methodName, + String methodDescriptor, + boolean isInterface + ) { + if ("registerLoader".equals(methodName) && pendingRegistrant != null) { + registered.add(pendingRegistrant.substring(pendingRegistrant.lastIndexOf('.') + 1)); + } + pendingRegistrant = null; + } + }; + } + }, ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES); + Set inTest = new TreeSet<>(); for (String name : GSON_REGISTERED_ROOTS) { inTest.add(name.substring(name.lastIndexOf('.') + 1)); } assertEquals("IrisData registers a different set of pack roots than this gate covers - " - + "add the new type to GSON_REGISTERED_ROOTS", inTest, inSource); + + "add the new type to GSON_REGISTERED_ROOTS", inTest, registered); } @Test diff --git a/core/src/test/java/art/arcane/iris/spi/PacksFolderContractTest.java b/core/src/test/java/art/arcane/iris/spi/PacksFolderContractTest.java index 7d51b4d12..2242d8c31 100644 --- a/core/src/test/java/art/arcane/iris/spi/PacksFolderContractTest.java +++ b/core/src/test/java/art/arcane/iris/spi/PacksFolderContractTest.java @@ -1,21 +1,32 @@ package art.arcane.iris.spi; +import art.arcane.iris.core.service.StudioSVC; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; +import org.objectweb.asm.ClassReader; +import org.objectweb.asm.ClassVisitor; +import org.objectweb.asm.MethodVisitor; +import org.objectweb.asm.Opcodes; import java.io.File; +import java.io.InputStream; import java.nio.file.Files; import java.nio.file.Path; +import java.util.ArrayList; import java.util.List; +import java.util.stream.Stream; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; import static org.mockito.Answers.CALLS_REAL_METHODS; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class PacksFolderContractTest { + private static final String PLATFORM_OWNER = "art/arcane/iris/spi/IrisPlatform"; + private static final String PACKS_ROOT_NAME = StudioSVC.WORKSPACE_NAME; + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); @@ -29,24 +40,92 @@ public class PacksFolderContractTest { assertEquals(new File(data, "packs" + File.separator + "overworld"), platform.packsFolderNoCreate("overworld")); } - /** - * Source guard: nothing outside the SPI defaults and platform overrides may spell the packs - * root by hand. New code goes through packsFolder()/packsFolderNoCreate(). - */ @Test - public void noCallSiteResolvesThePacksRootByHand() throws Exception { - List roots = List.of( - Path.of("src/main/java"), - Path.of("../adapters/bukkit/plugin/src/main/java")); - for (Path root : roots) { - try (var stream = Files.walk(root)) { - for (Path file : stream.filter(p -> p.toString().endsWith(".java")).toList()) { - String text = Files.readString(file); - assertFalse(file + " must use packsFolder() instead of dataFolder(\"packs\")", - text.contains("dataFolder(\"packs\")")); - assertFalse(file + " must use packsFolderNoCreate() instead of the WORKSPACE_NAME indirection", - text.contains("dataFolderNoCreate(StudioSVC.WORKSPACE_NAME")); - } + public void noCompiledCallSiteResolvesThePacksRootByHand() throws Exception { + Path classes = Path.of(StudioSVC.class.getProtectionDomain().getCodeSource().getLocation().toURI()); + assertTrue("core classes must be a directory to scan, got " + classes, Files.isDirectory(classes)); + List violations = new ArrayList<>(); + int scanned = 0; + + try (Stream tree = Files.walk(classes)) { + for (Path file : tree.filter(candidate -> candidate.toString().endsWith(".class")).toList()) { + collectViolations(file, violations); + scanned++; + } + } + + assertTrue("the gate scanned only " + scanned + " core classes, so it proves nothing", scanned > 1000); + + assertTrue("These methods spell the packs root by hand instead of going through" + + " IrisPlatform.packsFolder()/packsFolderNoCreate():" + String.join("", violations), + violations.isEmpty()); + } + + private static void collectViolations(Path classFile, List violations) throws Exception { + ClassReader reader; + try (InputStream input = Files.newInputStream(classFile)) { + reader = new ClassReader(input); + } + String owner = reader.getClassName(); + if (owner.equals(PLATFORM_OWNER)) { + return; + } + + reader.accept(new ClassVisitor(Opcodes.ASM9) { + @Override + public MethodVisitor visitMethod( + int access, + String name, + String descriptor, + String signature, + String[] exceptions + ) { + return new PacksRootCallSite(owner, name, violations); + } + }, ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES); + } + + private static final class PacksRootCallSite extends MethodVisitor { + private final String owner; + private final String method; + private final List violations; + private boolean loadsPacksRootName; + private boolean resolvesDataFolder; + + private PacksRootCallSite(String owner, String method, List violations) { + super(Opcodes.ASM9); + this.owner = owner; + this.method = method; + this.violations = violations; + } + + @Override + public void visitLdcInsn(Object value) { + if (PACKS_ROOT_NAME.equals(value)) { + loadsPacksRootName = true; + } + } + + @Override + public void visitMethodInsn( + int opcode, + String methodOwner, + String methodName, + String methodDescriptor, + boolean isInterface + ) { + if (!PLATFORM_OWNER.equals(methodOwner)) { + return; + } + if ("dataFolder".equals(methodName) || "dataFolderNoCreate".equals(methodName)) { + resolvesDataFolder = true; + } + } + + @Override + public void visitEnd() { + if (loadsPacksRootName && resolvesDataFolder) { + violations.add("\n " + owner.replace('/', '.') + "#" + method); } } } diff --git a/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java b/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java index 8530e15f4..c74a36807 100644 --- a/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java @@ -21,9 +21,6 @@ import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; import org.junit.Test; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.LinkedHashSet; import java.util.List; import java.util.Set; @@ -231,24 +228,6 @@ public class StructureHandlerTest { } } - @Test - public void completionUsesOneReachabilitySnapshotAndLocatableKeys() throws IOException { - Path sourcePath = Path.of( - "src/main/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandler.java"); - String source = Files.readString(sourcePath).replace("\r\n", "\n"); - int methodStart = source.indexOf("public KList getPossibilities()"); - int methodEnd = source.indexOf("@Override\n public String toString", methodStart); - String method = source.substring(methodStart, methodEnd); - - assertEquals(1, occurrences(method, "StructureReachability.reachableKeys(activeEngine)")); - assertEquals(0, occurrences(method, "IrisStructureLocator.locatableKeys(activeEngine)")); - assertEquals(1, occurrences(method, "IrisStructureLocator.locatableEditableKeys(activeEngine)")); - assertTrue(method.indexOf("if (activeEngine == null)") - < method.indexOf("IrisPlatforms.get().structureHooks()")); - assertFalse(method.contains("INMS")); - assertFalse(method.contains("catch (")); - } - private static IrisNativeStructureDecision decision(NativeStructureGenerationStatus status) { return new IrisNativeStructureDecision(status, 0, null, false, null, null); } @@ -268,16 +247,6 @@ public class StructureHandlerTest { return placement; } - private static int occurrences(String source, String target) { - int count = 0; - int offset = 0; - while ((offset = source.indexOf(target, offset)) >= 0) { - count++; - offset += target.length(); - } - return count; - } - private static final class TestStructureHandler extends StructureHandler { private final Engine activeEngine; private final boolean nativeGenerationEnabled; diff --git a/core/src/test/java/art/arcane/iris/util/common/scheduling/JRegionFutureContractTest.java b/core/src/test/java/art/arcane/iris/util/common/scheduling/JRegionFutureContractTest.java deleted file mode 100644 index 470a3f737..000000000 --- a/core/src/test/java/art/arcane/iris/util/common/scheduling/JRegionFutureContractTest.java +++ /dev/null @@ -1,24 +0,0 @@ -package art.arcane.iris.util.common.scheduling; - -import org.junit.Test; - -import java.nio.file.Files; -import java.nio.file.Path; - -import static org.junit.Assert.assertTrue; - -public class JRegionFutureContractTest { - @Test - public void regionFutureSettlesEverySchedulerPath() throws Exception { - String source = Files.readString(Path.of( - "src/main/java/art/arcane/iris/util/common/scheduling/J.java")) - .replace("\r\n", "\n"); - int start = source.indexOf("public static CompletableFuture runRegionFuture("); - int end = source.indexOf("public static boolean runGlobal(", start); - String method = source.substring(start, end); - - assertTrue(method.contains("settle(future, runnable)")); - assertTrue(method.contains("future.completeExceptionally(")); - assertTrue(method.contains("return sfut(runnable);")); - } -} From c332c86849646bd2fa30499b28fe9658dc6824be Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:24:58 -0400 Subject: [PATCH 02/35] Relax test fsync - Add Durability, a process-wide fsync policy defaulting to real barriers and switchable to relaxed through the iris.durability system property - Route the history, studio, journal, structure and datapack fsync barriers through Durability so relaxed mode skips both the force and the channel open - Add the DurabilityMode test rule and enable relaxed durability on the twenty slowest core stores tests - Split GenerationHistoryTest into epoch, legacy adoption and recovery classes over a shared GenerationHistorySupport base --- .../core/datapack/DatapackIngestService.java | 13 +- .../core/lifecycle/DirectoryDurability.java | 7 +- .../lifecycle/WorldReplacementJournal.java | 3 +- .../service/JigsawStudioHistoryStore.java | 9 +- .../authoring/StructureFileOperations.java | 13 +- .../engine/history/GenerationHistory.java | 7 +- .../history/GenerationHistoryStore.java | 11 +- .../history/GenerationSemanticIndex.java | 15 +- .../iris/util/common/io/Durability.java | 33 + ...sDatapackCompilerInputFingerprintTest.java | 5 + .../iris/core/IrisDatapackCompilerTest.java | 5 + .../datapack/DatapackIngestServiceTest.java | 5 + .../WorldReplacementBootstrapTest.java | 4 + .../WorldReplacementFilesystemTest.java | 4 + .../DefaultPackBootstrapProvisionerTest.java | 5 + .../JigsawStudioGraphEditorResizeTest.java | 4 + .../JigsawStudioPersistenceEditorsTest.java | 4 + .../JigsawStudioProjectCreatorTest.java | 4 + .../service/JigsawStudioHistoryStoreTest.java | 5 + ...gsawStudioResourceBundleAssemblerTest.java | 4 + .../StructureTransactionWriterTest.java | 5 + .../iris/engine/EngineShutdownDrainTest.java | 5 + .../history/ChunkGenerationOwnershipTest.java | 5 + .../GenerationHistoryLegacyAdoptionTest.java | 146 +++++ .../GenerationHistoryRecoveryTest.java | 345 ++++++++++ .../GenerationHistoryRuntimeRouterTest.java | 5 + .../history/GenerationHistoryStoreTest.java | 5 + .../history/GenerationHistorySupport.java | 145 +++++ .../engine/history/GenerationHistoryTest.java | 606 +----------------- .../history/GenerationSemanticIndexTest.java | 5 + .../history/TransitionGenerationPlanTest.java | 5 + .../history/WorldChunkInventoryTest.java | 5 + ...tFixtures.java => PackCompatFixtures.java} | 0 .../iris/testsupport/DurabilityMode.java | 41 ++ 34 files changed, 862 insertions(+), 621 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/util/common/io/Durability.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryLegacyAdoptionTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRecoveryTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistorySupport.java rename core/src/test/java/art/arcane/iris/engine/object/{CompatFixtures.java => PackCompatFixtures.java} (100%) create mode 100644 core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java index 5cbca3872..4de16d223 100644 --- a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java @@ -37,6 +37,7 @@ import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.engine.object.IrisImportedStructureControl; import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.io.Durability; import art.arcane.iris.util.common.plugin.VolmitSender; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.io.IO; @@ -5396,17 +5397,25 @@ public final class DatapackIngestService { } private static void forceFile(Path file) throws IOException { + if (!Durability.enabled()) { + return; + } + try (FileChannel channel = FileChannel.open(file, StandardOpenOption.WRITE)) { - channel.force(true); + Durability.force(channel); } } private static void forceDirectoryIfSupported(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + if (!Files.getFileStore(directory).supportsFileAttributeView("posix")) { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } } diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/DirectoryDurability.java b/core/src/main/java/art/arcane/iris/core/lifecycle/DirectoryDurability.java index 8d645c115..fca7c312d 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/DirectoryDurability.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/DirectoryDurability.java @@ -2,6 +2,7 @@ package art.arcane.iris.core.lifecycle; import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.io.Durability; import java.io.File; import java.io.IOException; import java.nio.channels.FileChannel; @@ -19,11 +20,15 @@ final class DirectoryDurability { } static void forceDirectoryRequired(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + if (File.separatorChar == '\\') { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } catch (UnsupportedOperationException failure) { throw new IOException("Directory durability sync is unavailable for " + directory + ".", failure); } diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldReplacementJournal.java b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldReplacementJournal.java index 4541b20cb..5b649c9a9 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldReplacementJournal.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldReplacementJournal.java @@ -5,6 +5,7 @@ import art.arcane.iris.core.IrisWorldStorage; import art.arcane.iris.core.WorldSlotKey; import art.arcane.iris.core.lifecycle.BukkitWorldConfiguration.WorldGeneratorSnapshot; +import art.arcane.iris.util.common.io.Durability; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; @@ -345,7 +346,7 @@ public final class WorldReplacementJournal { while (buffer.hasRemaining()) { channel.write(buffer); } - channel.force(true); + Durability.force(channel); } forceDirectoryRequired(parent); try { diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioHistoryStore.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioHistoryStore.java index 14a05b3be..d59243cdf 100644 --- a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioHistoryStore.java +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioHistoryStore.java @@ -12,6 +12,7 @@ import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.core.structure.authoring.StructureWriteOptions; import art.arcane.iris.core.structure.authoring.StructureWriteResult; import art.arcane.iris.engine.framework.structure.StructureResourceBundleGraphCompiler; +import art.arcane.iris.util.common.io.Durability; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -303,7 +304,7 @@ final class JigsawStudioHistoryStore { while (buffer.hasRemaining()) { channel.write(buffer); } - channel.force(true); + Durability.force(channel); } try { Files.move( @@ -374,6 +375,10 @@ final class JigsawStudioHistoryStore { } private static void forceDirectory(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + // A directory can only be opened and fsynced on a POSIX filesystem; Windows rejects the // open outright. Matches DirectoryDurability and DatapackIngestService, which already // skip the barrier there. @@ -381,7 +386,7 @@ final class JigsawStudioHistoryStore { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } } diff --git a/core/src/main/java/art/arcane/iris/core/structure/authoring/StructureFileOperations.java b/core/src/main/java/art/arcane/iris/core/structure/authoring/StructureFileOperations.java index da695e5c1..4a16fa414 100644 --- a/core/src/main/java/art/arcane/iris/core/structure/authoring/StructureFileOperations.java +++ b/core/src/main/java/art/arcane/iris/core/structure/authoring/StructureFileOperations.java @@ -18,6 +18,7 @@ package art.arcane.iris.core.structure.authoring; +import art.arcane.iris.util.common.io.Durability; import java.io.IOException; import java.io.InputStream; import java.nio.channels.FileChannel; @@ -70,17 +71,25 @@ interface StructureFileOperations { } default void forceFile(Path path) throws IOException { + if (!Durability.enabled()) { + return; + } + try (FileChannel channel = FileChannel.open(path, StandardOpenOption.WRITE)) { - channel.force(true); + Durability.force(channel); } } default void forceDirectory(Path path) throws IOException { + if (!Durability.enabled()) { + return; + } + if (!Files.getFileStore(path).supportsFileAttributeView("posix")) { return; } try (FileChannel channel = FileChannel.open(path, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } } } diff --git a/core/src/main/java/art/arcane/iris/engine/history/GenerationHistory.java b/core/src/main/java/art/arcane/iris/engine/history/GenerationHistory.java index fbe29df1a..4335f78dc 100644 --- a/core/src/main/java/art/arcane/iris/engine/history/GenerationHistory.java +++ b/core/src/main/java/art/arcane/iris/engine/history/GenerationHistory.java @@ -1,6 +1,7 @@ package art.arcane.iris.engine.history; import art.arcane.iris.core.pack.AtomicDirectoryPublisher; +import art.arcane.iris.util.common.io.Durability; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; import java.io.File; @@ -1153,11 +1154,15 @@ public final class GenerationHistory { } private static void forceDirectory(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + if (File.separatorChar == '\\') { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } catch (UnsupportedOperationException exception) { throw new IOException("Generation history directory cannot be durability-synced: " + directory, exception); diff --git a/core/src/main/java/art/arcane/iris/engine/history/GenerationHistoryStore.java b/core/src/main/java/art/arcane/iris/engine/history/GenerationHistoryStore.java index cf194565e..530ac14d5 100644 --- a/core/src/main/java/art/arcane/iris/engine/history/GenerationHistoryStore.java +++ b/core/src/main/java/art/arcane/iris/engine/history/GenerationHistoryStore.java @@ -1,5 +1,6 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.util.common.io.Durability; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.JsonElement; @@ -282,7 +283,7 @@ public final class GenerationHistoryStore { while (buffer.hasRemaining()) { channel.write(buffer); } - channel.force(true); + Durability.force(channel); } try { if (replaceExisting) { @@ -352,7 +353,7 @@ public final class GenerationHistoryStore { while (buffer.hasRemaining()) { channel.write(buffer); } - channel.force(true); + Durability.force(channel); } try { Files.move(temporary, metadata, StandardCopyOption.ATOMIC_MOVE); @@ -439,11 +440,15 @@ public final class GenerationHistoryStore { } private static void forceDirectory(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + if (File.separatorChar == '\\') { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } catch (UnsupportedOperationException exception) { throw new IOException("Generation history directory cannot be durability-synced: " + directory, exception); } diff --git a/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java b/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java index 891e8f620..74c903135 100644 --- a/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java +++ b/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java @@ -1,6 +1,7 @@ package art.arcane.iris.engine.history; import art.arcane.iris.engine.hydrology.HydrologyFeatureType; +import art.arcane.iris.util.common.io.Durability; import it.unimi.dsi.fastutil.longs.Long2IntOpenHashMap; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; import it.unimi.dsi.fastutil.longs.LongOpenHashSet; @@ -1949,14 +1950,14 @@ public final class GenerationSemanticIndex { channel.write(entry); } } - channel.force(true); + Durability.force(channel); if (created) { RegionShard.forceDirectory(directory); } } catch (IOException failure) { try { channel.truncate(size); - channel.force(true); + Durability.force(channel); if (created) { RegionShard.forceDirectory(directory); } @@ -2079,7 +2080,7 @@ public final class GenerationSemanticIndex { private static void truncateTail(RandomAccessFile file, long length) throws IOException { file.setLength(length); - file.getFD().sync(); + Durability.force(file.getFD()); } private static IOException invalid(Path file, String reason) { @@ -2951,16 +2952,20 @@ public final class GenerationSemanticIndex { while (buffer.hasRemaining()) { channel.write(buffer); } - channel.force(true); + Durability.force(channel); } } private static void forceDirectory(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + if (File.separatorChar == '\\') { return; } try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - channel.force(true); + Durability.force(channel); } catch (UnsupportedOperationException error) { throw new IOException("Generation semantic directory cannot be durability-synced", error); } diff --git a/core/src/main/java/art/arcane/iris/util/common/io/Durability.java b/core/src/main/java/art/arcane/iris/util/common/io/Durability.java new file mode 100644 index 000000000..a37b6866b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/util/common/io/Durability.java @@ -0,0 +1,33 @@ +package art.arcane.iris.util.common.io; + +import java.io.FileDescriptor; +import java.io.IOException; +import java.nio.channels.FileChannel; + +public final class Durability { + public static final String MODE_PROPERTY = "iris.durability"; + private static final String RELAXED = "relaxed"; + + private Durability() { + } + + public static boolean enabled() { + return !RELAXED.equalsIgnoreCase(System.getProperty(MODE_PROPERTY)); + } + + public static void force(FileChannel channel) throws IOException { + if (!enabled()) { + return; + } + + channel.force(true); + } + + public static void force(FileDescriptor descriptor) throws IOException { + if (!enabled()) { + return; + } + + descriptor.sync(); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerInputFingerprintTest.java b/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerInputFingerprintTest.java index 48eb068c2..b06f9962d 100644 --- a/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerInputFingerprintTest.java +++ b/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerInputFingerprintTest.java @@ -6,7 +6,9 @@ import art.arcane.iris.engine.history.GenerationEpochContractFactory; import art.arcane.iris.engine.history.GenerationHistory; import art.arcane.iris.engine.history.GenerationPackFingerprint; import art.arcane.iris.engine.history.GenerationRegistryContract; +import art.arcane.iris.testsupport.DurabilityMode; import org.junit.Assume; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -26,6 +28,9 @@ import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; public class IrisDatapackCompilerInputFingerprintTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public TemporaryFolder tmp = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerTest.java b/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerTest.java index 381cf1d1f..fd00e1485 100644 --- a/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerTest.java +++ b/core/src/test/java/art/arcane/iris/core/IrisDatapackCompilerTest.java @@ -17,8 +17,10 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformGenerationRegistry; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.json.JSONObject; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.Assume; @@ -42,6 +44,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisDatapackCompilerTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java index de8447788..7db24b0dc 100644 --- a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java +++ b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java @@ -10,6 +10,7 @@ import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.core.structure.authoring.StructureWriteMode; import art.arcane.iris.core.structure.authoring.StructureWriteResult; import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.io.IO; import com.google.gson.Gson; @@ -18,6 +19,7 @@ import com.google.gson.JsonObject; import com.google.gson.JsonParser; import com.sun.net.httpserver.HttpServer; import org.bukkit.Server; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.Assume; @@ -54,6 +56,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class DatapackIngestServiceTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private interface PaperLikeServer extends Server { String getMinecraftVersion(); } diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementBootstrapTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementBootstrapTest.java index 430d86d82..32f62c0a8 100644 --- a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementBootstrapTest.java +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementBootstrapTest.java @@ -11,6 +11,7 @@ import art.arcane.iris.engine.history.GenerationEpochContractFactory; import art.arcane.iris.engine.history.GenerationHistory; import art.arcane.iris.engine.history.GenerationPackFingerprint; import art.arcane.iris.engine.history.GenerationRegistryContract; +import art.arcane.iris.testsupport.DurabilityMode; import org.junit.Before; import org.junit.BeforeClass; import org.junit.ClassRule; @@ -32,6 +33,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class WorldReplacementBootstrapTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final WorldSlotKey WORLD_KEY = WorldSlotKey.minecraft("the_nether"); private static final long SEED = 4242424242L; diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementFilesystemTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementFilesystemTest.java index 622874288..d0a7b2864 100644 --- a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementFilesystemTest.java +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldReplacementFilesystemTest.java @@ -5,6 +5,7 @@ import art.arcane.iris.engine.history.GenerationEpochContractFactory; import art.arcane.iris.engine.history.GenerationHistory; import art.arcane.iris.engine.history.GenerationPackFingerprint; import art.arcane.iris.engine.history.GenerationRegistryContract; +import art.arcane.iris.testsupport.DurabilityMode; import org.junit.Assume; import org.junit.BeforeClass; import org.junit.ClassRule; @@ -30,6 +31,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class WorldReplacementFilesystemTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final UUID TRANSACTION_ID = UUID.fromString("00000000-0000-0000-0000-000000000001"); private static final UUID OTHER_TRANSACTION_ID = UUID.fromString("00000000-0000-0000-0000-000000000002"); diff --git a/core/src/test/java/art/arcane/iris/core/pack/DefaultPackBootstrapProvisionerTest.java b/core/src/test/java/art/arcane/iris/core/pack/DefaultPackBootstrapProvisionerTest.java index c4525b85e..d72c65d91 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/DefaultPackBootstrapProvisionerTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/DefaultPackBootstrapProvisionerTest.java @@ -3,9 +3,11 @@ package art.arcane.iris.core.pack; import art.arcane.iris.core.lifecycle.BukkitStartupPaths; import art.arcane.iris.engine.history.GenerationRegistryContractFactory; import art.arcane.iris.engine.object.IrisBiomeCustom; +import art.arcane.iris.testsupport.DurabilityMode; import com.sun.net.httpserver.HttpExchange; import com.sun.net.httpserver.HttpServer; import org.junit.Assume; +import org.junit.ClassRule; import org.junit.Test; import java.io.ByteArrayOutputStream; @@ -39,6 +41,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class DefaultPackBootstrapProvisionerTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Test public void startupDoesNotRequireOrDownloadDefaultPacks() { assertTrue(DefaultPackBootstrapProvisioner.defaultPacks().isEmpty()); diff --git a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java index 795f7b581..9c8c1ca04 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java @@ -6,6 +6,7 @@ import art.arcane.iris.engine.object.IrisJigsawPiece; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.iris.util.common.math.IrisBlockVector; import com.google.gson.JsonArray; import com.google.gson.JsonObject; @@ -36,6 +37,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class JigsawStudioGraphEditorResizeTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final String STRUCTURE_KEY = "resize/planar"; @ClassRule diff --git a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioPersistenceEditorsTest.java b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioPersistenceEditorsTest.java index 0d774b7d8..d0d0549fc 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioPersistenceEditorsTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioPersistenceEditorsTest.java @@ -10,6 +10,7 @@ import art.arcane.iris.core.structure.authoring.StructureWriteMode; import art.arcane.iris.core.structure.authoring.StructureWriteResult; import art.arcane.iris.engine.object.IrisJigsawThemeSet; import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.iris.util.common.math.IrisBlockVector; import com.google.gson.JsonArray; import com.google.gson.JsonElement; @@ -40,6 +41,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class JigsawStudioPersistenceEditorsTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final String PLANAR_KEY = "studio/planar"; private static final String SPATIAL_KEY = "studio/spatial"; diff --git a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioProjectCreatorTest.java b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioProjectCreatorTest.java index 7fd5c4ba9..c21360586 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioProjectCreatorTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioProjectCreatorTest.java @@ -9,6 +9,7 @@ import art.arcane.iris.engine.framework.structure.StructureGraphCompilation; import art.arcane.iris.engine.framework.structure.StructureResourceBundleGraphCompiler; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.volmlib.util.math.RNG; import com.google.gson.JsonObject; @@ -35,6 +36,9 @@ import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; public class JigsawStudioProjectCreatorTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final JigsawStudioProjectCreator.Options DEFAULT_PLANAR_OPTIONS = new JigsawStudioProjectCreator.Options( "settlement/test", diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioHistoryStoreTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioHistoryStoreTest.java index 9a7fe370f..c5a766535 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioHistoryStoreTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioHistoryStoreTest.java @@ -11,6 +11,8 @@ import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.core.structure.authoring.StructureWriteOptions; import art.arcane.iris.core.structure.authoring.StructureWriteResult; import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.testsupport.DurabilityMode; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -29,6 +31,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class JigsawStudioHistoryStoreTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioResourceBundleAssemblerTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioResourceBundleAssemblerTest.java index dda5ee08c..7b95615f4 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioResourceBundleAssemblerTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioResourceBundleAssemblerTest.java @@ -17,6 +17,7 @@ import art.arcane.iris.engine.object.IrisJigsawPiece; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.JigsawJoint; +import art.arcane.iris.testsupport.DurabilityMode; import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.JsonObject; @@ -46,6 +47,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class JigsawStudioResourceBundleAssemblerTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final Gson PRETTY_GSON = new GsonBuilder().setPrettyPrinting().create(); private static final String STRUCTURE_KEY = "fort"; diff --git a/core/src/test/java/art/arcane/iris/core/structure/authoring/StructureTransactionWriterTest.java b/core/src/test/java/art/arcane/iris/core/structure/authoring/StructureTransactionWriterTest.java index 52e695213..e4621cc07 100644 --- a/core/src/test/java/art/arcane/iris/core/structure/authoring/StructureTransactionWriterTest.java +++ b/core/src/test/java/art/arcane/iris/core/structure/authoring/StructureTransactionWriterTest.java @@ -18,6 +18,8 @@ package art.arcane.iris.core.structure.authoring; +import art.arcane.iris.testsupport.DurabilityMode; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.Assume; @@ -40,6 +42,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class StructureTransactionWriterTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final StructureKey TARGET_KEY = StructureKey.parse("iris_test:temple"); private static final StructureKey SOURCE_KEY = StructureKey.parse("minecraft:trial_chambers"); diff --git a/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java b/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java index 4b0208384..42faebe7d 100644 --- a/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java +++ b/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java @@ -26,8 +26,10 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.DurabilityMode; import org.junit.AfterClass; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import org.junit.Rule; import org.junit.rules.TemporaryFolder; @@ -69,6 +71,9 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class EngineShutdownDrainTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static IrisPlatform previousPlatform; @Rule diff --git a/core/src/test/java/art/arcane/iris/engine/history/ChunkGenerationOwnershipTest.java b/core/src/test/java/art/arcane/iris/engine/history/ChunkGenerationOwnershipTest.java index c9df042df..d6b7f574c 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/ChunkGenerationOwnershipTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/ChunkGenerationOwnershipTest.java @@ -1,6 +1,8 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.DurabilityMode; import org.junit.Assume; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -19,6 +21,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public final class ChunkGenerationOwnershipTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public final TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryLegacyAdoptionTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryLegacyAdoptionTest.java new file mode 100644 index 000000000..b354f6088 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryLegacyAdoptionTest.java @@ -0,0 +1,146 @@ +package art.arcane.iris.engine.history; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class GenerationHistoryLegacyAdoptionTest extends GenerationHistorySupport { + @Test + public void legacyAdoptionIsDurableExplicitAndIdempotent() throws Exception { + Path world = temporaryFolder.newFolder("legacy-world").toPath(); + Path legacy = Files.createDirectories(world.resolve("iris/pack/dimensions")); + Files.writeString(legacy.resolve("main.json"), "legacy"); + Path legacyRoot = world.resolve("iris/pack"); + Path legacyMantle = Files.createDirectories(world.resolve("mantle-hydrology")); + Files.writeString(legacyMantle.resolve("r.0.0.lz4b"), "mantle"); + String fingerprint = fingerprint(legacyRoot); + + GenerationHistory adopted = GenerationHistory.adoptLegacyPack( + world, + fingerprint, + 42L, + contract(), + GenerationRegistryContract.empty() + ); + + assertFalse(Files.exists(legacyRoot)); + assertFalse(Files.exists(legacyMantle)); + assertTrue(Files.isDirectory(adopted.activePackRoot())); + Path activationMantle = adopted.paths().activationMantleRoot(1L); + assertEquals("mantle", Files.readString(activationMantle.resolve("r.0.0.lz4b"))); + assertEquals(1L, adopted.activeActivation().activationId()); + GenerationHistory repeated = GenerationHistory.adoptLegacyPack( + world, + fingerprint, + 42L, + contract(), + GenerationRegistryContract.empty() + ); + assertEquals(adopted.activeEpoch(), repeated.activeEpoch()); + assertEquals("mantle", Files.readString(repeated.paths().activationMantleRoot(1L) + .resolve("r.0.0.lz4b"))); + } + + @Test + public void legacyMantleAdoptionFailsClosedOnDualRoots() throws Exception { + Path world = temporaryFolder.newFolder("legacy-dual-mantle-world").toPath(); + Path legacyPack = Files.createDirectories(world.resolve("iris/pack/dimensions")).getParent(); + Files.writeString(legacyPack.resolve("dimensions/main.json"), "legacy"); + Path legacyMantle = Files.createDirectories(world.resolve("mantle-hydrology")); + Files.writeString(legacyMantle.resolve("legacy.bin"), "legacy"); + GenerationHistoryPaths paths = GenerationHistoryPaths.forDimension(world); + Path activationMantle = Files.createDirectories(paths.activationMantleRoot(1L)); + Files.writeString(activationMantle.resolve("activation.bin"), "activation"); + + IOException failure = assertThrows( + IOException.class, + () -> GenerationHistory.adoptLegacyPack( + world, + fingerprint(legacyPack), + 42L, + contract(), + GenerationRegistryContract.empty() + ) + ); + + assertTrue(failure.getMessage().contains("mantle roots conflict")); + assertEquals("legacy", Files.readString(legacyMantle.resolve("legacy.bin"))); + assertEquals("activation", Files.readString(activationMantle.resolve("activation.bin"))); + } + + @Test + public void legacyMantleAdoptionRejectsRootAliases() throws Exception { + Path world = temporaryFolder.newFolder("legacy-aliased-mantle-world").toPath(); + Path legacyPack = Files.createDirectories(world.resolve("iris/pack/dimensions")).getParent(); + Files.writeString(legacyPack.resolve("dimensions/main.json"), "legacy"); + GenerationHistoryPaths paths = GenerationHistoryPaths.forDimension(world); + Path activationMantle = Files.createDirectories(paths.activationMantleRoot(1L)); + Path alias = paths.legacyMantleRoot(); + try { + Files.createSymbolicLink(alias, activationMantle); + } catch (UnsupportedOperationException exception) { + return; + } + + assertThrows( + IOException.class, + () -> GenerationHistory.adoptLegacyPack( + world, + fingerprint(legacyPack), + 42L, + contract(), + GenerationRegistryContract.empty() + ) + ); + assertTrue(Files.isSymbolicLink(alias)); + assertTrue(Files.isDirectory(activationMantle)); + } + + @Test + public void legacyAdoptionNeverDeletesMismatchedOrUnsafeInput() throws Exception { + Path mismatchWorld = temporaryFolder.newFolder("legacy-mismatch-world").toPath(); + Path mismatchRoot = Files.createDirectories(mismatchWorld.resolve("iris/pack/dimensions")).getParent(); + Files.writeString(mismatchRoot.resolve("dimensions/main.json"), "legacy"); + + assertThrows( + IOException.class, + () -> GenerationHistory.adoptLegacyPack( + mismatchWorld, + "f".repeat(64), + 42L, + contract(), + GenerationRegistryContract.empty() + ) + ); + assertTrue(Files.isDirectory(mismatchRoot)); + assertFalse(Files.exists(GenerationHistoryPaths.forDimension(mismatchWorld).manifest())); + + Path linkedWorld = temporaryFolder.newFolder("legacy-linked-world").toPath(); + Files.createDirectories(linkedWorld.resolve("iris")); + Path outside = temporaryFolder.newFolder("legacy-outside").toPath(); + Path link = linkedWorld.resolve("iris/pack"); + try { + Files.createSymbolicLink(link, outside); + } catch (UnsupportedOperationException exception) { + return; + } + assertThrows( + IOException.class, + () -> GenerationHistory.adoptLegacyPack( + linkedWorld, + "f".repeat(64), + 42L, + contract(), + GenerationRegistryContract.empty() + ) + ); + assertTrue(Files.isDirectory(outside)); + assertTrue(Files.isSymbolicLink(link)); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRecoveryTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRecoveryTest.java new file mode 100644 index 000000000..1f13bfba8 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRecoveryTest.java @@ -0,0 +1,345 @@ +package art.arcane.iris.engine.history; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Stream; +import org.junit.Test; + +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class GenerationHistoryRecoveryTest extends GenerationHistorySupport { + @Test + public void openFailsClosedOnDanglingOwnershipAndPartialHistory() throws Exception { + Path danglingWorld = temporaryFolder.newFolder("dangling-world").toPath(); + Path pack = createPack("dangling-pack", "alpha"); + GenerationHistory history = createHistory(danglingWorld, pack); + ChunkGenerationOwnership ownership = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); + ownership.assign(1, 2, 99L); + ownership.persist(); + + assertThrows(IOException.class, () -> GenerationHistory.open(danglingWorld)); + + Path absentWorld = temporaryFolder.newFolder("absent-world").toPath(); + Optional absent = GenerationHistory.openIfPresent(absentWorld); + assertTrue(absent.isEmpty()); + + Path partialWorld = temporaryFolder.newFolder("partial-world").toPath(); + Files.createDirectories(GenerationHistoryPaths.forDimension(partialWorld).generationRoot()); + assertThrows(NoSuchFileException.class, () -> GenerationHistory.openIfPresent(partialWorld)); + } + + @Test + public void savedHistoryOpensWithoutRetainingItsExecutableKernel() throws Exception { + Path world = temporaryFolder.newFolder("retained-abi-world").toPath(); + Path packA = createPack("retained-abi-pack-a", "alpha"); + Path packB = createPack("retained-abi-pack-b", "beta"); + GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); + GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); + GenerationKernelRegistry kernels = new GenerationKernelRegistry( + versionTwo, + List.of( + new GenerationKernelRegistry.Kernel( + 1, + "1".repeat(64), + Map.of( + new GenerationKernelRegistry.AlgorithmVersion(1, 1), + (engine, transitionPlan) -> { + throw new AssertionError("History-only kernel factory was invoked."); + } + ) + ), + new GenerationKernelRegistry.Kernel( + 2, + "2".repeat(64), + Map.of( + new GenerationKernelRegistry.AlgorithmVersion(1, 1), + (engine, transitionPlan) -> { + throw new AssertionError("History-only kernel factory was invoked."); + } + ) + ) + ) + ); + GenerationHistory history = GenerationHistory.create( + world, + packA, + fingerprint(packA), + 42L, + contract(), + GenerationRegistryContract.empty(), + versionOne, + kernels + ); + + history.stageUpdate( + packB, + fingerprint(packB), + contract(), + GenerationRegistryContract.empty(), + 256, + versionTwo + ); + history.promotePending(List.of()); + + assertEquals(2, GenerationHistory.open(world).activeEpoch().generatorAbi()); + GenerationHistory reopened = GenerationHistory.open(world, kernels); + assertEquals(2, reopened.activeEpoch().generatorAbi()); + assertEquals(1, reopened.manifest().activation(1L).orElseThrow().activationId()); + } + + @Test + public void changedBuildExpandsFromSavedTerrainWithoutTheOldFactory() throws Exception { + Path world = temporaryFolder.newFolder("build-upgrade-world").toPath(); + Path pack = createPack("build-upgrade-pack", "alpha"); + GenerationKernelRegistry.Version oldVersion = new GenerationKernelRegistry.Version(101, 1, 1); + GenerationKernelRegistry.Version newVersion = new GenerationKernelRegistry.Version(102, 1, 1); + GenerationKernelRegistry firstBuild = singleKernel(oldVersion, "a"); + GenerationKernelRegistry secondBuild = singleKernel(newVersion, "b"); + GenerationHistory.create(world, pack, fingerprint(pack), 42L, + contract(), GenerationRegistryContract.empty(), oldVersion, firstBuild); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + SavedTerrainTestRegion.write(region, new int[][]{{0, 0}}); + byte[] savedBlocks = Files.readAllBytes(region); + + GenerationHistory upgraded = GenerationHistory.open(world, secondBuild); + assertFalse(upgraded.usesCurrentGenerator()); + upgraded.prepareCurrentGenerator(32); + assertTrue(upgraded.usesCurrentGenerator()); + assertEquals(2L, upgraded.activeActivation().activationId()); + assertEquals(oldVersion, upgraded.resolveEpoch(0, 0).kernelVersion()); + try (GenerationHistory.GenerationStage generation = upgraded.openStage(1, 0)) { + assertEquals(newVersion, generation.epoch().kernelVersion()); + } + assertTrue(upgraded.terrainSignatures(2L).size() > 0); + assertArrayEquals(savedBlocks, Files.readAllBytes(region)); + GenerationHistory reopened = GenerationHistory.open(world, secondBuild); + assertTrue(reopened.usesCurrentGenerator()); + assertEquals(2L, reopened.activeActivation().activationId()); + } + + @Test + public void openFailsClosedWhenAnOwnershipShardDisappears() throws Exception { + Path world = temporaryFolder.newFolder("missing-ownership-world").toPath(); + Path packA = createPack("missing-ownership-pack-a", "alpha"); + Path packB = createPack("missing-ownership-pack-b", "beta"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{1, 2}}); + stage(history, packB); + history.promotePending(signaturesForChunks(new int[][]{{1, 2}})); + Files.delete(history.paths().ownershipRoot().resolve(RegionGenerationOwnership.fileName(0, 0))); + + assertThrows(IOException.class, () -> GenerationHistory.open(world)); + } + + @Test + public void pendingCutoverResumesAfterPartialOutgoingOwnershipPublication() throws Exception { + Path world = temporaryFolder.newFolder("partial-cutover-world").toPath(); + Path packA = createPack("partial-cutover-pack-a", "alpha"); + Path packB = createPack("partial-cutover-pack-b", "beta"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + int[][] chunks = {{1, 2}, {3, 4}}; + writeRegion(region, chunks); + stage(history, packB); + + ChunkGenerationOwnership partial = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); + assertTrue(partial.assign(1, 2, 1L)); + partial.persist(); + + GenerationHistory recovered = GenerationHistory.open(world); + assertEquals(1, recovered.explicitChunkCount()); + assertEquals(2L, recovered.promotePending(signaturesForChunks(chunks)).activationId()); + assertEquals(2, GenerationHistory.open(world).explicitChunkCount()); + } + + @Test + public void pendingCutoverStillRejectsMissingOlderOwnership() throws Exception { + Path world = temporaryFolder.newFolder("pending-missing-old-world").toPath(); + Path packA = createPack("pending-missing-old-pack-a", "alpha"); + Path packB = createPack("pending-missing-old-pack-b", "beta"); + Path packC = createPack("pending-missing-old-pack-c", "gamma"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{1, 2}}); + stage(history, packB); + history.promotePending(signaturesForChunks(new int[][]{{1, 2}})); + stage(history, packC); + Files.delete(history.paths().ownershipRoot().resolve(RegionGenerationOwnership.fileName(0, 0))); + + assertThrows(IOException.class, () -> GenerationHistory.open(world)); + } + + @Test + public void pendingCutoverDiscardsOutgoingOwnershipForUnstoredChunks() throws Exception { + Path world = temporaryFolder.newFolder("pending-forged-world").toPath(); + Path packA = createPack("pending-forged-pack-a", "alpha"); + Path packB = createPack("pending-forged-pack-b", "beta"); + GenerationHistory history = createHistory(world, packA); + stage(history, packB); + ChunkGenerationOwnership forged = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); + assertTrue(forged.assign(9, 9, 1L)); + forged.persist(); + + GenerationHistory recovered = GenerationHistory.open(world); + assertEquals(1, recovered.explicitChunkCount()); + recovered.promotePending(List.of()); + assertEquals(0, recovered.explicitChunkCount()); + assertEquals(2L, recovered.resolveActivation(9, 9).activationId()); + assertEquals(0, GenerationHistory.open(world).explicitChunkCount()); + } + + @Test + public void sealedGenerationClaimWithoutStoredTerrainIsDiscardedAfterCrash() throws Exception { + Path world = temporaryFolder.newFolder("semantic-claim-cutover-world").toPath(); + Path packA = createPack("semantic-claim-cutover-pack-a", "alpha"); + Path packB = createPack("semantic-claim-cutover-pack-b", "beta"); + GenerationHistory history = createHistory(world, packA); + GenerationHistory.GenerationStage generation = history.openStage(9, 9); + ChunkGenerationSemantics claim = ChunkGenerationSemantics.builder(9, 9, 1L) + .addSurfaceBiome("iris:forest") + .seal() + .build(); + + assertTrue(history.claimGeneratedSemantics(generation, claim)); + assertFalse(history.claimGeneratedSemantics(generation, claim)); + generation.close(); + assertThrows(IllegalStateException.class, () -> history.claimGeneratedSemantics(generation, claim)); + assertFalse(Files.exists(world.resolve("region"))); + stage(history, packB); + + Path recoveredWorld = temporaryFolder.newFolder("restored-semantic-claim-world").toPath(); + try (Stream entries = Files.walk(world)) { + for (Path source : entries.toList()) { + Path target = recoveredWorld.resolve(world.relativize(source)); + if (Files.isDirectory(source)) { + Files.createDirectories(target); + } else { + Files.copy(source, target); + } + } + } + GenerationHistory recovered = GenerationHistory.open(recoveredWorld); + recovered.promotePending(List.of()); + + assertEquals(2L, recovered.resolveActivation(9, 9).activationId()); + assertEquals(2L, recovered.resolveActivation(10, 9).activationId()); + assertEquals(0, recovered.explicitChunkCount()); + GenerationHistory reopened = GenerationHistory.open(recoveredWorld); + assertTrue(reopened.semantics(9, 9).isEmpty()); + assertEquals(2L, reopened.resolveActivation(9, 9).activationId()); + try (GenerationHistory.GenerationStage replacement = reopened.openStage(9, 9)) { + assertTrue(reopened.claimGeneratedSemantics(replacement, + ChunkGenerationSemantics.builder(9, 9, 2L).addObject("replacement").seal().build())); + } + } + + @Test + public void coldRecoveryUsesNativeNoiseStatusAsTheMinimumStoredTerrain() throws Exception { + Path world = temporaryFolder.newFolder("native-status-recovery-world").toPath(); + createHistory(world, createPack("native-status-recovery-pack", "alpha")); + Path regions = Files.createDirectories(world.resolve("region")); + SavedTerrainTestRegion.write(regions.resolve("r.0.0.mca"), new int[][]{{0, 0}}, "minecraft:noise"); + SavedTerrainTestRegion.write(regions.resolve("r.1.0.mca"), new int[][]{{32, 0}}, "minecraft:biomes"); + GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); + index.claimAndPersist(ChunkGenerationSemantics.builder(0, 0, 1L).addObject("saved-noise").seal().build()); + index.claimAndPersist(ChunkGenerationSemantics.builder(32, 0, 1L).addObject("unsaved-terrain").seal().build()); + + GenerationHistory recovered = GenerationHistory.open(world); + recovered.prepareCurrentGenerator(64); + + assertTrue(recovered.semantics(0, 0).isPresent()); + assertTrue(recovered.semantics(32, 0).isEmpty()); + assertEquals("minecraft:biomes", SavedTerrainChunk.readStatus(world, 32, 0)); + assertEquals(0, recovered.explicitChunkCount()); + GenerationHistory reopened = GenerationHistory.open(world); + assertTrue(reopened.semantics(0, 0).isPresent()); + assertTrue(reopened.semantics(32, 0).isEmpty()); + } + + @Test + public void coldRecoveryKeepsStoredClaimsHistoricalMetadataAndFrozenPacks() throws Exception { + Path world = temporaryFolder.newFolder("cold-recovery-world").toPath(); + Path packA = createPack("cold-recovery-a", "alpha"); + Path packB = createPack("cold-recovery-b", "beta"); + GenerationHistory initial = createHistory(world, packA); + String oldEpoch = initial.activeEpoch().epochId(); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{0, 0}}); + GenerationSemanticIndex initialIndex = GenerationSemanticIndex.loadRequired(world); + initialIndex.claimAndPersist(ChunkGenerationSemantics.builder(0, 0, 1L).addObject("historical").seal().build()); + GenerationHistory first = GenerationHistory.open(world); + stage(first, packB); + first.promotePending(signaturesForChunks(new int[][]{{0, 0}})); + GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); + index.claimAndPersist(ChunkGenerationSemantics.builder(1, 0, 2L).addObject("saved").seal().build()); + index.claimAndPersist(ChunkGenerationSemantics.builder(2, 0, 2L).addObject("orphan").seal().build()); + writeRegion(region, new int[][]{{1, 0}}); + + GenerationHistory recovered = GenerationHistory.open(world); + recovered.prepareCurrentGenerator(64); + + assertEquals(2L, recovered.activeActivation().activationId()); + assertEquals(1, recovered.explicitChunkCount()); + assertTrue(recovered.semantics(0, 0).isPresent()); + assertTrue(recovered.semantics(1, 0).isPresent()); + assertTrue(recovered.semantics(2, 0).isEmpty()); + assertTrue(Files.isDirectory(recovered.paths().packRoot(oldEpoch))); + assertEquals(GenerationPackFingerprint.compute(packA, GenerationPackFingerprint.CURRENT_VERSION), + GenerationPackFingerprint.compute(recovered.paths().packRoot(oldEpoch), GenerationPackFingerprint.CURRENT_VERSION)); + assertTrue(Files.isDirectory(recovered.activePackRoot())); + assertTrue(Files.isDirectory(packA)); + GenerationHistory reopened = GenerationHistory.open(world); + assertEquals(1L, reopened.resolveActivation(0, 0).activationId()); + assertTrue(reopened.semantics(2, 0).isEmpty()); + } + + @Test + public void openFailsClosedOnSemanticActivationMismatch() throws Exception { + Path world = temporaryFolder.newFolder("semantic-mismatch-world").toPath(); + Path packA = createPack("semantic-mismatch-pack-a", "alpha"); + Path packB = createPack("semantic-mismatch-pack-b", "beta"); + GenerationHistory history = createHistory(world, packA); + stage(history, packB); + history.promotePending(List.of()); + GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); + index.recordAndPersist(ChunkGenerationSemantics.builder(7, 8, 1L) + .addSurfaceBiome("iris:old") + .seal() + .build()); + + assertThrows(IOException.class, () -> GenerationHistory.open(world)); + } + + @Test + public void openFailsClosedOnDeletedOrCorruptTransitionSnapshots() throws Exception { + Path deletedWorld = temporaryFolder.newFolder("deleted-snapshot-world").toPath(); + Path deletedPackA = createPack("deleted-snapshot-pack-a", "alpha"); + Path deletedPackB = createPack("deleted-snapshot-pack-b", "beta"); + GenerationHistory deletedHistory = createHistory(deletedWorld, deletedPackA); + stage(deletedHistory, deletedPackB); + deletedHistory.promotePending(List.of()); + Files.delete(new TerrainBoundarySignatureStore(deletedWorld).snapshotPath(2L)); + + assertThrows(IOException.class, () -> GenerationHistory.open(deletedWorld)); + + Path corruptWorld = temporaryFolder.newFolder("corrupt-snapshot-world").toPath(); + Path corruptPackA = createPack("corrupt-snapshot-pack-a", "alpha"); + Path corruptPackB = createPack("corrupt-snapshot-pack-b", "beta"); + GenerationHistory corruptHistory = createHistory(corruptWorld, corruptPackA); + stage(corruptHistory, corruptPackB); + corruptHistory.promotePending(List.of()); + Files.write(new GenerationBoundaryStore(corruptWorld).snapshotPath(2L), new byte[]{1, 2, 3}); + + assertThrows(IOException.class, () -> GenerationHistory.open(corruptWorld)); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java index 93e4e3e4b..56b43f93c 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java @@ -9,10 +9,12 @@ import art.arcane.iris.engine.object.IrisBiome; import art.arcane.iris.engine.object.IrisRegion; import art.arcane.iris.engine.framework.GenerationSessionManager; import art.arcane.iris.engine.mantle.EngineMantle; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.iris.util.common.data.B; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.matter.Matter; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.BeforeClass; import org.junit.Test; @@ -57,6 +59,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public final class GenerationHistoryRuntimeRouterTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public final TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryStoreTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryStoreTest.java index 98f0286d3..47a5a0673 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryStoreTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryStoreTest.java @@ -1,8 +1,10 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.DurabilityMode; import com.google.gson.JsonObject; import com.google.gson.JsonParser; import org.junit.Assume; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -31,6 +33,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class GenerationHistoryStoreTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final String PACK_A = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; private static final String PACK_B = "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"; private static final Clock CLOCK = Clock.fixed(Instant.ofEpochMilli(123456789L), ZoneOffset.UTC); diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistorySupport.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistorySupport.java new file mode 100644 index 000000000..56bfa8d2a --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistorySupport.java @@ -0,0 +1,145 @@ +package art.arcane.iris.engine.history; + +import art.arcane.iris.testsupport.DurabilityMode; +import org.junit.ClassRule; +import org.junit.Rule; +import org.junit.rules.TemporaryFolder; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.NoSuchFileException; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.OptionalInt; +import java.util.Set; +import java.util.stream.Stream; + +public abstract class GenerationHistorySupport { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + + @Rule + public final TemporaryFolder temporaryFolder = new TemporaryFolder(); + + static GenerationKernelRegistry singleKernel(GenerationKernelRegistry.Version version, String fingerprint) { + return new GenerationKernelRegistry(version, List.of(new GenerationKernelRegistry.Kernel( + version.generatorAbi(), fingerprint.repeat(64), + Map.of(new GenerationKernelRegistry.AlgorithmVersion(version.rngVersion(), version.seedDerivationVersion()), + (engine, transition) -> { + throw new AssertionError("Saved terrain capture invoked a generator factory"); + })))); + } + void initializeRawHistory( + Path world, + Path pack, + int generatorAbi, + int rngVersion + ) throws IOException { + String fingerprint = fingerprint(pack); + GenerationEpoch epoch = GenerationEpoch.create(new GenerationEpoch.Spec( + fingerprint, + GenerationPackFingerprint.CURRENT_VERSION, + 42L, + GenerationEpoch.CURRENT_SEED_DERIVATION_VERSION, + generatorAbi, + rngVersion, + GenerationKernelV1.IMPLEMENTATION_FINGERPRINT, + contract(), + GenerationRegistryContract.empty() + )); + GenerationPackRepository repository = new GenerationPackRepository(world); + repository.publish( + epoch.epochId(), + fingerprint, + GenerationPackFingerprint.CURRENT_VERSION, + pack + ); + GenerationSemanticIndex.initialize(world); + GenerationHistoryStore.initialize(repository.generationRoot(), epoch); + } + Path createPack(String name, String content) throws IOException { + Path pack = temporaryFolder.newFolder(name).toPath(); + Files.createDirectories(pack.resolve("dimensions")); + Files.writeString(pack.resolve("dimensions/main.json"), content); + return pack; + } + static String fingerprint(Path pack) throws IOException { + return GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION); + } + static GenerationEpoch.DimensionContract upperContract(String packFingerprint) { + GenerationEpoch.DimensionContract base = contract(); + return new GenerationEpoch.DimensionContract( + base.dimensionKey(), base.dimensionTypeKey(), base.environment(), base.generationMode(), + base.internalFluidHeight(), base.minHeight(), base.height(), base.logicalHeight(), + base.coordinateScale(), true, "ceiling", 32, packFingerprint, + base.dimensionTypeFingerprintSchema(), base.dimensionTypeFingerprint()); + } + static GenerationEpoch.DimensionContract contract() { + return new GenerationEpoch.DimensionContract( + "overworld", + "iris:overworld_type", + "NORMAL", + "OVERWORLD", + 127, + -64, + 384, + 384, + 1D, + false, + "none", + 0, + "0".repeat(64), + GenerationEpochContractFactory.CURRENT_DIMENSION_TYPE_FINGERPRINT_SCHEMA, + "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" + ); + } + static GenerationHistory createHistory(Path world, Path pack) throws IOException { + return GenerationHistory.create( + world, + pack, + fingerprint(pack), + 42L, + contract(), + GenerationRegistryContract.empty() + ); + } + static GenerationActivation stage(GenerationHistory history, Path pack) throws IOException { + return history.stageUpdate( + pack, + fingerprint(pack), + contract(), + GenerationRegistryContract.empty(), + 256 + ); + } + static List signaturesForChunks(int[][] chunks) { + ArrayList coordinates = new ArrayList<>(chunks.length); + for (int[] chunk : chunks) { + coordinates.add(new GenerationBoundary.ChunkCoordinate(chunk[0], chunk[1])); + } + GenerationBoundary boundary = GenerationBoundary.freeze("test-boundary", coordinates); + ArrayList signatures = new ArrayList<>(boundary.exposedBlockColumns().size()); + for (GenerationBoundary.BlockColumn column : boundary.exposedBlockColumns()) { + signatures.add(signature(column.blockX(), column.blockZ())); + } + return List.copyOf(signatures); + } + static TerrainBoundarySignature signature(int blockX, int blockZ) { + return new TerrainBoundarySignature( + new TerrainBoundarySignature.Column(blockX, blockZ, 64, 63, OptionalInt.empty(), OptionalInt.empty()), + new TerrainBoundarySignature.Samples( + new TerrainBoundarySignature.VerticalLayout(-64, 64, 2), + new TerrainBoundarySignature.BiomeEncoding( + List.of("iris:test"), + new short[]{0, 0} + ) + ) + , BoundaryColumnGeometry.empty()); + } + static void writeRegion(Path file, int[][] chunks) throws IOException { + SavedTerrainTestRegion.write(file, chunks); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryTest.java index c39aec7aa..6e70d4723 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryTest.java @@ -1,31 +1,17 @@ package art.arcane.iris.engine.history; -import org.junit.Rule; -import org.junit.Test; -import org.junit.rules.TemporaryFolder; - import java.io.IOException; import java.nio.file.Files; -import java.nio.file.NoSuchFileException; import java.nio.file.Path; -import java.util.ArrayList; import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.OptionalInt; -import java.util.Set; -import java.util.stream.Stream; +import org.junit.Test; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertArrayEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; -public final class GenerationHistoryTest { - @Rule - public final TemporaryFolder temporaryFolder = new TemporaryFolder(); - +public class GenerationHistoryTest extends GenerationHistorySupport { @Test public void upperContentUpdatesPreserveLayoutAndDistinctActivationsAcrossRestarts() throws Exception { Path world = temporaryFolder.newFolder("upper-update-world").toPath(); @@ -235,159 +221,6 @@ public final class GenerationHistoryTest { ); } - @Test - public void legacyAdoptionIsDurableExplicitAndIdempotent() throws Exception { - Path world = temporaryFolder.newFolder("legacy-world").toPath(); - Path legacy = Files.createDirectories(world.resolve("iris/pack/dimensions")); - Files.writeString(legacy.resolve("main.json"), "legacy"); - Path legacyRoot = world.resolve("iris/pack"); - Path legacyMantle = Files.createDirectories(world.resolve("mantle-hydrology")); - Files.writeString(legacyMantle.resolve("r.0.0.lz4b"), "mantle"); - String fingerprint = fingerprint(legacyRoot); - - GenerationHistory adopted = GenerationHistory.adoptLegacyPack( - world, - fingerprint, - 42L, - contract(), - GenerationRegistryContract.empty() - ); - - assertFalse(Files.exists(legacyRoot)); - assertFalse(Files.exists(legacyMantle)); - assertTrue(Files.isDirectory(adopted.activePackRoot())); - Path activationMantle = adopted.paths().activationMantleRoot(1L); - assertEquals("mantle", Files.readString(activationMantle.resolve("r.0.0.lz4b"))); - assertEquals(1L, adopted.activeActivation().activationId()); - GenerationHistory repeated = GenerationHistory.adoptLegacyPack( - world, - fingerprint, - 42L, - contract(), - GenerationRegistryContract.empty() - ); - assertEquals(adopted.activeEpoch(), repeated.activeEpoch()); - assertEquals("mantle", Files.readString(repeated.paths().activationMantleRoot(1L) - .resolve("r.0.0.lz4b"))); - } - - @Test - public void legacyMantleAdoptionFailsClosedOnDualRoots() throws Exception { - Path world = temporaryFolder.newFolder("legacy-dual-mantle-world").toPath(); - Path legacyPack = Files.createDirectories(world.resolve("iris/pack/dimensions")).getParent(); - Files.writeString(legacyPack.resolve("dimensions/main.json"), "legacy"); - Path legacyMantle = Files.createDirectories(world.resolve("mantle-hydrology")); - Files.writeString(legacyMantle.resolve("legacy.bin"), "legacy"); - GenerationHistoryPaths paths = GenerationHistoryPaths.forDimension(world); - Path activationMantle = Files.createDirectories(paths.activationMantleRoot(1L)); - Files.writeString(activationMantle.resolve("activation.bin"), "activation"); - - IOException failure = assertThrows( - IOException.class, - () -> GenerationHistory.adoptLegacyPack( - world, - fingerprint(legacyPack), - 42L, - contract(), - GenerationRegistryContract.empty() - ) - ); - - assertTrue(failure.getMessage().contains("mantle roots conflict")); - assertEquals("legacy", Files.readString(legacyMantle.resolve("legacy.bin"))); - assertEquals("activation", Files.readString(activationMantle.resolve("activation.bin"))); - } - - @Test - public void legacyMantleAdoptionRejectsRootAliases() throws Exception { - Path world = temporaryFolder.newFolder("legacy-aliased-mantle-world").toPath(); - Path legacyPack = Files.createDirectories(world.resolve("iris/pack/dimensions")).getParent(); - Files.writeString(legacyPack.resolve("dimensions/main.json"), "legacy"); - GenerationHistoryPaths paths = GenerationHistoryPaths.forDimension(world); - Path activationMantle = Files.createDirectories(paths.activationMantleRoot(1L)); - Path alias = paths.legacyMantleRoot(); - try { - Files.createSymbolicLink(alias, activationMantle); - } catch (UnsupportedOperationException exception) { - return; - } - - assertThrows( - IOException.class, - () -> GenerationHistory.adoptLegacyPack( - world, - fingerprint(legacyPack), - 42L, - contract(), - GenerationRegistryContract.empty() - ) - ); - assertTrue(Files.isSymbolicLink(alias)); - assertTrue(Files.isDirectory(activationMantle)); - } - - @Test - public void legacyAdoptionNeverDeletesMismatchedOrUnsafeInput() throws Exception { - Path mismatchWorld = temporaryFolder.newFolder("legacy-mismatch-world").toPath(); - Path mismatchRoot = Files.createDirectories(mismatchWorld.resolve("iris/pack/dimensions")).getParent(); - Files.writeString(mismatchRoot.resolve("dimensions/main.json"), "legacy"); - - assertThrows( - IOException.class, - () -> GenerationHistory.adoptLegacyPack( - mismatchWorld, - "f".repeat(64), - 42L, - contract(), - GenerationRegistryContract.empty() - ) - ); - assertTrue(Files.isDirectory(mismatchRoot)); - assertFalse(Files.exists(GenerationHistoryPaths.forDimension(mismatchWorld).manifest())); - - Path linkedWorld = temporaryFolder.newFolder("legacy-linked-world").toPath(); - Files.createDirectories(linkedWorld.resolve("iris")); - Path outside = temporaryFolder.newFolder("legacy-outside").toPath(); - Path link = linkedWorld.resolve("iris/pack"); - try { - Files.createSymbolicLink(link, outside); - } catch (UnsupportedOperationException exception) { - return; - } - assertThrows( - IOException.class, - () -> GenerationHistory.adoptLegacyPack( - linkedWorld, - "f".repeat(64), - 42L, - contract(), - GenerationRegistryContract.empty() - ) - ); - assertTrue(Files.isDirectory(outside)); - assertTrue(Files.isSymbolicLink(link)); - } - - @Test - public void openFailsClosedOnDanglingOwnershipAndPartialHistory() throws Exception { - Path danglingWorld = temporaryFolder.newFolder("dangling-world").toPath(); - Path pack = createPack("dangling-pack", "alpha"); - GenerationHistory history = createHistory(danglingWorld, pack); - ChunkGenerationOwnership ownership = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); - ownership.assign(1, 2, 99L); - ownership.persist(); - - assertThrows(IOException.class, () -> GenerationHistory.open(danglingWorld)); - - Path absentWorld = temporaryFolder.newFolder("absent-world").toPath(); - Optional absent = GenerationHistory.openIfPresent(absentWorld); - assertTrue(absent.isEmpty()); - - Path partialWorld = temporaryFolder.newFolder("partial-world").toPath(); - Files.createDirectories(GenerationHistoryPaths.forDimension(partialWorld).generationRoot()); - assertThrows(NoSuchFileException.class, () -> GenerationHistory.openIfPresent(partialWorld)); - } - @Test public void stagingTheActiveEpochIsANoOp() throws Exception { Path world = temporaryFolder.newFolder("same-epoch-world").toPath(); @@ -420,104 +253,6 @@ public final class GenerationHistoryTest { assertEquals(3, history.manifest().activations().size()); } - @Test - public void savedHistoryOpensWithoutRetainingItsExecutableKernel() throws Exception { - Path world = temporaryFolder.newFolder("retained-abi-world").toPath(); - Path packA = createPack("retained-abi-pack-a", "alpha"); - Path packB = createPack("retained-abi-pack-b", "beta"); - GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); - GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); - GenerationKernelRegistry kernels = new GenerationKernelRegistry( - versionTwo, - List.of( - new GenerationKernelRegistry.Kernel( - 1, - "1".repeat(64), - Map.of( - new GenerationKernelRegistry.AlgorithmVersion(1, 1), - (engine, transitionPlan) -> { - throw new AssertionError("History-only kernel factory was invoked."); - } - ) - ), - new GenerationKernelRegistry.Kernel( - 2, - "2".repeat(64), - Map.of( - new GenerationKernelRegistry.AlgorithmVersion(1, 1), - (engine, transitionPlan) -> { - throw new AssertionError("History-only kernel factory was invoked."); - } - ) - ) - ) - ); - GenerationHistory history = GenerationHistory.create( - world, - packA, - fingerprint(packA), - 42L, - contract(), - GenerationRegistryContract.empty(), - versionOne, - kernels - ); - - history.stageUpdate( - packB, - fingerprint(packB), - contract(), - GenerationRegistryContract.empty(), - 256, - versionTwo - ); - history.promotePending(List.of()); - - assertEquals(2, GenerationHistory.open(world).activeEpoch().generatorAbi()); - GenerationHistory reopened = GenerationHistory.open(world, kernels); - assertEquals(2, reopened.activeEpoch().generatorAbi()); - assertEquals(1, reopened.manifest().activation(1L).orElseThrow().activationId()); - } - - @Test - public void changedBuildExpandsFromSavedTerrainWithoutTheOldFactory() throws Exception { - Path world = temporaryFolder.newFolder("build-upgrade-world").toPath(); - Path pack = createPack("build-upgrade-pack", "alpha"); - GenerationKernelRegistry.Version oldVersion = new GenerationKernelRegistry.Version(101, 1, 1); - GenerationKernelRegistry.Version newVersion = new GenerationKernelRegistry.Version(102, 1, 1); - GenerationKernelRegistry firstBuild = singleKernel(oldVersion, "a"); - GenerationKernelRegistry secondBuild = singleKernel(newVersion, "b"); - GenerationHistory.create(world, pack, fingerprint(pack), 42L, - contract(), GenerationRegistryContract.empty(), oldVersion, firstBuild); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - SavedTerrainTestRegion.write(region, new int[][]{{0, 0}}); - byte[] savedBlocks = Files.readAllBytes(region); - - GenerationHistory upgraded = GenerationHistory.open(world, secondBuild); - assertFalse(upgraded.usesCurrentGenerator()); - upgraded.prepareCurrentGenerator(32); - assertTrue(upgraded.usesCurrentGenerator()); - assertEquals(2L, upgraded.activeActivation().activationId()); - assertEquals(oldVersion, upgraded.resolveEpoch(0, 0).kernelVersion()); - try (GenerationHistory.GenerationStage generation = upgraded.openStage(1, 0)) { - assertEquals(newVersion, generation.epoch().kernelVersion()); - } - assertTrue(upgraded.terrainSignatures(2L).size() > 0); - assertArrayEquals(savedBlocks, Files.readAllBytes(region)); - GenerationHistory reopened = GenerationHistory.open(world, secondBuild); - assertTrue(reopened.usesCurrentGenerator()); - assertEquals(2L, reopened.activeActivation().activationId()); - } - - private static GenerationKernelRegistry singleKernel(GenerationKernelRegistry.Version version, String fingerprint) { - return new GenerationKernelRegistry(version, List.of(new GenerationKernelRegistry.Kernel( - version.generatorAbi(), fingerprint.repeat(64), - Map.of(new GenerationKernelRegistry.AlgorithmVersion(version.rngVersion(), version.seedDerivationVersion()), - (engine, transition) -> { - throw new AssertionError("Saved terrain capture invoked a generator factory"); - })))); - } - @Test public void openRejectsWorldSeedMismatch() throws Exception { Path world = temporaryFolder.newFolder("seed-world").toPath(); @@ -528,200 +263,6 @@ public final class GenerationHistoryTest { assertEquals(42L, GenerationHistory.open(world, 42L).activeEpoch().worldSeed()); } - @Test - public void openFailsClosedWhenAnOwnershipShardDisappears() throws Exception { - Path world = temporaryFolder.newFolder("missing-ownership-world").toPath(); - Path packA = createPack("missing-ownership-pack-a", "alpha"); - Path packB = createPack("missing-ownership-pack-b", "beta"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{1, 2}}); - stage(history, packB); - history.promotePending(signaturesForChunks(new int[][]{{1, 2}})); - Files.delete(history.paths().ownershipRoot().resolve(RegionGenerationOwnership.fileName(0, 0))); - - assertThrows(IOException.class, () -> GenerationHistory.open(world)); - } - - @Test - public void pendingCutoverResumesAfterPartialOutgoingOwnershipPublication() throws Exception { - Path world = temporaryFolder.newFolder("partial-cutover-world").toPath(); - Path packA = createPack("partial-cutover-pack-a", "alpha"); - Path packB = createPack("partial-cutover-pack-b", "beta"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - int[][] chunks = {{1, 2}, {3, 4}}; - writeRegion(region, chunks); - stage(history, packB); - - ChunkGenerationOwnership partial = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); - assertTrue(partial.assign(1, 2, 1L)); - partial.persist(); - - GenerationHistory recovered = GenerationHistory.open(world); - assertEquals(1, recovered.explicitChunkCount()); - assertEquals(2L, recovered.promotePending(signaturesForChunks(chunks)).activationId()); - assertEquals(2, GenerationHistory.open(world).explicitChunkCount()); - } - - @Test - public void pendingCutoverStillRejectsMissingOlderOwnership() throws Exception { - Path world = temporaryFolder.newFolder("pending-missing-old-world").toPath(); - Path packA = createPack("pending-missing-old-pack-a", "alpha"); - Path packB = createPack("pending-missing-old-pack-b", "beta"); - Path packC = createPack("pending-missing-old-pack-c", "gamma"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{1, 2}}); - stage(history, packB); - history.promotePending(signaturesForChunks(new int[][]{{1, 2}})); - stage(history, packC); - Files.delete(history.paths().ownershipRoot().resolve(RegionGenerationOwnership.fileName(0, 0))); - - assertThrows(IOException.class, () -> GenerationHistory.open(world)); - } - - @Test - public void pendingCutoverDiscardsOutgoingOwnershipForUnstoredChunks() throws Exception { - Path world = temporaryFolder.newFolder("pending-forged-world").toPath(); - Path packA = createPack("pending-forged-pack-a", "alpha"); - Path packB = createPack("pending-forged-pack-b", "beta"); - GenerationHistory history = createHistory(world, packA); - stage(history, packB); - ChunkGenerationOwnership forged = ChunkGenerationOwnership.load(history.paths().ownershipRoot()); - assertTrue(forged.assign(9, 9, 1L)); - forged.persist(); - - GenerationHistory recovered = GenerationHistory.open(world); - assertEquals(1, recovered.explicitChunkCount()); - recovered.promotePending(List.of()); - assertEquals(0, recovered.explicitChunkCount()); - assertEquals(2L, recovered.resolveActivation(9, 9).activationId()); - assertEquals(0, GenerationHistory.open(world).explicitChunkCount()); - } - - @Test - public void sealedGenerationClaimWithoutStoredTerrainIsDiscardedAfterCrash() throws Exception { - Path world = temporaryFolder.newFolder("semantic-claim-cutover-world").toPath(); - Path packA = createPack("semantic-claim-cutover-pack-a", "alpha"); - Path packB = createPack("semantic-claim-cutover-pack-b", "beta"); - GenerationHistory history = createHistory(world, packA); - GenerationHistory.GenerationStage generation = history.openStage(9, 9); - ChunkGenerationSemantics claim = ChunkGenerationSemantics.builder(9, 9, 1L) - .addSurfaceBiome("iris:forest") - .seal() - .build(); - - assertTrue(history.claimGeneratedSemantics(generation, claim)); - assertFalse(history.claimGeneratedSemantics(generation, claim)); - generation.close(); - assertThrows(IllegalStateException.class, () -> history.claimGeneratedSemantics(generation, claim)); - assertFalse(Files.exists(world.resolve("region"))); - stage(history, packB); - - Path recoveredWorld = temporaryFolder.newFolder("restored-semantic-claim-world").toPath(); - try (Stream entries = Files.walk(world)) { - for (Path source : entries.toList()) { - Path target = recoveredWorld.resolve(world.relativize(source)); - if (Files.isDirectory(source)) { - Files.createDirectories(target); - } else { - Files.copy(source, target); - } - } - } - GenerationHistory recovered = GenerationHistory.open(recoveredWorld); - recovered.promotePending(List.of()); - - assertEquals(2L, recovered.resolveActivation(9, 9).activationId()); - assertEquals(2L, recovered.resolveActivation(10, 9).activationId()); - assertEquals(0, recovered.explicitChunkCount()); - GenerationHistory reopened = GenerationHistory.open(recoveredWorld); - assertTrue(reopened.semantics(9, 9).isEmpty()); - assertEquals(2L, reopened.resolveActivation(9, 9).activationId()); - try (GenerationHistory.GenerationStage replacement = reopened.openStage(9, 9)) { - assertTrue(reopened.claimGeneratedSemantics(replacement, - ChunkGenerationSemantics.builder(9, 9, 2L).addObject("replacement").seal().build())); - } - } - - @Test - public void coldRecoveryUsesNativeNoiseStatusAsTheMinimumStoredTerrain() throws Exception { - Path world = temporaryFolder.newFolder("native-status-recovery-world").toPath(); - createHistory(world, createPack("native-status-recovery-pack", "alpha")); - Path regions = Files.createDirectories(world.resolve("region")); - SavedTerrainTestRegion.write(regions.resolve("r.0.0.mca"), new int[][]{{0, 0}}, "minecraft:noise"); - SavedTerrainTestRegion.write(regions.resolve("r.1.0.mca"), new int[][]{{32, 0}}, "minecraft:biomes"); - GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); - index.claimAndPersist(ChunkGenerationSemantics.builder(0, 0, 1L).addObject("saved-noise").seal().build()); - index.claimAndPersist(ChunkGenerationSemantics.builder(32, 0, 1L).addObject("unsaved-terrain").seal().build()); - - GenerationHistory recovered = GenerationHistory.open(world); - recovered.prepareCurrentGenerator(64); - - assertTrue(recovered.semantics(0, 0).isPresent()); - assertTrue(recovered.semantics(32, 0).isEmpty()); - assertEquals("minecraft:biomes", SavedTerrainChunk.readStatus(world, 32, 0)); - assertEquals(0, recovered.explicitChunkCount()); - GenerationHistory reopened = GenerationHistory.open(world); - assertTrue(reopened.semantics(0, 0).isPresent()); - assertTrue(reopened.semantics(32, 0).isEmpty()); - } - - @Test - public void coldRecoveryKeepsStoredClaimsHistoricalMetadataAndFrozenPacks() throws Exception { - Path world = temporaryFolder.newFolder("cold-recovery-world").toPath(); - Path packA = createPack("cold-recovery-a", "alpha"); - Path packB = createPack("cold-recovery-b", "beta"); - GenerationHistory initial = createHistory(world, packA); - String oldEpoch = initial.activeEpoch().epochId(); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{0, 0}}); - GenerationSemanticIndex initialIndex = GenerationSemanticIndex.loadRequired(world); - initialIndex.claimAndPersist(ChunkGenerationSemantics.builder(0, 0, 1L).addObject("historical").seal().build()); - GenerationHistory first = GenerationHistory.open(world); - stage(first, packB); - first.promotePending(signaturesForChunks(new int[][]{{0, 0}})); - GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); - index.claimAndPersist(ChunkGenerationSemantics.builder(1, 0, 2L).addObject("saved").seal().build()); - index.claimAndPersist(ChunkGenerationSemantics.builder(2, 0, 2L).addObject("orphan").seal().build()); - writeRegion(region, new int[][]{{1, 0}}); - - GenerationHistory recovered = GenerationHistory.open(world); - recovered.prepareCurrentGenerator(64); - - assertEquals(2L, recovered.activeActivation().activationId()); - assertEquals(1, recovered.explicitChunkCount()); - assertTrue(recovered.semantics(0, 0).isPresent()); - assertTrue(recovered.semantics(1, 0).isPresent()); - assertTrue(recovered.semantics(2, 0).isEmpty()); - assertTrue(Files.isDirectory(recovered.paths().packRoot(oldEpoch))); - assertEquals(GenerationPackFingerprint.compute(packA, GenerationPackFingerprint.CURRENT_VERSION), - GenerationPackFingerprint.compute(recovered.paths().packRoot(oldEpoch), GenerationPackFingerprint.CURRENT_VERSION)); - assertTrue(Files.isDirectory(recovered.activePackRoot())); - assertTrue(Files.isDirectory(packA)); - GenerationHistory reopened = GenerationHistory.open(world); - assertEquals(1L, reopened.resolveActivation(0, 0).activationId()); - assertTrue(reopened.semantics(2, 0).isEmpty()); - } - - @Test - public void openFailsClosedOnSemanticActivationMismatch() throws Exception { - Path world = temporaryFolder.newFolder("semantic-mismatch-world").toPath(); - Path packA = createPack("semantic-mismatch-pack-a", "alpha"); - Path packB = createPack("semantic-mismatch-pack-b", "beta"); - GenerationHistory history = createHistory(world, packA); - stage(history, packB); - history.promotePending(List.of()); - GenerationSemanticIndex index = GenerationSemanticIndex.loadRequired(world); - index.recordAndPersist(ChunkGenerationSemantics.builder(7, 8, 1L) - .addSurfaceBiome("iris:old") - .seal() - .build()); - - assertThrows(IOException.class, () -> GenerationHistory.open(world)); - } - @Test public void promotionIsRejectedAfterGenerationAdmissionOpens() throws Exception { Path world = temporaryFolder.newFolder("admission-world").toPath(); @@ -739,147 +280,4 @@ public final class GenerationHistoryTest { generationStage.close(); assertThrows(IllegalStateException.class, () -> history.promotePending(List.of())); } - - @Test - public void openFailsClosedOnDeletedOrCorruptTransitionSnapshots() throws Exception { - Path deletedWorld = temporaryFolder.newFolder("deleted-snapshot-world").toPath(); - Path deletedPackA = createPack("deleted-snapshot-pack-a", "alpha"); - Path deletedPackB = createPack("deleted-snapshot-pack-b", "beta"); - GenerationHistory deletedHistory = createHistory(deletedWorld, deletedPackA); - stage(deletedHistory, deletedPackB); - deletedHistory.promotePending(List.of()); - Files.delete(new TerrainBoundarySignatureStore(deletedWorld).snapshotPath(2L)); - - assertThrows(IOException.class, () -> GenerationHistory.open(deletedWorld)); - - Path corruptWorld = temporaryFolder.newFolder("corrupt-snapshot-world").toPath(); - Path corruptPackA = createPack("corrupt-snapshot-pack-a", "alpha"); - Path corruptPackB = createPack("corrupt-snapshot-pack-b", "beta"); - GenerationHistory corruptHistory = createHistory(corruptWorld, corruptPackA); - stage(corruptHistory, corruptPackB); - corruptHistory.promotePending(List.of()); - Files.write(new GenerationBoundaryStore(corruptWorld).snapshotPath(2L), new byte[]{1, 2, 3}); - - assertThrows(IOException.class, () -> GenerationHistory.open(corruptWorld)); - } - - private void initializeRawHistory( - Path world, - Path pack, - int generatorAbi, - int rngVersion - ) throws IOException { - String fingerprint = fingerprint(pack); - GenerationEpoch epoch = GenerationEpoch.create(new GenerationEpoch.Spec( - fingerprint, - GenerationPackFingerprint.CURRENT_VERSION, - 42L, - GenerationEpoch.CURRENT_SEED_DERIVATION_VERSION, - generatorAbi, - rngVersion, - GenerationKernelV1.IMPLEMENTATION_FINGERPRINT, - contract(), - GenerationRegistryContract.empty() - )); - GenerationPackRepository repository = new GenerationPackRepository(world); - repository.publish( - epoch.epochId(), - fingerprint, - GenerationPackFingerprint.CURRENT_VERSION, - pack - ); - GenerationSemanticIndex.initialize(world); - GenerationHistoryStore.initialize(repository.generationRoot(), epoch); - } - - private Path createPack(String name, String content) throws IOException { - Path pack = temporaryFolder.newFolder(name).toPath(); - Files.createDirectories(pack.resolve("dimensions")); - Files.writeString(pack.resolve("dimensions/main.json"), content); - return pack; - } - - private static String fingerprint(Path pack) throws IOException { - return GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION); - } - - private static GenerationEpoch.DimensionContract upperContract(String packFingerprint) { - GenerationEpoch.DimensionContract base = contract(); - return new GenerationEpoch.DimensionContract( - base.dimensionKey(), base.dimensionTypeKey(), base.environment(), base.generationMode(), - base.internalFluidHeight(), base.minHeight(), base.height(), base.logicalHeight(), - base.coordinateScale(), true, "ceiling", 32, packFingerprint, - base.dimensionTypeFingerprintSchema(), base.dimensionTypeFingerprint()); - } - - private static GenerationEpoch.DimensionContract contract() { - return new GenerationEpoch.DimensionContract( - "overworld", - "iris:overworld_type", - "NORMAL", - "OVERWORLD", - 127, - -64, - 384, - 384, - 1D, - false, - "none", - 0, - "0".repeat(64), - GenerationEpochContractFactory.CURRENT_DIMENSION_TYPE_FINGERPRINT_SCHEMA, - "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc" - ); - } - - private static GenerationHistory createHistory(Path world, Path pack) throws IOException { - return GenerationHistory.create( - world, - pack, - fingerprint(pack), - 42L, - contract(), - GenerationRegistryContract.empty() - ); - } - - private static GenerationActivation stage(GenerationHistory history, Path pack) throws IOException { - return history.stageUpdate( - pack, - fingerprint(pack), - contract(), - GenerationRegistryContract.empty(), - 256 - ); - } - - private static List signaturesForChunks(int[][] chunks) { - ArrayList coordinates = new ArrayList<>(chunks.length); - for (int[] chunk : chunks) { - coordinates.add(new GenerationBoundary.ChunkCoordinate(chunk[0], chunk[1])); - } - GenerationBoundary boundary = GenerationBoundary.freeze("test-boundary", coordinates); - ArrayList signatures = new ArrayList<>(boundary.exposedBlockColumns().size()); - for (GenerationBoundary.BlockColumn column : boundary.exposedBlockColumns()) { - signatures.add(signature(column.blockX(), column.blockZ())); - } - return List.copyOf(signatures); - } - - private static TerrainBoundarySignature signature(int blockX, int blockZ) { - return new TerrainBoundarySignature( - new TerrainBoundarySignature.Column(blockX, blockZ, 64, 63, OptionalInt.empty(), OptionalInt.empty()), - new TerrainBoundarySignature.Samples( - new TerrainBoundarySignature.VerticalLayout(-64, 64, 2), - new TerrainBoundarySignature.BiomeEncoding( - List.of("iris:test"), - new short[]{0, 0} - ) - ) - , BoundaryColumnGeometry.empty()); - } - - private static void writeRegion(Path file, int[][] chunks) throws IOException { - SavedTerrainTestRegion.write(file, chunks); - } } diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationSemanticIndexTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationSemanticIndexTest.java index d7a8bea96..b78e1b66f 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationSemanticIndexTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationSemanticIndexTest.java @@ -1,7 +1,9 @@ package art.arcane.iris.engine.history; import art.arcane.iris.engine.hydrology.HydrologyFeatureType; +import art.arcane.iris.testsupport.DurabilityMode; import it.unimi.dsi.fastutil.longs.LongOpenHashSet; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -26,6 +28,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public final class GenerationSemanticIndexTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public final TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/history/TransitionGenerationPlanTest.java b/core/src/test/java/art/arcane/iris/engine/history/TransitionGenerationPlanTest.java index 17c98daaa..fbb04b251 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/TransitionGenerationPlanTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/TransitionGenerationPlanTest.java @@ -1,5 +1,7 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.DurabilityMode; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -20,6 +22,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public class TransitionGenerationPlanTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/history/WorldChunkInventoryTest.java b/core/src/test/java/art/arcane/iris/engine/history/WorldChunkInventoryTest.java index 7c396a761..1246cb52d 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/WorldChunkInventoryTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/WorldChunkInventoryTest.java @@ -1,6 +1,8 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.DurabilityMode; import art.arcane.iris.util.nbt.common.mca.MCAFile; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -22,6 +24,9 @@ import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; public final class WorldChunkInventoryTest { + @ClassRule + public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); + private static final int SECTOR_BYTES = 4_096; @Rule diff --git a/core/src/test/java/art/arcane/iris/engine/object/CompatFixtures.java b/core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java similarity index 100% rename from core/src/test/java/art/arcane/iris/engine/object/CompatFixtures.java rename to core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java b/core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java new file mode 100644 index 000000000..249f7a2b3 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java @@ -0,0 +1,41 @@ +package art.arcane.iris.testsupport; + +import art.arcane.iris.util.common.io.Durability; +import org.junit.rules.TestRule; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; + +public final class DurabilityMode implements TestRule { + private static final String RELAXED = "relaxed"; + + private final String mode; + + private DurabilityMode(String mode) { + this.mode = mode; + } + + public static DurabilityMode relaxed() { + return new DurabilityMode(RELAXED); + } + + @Override + public Statement apply(Statement base, Description description) { + return new Statement() { + @Override + public void evaluate() throws Throwable { + String previous = System.getProperty(Durability.MODE_PROPERTY); + System.setProperty(Durability.MODE_PROPERTY, mode); + + try { + base.evaluate(); + } finally { + if (previous == null) { + System.clearProperty(Durability.MODE_PROPERTY); + } else { + System.setProperty(Durability.MODE_PROPERTY, previous); + } + } + } + }; + } +} From 03c645b66fb839bc1afe855a0052f1b2eeff8327 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:37:08 -0400 Subject: [PATCH 03/35] Isolate platform binding - Add the PlatformBinding rule that binds a mock platform for a class or method, unbinds on teardown and restores the previous binding - Add the PlatformLeakGuard rule that fails a class when a platform is still bound or a service is still registered at class start or end - Add IrisRuntimeState so the guard reads the registered services without adding a test-only method to the SPI - Replace the inline mock-platform setup and teardown of twenty test classes with the rule - Guard the remaining sixty-four platform and service touching core test classes - Rename the pack-compat pool fixtures to PackCompatFixtures so the two CompatFixtures names cannot collide - Scope BukkitTestServer branding to a ServerBranding rule that restores the shared mock after each test --- .../IrisRuntimeSchedulerModeRoutingTest.java | 6 +- .../iris/core/gui/NoiseExplorerGUITest.java | 5 + .../PregeneratorJobShutdownDispatchTest.java | 5 + .../lifecycle/MissingWorldStorageLogTest.java | 5 + .../link/MultiverseGuardListenerTest.java | 5 + .../loader/IrisDataAuthoringCacheTest.java | 5 + .../IrisDataDatapackCompilerCacheTest.java | 5 + .../loader/IrisDataEngineRegistryTest.java | 5 + .../core/loader/IrisDataRetainedPackTest.java | 5 + .../loader/ResourceLoaderPrefetchTest.java | 5 + ...ourceLoaderStaticObjectValidationTest.java | 5 + .../iris/core/pack/PackDownloaderTest.java | 5 + .../core/pack/PackImageMapValidatorTest.java | 5 + .../core/pack/PackValidationCacheTest.java | 5 + .../pack/PackValidatorStructureGraphTest.java | 5 + .../PregenCacheExecutorRegistrationTest.java | 5 + .../core/project/ExternalBlockSchemaTest.java | 5 + .../core/project/IrisCodeWorkspaceTest.java | 5 + .../core/project/IrisRiverSchemaTest.java | 5 + .../project/IrisStaticObjectSchemaTest.java | 5 + .../core/project/SchemaBuilderParityTest.java | 5 + .../core/service/BoardSVCSavedBiomeTest.java | 5 + .../JigsawStudioMenuControllerTest.java | 5 + .../JigsawStudioServiceCaptureTest.java | 5 + .../iris/core/service/MultiverseSVCTest.java | 5 + .../StudioSVCWorldPackPublishTest.java | 5 + .../structure/StructureIndexServiceTest.java | 5 + .../IrisDataStructureRecoveryTest.java | 5 + .../VanillaJigsawDatapackExporterTest.java | 5 + .../tools/IrisToolbeltPackReferenceTest.java | 5 + .../core/tools/TreePlausibilizerTest.java | 29 +----- .../iris/engine/EngineShutdownDrainTest.java | 4 + .../engine/ResolvedTerrainProviderTest.java | 5 + .../IrisBiomeActuatorCoordinateTest.java | 5 + ...risDimensionStackActuatorMetadataTest.java | 5 + ...risTerrainNormalActuatorHydrologyTest.java | 30 +----- .../IrisTransitionGeometryActuatorTest.java | 5 + .../IrisDecoratorCaveContextTest.java | 5 + .../decorator/IrisShoreLineDecoratorTest.java | 5 + .../engine/framework/EngineComponentTest.java | 5 + .../framework/EngineHostHeightTest.java | 5 + .../framework/EngineModeBurstAroundTest.java | 17 +--- .../engine/framework/HintedLocatorTest.java | 5 + .../StructureAssemblerCompatTest.java | 26 +---- .../framework/StructureAssemblerTest.java | 26 +---- .../StructureCaveAnchorResolverTest.java | 26 +---- .../StructureReachabilityContractTest.java | 5 + .../structure/StructureGraphCompilerTest.java | 28 +----- .../history/ArchivedRegistryCompilerTest.java | 5 + ...CrossTileCaveAdmissionIntegrationTest.java | 5 + .../mantle/EngineMantleCleanupTest.java | 20 +--- .../mantle/EngineMantleCoverageTest.java | 5 + .../engine/mantle/EngineMantleMarkerTest.java | 26 +---- .../mantle/MantleWriterOverlayTest.java | 23 +---- .../MantleWriterPreObjectJournalTest.java | 5 + .../MatterGeneratorCarvePassRadiusTest.java | 31 +----- .../mantle/ResolvedTerrainPlacementTest.java | 5 + ...tleCarvingComponentBoundaryRadiusTest.java | 26 +---- ...tingObjectComponentBoundaryRadiusTest.java | 27 +---- ...ntleObjectComponentBoundaryRadiusTest.java | 5 + ...isCarveModifierInferenceIsolationTest.java | 26 +---- .../IrisDepositModifierContextTest.java | 25 +---- .../IrisDepositModifierOrderingTest.java | 5 + .../IrisDepositModifierParityTest.java | 5 + .../object/IrisBiomeCompatChildrenTest.java | 10 +- .../object/IrisBiomeDerivativeCompatTest.java | 4 +- .../object/IrisDimensionCompatRegionTest.java | 10 +- .../IrisDimensionReachableBiomesTest.java | 2 +- .../object/IrisLootTableCompatTest.java | 14 +-- ...isObjectPlacementRunnerRegressionTest.java | 5 + .../engine/object/IrisObjectShapingTest.java | 5 + ...IrisObjectSurfaceSupportPlacementTest.java | 23 +---- .../object/IrisObjectTransformsTileTest.java | 5 + .../object/IrisRegionCompatPoolTest.java | 22 ++--- .../engine/object/IrisSpawnerCompatTest.java | 10 +- .../object/IrisStaticObjectLayerTest.java | 5 + .../object/NativeStructureObjectVetoTest.java | 23 +---- .../engine/object/PackCompatFixtures.java | 4 +- ...eBukkitOpsDeferredMaterializationTest.java | 5 + .../art/arcane/iris/spi/IrisLoggingTest.java | 5 + .../spi/IrisPlatformsBindLifecycleTest.java | 5 + .../art/arcane/iris/spi/IrisServicesTest.java | 5 + .../iris/testsupport/BukkitTestServer.java | 51 +++++++++- .../iris/testsupport/IrisRuntimeState.java | 52 ++++++++++ .../iris/testsupport/PlatformBinding.java | 99 +++++++++++++++++++ .../iris/testsupport/PlatformLeakGuard.java | 64 ++++++++++++ .../common/data/PlatformStateRebindTest.java | 5 + .../director/DirectorAuthoringDataTest.java | 5 + .../specialhandlers/StructureHandlerTest.java | 5 + .../iris/util/common/misc/WebCacheTest.java | 5 + .../scheduling/JHybridPlatformTest.java | 5 + .../context/ChunkContextPrefillPlanTest.java | 5 + .../IrisMatterPlatformSelectionTest.java | 5 + 93 files changed, 691 insertions(+), 403 deletions(-) create mode 100644 core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java create mode 100644 core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java create mode 100644 core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java diff --git a/core/src/test/java/art/arcane/iris/core/IrisRuntimeSchedulerModeRoutingTest.java b/core/src/test/java/art/arcane/iris/core/IrisRuntimeSchedulerModeRoutingTest.java index 87426c72f..ca7b49e94 100644 --- a/core/src/test/java/art/arcane/iris/core/IrisRuntimeSchedulerModeRoutingTest.java +++ b/core/src/test/java/art/arcane/iris/core/IrisRuntimeSchedulerModeRoutingTest.java @@ -1,6 +1,7 @@ package art.arcane.iris.core; import art.arcane.iris.testsupport.BukkitTestServer; +import org.junit.Rule; import org.junit.Test; @@ -9,6 +10,9 @@ import static org.junit.Assume.assumeTrue; import static org.mockito.Mockito.mockingDetails; public class IrisRuntimeSchedulerModeRoutingTest { + @Rule + public final BukkitTestServer.ServerBranding branding = BukkitTestServer.branding(); + @Test public void autoResolvesToPaperLikeOnPurpurBranding() { installServer("Purpur", "git-Purpur-2562 (MC: 26.2)"); @@ -55,6 +59,6 @@ public class IrisRuntimeSchedulerModeRoutingTest { private void installServer(String name, String version) { assumeTrue(mockingDetails(BukkitTestServer.install()).isMock()); - BukkitTestServer.brand(name, version); + branding.set(name, version); } } diff --git a/core/src/test/java/art/arcane/iris/core/gui/NoiseExplorerGUITest.java b/core/src/test/java/art/arcane/iris/core/gui/NoiseExplorerGUITest.java index 649d218d9..75957cff3 100644 --- a/core/src/test/java/art/arcane/iris/core/gui/NoiseExplorerGUITest.java +++ b/core/src/test/java/art/arcane/iris/core/gui/NoiseExplorerGUITest.java @@ -3,7 +3,9 @@ package art.arcane.iris.core.gui; import art.arcane.iris.engine.framework.MeteredCache; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.function.NoiseProvider; +import org.junit.ClassRule; import org.junit.Test; import javax.swing.SwingUtilities; @@ -20,6 +22,9 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; public final class NoiseExplorerGUITest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void openingInitialSourceBuildsSamplerExactlyOnce() throws Exception { AtomicInteger factoryCalls = new AtomicInteger(); diff --git a/core/src/test/java/art/arcane/iris/core/gui/PregeneratorJobShutdownDispatchTest.java b/core/src/test/java/art/arcane/iris/core/gui/PregeneratorJobShutdownDispatchTest.java index 9db13b6f1..b3daed02c 100644 --- a/core/src/test/java/art/arcane/iris/core/gui/PregeneratorJobShutdownDispatchTest.java +++ b/core/src/test/java/art/arcane/iris/core/gui/PregeneratorJobShutdownDispatchTest.java @@ -8,6 +8,7 @@ import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.format.MemoryMonitor; import art.arcane.volmlib.util.scheduling.FoliaScheduler; @@ -17,6 +18,7 @@ import org.bukkit.plugin.IllegalPluginAccessException; import org.bukkit.plugin.Plugin; import org.bukkit.plugin.PluginManager; import org.bukkit.scheduler.BukkitScheduler; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -45,6 +47,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class PregeneratorJobShutdownDispatchTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void pluginDisableCanJoinAWorkerAlreadyDispatchingSaving() throws Exception { try (Fixture fixture = new Fixture()) { diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/MissingWorldStorageLogTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/MissingWorldStorageLogTest.java index b76a79ab4..d5a8fa8d6 100644 --- a/core/src/test/java/art/arcane/iris/core/lifecycle/MissingWorldStorageLogTest.java +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/MissingWorldStorageLogTest.java @@ -3,8 +3,10 @@ package art.arcane.iris.core.lifecycle; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.LogLevel; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.nio.file.Path; @@ -22,6 +24,9 @@ import static org.mockito.Mockito.mock; * console and the runtime log but never the instance's logs/latest.log - the only log most operators read. */ public class MissingWorldStorageLogTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private final List emitted = new ArrayList<>(); private final List levels = new ArrayList<>(); private IrisPlatform previousPlatform; diff --git a/core/src/test/java/art/arcane/iris/core/link/MultiverseGuardListenerTest.java b/core/src/test/java/art/arcane/iris/core/link/MultiverseGuardListenerTest.java index f6a235721..aea563b70 100644 --- a/core/src/test/java/art/arcane/iris/core/link/MultiverseGuardListenerTest.java +++ b/core/src/test/java/art/arcane/iris/core/link/MultiverseGuardListenerTest.java @@ -3,12 +3,14 @@ package art.arcane.iris.core.link; import art.arcane.iris.core.lifecycle.ManagedWorldLoader; import art.arcane.iris.engine.platform.BukkitChunkGenerator; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.bukkit.Bukkit; import org.bukkit.Server; import org.bukkit.World; import org.bukkit.command.ConsoleCommandSender; import org.bukkit.event.server.ServerCommandEvent; import org.bukkit.plugin.PluginManager; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -29,6 +31,9 @@ import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.when; public class MultiverseGuardListenerTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/IrisDataAuthoringCacheTest.java b/core/src/test/java/art/arcane/iris/core/loader/IrisDataAuthoringCacheTest.java index e9b5b4311..6e6733c1f 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/IrisDataAuthoringCacheTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/IrisDataAuthoringCacheTest.java @@ -4,8 +4,10 @@ import art.arcane.iris.core.IrisSettings; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.engine.object.IrisGenerator; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -22,6 +24,9 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; public class IrisDataAuthoringCacheTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public final TemporaryFolder temporary = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/IrisDataDatapackCompilerCacheTest.java b/core/src/test/java/art/arcane/iris/core/loader/IrisDataDatapackCompilerCacheTest.java index 0717c5521..9cf53a739 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/IrisDataDatapackCompilerCacheTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/IrisDataDatapackCompilerCacheTest.java @@ -3,8 +3,10 @@ package art.arcane.iris.core.loader; import art.arcane.iris.engine.framework.MeteredCache; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -17,6 +19,9 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; public class IrisDataDatapackCompilerCacheTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/IrisDataEngineRegistryTest.java b/core/src/test/java/art/arcane/iris/core/loader/IrisDataEngineRegistryTest.java index 6e78dfcc4..420f38a22 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/IrisDataEngineRegistryTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/IrisDataEngineRegistryTest.java @@ -4,9 +4,11 @@ import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.MeteredCache; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.context.IrisContext; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -21,6 +23,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisDataEngineRegistryTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/IrisDataRetainedPackTest.java b/core/src/test/java/art/arcane/iris/core/loader/IrisDataRetainedPackTest.java index 11cca8434..8a86f3157 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/IrisDataRetainedPackTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/IrisDataRetainedPackTest.java @@ -5,8 +5,10 @@ import art.arcane.iris.engine.history.GenerationRegistryContract; import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -20,6 +22,9 @@ import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.spy; public class IrisDataRetainedPackTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderPrefetchTest.java b/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderPrefetchTest.java index 563f759fa..de54f4c0e 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderPrefetchTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderPrefetchTest.java @@ -7,10 +7,12 @@ import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.collection.KSet; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -34,6 +36,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class ResourceLoaderPrefetchTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderStaticObjectValidationTest.java b/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderStaticObjectValidationTest.java index 403c19da3..9265f0cc5 100644 --- a/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderStaticObjectValidationTest.java +++ b/core/src/test/java/art/arcane/iris/core/loader/ResourceLoaderStaticObjectValidationTest.java @@ -5,9 +5,11 @@ import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import com.google.gson.Gson; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -26,6 +28,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class ResourceLoaderStaticObjectValidationTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackDownloaderTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackDownloaderTest.java index 5e37ae1b7..96e04cdce 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackDownloaderTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackDownloaderTest.java @@ -27,9 +27,11 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.IrisServices; import art.arcane.iris.spi.PlatformStructureHooks; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.Assume; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -67,6 +69,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class PackDownloaderTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temp = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackImageMapValidatorTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackImageMapValidatorTest.java index 18e2995cc..7359261e3 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackImageMapValidatorTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackImageMapValidatorTest.java @@ -3,8 +3,10 @@ package art.arcane.iris.core.pack; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -25,6 +27,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class PackImageMapValidatorTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackValidationCacheTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackValidationCacheTest.java index 2c79cbe0c..c9ebb8c97 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackValidationCacheTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackValidationCacheTest.java @@ -7,6 +7,8 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.spi.PlatformStructureHooks; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.Assume; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class PackValidationCacheTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackValidatorStructureGraphTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackValidatorStructureGraphTest.java index d9fc885c1..6a58898af 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackValidatorStructureGraphTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackValidatorStructureGraphTest.java @@ -4,6 +4,8 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformStructureHooks; import art.arcane.iris.spi.PlatformStructureHooks.JigsawSourceMetadata; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -27,6 +29,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class PackValidatorStructureGraphTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheExecutorRegistrationTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheExecutorRegistrationTest.java index 7d5320a30..157d28002 100644 --- a/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheExecutorRegistrationTest.java +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheExecutorRegistrationTest.java @@ -3,7 +3,9 @@ package art.arcane.iris.core.pregenerator.cache; import art.arcane.iris.engine.framework.MeteredCache; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import java.io.File; @@ -16,6 +18,9 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; public class PregenCacheExecutorRegistrationTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final class RecordingPreservation implements PreservationRegistry { private final List executors = new CopyOnWriteArrayList<>(); diff --git a/core/src/test/java/art/arcane/iris/core/project/ExternalBlockSchemaTest.java b/core/src/test/java/art/arcane/iris/core/project/ExternalBlockSchemaTest.java index 48d2009d4..a1fc05c67 100644 --- a/core/src/test/java/art/arcane/iris/core/project/ExternalBlockSchemaTest.java +++ b/core/src/test/java/art/arcane/iris/core/project/ExternalBlockSchemaTest.java @@ -7,9 +7,11 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockProperty; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.json.JSONObject; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -20,6 +22,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class ExternalBlockSchemaTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final String QUALIFIED_BLOCK = "craftengine:example/ores/copper"; private IrisPlatform previous; diff --git a/core/src/test/java/art/arcane/iris/core/project/IrisCodeWorkspaceTest.java b/core/src/test/java/art/arcane/iris/core/project/IrisCodeWorkspaceTest.java index c1b5948b1..93279f408 100644 --- a/core/src/test/java/art/arcane/iris/core/project/IrisCodeWorkspaceTest.java +++ b/core/src/test/java/art/arcane/iris/core/project/IrisCodeWorkspaceTest.java @@ -8,10 +8,12 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.IrisServices; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.json.JSONArray; import art.arcane.volmlib.util.json.JSONObject; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -34,6 +36,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisCodeWorkspaceTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/project/IrisRiverSchemaTest.java b/core/src/test/java/art/arcane/iris/core/project/IrisRiverSchemaTest.java index f436677e8..4def75054 100644 --- a/core/src/test/java/art/arcane/iris/core/project/IrisRiverSchemaTest.java +++ b/core/src/test/java/art/arcane/iris/core/project/IrisRiverSchemaTest.java @@ -8,6 +8,7 @@ import art.arcane.iris.engine.object.IrisBlockData; import art.arcane.iris.engine.object.IrisExpression; import art.arcane.iris.engine.object.IrisHydrology; import art.arcane.iris.engine.object.IrisRiverPolicy; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.json.JSONArray; @@ -17,6 +18,7 @@ import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisRiverSchemaTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private IrisPlatform previousPlatform; @Before diff --git a/core/src/test/java/art/arcane/iris/core/project/IrisStaticObjectSchemaTest.java b/core/src/test/java/art/arcane/iris/core/project/IrisStaticObjectSchemaTest.java index 0de1e7b91..97269a088 100644 --- a/core/src/test/java/art/arcane/iris/core/project/IrisStaticObjectSchemaTest.java +++ b/core/src/test/java/art/arcane/iris/core/project/IrisStaticObjectSchemaTest.java @@ -12,11 +12,13 @@ import art.arcane.iris.engine.object.annotations.ArrayType; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.json.JSONObject; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.lang.reflect.Field; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisStaticObjectSchemaTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private IrisPlatform previousPlatform; @Before diff --git a/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderParityTest.java b/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderParityTest.java index 696374b43..cca89d561 100644 --- a/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderParityTest.java +++ b/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderParityTest.java @@ -55,12 +55,14 @@ import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.spi.PlatformScheduler; import art.arcane.iris.spi.PlatformStructureHooks; import art.arcane.iris.spi.PlatformWorld; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.json.JSONArray; import art.arcane.volmlib.util.json.JSONObject; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.io.File; @@ -76,6 +78,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class SchemaBuilderParityTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final List POTION_KEYS = List.of("minecraft:speed", "minecraft:slow_falling", "sniffer_mod:mega_boost"); private static final List ENCHANT_KEYS = List.of("minecraft:sharpness", "cool_mod:vorpal"); private static final List ITEM_KEYS = List.of("minecraft:stone", "minecraft:diamond_sword", "cool_mod:ruby"); diff --git a/core/src/test/java/art/arcane/iris/core/service/BoardSVCSavedBiomeTest.java b/core/src/test/java/art/arcane/iris/core/service/BoardSVCSavedBiomeTest.java index b5e295861..14fb11c81 100644 --- a/core/src/test/java/art/arcane/iris/core/service/BoardSVCSavedBiomeTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/BoardSVCSavedBiomeTest.java @@ -17,6 +17,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.board.Board; import art.arcane.volmlib.util.board.BoardSettings; @@ -24,6 +25,7 @@ import org.bukkit.Location; import org.bukkit.World; import org.bukkit.entity.Player; import org.bukkit.event.player.PlayerChangedWorldEvent; +import org.junit.ClassRule; import org.junit.Test; import org.junit.AfterClass; import org.junit.BeforeClass; @@ -53,6 +55,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class BoardSVCSavedBiomeTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static IrisPlatform previousPlatform; @BeforeClass diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java index 860be98ab..7725abc38 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java @@ -7,6 +7,7 @@ import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.scheduling.J; import org.bukkit.ChatColor; import org.bukkit.Location; @@ -15,6 +16,7 @@ import org.bukkit.World; import org.bukkit.entity.Player; import org.bukkit.event.player.PlayerChangedWorldEvent; import org.bukkit.plugin.java.JavaPlugin; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -41,6 +43,9 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class JigsawStudioMenuControllerTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final UUID WORLD_ID = UUID.fromString("22222222-2222-2222-2222-222222222222"); private static final UUID REQUEST_ID = UUID.fromString("77777777-7777-7777-7777-777777777777"); private static final JigsawStudioPieceRules RULES = new JigsawStudioPieceRules(1, 12, 2, 8, false); diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java index 794854461..9567bd53e 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java @@ -36,6 +36,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.data.B; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.iris.util.common.plugin.VolmitPlugin; @@ -72,6 +73,7 @@ import org.bukkit.event.player.PlayerCommandPreprocessEvent; import org.bukkit.event.player.PlayerInteractEvent; import org.bukkit.event.world.ChunkLoadEvent; import org.bukkit.event.world.WorldUnloadEvent; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -115,6 +117,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class JigsawStudioServiceCaptureTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void shutdownQuiesceIsIdempotentAndResetsOnEnable() throws Exception { diff --git a/core/src/test/java/art/arcane/iris/core/service/MultiverseSVCTest.java b/core/src/test/java/art/arcane/iris/core/service/MultiverseSVCTest.java index d580dedaf..5f3ae0b6a 100644 --- a/core/src/test/java/art/arcane/iris/core/service/MultiverseSVCTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/MultiverseSVCTest.java @@ -4,6 +4,7 @@ import art.arcane.iris.core.link.MultiverseCoreLink; import art.arcane.iris.core.link.MultiverseGuardListener; import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.plugin.VolmitPlugin; import org.bukkit.Bukkit; import org.bukkit.event.Listener; @@ -11,6 +12,7 @@ import org.bukkit.event.server.PluginDisableEvent; import org.bukkit.event.server.PluginEnableEvent; import org.bukkit.plugin.Plugin; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -24,6 +26,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class MultiverseSVCTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @After public void unbindLink() { IrisServices.remove(MultiverseCoreLink.class); diff --git a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java b/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java index 33ac1df61..a8f7d638b 100644 --- a/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/StudioSVCWorldPackPublishTest.java @@ -8,9 +8,11 @@ import art.arcane.iris.core.pack.PackValidationRegistry; import art.arcane.iris.core.pack.PackValidationResult; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.Assume; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -32,6 +34,9 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; public class StudioSVCWorldPackPublishTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/structure/StructureIndexServiceTest.java b/core/src/test/java/art/arcane/iris/core/structure/StructureIndexServiceTest.java index b796e3311..f0c331103 100644 --- a/core/src/test/java/art/arcane/iris/core/structure/StructureIndexServiceTest.java +++ b/core/src/test/java/art/arcane/iris/core/structure/StructureIndexServiceTest.java @@ -7,8 +7,10 @@ import art.arcane.iris.engine.history.GenerationPackFingerprint; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformStructureHooks; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class StructureIndexServiceTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/structure/authoring/IrisDataStructureRecoveryTest.java b/core/src/test/java/art/arcane/iris/core/structure/authoring/IrisDataStructureRecoveryTest.java index 548ff12d2..d99b6e6b3 100644 --- a/core/src/test/java/art/arcane/iris/core/structure/authoring/IrisDataStructureRecoveryTest.java +++ b/core/src/test/java/art/arcane/iris/core/structure/authoring/IrisDataStructureRecoveryTest.java @@ -4,8 +4,10 @@ import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.engine.framework.MeteredCache; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -22,6 +24,9 @@ import static org.junit.Assert.assertArrayEquals; import static org.junit.Assert.assertFalse; public class IrisDataStructureRecoveryTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawDatapackExporterTest.java b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawDatapackExporterTest.java index 064027996..57e8b5d79 100644 --- a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawDatapackExporterTest.java +++ b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawDatapackExporterTest.java @@ -20,6 +20,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.nbt.io.NBTUtil; import art.arcane.volmlib.util.nbt.tag.CompoundTag; @@ -28,6 +29,7 @@ import com.google.gson.JsonObject; import com.google.gson.JsonParser; import org.junit.AfterClass; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -53,6 +55,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class VanillaJigsawDatapackExporterTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static PlatformBlockState stone; @Rule diff --git a/core/src/test/java/art/arcane/iris/core/tools/IrisToolbeltPackReferenceTest.java b/core/src/test/java/art/arcane/iris/core/tools/IrisToolbeltPackReferenceTest.java index a9f908f1b..669e58122 100644 --- a/core/src/test/java/art/arcane/iris/core/tools/IrisToolbeltPackReferenceTest.java +++ b/core/src/test/java/art/arcane/iris/core/tools/IrisToolbeltPackReferenceTest.java @@ -2,8 +2,10 @@ package art.arcane.iris.core.tools; import art.arcane.iris.core.service.StudioSVC; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.bukkit.World; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import java.lang.reflect.Proxy; @@ -14,6 +16,9 @@ import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; public class IrisToolbeltPackReferenceTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @After public void cleanServices() { IrisServices.remove(StudioSVC.class); diff --git a/core/src/test/java/art/arcane/iris/core/tools/TreePlausibilizerTest.java b/core/src/test/java/art/arcane/iris/core/tools/TreePlausibilizerTest.java index cd9351a8b..699c880b4 100644 --- a/core/src/test/java/art/arcane/iris/core/tools/TreePlausibilizerTest.java +++ b/core/src/test/java/art/arcane/iris/core/tools/TreePlausibilizerTest.java @@ -1,13 +1,10 @@ package art.arcane.iris.core.tools; import art.arcane.iris.engine.object.IrisObject; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.common.math.IrisBlockVector; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayDeque; @@ -22,11 +19,11 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.anyString; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; public class TreePlausibilizerTest { + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); + private static final String OAK_LOG = "minecraft:oak_log[axis=y]"; private static final String BIRCH_LOG = "minecraft:birch_log[axis=y]"; private static final String OAK_LEAVES = "minecraft:oak_leaves[distance=7,persistent=true,waterlogged=false]"; @@ -42,22 +39,6 @@ public class TreePlausibilizerTest { private record Pos(int x, int y, int z) { } - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState defaultBlock = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - IrisPlatform platform = mock(IrisPlatform.class); - when(registries.block(anyString())).thenReturn(defaultBlock); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } - private static final class TestState implements PlatformBlockState { private final String key; diff --git a/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java b/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java index 42faebe7d..d65ad2e62 100644 --- a/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java +++ b/core/src/test/java/art/arcane/iris/engine/EngineShutdownDrainTest.java @@ -27,6 +27,7 @@ import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.testsupport.DurabilityMode; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.ClassRule; @@ -71,6 +72,9 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class EngineShutdownDrainTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @ClassRule public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); diff --git a/core/src/test/java/art/arcane/iris/engine/ResolvedTerrainProviderTest.java b/core/src/test/java/art/arcane/iris/engine/ResolvedTerrainProviderTest.java index 29967c1bd..2254fe035 100644 --- a/core/src/test/java/art/arcane/iris/engine/ResolvedTerrainProviderTest.java +++ b/core/src/test/java/art/arcane/iris/engine/ResolvedTerrainProviderTest.java @@ -17,11 +17,13 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.context.IrisContext; import art.arcane.iris.util.project.hunk.Hunk; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.collection.KList; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -59,6 +61,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public final class ResolvedTerrainProviderTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void cachedTransitionTerrainRetainsDeferredBlocksWhenCopied() { Fixture fixture = new Fixture(); diff --git a/core/src/test/java/art/arcane/iris/engine/actuator/IrisBiomeActuatorCoordinateTest.java b/core/src/test/java/art/arcane/iris/engine/actuator/IrisBiomeActuatorCoordinateTest.java index a4f2cd99a..6d97053ec 100644 --- a/core/src/test/java/art/arcane/iris/engine/actuator/IrisBiomeActuatorCoordinateTest.java +++ b/core/src/test/java/art/arcane/iris/engine/actuator/IrisBiomeActuatorCoordinateTest.java @@ -13,6 +13,7 @@ import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformBiome; import art.arcane.iris.spi.PlatformBiomeWriter; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.context.ChunkedDataCache; import art.arcane.iris.util.project.hunk.Hunk; @@ -21,6 +22,7 @@ import art.arcane.volmlib.util.math.RNG; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterBiomeInject; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -43,6 +45,9 @@ import static org.mockito.Mockito.verifyNoMoreInteractions; import static org.mockito.Mockito.when; public class IrisBiomeActuatorCoordinateTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @After public void unbindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/actuator/IrisDimensionStackActuatorMetadataTest.java b/core/src/test/java/art/arcane/iris/engine/actuator/IrisDimensionStackActuatorMetadataTest.java index 82eb3b857..e770fabf0 100644 --- a/core/src/test/java/art/arcane/iris/engine/actuator/IrisDimensionStackActuatorMetadataTest.java +++ b/core/src/test/java/art/arcane/iris/engine/actuator/IrisDimensionStackActuatorMetadataTest.java @@ -7,6 +7,7 @@ import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveAction; import art.arcane.iris.engine.mantle.TerrainMatterView; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.matter.IrisMatterSupport; import art.arcane.iris.util.project.matter.slices.PreObjectMatterTest; import art.arcane.volmlib.util.matter.IrisMatter; @@ -23,6 +24,7 @@ import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterSlice; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import static org.mockito.ArgumentMatchers.anyString; @@ -32,6 +34,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisDimensionStackActuatorMetadataTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuatorHydrologyTest.java b/core/src/test/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuatorHydrologyTest.java index c02fcad53..38ad21908 100644 --- a/core/src/test/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuatorHydrologyTest.java +++ b/core/src/test/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuatorHydrologyTest.java @@ -9,14 +9,11 @@ import art.arcane.iris.engine.object.IrisDecorationStep; import art.arcane.iris.engine.object.IrisMaterialPalette; import art.arcane.iris.engine.object.IrisRiverMaterialConfig; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.math.RNG; +import org.junit.Rule; import org.junit.Test; -import org.junit.Before; -import org.junit.After; import java.util.ArrayList; import java.util.List; @@ -28,7 +25,6 @@ import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyDouble; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.ArgumentMatchers.same; import static org.mockito.Mockito.mock; @@ -37,27 +33,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisTerrainNormalActuatorHydrologyTest { - private IrisPlatform previousPlatform; + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); - @Before - public void bindPlatform() { - previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @After - public void restorePlatform() { - IrisPlatforms.unbind(); - if (previousPlatform != null) { - IrisPlatforms.bind(previousPlatform); - } - } @Test public void hydrologyOwnedFluidBypassesBiomeSeaLayers() { diff --git a/core/src/test/java/art/arcane/iris/engine/actuator/IrisTransitionGeometryActuatorTest.java b/core/src/test/java/art/arcane/iris/engine/actuator/IrisTransitionGeometryActuatorTest.java index 96d362aa4..9d588d511 100644 --- a/core/src/test/java/art/arcane/iris/engine/actuator/IrisTransitionGeometryActuatorTest.java +++ b/core/src/test/java/art/arcane/iris/engine/actuator/IrisTransitionGeometryActuatorTest.java @@ -12,10 +12,12 @@ import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBiome; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.hunk.Hunk; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -31,6 +33,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisTransitionGeometryActuatorTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private IrisPlatform previous; private PlatformRegistries registries; private PlatformBlockState stone; diff --git a/core/src/test/java/art/arcane/iris/engine/decorator/IrisDecoratorCaveContextTest.java b/core/src/test/java/art/arcane/iris/engine/decorator/IrisDecoratorCaveContextTest.java index 42b5bcd7b..9e7f36694 100644 --- a/core/src/test/java/art/arcane/iris/engine/decorator/IrisDecoratorCaveContextTest.java +++ b/core/src/test/java/art/arcane/iris/engine/decorator/IrisDecoratorCaveContextTest.java @@ -14,7 +14,9 @@ import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.hunk.Hunk; +import org.junit.ClassRule; import org.junit.Test; import org.junit.BeforeClass; import org.junit.AfterClass; @@ -31,6 +33,9 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; public class IrisDecoratorCaveContextTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @BeforeClass public static void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/decorator/IrisShoreLineDecoratorTest.java b/core/src/test/java/art/arcane/iris/engine/decorator/IrisShoreLineDecoratorTest.java index 72b6a1049..aafeb6f69 100644 --- a/core/src/test/java/art/arcane/iris/engine/decorator/IrisShoreLineDecoratorTest.java +++ b/core/src/test/java/art/arcane/iris/engine/decorator/IrisShoreLineDecoratorTest.java @@ -14,10 +14,12 @@ import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.hunk.Hunk; import art.arcane.iris.util.project.stream.ProceduralStream; import org.bukkit.block.BlockSupport; import org.bukkit.block.data.BlockData; +import org.junit.ClassRule; import org.junit.Test; import org.junit.BeforeClass; import org.junit.AfterClass; @@ -35,6 +37,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisShoreLineDecoratorTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final int FLUID_HEIGHT = 4; @BeforeClass diff --git a/core/src/test/java/art/arcane/iris/engine/framework/EngineComponentTest.java b/core/src/test/java/art/arcane/iris/engine/framework/EngineComponentTest.java index 09e7121cb..bc334d75a 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/EngineComponentTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/EngineComponentTest.java @@ -19,8 +19,10 @@ package art.arcane.iris.engine.framework; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.math.RollingSequence; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import java.util.concurrent.atomic.AtomicReference; @@ -28,6 +30,9 @@ import java.util.concurrent.atomic.AtomicReference; import static org.junit.Assert.assertSame; public class EngineComponentTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @After public void removeCleanup() { IrisServices.remove(EngineComponentCleanup.class); diff --git a/core/src/test/java/art/arcane/iris/engine/framework/EngineHostHeightTest.java b/core/src/test/java/art/arcane/iris/engine/framework/EngineHostHeightTest.java index d7373a45f..9eef22d9f 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/EngineHostHeightTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/EngineHostHeightTest.java @@ -12,8 +12,10 @@ import art.arcane.iris.spi.PlatformBiome; import art.arcane.iris.spi.PlatformBiomeWriter; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class EngineHostHeightTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/framework/EngineModeBurstAroundTest.java b/core/src/test/java/art/arcane/iris/engine/framework/EngineModeBurstAroundTest.java index eeac725da..c1c04ea85 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/EngineModeBurstAroundTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/EngineModeBurstAroundTest.java @@ -1,14 +1,12 @@ package art.arcane.iris.engine.framework; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.common.parallel.MultiBurst; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.core.IrisSettings; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; import org.junit.AfterClass; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -19,29 +17,24 @@ import java.util.concurrent.CopyOnWriteArrayList; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.CALLS_REAL_METHODS; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class EngineModeBurstAroundTest { + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); + private static IrisSettings previousSettings; @BeforeClass public static void bindPlatform() { previousSettings = IrisSettings.settings; IrisSettings.settings = new IrisSettings(); - IrisPlatforms.unbind(); - PlatformRegistries registries = mock(PlatformRegistries.class); - IrisPlatform platform = mock(IrisPlatform.class); - when(registries.block(anyString())).thenReturn(mock(PlatformBlockState.class)); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); } @AfterClass public static void unbindPlatform() { - IrisPlatforms.unbind(); IrisSettings.settings = previousSettings; } diff --git a/core/src/test/java/art/arcane/iris/engine/framework/HintedLocatorTest.java b/core/src/test/java/art/arcane/iris/engine/framework/HintedLocatorTest.java index f71f35d15..0f10994c5 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/HintedLocatorTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/HintedLocatorTest.java @@ -17,6 +17,7 @@ import art.arcane.iris.engine.hydrology.runtime.IrisHydrologyRuntime; import art.arcane.iris.engine.history.GenerationSemanticIndex; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.iris.util.project.stream.interpolation.Interpolated; import art.arcane.volmlib.util.collection.KList; @@ -24,6 +25,7 @@ import art.arcane.volmlib.util.math.Position2; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.io.File; @@ -50,6 +52,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class HintedLocatorTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static boolean boundPlatform; @BeforeClass diff --git a/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerCompatTest.java b/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerCompatTest.java index f9f339348..63efc154a 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerCompatTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerCompatTest.java @@ -34,13 +34,9 @@ import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; import art.arcane.iris.engine.object.JigsawJoint; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.math.RNG; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -48,26 +44,12 @@ import java.util.List; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class StructureAssemblerCompatTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test public void anExcludedPieceIsNeverDrawnFromItsPool() { diff --git a/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerTest.java b/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerTest.java index 163e94fe2..ca3121b5f 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/StructureAssemblerTest.java @@ -34,13 +34,9 @@ import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; import art.arcane.iris.engine.object.JigsawJoint; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.math.RNG; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -50,26 +46,12 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class StructureAssemblerTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test public void attachedNonRotatablePieceKeepsItsAuthoredFacing() { diff --git a/core/src/test/java/art/arcane/iris/engine/framework/StructureCaveAnchorResolverTest.java b/core/src/test/java/art/arcane/iris/engine/framework/StructureCaveAnchorResolverTest.java index 337532b56..267c9720f 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/StructureCaveAnchorResolverTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/StructureCaveAnchorResolverTest.java @@ -5,14 +5,10 @@ import art.arcane.iris.engine.object.IrisStructureAnchorMode; import art.arcane.iris.engine.object.IrisStructurePlacement; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveAction; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCell; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.math.RNG; import art.arcane.volmlib.util.matter.MatterCavern; -import org.junit.After; -import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import java.util.Arrays; @@ -27,7 +23,6 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.RETURNS_DEEP_STUBS; import static org.mockito.Mockito.mock; @@ -36,21 +31,8 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class StructureCaveAnchorResolverTest { - @Before - public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); @Test public void floorRequiresSolidBoundaryAndUpwardClearance() { diff --git a/core/src/test/java/art/arcane/iris/engine/framework/StructureReachabilityContractTest.java b/core/src/test/java/art/arcane/iris/engine/framework/StructureReachabilityContractTest.java index 3386391a0..40b3855bb 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/StructureReachabilityContractTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/StructureReachabilityContractTest.java @@ -24,6 +24,8 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformStructureHooks; import art.arcane.iris.spi.PlatformWorld; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -35,6 +37,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class StructureReachabilityContractTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void reachableKeysRejectsNullEngine() { assertThrows(NullPointerException.class, () -> StructureReachability.reachableKeys(null)); diff --git a/core/src/test/java/art/arcane/iris/engine/framework/structure/StructureGraphCompilerTest.java b/core/src/test/java/art/arcane/iris/engine/framework/structure/StructureGraphCompilerTest.java index 6339d0323..e72c789f0 100644 --- a/core/src/test/java/art/arcane/iris/engine/framework/structure/StructureGraphCompilerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/framework/structure/StructureGraphCompilerTest.java @@ -14,13 +14,9 @@ import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; import art.arcane.iris.engine.object.JigsawJoint; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.collection.KList; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -31,26 +27,10 @@ import java.util.Map; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.anyString; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; public class StructureGraphCompilerTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test public void compilesACompleteTerminalGraphAndSamplesDeterministically() { diff --git a/core/src/test/java/art/arcane/iris/engine/history/ArchivedRegistryCompilerTest.java b/core/src/test/java/art/arcane/iris/engine/history/ArchivedRegistryCompilerTest.java index 9eef16f2c..1a87ca0c1 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/ArchivedRegistryCompilerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/ArchivedRegistryCompilerTest.java @@ -9,7 +9,9 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformGenerationRegistry; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -27,6 +29,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class ArchivedRegistryCompilerTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public final TemporaryFolder temporary = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerCrossTileCaveAdmissionIntegrationTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerCrossTileCaveAdmissionIntegrationTest.java index 063087527..d601663fd 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerCrossTileCaveAdmissionIntegrationTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerCrossTileCaveAdmissionIntegrationTest.java @@ -9,6 +9,8 @@ import art.arcane.iris.core.IrisSettings; import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlan; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -23,6 +25,9 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; public class HydrologyPlannerCrossTileCaveAdmissionIntegrationTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final long SEED = 77L; private static final List ADJACENT_PAIRS = List.of( new TilePair(new HydrologyTileKey(0, -2), new HydrologyTileKey(0, -1)), diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCleanupTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCleanupTest.java index a62f60a32..7dc0a2125 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCleanupTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCleanupTest.java @@ -3,10 +3,8 @@ package art.arcane.iris.engine.mantle; import art.arcane.iris.core.link.Identifier; import art.arcane.iris.engine.framework.TreeBlockMaterial; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCell; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.matter.PreObjectMatterCell; import art.arcane.iris.util.project.matter.TileWrapper; import art.arcane.volmlib.util.mantle.flag.MantleFlag; @@ -15,7 +13,7 @@ import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterCavern; import org.junit.After; -import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import org.mockito.InOrder; @@ -27,7 +25,6 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; import static org.mockito.Answers.CALLS_REAL_METHODS; import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; @@ -38,20 +35,11 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class EngineMantleCleanupTest { - @Before - public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); @After public void unbindPlatform() { - IrisPlatforms.unbind(); MantleSliceRetention.clearForTesting(); } diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCoverageTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCoverageTest.java index 0224f03dd..c26058c40 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCoverageTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleCoverageTest.java @@ -5,12 +5,14 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.mantle.flag.MantleFlag; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -34,6 +36,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class EngineMantleCoverageTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleMarkerTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleMarkerTest.java index cedcec4d9..7f9ce00ea 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleMarkerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/EngineMantleMarkerTest.java @@ -3,24 +3,19 @@ package art.arcane.iris.engine.mantle; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.EnginePlatformHooks; import art.arcane.iris.engine.object.IrisPosition; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.function.Consumer4; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterMarker; -import org.junit.After; -import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; import static org.mockito.Answers.CALLS_REAL_METHODS; import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; @@ -28,21 +23,8 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class EngineMantleMarkerTest { - @Before - public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); @Test @SuppressWarnings("unchecked") diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterOverlayTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterOverlayTest.java index 246aea5b6..c88eb0bb1 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterOverlayTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterOverlayTest.java @@ -7,17 +7,15 @@ import art.arcane.iris.engine.history.TransitionGenerationPlan; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveAction; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCell; import art.arcane.iris.engine.object.IrisDimension; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterCavern; import art.arcane.volmlib.util.matter.MatterSlice; -import org.junit.After; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import static org.junit.Assert.assertFalse; @@ -26,13 +24,15 @@ import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyInt; import static org.mockito.Mockito.doReturn; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class MantleWriterOverlayTest { + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); + private static final int X = 1; private static final int Y = 2; private static final int Z = 3; @@ -51,14 +51,6 @@ public class MantleWriterOverlayTest { @Before @SuppressWarnings("unchecked") public void setUp() { - IrisPlatforms.unbind(); - PlatformBlockState defaultBlock = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - IrisPlatform platform = mock(IrisPlatform.class); - when(registries.block(anyString())).thenReturn(defaultBlock); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - engineMantle = mock(EngineMantle.class); Engine engine = mock(Engine.class); dimension = mock(IrisDimension.class); @@ -92,11 +84,6 @@ public class MantleWriterOverlayTest { writer = new MantleWriter(engineMantle, mantle, 0, 0, 0, false); } - @After - public void tearDown() { - IrisPlatforms.unbind(); - } - @Test public void existingCavernStillClearsBlockAndDeferredPlacement() { MatterCavern existing = new MatterCavern(true, "", (byte) 3); diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterPreObjectJournalTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterPreObjectJournalTest.java index 19203cf4b..3c5c2322f 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterPreObjectJournalTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterPreObjectJournalTest.java @@ -7,6 +7,7 @@ import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.testsupport.BukkitTestServer; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.matter.IrisMatterSupport; import art.arcane.iris.util.project.matter.PreObjectMatterCell; import art.arcane.volmlib.util.mantle.runtime.Mantle; @@ -18,6 +19,7 @@ import art.arcane.volmlib.util.matter.MatterSlice; import org.junit.After; import org.junit.Before; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.concurrent.CountDownLatch; @@ -37,6 +39,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class MantleWriterPreObjectJournalTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final int X = 2; private static final int Y = 5; private static final int Z = 4; diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorCarvePassRadiusTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorCarvePassRadiusTest.java index 341c50625..af3e61287 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorCarvePassRadiusTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorCarvePassRadiusTest.java @@ -3,18 +3,14 @@ package art.arcane.iris.engine.mantle; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.EnginePlatformHooks; import art.arcane.iris.engine.object.IrisDimension; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.volmlib.util.mantle.flag.MantleFlag; import art.arcane.volmlib.util.mantle.flag.ReservedFlag; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.util.LinkedHashSet; @@ -25,33 +21,14 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class MatterGeneratorCarvePassRadiusTest { - private static IrisPlatform previousPlatform; + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); - @BeforeClass - public static void bindPlatform() { - previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; - IrisPlatforms.unbind(); - PlatformBlockState air = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - IrisPlatform platform = mock(IrisPlatform.class); - when(registries.block(anyString())).thenReturn(air); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void restorePlatform() { - IrisPlatforms.unbind(); - if (previousPlatform != null) { - IrisPlatforms.bind(previousPlatform); - } - } @Test @SuppressWarnings("unchecked") diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/ResolvedTerrainPlacementTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/ResolvedTerrainPlacementTest.java index b9b3f47fd..c5ecf874e 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/ResolvedTerrainPlacementTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/ResolvedTerrainPlacementTest.java @@ -8,6 +8,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.matter.IrisMatterSupport; import art.arcane.iris.util.project.matter.PreObjectMatterCell; import art.arcane.iris.util.project.matter.slices.PreObjectMatterTest; @@ -17,6 +18,7 @@ import art.arcane.volmlib.util.matter.IrisMatter; import art.arcane.volmlib.util.matter.Matter; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.List; @@ -39,6 +41,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class ResolvedTerrainPlacementTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private EngineMantle engineMantle; private Mantle mantle; private PlatformBlockState stone; diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleCarvingComponentBoundaryRadiusTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleCarvingComponentBoundaryRadiusTest.java index b71601d73..a62d9338f 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleCarvingComponentBoundaryRadiusTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleCarvingComponentBoundaryRadiusTest.java @@ -7,17 +7,13 @@ import art.arcane.iris.engine.mantle.MantlePass; import art.arcane.iris.engine.mantle.EngineMantle; import art.arcane.iris.engine.mantle.MatterGenerator; import art.arcane.iris.engine.object.IrisDimension; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; -import org.junit.After; -import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import java.util.ArrayList; @@ -27,7 +23,6 @@ import static org.junit.Assert.assertEquals; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyDouble; import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; @@ -36,21 +31,8 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class MantleCarvingComponentBoundaryRadiusTest { - @Before - public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); @Test public void boundaryWallResolutionSchedulesAdjacentCarvingChunks() { diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleFloatingObjectComponentBoundaryRadiusTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleFloatingObjectComponentBoundaryRadiusTest.java index ec6b92503..3e4ac3522 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleFloatingObjectComponentBoundaryRadiusTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleFloatingObjectComponentBoundaryRadiusTest.java @@ -28,13 +28,8 @@ import art.arcane.iris.engine.object.IrisFloatingChildBiomes; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisObjectPlacement; import art.arcane.iris.engine.object.IrisObjectTranslate; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.volmlib.util.collection.KList; -import org.junit.After; -import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -44,30 +39,16 @@ import java.io.File; import java.io.FileOutputStream; import static org.junit.Assert.assertEquals; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class MantleFloatingObjectComponentBoundaryRadiusTest { + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); - @Before - public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } - @Test @SuppressWarnings("unchecked") public void transformedFloatingPlacementExpandsOwnerRadius() throws Exception { diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleObjectComponentBoundaryRadiusTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleObjectComponentBoundaryRadiusTest.java index 4cf8e9a2e..be7f71765 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleObjectComponentBoundaryRadiusTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/components/MantleObjectComponentBoundaryRadiusTest.java @@ -28,6 +28,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.volmlib.util.collection.KList; @@ -36,6 +37,7 @@ import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -59,6 +61,9 @@ import static org.mockito.Mockito.when; import static org.mockito.Mockito.verify; public class MantleObjectComponentBoundaryRadiusTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/engine/modifier/IrisCarveModifierInferenceIsolationTest.java b/core/src/test/java/art/arcane/iris/engine/modifier/IrisCarveModifierInferenceIsolationTest.java index 1096c4fbb..e145f8da2 100644 --- a/core/src/test/java/art/arcane/iris/engine/modifier/IrisCarveModifierInferenceIsolationTest.java +++ b/core/src/test/java/art/arcane/iris/engine/modifier/IrisCarveModifierInferenceIsolationTest.java @@ -9,17 +9,13 @@ import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.engine.object.IrisDimensionCarvingResolver; import art.arcane.iris.engine.object.IrisRegion; import art.arcane.iris.engine.object.IrisWorld; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.hunk.Hunk; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.MatterCavern; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; -import org.junit.AfterClass; -import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import java.lang.reflect.Field; @@ -30,27 +26,13 @@ import java.util.Map; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertSame; import static org.mockito.ArgumentMatchers.anyDouble; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.CALLS_REAL_METHODS; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; public class IrisCarveModifierInferenceIsolationTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - doReturn(block).when(registries).block(anyString()); - IrisPlatform platform = mock(IrisPlatform.class); - doReturn(registries).when(platform).registries(); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test @SuppressWarnings("unchecked") diff --git a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierContextTest.java b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierContextTest.java index ce01209d2..72fcd515d 100644 --- a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierContextTest.java +++ b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierContextTest.java @@ -6,10 +6,8 @@ import art.arcane.iris.engine.object.IrisDepositGenerator; import art.arcane.iris.engine.object.IrisDepositHeightDistribution; import art.arcane.iris.engine.object.IrisDepositPlacementScope; import art.arcane.iris.engine.object.IrisObject; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.common.parallel.BurstExecutor; import art.arcane.iris.util.common.parallel.MultiBurst; import art.arcane.iris.util.project.context.ChunkContext; @@ -20,9 +18,8 @@ import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.math.RNG; +import org.junit.ClassRule; import org.junit.Test; -import org.junit.AfterClass; -import org.junit.BeforeClass; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @@ -37,7 +34,6 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; import static org.junit.Assert.assertThrows; import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.RETURNS_DEEP_STUBS; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doReturn; @@ -49,21 +45,8 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisDepositModifierContextTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test public void workerDepositsRetainRuntimeAndChunkContextUntilCompletion() throws Exception { diff --git a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierOrderingTest.java b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierOrderingTest.java index c8df9dbf2..0c43ff57a 100644 --- a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierOrderingTest.java +++ b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierOrderingTest.java @@ -9,6 +9,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.data.B; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.iris.util.common.parallel.BurstExecutor; @@ -22,6 +23,7 @@ import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.math.RNG; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -48,6 +50,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisDepositModifierOrderingTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierParityTest.java b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierParityTest.java index a8ee8762a..6a6a5c31f 100644 --- a/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierParityTest.java +++ b/core/src/test/java/art/arcane/iris/engine/modifier/IrisDepositModifierParityTest.java @@ -13,6 +13,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.data.B; import art.arcane.iris.util.common.parallel.MultiBurst; import art.arcane.iris.util.project.context.ChunkContext; @@ -24,6 +25,7 @@ import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterCavern; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -44,6 +46,9 @@ import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.when; public class IrisDepositModifierParityTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private final Map states = new HashMap<>(); @Before diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCompatChildrenTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCompatChildrenTest.java index f1666a1ae..351267eb9 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCompatChildrenTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCompatChildrenTest.java @@ -8,10 +8,10 @@ import art.arcane.iris.core.loader.ResourceLoader; import art.arcane.volmlib.util.collection.KList; import org.junit.Test; -import static art.arcane.iris.engine.object.CompatFixtures.MISSING_BLOCK; -import static art.arcane.iris.engine.object.CompatFixtures.biome; -import static art.arcane.iris.engine.object.CompatFixtures.excludeBlock; -import static art.arcane.iris.engine.object.CompatFixtures.find; +import static art.arcane.iris.engine.object.PackCompatFixtures.MISSING_BLOCK; +import static art.arcane.iris.engine.object.PackCompatFixtures.biome; +import static art.arcane.iris.engine.object.PackCompatFixtures.excludeBlock; +import static art.arcane.iris.engine.object.PackCompatFixtures.find; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; @@ -23,7 +23,7 @@ import static org.mockito.Mockito.when; public class IrisBiomeCompatChildrenTest { @SuppressWarnings("unchecked") private static IrisData dataWith(PackCompatReport report, IrisBiome... biomes) { - IrisData data = CompatFixtures.data(report); + IrisData data = PackCompatFixtures.data(report); ResourceLoader biomeLoader = mock(ResourceLoader.class); when(data.getBiomeLoader()).thenReturn(biomeLoader); for (IrisBiome biome : biomes) { diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeDerivativeCompatTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeDerivativeCompatTest.java index 19055378c..33d2fcb00 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeDerivativeCompatTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeDerivativeCompatTest.java @@ -12,7 +12,7 @@ import static org.junit.Assert.assertEquals; public class IrisBiomeDerivativeCompatTest { @Test public void droppedVanillaDerivativeFallsBackToDerivative() { - IrisBiome biome = CompatFixtures.biome("cave/sulfur-grotto"); + IrisBiome biome = PackCompatFixtures.biome("cave/sulfur-grotto"); biome.setDerivative("minecraft:dripstone_caves"); biome.setVanillaDerivative("minecraft:sulfur_caves"); @@ -25,7 +25,7 @@ public class IrisBiomeDerivativeCompatTest { @Test public void blankVanillaDerivativeFallsBackToDerivative() { - IrisBiome biome = CompatFixtures.biome("cave/sulfur-grotto"); + IrisBiome biome = PackCompatFixtures.biome("cave/sulfur-grotto"); biome.setDerivative("minecraft:dripstone_caves"); biome.setVanillaDerivative(""); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCompatRegionTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCompatRegionTest.java index e9dc36dfe..f9db3b7e1 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCompatRegionTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCompatRegionTest.java @@ -12,10 +12,10 @@ import org.junit.Test; import java.util.Map; -import static art.arcane.iris.engine.object.CompatFixtures.MISSING_BLOCK; -import static art.arcane.iris.engine.object.CompatFixtures.excludeBlock; -import static art.arcane.iris.engine.object.CompatFixtures.find; -import static art.arcane.iris.engine.object.CompatFixtures.region; +import static art.arcane.iris.engine.object.PackCompatFixtures.MISSING_BLOCK; +import static art.arcane.iris.engine.object.PackCompatFixtures.excludeBlock; +import static art.arcane.iris.engine.object.PackCompatFixtures.find; +import static art.arcane.iris.engine.object.PackCompatFixtures.region; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; @@ -26,7 +26,7 @@ import static org.mockito.Mockito.when; public class IrisDimensionCompatRegionTest { @SuppressWarnings("unchecked") private static IrisData dataWith(PackCompatReport report, IrisRegion... regions) { - IrisData data = CompatFixtures.data(report); + IrisData data = PackCompatFixtures.data(report); ResourceLoader regionLoader = mock(ResourceLoader.class); when(data.getRegionLoader()).thenReturn(regionLoader); for (IrisRegion region : regions) { diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionReachableBiomesTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionReachableBiomesTest.java index 836955f41..243afedf0 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionReachableBiomesTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionReachableBiomesTest.java @@ -176,7 +176,7 @@ public class IrisDimensionReachableBiomesTest { .setLandBiomes(new KList<>("plains")) .setCaveBiomes(new KList<>("carving/sulfur")); IrisBiome plains = biome("plains"); - IrisBiome sulfur = CompatFixtures.excludeBlock(biome("carving/sulfur")) + IrisBiome sulfur = PackCompatFixtures.excludeBlock(biome("carving/sulfur")) .setChildren(new KList<>("carving/sulfur-hollows")); IrisData data = mock(IrisData.class); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisLootTableCompatTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisLootTableCompatTest.java index 6212b714f..bc7edcf32 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisLootTableCompatTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisLootTableCompatTest.java @@ -14,8 +14,8 @@ import org.junit.Test; import java.util.List; import java.util.Map; -import static art.arcane.iris.engine.object.CompatFixtures.find; -import static art.arcane.iris.engine.object.CompatFixtures.lootTable; +import static art.arcane.iris.engine.object.PackCompatFixtures.find; +import static art.arcane.iris.engine.object.PackCompatFixtures.lootTable; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; @@ -26,7 +26,7 @@ import static org.mockito.Mockito.when; public class IrisLootTableCompatTest { @SuppressWarnings("unchecked") private static IrisData dataWith(PackCompatReport report, IrisLootTable... tables) { - IrisData data = CompatFixtures.data(report); + IrisData data = PackCompatFixtures.data(report); ResourceLoader lootLoader = mock(ResourceLoader.class); when(data.getLootLoader()).thenReturn(lootLoader); for (IrisLootTable table : tables) { @@ -43,7 +43,7 @@ public class IrisLootTableCompatTest { public void evaluateCompatExcludesTableWhoseEntriesWereAllDropped() { PackCompatReport report = new PackCompatReport(); IrisLootTable table = lootTable("chest/sulfur-cache"); - table.setLoader(CompatFixtures.data(report)); + table.setLoader(PackCompatFixtures.data(report)); // The gate walker drops every entry with a missing item and hands the cascade its reasons. CompatStatus walked = new CompatStatus(false, List.of(new CompatFinding(CompatRegistry.ITEM, "minecraft:sulfur_dust", CompatAction.DROPPED, "loot", "chest/sulfur-cache", "loot[0]"))); @@ -62,7 +62,7 @@ public class IrisLootTableCompatTest { public void evaluateCompatKeepsTableWithSurvivingEntries() { PackCompatReport report = new PackCompatReport(); IrisLootTable table = lootTable("chest/mixed"); - table.setLoader(CompatFixtures.data(report)); + table.setLoader(PackCompatFixtures.data(report)); table.setLoot(new KList<>(new IrisLoot())); CompatStatus walked = new CompatStatus(false, List.of(new CompatFinding(CompatRegistry.ITEM, "minecraft:sulfur_dust", CompatAction.DROPPED, "loot", "chest/mixed", "loot[1]"))); @@ -74,7 +74,7 @@ public class IrisLootTableCompatTest { public void evaluateCompatKeepsTableThatNeverDeclaredLoot() { PackCompatReport report = new PackCompatReport(); IrisLootTable table = lootTable("chest/empty"); - table.setLoader(CompatFixtures.data(report)); + table.setLoader(PackCompatFixtures.data(report)); assertFalse(table.evaluateCompat(gate(report)).excluded()); assertTrue(report.isEmpty()); @@ -84,7 +84,7 @@ public class IrisLootTableCompatTest { public void lootReferenceSkipsExcludedAndUnloadableTables() { PackCompatReport report = new PackCompatReport(); IrisLootTable kept = lootTable("chest/common"); - IrisLootTable excluded = CompatFixtures.exclude(lootTable("chest/sulfur-cache"), + IrisLootTable excluded = PackCompatFixtures.exclude(lootTable("chest/sulfur-cache"), CompatRegistry.ITEM, "minecraft:sulfur_dust"); IrisData data = dataWith(report, kept, excluded); IrisLootReference reference = new IrisLootReference() diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectPlacementRunnerRegressionTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectPlacementRunnerRegressionTest.java index bc0a095ba..1dc1ba59c 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectPlacementRunnerRegressionTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectPlacementRunnerRegressionTest.java @@ -7,6 +7,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.math.RNG; @@ -15,6 +16,7 @@ import org.bukkit.block.BlockFace; import org.bukkit.block.data.Directional; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -40,6 +42,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisObjectPlacementRunnerRegressionTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final int ANCHOR_Y = 80; private IrisData data; diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectShapingTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectShapingTest.java index 75fe7c94c..456e3fe2a 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectShapingTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectShapingTest.java @@ -4,9 +4,11 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.math.IrisBlockVector; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -23,6 +25,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisObjectShapingTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectSurfaceSupportPlacementTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectSurfaceSupportPlacementTest.java index fa2dca7b5..1b9c5e166 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectSurfaceSupportPlacementTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectSurfaceSupportPlacementTest.java @@ -3,14 +3,12 @@ package art.arcane.iris.engine.object; import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.engine.IrisComplex; import art.arcane.iris.engine.framework.Engine; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.math.RNG; -import org.junit.After; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import java.util.HashMap; @@ -23,13 +21,15 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.anyDouble; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class IrisObjectSurfaceSupportPlacementTest { + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); + private static final int SURFACE_Y = 80; private IrisData data; @@ -38,14 +38,6 @@ public class IrisObjectSurfaceSupportPlacementTest { @Before public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - @SuppressWarnings("unchecked") ProceduralStream heightStream = mock(ProceduralStream.class); when(heightStream.get(anyDouble(), anyDouble())).thenReturn((double) SURFACE_Y); @@ -59,11 +51,6 @@ public class IrisObjectSurfaceSupportPlacementTest { when(data.getEngine()).thenReturn(engine); } - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } - @Test public void carvedAnchorColumnSkipsEverySurfaceAnchoredMode() { for (ObjectPlaceMode mode : new ObjectPlaceMode[]{ diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectTransformsTileTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectTransformsTileTest.java index 01d21393e..00e543bf8 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisObjectTransformsTileTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisObjectTransformsTileTest.java @@ -4,11 +4,13 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.iris.util.common.math.Vector3i; import art.arcane.volmlib.util.collection.KMap; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.Collections; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisObjectTransformsTileTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void bindPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisRegionCompatPoolTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisRegionCompatPoolTest.java index e659ed70e..ab8499081 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisRegionCompatPoolTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisRegionCompatPoolTest.java @@ -13,10 +13,10 @@ import org.junit.Test; import java.util.Map; -import static art.arcane.iris.engine.object.CompatFixtures.MISSING_BLOCK; -import static art.arcane.iris.engine.object.CompatFixtures.biome; -import static art.arcane.iris.engine.object.CompatFixtures.excludeBlock; -import static art.arcane.iris.engine.object.CompatFixtures.find; +import static art.arcane.iris.engine.object.PackCompatFixtures.MISSING_BLOCK; +import static art.arcane.iris.engine.object.PackCompatFixtures.biome; +import static art.arcane.iris.engine.object.PackCompatFixtures.excludeBlock; +import static art.arcane.iris.engine.object.PackCompatFixtures.find; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; @@ -27,7 +27,7 @@ import static org.mockito.Mockito.when; public class IrisRegionCompatPoolTest { @SuppressWarnings("unchecked") private static IrisData dataWith(PackCompatReport report, IrisBiome... biomes) { - IrisData data = CompatFixtures.data(report); + IrisData data = PackCompatFixtures.data(report); ResourceLoader biomeLoader = mock(ResourceLoader.class); when(data.getBiomeLoader()).thenReturn(biomeLoader); for (IrisBiome biome : biomes) { @@ -46,7 +46,7 @@ public class IrisRegionCompatPoolTest { IrisBiome plains = biome("land/plains"); IrisBiome sulfur = excludeBlock(biome("cave/sulfur-grotto")); IrisData data = dataWith(report, plains, sulfur); - IrisRegion region = CompatFixtures.region("overworld"); + IrisRegion region = PackCompatFixtures.region("overworld"); region.setLoader(data); region.setLandBiomes(new KList<>("land/plains", "cave/sulfur-grotto")); @@ -66,7 +66,7 @@ public class IrisRegionCompatPoolTest { PackCompatReport report = new PackCompatReport(); IrisBiome shore = biome("shore/sand"); IrisData data = dataWith(report, shore); - IrisRegion region = CompatFixtures.region("overworld"); + IrisRegion region = PackCompatFixtures.region("overworld"); region.setLoader(data); region.setSeaBiomes(new KList<>("sea/gone")); region.setShoreBiomes(new KList<>("shore/sand")); @@ -86,7 +86,7 @@ public class IrisRegionCompatPoolTest { sulfur.setChildren(new KList<>("cave/sulfur-deep")); IrisBiome sulfurDeep = biome("cave/sulfur-deep"); IrisData data = dataWith(report, plains, sulfur, sulfurDeep); - IrisRegion region = CompatFixtures.region("overworld"); + IrisRegion region = PackCompatFixtures.region("overworld"); region.setLoader(data); region.setLandBiomes(new KList<>("land/plains")); region.setCaveBiomes(new KList<>("cave/sulfur-grotto")); @@ -102,7 +102,7 @@ public class IrisRegionCompatPoolTest { PackCompatReport report = new PackCompatReport(); IrisBiome sulfur = excludeBlock(biome("cave/sulfur-flats")); IrisData data = dataWith(report, sulfur); - IrisRegion region = CompatFixtures.region("sulfur-lands"); + IrisRegion region = PackCompatFixtures.region("sulfur-lands"); region.setLoader(data); region.setLandBiomes(new KList<>("cave/sulfur-flats")); @@ -122,7 +122,7 @@ public class IrisRegionCompatPoolTest { IrisBiome plains = biome("land/plains"); IrisBiome sulfur = excludeBlock(biome("cave/sulfur-flats")); IrisData data = dataWith(report, plains, sulfur); - IrisRegion region = CompatFixtures.region("overworld"); + IrisRegion region = PackCompatFixtures.region("overworld"); region.setLoader(data); region.setLandBiomes(new KList<>("land/plains", "cave/sulfur-flats")); @@ -133,7 +133,7 @@ public class IrisRegionCompatPoolTest { public void evaluateCompatDoesNotExcludeRegionThatNeverDeclaredLandBiomes() { PackCompatReport report = new PackCompatReport(); IrisData data = dataWith(report); - IrisRegion region = CompatFixtures.region("empty"); + IrisRegion region = PackCompatFixtures.region("empty"); region.setLoader(data); assertFalse(region.evaluateCompat(gate(report)).excluded()); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisSpawnerCompatTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisSpawnerCompatTest.java index 5d73e237f..d5dc42e95 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisSpawnerCompatTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisSpawnerCompatTest.java @@ -14,10 +14,10 @@ import org.junit.Test; import java.util.Map; -import static art.arcane.iris.engine.object.CompatFixtures.MISSING_ENTITY; -import static art.arcane.iris.engine.object.CompatFixtures.entity; -import static art.arcane.iris.engine.object.CompatFixtures.excludeEntity; -import static art.arcane.iris.engine.object.CompatFixtures.find; +import static art.arcane.iris.engine.object.PackCompatFixtures.MISSING_ENTITY; +import static art.arcane.iris.engine.object.PackCompatFixtures.entity; +import static art.arcane.iris.engine.object.PackCompatFixtures.excludeEntity; +import static art.arcane.iris.engine.object.PackCompatFixtures.find; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; @@ -30,7 +30,7 @@ import static org.mockito.Mockito.when; public class IrisSpawnerCompatTest { @SuppressWarnings("unchecked") private static IrisData dataWith(PackCompatReport report, IrisEntity... entities) { - IrisData data = CompatFixtures.data(report); + IrisData data = PackCompatFixtures.data(report); ResourceLoader entityLoader = mock(ResourceLoader.class); when(data.getEntityLoader()).thenReturn(entityLoader); for (IrisEntity entity : entities) { diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisStaticObjectLayerTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisStaticObjectLayerTest.java index a9920e649..89e2e6497 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisStaticObjectLayerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisStaticObjectLayerTest.java @@ -8,6 +8,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.math.IrisBlockVector; import art.arcane.iris.util.project.hunk.Hunk; import art.arcane.iris.util.project.matter.TileWrapper; @@ -19,6 +20,7 @@ import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterSlice; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.HashMap; @@ -40,6 +42,9 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class IrisStaticObjectLayerTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private final Map states = new HashMap<>(); private IrisData data; private ResourceLoader loader; diff --git a/core/src/test/java/art/arcane/iris/engine/object/NativeStructureObjectVetoTest.java b/core/src/test/java/art/arcane/iris/engine/object/NativeStructureObjectVetoTest.java index 368f731f4..9516d6306 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/NativeStructureObjectVetoTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/NativeStructureObjectVetoTest.java @@ -4,16 +4,14 @@ import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.engine.IrisComplex; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.NativeStructureVolume; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.common.math.Vector3i; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.math.RNG; -import org.junit.After; import org.junit.Before; +import org.junit.Rule; import org.junit.Test; import java.util.ArrayList; @@ -23,11 +21,13 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class NativeStructureObjectVetoTest { + @Rule + public final PlatformBinding platform = PlatformBinding.mockPlatform(); + private static final int SURFACE_Y = 80; private IrisData data; @@ -36,14 +36,6 @@ public class NativeStructureObjectVetoTest { @Before public void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - log = state("minecraft:oak_log", true); @SuppressWarnings("unchecked") ProceduralStream heightStream = mock(ProceduralStream.class); @@ -58,11 +50,6 @@ public class NativeStructureObjectVetoTest { when(data.getEngine()).thenReturn(engine); } - @After - public void unbindPlatform() { - IrisPlatforms.unbind(); - } - @Test public void objectPlacesWhenNoNativeStructureIsNear() { RecordingPlacer placer = new RecordingPlacer(engine); diff --git a/core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java b/core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java index d652bffe1..197a57553 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java +++ b/core/src/test/java/art/arcane/iris/engine/object/PackCompatFixtures.java @@ -17,11 +17,11 @@ import static org.mockito.Mockito.when; * Shared fixtures for the version-content pool cascade tests. The gate walker (lane L1) is not exercised here: the * tests stamp {@code compat} on a registrant directly, which is exactly what the walker stores. */ -final class CompatFixtures { +final class PackCompatFixtures { static final String MISSING_BLOCK = "minecraft:sulfur"; static final String MISSING_ENTITY = "minecraft:camel"; - private CompatFixtures() { + private PackCompatFixtures() { } static IrisData data(PackCompatReport report) { diff --git a/core/src/test/java/art/arcane/iris/engine/platform/EngineBukkitOpsDeferredMaterializationTest.java b/core/src/test/java/art/arcane/iris/engine/platform/EngineBukkitOpsDeferredMaterializationTest.java index 4c31403d5..09f6739f6 100644 --- a/core/src/test/java/art/arcane/iris/engine/platform/EngineBukkitOpsDeferredMaterializationTest.java +++ b/core/src/test/java/art/arcane/iris/engine/platform/EngineBukkitOpsDeferredMaterializationTest.java @@ -13,6 +13,7 @@ import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.IrisServices; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.scheduling.J; import art.arcane.iris.util.project.matter.TileWrapper; import art.arcane.iris.util.project.matter.slices.PreObjectMatterTest; @@ -30,6 +31,7 @@ import org.bukkit.Material; import org.bukkit.World; import org.bukkit.block.Block; import org.bukkit.block.data.BlockData; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.InOrder; import org.mockito.MockedStatic; @@ -59,6 +61,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class EngineBukkitOpsDeferredMaterializationTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test @SuppressWarnings("unchecked") public void savedMantlePlacementUsesCurrentProviderWithoutReadingCurrentMantle() { diff --git a/core/src/test/java/art/arcane/iris/spi/IrisLoggingTest.java b/core/src/test/java/art/arcane/iris/spi/IrisLoggingTest.java index 2e0bc1e0f..fb68e4b02 100644 --- a/core/src/test/java/art/arcane/iris/spi/IrisLoggingTest.java +++ b/core/src/test/java/art/arcane/iris/spi/IrisLoggingTest.java @@ -1,7 +1,9 @@ package art.arcane.iris.spi; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import java.util.ArrayList; @@ -24,6 +26,9 @@ import static org.mockito.Mockito.verify; * exactly one warning and would otherwise repeat per block, per sample or per chunk. */ public class IrisLoggingTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private final List levels = new ArrayList<>(); private final List messages = new ArrayList<>(); private IrisPlatform capturingPlatform; diff --git a/core/src/test/java/art/arcane/iris/spi/IrisPlatformsBindLifecycleTest.java b/core/src/test/java/art/arcane/iris/spi/IrisPlatformsBindLifecycleTest.java index 3daf3fdc5..e6ce100f0 100644 --- a/core/src/test/java/art/arcane/iris/spi/IrisPlatformsBindLifecycleTest.java +++ b/core/src/test/java/art/arcane/iris/spi/IrisPlatformsBindLifecycleTest.java @@ -1,7 +1,9 @@ package art.arcane.iris.spi; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import static org.junit.Assert.assertFalse; @@ -10,6 +12,9 @@ import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.mock; public class IrisPlatformsBindLifecycleTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void resetBinding() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/spi/IrisServicesTest.java b/core/src/test/java/art/arcane/iris/spi/IrisServicesTest.java index 735e24eba..96d9fabab 100644 --- a/core/src/test/java/art/arcane/iris/spi/IrisServicesTest.java +++ b/core/src/test/java/art/arcane/iris/spi/IrisServicesTest.java @@ -18,12 +18,17 @@ package art.arcane.iris.spi; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Test; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; public class IrisServicesTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void removeThenReregisterRebindsService() { Sample first = new Sample(); diff --git a/core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java b/core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java index 1bc432f93..471b3f27f 100644 --- a/core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java +++ b/core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java @@ -5,6 +5,9 @@ import org.bukkit.Material; import org.bukkit.Server; import org.bukkit.block.data.BlockData; import org.bukkit.plugin.PluginManager; +import org.junit.rules.TestRule; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; import org.mockito.invocation.InvocationOnMock; import java.util.Locale; @@ -18,6 +21,8 @@ import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.mock; public final class BukkitTestServer { + private static final String DEFAULT_NAME = "IrisTestServer"; + private static final String DEFAULT_VERSION = "1.0"; private static final Object LOCK = new Object(); private static volatile Server installed; @@ -46,9 +51,7 @@ public final class BukkitTestServer { Server server = mock(Server.class); doReturn(Logger.getLogger("IrisTest")).when(server).getLogger(); doReturn(mock(PluginManager.class)).when(server).getPluginManager(); - doReturn("IrisTestServer").when(server).getName(); - doReturn("1.0").when(server).getVersion(); - doReturn("1.0").when(server).getBukkitVersion(); + applyBranding(server, DEFAULT_NAME, DEFAULT_VERSION); doAnswer((InvocationOnMock invocation) -> blockData(invocation.getArgument(0, Material.class).name().toLowerCase(Locale.ROOT))) .when(server).createBlockData(any(Material.class)); doAnswer((InvocationOnMock invocation) -> blockData(invocation.getArgument(0, String.class))) @@ -67,13 +70,51 @@ public final class BukkitTestServer { } } - public static void brand(String name, String version) { - Server server = install(); + public static ServerBranding branding() { + return new ServerBranding(); + } + + private static void applyBranding(Server server, String name, String version) { doReturn(name).when(server).getName(); doReturn(version).when(server).getVersion(); doReturn(version).when(server).getBukkitVersion(); } + public static final class ServerBranding implements TestRule { + private boolean applied; + + private ServerBranding() { + } + + public void set(String name, String version) { + applyBranding(install(), name, version); + applied = true; + } + + @Override + public Statement apply(Statement base, Description description) { + return new Statement() { + @Override + public void evaluate() throws Throwable { + try { + base.evaluate(); + } finally { + restore(); + } + } + }; + } + + private void restore() { + if (!applied) { + return; + } + + applied = false; + applyBranding(install(), DEFAULT_NAME, DEFAULT_VERSION); + } + } + public static BlockData blockData(String key) { String canonical = key.indexOf(':') >= 0 ? key : "minecraft:" + key; BlockData data = mock(BlockData.class); diff --git a/core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java b/core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java new file mode 100644 index 000000000..ad5a7948d --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java @@ -0,0 +1,52 @@ +package art.arcane.iris.testsupport; + +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.IrisServices; + +import java.lang.reflect.Field; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.TreeSet; + +public final class IrisRuntimeState { + private static final Map, Object> SERVICES = services(); + + private IrisRuntimeState() { + } + + public static boolean platformBound() { + return IrisPlatforms.isBound(); + } + + public static List registeredServices() { + TreeSet names = new TreeSet<>(); + + for (Class type : SERVICES.keySet()) { + names.add(type.getName()); + } + + return Collections.unmodifiableList(new ArrayList<>(names)); + } + + public static void reset() { + IrisPlatforms.unbind(); + IrisServices.clear(); + } + + private static Map, Object> services() { + try { + Field field = IrisServices.class.getDeclaredField("SERVICES"); + field.setAccessible(true); + return castServices(field.get(null)); + } catch (ReflectiveOperationException e) { + throw new IllegalStateException("IrisServices no longer exposes its backing map to the test guard", e); + } + } + + @SuppressWarnings("unchecked") + private static Map, Object> castServices(Object value) { + return (Map, Object>) value; + } +} diff --git a/core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java b/core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java new file mode 100644 index 000000000..711ca4408 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java @@ -0,0 +1,99 @@ +package art.arcane.iris.testsupport; + +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.spi.PlatformRegistries; +import org.junit.rules.TestRule; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; + +import java.util.function.Supplier; + +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public final class PlatformBinding implements TestRule { + private final Supplier factory; + private IrisPlatform platform; + private PlatformRegistries registries; + private PlatformBlockState block; + + private PlatformBinding(Supplier factory) { + this.factory = factory; + } + + public static PlatformBinding mockPlatform() { + return new PlatformBinding(null); + } + + public static PlatformBinding of(Supplier factory) { + if (factory == null) { + throw new IllegalArgumentException("A platform factory is required"); + } + + return new PlatformBinding(factory); + } + + public IrisPlatform platform() { + if (platform == null) { + throw new IllegalStateException("The platform binding rule is not active"); + } + + return platform; + } + + public PlatformRegistries registries() { + if (registries == null) { + registries = platform().registries(); + } + + return registries; + } + + public PlatformBlockState block() { + if (block == null) { + block = registries().block("minecraft:stone"); + } + + return block; + } + + @Override + public Statement apply(Statement base, Description description) { + String scope = description.getDisplayName(); + + return new Statement() { + @Override + public void evaluate() throws Throwable { + PlatformLeakGuard.requireClean(scope, "start"); + bind(); + + try { + base.evaluate(); + } finally { + IrisPlatforms.unbind(); + platform = null; + registries = null; + block = null; + PlatformLeakGuard.requireClean(scope, "end"); + } + } + }; + } + + private void bind() { + if (factory == null) { + block = mock(PlatformBlockState.class); + registries = mock(PlatformRegistries.class); + when(registries.block(anyString())).thenReturn(block); + platform = mock(IrisPlatform.class); + when(platform.registries()).thenReturn(registries); + } else { + platform = factory.get(); + } + + IrisPlatforms.bind(platform); + } +} diff --git a/core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java b/core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java new file mode 100644 index 000000000..c27a5f76c --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java @@ -0,0 +1,64 @@ +package art.arcane.iris.testsupport; + +import org.junit.rules.TestRule; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; + +import java.util.List; + +public final class PlatformLeakGuard implements TestRule { + private PlatformLeakGuard() { + } + + public static PlatformLeakGuard clean() { + return new PlatformLeakGuard(); + } + + public static void requireClean(String scope, String phase) { + boolean bound = IrisRuntimeState.platformBound(); + List services = IrisRuntimeState.registeredServices(); + + if (!bound && services.isEmpty()) { + return; + } + + IrisRuntimeState.reset(); + throw new AssertionError(describe(scope, phase, bound, services)); + } + + @Override + public Statement apply(Statement base, Description description) { + String scope = description.getDisplayName(); + + return new Statement() { + @Override + public void evaluate() throws Throwable { + requireClean(scope, "start"); + + try { + base.evaluate(); + } finally { + requireClean(scope, "end"); + } + } + }; + } + + private static String describe(String scope, String phase, boolean bound, List services) { + StringBuilder message = new StringBuilder("Iris runtime state is dirty at ") + .append(phase) + .append(" of ") + .append(scope) + .append(':'); + + if (bound) { + message.append(" platform still bound;"); + } + + if (!services.isEmpty()) { + message.append(" services still registered ").append(services).append(';'); + } + + return message.toString(); + } +} diff --git a/core/src/test/java/art/arcane/iris/util/common/data/PlatformStateRebindTest.java b/core/src/test/java/art/arcane/iris/util/common/data/PlatformStateRebindTest.java index 42d7a216a..79acb8d45 100644 --- a/core/src/test/java/art/arcane/iris/util/common/data/PlatformStateRebindTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/data/PlatformStateRebindTest.java @@ -5,9 +5,11 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.hunk.view.ChunkDataHunkHolder; import org.bukkit.generator.ChunkGenerator; import org.junit.After; +import org.junit.ClassRule; import org.junit.Test; import java.lang.reflect.Field; @@ -24,6 +26,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class PlatformStateRebindTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + private static final List CONVERTED = List.of( "art.arcane.iris.engine.actuator.IrisDimensionStackActuator", "art.arcane.iris.engine.actuator.IrisTerrainNormalActuator", diff --git a/core/src/test/java/art/arcane/iris/util/common/director/DirectorAuthoringDataTest.java b/core/src/test/java/art/arcane/iris/util/common/director/DirectorAuthoringDataTest.java index bf00429cd..460293953 100644 --- a/core/src/test/java/art/arcane/iris/util/common/director/DirectorAuthoringDataTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/director/DirectorAuthoringDataTest.java @@ -6,6 +6,8 @@ import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -28,6 +30,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class DirectorAuthoringDataTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public final TemporaryFolder temporary = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java b/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java index c74a36807..17d2b837b 100644 --- a/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/director/specialhandlers/StructureHandlerTest.java @@ -17,8 +17,10 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformStructureHooks; import art.arcane.iris.spi.PlatformWorld; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; +import org.junit.ClassRule; import org.junit.Test; import java.util.LinkedHashSet; @@ -36,6 +38,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class StructureHandlerTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void registeredEligibilityMatchesFindExecutionTruthTable() { IrisNativeStructureDecision replacement = decision(NativeStructureGenerationStatus.REPLACED_BY_IRIS); diff --git a/core/src/test/java/art/arcane/iris/util/common/misc/WebCacheTest.java b/core/src/test/java/art/arcane/iris/util/common/misc/WebCacheTest.java index ab243ae9f..94b4b2bcb 100644 --- a/core/src/test/java/art/arcane/iris/util/common/misc/WebCacheTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/misc/WebCacheTest.java @@ -2,11 +2,13 @@ package art.arcane.iris.util.common.misc; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.volmlib.util.io.IO; import com.sun.net.httpserver.HttpExchange; import com.sun.net.httpserver.HttpServer; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -34,6 +36,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class WebCacheTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temp = new TemporaryFolder(); diff --git a/core/src/test/java/art/arcane/iris/util/common/scheduling/JHybridPlatformTest.java b/core/src/test/java/art/arcane/iris/util/common/scheduling/JHybridPlatformTest.java index 6d97dfe0d..795f67b0a 100644 --- a/core/src/test/java/art/arcane/iris/util/common/scheduling/JHybridPlatformTest.java +++ b/core/src/test/java/art/arcane/iris/util/common/scheduling/JHybridPlatformTest.java @@ -3,8 +3,10 @@ package art.arcane.iris.util.common.scheduling; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformScheduler; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Test; import static org.junit.Assert.assertNotEquals; @@ -17,6 +19,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class JHybridPlatformTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Before public void clearPlatform() { IrisPlatforms.unbind(); diff --git a/core/src/test/java/art/arcane/iris/util/project/context/ChunkContextPrefillPlanTest.java b/core/src/test/java/art/arcane/iris/util/project/context/ChunkContextPrefillPlanTest.java index a2eb3aea0..2cb834bc8 100644 --- a/core/src/test/java/art/arcane/iris/util/project/context/ChunkContextPrefillPlanTest.java +++ b/core/src/test/java/art/arcane/iris/util/project/context/ChunkContextPrefillPlanTest.java @@ -5,8 +5,10 @@ import art.arcane.iris.engine.hydrology.runtime.IrisHydrologyRuntime; import art.arcane.iris.engine.object.IrisBiome; import art.arcane.iris.engine.object.IrisRegion; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.stream.ProceduralStream; import org.bukkit.block.data.BlockData; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -29,6 +31,9 @@ import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; public class ChunkContextPrefillPlanTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void noCavePrefillSkipsCaveCacheFill() { AtomicInteger caveCalls = new AtomicInteger(); diff --git a/core/src/test/java/art/arcane/iris/util/project/matter/slices/IrisMatterPlatformSelectionTest.java b/core/src/test/java/art/arcane/iris/util/project/matter/slices/IrisMatterPlatformSelectionTest.java index 0b1323d0c..5e4964ebb 100644 --- a/core/src/test/java/art/arcane/iris/util/project/matter/slices/IrisMatterPlatformSelectionTest.java +++ b/core/src/test/java/art/arcane/iris/util/project/matter/slices/IrisMatterPlatformSelectionTest.java @@ -2,7 +2,9 @@ package art.arcane.iris.util.project.matter.slices; import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.bukkit.World; +import org.junit.ClassRule; import org.junit.Test; import static org.junit.Assert.assertNotNull; @@ -11,6 +13,9 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; public class IrisMatterPlatformSelectionTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void hybridClasspathDoesNotEnableBukkitMatterIoForModdedPlatform() { IrisPlatform platform = mock(IrisPlatform.class); From c75b0e01af70b919f07fc1064e2be1f4b37935bb Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:37:18 -0400 Subject: [PATCH 04/35] Resolve test paths from code source - Add the ProjectPaths test helper that derives the module root from the test class code source and the repository root from the settings file above it - Replace the working-directory-relative source and resource literals in thirty-five test classes with module and repository lookups - Drop the bespoke source-root walk in PregenMantleCleanupContractTest --- .../arcane/iris/testsupport/ProjectPaths.java | 81 +++++++++++++++++++ .../ModdedMessageContributorTest.java | 3 +- .../iris/modded/testsupport/ProjectPaths.java | 81 +++++++++++++++++++ .../IrisDownloadValidationTest.java | 3 +- .../localization/IrisLanguageEditorTest.java | 5 +- .../core/localization/IrisLanguageTest.java | 5 +- .../arcane/iris/testsupport/ProjectPaths.java | 81 +++++++++++++++++++ 7 files changed, 253 insertions(+), 6 deletions(-) create mode 100644 adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java create mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java create mode 100644 core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java new file mode 100644 index 000000000..c63903367 --- /dev/null +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java @@ -0,0 +1,81 @@ +package art.arcane.iris.testsupport; + +import java.io.File; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.security.CodeSource; +import java.security.ProtectionDomain; + +public final class ProjectPaths { + private static final Path MODULE_ROOT = resolveModuleRoot(); + private static final Path REPOSITORY_ROOT = resolveRepositoryRoot(MODULE_ROOT); + + private ProjectPaths() { + } + + public static Path moduleRoot() { + return MODULE_ROOT; + } + + public static Path repositoryRoot() { + return REPOSITORY_ROOT; + } + + public static Path moduleFile(String relative) { + return MODULE_ROOT.resolve(relative).normalize(); + } + + public static Path repositoryFile(String relative) { + return REPOSITORY_ROOT.resolve(relative).normalize(); + } + + public static File moduleFileAt(String relative) { + return moduleFile(relative).toFile(); + } + + public static File repositoryFileAt(String relative) { + return repositoryFile(relative).toFile(); + } + + private static Path resolveModuleRoot() { + ProtectionDomain domain = ProjectPaths.class.getProtectionDomain(); + CodeSource source = domain == null ? null : domain.getCodeSource(); + URL location = source == null ? null : source.getLocation(); + + if (location != null) { + try { + Path current = Path.of(location.toURI()).toAbsolutePath().normalize(); + + while (current != null) { + Path name = current.getFileName(); + + if (name != null && "build".equals(name.toString()) && current.getParent() != null) { + return current.getParent(); + } + + current = current.getParent(); + } + } catch (URISyntaxException | IllegalArgumentException ignored) { + return Path.of("").toAbsolutePath().normalize(); + } + } + + return Path.of("").toAbsolutePath().normalize(); + } + + private static Path resolveRepositoryRoot(Path moduleRoot) { + Path current = moduleRoot; + + while (current != null) { + if (Files.isRegularFile(current.resolve("settings.gradle"))) { + return current; + } + + current = current.getParent(); + } + + return moduleRoot; + } +} diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java index 634ca6702..55a0038a5 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java @@ -2,6 +2,7 @@ package art.arcane.iris.modded.localization; import art.arcane.iris.core.localization.IrisLanguage; import art.arcane.iris.core.localization.IrisMessages; +import art.arcane.iris.modded.testsupport.ProjectPaths; import art.arcane.volmlib.util.localization.MessageKey; import art.arcane.volmlib.util.localization.VolmitLocales; import com.google.gson.JsonObject; @@ -27,7 +28,7 @@ public class ModdedMessageContributorTest { @Test public void completeLoaderCatalogStillMatchesEveryDownloadableLocale() throws Exception { - Path sourceRoot = Path.of("../../core/src/main/resources/languages"); + Path sourceRoot = ProjectPaths.repositoryFile("core/src/main/resources/languages"); for (String locale : VolmitLocales.nonEnglish()) { JsonObject document = JsonParser.parseString(Files.readString(sourceRoot.resolve(locale + ".json"))) .getAsJsonObject(); diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java new file mode 100644 index 000000000..8fb746e94 --- /dev/null +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java @@ -0,0 +1,81 @@ +package art.arcane.iris.modded.testsupport; + +import java.io.File; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.security.CodeSource; +import java.security.ProtectionDomain; + +public final class ProjectPaths { + private static final Path MODULE_ROOT = resolveModuleRoot(); + private static final Path REPOSITORY_ROOT = resolveRepositoryRoot(MODULE_ROOT); + + private ProjectPaths() { + } + + public static Path moduleRoot() { + return MODULE_ROOT; + } + + public static Path repositoryRoot() { + return REPOSITORY_ROOT; + } + + public static Path moduleFile(String relative) { + return MODULE_ROOT.resolve(relative).normalize(); + } + + public static Path repositoryFile(String relative) { + return REPOSITORY_ROOT.resolve(relative).normalize(); + } + + public static File moduleFileAt(String relative) { + return moduleFile(relative).toFile(); + } + + public static File repositoryFileAt(String relative) { + return repositoryFile(relative).toFile(); + } + + private static Path resolveModuleRoot() { + ProtectionDomain domain = ProjectPaths.class.getProtectionDomain(); + CodeSource source = domain == null ? null : domain.getCodeSource(); + URL location = source == null ? null : source.getLocation(); + + if (location != null) { + try { + Path current = Path.of(location.toURI()).toAbsolutePath().normalize(); + + while (current != null) { + Path name = current.getFileName(); + + if (name != null && "build".equals(name.toString()) && current.getParent() != null) { + return current.getParent(); + } + + current = current.getParent(); + } + } catch (URISyntaxException | IllegalArgumentException ignored) { + return Path.of("").toAbsolutePath().normalize(); + } + } + + return Path.of("").toAbsolutePath().normalize(); + } + + private static Path resolveRepositoryRoot(Path moduleRoot) { + Path current = moduleRoot; + + while (current != null) { + if (Files.isRegularFile(current.resolve("settings.gradle"))) { + return current; + } + + current = current.getParent(); + } + + return moduleRoot; + } +} diff --git a/core/src/test/java/art/arcane/iris/core/localization/IrisDownloadValidationTest.java b/core/src/test/java/art/arcane/iris/core/localization/IrisDownloadValidationTest.java index 84251d6a7..d6b6d71e7 100644 --- a/core/src/test/java/art/arcane/iris/core/localization/IrisDownloadValidationTest.java +++ b/core/src/test/java/art/arcane/iris/core/localization/IrisDownloadValidationTest.java @@ -1,5 +1,6 @@ package art.arcane.iris.core.localization; +import art.arcane.iris.testsupport.ProjectPaths; import art.arcane.volmlib.util.localization.LocaleOverlay; import art.arcane.volmlib.util.localization.LocalizationValidator; import art.arcane.volmlib.util.localization.RemoteLanguageCatalog; @@ -111,7 +112,7 @@ public class IrisDownloadValidationTest { } private String completeCatalog() throws IOException { - return Files.readString(Path.of("src/main/resources/languages", LOCALE + ".json")); + return Files.readString(ProjectPaths.moduleFile("src/main/resources/languages").resolve(LOCALE + ".json")); } private String incompleteCatalog(String complete) { diff --git a/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageEditorTest.java b/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageEditorTest.java index ba2314ac6..94d8222b4 100644 --- a/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageEditorTest.java +++ b/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageEditorTest.java @@ -1,5 +1,6 @@ package art.arcane.iris.core.localization; +import art.arcane.iris.testsupport.ProjectPaths; import art.arcane.volmlib.util.localization.LocalizationCandidate; import art.arcane.volmlib.util.localization.LocalizationSnapshot; import art.arcane.volmlib.util.localization.PluginLanguageEditor; @@ -49,7 +50,7 @@ public class IrisLanguageEditorTest { assertTrue(IrisLanguage.reload(directory, "en_US")); Path cache = IrisLanguage.remote(directory).cacheFile("fr_FR"); Files.createDirectories(cache.getParent()); - Files.copy(Path.of("src/main/resources/languages/fr_FR.json"), cache); + Files.copy(ProjectPaths.moduleFile("src/main/resources/languages/fr_FR.json"), cache); PluginLanguageEditor.Options options = IrisLanguage.editorOptions(); LocalizationSnapshot english = LocalizationSnapshot.create( LocalizationCandidate.english(IrisLanguage.catalog(), PluralSelector.oneOther())); @@ -106,7 +107,7 @@ public class IrisLanguageEditorTest { @Test public void incompleteDownloadedLocaleCanBeEditedWithoutBeingSelected() throws Exception { - byte[] complete = Files.readAllBytes(Path.of("src/main/resources/languages/fr_FR.json")); + byte[] complete = Files.readAllBytes(ProjectPaths.moduleFile("src/main/resources/languages/fr_FR.json")); AtomicInteger requests = new AtomicInteger(); Field remoteField = IrisLanguage.class.getDeclaredField("remote"); remoteField.setAccessible(true); diff --git a/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageTest.java b/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageTest.java index 79425b4c2..8b43f25cc 100644 --- a/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageTest.java +++ b/core/src/test/java/art/arcane/iris/core/localization/IrisLanguageTest.java @@ -1,6 +1,7 @@ package art.arcane.iris.core.localization; import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.testsupport.ProjectPaths; import art.arcane.volmlib.util.localization.MessageArgument; import art.arcane.volmlib.util.localization.LocaleOverlay; import art.arcane.volmlib.util.localization.LocalizationValidationResult; @@ -117,7 +118,7 @@ public class IrisLanguageTest { for (String locale : VolmitLocales.nonEnglish()) { Path target = IrisLanguage.remote(dataFolder).cacheFile(locale); Files.createDirectories(target.getParent()); - Files.copy(Path.of("src/main/resources/languages", locale + ".json"), target, StandardCopyOption.REPLACE_EXISTING); + Files.copy(ProjectPaths.moduleFile("src/main/resources/languages").resolve(locale + ".json"), target, StandardCopyOption.REPLACE_EXISTING); } } @@ -127,7 +128,7 @@ public class IrisLanguageTest { } private LocaleOverlay loadSourceOverlay(String locale) throws Exception { - Path source = Path.of("src/main/resources/languages", locale + ".json"); + Path source = ProjectPaths.moduleFile("src/main/resources/languages").resolve(locale + ".json"); return IrisLanguage.parseDownloadedOverlay(source.toString(), locale, Files.readString(source)); } diff --git a/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java new file mode 100644 index 000000000..c63903367 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java @@ -0,0 +1,81 @@ +package art.arcane.iris.testsupport; + +import java.io.File; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.security.CodeSource; +import java.security.ProtectionDomain; + +public final class ProjectPaths { + private static final Path MODULE_ROOT = resolveModuleRoot(); + private static final Path REPOSITORY_ROOT = resolveRepositoryRoot(MODULE_ROOT); + + private ProjectPaths() { + } + + public static Path moduleRoot() { + return MODULE_ROOT; + } + + public static Path repositoryRoot() { + return REPOSITORY_ROOT; + } + + public static Path moduleFile(String relative) { + return MODULE_ROOT.resolve(relative).normalize(); + } + + public static Path repositoryFile(String relative) { + return REPOSITORY_ROOT.resolve(relative).normalize(); + } + + public static File moduleFileAt(String relative) { + return moduleFile(relative).toFile(); + } + + public static File repositoryFileAt(String relative) { + return repositoryFile(relative).toFile(); + } + + private static Path resolveModuleRoot() { + ProtectionDomain domain = ProjectPaths.class.getProtectionDomain(); + CodeSource source = domain == null ? null : domain.getCodeSource(); + URL location = source == null ? null : source.getLocation(); + + if (location != null) { + try { + Path current = Path.of(location.toURI()).toAbsolutePath().normalize(); + + while (current != null) { + Path name = current.getFileName(); + + if (name != null && "build".equals(name.toString()) && current.getParent() != null) { + return current.getParent(); + } + + current = current.getParent(); + } + } catch (URISyntaxException | IllegalArgumentException ignored) { + return Path.of("").toAbsolutePath().normalize(); + } + } + + return Path.of("").toAbsolutePath().normalize(); + } + + private static Path resolveRepositoryRoot(Path moduleRoot) { + Path current = moduleRoot; + + while (current != null) { + if (Files.isRegularFile(current.resolve("settings.gradle"))) { + return current; + } + + current = current.getParent(); + } + + return moduleRoot; + } +} From 42798c634071b3765b7001cfe6a7a791d03193fa Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:45:08 -0400 Subject: [PATCH 05/35] Poll instead of sleeping - Add the Await test helper that polls a condition every ten milliseconds under a bounded timeout - Replace every Thread.sleep in the fourteen polling test classes with a condition wait, a latch wait or a bounded quiet window - Keep the crash-consistency fsync interception in GenerationHistoryAdmissionTest and SavedBiomeStoreBatchTest on real barriers --- .../NativeStructureVolumeIndexTest.java | 3 +- .../iris/core/SettingsHotloadWatchTest.java | 70 ++++++++----------- .../core/gui/NoiseRenderCoordinatorTest.java | 8 ++- .../core/gui/VisionRenderControllerTest.java | 19 ++--- .../core/pack/PackDownloadExecutionTest.java | 3 +- .../IrisEngineGenerationRuntimeScopeTest.java | 36 +++------- .../WorldChunkMaintenanceRoutingTest.java | 36 ++-------- .../history/GenerationAdmissionTest.java | 17 +++-- .../GenerationHistoryAdmissionTest.java | 37 +++++----- .../engine/history/SavedBiomeRuntimeTest.java | 21 +++--- .../history/SavedBiomeStoreBatchTest.java | 8 +-- .../hydrology/HydrologyTileCacheTest.java | 26 +++---- .../MatterGeneratorConcurrencyTest.java | 26 +++---- ...risDimensionCarvingResolverParityTest.java | 16 +++-- .../art/arcane/iris/testsupport/Await.java | 41 +++++++++++ 15 files changed, 174 insertions(+), 193 deletions(-) create mode 100644 core/src/test/java/art/arcane/iris/testsupport/Await.java diff --git a/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeStructureVolumeIndexTest.java b/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeStructureVolumeIndexTest.java index 84f07324d..50ad1b4c1 100644 --- a/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeStructureVolumeIndexTest.java +++ b/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeStructureVolumeIndexTest.java @@ -32,6 +32,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.locks.LockSupport; import java.util.function.IntConsumer; import static org.junit.Assert.assertEquals; @@ -218,7 +219,7 @@ public class NativeStructureVolumeIndexTest { if (cleared) { break; } - Thread.sleep(1); + LockSupport.parkNanos(TimeUnit.MILLISECONDS.toNanos(10L)); } assertTrue("Origin eviction did not complete before the query cache lock", cleared); resolver.release(); diff --git a/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java b/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java index af1f73860..8547a18ce 100644 --- a/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java +++ b/core/src/test/java/art/arcane/iris/core/SettingsHotloadWatchTest.java @@ -2,8 +2,10 @@ package art.arcane.iris.core; import art.arcane.iris.core.localization.IrisLanguage; import art.arcane.iris.core.localization.IrisMessages; +import art.arcane.iris.testsupport.Await; import art.arcane.volmlib.util.hotload.ConfigHotloadEngine; import art.arcane.volmlib.util.localization.MessageArgument; +import java.time.Duration; import org.junit.After; import org.junit.Before; import org.junit.Rule; @@ -213,12 +215,12 @@ public class SettingsHotloadWatchTest { assertEquals(1, automaticApplies.get()); Files.writeString(override.toPath(), locale("en_US", "Manual {permission}"), StandardCharsets.UTF_8); - pollFor(125L); + pollWithoutChange(125L, "First " + PERMISSION); assertEquals("First " + PERMISSION, permissionMessage()); assertTrue(IrisLanguage.reload(dataFolder, "en_US")); assertEquals("Manual " + PERMISSION, permissionMessage()); - pollFor(650L); + pollWithoutChange(650L, "Manual " + PERMISSION); assertEquals(1, automaticApplies.get()); assertEquals("Manual " + PERMISSION, permissionMessage()); } @@ -254,15 +256,11 @@ public class SettingsHotloadWatchTest { assertEquals("Active " + PERMISSION, permissionMessage()); } - private void awaitPermissionMessage(String expected) throws Exception { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(6L); - while (System.nanoTime() < deadline) { + private void awaitPermissionMessage(String expected) { + Await.reached("the hotload permission message '" + expected + "'", Duration.ofSeconds(6L), () -> { watch.checkConfigHotload(); - if (expected.equals(permissionMessage())) { - return; - } - Thread.sleep(25L); - } + return expected.equals(permissionMessage()); + }); assertEquals(expected, permissionMessage()); } @@ -275,31 +273,24 @@ public class SettingsHotloadWatchTest { } private void checkUntilEntered(CountDownLatch entered) { - try { - while (entered.getCount() > 0L) { - watch.checkConfigHotload(); - Thread.sleep(10L); - } - } catch (InterruptedException failure) { - Thread.currentThread().interrupt(); - throw new IllegalStateException("Interrupted while waiting for a hotload snapshot", failure); - } + Await.until("the hotload apply boundary", Duration.ofSeconds(5L), () -> { + watch.checkConfigHotload(); + return entered.getCount() == 0L; + }); } - private void awaitThreadState(Thread thread, Thread.State expected) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(1L); - while (System.nanoTime() < deadline && thread.getState() != expected) { - Thread.sleep(5L); - } + private void awaitThreadState(Thread thread, Thread.State expected) { + Await.reached(thread.getName() + " to reach " + expected, Duration.ofSeconds(1L), + () -> thread.getState() == expected); assertEquals(expected, thread.getState()); } - private void pollFor(long durationMillis) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(durationMillis); - while (System.nanoTime() < deadline) { - watch.checkConfigHotload(); - Thread.sleep(25L); - } + private void pollWithoutChange(long windowMillis, String expected) { + assertFalse("The hotload permission message changed inside the quiet window", + Await.reached("an unexpected hotload apply", Duration.ofMillis(windowMillis), () -> { + watch.checkConfigHotload(); + return !expected.equals(permissionMessage()); + })); } private String captureErrorsWhilePolling(String expected, long duplicateWindowMillis) throws Exception { @@ -307,20 +298,17 @@ public class SettingsHotloadWatchTest { ByteArrayOutputStream captured = new ByteArrayOutputStream(); try (PrintStream capture = new PrintStream(captured, true, StandardCharsets.UTF_8)) { System.setErr(capture); - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(4L); - while (!captured.toString(StandardCharsets.UTF_8).contains(expected)) { - if (System.nanoTime() >= deadline) { - fail("Timed out after 4000ms waiting for the hotload diagnostic '" + expected - + "'; captured stderr was: " + captured.toString(StandardCharsets.UTF_8)); - } + if (!Await.reached("the hotload diagnostic '" + expected + "'", Duration.ofSeconds(4L), () -> { watch.checkConfigHotload(); - Thread.sleep(10L); + return captured.toString(StandardCharsets.UTF_8).contains(expected); + })) { + fail("Timed out after 4000ms waiting for the hotload diagnostic '" + expected + + "'; captured stderr was: " + captured.toString(StandardCharsets.UTF_8)); } - long duplicateDeadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(duplicateWindowMillis); - while (System.nanoTime() < duplicateDeadline) { + Await.reached("a duplicate hotload diagnostic", Duration.ofMillis(duplicateWindowMillis), () -> { watch.checkConfigHotload(); - Thread.sleep(10L); - } + return false; + }); } finally { System.setErr(originalError); } diff --git a/core/src/test/java/art/arcane/iris/core/gui/NoiseRenderCoordinatorTest.java b/core/src/test/java/art/arcane/iris/core/gui/NoiseRenderCoordinatorTest.java index c24d40edc..437e330c1 100644 --- a/core/src/test/java/art/arcane/iris/core/gui/NoiseRenderCoordinatorTest.java +++ b/core/src/test/java/art/arcane/iris/core/gui/NoiseRenderCoordinatorTest.java @@ -133,6 +133,8 @@ public final class NoiseRenderCoordinatorTest { AtomicReference failure = new AtomicReference<>(); AtomicReference samplingThread = new AtomicReference<>(); AtomicBoolean sampledOnEdt = new AtomicBoolean(); + AtomicBoolean renderFinished = new AtomicBoolean(); + CountDownLatch sampledAfterCompletion = new CountDownLatch(1); AtomicInteger samples = new AtomicInteger(); NoiseRenderCoordinator coordinator = new NoiseRenderCoordinator(2, new NoiseRenderCoordinator.Listener() { @Override @@ -154,6 +156,9 @@ public final class NoiseRenderCoordinatorTest { try { NoiseProvider sampler = (x, z) -> { samples.incrementAndGet(); + if (renderFinished.get()) { + sampledAfterCompletion.countDown(); + } samplingThread.compareAndSet(null, Thread.currentThread().getName()); sampledOnEdt.compareAndSet(false, SwingUtilities.isEventDispatchThread()); return x + z; @@ -177,7 +182,8 @@ public final class NoiseRenderCoordinatorTest { assertFalse(sampledOnEdt.get()); assertTrue(samplingThread.get().startsWith("Iris Noise Renderer")); int completedSamples = samples.get(); - Thread.sleep(150L); + renderFinished.set(true); + assertFalse(sampledAfterCompletion.await(150L, TimeUnit.MILLISECONDS)); assertEquals(completedSamples, samples.get()); } finally { coordinator.close(); diff --git a/core/src/test/java/art/arcane/iris/core/gui/VisionRenderControllerTest.java b/core/src/test/java/art/arcane/iris/core/gui/VisionRenderControllerTest.java index 14e63055e..ef4dbe6c2 100644 --- a/core/src/test/java/art/arcane/iris/core/gui/VisionRenderControllerTest.java +++ b/core/src/test/java/art/arcane/iris/core/gui/VisionRenderControllerTest.java @@ -2,9 +2,11 @@ package art.arcane.iris.core.gui; import art.arcane.iris.engine.framework.render.IrisRenderer; import art.arcane.iris.engine.framework.render.RenderType; +import art.arcane.iris.testsupport.Await; import org.junit.Test; import java.awt.image.BufferedImage; +import java.time.Duration; import java.util.HashSet; import java.util.List; import java.util.Set; @@ -86,7 +88,8 @@ public class VisionRenderControllerTest { VisionRenderController.RenderSpec spec = spec(renderer, RenderType.BIOME, 1L, 0D, 0D, 4D, 128, 128); try { VisionRenderController.Frame first = controller.request(spec); - assertTrue(await(() -> controller.progress(first).ready() == controller.progress(first).total(), 2_000L)); + Await.until("the first render to report every tile ready", Duration.ofSeconds(2L), + () -> controller.progress(first).ready() == controller.progress(first).total()); int rendered = calls.get(); VisionRenderController.Frame cached = controller.request(spec); @@ -108,7 +111,8 @@ public class VisionRenderControllerTest { VisionRenderController controller = controller(2); try { VisionRenderController.Frame first = controller.request(spec(renderer, RenderType.BIOME, 1L, 16D, 16D, 4D, 128, 128)); - assertTrue(await(() -> controller.progress(first).ready() == controller.progress(first).total(), 2_000L)); + Await.until("the first render to report every tile ready", Duration.ofSeconds(2L), + () -> controller.progress(first).ready() == controller.progress(first).total()); Set firstKeys = keys(first); VisionRenderController.Frame panned = controller.request(spec(renderer, RenderType.BIOME, 1L, 20D, 20D, 4D, 128, 128)); @@ -249,15 +253,4 @@ public class VisionRenderControllerTest { height ); } - - private static boolean await(BooleanSupplier condition, long timeoutMillis) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(timeoutMillis); - while (System.nanoTime() < deadline) { - if (condition.getAsBoolean()) { - return true; - } - Thread.sleep(5L); - } - return condition.getAsBoolean(); - } } diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackDownloadExecutionTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackDownloadExecutionTest.java index 79426f240..8d321a75b 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackDownloadExecutionTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackDownloadExecutionTest.java @@ -61,11 +61,12 @@ public class PackDownloadExecutionTest { public void cancellationInterruptsRunningWorkOutsidePublication() throws Exception { LifecycleOperationCoordinator.Lease lease = mock(LifecycleOperationCoordinator.Lease.class); CountDownLatch started = new CountDownLatch(1); + CountDownLatch neverReleased = new CountDownLatch(1); AtomicBoolean interrupted = new AtomicBoolean(); PackDownloadExecution execution = new PackDownloadExecution(lease, cancellation -> { started.countDown(); try { - Thread.sleep(TimeUnit.SECONDS.toMillis(30L)); + neverReleased.await(30L, TimeUnit.SECONDS); } catch (InterruptedException exception) { interrupted.set(true); Thread.currentThread().interrupt(); diff --git a/core/src/test/java/art/arcane/iris/engine/IrisEngineGenerationRuntimeScopeTest.java b/core/src/test/java/art/arcane/iris/engine/IrisEngineGenerationRuntimeScopeTest.java index af5ffa731..5124af86e 100644 --- a/core/src/test/java/art/arcane/iris/engine/IrisEngineGenerationRuntimeScopeTest.java +++ b/core/src/test/java/art/arcane/iris/engine/IrisEngineGenerationRuntimeScopeTest.java @@ -7,6 +7,8 @@ import art.arcane.iris.engine.framework.BiomeEnvironment; import art.arcane.iris.engine.history.SavedBiomeRuntime; import art.arcane.iris.engine.history.SavedBiomeUnavailableException; import art.arcane.iris.engine.object.IrisRegion; +import art.arcane.iris.testsupport.Await; +import art.arcane.iris.testsupport.PlatformBinding; import java.util.Optional; import java.util.concurrent.TimeUnit; import art.arcane.iris.engine.framework.EngineMode; @@ -27,23 +29,19 @@ import art.arcane.iris.engine.object.IrisDimensionCarvingEntry; import art.arcane.iris.engine.object.IrisDimensionCarvingResolver; import art.arcane.iris.engine.object.IrisRange; import art.arcane.iris.engine.object.IrisWorld; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; import art.arcane.iris.util.common.parallel.MultiBurst; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.context.IrisContext; import art.arcane.iris.util.project.noise.CNG; import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.collection.KList; +import org.junit.ClassRule; import org.junit.Test; -import org.junit.AfterClass; -import org.junit.BeforeClass; import java.io.IOException; import java.lang.reflect.Field; import java.nio.file.Path; +import java.time.Duration; import java.util.Collections; import java.util.IdentityHashMap; import java.util.Map; @@ -65,7 +63,6 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.CALLS_REAL_METHODS; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.anyInt; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.doCallRealMethod; @@ -78,21 +75,8 @@ import static org.mockito.Mockito.verifyNoInteractions; import static org.mockito.Mockito.when; public class IrisEngineGenerationRuntimeScopeTest { - @BeforeClass - public static void bindPlatform() { - IrisPlatforms.unbind(); - PlatformBlockState block = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(registries.block(anyString())).thenReturn(block); - IrisPlatform platform = mock(IrisPlatform.class); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void unbindPlatform() { - IrisPlatforms.unbind(); - } + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); @Test public void carvingResolverRestoresNestedRuntimeDefinitions() throws Exception { @@ -878,11 +862,9 @@ public class IrisEngineGenerationRuntimeScopeTest { return router; } - private static void awaitBlocked(Thread thread) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (thread.getState() != Thread.State.BLOCKED && thread.isAlive() && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + private static void awaitBlocked(Thread thread) { + Await.reached("the reader to block on the engine lifecycle lock", Duration.ofSeconds(5L), + () -> thread.getState() == Thread.State.BLOCKED || !thread.isAlive()); assertEquals(Thread.State.BLOCKED, thread.getState()); } diff --git a/core/src/test/java/art/arcane/iris/engine/WorldChunkMaintenanceRoutingTest.java b/core/src/test/java/art/arcane/iris/engine/WorldChunkMaintenanceRoutingTest.java index 16d8e2fdd..5882becd5 100644 --- a/core/src/test/java/art/arcane/iris/engine/WorldChunkMaintenanceRoutingTest.java +++ b/core/src/test/java/art/arcane/iris/engine/WorldChunkMaintenanceRoutingTest.java @@ -6,10 +6,8 @@ import art.arcane.iris.engine.history.GenerationHistoryRuntimeRouter.SavedChunkM import art.arcane.iris.engine.mantle.EngineMantle; import art.arcane.iris.engine.platform.EngineBukkitOps; import art.arcane.iris.spi.IrisLogging; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.Await; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.mantle.flag.MantleFlag; import art.arcane.volmlib.util.mantle.runtime.Mantle; @@ -17,13 +15,13 @@ import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import org.bukkit.Chunk; import org.bukkit.World; +import org.junit.ClassRule; import org.junit.Test; -import org.junit.AfterClass; -import org.junit.BeforeClass; import org.mockito.InOrder; import org.mockito.MockedStatic; import java.lang.reflect.Field; +import java.time.Duration; import java.util.ArrayDeque; import java.util.Map; import java.util.Optional; @@ -52,26 +50,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class WorldChunkMaintenanceRoutingTest { - private static IrisPlatform previousPlatform; + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); - @BeforeClass - public static void bindPlatform() { - previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; - IrisPlatforms.unbind(); - IrisPlatform platform = mock(IrisPlatform.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - when(platform.registries()).thenReturn(registries); - when(registries.block(anyString())).thenReturn(mock(PlatformBlockState.class)); - IrisPlatforms.bind(platform); - } - - @AfterClass - public static void restorePlatform() { - IrisPlatforms.unbind(); - if (previousPlatform != null) { - IrisPlatforms.bind(previousPlatform); - } - } @Test public void materializesTheSavedOwnerAndKeepsSpawningAfterCompletion() throws Exception { @@ -372,10 +353,7 @@ public class WorldChunkMaintenanceRoutingTest { private void awaitRelease() throws InterruptedException { assertTrue("Saved mantle handle was not released", released.tryAcquire(5L, TimeUnit.SECONDS)); - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (!pending.isEmpty() && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + Await.reached("the saved mantle cleanup to finish", Duration.ofSeconds(5L), pending::isEmpty); assertTrue("Saved mantle cleanup did not finish", pending.isEmpty()); } diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationAdmissionTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationAdmissionTest.java index 4ce8a7b10..08754886e 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationAdmissionTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationAdmissionTest.java @@ -1,10 +1,12 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.Await; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; import java.nio.file.Path; +import java.time.Duration; import java.util.ArrayList; import java.util.List; import java.util.concurrent.CompletableFuture; @@ -14,6 +16,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.FutureTask; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import static org.junit.Assert.assertEquals; @@ -38,7 +41,7 @@ public class GenerationAdmissionTest { }); assertTrue(requested.await(5L, TimeUnit.SECONDS)); - Thread.sleep(100L); + assertThrows(TimeoutException.class, () -> cutover.get(100L, TimeUnit.MILLISECONDS)); assertFalse(cutover.isDone()); stage.close(); cutover.get(5L, TimeUnit.SECONDS); @@ -246,12 +249,14 @@ public class GenerationAdmissionTest { } } - private static void awaitWaiting(Thread thread) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (thread.getState() != Thread.State.WAITING && System.nanoTime() < deadline) { + private static void awaitWaiting(Thread thread) { + Await.reached("the generation operation to reach the admission gate", Duration.ofSeconds(5L), () -> { + if (thread.getState() == Thread.State.WAITING) { + return true; + } assertTrue("Generation operation completed before reaching the admission gate.", thread.isAlive()); - Thread.sleep(1L); - } + return false; + }); assertEquals("Generation operation did not reach the admission gate.", Thread.State.WAITING, thread.getState()); } diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryAdmissionTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryAdmissionTest.java index fb75e2fac..e3f8d4bd2 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryAdmissionTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryAdmissionTest.java @@ -1,5 +1,6 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.Await; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -13,6 +14,7 @@ import java.nio.channels.FileChannel; import java.nio.ByteBuffer; import java.nio.file.Files; import java.nio.file.Path; +import java.time.Duration; import java.util.ArrayList; import java.util.List; import java.util.Optional; @@ -251,10 +253,8 @@ public class GenerationHistoryAdmissionTest { Field queueField = GenerationHistory.class.getDeclaredField("pendingSemanticClaims"); queueField.setAccessible(true); ArrayBlockingQueue queue = (ArrayBlockingQueue) queueField.get(history); - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (queue.remainingCapacity() != 0 && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + Await.reached("the claim queue to reach capacity", Duration.ofSeconds(5L), + () -> queue.remainingCapacity() == 0); assertEquals(0, queue.remainingCapacity()); assertEquals(128, queue.size()); } @@ -354,24 +354,21 @@ public class GenerationHistoryAdmissionTest { } } - private static void awaitBlockedOnHistory(GenerationHistory history, List workers, int count) - throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (System.nanoTime() < deadline) { - int blocked = 0; - for (Thread worker : workers) { - ThreadInfo info = ManagementFactory.getThreadMXBean().getThreadInfo(worker.threadId()); - if (info != null && info.getThreadState() == Thread.State.BLOCKED - && info.getLockInfo().getIdentityHashCode() == System.identityHashCode(history)) { - blocked++; - } + private static void awaitBlockedOnHistory(GenerationHistory history, List workers, int count) { + Await.until("semantic claim callers to queue behind the History monitor", Duration.ofSeconds(5L), + () -> blockedOnHistory(history, workers) == count); + } + + private static int blockedOnHistory(GenerationHistory history, List workers) { + int blocked = 0; + for (Thread worker : workers) { + ThreadInfo info = ManagementFactory.getThreadMXBean().getThreadInfo(worker.threadId()); + if (info != null && info.getThreadState() == Thread.State.BLOCKED + && info.getLockInfo().getIdentityHashCode() == System.identityHashCode(history)) { + blocked++; } - if (blocked == count) { - return; - } - Thread.sleep(1L); } - throw new AssertionError("Semantic claim callers did not queue behind the History monitor"); + return blocked; } private static boolean persistPaused(GenerationHistory history, GenerationHistory.GenerationStage stage, diff --git a/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeRuntimeTest.java b/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeRuntimeTest.java index 5e357ab0b..ca821d85e 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeRuntimeTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeRuntimeTest.java @@ -5,8 +5,11 @@ import art.arcane.iris.engine.IrisEngine; import art.arcane.iris.engine.framework.BiomeEnvironment; import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.Await; +import art.arcane.iris.testsupport.PlatformLeakGuard; import org.junit.After; import org.junit.Before; +import org.junit.ClassRule; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -15,6 +18,7 @@ import java.io.IOException; import java.lang.reflect.Field; import java.nio.file.Files; import java.nio.file.Path; +import java.time.Duration; import java.util.ArrayList; import java.util.List; import java.util.Optional; @@ -39,6 +43,9 @@ import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; public class SavedBiomeRuntimeTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Rule public TemporaryFolder temporaryFolder = new TemporaryFolder(); @@ -263,10 +270,8 @@ public class SavedBiomeRuntimeTest { consumption.writeLock().lock(); Future rendered = caller.submit(() -> runtime.readSurfaceBiome(0, 0, Optional::isEmpty)); try { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (runtime.cachedQueryCount() == 0 && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + Await.reached("the background preview to cache its query", Duration.ofSeconds(5L), + () -> runtime.cachedQueryCount() != 0); assertEquals(1, runtime.cachedQueryCount()); for (int chunkX = 1; chunkX <= 130; chunkX++) { int requestedX = chunkX; @@ -451,11 +456,9 @@ public class SavedBiomeRuntimeTest { when(history.semantics(anyInt(), anyInt())).thenReturn(Optional.empty()); } - private static void awaitIdle(SavedBiomeRuntime runtime) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (runtime.pendingQueryCount() != 0 && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + private static void awaitIdle(SavedBiomeRuntime runtime) { + Await.reached("the runtime to drain its pending queries", Duration.ofSeconds(5L), + () -> runtime.pendingQueryCount() == 0); assertEquals(0, runtime.pendingQueryCount()); } diff --git a/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeStoreBatchTest.java b/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeStoreBatchTest.java index 99da9c38a..b40a2ef7a 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeStoreBatchTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/SavedBiomeStoreBatchTest.java @@ -1,5 +1,6 @@ package art.arcane.iris.engine.history; +import art.arcane.iris.testsupport.Await; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -11,6 +12,7 @@ import java.lang.reflect.Field; import java.nio.channels.FileChannel; import java.nio.file.Files; import java.nio.file.Path; +import java.time.Duration; import java.util.ArrayList; import java.util.List; import java.util.Queue; @@ -207,10 +209,8 @@ public class SavedBiomeStoreBatchTest { for (SavedBiomeChunk chunk : chunks) { results.add(workers.submit(() -> claim(store, root, control, chunk))); } - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5); - while (pending.size() != chunks.size() && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + Await.reached("every claim to queue behind the region write", Duration.ofSeconds(5L), + () -> pending.size() == chunks.size()); assertEquals(chunks.size(), pending.size()); } finally { writingField.setBoolean(stripe, false); diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyTileCacheTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyTileCacheTest.java index 0827fbe5c..d8f194306 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyTileCacheTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyTileCacheTest.java @@ -1,10 +1,12 @@ package art.arcane.iris.engine.hydrology; +import art.arcane.iris.testsupport.Await; import art.arcane.iris.util.common.parallel.MultiBurst; import art.arcane.volmlib.util.cache.CacheKey; import org.junit.Test; import java.lang.reflect.Field; +import java.time.Duration; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; @@ -137,10 +139,7 @@ public class HydrologyTileCacheTest { Field field = HydrologyTileCache.class.getDeclaredField("closed"); field.setAccessible(true); AtomicBoolean closed = (AtomicBoolean) field.get(cache); - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5); - while (!closed.get() && System.nanoTime() < deadline) { - Thread.sleep(1); - } + Await.reached("the cache to finish closing", Duration.ofSeconds(5L), closed::get); assertTrue(closed.get()); } @@ -1162,22 +1161,13 @@ public class HydrologyTileCacheTest { } } - private static void awaitConcurrentPlan(AtomicInteger inFlight, long boundMillis) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(boundMillis); - while (inFlight.get() < 2 && System.nanoTime() < deadline) { - Thread.sleep(1L); - } + private static void awaitConcurrentPlan(AtomicInteger inFlight, long boundMillis) { + Await.reached("a second plan to run concurrently", Duration.ofMillis(boundMillis), () -> inFlight.get() >= 2); } - private static void awaitParkedCallers(List callers, int expected) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5); - while (System.nanoTime() < deadline) { - if (callers.size() == expected && allParked(callers)) { - return; - } - Thread.sleep(1L); - } - throw new AssertionError("Callers did not park on the in-flight plan"); + private static void awaitParkedCallers(List callers, int expected) { + Await.until("callers to park on the in-flight plan", Duration.ofSeconds(5L), + () -> callers.size() == expected && allParked(callers)); } private static boolean allParked(List callers) { diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorConcurrencyTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorConcurrencyTest.java index 16df4d316..7e9b6488a 100644 --- a/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorConcurrencyTest.java +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MatterGeneratorConcurrencyTest.java @@ -3,10 +3,8 @@ package art.arcane.iris.engine.mantle; import art.arcane.iris.core.IrisSettings; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.object.IrisDimension; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.Await; +import art.arcane.iris.testsupport.PlatformBinding; import art.arcane.iris.util.project.context.ChunkContext; import art.arcane.iris.util.project.context.IrisContext; import art.arcane.volmlib.util.mantle.flag.MantleFlag; @@ -16,9 +14,11 @@ import art.arcane.volmlib.util.mantle.runtime.MantleChunk; import art.arcane.volmlib.util.matter.Matter; import org.junit.AfterClass; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import art.arcane.iris.util.common.parallel.MultiBurst; +import java.time.Duration; import java.util.List; import java.util.Set; import java.util.concurrent.CancellationException; @@ -43,7 +43,6 @@ import static org.junit.Assert.assertThrows; import static org.mockito.ArgumentMatchers.anyBoolean; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; @@ -52,24 +51,19 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class MatterGeneratorConcurrencyTest { + @ClassRule + public static final PlatformBinding PLATFORM = PlatformBinding.mockPlatform(); + private static IrisSettings previousSettings; @BeforeClass public static void bindPlatform() { previousSettings = IrisSettings.settings; IrisSettings.settings = new IrisSettings(); - IrisPlatforms.unbind(); - PlatformBlockState defaultBlock = mock(PlatformBlockState.class); - PlatformRegistries registries = mock(PlatformRegistries.class); - IrisPlatform platform = mock(IrisPlatform.class); - when(registries.block(anyString())).thenReturn(defaultBlock); - when(platform.registries()).thenReturn(registries); - IrisPlatforms.bind(platform); } @AfterClass public static void unbindPlatform() { - IrisPlatforms.unbind(); IrisSettings.settings = previousSettings; } @@ -592,10 +586,8 @@ public class MatterGeneratorConcurrencyTest { return null; }); - long deadline = System.currentTimeMillis() + 10_000L; - while (secondCompleted.size() < 7 && System.currentTimeMillis() < deadline) { - Thread.sleep(10L); - } + Await.reached("the second generation to finish its own seven chunks", Duration.ofSeconds(10L), + () -> secondCompleted.size() >= 7); // The second generation's window is x 1..3, z -1..1. The first generation finished (1,-1) // before parking on (1,0), so the second one owns the remaining seven chunks and must // complete all of them while (1,0) is still held instead of blocking on it first. diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCarvingResolverParityTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCarvingResolverParityTest.java index 58e3e5151..9701c0ae5 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCarvingResolverParityTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisDimensionCarvingResolverParityTest.java @@ -4,6 +4,7 @@ import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.core.loader.ResourceLoader; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.SeedManager; +import art.arcane.iris.testsupport.Await; import art.arcane.iris.testsupport.BukkitTestServer; import art.arcane.iris.util.project.noise.CNG; import art.arcane.volmlib.util.collection.KList; @@ -14,6 +15,7 @@ import org.mockito.invocation.InvocationOnMock; import java.lang.ref.WeakReference; import java.lang.reflect.Field; import java.lang.reflect.Proxy; +import java.time.Duration; import java.util.HashMap; import java.util.List; import java.util.Map; @@ -22,6 +24,7 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicReference; import static org.junit.Assert.assertFalse; @@ -281,17 +284,18 @@ public class IrisDimensionCarvingResolverParityTest { new WeakReference<>(fixture.engine())); } - private static void awaitCollection(LifetimeReferences references) throws InterruptedException { - for (int attempt = 0; attempt < 100; attempt++) { + private static void awaitCollection(LifetimeReferences references) { + AtomicInteger attempt = new AtomicInteger(); + Await.reached("the thread-local State and Engine to be collected", Duration.ofSeconds(5L), () -> { System.gc(); if (references.state().get() == null && references.engine().get() == null) { - return; + return true; } byte[] pressure = new byte[1_048_576]; - pressure[0] = (byte) attempt; - Thread.sleep(10L); - } + pressure[0] = (byte) attempt.incrementAndGet(); + return false; + }); assertTrue("Thread-local State was retained", references.state().get() == null); assertTrue("Engine was retained", references.engine().get() == null); } diff --git a/core/src/test/java/art/arcane/iris/testsupport/Await.java b/core/src/test/java/art/arcane/iris/testsupport/Await.java new file mode 100644 index 000000000..d64aeb6d4 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/testsupport/Await.java @@ -0,0 +1,41 @@ +package art.arcane.iris.testsupport; + +import java.time.Duration; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.LockSupport; +import java.util.function.BooleanSupplier; + +public final class Await { + private static final long POLL_INTERVAL_NANOS = TimeUnit.MILLISECONDS.toNanos(10L); + private static final Duration DEFAULT_TIMEOUT = Duration.ofSeconds(5L); + + private Await() { + } + + public static void until(String what, BooleanSupplier condition) { + until(what, DEFAULT_TIMEOUT, condition); + } + + public static void until(String what, Duration timeout, BooleanSupplier condition) { + if (!reached(what, timeout, condition)) { + throw new AssertionError("Timed out after " + timeout.toMillis() + "ms waiting for " + what); + } + } + + public static boolean reached(String what, Duration timeout, BooleanSupplier condition) { + long deadline = System.nanoTime() + timeout.toNanos(); + while (true) { + if (condition.getAsBoolean()) { + return true; + } + if (System.nanoTime() - deadline >= 0L) { + return false; + } + LockSupport.parkNanos(POLL_INTERVAL_NANOS); + if (Thread.interrupted()) { + Thread.currentThread().interrupt(); + throw new AssertionError("Interrupted while waiting for " + what); + } + } + } +} From bdb13d164795284dbd7d56b9c331efb8c63b9616 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:45:18 -0400 Subject: [PATCH 06/35] Fix cross-thread report assertion - Assert the spawn failure report through the bound platform instead of a thread-confined static mock, so the report is seen whichever thread wins the reporting race - Guard WorldEntitySpawnerLifecycleTest against a leaked platform binding - Unbind the stub platform after the probe module's platform state test --- .../WorldEntitySpawnerLifecycleTest.java | 31 ++++++++++++++++--- .../iris/probe/StubPlatformStateTest.java | 6 ++++ 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/core/src/test/java/art/arcane/iris/engine/WorldEntitySpawnerLifecycleTest.java b/core/src/test/java/art/arcane/iris/engine/WorldEntitySpawnerLifecycleTest.java index 46ddab962..2df8b2ef9 100644 --- a/core/src/test/java/art/arcane/iris/engine/WorldEntitySpawnerLifecycleTest.java +++ b/core/src/test/java/art/arcane/iris/engine/WorldEntitySpawnerLifecycleTest.java @@ -12,11 +12,16 @@ import art.arcane.iris.engine.framework.GenerationSessionManager; import art.arcane.iris.engine.object.IrisWorld; import art.arcane.iris.platform.bukkit.BukkitWorldBinding; import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.Await; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.common.scheduling.J; import art.arcane.iris.util.project.context.IrisContext; import art.arcane.volmlib.util.scheduling.ChronoLatch; import org.bukkit.World; import org.bukkit.entity.LivingEntity; +import org.junit.ClassRule; import org.junit.Test; import org.mockito.MockedStatic; @@ -41,8 +46,9 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.anyInt; +import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.ArgumentMatchers.same; +import static org.mockito.Mockito.doAnswer; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.never; @@ -50,6 +56,9 @@ import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; public class WorldEntitySpawnerLifecycleTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + @Test public void queuedSpawnIsDiscardedWhenTheManagerCloses() throws Exception { try (Fixture fixture = new Fixture()) { @@ -162,14 +171,26 @@ public class WorldEntitySpawnerLifecycleTest { when(fixture.world.isChunkLoaded(7, -4)).thenThrow(failure); Future waiting = fixture.spawn(false, true); Runnable task = fixture.nextTask(); + AtomicReference reportedContext = new AtomicReference<>(); + AtomicReference reportedCause = new AtomicReference<>(); + IrisPlatform platform = mock(IrisPlatform.class); + doAnswer(invocation -> { + reportedContext.set(invocation.getArgument(0)); + reportedCause.set(invocation.getArgument(1)); + return null; + }).when(platform).reportError(anyString(), any(Throwable.class)); + IrisPlatforms.bind(platform); - try (MockedStatic logging = mockStatic(IrisLogging.class)) { + try { task.run(); - logging.verify(() -> IrisLogging.reportError( - eq("Failed to spawn Iris entities in chunk 7,-4."), same(failure))); + assertFalse(waiting.get(1L, TimeUnit.SECONDS)); + Await.until("the spawn failure report", () -> reportedCause.get() != null); + } finally { + IrisPlatforms.unbind(); } - assertFalse(waiting.get(1L, TimeUnit.SECONDS)); + assertEquals("Failed to spawn Iris entities in chunk 7,-4.", reportedContext.get()); + assertSame(failure, reportedCause.get()); assertEquals(0, fixture.sessions.activeLeases()); } } diff --git a/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java b/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java index 62ad735e7..41c4fa350 100644 --- a/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java +++ b/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java @@ -5,6 +5,7 @@ import art.arcane.iris.engine.object.IrisObjectRotation; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.util.project.hunk.Hunk; +import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; @@ -21,6 +22,11 @@ public final class StubPlatformStateTest { StubPlatform.bindGenerationStateHandlers(); } + @AfterClass + public static void unbindPlatform() { + IrisPlatforms.unbind(); + } + @Test public void rotatesFacingAxisAndConnectedFaces() { IrisObjectRotation rotation = IrisObjectRotation.of(0, 90, 0); From e5b7cb97a807309a2f629ef21dc696fd235be21f Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:06:15 -0400 Subject: [PATCH 07/35] Anchor repository root probe - Require the core source tree alongside the settings file when walking up for the repository root, so modded-common tests built inside a loader adapter no longer stop at that adapter's own settings file --- .../test/java/art/arcane/iris/testsupport/ProjectPaths.java | 3 ++- .../java/art/arcane/iris/modded/testsupport/ProjectPaths.java | 3 ++- .../test/java/art/arcane/iris/testsupport/ProjectPaths.java | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java index c63903367..3617450f5 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java @@ -69,7 +69,8 @@ public final class ProjectPaths { Path current = moduleRoot; while (current != null) { - if (Files.isRegularFile(current.resolve("settings.gradle"))) { + if (Files.isRegularFile(current.resolve("settings.gradle")) + && Files.isDirectory(current.resolve("core/src/main/java"))) { return current; } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java index 8fb746e94..feab80d42 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java @@ -69,7 +69,8 @@ public final class ProjectPaths { Path current = moduleRoot; while (current != null) { - if (Files.isRegularFile(current.resolve("settings.gradle"))) { + if (Files.isRegularFile(current.resolve("settings.gradle")) + && Files.isDirectory(current.resolve("core/src/main/java"))) { return current; } diff --git a/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java index c63903367..3617450f5 100644 --- a/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java +++ b/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java @@ -69,7 +69,8 @@ public final class ProjectPaths { Path current = moduleRoot; while (current != null) { - if (Files.isRegularFile(current.resolve("settings.gradle"))) { + if (Files.isRegularFile(current.resolve("settings.gradle")) + && Files.isDirectory(current.resolve("core/src/main/java"))) { return current; } From 9d22a18a3a328b1c121a645275e48ae0679eab53 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:06:16 -0400 Subject: [PATCH 08/35] Close route off the caller thread - Complete the async route close on the worker executor so the cross-thread assertion no longer depends on whether the first stage finished before the handler was attached --- .../engine/history/GenerationHistoryRuntimeRouterTest.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java index 56b43f93c..c65a26820 100644 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java @@ -723,10 +723,10 @@ public final class GenerationHistoryRuntimeRouterTest { assertThrows(IllegalStateException.class, route::close); } }, executor); - CompletableFuture completion = work.whenComplete((ignored, failure) -> { + CompletableFuture completion = work.whenCompleteAsync((ignored, failure) -> { completionThread.set(Thread.currentThread()); route.close(); - }); + }, executor); completion.get(5L, TimeUnit.SECONDS); } finally { executor.shutdownNow(); From e030ac3be524a9ef29b8f96ee62027785eaef7b7 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:17:21 -0400 Subject: [PATCH 09/35] Report silent pregen failures - Add PregenDiagnostics.probeFailed so capability probes log their name, class and message at debug instead of vanishing - Report the moonrise worker pool, mantle radius, engine access and Folia submit probe failures through that helper - Report async pregen mantle cleanup failures through IrisLogging.reportError with the trace instead of dropping them - Report a stranded plugin chunk ticket through IrisLogging.reportError so the leaked pin is visible - Emit the chunk load failure trace before the metrics snapshot so a failing snapshot can no longer silence it - Report the pregen cancellation and mantle handle probe failures in PregenMantleBackpressure - Report the Medieval engine resolution probe failure - Record the real Vector API initialization failure in SimdSupport and print the accurate kernel selection reason - Add PregenDiagnosticsTest, PregenSilentFailureContractTest and SimdSupportStatusTest --- .../core/pregenerator/PregenDiagnostics.java | 43 ++++++ .../PregenMantleBackpressure.java | 6 +- .../methods/AsyncPregenMethod.java | 29 ++-- .../methods/MedievalPregenMethod.java | 4 +- .../arcane/iris/util/simd/SimdSupport.java | 135 +++++++++++++---- .../pregenerator/PregenDiagnosticsTest.java | 84 +++++++++++ .../PregenSilentFailureContractTest.java | 136 ++++++++++++++++++ .../iris/util/simd/SimdSupportStatusTest.java | 116 +++++++++++++++ 8 files changed, 513 insertions(+), 40 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/pregenerator/PregenDiagnostics.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenSilentFailureContractTest.java create mode 100644 core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenDiagnostics.java b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenDiagnostics.java new file mode 100644 index 000000000..be5fefe6a --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenDiagnostics.java @@ -0,0 +1,43 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.pregenerator; + +import art.arcane.iris.spi.IrisLogging; + +public final class PregenDiagnostics { + private PregenDiagnostics() { + } + + public static void probeFailed(String probe, Throwable failure) { + IrisLogging.debug("Pregen probe " + describeProbe(probe) + " failed: " + describeFailure(failure)); + } + + public static String describeProbe(String probe) { + return probe == null || probe.isBlank() ? "unnamed" : probe; + } + + public static String describeFailure(Throwable failure) { + if (failure == null) { + return "no throwable reported"; + } + + String message = failure.getMessage(); + return message == null ? failure.getClass().getName() : failure.getClass().getName() + ": " + message; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java index 39152f161..2df82795d 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java @@ -170,7 +170,8 @@ public final class PregenMantleBackpressure { try { return cancelled.getAsBoolean(); - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("pregen cancellation state", e); return false; } } @@ -178,7 +179,8 @@ public final class PregenMantleBackpressure { private Mantle resolveMantle() { try { return mantleSupplier.get(); - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("mantle handle for backpressure", e); return null; } } diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java index 399eee3d6..811b5f285 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java @@ -22,6 +22,7 @@ import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.core.IrisPaperLikeBackendMode; import art.arcane.iris.core.IrisRuntimeSchedulerMode; import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.core.pregenerator.PregenDiagnostics; import art.arcane.iris.core.pregenerator.PregenListener; import art.arcane.iris.core.pregenerator.PregenMantleBackpressure; import art.arcane.iris.core.pregenerator.PregeneratorMethod; @@ -212,7 +213,8 @@ public class AsyncPregenMethod implements PregeneratorMethod { if (coreThreads instanceof Thread[] threadsArray) { return threadsArray.length; } - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("moonrise worker pool size", e); } return -1; @@ -238,7 +240,8 @@ public class AsyncPregenMethod implements PregeneratorMethod { int resolved = radius > 0 ? Math.max(1, (int) Math.ceil(radius / 32.0)) : 2; evictionWindowRegions = resolved; return resolved; - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("mantle radius for eviction window", e); return 2; } } @@ -431,7 +434,9 @@ public class AsyncPregenMethod implements PregeneratorMethod { private void unloadChunkSafely(int cx, int cz) { try { world.removePluginChunkTicket(cx, cz, BukkitPlatform.plugin()); - } catch (Throwable ignored) { + } catch (Throwable e) { + IrisLogging.reportError("Async pregen could not release the plugin chunk ticket at " + cx + "," + cz + + " in world " + world.getName() + "; the chunk stays pinned in memory.", e); } try { @@ -492,11 +497,12 @@ public class AsyncPregenMethod implements PregeneratorMethod { } private Chunk onChunkFutureFailure(int x, int z, Throwable throwable) { - try { - IrisLogging.warn("Failed async pregen chunk load at " + x + "," + z + ". " + metricsSnapshot()); + IrisLogging.reportError("Failed async pregen chunk load at " + x + "," + z + ".", throwable); - IrisLogging.reportError(throwable); + try { + IrisLogging.warn("Async pregen state at the failed chunk " + x + "," + z + ". " + metricsSnapshot()); } catch (Throwable e) { + PregenDiagnostics.probeFailed("pregen metrics snapshot", e); } return null; @@ -738,7 +744,9 @@ public class AsyncPregenMethod implements PregeneratorMethod { if (engine != null) { try { engine.getMantle().cleanupChunksCoveredBy(x, z, true, listener::onChunkCleaned); - } catch (Throwable ignored) { + } catch (Throwable e) { + IrisLogging.reportError("Async pregen mantle cleanup failed at chunk " + x + "," + z + + " in world " + world.getName() + "; tectonic plates for that chunk stay resident.", e); } } } @@ -759,7 +767,8 @@ public class AsyncPregenMethod implements PregeneratorMethod { metricsEngine = resolvedEngine; } return resolvedEngine; - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("engine access for world " + world.getName(), e); return null; } } @@ -1094,7 +1103,9 @@ public class AsyncPregenMethod implements PregeneratorMethod { requestMonitoredChunkAsync(x, z) .whenComplete((chunk, throwable) -> completeChunk(x, z, listener, chunk, throwable)); return; - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("folia direct chunk request at " + x + "," + z + + ", falling back to a region task", e); } Runnable regionTask = () -> { diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java index c56602aef..54f24d0ee 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java @@ -20,6 +20,7 @@ package art.arcane.iris.core.pregenerator.methods; import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.nms.INMS; +import art.arcane.iris.core.pregenerator.PregenDiagnostics; import art.arcane.iris.core.pregenerator.PregenListener; import art.arcane.iris.core.pregenerator.PregeneratorMethod; import art.arcane.iris.core.tools.IrisToolbelt; @@ -102,7 +103,8 @@ public class MedievalPregenMethod implements PregeneratorMethod { if (cached != null) { cachedEngine = cached; } - } catch (Throwable ignored) { + } catch (Throwable e) { + PregenDiagnostics.probeFailed("engine access for world " + world.getName(), e); } return cached; } diff --git a/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java b/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java index de41f882b..07347095a 100644 --- a/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java +++ b/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java @@ -3,10 +3,15 @@ package art.arcane.iris.util.simd; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.core.IrisSettings; +import java.util.concurrent.atomic.AtomicReference; + public final class SimdSupport { private static final String VECTOR_MODULE = "jdk.incubator.vector"; private static final boolean MODULE_PRESENT = ModuleLayer.boot().findModule(VECTOR_MODULE).isPresent(); + private static final AtomicReference KERNEL_FAILURE = new AtomicReference<>(); + private static final AtomicReference NOISE_KERNEL_FAILURE = new AtomicReference<>(); private static final SimdKernels KERNELS = selectKernels(); + private static final NoiseKernels2D NOISE_KERNELS_2D = selectNoiseKernels2D(); private SimdSupport() { } @@ -15,6 +20,10 @@ public final class SimdSupport { return KERNELS; } + public static NoiseKernels2D noiseKernels2D() { + return NOISE_KERNELS_2D; + } + public static boolean isVectorModulePresent() { return MODULE_PRESENT; } @@ -23,13 +32,75 @@ public final class SimdSupport { return !(KERNELS instanceof ScalarSimdKernels); } + public static Throwable kernelInitializationFailure() { + return KERNEL_FAILURE.get(); + } + + public static Throwable noiseKernelInitializationFailure() { + return NOISE_KERNEL_FAILURE.get(); + } + + public static String kernelStatus() { + return kernelStatus(isVectorized(), KERNELS.describe(), MODULE_PRESENT, KERNEL_FAILURE.get(), simdEnabledInSettings()); + } + + public static String noiseKernelStatus() { + return noiseKernelStatus(!(NOISE_KERNELS_2D instanceof ScalarNoiseKernels2D), NOISE_KERNELS_2D.describe(), + MODULE_PRESENT, NOISE_KERNEL_FAILURE.get(), simdEnabledInSettings()); + } + + static String kernelStatus(boolean vectorized, String description, boolean modulePresent, Throwable failure, boolean settingEnabled) { + if (vectorized) { + return "vector kernels enabled (" + description + ")"; + } + + if (!modulePresent) { + return "scalar kernels active; add --add-modules " + VECTOR_MODULE + " to JVM flags to enable vectorized generation kernels"; + } + + if (failure != null) { + return "scalar kernels active; vector kernel initialization failed: " + describe(failure); + } + + if (!settingEnabled) { + return "vector kernels disabled (performance.simdKernels=false)"; + } + + return "scalar kernels active; the Vector API reported no usable vector shape on this CPU"; + } + + static String noiseKernelStatus(boolean vectorized, String description, boolean modulePresent, Throwable failure, boolean settingEnabled) { + if (vectorized) { + return "2D noise vector kernels enabled (" + description + ")"; + } + + if (!modulePresent) { + return "2D noise scalar kernels active; the " + VECTOR_MODULE + " module is not on this JVM"; + } + + if (failure != null) { + return "2D noise scalar kernels active; vector kernel initialization failed: " + describe(failure); + } + + if (!settingEnabled) { + return "2D noise vector kernels disabled (performance.simdKernels=false)"; + } + + return "2D noise scalar kernels active; this CPU has fewer than the 4 double lanes the vector kernel needs to pay for itself"; + } + public static void install() { - if (isVectorized()) { - IrisLogging.info("SIMD: vector kernels enabled (" + KERNELS.describe() + ")"); - } else if (!MODULE_PRESENT) { - IrisLogging.info("SIMD: scalar kernels active; add --add-modules " + VECTOR_MODULE + " to JVM flags to enable vectorized generation kernels"); - } else { - IrisLogging.info("SIMD: vector kernels disabled (performance.simdKernels=false)"); + IrisLogging.info("SIMD: " + kernelStatus()); + IrisLogging.info("SIMD: " + noiseKernelStatus()); + + Throwable failure = KERNEL_FAILURE.get(); + if (failure != null) { + IrisLogging.reportError("Iris could not initialize its Vector API kernels; generation runs on the scalar kernels instead.", failure); + } + + Throwable noiseFailure = NOISE_KERNEL_FAILURE.get(); + if (noiseFailure != null) { + IrisLogging.reportError("Iris could not initialize its Vector API 2D noise kernels; noise runs on the scalar kernels instead.", noiseFailure); } } @@ -41,6 +112,25 @@ public final class SimdSupport { try { return (SimdKernels) Class.forName("art.arcane.iris.util.simd.VectorSimdKernels").getDeclaredConstructor().newInstance(); } catch (Throwable e) { + KERNEL_FAILURE.set(e); + return null; + } + } + + public static NoiseKernels2D createVectorNoiseKernels2D() { + if (!MODULE_PRESENT) { + return null; + } + + try { + Class cls = Class.forName("art.arcane.iris.util.simd.VectorNoiseKernels2D"); + boolean profitable = (boolean) cls.getMethod("profitable").invoke(null); + if (!profitable) { + return null; + } + return (NoiseKernels2D) cls.getDeclaredConstructor().newInstance(); + } catch (Throwable e) { + NOISE_KERNEL_FAILURE.set(e); return null; } } @@ -54,36 +144,25 @@ public final class SimdSupport { return vector == null ? new ScalarSimdKernels() : vector; } - private static final NoiseKernels2D NOISE_KERNELS_2D = selectNoiseKernels2D(); - - public static NoiseKernels2D noiseKernels2D() { - return NOISE_KERNELS_2D; - } - - public static NoiseKernels2D createVectorNoiseKernels2D() { - if (!MODULE_PRESENT) { - return null; - } - try { - Class cls = Class.forName("art.arcane.iris.util.simd.VectorNoiseKernels2D"); - boolean profitable = (boolean) cls.getMethod("profitable").invoke(null); - if (!profitable) { - return null; - } - return (NoiseKernels2D) cls.getDeclaredConstructor().newInstance(); - } catch (Throwable e) { - return null; - } - } - private static NoiseKernels2D selectNoiseKernels2D() { if (!simdEnabledInSettings()) { return new ScalarNoiseKernels2D(); } + NoiseKernels2D vector = createVectorNoiseKernels2D(); return vector == null ? new ScalarNoiseKernels2D() : vector; } + private static String describe(Throwable failure) { + Throwable root = failure; + while (root.getCause() != null && root.getCause() != root) { + root = root.getCause(); + } + + String message = root.getMessage(); + return message == null ? root.getClass().getName() : root.getClass().getName() + ": " + message; + } + private static boolean simdEnabledInSettings() { try { return IrisSettings.get().getPerformance().isSimdKernels(); diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsTest.java new file mode 100644 index 000000000..e2805bb57 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsTest.java @@ -0,0 +1,84 @@ +package art.arcane.iris.core.pregenerator; + +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.LogLevel; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentMatchers; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; + +public class PregenDiagnosticsTest { + private final List emitted = new ArrayList<>(); + private final List levels = new ArrayList<>(); + private IrisPlatform previousPlatform; + + @Before + public void captureLog() { + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + emitted.clear(); + levels.clear(); + IrisPlatform platform = mock(IrisPlatform.class); + doAnswer(invocation -> { + levels.add(invocation.getArgument(0, LogLevel.class)); + emitted.add(invocation.getArgument(1, String.class)); + return null; + }).when(platform).log(ArgumentMatchers.any(LogLevel.class), ArgumentMatchers.anyString()); + IrisPlatforms.bind(platform); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + + @Test + public void aFailedProbeReportsItsNameClassAndMessageAtDebug() { + PregenDiagnostics.probeFailed("moonrise worker pool size", new IllegalStateException("no such field")); + + assertEquals(1, emitted.size()); + assertEquals(LogLevel.DEBUG, levels.get(0)); + assertTrue(emitted.get(0), emitted.get(0).contains("moonrise worker pool size")); + assertTrue(emitted.get(0), emitted.get(0).contains(IllegalStateException.class.getName())); + assertTrue(emitted.get(0), emitted.get(0).contains("no such field")); + } + + @Test + public void aThrowableWithNoMessageStillReportsItsClass() { + PregenDiagnostics.probeFailed("engine access", new NoClassDefFoundError()); + + assertEquals(1, emitted.size()); + assertTrue(emitted.get(0), emitted.get(0).contains(NoClassDefFoundError.class.getName())); + assertTrue(emitted.get(0), emitted.get(0).contains("engine access")); + } + + @Test + public void aMissingProbeNameAndThrowableStillProduceAReadableLine() { + PregenDiagnostics.probeFailed(null, null); + + assertEquals(1, emitted.size()); + assertTrue(emitted.get(0), emitted.get(0).contains("unnamed")); + assertTrue(emitted.get(0), emitted.get(0).contains("no throwable reported")); + } + + @Test + public void percentSignsInAProbeNameAreNotTreatedAsFormatSpecifiers() { + PregenDiagnostics.probeFailed("heap at 95% headroom", new IllegalArgumentException("bad %s value")); + + assertEquals(1, emitted.size()); + assertTrue(emitted.get(0), emitted.get(0).contains("heap at 95% headroom")); + assertTrue(emitted.get(0), emitted.get(0).contains("bad %s value")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenSilentFailureContractTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenSilentFailureContractTest.java new file mode 100644 index 000000000..495ae768f --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenSilentFailureContractTest.java @@ -0,0 +1,136 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import java.io.IOException; +import java.net.URISyntaxException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Stream; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class PregenSilentFailureContractTest { + @Test + public void noPregenSourceSwallowsAThrowableWithoutSayingAnything() throws IOException { + List offenders = new ArrayList<>(); + Path pregenRoot = sourceRoot().resolve("art/arcane/iris/core/pregenerator"); + try (Stream sources = Files.walk(pregenRoot)) { + for (Path source : sources.filter(path -> path.toString().endsWith(".java")).toList()) { + String text = Files.readString(source); + if (text.contains("catch (Throwable ignored)") || text.contains("catch (Exception ignored)")) { + offenders.add(source.getFileName().toString()); + } + } + } + + assertEquals("silent catches on the pregen path: " + offenders, List.of(), offenders); + } + + @Test + public void mantleCleanupFailureIsReportedWithItsStackTrace() throws IOException { + String cleanup = method(read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"), + "private void cleanupMantleChunksCoveredBy("); + + assertTrue(cleanup, cleanup.contains("IrisLogging.reportError(")); + assertTrue(cleanup, cleanup.contains("catch (Throwable e)")); + } + + @Test + public void aStrandedPluginChunkTicketIsReportedWithItsStackTrace() throws IOException { + String unload = method(read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"), + "private void unloadChunkSafely("); + + assertTrue(unload, unload.contains("removePluginChunkTicket")); + assertEquals(unload, 2, countOccurrences(unload, "IrisLogging.reportError(")); + } + + @Test + public void capabilityProbesLogThroughTheNamedDebugHelperRatherThanReportingErrors() throws IOException { + String async = read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"); + + assertTrue(method(async, "private int resolveWorkerPoolThreads()").contains("PregenDiagnostics.probeFailed(")); + assertTrue(method(async, "private int evictionWindow()").contains("PregenDiagnostics.probeFailed(")); + assertTrue(method(async, "private Engine resolveMetricsEngine()").contains("PregenDiagnostics.probeFailed(")); + } + + @Test + public void theFoliaSubmitFallbackNamesTheFailureItIsFallingBackFrom() throws IOException { + String executor = method(read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"), + "private class FoliaRegionExecutor"); + + assertTrue(executor, executor.contains("PregenDiagnostics.probeFailed(")); + assertTrue(executor, executor.contains("falling back to a region task")); + } + + @Test + public void backpressureProbesAnnounceWhyTheyFellBack() throws IOException { + String backpressure = read("art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java"); + + assertTrue(method(backpressure, "private boolean isCancelled()").contains("PregenDiagnostics.probeFailed(")); + assertTrue(method(backpressure, "private Mantle resolveMantle()").contains("PregenDiagnostics.probeFailed(")); + } + + @Test + public void medievalEngineResolutionAnnouncesWhyItFellBack() throws IOException { + String medieval = read("art/arcane/iris/core/pregenerator/methods/MedievalPregenMethod.java"); + + assertTrue(method(medieval, "private Engine resolveEngine()").contains("PregenDiagnostics.probeFailed(")); + } + + private static int countOccurrences(String text, String needle) { + int count = 0; + int index = text.indexOf(needle); + while (index >= 0) { + count++; + index = text.indexOf(needle, index + needle.length()); + } + return count; + } + + private static Path sourceRoot() throws IOException { + Path current; + try { + current = Path.of(PregenSilentFailureContractTest.class.getProtectionDomain() + .getCodeSource() + .getLocation() + .toURI()); + } catch (URISyntaxException e) { + throw new IOException("Unable to resolve the core source root", e); + } + while (current != null && !Files.isDirectory(current.resolve("src/main/java"))) { + current = current.getParent(); + } + if (current == null) { + throw new IOException("Unable to locate the core source root"); + } + return current.resolve("src/main/java"); + } + + private static String read(String relativePath) throws IOException { + return Files.readString(sourceRoot().resolve(relativePath)); + } + + private static String method(String source, String signature) { + int start = source.indexOf(signature); + assertTrue("Missing source contract signature: " + signature, start >= 0); + int openBrace = source.indexOf('{', start); + assertTrue("Missing source contract method body: " + signature, openBrace >= 0); + int depth = 0; + for (int index = openBrace; index < source.length(); index++) { + char current = source.charAt(index); + if (current == '{') { + depth++; + } else if (current == '}') { + depth--; + if (depth == 0) { + return source.substring(start, index + 1); + } + } + } + throw new IllegalArgumentException("Unclosed source contract method: " + signature); + } +} diff --git a/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java b/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java new file mode 100644 index 000000000..20a0cc2c7 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java @@ -0,0 +1,116 @@ +package art.arcane.iris.util.simd; + +import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.LogLevel; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentMatchers; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; + +public class SimdSupportStatusTest { + private final List emitted = new ArrayList<>(); + private IrisPlatform previousPlatform; + private IrisSettings previousSettings; + + @Before + public void captureLog() { + previousSettings = IrisSettings.settings; + IrisSettings.settings = new IrisSettings(); + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + emitted.clear(); + IrisPlatform platform = mock(IrisPlatform.class); + doAnswer(invocation -> { + emitted.add(invocation.getArgument(1, String.class)); + return null; + }).when(platform).log(ArgumentMatchers.any(LogLevel.class), ArgumentMatchers.anyString()); + IrisPlatforms.bind(platform); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + IrisSettings.settings = previousSettings; + } + + @Test + public void anInitializationFailureIsNamedInsteadOfBlamingTheSetting() { + String status = SimdSupport.kernelStatus(false, "scalar", true, + new ExceptionInInitializerError(new UnsupportedOperationException("no vector shape")), true); + + assertFalse(status, status.contains("performance.simdKernels=false")); + assertTrue(status, status.contains(UnsupportedOperationException.class.getName())); + assertTrue(status, status.contains("no vector shape")); + } + + @Test + public void anInitializationFailureOutranksADisabledSettingBecauseADisabledSettingNeverAttempts() { + String status = SimdSupport.kernelStatus(false, "scalar", true, new LinkageError("bad class"), false); + + assertTrue(status, status.contains("bad class")); + assertFalse(status, status.contains("performance.simdKernels=false")); + } + + @Test + public void aDisabledSettingIsReportedOnlyWhenNothingFailed() { + String status = SimdSupport.kernelStatus(false, "scalar", true, null, false); + + assertTrue(status, status.contains("performance.simdKernels=false")); + } + + @Test + public void anAbsentVectorModuleIsReportedWithTheJvmFlagThatFixesIt() { + String status = SimdSupport.kernelStatus(false, "scalar", false, null, true); + + assertTrue(status, status.contains("--add-modules jdk.incubator.vector")); + assertFalse(status, status.contains("performance.simdKernels=false")); + } + + @Test + public void anEnabledVectorKernelReportsItsShapeAndNoRemedy() { + String status = SimdSupport.kernelStatus(true, "4x64-bit lanes, S_256_BIT", true, null, true); + + assertTrue(status, status.contains("4x64-bit lanes, S_256_BIT")); + assertFalse(status, status.contains("scalar kernels active")); + } + + @Test + public void aNarrowCpuIsReportedAsUnprofitableRatherThanDisabled() { + String status = SimdSupport.noiseKernelStatus(false, "scalar", true, null, true); + + assertTrue(status, status.contains("4 double lanes")); + assertFalse(status, status.contains("performance.simdKernels=false")); + } + + @Test + public void installStatesTheLiveKernelSelectionForBothKernelSets() { + SimdSupport.install(); + + assertTrue(emitted.toString(), emitted.size() >= 2); + assertTrue(emitted.toString(), emitted.contains("SIMD: " + SimdSupport.kernelStatus())); + assertTrue(emitted.toString(), emitted.contains("SIMD: " + SimdSupport.noiseKernelStatus())); + } + + @Test + public void theLiveStatusNeverBlamesTheSettingWhileSimdKernelsAreEnabled() { + if (!IrisSettings.get().getPerformance().isSimdKernels()) { + return; + } + + assertFalse(SimdSupport.kernelStatus(), SimdSupport.kernelStatus().contains("performance.simdKernels=false")); + assertFalse(SimdSupport.noiseKernelStatus(), SimdSupport.noiseKernelStatus().contains("performance.simdKernels=false")); + } +} From 1be563bd28098d7317e14327736c689cf697c45e Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:34:12 -0400 Subject: [PATCH 10/35] Unblock pregen throughput limiters - Replace the pregen cache global monitor with atomic per-plate and per-region state and a lock-free resident-plate memo - Serialize plate eviction and its disk write under the residency lock so a reloaded plate can never lose a concurrent bit - Retry a chunk or region cache write whose plate was retired mid-write - Delete SynchronizedCache and the isThreadSafe wrapper it existed for - Replace the AsyncPregenMethod semaphore and permit monitor with PregenAdmissionGate, one condition that signals on release, adaptive-limit change and cancellation - Attribute the adaptive and permit waits separately from the single gate wait - Wait on a progress signal instead of sleeping 25ms in PregenMantleBackpressure, signalled by chunk completion - Wait on a state signal instead of sleeping 50ms and 150ms in IrisPregenerator pause, heap pressure and tectonic reclaim loops - Restore the burst pool parallelism when the last pregen job finishes - Add PregenCacheConcurrencyTest, PregenAdmissionGateTest and PregenWaitPolicyContractTest --- .../core/pregenerator/IrisPregenerator.java | 37 +- .../pregenerator/PregenAdmissionGate.java | 136 +++++++ .../PregenMantleBackpressure.java | 37 +- .../PregenPerformanceProfile.java | 24 ++ .../core/pregenerator/cache/PregenCache.java | 12 +- .../pregenerator/cache/PregenCacheImpl.java | 366 +++++++++++------- .../pregenerator/cache/SynchronizedCache.java | 50 --- .../methods/AsyncPregenMethod.java | 94 ++--- .../iris/util/common/parallel/MultiBurst.java | 26 +- .../pregenerator/PregenAdmissionGateTest.java | 189 +++++++++ .../PregenPerformanceProfileTest.java | 37 ++ .../PregenWaitPolicyContractTest.java | 111 ++++++ .../cache/PregenCacheConcurrencyTest.java | 194 ++++++++++ .../AsyncPregenMethodConcurrencyCapTest.java | 16 +- 14 files changed, 1032 insertions(+), 297 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/pregenerator/PregenAdmissionGate.java delete mode 100644 core/src/main/java/art/arcane/iris/core/pregenerator/cache/SynchronizedCache.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenAdmissionGateTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenWaitPolicyContractTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheConcurrencyTest.java diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/IrisPregenerator.java b/core/src/main/java/art/arcane/iris/core/pregenerator/IrisPregenerator.java index a10aa3963..185ef7a95 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/IrisPregenerator.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/IrisPregenerator.java @@ -35,6 +35,9 @@ import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.scheduling.Looper; import art.arcane.volmlib.util.scheduling.PrecisionStopwatch; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.ReentrantLock; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicReference; @@ -43,6 +46,8 @@ import java.util.concurrent.atomic.AtomicReference; public class IrisPregenerator { private static final double INVALID = 9223372036854775807d; private static final AtomicLong JOB_SEQUENCE = new AtomicLong(0L); + private static final long GATE_WAIT_MS = 50L; + private static final long RECLAIM_WAIT_MS = 150L; private final long jobId; private final PregenTask task; private final PregeneratorMethod generator; @@ -50,6 +55,8 @@ public class IrisPregenerator { private final Looper ticker; private final AtomicBoolean paused; private final AtomicBoolean shutdown; + private final ReentrantLock stateLock = new ReentrantLock(); + private final Condition stateChanged = stateLock.newCondition(); private final PregenRateTracker rateTracker; private final KList chunksPerSecondHistory; private final AtomicLong generated; @@ -193,6 +200,7 @@ public class IrisPregenerator { public void close() { shutdown.set(true); + signalState(); } public void start() { @@ -295,6 +303,7 @@ public class IrisPregenerator { reclaimTectonicPlates(mantle); } }); + shutdownStep("parallelism", PregenPerformanceProfile::restore); shutdownStep("protocol", () -> { IrisProtocolServer protocolServer = IrisServices.getOrNull(IrisProtocolServer.class); if (protocolServer != null) { @@ -337,7 +346,7 @@ public class IrisPregenerator { } previousLoaded = loaded; - J.sleep(150); + awaitStateChange(RECLAIM_WAIT_MS); } int loadedAfter = mantle.getLoadedRegionCount(); @@ -348,7 +357,7 @@ public class IrisPregenerator { private void visitRegion(int x, int z, boolean regions) { while (paused.get() && !shutdown.get()) { - J.sleep(50); + awaitStateChange(GATE_WAIT_MS); } if (shutdown.get()) { @@ -376,7 +385,7 @@ public class IrisPregenerator { if (!paused.get()) { reclaimHeapPressure(); } - J.sleep(50); + awaitStateChange(GATE_WAIT_MS); } if (shutdown.get()) { @@ -439,10 +448,32 @@ public class IrisPregenerator { public void pause() { paused.set(true); + signalState(); } public void resume() { paused.set(false); + signalState(); + } + + private void signalState() { + stateLock.lock(); + try { + stateChanged.signalAll(); + } finally { + stateLock.unlock(); + } + } + + private void awaitStateChange(long millis) { + stateLock.lock(); + try { + stateChanged.await(millis, TimeUnit.MILLISECONDS); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + } finally { + stateLock.unlock(); + } } private PregenListener listenify(PregenListener listener) { diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenAdmissionGate.java b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenAdmissionGate.java new file mode 100644 index 000000000..60b9566cd --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenAdmissionGate.java @@ -0,0 +1,136 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.pregenerator; + +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.ReentrantLock; +import java.util.function.BooleanSupplier; +import java.util.function.LongSupplier; + +public final class PregenAdmissionGate { + public record Wait(long adaptiveMs, long permitMs) { + } + + private final int permits; + private final long boundMs; + private final LongSupplier clock; + private final ReentrantLock lock = new ReentrantLock(true); + private final Condition changed = lock.newCondition(); + private int free; + private volatile int freeSnapshot; + + public PregenAdmissionGate(int permits, long boundMs, LongSupplier clock) { + if (permits < 1) { + throw new IllegalArgumentException("A pregen admission gate needs at least one permit"); + } + if (boundMs < 1L) { + throw new IllegalArgumentException("A pregen admission gate needs a positive wait bound"); + } + this.permits = permits; + this.boundMs = boundMs; + this.clock = clock; + this.free = permits; + this.freeSnapshot = permits; + } + + public int permits() { + return permits; + } + + public int availablePermits() { + return freeSnapshot; + } + + public Wait admit(BooleanSupplier overAdaptiveLimit, BooleanSupplier cancelled) throws InterruptedException { + long adaptiveMs = 0L; + long permitMs = 0L; + lock.lock(); + try { + while (true) { + if (cancelled.getAsBoolean()) { + return null; + } + + boolean blockedByLimit = overAdaptiveLimit.getAsBoolean(); + if (!blockedByLimit && free > 0) { + free--; + freeSnapshot = free; + return new Wait(adaptiveMs, permitMs); + } + + long start = clock.getAsLong(); + changed.await(boundMs, TimeUnit.MILLISECONDS); + long waited = Math.max(0L, clock.getAsLong() - start); + if (blockedByLimit) { + adaptiveMs += waited; + } else { + permitMs += waited; + } + } + } finally { + lock.unlock(); + } + } + + public void release() { + lock.lock(); + try { + if (free < permits) { + free++; + freeSnapshot = free; + } + changed.signalAll(); + } finally { + lock.unlock(); + } + } + + public void wake() { + lock.lock(); + try { + changed.signalAll(); + } finally { + lock.unlock(); + } + } + + public boolean awaitDrain(long warningInterval, TimeUnit timeUnit, Runnable onWait) { + boolean interrupted = false; + lock.lock(); + try { + while (free < permits) { + boolean signalled = false; + try { + signalled = changed.await(warningInterval, timeUnit); + } catch (InterruptedException e) { + interrupted = true; + continue; + } + if (!signalled && free < permits) { + onWait.run(); + } + } + } finally { + lock.unlock(); + } + + return interrupted; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java index 2df82795d..ca40d3851 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java @@ -22,6 +22,9 @@ import art.arcane.iris.spi.IrisLogging; import art.arcane.volmlib.util.mantle.runtime.Mantle; import art.arcane.volmlib.util.math.M; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.locks.Condition; +import java.util.concurrent.locks.ReentrantLock; import java.util.function.BooleanSupplier; import java.util.function.Supplier; @@ -33,6 +36,8 @@ public final class PregenMantleBackpressure { private final Runnable onBudgetTimeout; private final Supplier diagnostics; private final BooleanSupplier cancelled; + private final ReentrantLock lock = new ReentrantLock(); + private final Condition progressed = lock.newCondition(); public PregenMantleBackpressure(Supplier mantleSupplier, int maxResidentTectonicPlates, int waitMs, long timeoutMs, Runnable onBudgetTimeout, Supplier diagnostics) { this(mantleSupplier, maxResidentTectonicPlates, waitMs, timeoutMs, onBudgetTimeout, diagnostics, () -> false); @@ -108,10 +113,7 @@ public final class PregenMantleBackpressure { + "), freed " + freed + " last pass, waited " + elapsed + "ms."); } - try { - Thread.sleep(waitMs); - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); + if (!awaitProgress()) { return; } } @@ -154,15 +156,34 @@ public final class PregenMantleBackpressure { + (mantle != null ? " (" + mantle.getLoadedRegionCount() + " plates resident)" : "") + "."); } - try { - Thread.sleep(waitMs); - } catch (InterruptedException e) { - Thread.currentThread().interrupt(); + if (!awaitProgress()) { return; } } } + public void signalProgress() { + lock.lock(); + try { + progressed.signalAll(); + } finally { + lock.unlock(); + } + } + + private boolean awaitProgress() { + lock.lock(); + try { + progressed.await(waitMs, TimeUnit.MILLISECONDS); + return true; + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + return false; + } finally { + lock.unlock(); + } + } + private boolean isCancelled() { if (Thread.currentThread().isInterrupted()) { return true; diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfile.java b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfile.java index 8c38746db..b59fe46de 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfile.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfile.java @@ -28,8 +28,11 @@ import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.iris.util.project.stream.utility.CachedDoubleStream2D; import java.util.Objects; +import java.util.concurrent.atomic.AtomicInteger; public final class PregenPerformanceProfile { + private static final AtomicInteger PARALLELISM_HOLDERS = new AtomicInteger(); + private PregenPerformanceProfile() { } @@ -45,12 +48,33 @@ public final class PregenPerformanceProfile { } if (MultiBurst.burst.raiseParallelism(pregenBurstParallelism(Runtime.getRuntime().availableProcessors()))) { + PARALLELISM_HOLDERS.incrementAndGet(); changed = true; } return changed; } + /** + * Releases one hold on the pregeneration burst parallelism. The pool returns to the parallelism it had + * before the first pregeneration raised it once the last concurrent job releases its hold. + */ + public static boolean restore() { + while (true) { + int holders = PARALLELISM_HOLDERS.get(); + if (holders <= 0) { + return false; + } + if (PARALLELISM_HOLDERS.compareAndSet(holders, holders - 1)) { + return holders == 1 && MultiBurst.burst.restoreParallelism(); + } + } + } + + static int parallelismHolders() { + return PARALLELISM_HOLDERS.get(); + } + public static void apply(Engine engine) { apply(); if (engine != null) { diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCache.java b/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCache.java index 9170ffd2a..a9e8df5ac 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCache.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCache.java @@ -6,10 +6,6 @@ import art.arcane.volmlib.util.documentation.RegionCoordinates; import java.io.File; public interface PregenCache { - default boolean isThreadSafe() { - return false; - } - @ChunkCoordinates boolean isChunkCached(int x, int z); @@ -32,16 +28,10 @@ public interface PregenCache { } default PregenCache sync() { - if (isThreadSafe()) return this; - return new SynchronizedCache(this); + return this; } PregenCache EMPTY = new PregenCache() { - @Override - public boolean isThreadSafe() { - return true; - } - @Override public boolean isChunkCached(int x, int z) { return false; diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCacheImpl.java b/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCacheImpl.java index 5c1409493..920d25006 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCacheImpl.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/cache/PregenCacheImpl.java @@ -26,6 +26,9 @@ import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLongArray; +import java.util.concurrent.atomic.AtomicReferenceArray; public class PregenCacheImpl implements PregenCache { // Daemon threads: this static pool is never shut down, and non-daemon threads here block JVM exit @@ -36,12 +39,15 @@ public class PregenCacheImpl implements PregenCache { return thread; }); private static final AtomicBoolean DISPATCHER_REGISTERED = new AtomicBoolean(); - private static final short SIZE = 1024; + private static final int SIZE = 1024; + private static final int RETIRED_WRITE_RETRIES = 4; private final File directory; private final int maxSize; private final AtomicBoolean missingStorageReported = new AtomicBoolean(); + private final Object residencyLock = new Object(); private final Long2ObjectLinkedOpenHashMap cache = new Long2ObjectLinkedOpenHashMap<>(); + private volatile Plate recent; public PregenCacheImpl(File directory, int maxSize) { this.directory = directory; @@ -78,35 +84,119 @@ public class PregenCacheImpl implements PregenCache { @Override @ChunkCoordinates public void cacheChunk(int x, int z) { - getPlate(PowerOfTwoCoordinates.floorDivPow2(x, 10), PowerOfTwoCoordinates.floorDivPow2(z, 10)).cache( - PowerOfTwoCoordinates.localMaskPow2(PowerOfTwoCoordinates.floorDivPow2(x, 5), PowerOfTwoCoordinates.REGION_CHUNK_BITS), - PowerOfTwoCoordinates.localMaskPow2(PowerOfTwoCoordinates.floorDivPow2(z, 5), PowerOfTwoCoordinates.REGION_CHUNK_BITS), - region -> region.cache( - PowerOfTwoCoordinates.localMaskPow2(x, PowerOfTwoCoordinates.REGION_CHUNK_BITS), - PowerOfTwoCoordinates.localMaskPow2(z, PowerOfTwoCoordinates.REGION_CHUNK_BITS) - ) - ); + int plateX = PowerOfTwoCoordinates.floorDivPow2(x, 10); + int plateZ = PowerOfTwoCoordinates.floorDivPow2(z, 10); + int regionX = PowerOfTwoCoordinates.localMaskPow2(PowerOfTwoCoordinates.floorDivPow2(x, 5), PowerOfTwoCoordinates.REGION_CHUNK_BITS); + int regionZ = PowerOfTwoCoordinates.localMaskPow2(PowerOfTwoCoordinates.floorDivPow2(z, 5), PowerOfTwoCoordinates.REGION_CHUNK_BITS); + int localX = PowerOfTwoCoordinates.localMaskPow2(x, PowerOfTwoCoordinates.REGION_CHUNK_BITS); + int localZ = PowerOfTwoCoordinates.localMaskPow2(z, PowerOfTwoCoordinates.REGION_CHUNK_BITS); + + for (int attempt = 0; attempt < RETIRED_WRITE_RETRIES; attempt++) { + Plate plate = getPlate(plateX, plateZ); + plate.cache(regionX, regionZ, region -> region.cache(localX, localZ)); + if (!plate.retired) { + return; + } + } } @Override @RegionCoordinates public void cacheRegion(int x, int z) { - getPlate(PowerOfTwoCoordinates.floorDivPow2(x, 5), PowerOfTwoCoordinates.floorDivPow2(z, 5)).cache( - PowerOfTwoCoordinates.localMaskPow2(x, PowerOfTwoCoordinates.REGION_CHUNK_BITS), - PowerOfTwoCoordinates.localMaskPow2(z, PowerOfTwoCoordinates.REGION_CHUNK_BITS), - Region::cache - ); + int plateX = PowerOfTwoCoordinates.floorDivPow2(x, 5); + int plateZ = PowerOfTwoCoordinates.floorDivPow2(z, 5); + int regionX = PowerOfTwoCoordinates.localMaskPow2(x, PowerOfTwoCoordinates.REGION_CHUNK_BITS); + int regionZ = PowerOfTwoCoordinates.localMaskPow2(z, PowerOfTwoCoordinates.REGION_CHUNK_BITS); + + for (int attempt = 0; attempt < RETIRED_WRITE_RETRIES; attempt++) { + Plate plate = getPlate(plateX, plateZ); + plate.cache(regionX, regionZ, Region::cache); + if (!plate.retired) { + return; + } + } } @Override public void write() { - if (cache.isEmpty()) { + List resident; + synchronized (residencyLock) { + if (cache.isEmpty()) { + return; + } + resident = new ArrayList<>(cache.values()); + } + + writePlates(resident); + } + + @Override + public void trim(long unloadDuration) { + synchronized (residencyLock) { + if (cache.isEmpty()) { + return; + } + + long threshold = System.currentTimeMillis() - unloadDuration; + List resident = new ArrayList<>(cache.size()); + Iterator iterator = cache.values().iterator(); + while (iterator.hasNext()) { + Plate plate = iterator.next(); + if (plate.lastAccess < threshold) { + iterator.remove(); + plate.retired = true; + } + resident.add(plate); + } + + writePlates(resident); + } + } + + private Plate getPlate(int x, int z) { + long key = key(x, z); + Plate memo = recent; + if (memo != null && memo.key == key && !memo.retired) { + return memo; + } + + return residePlate(key, x, z); + } + + private Plate residePlate(long key, int x, int z) { + Plate resolved; + synchronized (residencyLock) { + resolved = cache.getAndMoveToFirst(key); + if (resolved == null) { + resolved = readPlate(key, x, z); + cache.putAndMoveToFirst(key, resolved); + List evicted = null; + while (cache.size() > maxSize) { + Plate removed = cache.removeLast(); + removed.retired = true; + if (evicted == null) { + evicted = new ArrayList<>(2); + } + evicted.add(removed); + } + if (evicted != null) { + writePlates(evicted); + } + } + } + + recent = resolved; + return resolved; + } + + private void writePlates(List plates) { + if (plates.isEmpty()) { return; } - List> futures = new ArrayList<>(cache.size()); - for (Plate plate : cache.values()) { - if (!plate.dirty) { + List> futures = new ArrayList<>(plates.size()); + for (Plate plate : plates) { + if (!plate.dirty.get()) { continue; } futures.add(CompletableFuture.runAsync(() -> writePlate(plate), DISPATCHER)); @@ -117,84 +207,41 @@ public class PregenCacheImpl implements PregenCache { } } - @Override - public void trim(long unloadDuration) { - if (cache.isEmpty()) { - return; - } - - long threshold = System.currentTimeMillis() - unloadDuration; - List> futures = new ArrayList<>(cache.size()); - Iterator iterator = cache.values().iterator(); - while (iterator.hasNext()) { - Plate plate = iterator.next(); - if (plate.lastAccess < threshold) { - iterator.remove(); - } - futures.add(CompletableFuture.runAsync(() -> writePlate(plate), DISPATCHER)); - } - - for (CompletableFuture future : futures) { - future.join(); - } - } - - private Plate getPlate(int x, int z) { - long key = key(x, z); - Plate plate = cache.getAndMoveToFirst(key); - if (plate != null) { - return plate; - } - - Plate loaded = readPlate(x, z); - cache.putAndMoveToFirst(key, loaded); - - if (cache.size() > maxSize) { - List> futures = new ArrayList<>(cache.size() - maxSize); - while (cache.size() > maxSize) { - Plate evicted = cache.removeLast(); - futures.add(CompletableFuture.runAsync(() -> writePlate(evicted), DISPATCHER)); - } - for (CompletableFuture future : futures) { - future.join(); - } - } - - return loaded; - } - - private Plate readPlate(int x, int z) { + private Plate readPlate(long key, int x, int z) { File file = fileForPlate(x, z); if (!file.exists()) { - return new Plate(x, z); + return new Plate(key, x, z); } try (DataInputStream input = new DataInputStream(new LZ4BlockInputStream(new FileInputStream(file)))) { - return readPlate(x, z, input); + return readPlate(key, x, z, input); } catch (IOException e) { IrisLogging.error("Failed to read pregen cache " + file); IrisLogging.reportError(e); } - return new Plate(x, z); + return new Plate(key, x, z); } private void writePlate(Plate plate) { - if (!plate.dirty) { - return; - } - if (!prepareCacheDirectory()) { - return; - } + synchronized (plate) { + if (!plate.dirty.compareAndSet(true, false)) { + return; + } + if (!prepareCacheDirectory()) { + plate.dirty.set(true); + return; + } - File file = null; - try { - file = fileForPlate(plate.x, plate.z); - IO.write(file, output -> new DataOutputStream(new LZ4BlockOutputStream(output)), plate::write); - plate.dirty = false; - } catch (Throwable e) { - IrisLogging.error("Failed to write pregen cache " + (file != null ? file : "c." + plate.x + "." + plate.z)); - IrisLogging.reportError(e); + File file = null; + try { + file = fileForPlate(plate.x, plate.z); + IO.write(file, output -> new DataOutputStream(new LZ4BlockOutputStream(output)), plate::write); + } catch (Throwable e) { + plate.dirty.set(true); + IrisLogging.error("Failed to write pregen cache " + (file != null ? file : "c." + plate.x + "." + plate.z)); + IrisLogging.reportError(e); + } } } @@ -243,36 +290,48 @@ public class PregenCacheImpl implements PregenCache { } private static class Plate { + private final long key; private final int x; private final int z; - private short count; - private Region[] regions; - private boolean dirty; - private long lastAccess; + private final AtomicInteger count; + private final AtomicReferenceArray regions; + private final AtomicBoolean dirty = new AtomicBoolean(); + private volatile long lastAccess; + private volatile boolean retired; - private Plate(int x, int z) { - this(x, z, (short) 0, new Region[1024]); + private Plate(long key, int x, int z) { + this(key, x, z, 0, new AtomicReferenceArray<>(SIZE)); } - private Plate(int x, int z, short count, Region[] regions) { + private Plate(long key, int x, int z, int count, AtomicReferenceArray regions) { + this.key = key; this.x = x; this.z = z; - this.count = count; + this.count = new AtomicInteger(count); this.regions = regions; this.lastAccess = System.currentTimeMillis(); } + private int completed() { + return Math.min(count.get(), SIZE); + } + private boolean cache(int x, int z, RegionCacheOp op) { lastAccess = System.currentTimeMillis(); - if (count == SIZE) { + if (completed() == SIZE) { + return false; + } + + AtomicReferenceArray current = regions; + if (current == null) { return false; } int index = PowerOfTwoCoordinates.packLocal32(x, z); - Region region = regions[index]; + Region region = current.get(index); if (region == null) { - region = new Region(); - regions[index] = region; + Region created = new Region(); + region = current.compareAndSet(index, null, created) ? created : current.get(index); } CacheResult result = op.apply(region); @@ -280,25 +339,26 @@ public class PregenCacheImpl implements PregenCache { return false; } - dirty = true; + dirty.set(true); if (result != CacheResult.COMPLETED) { return false; } - count++; - if (count == SIZE) { - regions = null; - } - return true; + return count.incrementAndGet() >= SIZE; } private boolean isCached(int x, int z, RegionPredicate predicate) { lastAccess = System.currentTimeMillis(); - if (count == SIZE) { + if (completed() == SIZE) { return true; } - Region region = regions[PowerOfTwoCoordinates.packLocal32(x, z)]; + AtomicReferenceArray current = regions; + if (current == null) { + return true; + } + + Region region = current.get(PowerOfTwoCoordinates.packLocal32(x, z)); if (region == null) { return false; } @@ -306,12 +366,15 @@ public class PregenCacheImpl implements PregenCache { } private void write(DataOutput output) throws IOException { - Varint.writeSignedVarInt(count, output); - if (regions == null) { + int total = completed(); + Varint.writeSignedVarInt(total, output); + AtomicReferenceArray current = regions; + if (total == SIZE || current == null) { return; } - for (Region region : regions) { + for (int index = 0; index < SIZE; index++) { + Region region = current.get(index); output.writeBoolean(region == null); if (region != null) { region.write(output); @@ -321,33 +384,32 @@ public class PregenCacheImpl implements PregenCache { } private static class Region { - private short count; - private long[] words; + private final AtomicInteger count; + private final AtomicLongArray words; private Region() { - this((short) 0, new long[64]); + this(0, new AtomicLongArray(64)); } - private Region(short count, long[] words) { - this.count = count; + private Region(int count, AtomicLongArray words) { + this.count = new AtomicInteger(count); this.words = words; } + private int completed() { + return Math.min(count.get(), SIZE); + } + private CacheResult cache() { - if (count == SIZE) { - return CacheResult.NOOP; - } - count = SIZE; - words = null; - return CacheResult.COMPLETED; + return count.getAndSet(SIZE) >= SIZE ? CacheResult.NOOP : CacheResult.COMPLETED; } private CacheResult cache(int x, int z) { - if (count == SIZE) { + if (completed() == SIZE) { return CacheResult.NOOP; } - long[] value = words; + AtomicLongArray value = words; if (value == null) { return CacheResult.NOOP; } @@ -355,73 +417,79 @@ public class PregenCacheImpl implements PregenCache { int index = PowerOfTwoCoordinates.packLocal32(x, z); int wordIndex = index >> 6; long bit = 1L << (index & 63); - boolean current = (value[wordIndex] & bit) != 0L; - if (current) { - return CacheResult.NOOP; + while (true) { + long current = value.get(wordIndex); + if ((current & bit) != 0L) { + return CacheResult.NOOP; + } + if (value.compareAndSet(wordIndex, current, current | bit)) { + break; + } } - count++; - if (count == SIZE) { - words = null; - return CacheResult.COMPLETED; - } - - value[wordIndex] = value[wordIndex] | bit; - return CacheResult.SET; + return count.incrementAndGet() >= SIZE ? CacheResult.COMPLETED : CacheResult.SET; } private boolean isCached() { - return count == SIZE; + return completed() == SIZE; } private boolean isCached(int x, int z) { - int index = PowerOfTwoCoordinates.packLocal32(x, z); - if (count == SIZE) { + if (completed() == SIZE) { return true; } - return (words[index >> 6] & (1L << (index & 63))) != 0L; + + AtomicLongArray value = words; + if (value == null) { + return true; + } + + int index = PowerOfTwoCoordinates.packLocal32(x, z); + return (value.get(index >> 6) & (1L << (index & 63))) != 0L; } private void write(DataOutput output) throws IOException { - Varint.writeSignedVarInt(count, output); - if (words == null) { + int total = completed(); + Varint.writeSignedVarInt(total, output); + AtomicLongArray value = words; + if (total == SIZE || value == null) { return; } - for (long word : words) { - Varint.writeUnsignedVarLong(word, output); + for (int index = 0; index < value.length(); index++) { + Varint.writeUnsignedVarLong(value.get(index), output); } } } - private static Plate readPlate(int x, int z, DataInput input) throws IOException { + private static Plate readPlate(long key, int x, int z, DataInput input) throws IOException { int count = Varint.readSignedVarInt(input); - if (count == 1024) { - return new Plate(x, z, SIZE, null); + if (count == SIZE) { + return new Plate(key, x, z, SIZE, null); } - Region[] regions = new Region[1024]; - for (int i = 0; i < regions.length; i++) { + AtomicReferenceArray regions = new AtomicReferenceArray<>(SIZE); + for (int index = 0; index < SIZE; index++) { boolean isNull = input.readBoolean(); if (!isNull) { - regions[i] = readRegion(input); + regions.set(index, readRegion(input)); } } - return new Plate(x, z, (short) count, regions); + return new Plate(key, x, z, count, regions); } private static Region readRegion(DataInput input) throws IOException { int count = Varint.readSignedVarInt(input); - if (count == 1024) { + if (count == SIZE) { return new Region(SIZE, null); } - long[] words = new long[64]; - for (int i = 0; i < words.length; i++) { - words[i] = Varint.readUnsignedVarLong(input); + AtomicLongArray words = new AtomicLongArray(64); + for (int index = 0; index < words.length(); index++) { + words.set(index, Varint.readUnsignedVarLong(input)); } - return new Region((short) count, words); + return new Region(count, words); } } diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/SynchronizedCache.java b/core/src/main/java/art/arcane/iris/core/pregenerator/cache/SynchronizedCache.java deleted file mode 100644 index 2605ada76..000000000 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/cache/SynchronizedCache.java +++ /dev/null @@ -1,50 +0,0 @@ -package art.arcane.iris.core.pregenerator.cache; - -record SynchronizedCache(PregenCache cache) implements PregenCache { - @Override - public boolean isThreadSafe() { - return true; - } - - @Override - public boolean isChunkCached(int x, int z) { - synchronized (cache) { - return cache.isChunkCached(x, z); - } - } - - @Override - public boolean isRegionCached(int x, int z) { - synchronized (cache) { - return cache.isRegionCached(x, z); - } - } - - @Override - public void cacheChunk(int x, int z) { - synchronized (cache) { - cache.cacheChunk(x, z); - } - } - - @Override - public void cacheRegion(int x, int z) { - synchronized (cache) { - cache.cacheRegion(x, z); - } - } - - @Override - public void write() { - synchronized (cache) { - cache.write(); - } - } - - @Override - public void trim(long unloadDuration) { - synchronized (cache) { - cache.trim(unloadDuration); - } - } -} diff --git a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java index 811b5f285..53218d1c7 100644 --- a/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java +++ b/core/src/main/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java @@ -22,6 +22,7 @@ import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.core.IrisPaperLikeBackendMode; import art.arcane.iris.core.IrisRuntimeSchedulerMode; import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.core.pregenerator.PregenAdmissionGate; import art.arcane.iris.core.pregenerator.PregenDiagnostics; import art.arcane.iris.core.pregenerator.PregenListener; import art.arcane.iris.core.pregenerator.PregenMantleBackpressure; @@ -51,7 +52,6 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.Executor; import java.util.concurrent.ExecutorService; -import java.util.concurrent.Semaphore; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; @@ -68,6 +68,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { private static final int ADAPTIVE_RECOVERY_INTERVAL = 8; private static final long CLOSE_DRAIN_WARNING_SECONDS = 60L; private static final long FLUSH_TIMEOUT_SECONDS = 120L; + private static final long ADMISSION_WAIT_BOUND_MS = 500L; private final World world; private final IrisRuntimeSchedulerMode runtimeSchedulerMode; private final IrisPaperLikeBackendMode paperLikeBackendMode; @@ -82,7 +83,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { private final String chunkAccessMode; private final ChunkRequestExecutor executor; private final Executor slowRequestExecutor; - private final Semaphore semaphore; + private final PregenAdmissionGate admission; private final int threads; private final int slowRequestWarningSeconds; private final int slowRequestWarnIntervalMs; @@ -111,7 +112,6 @@ public class AsyncPregenMethod implements PregeneratorMethod { private final AtomicLong lastProgressAt = new AtomicLong(M.ms()); private final AtomicBoolean closing = new AtomicBoolean(); private final AtomicBoolean holdsWorkerBoost = new AtomicBoolean(); - private final Object permitMonitor = new Object(); private volatile Engine metricsEngine; private volatile Mantle cachedMantle; private final PregenMantleBackpressure backpressure; @@ -161,7 +161,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { this.runtimeCpuThreads = detectedCpuThreads; this.effectiveWorkerThreads = workerThreadsForCap; this.recommendedRuntimeConcurrencyCap = configuredThreads; - this.semaphore = new Semaphore(this.threads, true); + this.admission = new PregenAdmissionGate(this.threads, ADMISSION_WAIT_BOUND_MS, M::ms); this.slowRequestWarningSeconds = pregen.getChunkLoadTimeoutSeconds(); this.slowRequestExecutor = CompletableFuture.delayedExecutor(this.slowRequestWarningSeconds, TimeUnit.SECONDS); this.slowRequestWarnIntervalMs = pregen.getTimeoutWarnIntervalMs(); @@ -527,11 +527,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { } catch (Throwable e) { IrisLogging.reportError(e); } finally { - try { - markFinished(success); - } finally { - semaphore.release(); - } + markFinished(success); } } @@ -587,7 +583,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { int next = Math.max(adaptiveMinInFlightLimit, current - 1); if (adaptiveInFlightLimit.compareAndSet(current, next)) { logAdaptiveLimit("decrease", next); - notifyPermitWaiters(); + admission.wake(); return; } } @@ -603,7 +599,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { int next = nextAdaptiveInFlightLimit(current, threads); if (adaptiveInFlightLimit.compareAndSet(current, next)) { logAdaptiveLimit("increase", next); - notifyPermitWaiters(); + admission.wake(); return; } } @@ -689,7 +685,7 @@ public class AsyncPregenMethod implements PregeneratorMethod { private String metricsSnapshot() { long stalledFor = Math.max(0L, M.ms() - lastProgressAt.get()); return "world=" + world.getName() - + " permits=" + semaphore.availablePermits() + "/" + threads + + " permits=" + admission.availablePermits() + "/" + threads + " adaptiveLimit=" + adaptiveInFlightLimit.get() + " inFlight=" + inFlight.get() + " submitted=" + submitted.get() @@ -716,13 +712,8 @@ public class AsyncPregenMethod implements PregeneratorMethod { if (after < 0) { inFlight.compareAndSet(after, 0); } - notifyPermitWaiters(); - } - - private void notifyPermitWaiters() { - synchronized (permitMonitor) { - permitMonitor.notifyAll(); - } + admission.release(); + backpressure.signalProgress(); } private void recordAdaptiveWait(long waitedMs) { @@ -818,14 +809,12 @@ public class AsyncPregenMethod implements PregeneratorMethod { @Override public void close() { closing.set(true); - notifyPermitWaiters(); + admission.wake(); // A stop request interrupts the pregen worker; shield the drain and flush so chunks still hit disk. boolean interrupted = Thread.interrupted(); try { - interrupted |= awaitDrain( - semaphore, - threads, + interrupted |= admission.awaitDrain( CLOSE_DRAIN_WARNING_SECONDS, TimeUnit.SECONDS, () -> IrisLogging.warn("Async pregen is still draining outstanding chunks. " + metricsSnapshot()) @@ -843,26 +832,6 @@ public class AsyncPregenMethod implements PregeneratorMethod { } } - static boolean awaitDrain( - Semaphore semaphore, - int permits, - long warningInterval, - TimeUnit timeUnit, - Runnable onWait - ) { - boolean interrupted = false; - while (true) { - try { - if (semaphore.tryAcquire(permits, warningInterval, timeUnit)) { - return interrupted; - } - onWait.run(); - } catch (InterruptedException e) { - interrupted = true; - } - } - } - private boolean isCancelled() { return closing.get() || Thread.currentThread().isInterrupted(); } @@ -890,37 +859,26 @@ public class AsyncPregenMethod implements PregeneratorMethod { return; } + PregenAdmissionGate.Wait waited; try { - long waitStart = M.ms(); - synchronized (permitMonitor) { - while (inFlight.get() >= adaptiveInFlightLimit.get()) { - if (isCancelled()) { - return; - } - - permitMonitor.wait(500L); - } - } - long adaptiveWait = Math.max(0L, M.ms() - waitStart); - if (adaptiveWait > 0L) { - recordAdaptiveWait(adaptiveWait); - } - - long permitWaitStart = M.ms(); - while (!semaphore.tryAcquire(1, TimeUnit.SECONDS)) { - if (isCancelled()) { - return; - } - } - long permitWait = Math.max(0L, M.ms() - permitWaitStart); - if (permitWait > 0L) { - recordPermitWait(permitWait); - } + waited = admission.admit(() -> inFlight.get() >= adaptiveInFlightLimit.get(), this::isCancelled); } catch (InterruptedException e) { Thread.currentThread().interrupt(); return; } + if (waited == null) { + return; + } + + if (waited.adaptiveMs() > 0L) { + recordAdaptiveWait(waited.adaptiveMs()); + } + + if (waited.permitMs() > 0L) { + recordPermitWait(waited.permitMs()); + } + regionPending.computeIfAbsent(rkey(x >> 5, z >> 5), k -> new AtomicInteger(1)).incrementAndGet(); markSubmitted(); executor.generate(x, z, listener); diff --git a/core/src/main/java/art/arcane/iris/util/common/parallel/MultiBurst.java b/core/src/main/java/art/arcane/iris/util/common/parallel/MultiBurst.java index 88d6c48d6..f918668a5 100644 --- a/core/src/main/java/art/arcane/iris/util/common/parallel/MultiBurst.java +++ b/core/src/main/java/art/arcane/iris/util/common/parallel/MultiBurst.java @@ -10,6 +10,7 @@ import java.util.concurrent.CompletableFuture; import java.util.concurrent.ForkJoinPool; import java.util.concurrent.ForkJoinWorkerThread; import java.util.concurrent.Future; +import java.util.concurrent.atomic.AtomicInteger; import java.util.function.IntSupplier; public class MultiBurst extends MultiBurstSupport { @@ -21,6 +22,7 @@ public class MultiBurst extends MultiBurstSupport { * plans never pin the workers that chunk generation's short stage and mantle tasks need. */ public static final MultiBurst hydrology = new MultiBurst("Iris Hydrology", () -> Math.max(2, IrisSettings.getThreadCount(IrisSettings.get().getConcurrency().getParallelism()))); + private final AtomicInteger parallelismBaseline = new AtomicInteger(); public MultiBurst() { this("Iris"); @@ -41,16 +43,38 @@ public class MultiBurst extends MultiBurstSupport { /** * Raises the pool's parallelism to at least {@code target} workers. Pregeneration fans every * chunk's stages and mantle windows into this pool while some tasks block on unmanaged waits, - * so a pregeneration box wants more workers than cores; the pool never shrinks back. + * so a pregeneration box wants more workers than cores. {@link #restoreParallelism()} puts it back. */ public boolean raiseParallelism(int target) { if (!(service() instanceof ForkJoinPool pool) || target <= pool.getParallelism()) { return false; } + parallelismBaseline.compareAndSet(0, pool.getParallelism()); pool.setParallelism(target); return true; } + /** + * Returns the pool to the parallelism it had before the first {@link #raiseParallelism(int)} that took + * effect. A pool that was never raised, or that is not a {@link ForkJoinPool}, is left alone. + */ + public boolean restoreParallelism() { + int baseline = parallelismBaseline.getAndSet(0); + if (baseline <= 0 || !(service() instanceof ForkJoinPool pool) || pool.getParallelism() <= baseline) { + return false; + } + + try { + pool.setParallelism(baseline); + } catch (RuntimeException e) { + IrisLogging.reportError("Iris could not return the burst pool to its pre-pregeneration parallelism of " + + baseline + "; it stays at " + pool.getParallelism() + ".", e); + return false; + } + + return true; + } + public int parallelism() { return service() instanceof ForkJoinPool pool ? pool.getParallelism() : -1; } diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenAdmissionGateTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenAdmissionGateTest.java new file mode 100644 index 000000000..10e37013c --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenAdmissionGateTest.java @@ -0,0 +1,189 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicLong; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; + +public class PregenAdmissionGateTest { + private static final long GENEROUS_BOUND_MS = 60_000L; + + @Test + public void admissionConsumesOnePermitAndReturnsItOnRelease() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(2, GENEROUS_BOUND_MS, System::currentTimeMillis); + + assertEquals(2, gate.availablePermits()); + assertNotNull(gate.admit(() -> false, () -> false)); + assertEquals(1, gate.availablePermits()); + gate.release(); + assertEquals(2, gate.availablePermits()); + } + + @Test + public void releaseNeverPushesThePermitCountAboveTheConfiguredCeiling() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(1, GENEROUS_BOUND_MS, System::currentTimeMillis); + + gate.release(); + gate.release(); + + assertEquals(1, gate.availablePermits()); + assertNotNull(gate.admit(() -> false, () -> false)); + assertEquals(0, gate.availablePermits()); + } + + @Test + public void aBlockedAdmissionWakesOnTheReleaseSignalRatherThanTheTimeout() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(1, GENEROUS_BOUND_MS, System::currentTimeMillis); + assertNotNull(gate.admit(() -> false, () -> false)); + CountDownLatch started = new CountDownLatch(1); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + Future blocked = executor.submit(() -> { + started.countDown(); + return gate.admit(() -> false, () -> false); + }); + + assertTrue(started.await(5, TimeUnit.SECONDS)); + while (gate.availablePermits() != 0) { + Thread.onSpinWait(); + } + gate.release(); + + assertNotNull(blocked.get(5, TimeUnit.SECONDS)); + } finally { + executor.shutdownNow(); + } + } + + @Test + public void aBlockedAdmissionWakesOnTheAdaptiveLimitSignalWithoutWaitingOutTheBound() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(4, GENEROUS_BOUND_MS, System::currentTimeMillis); + AtomicBoolean overLimit = new AtomicBoolean(true); + CountDownLatch started = new CountDownLatch(1); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + Future blocked = executor.submit(() -> { + started.countDown(); + return gate.admit(overLimit::get, () -> false); + }); + + assertTrue(started.await(5, TimeUnit.SECONDS)); + Thread.yield(); + overLimit.set(false); + gate.wake(); + + assertNotNull(blocked.get(5, TimeUnit.SECONDS)); + assertEquals(3, gate.availablePermits()); + } finally { + executor.shutdownNow(); + } + } + + @Test + public void aCancelledAdmissionReturnsNothingAndConsumesNoPermit() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(1, GENEROUS_BOUND_MS, System::currentTimeMillis); + + assertNull(gate.admit(() -> true, () -> true)); + assertEquals(1, gate.availablePermits()); + } + + @Test + public void aCancellationRaisedWhileBlockedEndsTheWait() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(1, GENEROUS_BOUND_MS, System::currentTimeMillis); + assertNotNull(gate.admit(() -> false, () -> false)); + AtomicBoolean cancelled = new AtomicBoolean(); + CountDownLatch started = new CountDownLatch(1); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + Future blocked = executor.submit(() -> { + started.countDown(); + return gate.admit(() -> false, cancelled::get); + }); + + assertTrue(started.await(5, TimeUnit.SECONDS)); + Thread.yield(); + cancelled.set(true); + gate.wake(); + + assertNull(blocked.get(5, TimeUnit.SECONDS)); + assertEquals(0, gate.availablePermits()); + } finally { + executor.shutdownNow(); + } + } + + @Test + public void theAdaptiveAndPermitWaitsAreAttributedSeparately() throws Exception { + AtomicLong clock = new AtomicLong(); + AtomicBoolean overLimit = new AtomicBoolean(true); + PregenAdmissionGate gate = new PregenAdmissionGate(1, 5L, () -> clock.addAndGet(10L)); + assertNotNull(gate.admit(() -> false, () -> false)); + + AtomicInteger passes = new AtomicInteger(); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + Future blocked = executor.submit(() -> gate.admit(() -> { + if (passes.incrementAndGet() > 2) { + overLimit.set(false); + } + return overLimit.get(); + }, () -> false)); + + while (passes.get() <= 3) { + Thread.onSpinWait(); + } + gate.release(); + + PregenAdmissionGate.Wait wait = blocked.get(5, TimeUnit.SECONDS); + assertNotNull(wait); + assertTrue("adaptive wait was not attributed: " + wait, wait.adaptiveMs() > 0L); + assertTrue("permit wait was not attributed: " + wait, wait.permitMs() > 0L); + } finally { + executor.shutdownNow(); + } + } + + @Test + public void drainReturnsOnlyAfterEveryPermitIsBack() throws Exception { + PregenAdmissionGate gate = new PregenAdmissionGate(2, GENEROUS_BOUND_MS, System::currentTimeMillis); + assertNotNull(gate.admit(() -> false, () -> false)); + assertNotNull(gate.admit(() -> false, () -> false)); + AtomicInteger warnings = new AtomicInteger(); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + Future drain = executor.submit(() -> gate.awaitDrain(5L, TimeUnit.MILLISECONDS, warnings::incrementAndGet)); + + while (warnings.get() < 2) { + Thread.onSpinWait(); + } + gate.release(); + gate.release(); + + assertEquals(Boolean.FALSE, drain.get(5, TimeUnit.SECONDS)); + assertEquals(2, gate.availablePermits()); + } finally { + executor.shutdownNow(); + } + } + + @Test(expected = IllegalArgumentException.class) + public void aGateWithoutPermitsIsRejected() { + new PregenAdmissionGate(0, GENEROUS_BOUND_MS, System::currentTimeMillis); + } + + @Test(expected = IllegalArgumentException.class) + public void aGateWithoutAWaitBoundIsRejected() { + new PregenAdmissionGate(1, 0L, System::currentTimeMillis); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfileTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfileTest.java index 2ea3869fe..56966becb 100644 --- a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfileTest.java +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenPerformanceProfileTest.java @@ -107,4 +107,41 @@ public class PregenPerformanceProfileTest { assertEquals(before + 1, MultiBurst.burst.parallelism()); assertFalse(MultiBurst.burst.raiseParallelism(before)); } + + @Test + public void restoringBurstParallelismReturnsThePoolToItsPrePregenerationSize() { + int before = MultiBurst.ioBurst.parallelism(); + assertTrue(MultiBurst.ioBurst.raiseParallelism(before + 3)); + assertEquals(before + 3, MultiBurst.ioBurst.parallelism()); + + assertTrue(MultiBurst.ioBurst.restoreParallelism()); + assertEquals(before, MultiBurst.ioBurst.parallelism()); + assertFalse(MultiBurst.ioBurst.restoreParallelism()); + assertEquals(before, MultiBurst.ioBurst.parallelism()); + } + + @Test + public void aSecondRaiseKeepsTheOriginalBaselineSoOneRestoreIsEnough() { + int before = MultiBurst.ioBurst.parallelism(); + assertTrue(MultiBurst.ioBurst.raiseParallelism(before + 2)); + assertTrue(MultiBurst.ioBurst.raiseParallelism(before + 5)); + + assertTrue(MultiBurst.ioBurst.restoreParallelism()); + assertEquals(before, MultiBurst.ioBurst.parallelism()); + } + + @Test + public void theBurstParallelismHoldIsReleasedByAMatchingRestore() { + while (PregenPerformanceProfile.parallelismHolders() > 0) { + PregenPerformanceProfile.restore(); + } + assertFalse(PregenPerformanceProfile.restore()); + assertEquals(0, PregenPerformanceProfile.parallelismHolders()); + + PregenPerformanceProfile.apply(); + int holders = PregenPerformanceProfile.parallelismHolders(); + PregenPerformanceProfile.restore(); + + assertEquals(Math.max(0, holders - 1), PregenPerformanceProfile.parallelismHolders()); + } } diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenWaitPolicyContractTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenWaitPolicyContractTest.java new file mode 100644 index 000000000..e9908925b --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenWaitPolicyContractTest.java @@ -0,0 +1,111 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import java.io.IOException; +import java.net.URISyntaxException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Stream; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class PregenWaitPolicyContractTest { + @Test + public void noPregenSourceSleepPollsWhileWaitingForCapacity() throws IOException { + List offenders = new ArrayList<>(); + Path pregenRoot = sourceRoot().resolve("art/arcane/iris/core/pregenerator"); + try (Stream sources = Files.walk(pregenRoot)) { + for (Path source : sources.filter(path -> path.toString().endsWith(".java")).toList()) { + String text = Files.readString(source); + if (text.contains("Thread.sleep(") || text.contains("J.sleep(")) { + offenders.add(source.getFileName().toString()); + } + } + } + + assertEquals("sleep polling on the pregen path: " + offenders, List.of(), offenders); + } + + @Test + public void mantleBackpressureWaitsOnAProgressSignalWithABoundedTimeout() throws IOException { + String backpressure = read("art/arcane/iris/core/pregenerator/PregenMantleBackpressure.java"); + + assertTrue(backpressure.contains("progressed.await(waitMs, TimeUnit.MILLISECONDS)")); + assertTrue(method(backpressure, "public void enforceMantleBudget()").contains("awaitProgress()")); + assertTrue(method(backpressure, "public void awaitHeapHeadroom()").contains("awaitProgress()")); + } + + @Test + public void chunkCompletionSignalsBothTheAdmissionGateAndTheBackpressureWait() throws IOException { + String finished = method(read("art/arcane/iris/core/pregenerator/methods/AsyncPregenMethod.java"), + "private void markFinished(boolean success)"); + + assertTrue(finished, finished.contains("admission.release()")); + assertTrue(finished, finished.contains("backpressure.signalProgress()")); + } + + @Test + public void pauseResumeAndStopSignalThePregenGateInsteadOfLettingItPoll() throws IOException { + String pregenerator = read("art/arcane/iris/core/pregenerator/IrisPregenerator.java"); + + assertTrue(method(pregenerator, "public void pause()").contains("signalState()")); + assertTrue(method(pregenerator, "public void resume()").contains("signalState()")); + assertTrue(method(pregenerator, "public void close()").contains("signalState()")); + assertTrue(method(pregenerator, "private void visitRegion(").contains("awaitStateChange(GATE_WAIT_MS)")); + assertTrue(method(pregenerator, "private void reclaimTectonicPlates(").contains("awaitStateChange(RECLAIM_WAIT_MS)")); + } + + @Test + public void aFinishedPregenReleasesTheBurstParallelismItRaised() throws IOException { + String shutdown = method(read("art/arcane/iris/core/pregenerator/IrisPregenerator.java"), "private void shutdown()"); + + assertTrue(shutdown, shutdown.contains("shutdownStep(\"parallelism\", PregenPerformanceProfile::restore)")); + } + + private static Path sourceRoot() throws IOException { + Path current; + try { + current = Path.of(PregenWaitPolicyContractTest.class.getProtectionDomain() + .getCodeSource() + .getLocation() + .toURI()); + } catch (URISyntaxException e) { + throw new IOException("Unable to resolve the core source root", e); + } + while (current != null && !Files.isDirectory(current.resolve("src/main/java"))) { + current = current.getParent(); + } + if (current == null) { + throw new IOException("Unable to locate the core source root"); + } + return current.resolve("src/main/java"); + } + + private static String read(String relativePath) throws IOException { + return Files.readString(sourceRoot().resolve(relativePath)); + } + + private static String method(String source, String signature) { + int start = source.indexOf(signature); + assertTrue("Missing source contract signature: " + signature, start >= 0); + int openBrace = source.indexOf('{', start); + assertTrue("Missing source contract method body: " + signature, openBrace >= 0); + int depth = 0; + for (int index = openBrace; index < source.length(); index++) { + char current = source.charAt(index); + if (current == '{') { + depth++; + } else if (current == '}') { + depth--; + if (depth == 0) { + return source.substring(start, index + 1); + } + } + } + throw new IllegalArgumentException("Unclosed source contract method: " + signature); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheConcurrencyTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheConcurrencyTest.java new file mode 100644 index 000000000..a960113b6 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheConcurrencyTest.java @@ -0,0 +1,194 @@ +package art.arcane.iris.core.pregenerator.cache; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import java.io.File; +import java.nio.file.Files; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.Callable; +import java.util.concurrent.CyclicBarrier; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class PregenCacheConcurrencyTest { + private static final int THREADS = 8; + + private File directory; + private ExecutorService pool; + + @Before + public void setUp() throws Exception { + directory = Files.createTempDirectory("iris-pregen-cache-concurrency").toFile(); + pool = Executors.newFixedThreadPool(THREADS); + } + + @After + public void tearDown() throws Exception { + pool.shutdownNow(); + pool.awaitTermination(30, TimeUnit.SECONDS); + deleteRecursively(directory); + } + + @Test + public void everyConcurrentlyCachedChunkIsReadBackAsCached() throws Exception { + PregenCache cache = PregenCache.create(directory); + int chunksPerThread = 512; + runAll(thread -> () -> { + for (int index = 0; index < chunksPerThread; index++) { + int x = (thread * chunksPerThread) + index; + cache.cacheChunk(x, thread); + } + return null; + }); + + for (int thread = 0; thread < THREADS; thread++) { + for (int index = 0; index < chunksPerThread; index++) { + int x = (thread * chunksPerThread) + index; + assertTrue("chunk " + x + "," + thread, cache.isChunkCached(x, thread)); + } + } + } + + @Test + public void concurrentWritersToOneRegionNeverLoseABit() throws Exception { + PregenCache cache = PregenCache.create(directory); + runAll(thread -> () -> { + for (int index = thread; index < 1024; index += THREADS) { + cache.cacheChunk(index & 31, index >> 5); + } + return null; + }); + + for (int index = 0; index < 1024; index++) { + assertTrue("chunk " + index, cache.isChunkCached(index & 31, index >> 5)); + } + assertTrue(cache.isRegionCached(0, 0)); + } + + @Test + public void aRegionIsOnlyReportedCachedOnceEveryChunkInItLanded() throws Exception { + PregenCache cache = PregenCache.create(directory); + AtomicInteger seenComplete = new AtomicInteger(); + runAll(thread -> () -> { + for (int index = thread; index < 1023; index += THREADS) { + cache.cacheChunk(index & 31, index >> 5); + if (cache.isRegionCached(0, 0)) { + seenComplete.incrementAndGet(); + } + } + return null; + }); + + assertEquals(0, seenComplete.get()); + assertFalse(cache.isRegionCached(0, 0)); + cache.cacheChunk(1023 & 31, 1023 >> 5); + assertTrue(cache.isRegionCached(0, 0)); + } + + @Test + public void concurrentReadsAndWritesNeverInventACachedChunk() throws Exception { + PregenCache cache = PregenCache.create(directory); + AtomicInteger falsePositives = new AtomicInteger(); + runAll(thread -> () -> { + if (thread % 2 == 0) { + for (int index = 0; index < 2048; index++) { + cache.cacheChunk(index, 0); + } + return null; + } + + for (int index = 0; index < 2048; index++) { + if (cache.isChunkCached(index, 7000)) { + falsePositives.incrementAndGet(); + } + } + return null; + }); + + assertEquals(0, falsePositives.get()); + } + + @Test + public void aConcurrentWriteAndFlushRoundTripsThroughDiskWithoutLosingChunks() throws Exception { + PregenCache cache = PregenCache.create(directory); + runAll(thread -> () -> { + for (int index = 0; index < 256; index++) { + cache.cacheChunk((thread * 256) + index, 4); + if (index % 64 == 0) { + cache.write(); + } + } + return null; + }); + cache.write(); + + PregenCache reopened = PregenCache.create(directory); + for (int thread = 0; thread < THREADS; thread++) { + for (int index = 0; index < 256; index++) { + int x = (thread * 256) + index; + assertTrue("chunk " + x + " lost across a flush", reopened.isChunkCached(x, 4)); + } + } + } + + @Test + public void plateEvictionUnderConcurrencyStillPersistsEveryChunk() throws Exception { + PregenCacheImpl cache = new PregenCacheImpl(directory, 1); + int platesPerThread = 6; + runAll(thread -> () -> { + for (int plate = 0; plate < platesPerThread; plate++) { + cache.cacheChunk(plate * 1024, thread); + } + return null; + }); + cache.write(); + + PregenCache reopened = PregenCache.create(directory); + for (int thread = 0; thread < THREADS; thread++) { + for (int plate = 0; plate < platesPerThread; plate++) { + assertTrue("chunk " + (plate * 1024) + "," + thread + " lost to eviction", + reopened.isChunkCached(plate * 1024, thread)); + } + } + } + + private void runAll(ThreadTask task) throws Exception { + CyclicBarrier barrier = new CyclicBarrier(THREADS); + List> futures = new ArrayList<>(THREADS); + for (int thread = 0; thread < THREADS; thread++) { + Callable body = task.forThread(thread); + futures.add(pool.submit(() -> { + barrier.await(30, TimeUnit.SECONDS); + return body.call(); + })); + } + + for (Future future : futures) { + future.get(60, TimeUnit.SECONDS); + } + } + + private static void deleteRecursively(File file) { + File[] children = file.listFiles(); + if (children != null) { + for (File child : children) { + deleteRecursively(child); + } + } + file.delete(); + } + + private interface ThreadTask { + Callable forThread(int thread); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethodConcurrencyCapTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethodConcurrencyCapTest.java index a95d0209e..9a065a227 100644 --- a/core/src/test/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethodConcurrencyCapTest.java +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/methods/AsyncPregenMethodConcurrencyCapTest.java @@ -1,17 +1,18 @@ package art.arcane.iris.core.pregenerator.methods; +import art.arcane.iris.core.pregenerator.PregenAdmissionGate; import org.junit.Test; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; -import java.util.concurrent.Semaphore; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicInteger; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; @@ -101,13 +102,13 @@ public class AsyncPregenMethodConcurrencyCapTest { @Test public void closeDrainWaitsPastWarningIntervalsUntilEveryPermitReturns() throws Exception { - Semaphore semaphore = new Semaphore(0); + PregenAdmissionGate gate = new PregenAdmissionGate(2, 5L, System::currentTimeMillis); + assertNotNull(gate.admit(() -> false, () -> false)); + assertNotNull(gate.admit(() -> false, () -> false)); AtomicInteger warnings = new AtomicInteger(); ExecutorService executor = Executors.newSingleThreadExecutor(); try { - Future drain = executor.submit(() -> AsyncPregenMethod.awaitDrain( - semaphore, - 2, + Future drain = executor.submit(() -> gate.awaitDrain( 10L, TimeUnit.MILLISECONDS, warnings::incrementAndGet @@ -116,11 +117,12 @@ public class AsyncPregenMethodConcurrencyCapTest { while (warnings.get() == 0) { Thread.onSpinWait(); } - semaphore.release(2); + gate.release(); + gate.release(); assertFalse(drain.get(1L, TimeUnit.SECONDS)); assertTrue(warnings.get() > 0); - assertEquals(0, semaphore.availablePermits()); + assertEquals(2, gate.availablePermits()); } finally { executor.shutdownNow(); } From 79af11c435d0482974422126b84cdc4ca82839a4 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:54:17 -0400 Subject: [PATCH 11/35] Trim generation hot path allocations - Replace the six per-voxel IrisPosition probes in MantleWriter neighborhood hollowing with an origin-relative primitive key set - Look mask membership up through the same primitive key set instead of allocating an IrisPosition per candidate voxel - Give the squared-distance helper a fixed arity so ballooning no longer depends on escape analysis to drop its varargs array - Resolve each Matter slice once per write instead of paying a hasSlice probe and a getSlice lookup for the same class - Read the river water surface through the primitive stream accessor instead of boxing a Double per column - Add nullable primary surface layer accessors so the terrain actuator stops building two Optionals per column - Add MantleWriterNeighborhoodTest, MantleWriterNeighborhoodBenchmarkTest and HydrologyColumnSampleAccessorTest --- .../actuator/IrisTerrainNormalActuator.java | 8 +- .../hydrology/HydrologyColumnSample.java | 19 +- .../iris/engine/mantle/MantleWriter.java | 154 ++++++++++----- .../HydrologyColumnSampleAccessorTest.java | 153 +++++++++++++++ ...MantleWriterNeighborhoodBenchmarkTest.java | 125 ++++++++++++ .../mantle/MantleWriterNeighborhoodTest.java | 184 ++++++++++++++++++ 6 files changed, 580 insertions(+), 63 deletions(-) create mode 100644 core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodBenchmarkTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodTest.java diff --git a/core/src/main/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuator.java b/core/src/main/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuator.java index 6d31bff52..67b5cb45b 100644 --- a/core/src/main/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuator.java +++ b/core/src/main/java/art/arcane/iris/engine/actuator/IrisTerrainNormalActuator.java @@ -22,6 +22,7 @@ import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.engine.framework.EngineAssignedActuator; import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.engine.IrisComplex; +import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.iris.engine.UpperDimensionContext; import art.arcane.iris.engine.hydrology.HydrologyColumnLayer; import art.arcane.iris.engine.hydrology.HydrologyColumnSample; @@ -84,6 +85,7 @@ public class IrisTerrainNormalActuator extends EngineAssignedActuator riverWaterSurfaceStream = complex.getRiverWaterSurfaceStream(); RNG localRng = rng; boolean bedrockEnabled = dimension.isBedrock(); boolean hideOres = dimension.isHideOresForHiddenOre(); @@ -117,7 +119,7 @@ public class IrisTerrainNormalActuator extends EngineAssignedActuator primarySurfaceLayer() { - return selectSurfaceLayer(false); + return Optional.ofNullable(selectSurfaceLayer(false)); } public Optional primarySurfaceFluidLayer() { + return Optional.ofNullable(selectSurfaceLayer(true)); + } + + public HydrologyColumnLayer primarySurfaceLayerOrNull() { + return selectSurfaceLayer(false); + } + + public HydrologyColumnLayer primarySurfaceFluidLayerOrNull() { return selectSurfaceLayer(true); } @@ -120,11 +128,10 @@ public record HydrologyColumnSample( } public int terrainHeight() { - Optional layer = primarySurfaceLayer(); - if (layer.isEmpty()) { + HydrologyColumnLayer primary = selectSurfaceLayer(false); + if (primary == null) { return naturalHeight; } - HydrologyColumnLayer primary = layer.get(); if (primary.channel()) { return primary.bedY(); } @@ -147,7 +154,7 @@ public record HydrologyColumnSample( return new HydrologyRenderSample(x, z, features); } - private Optional selectSurfaceLayer(boolean fluidOnly) { + private HydrologyColumnLayer selectSurfaceLayer(boolean fluidOnly) { HydrologyColumnLayer selected = null; for (HydrologyColumnLayer layer : layers) { if (layer.oceanApron() || !layer.feature().type().isSurface()) { @@ -164,7 +171,7 @@ public record HydrologyColumnSample( selected = layer; } } - return Optional.ofNullable(selected); + return selected; } private static int surfaceRolePriority(HydrologyColumnLayer layer) { diff --git a/core/src/main/java/art/arcane/iris/engine/mantle/MantleWriter.java b/core/src/main/java/art/arcane/iris/engine/mantle/MantleWriter.java index 8c8c5b7b4..1c3a92817 100644 --- a/core/src/main/java/art/arcane/iris/engine/mantle/MantleWriter.java +++ b/core/src/main/java/art/arcane/iris/engine/mantle/MantleWriter.java @@ -23,6 +23,7 @@ import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.util.project.matter.TileWrapper; import art.arcane.iris.util.project.matter.PreObjectMatterCell; import com.google.common.collect.ImmutableList; +import it.unimi.dsi.fastutil.longs.LongOpenHashSet; import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.link.Identifier; import art.arcane.iris.core.tools.WorldMaintenance; @@ -175,7 +176,7 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { } } - private static Set getBallooned(Set vset, double radius) { + static Set getBallooned(Set vset, double radius) { Set returnset = new HashSet<>(); int ceilrad = (int) Math.ceil(radius); double r2 = Math.pow(radius, 2); @@ -198,30 +199,83 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { return returnset; } - private static Set getHollowed(Set vset) { + static Set getHollowed(Set vset) { + PositionLookup lookup = PositionLookup.of(vset); Set returnset = new KSet<>(); for (IrisPosition v : vset) { - double x = v.getX(); - double y = v.getY(); - double z = v.getZ(); - if (!(vset.contains(new IrisPosition(x + 1, y, z)) - && vset.contains(new IrisPosition(x - 1, y, z)) - && vset.contains(new IrisPosition(x, y + 1, z)) - && vset.contains(new IrisPosition(x, y - 1, z)) - && vset.contains(new IrisPosition(x, y, z + 1)) - && vset.contains(new IrisPosition(x, y, z - 1)))) { + int x = v.getX(); + int y = v.getY(); + int z = v.getZ(); + if (!(lookup.contains(x + 1, y, z) + && lookup.contains(x - 1, y, z) + && lookup.contains(x, y + 1, z) + && lookup.contains(x, y - 1, z) + && lookup.contains(x, y, z + 1) + && lookup.contains(x, y, z - 1))) { returnset.add(v); } } return returnset; } - private static double hypot(double... pars) { - double sum = 0; - for (double d : pars) { - sum += Math.pow(d, 2); + private static double hypot(double x, double y, double z) { + return Math.pow(x, 2) + Math.pow(y, 2) + Math.pow(z, 2); + } + + record PositionLookup(LongOpenHashSet keys, Set positions, int originX, int originY, int originZ) { + private static final int AXIS_BITS = 21; + private static final long AXIS_LIMIT = 1L << AXIS_BITS; + + static PositionLookup of(Set positions) { + if (positions.isEmpty()) { + return new PositionLookup(new LongOpenHashSet(), positions, 0, 0, 0); + } + + int minX = Integer.MAX_VALUE; + int minY = Integer.MAX_VALUE; + int minZ = Integer.MAX_VALUE; + int maxX = Integer.MIN_VALUE; + int maxY = Integer.MIN_VALUE; + int maxZ = Integer.MIN_VALUE; + for (IrisPosition position : positions) { + minX = Math.min(minX, position.getX()); + minY = Math.min(minY, position.getY()); + minZ = Math.min(minZ, position.getZ()); + maxX = Math.max(maxX, position.getX()); + maxY = Math.max(maxY, position.getY()); + maxZ = Math.max(maxZ, position.getZ()); + } + + if ((long) maxX - minX >= AXIS_LIMIT - 2L + || (long) maxY - minY >= AXIS_LIMIT - 2L + || (long) maxZ - minZ >= AXIS_LIMIT - 2L) { + return new PositionLookup(null, positions, 0, 0, 0); + } + + LongOpenHashSet keys = new LongOpenHashSet(positions.size()); + for (IrisPosition position : positions) { + keys.add(key(position.getX() - minX, position.getY() - minY, position.getZ() - minZ)); + } + return new PositionLookup(keys, positions, minX, minY, minZ); + } + + boolean contains(int x, int y, int z) { + if (keys == null) { + return positions.contains(new IrisPosition(x, y, z)); + } + + long dx = (long) x - originX; + long dy = (long) y - originY; + long dz = (long) z - originZ; + if ((dx | dy | dz) < 0L || dx >= AXIS_LIMIT || dy >= AXIS_LIMIT || dz >= AXIS_LIMIT) { + return false; + } + return keys.contains(key(dx, dy, dz)); + } + + private static long key(long x, long y, long z) { + return (x << (AXIS_BITS * 2)) | (y << AXIS_BITS) | z; } - return sum; } private static double lengthSq(double x, double y, double z) { @@ -294,9 +348,7 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { if (hasProtectedHydrology(matter, x, y, z)) { return false; } - MatterSlice cavernSlice = matter.hasSlice(MatterCavern.class) - ? matter.getSlice(MatterCavern.class) - : null; + MatterSlice cavernSlice = matter.getSlice(MatterCavern.class); MatterCavern existing = cavernSlice == null ? null : cavernSlice.get(x & 15, y & 15, z & 15); @@ -328,15 +380,13 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { if (hasProtectedHydrology(matter, x, y, z)) { return false; } - if (matter.hasSlice(PlatformBlockState.class)) { + MatterSlice blockSlice = matter.getSlice(PlatformBlockState.class); + if (blockSlice != null) { capturePreObjectOriginal(matter, x, y, z, PlatformBlockState.class); - matter.getSlice(PlatformBlockState.class) - .set(x & 15, y & 15, z & 15, null); + blockSlice.set(x & 15, y & 15, z & 15, null); } clearDeferredPlacement(matter, x, y, z); - MatterSlice cavernSlice = matter.hasSlice(MatterCavern.class) - ? matter.getSlice(MatterCavern.class) - : null; + MatterSlice cavernSlice = matter.getSlice(MatterCavern.class); if (cavernSlice != null && cavernSlice.get(x & 15, y & 15, z & 15) != null) { return false; } @@ -363,10 +413,10 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { if (hasProtectedHydrology(matter, x, y, z)) { return; } - if (matter.hasSlice(PlatformBlockState.class)) { + MatterSlice blockSlice = matter.getSlice(PlatformBlockState.class); + if (blockSlice != null) { capturePreObjectOriginal(matter, x, y, z, PlatformBlockState.class); - matter.getSlice(PlatformBlockState.class) - .set(x & 15, y & 15, z & 15, null); + blockSlice.set(x & 15, y & 15, z & 15, null); } clearDeferredPlacement(matter, x, y, z); capturePreObjectOriginal(matter, x, y, z, MatterCavern.class); @@ -394,10 +444,10 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { if (hasProtectedHydrology(matter, x, y, z)) { return; } - if (matter.hasSlice(PlatformBlockState.class)) { + MatterSlice blockSlice = matter.getSlice(PlatformBlockState.class); + if (blockSlice != null) { capturePreObjectOriginal(matter, x, y, z, PlatformBlockState.class); - matter.getSlice(PlatformBlockState.class) - .set(x & 15, y & 15, z & 15, null); + blockSlice.set(x & 15, y & 15, z & 15, null); } clearDeferredPlacement(matter, x, y, z); } @@ -651,17 +701,18 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { } private static boolean hasProtectedHydrology(Matter matter, int x, int y, int z) { - if (!matter.hasSlice(HydrologyCaveCell.class)) { + MatterSlice slice = matter.getSlice(HydrologyCaveCell.class); + if (slice == null) { return false; } - HydrologyCaveCell hydrology = matter.getSlice(HydrologyCaveCell.class) - .get(x & 15, y & 15, z & 15); + HydrologyCaveCell hydrology = slice.get(x & 15, y & 15, z & 15); return hydrology != null && hydrology.protectsPlacement(); } private static void clearDeferredPlacement(Matter matter, int x, int y, int z) { - if (matter.hasSlice(Identifier.class)) { - matter.getSlice(Identifier.class).set(x & 15, y & 15, z & 15, null); + MatterSlice slice = matter.getSlice(Identifier.class); + if (slice != null) { + slice.set(x & 15, y & 15, z & 15, null); } } @@ -728,11 +779,11 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { } private static PreObjectMatterCell preObjectCell(Matter matter, int x, int y, int z) { - if (matter == null || !matter.hasSlice(PreObjectMatterCell.class)) { + if (matter == null) { return null; } - return matter.getSlice(PreObjectMatterCell.class) - .get(x & 15, y & 15, z & 15); + MatterSlice slice = matter.getSlice(PreObjectMatterCell.class); + return slice == null ? null : slice.get(x & 15, y & 15, z & 15); } private static T prerequisiteValue(Matter matter, int x, int y, int z, Class type) { @@ -740,17 +791,13 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { if (cell != null && cell.captures(type)) { return cell.original(type); } - if (!matter.hasSlice(type)) { - return null; - } - return matter.getSlice(type).get(x & 15, y & 15, z & 15); + MatterSlice slice = matter.getSlice(type); + return slice == null ? null : slice.get(x & 15, y & 15, z & 15); } private static Object rawValue(Matter matter, int x, int y, int z, Class type) { - if (!matter.hasSlice(type)) { - return null; - } - return matter.getSlice(type).get(x, y, z); + MatterSlice slice = matter.getSlice(type); + return slice == null ? null : slice.get(x, y, z); } private boolean allowsWrite(int blockX, int blockZ) { @@ -762,10 +809,10 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { private static void restoreRaw(Matter matter, int x, int y, int z, Class type, Object value) { MatterSlice slice; if (value == null) { - if (!matter.hasSlice(type)) { + slice = (MatterSlice) matter.getSlice(type); + if (slice == null) { return; } - slice = (MatterSlice) matter.getSlice(type); } else { slice = (MatterSlice) matter.slice(type); } @@ -951,9 +998,7 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { continue; } - MatterSlice cavernSlice = matter.hasSlice(MatterCavern.class) - ? matter.getSlice(MatterCavern.class) - : null; + MatterSlice cavernSlice = matter.getSlice(MatterCavern.class); MatterSlice hydrologySlice = matter.hasSlice(HydrologyCaveCell.class) ? matter.getSlice(HydrologyCaveCell.class) : null; @@ -1277,10 +1322,11 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { setConsumer(vset, data); } - private static Set getMasked(Set vectors, Set masks, double radius) { + static Set getMasked(Set vectors, Set masks, double radius) { Set vset = new KSet<>(); int ceil = (int) Math.ceil(radius); double r2 = Math.pow(radius, 2); + PositionLookup maskLookup = PositionLookup.of(masks); for (IrisPosition v : vectors) { int tipX = v.getX(); @@ -1290,7 +1336,7 @@ public class MantleWriter implements ObjectPassPlacer, AutoCloseable { for (int x = -ceil; x <= ceil; x++) { for (int y = -ceil; y <= ceil; y++) { for (int z = -ceil; z <= ceil; z++) { - if (hypot(x, y, z) > r2 || !masks.contains(new IrisPosition(x, y, z))) + if (hypot(x, y, z) > r2 || !maskLookup.contains(x, y, z)) continue; vset.add(new IrisPosition(tipX + x, tipY + y, tipZ + z)); } diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java new file mode 100644 index 000000000..23f1af2cc --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java @@ -0,0 +1,153 @@ +package art.arcane.iris.engine.hydrology; + +import org.junit.Assume; +import org.junit.Test; + +import java.lang.management.ManagementFactory; +import java.lang.management.ThreadMXBean; +import java.util.ArrayList; +import java.util.List; +import java.util.function.Supplier; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; + +public class HydrologyColumnSampleAccessorTest { + private static final int WARMUP = 20_000; + private static final int ROUNDS = 20_000; + private static final int PASSES = 5; + + @Test + public void theNullableSurfaceAccessorsAgreeWithTheOptionalOnes() { + HydrologyColumnSample sample = sample(); + + assertSame(sample.primarySurfaceLayer().orElse(null), sample.primarySurfaceLayerOrNull()); + assertSame(sample.primarySurfaceFluidLayer().orElse(null), sample.primarySurfaceFluidLayerOrNull()); + assertNotNull(sample.primarySurfaceLayerOrNull()); + assertNotNull(sample.primarySurfaceFluidLayerOrNull()); + } + + @Test + public void aColumnWithoutSurfaceLayersReportsNothingOnBothAccessors() { + HydrologyColumnSample empty = new HydrologyColumnSample(0, 0, 70, 62, false, "overworld/plains", List.of()); + + assertNull(empty.primarySurfaceLayerOrNull()); + assertNull(empty.primarySurfaceFluidLayerOrNull()); + assertTrue(empty.primarySurfaceLayer().isEmpty()); + assertTrue(empty.primarySurfaceFluidLayer().isEmpty()); + assertEquals(70, empty.terrainHeight()); + } + + @Test + public void terrainHeightStillFollowsThePrimarySurfaceLayer() { + HydrologyColumnSample sample = sample(); + + assertEquals(sample.primarySurfaceLayerOrNull().bedY(), sample.terrainHeight()); + } + + @Test + public void theNullableAccessorNeverAllocatesMoreThanTheOptionalOne() { + HydrologyColumnSample sample = sample(); + + Measurement nullable = best(() -> sample.primarySurfaceLayerOrNull()); + Measurement optional = best(() -> sample.primarySurfaceLayer().orElse(null)); + + System.out.println("[bench] primarySurfaceLayer nullable=" + nullable + " optional=" + optional); + + Assume.assumeTrue("per-thread allocation counters are unavailable on this JVM", nullable.bytes() >= 0L); + assertTrue("the nullable accessor allocated " + nullable.bytes() + + " bytes against " + optional.bytes() + " for the Optional accessor", + nullable.bytes() <= optional.bytes()); + } + + private static HydrologyColumnSample sample() { + List layers = new ArrayList<>(); + layers.add(layer(1L, HydrologyFeatureType.RIFFLE, 66, 68, true, false, true, true)); + layers.add(layer(2L, HydrologyFeatureType.SURFACE_POOL, 67, 68, false, true, false, false)); + layers.add(layer(3L, HydrologyFeatureType.MOUTH, 65, 67, true, false, true, true)); + return new HydrologyColumnSample(4, 9, 74, 62, false, "overworld/river", layers); + } + + private static HydrologyColumnLayer layer( + long id, + HydrologyFeatureType type, + int bedY, + int fluidHeadY, + boolean channel, + boolean shore, + boolean connectedFluid, + boolean fluidOwned + ) { + return new HydrologyColumnLayer( + new HydrologyFeatureRef(id, type, id, id, 4, fluidHeadY, 9, 1, 0, false), + bedY, + fluidHeadY, + fluidHeadY, + channel, + shore, + false, + connectedFluid, + false, + false, + true, + fluidOwned, + false, + "overworld/river", + "overworld/river-surface", + "overworld/river-mouth", + "overworld/river-shore", + "overworld/river-bank", + "overworld/river-cave"); + } + + private static Measurement best(Supplier work) { + for (int round = 0; round < WARMUP; round++) { + work.get(); + } + + long bytes = Long.MAX_VALUE; + long nanos = Long.MAX_VALUE; + for (int pass = 0; pass < PASSES; pass++) { + Measurement measured = measure(work); + if (measured.bytes() < 0L) { + return measured; + } + bytes = Math.min(bytes, measured.bytes()); + nanos = Math.min(nanos, measured.nanos()); + } + return new Measurement(bytes, nanos); + } + + private static Measurement measure(Supplier work) { + HydrologyColumnLayer sink = null; + long startBytes = allocatedBytes(); + long startNanos = System.nanoTime(); + for (int round = 0; round < ROUNDS; round++) { + sink = work.get(); + } + long elapsedNanos = System.nanoTime() - startNanos; + long endBytes = allocatedBytes(); + assertNotNull(sink); + long bytes = startBytes < 0L || endBytes < 0L ? -1L : (endBytes - startBytes) / ROUNDS; + + return new Measurement(bytes, elapsedNanos / ROUNDS); + } + + private static long allocatedBytes() { + ThreadMXBean threads = ManagementFactory.getThreadMXBean(); + if (!(threads instanceof com.sun.management.ThreadMXBean hotspot) || !hotspot.isThreadAllocatedMemoryEnabled()) { + return -1L; + } + return hotspot.getThreadAllocatedBytes(Thread.currentThread().threadId()); + } + + private record Measurement(long bytes, long nanos) { + @Override + public String toString() { + return "{bytes/op=" + bytes + ", ns/op=" + nanos + "}"; + } + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodBenchmarkTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodBenchmarkTest.java new file mode 100644 index 000000000..d7e5aea6f --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodBenchmarkTest.java @@ -0,0 +1,125 @@ +package art.arcane.iris.engine.mantle; + +import art.arcane.iris.engine.object.IrisPosition; +import org.junit.Assume; +import org.junit.Test; + +import java.lang.management.ManagementFactory; +import java.lang.management.ThreadMXBean; +import java.util.LinkedHashSet; +import java.util.Set; +import java.util.function.Supplier; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class MantleWriterNeighborhoodBenchmarkTest { + private static final int WARMUP = 400; + private static final int ROUNDS = 40; + private static final int PASSES = 6; + private static final double RADIUS = 5.0D; + + @Test + public void hollowingAllocatesLessThanThePositionProbeImplementation() { + Set ballooned = MantleWriter.getBallooned(line(), RADIUS); + assertTrue("benchmark input is too small to be meaningful: " + ballooned.size(), ballooned.size() > 4_000); + + Comparison comparison = compare( + () -> MantleWriter.getHollowed(ballooned), + () -> MantleWriterNeighborhoodTest.referenceHollowed(ballooned)); + + System.out.println("[bench] getHollowed voxels=" + ballooned.size() + + " primitiveKeys=" + comparison.candidate() + + " positionProbes=" + comparison.reference()); + + assertEquals(comparison.reference().result(), comparison.candidate().result()); + + Assume.assumeTrue("per-thread allocation counters are unavailable on this JVM", + comparison.candidate().bytes() >= 0L); + assertTrue("primitive-keyed hollowing allocated " + comparison.candidate().bytes() + + " bytes against " + comparison.reference().bytes() + " for the position-probe implementation", + comparison.candidate().bytes() < comparison.reference().bytes()); + } + + @Test + public void ballooningMatchesTheVarargsDistanceImplementationExactly() { + Set seeds = line(); + + Comparison comparison = compare( + () -> MantleWriter.getBallooned(seeds, RADIUS), + () -> MantleWriterNeighborhoodTest.referenceBallooned(seeds, RADIUS)); + + System.out.println("[bench] getBallooned seeds=" + seeds.size() + + " fixedArityDistance=" + comparison.candidate() + + " varargsDistance=" + comparison.reference()); + + assertEquals(comparison.reference().result(), comparison.candidate().result()); + } + + private static Set line() { + Set positions = new LinkedHashSet<>(); + for (int step = 0; step <= 48; step++) { + positions.add(new IrisPosition(step, 60 + (step % 5), step / 2)); + } + return positions; + } + + private static Comparison compare(Supplier> candidate, Supplier> reference) { + for (int round = 0; round < WARMUP; round++) { + candidate.get(); + reference.get(); + } + + Measurement bestCandidate = null; + Measurement bestReference = null; + for (int pass = 0; pass < PASSES; pass++) { + bestCandidate = best(bestCandidate, measure(candidate)); + bestReference = best(bestReference, measure(reference)); + } + + return new Comparison(bestCandidate, bestReference); + } + + private static Measurement best(Measurement current, Measurement measured) { + if (current == null) { + return measured; + } + + return new Measurement( + measured.result(), + current.bytes() < 0L || measured.bytes() < 0L ? -1L : Math.min(current.bytes(), measured.bytes()), + Math.min(current.nanos(), measured.nanos())); + } + + private static Measurement measure(Supplier> work) { + Set result = null; + long startBytes = allocatedBytes(); + long startNanos = System.nanoTime(); + for (int round = 0; round < ROUNDS; round++) { + result = work.get(); + } + long elapsedNanos = System.nanoTime() - startNanos; + long endBytes = allocatedBytes(); + long bytes = startBytes < 0L || endBytes < 0L ? -1L : (endBytes - startBytes) / ROUNDS; + + return new Measurement(result, bytes, elapsedNanos / ROUNDS); + } + + private static long allocatedBytes() { + ThreadMXBean threads = ManagementFactory.getThreadMXBean(); + if (!(threads instanceof com.sun.management.ThreadMXBean hotspot) || !hotspot.isThreadAllocatedMemoryEnabled()) { + return -1L; + } + return hotspot.getThreadAllocatedBytes(Thread.currentThread().threadId()); + } + + private record Comparison(Measurement candidate, Measurement reference) { + } + + private record Measurement(Set result, long bytes, long nanos) { + @Override + public String toString() { + return "{bytes/op=" + bytes + ", ns/op=" + nanos + ", voxels=" + result.size() + "}"; + } + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodTest.java b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodTest.java new file mode 100644 index 000000000..c9b18dbfb --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/mantle/MantleWriterNeighborhoodTest.java @@ -0,0 +1,184 @@ +package art.arcane.iris.engine.mantle; + +import art.arcane.iris.engine.object.IrisPosition; +import org.junit.Test; + +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.Set; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class MantleWriterNeighborhoodTest { + @Test + public void balloonedVoxelsMatchTheReferenceSphereForFractionalRadii() { + for (double radius : new double[]{0.0D, 0.5D, 1.0D, 1.5D, 2.0D, 3.7D, 5.0D}) { + Set seeds = line(-3, 60, 7, 4, 63, 9); + assertEquals("radius " + radius, referenceBallooned(seeds, radius), MantleWriter.getBallooned(seeds, radius)); + } + } + + @Test + public void hollowedVoxelsMatchTheReferenceSurfaceExtraction() { + Set ballooned = MantleWriter.getBallooned(line(0, 40, 0, 6, 44, 3), 4.0D); + + assertEquals(referenceHollowed(ballooned), MantleWriter.getHollowed(ballooned)); + } + + @Test + public void hollowingASolidBlockKeepsOnlyItsShell() { + Set solid = new LinkedHashSet<>(); + for (int x = 0; x < 5; x++) { + for (int y = 0; y < 5; y++) { + for (int z = 0; z < 5; z++) { + solid.add(new IrisPosition(x, y, z)); + } + } + } + + Set hollow = MantleWriter.getHollowed(solid); + + assertEquals(98, hollow.size()); + assertFalse(hollow.contains(new IrisPosition(2, 2, 2))); + assertTrue(hollow.contains(new IrisPosition(0, 2, 2))); + } + + @Test + public void aSetTooWideToPackFallsBackToPositionEqualityWithoutChangingTheResult() { + Set spread = new LinkedHashSet<>(); + spread.add(new IrisPosition(-20_000_000, 60, 0)); + spread.add(new IrisPosition(20_000_000, 60, 0)); + spread.add(new IrisPosition(20_000_001, 60, 0)); + + assertEquals(referenceHollowed(spread), MantleWriter.getHollowed(spread)); + assertEquals(spread, MantleWriter.getHollowed(spread)); + } + + @Test + public void maskedVoxelsMatchTheReferenceMaskExpansion() { + Set seeds = line(0, 70, 0, 3, 70, 4); + Set masks = new LinkedHashSet<>(); + masks.add(new IrisPosition(0, 0, 0)); + masks.add(new IrisPosition(1, 0, 0)); + masks.add(new IrisPosition(0, 1, 0)); + masks.add(new IrisPosition(-1, 0, 1)); + masks.add(new IrisPosition(0, 0, -2)); + + assertEquals(referenceMasked(seeds, masks, 3.0D), MantleWriter.getMasked(seeds, masks, 3.0D)); + } + + @Test + public void anEmptyMaskProducesNoVoxels() { + assertTrue(MantleWriter.getMasked(line(0, 70, 0, 2, 70, 2), new LinkedHashSet<>(), 2.0D).isEmpty()); + } + + @Test + public void aPositionLookupReportsMembershipOutsideItsBoundingBoxAsAbsent() { + Set positions = new LinkedHashSet<>(); + positions.add(new IrisPosition(10, 20, 30)); + MantleWriter.PositionLookup lookup = MantleWriter.PositionLookup.of(positions); + + assertTrue(lookup.contains(10, 20, 30)); + assertFalse(lookup.contains(9, 20, 30)); + assertFalse(lookup.contains(10, 20, 31)); + assertFalse(lookup.contains(Integer.MIN_VALUE, 20, 30)); + assertFalse(lookup.contains(Integer.MAX_VALUE, 20, 30)); + } + + @Test + public void anEmptyPositionLookupContainsNothing() { + MantleWriter.PositionLookup lookup = MantleWriter.PositionLookup.of(new LinkedHashSet<>()); + + assertFalse(lookup.contains(0, 0, 0)); + assertFalse(lookup.contains(-1, -1, -1)); + } + + private static Set line(int x1, int y1, int z1, int x2, int y2, int z2) { + Set positions = new LinkedHashSet<>(); + int steps = Math.max(Math.max(Math.abs(x2 - x1), Math.abs(y2 - y1)), Math.abs(z2 - z1)); + for (int step = 0; step <= steps; step++) { + double t = steps == 0 ? 0D : (double) step / steps; + positions.add(new IrisPosition( + (int) Math.round(x1 + t * (x2 - x1)), + (int) Math.round(y1 + t * (y2 - y1)), + (int) Math.round(z1 + t * (z2 - z1)))); + } + return positions; + } + + static Set referenceBallooned(Set vset, double radius) { + Set returnset = new HashSet<>(); + int ceilrad = (int) Math.ceil(radius); + double r2 = Math.pow(radius, 2); + + for (IrisPosition v : vset) { + int tipx = v.getX(); + int tipy = v.getY(); + int tipz = v.getZ(); + + for (int loopx = tipx - ceilrad; loopx <= tipx + ceilrad; loopx++) { + for (int loopy = tipy - ceilrad; loopy <= tipy + ceilrad; loopy++) { + for (int loopz = tipz - ceilrad; loopz <= tipz + ceilrad; loopz++) { + if (referenceHypot(loopx - tipx, loopy - tipy, loopz - tipz) <= r2) { + returnset.add(new IrisPosition(loopx, loopy, loopz)); + } + } + } + } + } + return returnset; + } + + static Set referenceHollowed(Set vset) { + Set returnset = new LinkedHashSet<>(); + for (IrisPosition v : vset) { + double x = v.getX(); + double y = v.getY(); + double z = v.getZ(); + if (!(vset.contains(new IrisPosition(x + 1, y, z)) + && vset.contains(new IrisPosition(x - 1, y, z)) + && vset.contains(new IrisPosition(x, y + 1, z)) + && vset.contains(new IrisPosition(x, y - 1, z)) + && vset.contains(new IrisPosition(x, y, z + 1)) + && vset.contains(new IrisPosition(x, y, z - 1)))) { + returnset.add(v); + } + } + return returnset; + } + + static Set referenceMasked(Set vectors, Set masks, double radius) { + Set vset = new LinkedHashSet<>(); + int ceil = (int) Math.ceil(radius); + double r2 = Math.pow(radius, 2); + + for (IrisPosition v : vectors) { + int tipX = v.getX(); + int tipY = v.getY(); + int tipZ = v.getZ(); + + for (int x = -ceil; x <= ceil; x++) { + for (int y = -ceil; y <= ceil; y++) { + for (int z = -ceil; z <= ceil; z++) { + if (referenceHypot(x, y, z) > r2 || !masks.contains(new IrisPosition(x, y, z))) { + continue; + } + vset.add(new IrisPosition(tipX + x, tipY + y, tipZ + z)); + } + } + } + } + + return vset; + } + + private static double referenceHypot(double... pars) { + double sum = 0; + for (double d : pars) { + sum += Math.pow(d, 2); + } + return sum; + } +} From 45b9ff8e11731594c2b67a4d323fc9cded739d1e Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:54:26 -0400 Subject: [PATCH 12/35] Drop unwired 2D noise kernels - Delete NoiseKernels2D, ScalarNoiseKernels2D and VectorNoiseKernels2D after measuring the vector kernel at 0.07x scalar on 2-lane NEON with no production call site - Delete the 2D noise parity test and the SimdSupport plumbing that selected between the two kernel sets - State in the simd-bench README that its 2D noise classes are a candidate Iris does not ship --- .../arcane/iris/util/simd/NoiseKernels2D.java | 8 -- .../iris/util/simd/ScalarNoiseKernels2D.java | 99 -------------- .../arcane/iris/util/simd/SimdSupport.java | 68 --------- .../iris/util/simd/VectorNoiseKernels2D.java | 129 ------------------ .../util/simd/NoiseKernels2DParityTest.java | 120 ---------------- .../iris/util/simd/SimdSupportStatusTest.java | 12 +- tools/simd-bench/README.md | 15 +- 7 files changed, 15 insertions(+), 436 deletions(-) delete mode 100644 core/src/main/java/art/arcane/iris/util/simd/NoiseKernels2D.java delete mode 100644 core/src/main/java/art/arcane/iris/util/simd/ScalarNoiseKernels2D.java delete mode 100644 core/src/main/java/art/arcane/iris/util/simd/VectorNoiseKernels2D.java delete mode 100644 core/src/test/java/art/arcane/iris/util/simd/NoiseKernels2DParityTest.java diff --git a/core/src/main/java/art/arcane/iris/util/simd/NoiseKernels2D.java b/core/src/main/java/art/arcane/iris/util/simd/NoiseKernels2D.java deleted file mode 100644 index b781cd784..000000000 --- a/core/src/main/java/art/arcane/iris/util/simd/NoiseKernels2D.java +++ /dev/null @@ -1,8 +0,0 @@ -package art.arcane.iris.util.simd; - -public interface NoiseKernels2D { - String describe(); - - void simplexFractalFBM(long seed, int octaves, double frequency, double lacunarity, double gain, - double fractalBounding, double[] xs, double[] zs, double[] out, int length); -} diff --git a/core/src/main/java/art/arcane/iris/util/simd/ScalarNoiseKernels2D.java b/core/src/main/java/art/arcane/iris/util/simd/ScalarNoiseKernels2D.java deleted file mode 100644 index e2b592d0b..000000000 --- a/core/src/main/java/art/arcane/iris/util/simd/ScalarNoiseKernels2D.java +++ /dev/null @@ -1,99 +0,0 @@ -package art.arcane.iris.util.simd; - -public final class ScalarNoiseKernels2D implements NoiseKernels2D { - static final double F2 = 0.5D * (Math.sqrt(3.0D) - 1.0D); - static final double G2 = (3.0D - Math.sqrt(3.0D)) / 6.0D; - static final long X_PRIME = 1619L; - static final long Y_PRIME = 31337L; - static final double[] GRAD_2D = {-1D, -1D, 1D, -1D, -1D, 1D, 1D, 1D, 0D, -1D, -1D, 0D, 0D, 1D, 1D, 0D}; - - @Override - public String describe() { - return "scalar"; - } - - static long fastFloor(double f) { - return f >= 0D ? (long) f : (long) f - 1L; - } - - static double gradCoord2D(long seed, long x, long y, double xd, double yd) { - long hash = seed; - hash ^= X_PRIME * x; - hash ^= Y_PRIME * y; - hash = hash * hash * hash * 60493L; - hash = (hash >> 13) ^ hash; - int gradientIndex = ((int) hash & 7) << 1; - return (xd * GRAD_2D[gradientIndex]) + (yd * GRAD_2D[gradientIndex + 1]); - } - - static double singleSimplex(long seed, double x, double y) { - double t = (x + y) * F2; - long i = fastFloor(x + t); - long j = fastFloor(y + t); - t = (i + j) * G2; - double x0 = x - (i - t); - double y0 = y - (j - t); - long i1; - long j1; - if (x0 > y0) { - i1 = 1L; - j1 = 0L; - } else { - i1 = 0L; - j1 = 1L; - } - double x1 = x0 - i1 + G2; - double y1 = y0 - j1 + G2; - double x2 = x0 - 1D + (2D * G2); - double y2 = y0 - 1D + (2D * G2); - double n0; - double n1; - double n2; - double a = 0.5D - x0 * x0 - y0 * y0; - if (a < 0D) { - n0 = 0D; - } else { - a *= a; - n0 = a * a * gradCoord2D(seed, i, j, x0, y0); - } - double b = 0.5D - x1 * x1 - y1 * y1; - if (b < 0D) { - n1 = 0D; - } else { - b *= b; - n1 = b * b * gradCoord2D(seed, i + i1, j + j1, x1, y1); - } - double c = 0.5D - x2 * x2 - y2 * y2; - if (c < 0D) { - n2 = 0D; - } else { - c *= c; - n2 = c * c * gradCoord2D(seed, i + 1L, j + 1L, x2, y2); - } - return 50D * (n0 + n1 + n2); - } - - static double simplexFractalFBMScalar(long seed, int octaves, double frequency, double lacunarity, double gain, - double fractalBounding, double xIn, double yIn) { - double x = xIn * frequency; - double y = yIn * frequency; - long s = seed; - double sum = singleSimplex(s, x, y); - double amp = 1D; - for (int o = 1; o < octaves; o++) { - x *= lacunarity; - y *= lacunarity; - amp *= gain; - sum += singleSimplex(++s, x, y) * amp; - } - return sum * fractalBounding; - } - - @Override - public void simplexFractalFBM(long seed, int octaves, double frequency, double lacunarity, double gain, - double fractalBounding, double[] xs, double[] zs, double[] out, int length) { - for (int k = 0; k < length; k++) { - out[k] = simplexFractalFBMScalar(seed, octaves, frequency, lacunarity, gain, fractalBounding, xs[k], zs[k]); - } - } -} diff --git a/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java b/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java index 07347095a..055550867 100644 --- a/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java +++ b/core/src/main/java/art/arcane/iris/util/simd/SimdSupport.java @@ -9,9 +9,7 @@ public final class SimdSupport { private static final String VECTOR_MODULE = "jdk.incubator.vector"; private static final boolean MODULE_PRESENT = ModuleLayer.boot().findModule(VECTOR_MODULE).isPresent(); private static final AtomicReference KERNEL_FAILURE = new AtomicReference<>(); - private static final AtomicReference NOISE_KERNEL_FAILURE = new AtomicReference<>(); private static final SimdKernels KERNELS = selectKernels(); - private static final NoiseKernels2D NOISE_KERNELS_2D = selectNoiseKernels2D(); private SimdSupport() { } @@ -20,10 +18,6 @@ public final class SimdSupport { return KERNELS; } - public static NoiseKernels2D noiseKernels2D() { - return NOISE_KERNELS_2D; - } - public static boolean isVectorModulePresent() { return MODULE_PRESENT; } @@ -36,19 +30,10 @@ public final class SimdSupport { return KERNEL_FAILURE.get(); } - public static Throwable noiseKernelInitializationFailure() { - return NOISE_KERNEL_FAILURE.get(); - } - public static String kernelStatus() { return kernelStatus(isVectorized(), KERNELS.describe(), MODULE_PRESENT, KERNEL_FAILURE.get(), simdEnabledInSettings()); } - public static String noiseKernelStatus() { - return noiseKernelStatus(!(NOISE_KERNELS_2D instanceof ScalarNoiseKernels2D), NOISE_KERNELS_2D.describe(), - MODULE_PRESENT, NOISE_KERNEL_FAILURE.get(), simdEnabledInSettings()); - } - static String kernelStatus(boolean vectorized, String description, boolean modulePresent, Throwable failure, boolean settingEnabled) { if (vectorized) { return "vector kernels enabled (" + description + ")"; @@ -69,39 +54,13 @@ public final class SimdSupport { return "scalar kernels active; the Vector API reported no usable vector shape on this CPU"; } - static String noiseKernelStatus(boolean vectorized, String description, boolean modulePresent, Throwable failure, boolean settingEnabled) { - if (vectorized) { - return "2D noise vector kernels enabled (" + description + ")"; - } - - if (!modulePresent) { - return "2D noise scalar kernels active; the " + VECTOR_MODULE + " module is not on this JVM"; - } - - if (failure != null) { - return "2D noise scalar kernels active; vector kernel initialization failed: " + describe(failure); - } - - if (!settingEnabled) { - return "2D noise vector kernels disabled (performance.simdKernels=false)"; - } - - return "2D noise scalar kernels active; this CPU has fewer than the 4 double lanes the vector kernel needs to pay for itself"; - } - public static void install() { IrisLogging.info("SIMD: " + kernelStatus()); - IrisLogging.info("SIMD: " + noiseKernelStatus()); Throwable failure = KERNEL_FAILURE.get(); if (failure != null) { IrisLogging.reportError("Iris could not initialize its Vector API kernels; generation runs on the scalar kernels instead.", failure); } - - Throwable noiseFailure = NOISE_KERNEL_FAILURE.get(); - if (noiseFailure != null) { - IrisLogging.reportError("Iris could not initialize its Vector API 2D noise kernels; noise runs on the scalar kernels instead.", noiseFailure); - } } public static SimdKernels createVectorKernels() { @@ -117,24 +76,6 @@ public final class SimdSupport { } } - public static NoiseKernels2D createVectorNoiseKernels2D() { - if (!MODULE_PRESENT) { - return null; - } - - try { - Class cls = Class.forName("art.arcane.iris.util.simd.VectorNoiseKernels2D"); - boolean profitable = (boolean) cls.getMethod("profitable").invoke(null); - if (!profitable) { - return null; - } - return (NoiseKernels2D) cls.getDeclaredConstructor().newInstance(); - } catch (Throwable e) { - NOISE_KERNEL_FAILURE.set(e); - return null; - } - } - private static SimdKernels selectKernels() { if (!simdEnabledInSettings()) { return new ScalarSimdKernels(); @@ -144,15 +85,6 @@ public final class SimdSupport { return vector == null ? new ScalarSimdKernels() : vector; } - private static NoiseKernels2D selectNoiseKernels2D() { - if (!simdEnabledInSettings()) { - return new ScalarNoiseKernels2D(); - } - - NoiseKernels2D vector = createVectorNoiseKernels2D(); - return vector == null ? new ScalarNoiseKernels2D() : vector; - } - private static String describe(Throwable failure) { Throwable root = failure; while (root.getCause() != null && root.getCause() != root) { diff --git a/core/src/main/java/art/arcane/iris/util/simd/VectorNoiseKernels2D.java b/core/src/main/java/art/arcane/iris/util/simd/VectorNoiseKernels2D.java deleted file mode 100644 index 5db19a260..000000000 --- a/core/src/main/java/art/arcane/iris/util/simd/VectorNoiseKernels2D.java +++ /dev/null @@ -1,129 +0,0 @@ -package art.arcane.iris.util.simd; - -import jdk.incubator.vector.DoubleVector; -import jdk.incubator.vector.LongVector; -import jdk.incubator.vector.VectorMask; -import jdk.incubator.vector.VectorOperators; -import jdk.incubator.vector.VectorSpecies; - -public final class VectorNoiseKernels2D implements NoiseKernels2D { - private static final VectorSpecies DS = DoubleVector.SPECIES_PREFERRED; - private static final VectorSpecies LS = LongVector.SPECIES_PREFERRED; - private static final boolean ALIGNED = DS.length() == LS.length(); - private static final int MIN_PROFITABLE_LANES = 4; - private static final boolean PROFITABLE = ALIGNED && DS.length() >= MIN_PROFITABLE_LANES; - private static final double[] GRAD_X = {-1D, 1D, -1D, 1D, 0D, -1D, 0D, 1D}; - private static final double[] GRAD_Y = {-1D, -1D, 1D, 1D, -1D, 0D, 1D, 0D}; - private static final double F2 = ScalarNoiseKernels2D.F2; - private static final double G2 = ScalarNoiseKernels2D.G2; - private static final long X_PRIME = ScalarNoiseKernels2D.X_PRIME; - private static final long Y_PRIME = ScalarNoiseKernels2D.Y_PRIME; - private static final ThreadLocal LONG_SCRATCH = ThreadLocal.withInitial(() -> new long[LS.length()]); - - public static boolean lanesAligned() { - return ALIGNED; - } - - public static boolean profitable() { - return PROFITABLE; - } - - @Override - public String describe() { - return DS.length() + "x64 lanes, " + DS.vectorShape(); - } - - private static LongVector floorToLong(DoubleVector f) { - LongVector truncated = (LongVector) f.convertShape(VectorOperators.D2L, LS, 0); - VectorMask negative = f.compare(VectorOperators.LT, 0D).cast(LS); - return truncated.sub(1L, negative); - } - - private static DoubleVector toDouble(LongVector v) { - return (DoubleVector) v.convertShape(VectorOperators.L2D, DS, 0); - } - - private static DoubleVector gradCoord(long seed, LongVector i, LongVector j, DoubleVector xd, DoubleVector yd, - int[] idxScratch) { - LongVector hash = LongVector.broadcast(LS, seed) - .lanewise(VectorOperators.XOR, i.mul(X_PRIME)) - .lanewise(VectorOperators.XOR, j.mul(Y_PRIME)); - hash = hash.mul(hash).mul(hash).mul(60493L); - LongVector shifted = hash.lanewise(VectorOperators.ASHR, 13); - hash = shifted.lanewise(VectorOperators.XOR, hash); - LongVector idx = hash.lanewise(VectorOperators.AND, 7L); - long[] tmp = LONG_SCRATCH.get(); - idx.intoArray(tmp, 0); - for (int l = 0; l < idxScratch.length; l++) { - idxScratch[l] = (int) tmp[l]; - } - DoubleVector gx = DoubleVector.fromArray(DS, GRAD_X, 0, idxScratch, 0); - DoubleVector gy = DoubleVector.fromArray(DS, GRAD_Y, 0, idxScratch, 0); - return xd.mul(gx).add(yd.mul(gy)); - } - - private static DoubleVector corner(DoubleVector xk, DoubleVector yk, DoubleVector grad) { - DoubleVector t = DoubleVector.broadcast(DS, 0.5D).sub(xk.mul(xk)).sub(yk.mul(yk)); - VectorMask negative = t.compare(VectorOperators.LT, 0D); - DoubleVector t2 = t.mul(t); - DoubleVector t4 = t2.mul(t2); - return t4.mul(grad).blend(0D, negative); - } - - private static DoubleVector singleSimplexVector(long seed, DoubleVector x, DoubleVector y, int[] idxScratch) { - DoubleVector t = x.add(y).mul(F2); - LongVector i = floorToLong(x.add(t)); - LongVector j = floorToLong(y.add(t)); - DoubleVector skew = toDouble(i.add(j)).mul(G2); - DoubleVector x0 = x.sub(toDouble(i).sub(skew)); - DoubleVector y0 = y.sub(toDouble(j).sub(skew)); - VectorMask xGreater = x0.compare(VectorOperators.GT, y0); - VectorMask xGreaterL = xGreater.cast(LS); - LongVector i1 = LongVector.zero(LS).blend(1L, xGreaterL); - LongVector j1 = LongVector.broadcast(LS, 1L).blend(0L, xGreaterL); - DoubleVector x1 = x0.sub(toDouble(i1)).add(G2); - DoubleVector y1 = y0.sub(toDouble(j1)).add(G2); - DoubleVector x2 = x0.sub(1D).add(2D * G2); - DoubleVector y2 = y0.sub(1D).add(2D * G2); - DoubleVector n0 = corner(x0, y0, gradCoord(seed, i, j, x0, y0, idxScratch)); - DoubleVector n1 = corner(x1, y1, gradCoord(seed, i.add(i1), j.add(j1), x1, y1, idxScratch)); - DoubleVector n2 = corner(x2, y2, gradCoord(seed, i.add(1L), j.add(1L), x2, y2, idxScratch)); - return n0.add(n1).add(n2).mul(50D); - } - - @Override - public void simplexFractalFBM(long seed, int octaves, double frequency, double lacunarity, double gain, - double fractalBounding, double[] xs, double[] zs, double[] out, int length) { - if (!ALIGNED) { - tailScalar(seed, octaves, frequency, lacunarity, gain, fractalBounding, xs, zs, out, 0, length); - return; - } - int lanes = DS.length(); - int bound = DS.loopBound(length); - int[] idxScratch = new int[lanes]; - int k = 0; - for (; k < bound; k += lanes) { - DoubleVector x = DoubleVector.fromArray(DS, xs, k).mul(frequency); - DoubleVector y = DoubleVector.fromArray(DS, zs, k).mul(frequency); - long s = seed; - DoubleVector sum = singleSimplexVector(s, x, y, idxScratch); - double amp = 1D; - for (int o = 1; o < octaves; o++) { - x = x.mul(lacunarity); - y = y.mul(lacunarity); - amp *= gain; - sum = sum.add(singleSimplexVector(++s, x, y, idxScratch).mul(amp)); - } - sum.mul(fractalBounding).intoArray(out, k); - } - tailScalar(seed, octaves, frequency, lacunarity, gain, fractalBounding, xs, zs, out, k, length); - } - - private static void tailScalar(long seed, int octaves, double frequency, double lacunarity, double gain, - double fractalBounding, double[] xs, double[] zs, double[] out, int from, int length) { - for (int k = from; k < length; k++) { - out[k] = ScalarNoiseKernels2D.simplexFractalFBMScalar(seed, octaves, frequency, lacunarity, gain, - fractalBounding, xs[k], zs[k]); - } - } -} diff --git a/core/src/test/java/art/arcane/iris/util/simd/NoiseKernels2DParityTest.java b/core/src/test/java/art/arcane/iris/util/simd/NoiseKernels2DParityTest.java deleted file mode 100644 index 69f16f747..000000000 --- a/core/src/test/java/art/arcane/iris/util/simd/NoiseKernels2DParityTest.java +++ /dev/null @@ -1,120 +0,0 @@ -package art.arcane.iris.util.simd; - -import art.arcane.iris.util.project.noise.FastNoiseDouble; -import art.arcane.iris.util.project.noise.FastNoiseDouble.FractalType; -import art.arcane.iris.util.project.noise.FastNoiseDouble.NoiseType; -import art.arcane.volmlib.util.math.RNG; -import org.junit.Test; - -import static org.junit.Assert.assertEquals; - -public class NoiseKernels2DParityTest { - private static FastNoiseDouble oracle(long seed, int octaves) { - FastNoiseDouble n = new FastNoiseDouble(seed); - n.setNoiseType(NoiseType.SimplexFractal); - n.setFractalType(FractalType.FBM); - n.setFractalOctaves(octaves); - return n; - } - - private static void assertKernelMatchesOracle(NoiseKernels2D kernel) { - RNG rng = new RNG(99L); - for (int octaves = 1; octaves <= 8; octaves++) { - FastNoiseDouble n = oracle(1337L + octaves, octaves); - int length = 256; - double[] xs = new double[length]; - double[] zs = new double[length]; - double[] expected = new double[length]; - double[] out = new double[length]; - for (int k = 0; k < length; k++) { - double x = (rng.nextDouble() - 0.5D) * 1_000_000D; - double z = (rng.nextDouble() - 0.5D) * 1_000_000D; - xs[k] = x; - zs[k] = z; - expected[k] = n.GetSimplexFractal(x, z); - } - kernel.simplexFractalFBM(1337L + octaves, octaves, n.getFrequency(), 2.0D, 0.5D, n.getFractalBounding(), xs, zs, out, length); - for (int k = 0; k < length; k++) { - assertEquals("octaves=" + octaves + " idx=" + k, expected[k], out[k], 0D); - } - } - } - - @Test - public void scalarKernelIsBitExactToOracle() { - assertKernelMatchesOracle(new ScalarNoiseKernels2D()); - } - - @Test - public void vectorKernelSingleOctaveIsBitExactToOracle() { - org.junit.Assume.assumeTrue(VectorNoiseKernels2D.lanesAligned()); - FastNoiseDouble n = oracle(202020L, 1); - RNG rng = new RNG(7L); - int length = 333; - double[] xs = new double[length]; - double[] zs = new double[length]; - double[] expected = new double[length]; - double[] out = new double[length]; - for (int k = 0; k < length; k++) { - double x = (rng.nextDouble() - 0.5D) * 800_000D; - double z = (rng.nextDouble() - 0.5D) * 800_000D; - xs[k] = x; - zs[k] = z; - expected[k] = n.GetSimplexFractal(x, z); - } - new VectorNoiseKernels2D().simplexFractalFBM(202020L, 1, n.getFrequency(), 2.0D, 0.5D, n.getFractalBounding(), xs, zs, out, length); - for (int k = 0; k < length; k++) { - assertEquals("idx=" + k, expected[k], out[k], 0D); - } - } - - @Test - public void vectorKernelAllOctavesAreBitExactToOracle() { - org.junit.Assume.assumeTrue(VectorNoiseKernels2D.lanesAligned()); - assertKernelMatchesOracle(new VectorNoiseKernels2D()); - } - - @Test - public void simdSupportReturnsBitExactNoiseKernel() { - NoiseKernels2D kernel = SimdSupport.noiseKernels2D(); - org.junit.Assert.assertNotNull(kernel); - assertKernelMatchesOracle(kernel); - } - - @Test - public void simdSupportNeverSelectsVectorBelowProfitableLanes() { - if (VectorNoiseKernels2D.profitable()) { - org.junit.Assert.assertTrue(SimdSupport.createVectorNoiseKernels2D() instanceof VectorNoiseKernels2D); - } else { - org.junit.Assert.assertTrue(SimdSupport.noiseKernels2D() instanceof ScalarNoiseKernels2D); - } - } - - @Test - public void vectorMatchesScalarAcrossEdgeCases() { - org.junit.Assume.assumeTrue(VectorNoiseKernels2D.lanesAligned()); - NoiseKernels2D scalar = new ScalarNoiseKernels2D(); - NoiseKernels2D vector = new VectorNoiseKernels2D(); - RNG rng = new RNG(31337L); - int[] lengths = {1, 3, 7, 8, 9, 255, 256, 257}; - double[] edgeCoords = {-4.0D, -3.0D, -1.0D, -0.0D, 0.0D, 1.0D, 4.0D, 1_000_000.0D, -1_000_000.0D}; - for (int octaves = 1; octaves <= 8; octaves++) { - for (int length : lengths) { - double[] xs = new double[length]; - double[] zs = new double[length]; - double[] a = new double[length]; - double[] b = new double[length]; - for (int k = 0; k < length; k++) { - boolean edge = (k % 3) == 0; - xs[k] = edge ? edgeCoords[k % edgeCoords.length] : (rng.nextDouble() - 0.5D) * 2_000_000D; - zs[k] = edge ? edgeCoords[(k + 1) % edgeCoords.length] : (rng.nextDouble() - 0.5D) * 2_000_000D; - } - scalar.simplexFractalFBM(77L, octaves, 0.01D, 2.0D, 0.5D, 0.6667D, xs, zs, a, length); - vector.simplexFractalFBM(77L, octaves, 0.01D, 2.0D, 0.5D, 0.6667D, xs, zs, b, length); - for (int k = 0; k < length; k++) { - assertEquals("oct=" + octaves + " len=" + length + " idx=" + k, a[k], b[k], 0D); - } - } - } - } -} diff --git a/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java b/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java index 20a0cc2c7..a6c3ff6d6 100644 --- a/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java +++ b/core/src/test/java/art/arcane/iris/util/simd/SimdSupportStatusTest.java @@ -88,20 +88,19 @@ public class SimdSupportStatusTest { } @Test - public void aNarrowCpuIsReportedAsUnprofitableRatherThanDisabled() { - String status = SimdSupport.noiseKernelStatus(false, "scalar", true, null, true); + public void aCpuWithoutAUsableVectorShapeIsReportedAsSuchRatherThanDisabled() { + String status = SimdSupport.kernelStatus(false, "scalar", true, null, true); - assertTrue(status, status.contains("4 double lanes")); + assertTrue(status, status.contains("no usable vector shape")); assertFalse(status, status.contains("performance.simdKernels=false")); } @Test - public void installStatesTheLiveKernelSelectionForBothKernelSets() { + public void installStatesTheLiveKernelSelection() { SimdSupport.install(); - assertTrue(emitted.toString(), emitted.size() >= 2); + assertTrue(emitted.toString(), emitted.size() >= 1); assertTrue(emitted.toString(), emitted.contains("SIMD: " + SimdSupport.kernelStatus())); - assertTrue(emitted.toString(), emitted.contains("SIMD: " + SimdSupport.noiseKernelStatus())); } @Test @@ -111,6 +110,5 @@ public class SimdSupportStatusTest { } assertFalse(SimdSupport.kernelStatus(), SimdSupport.kernelStatus().contains("performance.simdKernels=false")); - assertFalse(SimdSupport.noiseKernelStatus(), SimdSupport.noiseKernelStatus().contains("performance.simdKernels=false")); } } diff --git a/tools/simd-bench/README.md b/tools/simd-bench/README.md index ae6bd62f0..d5d149559 100644 --- a/tools/simd-bench/README.md +++ b/tools/simd-bench/README.md @@ -6,9 +6,13 @@ on**. The Volmit dev/test machines are Apple Silicon, where the wide-SIMD path (4+ double lanes) does not exist. Copy the built artifact to a Windows/x86 box (AVX2 = 4 lanes, AVX-512 = 8 lanes) and run it to get real numbers for that CPU. -The six kernel classes are copied verbatim (logic byte-for-byte) from -`Iris/core/.../util/simd/`. This tool is intentionally a duplicate so it builds -and runs on its own with no Gradle, no VolmLib, and no Iris on the classpath. +The three array kernel classes are copied verbatim (logic byte-for-byte) from +`Iris/core/.../util/simd/`. The three 2D noise kernel classes are a candidate +implementation that Iris does not ship: it measured 0.07x against scalar on +2-lane NEON and was removed, and this harness keeps it so the same question can be +answered on a wider CPU before anyone rebuilds it. This tool is intentionally a +duplicate so it builds and runs on its own with no Gradle, no VolmLib, and no Iris +on the classpath. ## Requirements @@ -98,7 +102,8 @@ run.bat --mode both (default) throughput will be (cache behavior, allocation, and surrounding code differ in the real engine). - **Effort 1 array kernels** (`roundToInt` / `sum` / `max`) run unconditionally - in real Iris. **Effort 2 noise** (`simplexFractalFBM`) is currently unwired in - Iris and gated to 4+ double lanes; this tool force-measures it regardless. + in real Iris. **Effort 2 noise** (`simplexFractalFBM`) is not part of + Iris; this tool force-measures the candidate kernel regardless of the 4+ double + lane gate. - Vector-API auto-vectorization and cost depend heavily on the JDK version and CPU. Run on the actual target hardware; do not extrapolate across machines. From f83cf71b1121f968ce1de8fe4d22644f1f2345c0 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:37:17 -0400 Subject: [PATCH 13/35] Report swallowed failures - Add art.arcane.iris.spi.CapabilityProbe so an absent optional API is recorded at debug with the failure class and message instead of a bare ignored catch - Route runtime day-time reads, clock pushes and the noon time lock through IrisLogging.reportError with the world name and the full trace - Report a level storage access that will not close, so a retained world session lock names its cause - Report a failed iris.json rewrite with the file path instead of dropping the IOException - Report Iris world registry and dimension read failures during Multiverse reconciliation instead of logging one debug line - Report a failed pack compatibility summary and a failed vanilla-slot capture with their traces - Report a superseded generation semantics shard that cannot be deleted, once, with its path - Restore the interrupt flag when the global cache trimmer join is interrupted - Replace ValueWithDiagnostics with CheckResult so a startup check carries the runtime lock reason it raises - Give every startup check an explicit advisory or critical severity and lock the runtime on any Danger result, replacing the catch that recognised the injection check by id - Lock the runtime when general.disableNMS holds a no-op binding or the NMS binding is unbound, instead of marking the runtime ready - Match incompatible plugin names against every registered plugin without regard to case - Name the JVM maximum heap in the memory check output - Print the lock reason and what it blocks when Iris enables into a locked runtime - Carry the per-check safeguard modes and diagnostic lines in /iris debugdump --- .../src/main/java/art/arcane/iris/Iris.java | 36 ++++- .../core/PendingWorldReplacementManager.java | 3 +- .../art/arcane/iris/core/IrisSettings.java | 2 + .../core/lifecycle/CapabilitySnapshot.java | 67 ++++---- .../core/lifecycle/WorldLifecycleSupport.java | 15 +- .../iris/core/link/MultiverseCoreLink.java | 11 +- .../core/link/MultiverseGuardListener.java | 4 +- .../arcane/iris/core/link/WorldEditLink.java | 8 +- .../iris/core/localization/IrisLanguage.java | 10 +- .../iris/core/project/SchemaBuilder.java | 11 +- .../BukkitPublicRuntimeControlBackend.java | 15 +- .../PaperLikeRuntimeControlBackend.java | 88 ++++++----- .../runtime/WorldRuntimeControlService.java | 67 ++++---- .../iris/core/safeguard/IrisSafeguard.java | 74 ++++++--- .../core/safeguard/RuntimeLockNotice.java | 29 ++++ .../iris/core/safeguard/task/CheckResult.java | 47 ++++++ .../arcane/iris/core/safeguard/task/Task.java | 51 +++--- .../iris/core/safeguard/task/Tasks.java | 148 +++++++++++------- .../safeguard/task/ValueWithDiagnostics.java | 40 ----- .../iris/core/service/GlobalCacheSVC.java | 4 +- .../iris/core/service/MultiverseSVC.java | 4 +- .../arcane/iris/engine/EngineDiagnostics.java | 3 +- .../history/GenerationSemanticIndex.java | 12 +- .../core/IrisSafeguardLockPolicyTest.java | 140 +++++++++++++++++ .../arcane/iris/core/IrisSafeguardTest.java | 11 +- .../core/IrisSettingsRewriteFailureTest.java | 79 ++++++++++ ...WorldLifecycleSupportCloseFailureTest.java | 66 ++++++++ ...orldRuntimeControlServiceTimeLockTest.java | 33 ++++ .../core/safeguard/RuntimeLockNoticeTest.java | 42 +++++ .../safeguard/TasksIncompatibilityTest.java | 87 ++++++++++ .../engine/EngineDiagnosticsFailureTest.java | 53 +++++++ .../purity/SwallowedFailurePolicyTest.java | 89 +++++++++++ .../arcane/iris/spi/CapabilityProbeTest.java | 136 ++++++++++++++++ .../art/arcane/iris/spi/CapabilityProbe.java | 88 +++++++++++ 34 files changed, 1267 insertions(+), 306 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java create mode 100644 core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java delete mode 100644 core/src/main/java/art/arcane/iris/core/safeguard/task/ValueWithDiagnostics.java create mode 100644 core/src/test/java/art/arcane/iris/core/IrisSafeguardLockPolicyTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/IrisSettingsRewriteFailureTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupportCloseFailureTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/safeguard/RuntimeLockNoticeTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/safeguard/TasksIncompatibilityTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/EngineDiagnosticsFailureTest.java create mode 100644 core/src/test/java/art/arcane/iris/purity/SwallowedFailurePolicyTest.java create mode 100644 core/src/test/java/art/arcane/iris/spi/CapabilityProbeTest.java create mode 100644 spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java index b7ceb4e6f..a9a7d5bfb 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java @@ -87,6 +87,7 @@ import art.arcane.iris.engine.framework.PreservationRegistry; import art.arcane.iris.engine.framework.TreeBlockMaterial; import art.arcane.iris.engine.object.IrisCompat; import art.arcane.iris.core.safeguard.IrisSafeguard; +import art.arcane.iris.core.safeguard.RuntimeLockNotice; import art.arcane.iris.engine.platform.PlatformChunkGenerator; import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.spi.IrisLogging; @@ -305,10 +306,11 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { return; } - StackWalker.StackFrame frame = null; + StackWalker.StackFrame frame; try { frame = DEBUG_STACK_WALKER.walk(stream -> stream.skip(1).findFirst().orElse(null)); - } catch (Throwable ignored) { + } catch (Throwable unavailable) { + frame = null; } if (frame == null) { @@ -444,7 +446,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { try { IrisSettings currentSettings = IrisSettings.settings != null ? IrisSettings.settings : IrisSettings.get(); debug = currentSettings != null && currentSettings.getGeneral().isDebug(); - } catch (Throwable ignored) { + } catch (Throwable unreadable) { debug = false; } } @@ -625,7 +627,9 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { MultiBurst.burst.reopen(); MultiBurst.ioBurst.reopen(); IrisLanguage.initialize(); - debugDump = BukkitDebugDump.create(this); + debugDump = BukkitDebugDump.create(this, new BukkitDebugDump.Options( + () -> true, + () -> IrisSafeguard::debugReport)); languageSwitcher = BukkitLanguageSwitcher.register(this, IrisLanguage.selections(), new BukkitLanguageSwitcher.Options("iris", "iris.all", DirectorMiniMenu.Theme.irisGreen(), IrisLanguage.directorResolver(), IrisLanguage.editorOptions())); @@ -866,6 +870,30 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { .orElse("Iris startup validation requires a restart."); startupBoundaryRestart.set(true); ServerConfigurator.restartAtStartupBoundary(restartReason); + return; + } + reportLockedRuntime(); + } + + /** + * refuseVanillaFallback only ever runs when enable itself failed. A boot that enabled into Danger Mode + * keeps every configured Iris world bound to a generator that throws, and until now said so nowhere + * after the banner. + */ + private static void reportLockedRuntime() { + String denial = IrisStartupValidation.denialReason().orElse(null); + if (denial == null) { + return; + } + boolean managedStorage; + try { + managedStorage = IrisWorldStorage.hasManagedWorldStorage(IrisWorldStorage.levelRoot()); + } catch (Throwable unavailable) { + Iris.reportError("Could not inspect Iris world storage while reporting the locked runtime.", unavailable); + managedStorage = false; + } + for (String line : RuntimeLockNotice.compose(denial, managedStorage)) { + Iris.error(line); } } diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/PendingWorldReplacementManager.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/PendingWorldReplacementManager.java index d00c993aa..e2074b758 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/PendingWorldReplacementManager.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/PendingWorldReplacementManager.java @@ -1104,7 +1104,8 @@ public final class PendingWorldReplacementManager implements Listener { Iris.instance.getServer().getAllowEnd() ); } catch (Throwable failure) { - Iris.debug("Could not capture vanilla-slot availability yet: " + detail(failure)); + Iris.reportError("Could not capture vanilla-slot availability at startup;" + + " world replacement staging will resolve it on demand.", failure); } } diff --git a/core/src/main/java/art/arcane/iris/core/IrisSettings.java b/core/src/main/java/art/arcane/iris/core/IrisSettings.java index 6b690d310..936a12d22 100644 --- a/core/src/main/java/art/arcane/iris/core/IrisSettings.java +++ b/core/src/main/java/art/arcane/iris/core/IrisSettings.java @@ -107,6 +107,8 @@ public class IrisSettings { try { IO.writeAll(s, new JSONObject(new Gson().toJson(loaded)).toString(4)); } catch (IOException e) { + IrisLogging.reportError("Could not rewrite " + s.getAbsolutePath() + + "; settings changes made in game will not survive a restart.", e); } } catch (Throwable ee) { // IrisLogging.reportError(ee); causes a self-reference & stackoverflow diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/CapabilitySnapshot.java b/core/src/main/java/art/arcane/iris/core/lifecycle/CapabilitySnapshot.java index 3c871d7bf..27bbab2ad 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/CapabilitySnapshot.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/CapabilitySnapshot.java @@ -1,5 +1,6 @@ package art.arcane.iris.core.lifecycle; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.scheduling.FoliaScheduler; import org.bukkit.Bukkit; @@ -202,33 +203,28 @@ public final class CapabilitySnapshot { removeLevelMethod = null; } - Method unloadWorldAsyncMethod = null; - try { - if (bukkitServer != null) { - unloadWorldAsyncMethod = CapabilityResolution.resolveMethod(bukkitServer.getClass(), "unloadWorldAsync", method -> { + Object resolvedServer = bukkitServer; + Method unloadWorldAsyncMethod = resolvedServer == null ? null : CapabilityProbe.attempt( + "server#unloadWorldAsync", + () -> CapabilityResolution.resolveMethod(resolvedServer.getClass(), "unloadWorldAsync", method -> { Class[] params = method.getParameterTypes(); return params.length == 3 && World.class.equals(params[0]) && boolean.class.equals(params[1]) && "Consumer".equals(params[2].getSimpleName()); - }); - } - } catch (Throwable ignored) { - unloadWorldAsyncMethod = null; - } + }), + null); - Method chunkAtAsyncMethod = null; - try { - chunkAtAsyncMethod = CapabilityResolution.resolveMethod(World.class, "getChunkAtAsync", method -> { - Class[] params = method.getParameterTypes(); - return params.length == 3 - && int.class.equals(params[0]) - && int.class.equals(params[1]) - && boolean.class.equals(params[2]); - }); - } catch (Throwable ignored) { - chunkAtAsyncMethod = null; - } + Method chunkAtAsyncMethod = CapabilityProbe.attempt( + "world#getChunkAtAsync", + () -> CapabilityResolution.resolveMethod(World.class, "getChunkAtAsync", method -> { + Class[] params = method.getParameterTypes(); + return params.length == 3 + && int.class.equals(params[0]) + && int.class.equals(params[1]) + && boolean.class.equals(params[2]); + }), + null); return new CapabilitySnapshot( serverFamily, @@ -436,12 +432,8 @@ public final class CapabilitySnapshot { } private static boolean hasCanvasRuntime() { - try { - Class.forName("io.canvasmc.canvas.region.WorldRegionizer"); - return true; - } catch (Throwable ignored) { - return false; - } + return CapabilityProbe.succeeds("io.canvasmc.canvas.region.WorldRegionizer", + () -> Class.forName("io.canvasmc.canvas.region.WorldRegionizer")); } private static boolean containsIgnoreCase(String value, String needle) { @@ -452,14 +444,10 @@ public final class CapabilitySnapshot { } private static Object[] resolveWorldsProvider() throws Throwable { - try { - Class worldsProviderClass = Class.forName("net.thenextlvl.worlds.api.WorldsProvider"); - Class levelStemClass = Class.forName("net.thenextlvl.worlds.api.generator.LevelStem"); - Class generatorTypeClass = Class.forName("net.thenextlvl.worlds.api.generator.GeneratorType"); - Object provider = Bukkit.getServicesManager().load(worldsProviderClass); - String resolution = provider == null ? "inactive(service not registered)" : "active(service=" + provider.getClass().getName() + ")"; - return new Object[]{provider, levelStemClass, generatorTypeClass, resolution}; - } catch (Throwable ignored) { + Object[] direct = CapabilityProbe.attempt("net.thenextlvl.worlds.api.WorldsProvider", + CapabilitySnapshot::loadWorldsProvider, null); + if (direct != null) { + return direct; } Collection> knownServices = Bukkit.getServicesManager().getKnownServices(); @@ -490,4 +478,13 @@ public final class CapabilitySnapshot { return new Object[]{null, null, null, "inactive(service scan found nothing)"}; } + private static Object[] loadWorldsProvider() throws ClassNotFoundException { + Class worldsProviderClass = Class.forName("net.thenextlvl.worlds.api.WorldsProvider"); + Class levelStemClass = Class.forName("net.thenextlvl.worlds.api.generator.LevelStem"); + Class generatorTypeClass = Class.forName("net.thenextlvl.worlds.api.generator.GeneratorType"); + Object provider = Bukkit.getServicesManager().load(worldsProviderClass); + String resolution = provider == null ? "inactive(service not registered)" : "active(service=" + provider.getClass().getName() + ")"; + return new Object[]{provider, levelStemClass, generatorTypeClass, resolution}; + } + } diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupport.java b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupport.java index 64e0593d6..1060de9e8 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupport.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupport.java @@ -6,6 +6,8 @@ import art.arcane.iris.core.nms.INMS; import art.arcane.iris.core.nms.INMSBinding; import art.arcane.iris.engine.platform.PlatformChunkGenerator; import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.spi.CapabilityProbe; +import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.util.common.scheduling.J; import art.arcane.volmlib.util.bukkit.WorldIdentity; import art.arcane.volmlib.util.scheduling.FoliaScheduler; @@ -412,7 +414,9 @@ final class WorldLifecycleSupport { try { Method closeMethod = levelStorageAccess.getClass().getMethod("close"); closeMethod.invoke(levelStorageAccess); - } catch (Throwable ignored) { + } catch (Throwable failure) { + IrisLogging.reportError("Failed to close the level storage access; the world session lock may still be held.", + unwrap(failure)); } } @@ -712,11 +716,8 @@ final class WorldLifecycleSupport { if (server == null) { return false; } - try { - Method method = server.getClass().getMethod("isGlobalTickThread"); - return Boolean.TRUE.equals(method.invoke(server)); - } catch (Throwable ignored) { - return false; - } + return CapabilityProbe.attempt("server#isGlobalTickThread", + () -> Boolean.TRUE.equals(server.getClass().getMethod("isGlobalTickThread").invoke(server)), + Boolean.FALSE); } } diff --git a/core/src/main/java/art/arcane/iris/core/link/MultiverseCoreLink.java b/core/src/main/java/art/arcane/iris/core/link/MultiverseCoreLink.java index dab62c6d6..be518db36 100644 --- a/core/src/main/java/art/arcane/iris/core/link/MultiverseCoreLink.java +++ b/core/src/main/java/art/arcane/iris/core/link/MultiverseCoreLink.java @@ -204,8 +204,10 @@ public class MultiverseCoreLink { try { worldKey = WorldIdentity.parse(entry.getKey()); worldName = IrisWorldStorage.configuredWorldName(worldKey, levelName); - } catch (Throwable ignored) { + } catch (Throwable unreadable) { // Not a world with a Bukkit startup name; Multiverse cannot be holding an entry for it. + IrisLogging.debug("Skipping Iris world registry entry " + entry.getKey() + + " for Multiverse reconciliation: " + describe(unreadable)); continue; } try { @@ -324,8 +326,8 @@ public class MultiverseCoreLink { try { return IrisWorlds.get().getWorlds().get(worldKey.toString()); } catch (Throwable unreadable) { - IrisLogging.debug("Could not read the Iris world registry for " + worldKey + ": " - + describe(unreadable)); + IrisLogging.reportError("Could not read the Iris world registry for " + worldKey + + "; Multiverse keeps whatever generator it already recorded.", unreadable); return null; } } @@ -382,7 +384,8 @@ public class MultiverseCoreLink { IrisDimension dimension = IrisWorlds.get().getDimension(worldKey.toString(), pack); return dimension == null ? null : BukkitEnvironment.from(dimension.getEnvironment()); } catch (Throwable unreadable) { - IrisLogging.debug("Could not read the Iris dimension for " + worldKey + ": " + describe(unreadable)); + IrisLogging.reportError("Could not read the Iris dimension for " + worldKey + + "; Multiverse keeps whatever environment it already recorded.", unreadable); return null; } } diff --git a/core/src/main/java/art/arcane/iris/core/link/MultiverseGuardListener.java b/core/src/main/java/art/arcane/iris/core/link/MultiverseGuardListener.java index 66db137f8..14c9fc046 100644 --- a/core/src/main/java/art/arcane/iris/core/link/MultiverseGuardListener.java +++ b/core/src/main/java/art/arcane/iris/core/link/MultiverseGuardListener.java @@ -471,7 +471,9 @@ public final class MultiverseGuardListener implements Listener { for (String line : lines) { target.sendMessage(line); } - } catch (Throwable ignored) { + } catch (Throwable undeliverable) { + IrisLogging.debug("Falling back to plain delivery for a Multiverse guard message: " + + describe(undeliverable)); for (String line : lines) { ComponentMessenger.sendSection(sender, line); } diff --git a/core/src/main/java/art/arcane/iris/core/link/WorldEditLink.java b/core/src/main/java/art/arcane/iris/core/link/WorldEditLink.java index dda67dac8..d98e0f134 100644 --- a/core/src/main/java/art/arcane/iris/core/link/WorldEditLink.java +++ b/core/src/main/java/art/arcane/iris/core/link/WorldEditLink.java @@ -1,5 +1,6 @@ package art.arcane.iris.core.link; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.engine.data.cache.AtomicCache; import art.arcane.volmlib.util.data.Cuboid; @@ -63,12 +64,7 @@ public class WorldEditLink { return true; } - boolean present; - try { - present = detector.getAsBoolean(); - } catch (Throwable ignored) { - return false; - } + boolean present = CapabilityProbe.attempt("WorldEdit", detector::getAsBoolean, Boolean.FALSE); if (present) { active.aquire(() -> Boolean.TRUE); diff --git a/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java b/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java index 6c98df20e..4dc586eee 100644 --- a/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java +++ b/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java @@ -1,6 +1,7 @@ package art.arcane.iris.core.localization; import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.volmlib.util.director.DirectorTextResolver; @@ -212,11 +213,10 @@ public final class IrisLanguage { if (root == null) { return false; } - try { - return overrideFile(root, configuredLocale()).equals(file.getAbsoluteFile()); - } catch (RuntimeException ignored) { - return false; - } + File overrideRoot = root; + return CapabilityProbe.attempt("locale override path", + () -> overrideFile(overrideRoot, configuredLocale()).equals(file.getAbsoluteFile()), + Boolean.FALSE); } private static boolean applyReload(File root, String requestedLocale, SnapshotCapture capture) { diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java b/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java index a311eb111..41c41b45e 100644 --- a/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java @@ -18,6 +18,7 @@ package art.arcane.iris.core.project; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockProperty; @@ -126,13 +127,9 @@ public class SchemaBuilder { if (cached != null) { return cached; } - JSONArray built; - try { - built = new JSONArray(GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()); - } catch (Throwable e) { - IrisLogging.debug("Schema font family enumeration unavailable: " + e.getMessage()); - built = new JSONArray(); - } + JSONArray built = CapabilityProbe.attempt("java.awt font families", + () -> new JSONArray(GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()), + new JSONArray()); fontTypes = built; return built; } diff --git a/core/src/main/java/art/arcane/iris/core/runtime/BukkitPublicRuntimeControlBackend.java b/core/src/main/java/art/arcane/iris/core/runtime/BukkitPublicRuntimeControlBackend.java index ddada2db9..1da53717c 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/BukkitPublicRuntimeControlBackend.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/BukkitPublicRuntimeControlBackend.java @@ -1,6 +1,7 @@ package art.arcane.iris.core.runtime; import art.arcane.iris.core.lifecycle.CapabilitySnapshot; +import art.arcane.iris.spi.CapabilityProbe; import io.papermc.lib.PaperLib; import org.bukkit.Chunk; import org.bukkit.World; @@ -56,14 +57,12 @@ final class BukkitPublicRuntimeControlBackend implements WorldRuntimeControlBack } if (capabilities.chunkAtAsyncMethod() != null) { - try { - Object result = capabilities.chunkAtAsyncMethod().invoke(world, chunkX, chunkZ, generate); - if (result instanceof CompletableFuture) { - @SuppressWarnings("unchecked") - CompletableFuture future = (CompletableFuture) result; - return future; - } - } catch (Throwable ignored) { + Object result = CapabilityProbe.attempt("world#getChunkAtAsync", + () -> capabilities.chunkAtAsyncMethod().invoke(world, chunkX, chunkZ, generate), null); + if (result instanceof CompletableFuture) { + @SuppressWarnings("unchecked") + CompletableFuture future = (CompletableFuture) result; + return future; } } diff --git a/core/src/main/java/art/arcane/iris/core/runtime/PaperLikeRuntimeControlBackend.java b/core/src/main/java/art/arcane/iris/core/runtime/PaperLikeRuntimeControlBackend.java index 377113068..abacc23b5 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/PaperLikeRuntimeControlBackend.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/PaperLikeRuntimeControlBackend.java @@ -1,6 +1,8 @@ package art.arcane.iris.core.runtime; import art.arcane.iris.core.lifecycle.CapabilitySnapshot; +import art.arcane.iris.spi.CapabilityProbe; +import art.arcane.iris.spi.IrisLogging; import io.papermc.lib.PaperLib; import org.bukkit.Bukkit; import org.bukkit.Chunk; @@ -57,7 +59,9 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend if (value instanceof Number number) { return OptionalLong.of(number.longValue()); } - } catch (Throwable ignored) { + } catch (Throwable failure) { + IrisLogging.reportError("Failed to read the runtime day time of world \"" + world.getName() + + "\" through " + strategy.description() + ".", failure); } return OptionalLong.empty(); @@ -107,7 +111,9 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend } strategy.syncMethod().invoke(serverHandle); - } catch (Throwable ignored) { + } catch (Throwable failure) { + IrisLogging.reportError("Failed to push the runtime day time of world \"" + + (world == null ? "unknown" : world.getName()) + "\" to its players.", failure); } } @@ -161,42 +167,42 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend return TimeAccessStrategy.unsupported(); } - try { - Method handleMethod = resolveZeroArgMethod(world.getClass(), "getHandle"); - if (handleMethod == null) { - return TimeAccessStrategy.unsupported(); - } + return CapabilityProbe.attempt("runtime world clock", () -> resolveTimeAccess(world), + TimeAccessStrategy.unsupported()); + } - Object handle = handleMethod.invoke(world); - if (handle == null) { - return TimeAccessStrategy.unsupported(); - } - - Method readMethod = resolveZeroArgMethod(handle.getClass(), "getDayTime"); - Method writeMethod = resolveLongArgMethod(handle.getClass(), "setDayTime"); - if (readMethod != null && writeMethod != null) { - return TimeAccessStrategy.forHandle(handleMethod, readMethod, writeMethod, "runtime_handle#setDayTime"); - } - - Method levelDataMethod = resolveZeroArgMethod(handle.getClass(), "serverLevelData"); - if (levelDataMethod == null) { - levelDataMethod = resolveZeroArgMethod(handle.getClass(), "getLevelData"); - } - if (levelDataMethod != null) { - Object levelData = levelDataMethod.invoke(handle); - if (levelData != null) { - Method levelDataReadMethod = resolveZeroArgMethod(levelData.getClass(), "getDayTime"); - Method levelDataWriteMethod = resolveLongArgMethod(levelData.getClass(), "setDayTime"); - if (levelDataReadMethod != null && levelDataWriteMethod != null) { - return TimeAccessStrategy.forLevelData(handleMethod, levelDataMethod, levelDataReadMethod, levelDataWriteMethod, "world_data#setDayTime"); - } - } - } - - return TimeAccessStrategy.unsupported(handleMethod); - } catch (Throwable ignored) { + private TimeAccessStrategy resolveTimeAccess(World world) throws ReflectiveOperationException { + Method handleMethod = resolveZeroArgMethod(world.getClass(), "getHandle"); + if (handleMethod == null) { return TimeAccessStrategy.unsupported(); } + + Object handle = handleMethod.invoke(world); + if (handle == null) { + return TimeAccessStrategy.unsupported(); + } + + Method readMethod = resolveZeroArgMethod(handle.getClass(), "getDayTime"); + Method writeMethod = resolveLongArgMethod(handle.getClass(), "setDayTime"); + if (readMethod != null && writeMethod != null) { + return TimeAccessStrategy.forHandle(handleMethod, readMethod, writeMethod, "runtime_handle#setDayTime"); + } + + Method levelDataMethod = resolveZeroArgMethod(handle.getClass(), "serverLevelData"); + if (levelDataMethod == null) { + levelDataMethod = resolveZeroArgMethod(handle.getClass(), "getLevelData"); + } + if (levelDataMethod != null) { + Object levelData = levelDataMethod.invoke(handle); + if (levelData != null) { + Method levelDataReadMethod = resolveZeroArgMethod(levelData.getClass(), "getDayTime"); + Method levelDataWriteMethod = resolveLongArgMethod(levelData.getClass(), "setDayTime"); + if (levelDataReadMethod != null && levelDataWriteMethod != null) { + return TimeAccessStrategy.forLevelData(handleMethod, levelDataMethod, levelDataReadMethod, levelDataWriteMethod, "world_data#setDayTime"); + } + } + } + return TimeAccessStrategy.unsupported(handleMethod); } private static Method resolveZeroArgMethod(Class type, String name) { @@ -283,13 +289,11 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend } private static Method resolveCraftServerMethod(String name) { - try { + return CapabilityProbe.attempt("craft server#" + name, () -> { Method method = Bukkit.getServer().getClass().getMethod(name); method.setAccessible(true); return method; - } catch (Throwable ignored) { - return null; - } + }, null); } private static Method resolveServerMethod(Method serverHandleMethod, String name) { @@ -297,7 +301,7 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend return null; } - try { + return CapabilityProbe.attempt("minecraft server#" + name, () -> { Object craftServer = Bukkit.getServer(); if (craftServer == null) { return null; @@ -311,9 +315,7 @@ final class PaperLikeRuntimeControlBackend implements WorldRuntimeControlBackend Method method = serverHandle.getClass().getMethod(name); method.setAccessible(true); return method; - } catch (Throwable ignored) { - return null; - } + }, null); } } } diff --git a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java index 3648e6bcd..d8ddb486b 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java @@ -1,5 +1,6 @@ package art.arcane.iris.core.runtime; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisServices; import art.arcane.iris.core.IrisSettings; @@ -30,7 +31,6 @@ import org.bukkit.plugin.PluginManager; import org.bukkit.util.BoundingBox; import org.bukkit.util.VoxelShape; -import java.lang.reflect.Field; import java.lang.reflect.Method; import java.util.LinkedHashSet; import java.util.Objects; @@ -192,7 +192,8 @@ public final class WorldRuntimeControlService { backend.syncTime(world); return true; } catch (Throwable e) { - IrisLogging.debug("Runtime time lock skipped for world \"" + world.getName() + "\": " + e.getMessage()); + IrisLogging.reportError("Failed to lock the clock of world \"" + world.getName() + + "\" to noon; the world keeps its own time.", e); return false; } } @@ -621,21 +622,16 @@ public final class WorldRuntimeControlService { continue; } - try { - Field field = GameRule.class.getField(name); - Object value = field.get(null); - if (value instanceof GameRule gameRule && Integer.class.equals(gameRule.getType())) { - return (GameRule) gameRule; - } - } catch (Throwable ignored) { + Object declared = CapabilityProbe.attempt("GameRule." + name, + () -> GameRule.class.getField(name).get(null), null); + if (declared instanceof GameRule gameRule && Integer.class.equals(gameRule.getType())) { + return (GameRule) gameRule; } - try { - GameRule byName = GameRule.getByName(name); - if (byName != null && Integer.class.equals(byName.getType())) { - return (GameRule) byName; - } - } catch (Throwable ignored) { + GameRule byName = CapabilityProbe.attempt("GameRule#getByName(" + name + ")", + () -> GameRule.getByName(name), null); + if (byName != null && Integer.class.equals(byName.getType())) { + return (GameRule) byName; } } @@ -657,12 +653,10 @@ public final class WorldRuntimeControlService { continue; } - try { - GameRule byName = GameRule.getByName(availableRule); - if (byName != null && Integer.class.equals(byName.getType())) { - return (GameRule) byName; - } - } catch (Throwable ignored) { + GameRule byName = CapabilityProbe.attempt("GameRule#getByName(" + availableRule + ")", + () -> GameRule.getByName(availableRule), null); + if (byName != null && Integer.class.equals(byName.getType())) { + return (GameRule) byName; } } @@ -681,21 +675,16 @@ public final class WorldRuntimeControlService { continue; } - try { - Field field = GameRule.class.getField(name); - Object value = field.get(null); - if (value instanceof GameRule gameRule && Boolean.class.equals(gameRule.getType())) { - return (GameRule) gameRule; - } - } catch (Throwable ignored) { + Object declared = CapabilityProbe.attempt("GameRule." + name, + () -> GameRule.class.getField(name).get(null), null); + if (declared instanceof GameRule gameRule && Boolean.class.equals(gameRule.getType())) { + return (GameRule) gameRule; } - try { - GameRule byName = GameRule.getByName(name); - if (byName != null && Boolean.class.equals(byName.getType())) { - return (GameRule) byName; - } - } catch (Throwable ignored) { + GameRule byName = CapabilityProbe.attempt("GameRule#getByName(" + name + ")", + () -> GameRule.getByName(name), null); + if (byName != null && Boolean.class.equals(byName.getType())) { + return (GameRule) byName; } } @@ -717,12 +706,10 @@ public final class WorldRuntimeControlService { continue; } - try { - GameRule byName = GameRule.getByName(availableRule); - if (byName != null && Boolean.class.equals(byName.getType())) { - return (GameRule) byName; - } - } catch (Throwable ignored) { + GameRule byName = CapabilityProbe.attempt("GameRule#getByName(" + availableRule + ")", + () -> GameRule.getByName(availableRule), null); + if (byName != null && Boolean.class.equals(byName.getType())) { + return (GameRule) byName; } } diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java b/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java index 326fd929d..13d96105e 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java @@ -1,10 +1,10 @@ package art.arcane.iris.core.safeguard; import art.arcane.iris.core.IrisStartupValidation; +import art.arcane.iris.core.safeguard.task.CheckResult; import art.arcane.iris.core.safeguard.task.Diagnostic; import art.arcane.iris.core.safeguard.task.Task; import art.arcane.iris.core.safeguard.task.Tasks; -import art.arcane.iris.core.safeguard.task.ValueWithDiagnostics; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.util.common.format.C; @@ -15,7 +15,10 @@ import java.util.List; import java.util.Map; public final class IrisSafeguard { - private static Map> results = Collections.emptyMap(); + private static final String GENERIC_LOCK_REASON = + "An Iris startup check failed. Resolve the startup errors and restart the server."; + + private static Map results = Collections.emptyMap(); private static Map context = Collections.emptyMap(); private static Map> attachment = Collections.emptyMap(); private static Mode mode = Mode.STABLE; @@ -27,40 +30,40 @@ public final class IrisSafeguard { public static void execute() { IrisStartupValidation.beginRuntimeValidation(); List tasks = Tasks.getTasks(); - LinkedHashMap> resultValues = new LinkedHashMap<>(tasks.size()); + LinkedHashMap resultValues = new LinkedHashMap<>(tasks.size()); LinkedHashMap contextValues = new LinkedHashMap<>(tasks.size()); LinkedHashMap> attachmentValues = new LinkedHashMap<>(tasks.size()); Mode currentMode = Mode.STABLE; + String lockReason = null; int issueCount = 0; for (Task task : tasks) { - ValueWithDiagnostics result; + CheckResult result; try { result = task.run(); } catch (Throwable e) { - boolean injectionFailure = "injection".equals(task.getId()); - if (injectionFailure) { - IrisStartupValidation.markRuntimeInvalid("Iris runtime injection failed. Resolve the startup errors and restart the server."); - } - IrisLogging.reportError(e); - result = new ValueWithDiagnostics<>( - injectionFailure ? Mode.UNSTABLE : Mode.WARNING, - new Diagnostic(Diagnostic.Logger.ERROR, "Error while running task " + task.getId(), e) - ); + IrisLogging.reportError("Iris startup check \"" + task.getId() + "\" failed to run.", e); + Diagnostic diagnostic = new Diagnostic(Diagnostic.Logger.ERROR, + "Error while running task " + task.getId(), e); + result = task.failureMode() == Mode.UNSTABLE + ? CheckResult.danger(failureLockReason(task), diagnostic) + : CheckResult.warning(diagnostic); } - currentMode = currentMode.highest(result.getValue()); + currentMode = currentMode.highest(result.mode()); + if (result.mode() == Mode.UNSTABLE && lockReason == null) { + lockReason = result.lockReason(); + } resultValues.put(task, result); - contextValues.put(task.getId(), result.getValue().getId()); + contextValues.put(task.getId(), result.mode().getId()); List lines = new ArrayList<>(); - for (Diagnostic diagnostic : result.getDiagnostics()) { - String[] split = diagnostic.toString().split("\\n"); - Collections.addAll(lines, split); + for (Diagnostic diagnostic : result.diagnostics()) { + Collections.addAll(lines, diagnostic.toString().split("\\n")); } attachmentValues.put(task.getId(), lines); - if (result.getValue() != Mode.STABLE) { + if (result.mode() != Mode.STABLE) { issueCount++; } } @@ -70,6 +73,15 @@ public final class IrisSafeguard { attachment = Collections.unmodifiableMap(attachmentValues); mode = currentMode; count = issueCount; + + // Danger is the lock. Recognising one check by its id and letting every other critical failure + // through was how a no-op NMS binding or a missing dimension type reached an open login queue. + if (currentMode == Mode.UNSTABLE) { + IrisStartupValidation.markRuntimeInvalid(lockReason == null ? GENERIC_LOCK_REASON : lockReason); + return; + } + + IrisStartupValidation.markRuntimeReady(); } public static Mode mode() { @@ -84,6 +96,23 @@ public final class IrisSafeguard { return attachment; } + /** + * The per-check record for {@code /iris debugdump}. Without it a support report carried the server and + * plugin state but not one word about which startup check put the server in the mode it is in. + */ + public static String debugReport() { + StringBuilder builder = new StringBuilder(); + builder.append("Startup safeguard: ").append(mode.getId()) + .append(" (").append(count).append(" issues)"); + for (Map.Entry entry : context.entrySet()) { + builder.append('\n').append(" ").append(entry.getKey()).append(": ").append(entry.getValue()); + for (String line : attachment.getOrDefault(entry.getKey(), List.of())) { + builder.append('\n').append(" ").append(line); + } + } + return builder.toString(); + } + public static void printReports() { switch (mode) { case STABLE -> IrisLogging.info(C.BLUE + "0 Conflicts found"); @@ -91,7 +120,7 @@ public final class IrisSafeguard { case UNSTABLE -> IrisLogging.error(C.DARK_RED + "%s Issues found", count); } - for (ValueWithDiagnostics value : results.values()) { + for (CheckResult value : results.values()) { // Without the stack trace: Diagnostic.Logger splits on newlines, so a trace became one log // record per frame at the diagnostic's own severity. Traces go through reportError. value.log(true, false); @@ -106,6 +135,11 @@ public final class IrisSafeguard { } } + private static String failureLockReason(Task task) { + String declared = task.failureLockReason(); + return declared == null || declared.isBlank() ? GENERIC_LOCK_REASON : declared; + } + // A log record carries a level, so a blank record renders as an empty [WARN] line and a rule of // dashes renders as a [SEVERE] one. Spacing belongs to a console, not to the server log. private static void warning() { diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java b/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java new file mode 100644 index 000000000..26a1ab56e --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java @@ -0,0 +1,29 @@ +package art.arcane.iris.core.safeguard; + +import java.util.List; + +/** + * The operator lines a boot prints when Iris enabled but its runtime is locked. + *

+ * The Danger banner states the mode; this states the consequence. A locked runtime that still enabled is not + * covered by the vanilla-fallback refusal - that only runs when enable itself fails - so without this the + * only evidence is the first chunk request throwing hours later. + */ +public final class RuntimeLockNotice { + private RuntimeLockNotice() { + } + + public static List compose(String denialReason, boolean hasManagedWorldStorage) { + if (denialReason == null || denialReason.isBlank()) { + return List.of(); + } + + return List.of( + "Iris enabled with a locked runtime: " + denialReason.trim(), + hasManagedWorldStorage + ? "Every configured Iris world is generation-locked and refuses to generate terrain" + + " until this is resolved and the server restarts." + : "This server has no Iris world storage, so nothing is generation-locked;" + + " world creation and player login stay refused until this is resolved."); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java new file mode 100644 index 000000000..28f8bd85b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java @@ -0,0 +1,47 @@ +package art.arcane.iris.core.safeguard.task; + +import art.arcane.iris.core.safeguard.Mode; + +import java.util.List; + +/** + * What one startup check found: the severity it reached, the console lines it wants printed, and - for a + * Danger result only - the reason the runtime is locked. + *

+ * The lock reason is mandatory on {@link #danger(String, Diagnostic...)} because Danger is what stops player + * login, world creation and generation, and an operator has to be told which check did that and what fixes + * it. A check cannot reach Danger without answering that. + */ +public record CheckResult(Mode mode, String lockReason, List diagnostics) { + public CheckResult { + if (mode == null) { + throw new IllegalArgumentException("A startup check result needs a mode"); + } + if (mode == Mode.UNSTABLE && (lockReason == null || lockReason.isBlank())) { + throw new IllegalArgumentException("A Danger startup check result needs a lock reason"); + } + diagnostics = List.copyOf(diagnostics); + } + + public static CheckResult stable(Diagnostic... diagnostics) { + return new CheckResult(Mode.STABLE, null, List.of(diagnostics)); + } + + public static CheckResult warning(Diagnostic... diagnostics) { + return new CheckResult(Mode.WARNING, null, List.of(diagnostics)); + } + + public static CheckResult warning(List diagnostics) { + return new CheckResult(Mode.WARNING, null, diagnostics); + } + + public static CheckResult danger(String lockReason, Diagnostic... diagnostics) { + return new CheckResult(Mode.UNSTABLE, lockReason, List.of(diagnostics)); + } + + public void log(boolean withException, boolean withStackTrace) { + for (Diagnostic diagnostic : diagnostics) { + diagnostic.log(withException, withStackTrace); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java index adfc428d3..a181bc863 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java @@ -1,47 +1,62 @@ package art.arcane.iris.core.safeguard.task; import art.arcane.iris.core.safeguard.Mode; -import art.arcane.volmlib.util.format.Form; -import java.util.Locale; import java.util.function.Supplier; +/** + * One startup check, plus the severity its own failure carries. + *

+ * A check declares whether it is advisory or critical at the point it is written, so nothing downstream has + * to recognise a check by its id to decide what a failure means. An advisory check that throws is a Warning + * and leaves the runtime open; a critical one that throws is Danger and locks the runtime with the reason it + * carries here. + */ public abstract class Task { private final String id; - private final String name; + private final Mode failureMode; + private final String failureLockReason; - public Task(String id) { - this(id, Form.capitalizeWords(id.replace(" ", "_").toLowerCase(Locale.ROOT))); - } - - public Task(String id, String name) { + protected Task(String id, Mode failureMode, String failureLockReason) { this.id = id; - this.name = name; + this.failureMode = failureMode; + this.failureLockReason = failureLockReason; } public String getId() { return id; } - public String getName() { - return name; + public Mode failureMode() { + return failureMode; } - public abstract ValueWithDiagnostics run(); + public String failureLockReason() { + return failureLockReason; + } - public static Task of(String id, String name, Supplier> action) { - return new Task(id, name) { + public abstract CheckResult run(); + + /** + * A check whose failure degrades Iris but leaves it usable. + */ + public static Task advisory(String id, Supplier action) { + return new Task(id, Mode.WARNING, null) { @Override - public ValueWithDiagnostics run() { + public CheckResult run() { return action.get(); } }; } - public static Task of(String id, Supplier> action) { - return new Task(id) { + /** + * A check whose failure means Iris cannot safely run. {@code throwLockReason} is what an operator is told + * when the check itself throws rather than returning a result. + */ + public static Task critical(String id, String throwLockReason, Supplier action) { + return new Task(id, Mode.UNSTABLE, throwLockReason) { @Override - public ValueWithDiagnostics run() { + public CheckResult run() { return action.get(); } }; diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java index cf0dc153f..79d0dc8cb 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java @@ -1,7 +1,6 @@ package art.arcane.iris.core.safeguard.task; import art.arcane.iris.BuildConstants; -import art.arcane.iris.core.IrisStartupValidation; import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.core.IrisWorlds; import art.arcane.iris.core.IrisWorldStorage; @@ -9,46 +8,56 @@ import art.arcane.iris.core.nms.INMS; import art.arcane.iris.core.nms.v1X.NMSBinding1X; import art.arcane.iris.core.safeguard.Mode; import art.arcane.iris.core.splash.IrisSplashComposer; +import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.engine.object.IrisDimension; import art.arcane.iris.util.common.misc.getHardware; import art.arcane.iris.util.project.agent.Agent; import org.bukkit.Bukkit; import org.bukkit.Server; +import org.bukkit.plugin.Plugin; import java.util.ArrayList; -import java.util.HashSet; +import java.util.LinkedHashSet; import java.util.List; import java.util.Locale; import java.util.Set; import java.util.stream.Collectors; public final class Tasks { - private static final Task MEMORY = Task.of("memory", () -> { + static final String NMS_LOCK_REASON = + "Iris cannot use this server's NMS runtime. Resolve the Server Version or NMS Disabled error above and restart the server."; + static final String INJECTION_LOCK_REASON = + "Iris runtime injection failed. Resolve the startup errors and restart the server."; + static final String DIMENSION_TYPE_LOCK_REASON = + "Iris dimension types were not registered. Restart the server so the registries reload."; + + private static final Set INCOMPATIBLE_PLUGINS = Set.of("dynmap", "stratos"); + + private static final Task MEMORY = Task.advisory("memory", () -> { long mem = getHardware.getProcessMemory(); if (mem >= 3072L) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } if (mem > 2048L) { - return withDiagnostics(Mode.STABLE, + return CheckResult.stable( Diagnostic.Logger.INFO.create("Memory Recommendation"), - Diagnostic.Logger.INFO.create("- 3GB+ process memory is recommended for Iris."), - Diagnostic.Logger.INFO.create("- Process Memory: " + mem + " MB")); + Diagnostic.Logger.INFO.create("- A 3GB+ JVM maximum heap is recommended for Iris."), + Diagnostic.Logger.INFO.create("- JVM maximum heap: " + mem + " MB")); } - return withDiagnostics(Mode.WARNING, + return CheckResult.warning( Diagnostic.Logger.WARN.create("Low Memory"), - Diagnostic.Logger.WARN.create("- Iris is running with 2GB or less process memory."), - Diagnostic.Logger.WARN.create("- 3GB+ process memory is recommended for Iris."), - Diagnostic.Logger.WARN.create("- Process Memory: " + mem + " MB")); + Diagnostic.Logger.WARN.create("- Iris is running with a 2GB or smaller JVM maximum heap."), + Diagnostic.Logger.WARN.create("- A 3GB+ JVM maximum heap is recommended for Iris."), + Diagnostic.Logger.WARN.create("- JVM maximum heap: " + mem + " MB")); }); - private static final Task INCOMPATIBILITIES = Task.of("incompatibilities", () -> { - Set plugins = new HashSet<>(Set.of("dynmap", "Stratos")); - plugins.removeIf(name -> server().getPluginManager().getPlugin(name) == null); + private static final Task INCOMPATIBILITIES = Task.advisory("incompatibilities", () -> { + Set plugins = installedIncompatiblePlugins(); if (plugins.isEmpty()) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } List diagnostics = new ArrayList<>(); @@ -58,15 +67,15 @@ public final class Tasks { Diagnostic.Logger.ERROR.create("- The plugin Dynmap is not compatible with the server."), Diagnostic.Logger.ERROR.create("- If you want to have a map plugin like Dynmap, consider Bluemap.")); } - if (plugins.contains("Stratos")) { + if (plugins.contains("stratos")) { addAllDiagnostics(diagnostics, Diagnostic.Logger.ERROR.create("Stratos"), Diagnostic.Logger.ERROR.create("- Iris is not compatible with other worldgen plugins.")); } - return withDiagnostics(Mode.WARNING, diagnostics); + return CheckResult.warning(diagnostics); }); - private static final Task SOFTWARE = Task.of("software", () -> { + private static final Task SOFTWARE = Task.advisory("software", () -> { Set supported = Set.of("canvas", "folia", "purpur", "pufferfish", "leaf", "paper", "spigot", "bukkit"); String serverName = server().getName().toLowerCase(Locale.ROOT); boolean supportedServer = isCanvasServer(); @@ -80,15 +89,15 @@ public final class Tasks { } if (supportedServer) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } - return withDiagnostics(Mode.WARNING, + return CheckResult.warning( Diagnostic.Logger.WARN.create("Unsupported Server Software"), Diagnostic.Logger.WARN.create("- Please consider using Canvas, Folia, Leaf, Paper, or Purpur instead.")); }); - private static final Task VERSION = Task.of("version", () -> { + private static final Task VERSION = Task.critical("version", NMS_LOCK_REASON, () -> { String[] parts = BukkitPlatform.plugin().getDescription().getVersion().split("-"); String supportedVersions; if (parts.length >= 3) { @@ -103,84 +112,94 @@ public final class Tasks { if (!INMS.isBound()) { String cause = INMS.bindFailure() == null ? "Unknown NMS bind failure" : INMS.bindFailure().getMessage(); - return withDiagnostics(Mode.UNSTABLE, + return CheckResult.danger(NMS_LOCK_REASON, Diagnostic.Logger.ERROR.create("Server Version"), Diagnostic.Logger.ERROR.create("- " + cause), Diagnostic.Logger.ERROR.create("- Iris only supports " + supportedVersions)); } if (!(INMS.get() instanceof NMSBinding1X)) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } - return withDiagnostics(Mode.UNSTABLE, + return CheckResult.danger(NMS_LOCK_REASON, Diagnostic.Logger.ERROR.create("NMS Disabled"), Diagnostic.Logger.ERROR.create("- NMS support is disabled (general.disableNMS); Iris world creation is unavailable.")); }); - private static final Task INJECTION = Task.of("injection", () -> { + private static final Task INJECTION = Task.critical("injection", INJECTION_LOCK_REASON, () -> { + if (!INMS.isBound() || INMS.get() instanceof NMSBinding1X) { + return CheckResult.danger(NMS_LOCK_REASON, + Diagnostic.Logger.ERROR.create("Code Injection"), + Diagnostic.Logger.ERROR.create("- Runtime injection was skipped because Iris has no usable NMS binding.")); + } + if (!Agent.install()) { - IrisStartupValidation.markRuntimeInvalid("Iris Java agent is unavailable. Add -javaagent:" - + Agent.AGENT_JAR.getPath() + " to the JVM arguments before -jar and restart the server."); - return withDiagnostics(Mode.UNSTABLE, + String agentLockReason = "Iris Java agent is unavailable. Add -javaagent:" + + Agent.AGENT_JAR.getPath() + " to the JVM arguments before -jar and restart the server."; + return CheckResult.danger(agentLockReason, Diagnostic.Logger.ERROR.create("Java Agent"), Diagnostic.Logger.ERROR.create("- Add -javaagent:" + Agent.AGENT_JAR.getPath() + " before -jar in your startup command and restart the server."), Diagnostic.Logger.ERROR.create("- Dynamic attachment requires -XX:+EnableDynamicAgentLoading and a host that permits JVM attachment.")); } if (!INMS.get().injectBukkit()) { - IrisStartupValidation.markRuntimeInvalid("Iris runtime injection failed. Resolve the startup errors and restart the server."); - return withDiagnostics(Mode.UNSTABLE, + return CheckResult.danger(INJECTION_LOCK_REASON, Diagnostic.Logger.ERROR.create("Code Injection"), Diagnostic.Logger.ERROR.create("- Failed to inject code. Please contact support")); } - IrisStartupValidation.markRuntimeReady(); - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); }); - private static final Task DIMENSION_TYPES = Task.of("dimensionTypes", () -> { - Set keys = IrisWorlds.get().getDimensions().map(IrisDimension::getDimensionTypeKey).collect(Collectors.toSet()); - if (!INMS.get().missingDimensionTypes(keys.toArray(String[]::new))) { - return withDiagnostics(Mode.STABLE); + private static final Task DIMENSION_TYPES = Task.critical("dimensionTypes", DIMENSION_TYPE_LOCK_REASON, () -> { + if (!INMS.isBound()) { + return CheckResult.danger(NMS_LOCK_REASON, + Diagnostic.Logger.ERROR.create("Dimension Types"), + Diagnostic.Logger.ERROR.create("- Dimension types could not be checked because Iris has no NMS binding.")); } - return withDiagnostics(Mode.UNSTABLE, + Set keys = IrisWorlds.get().getDimensions().map(IrisDimension::getDimensionTypeKey).collect(Collectors.toSet()); + if (!INMS.get().missingDimensionTypes(keys.toArray(String[]::new))) { + return CheckResult.stable(); + } + + return CheckResult.danger(DIMENSION_TYPE_LOCK_REASON, Diagnostic.Logger.ERROR.create("Dimension Types"), Diagnostic.Logger.ERROR.create("- Required Iris dimension types were not loaded."), Diagnostic.Logger.ERROR.create("- If this still happens after a restart please contact support.")); }); - private static final Task DISK_SPACE = Task.of("diskSpace", () -> { + private static final Task DISK_SPACE = Task.advisory("diskSpace", () -> { double freeGiB = IrisWorldStorage.levelRoot().getFreeSpace() / (double) 0x4000_0000; if (freeGiB > 3.0) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } - return withDiagnostics(Mode.WARNING, + return CheckResult.warning( Diagnostic.Logger.WARN.create("Insufficient Disk Space"), Diagnostic.Logger.WARN.create("- 3GB of free space is required for Iris to function.")); }); - private static final Task JAVA = Task.of("java", () -> { + private static final Task JAVA = Task.advisory("java", () -> { int version = IrisSplashComposer.javaVersion(); if (version < 0) { - return withDiagnostics(Mode.WARNING, + return CheckResult.warning( Diagnostic.Logger.WARN.create("Java Runtime"), Diagnostic.Logger.WARN.create("- Java version could not be determined (java.version=" + System.getProperty("java.version") + ").")); } if (version == 25) { - return withDiagnostics(Mode.STABLE); + return CheckResult.stable(); } if (version > 25) { - return withDiagnostics(Mode.STABLE, + return CheckResult.stable( Diagnostic.Logger.INFO.create("Java Runtime"), Diagnostic.Logger.INFO.create("- Running Java " + version + ". Iris is tested primarily on Java 25.")); } - return withDiagnostics(Mode.WARNING, + return CheckResult.warning( Diagnostic.Logger.WARN.create("Unsupported Java version"), Diagnostic.Logger.WARN.create("- Java 25+ is recommended. Current runtime: Java " + version)); }); @@ -207,14 +226,36 @@ public final class Tasks { return Bukkit.getServer(); } + /** + * Matched against every registered plugin rather than asked for by exact name: a plugin.yml decides its + * own capitalization, and asking the plugin manager for "dynmap" misses a build that registers "Dynmap". + */ + private static Set installedIncompatiblePlugins() { + Set found = new LinkedHashSet<>(); + Plugin[] plugins = server().getPluginManager().getPlugins(); + if (plugins == null) { + return found; + } + for (Plugin plugin : plugins) { + String name = plugin == null ? null : plugin.getName(); + if (name == null) { + continue; + } + String normalized = name.toLowerCase(Locale.ROOT); + if (INCOMPATIBLE_PLUGINS.contains(normalized)) { + found.add(normalized); + } + } + return found; + } + private static boolean isCanvasServer() { ClassLoader loader = server().getClass().getClassLoader(); - try { - Class.forName("io.canvasmc.canvas.region.WorldRegionizer", false, loader); + if (CapabilityProbe.succeeds("io.canvasmc.canvas.region.WorldRegionizer", + () -> Class.forName("io.canvasmc.canvas.region.WorldRegionizer", false, loader))) { return true; - } catch (Throwable ignored) { - return server().getName().toLowerCase(Locale.ROOT).contains("canvas"); } + return server().getName().toLowerCase(Locale.ROOT).contains("canvas"); } private static void addAllDiagnostics(List diagnostics, Diagnostic... values) { @@ -222,13 +263,4 @@ public final class Tasks { diagnostics.add(value); } } - - private static ValueWithDiagnostics withDiagnostics(Mode mode, Diagnostic... diagnostics) { - return new ValueWithDiagnostics<>(mode, diagnostics); - } - - private static ValueWithDiagnostics withDiagnostics(Mode mode, List diagnostics) { - return new ValueWithDiagnostics<>(mode, diagnostics); - } - } diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/ValueWithDiagnostics.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/ValueWithDiagnostics.java deleted file mode 100644 index 6650cc4a0..000000000 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/ValueWithDiagnostics.java +++ /dev/null @@ -1,40 +0,0 @@ -package art.arcane.iris.core.safeguard.task; - -import java.util.List; - -public class ValueWithDiagnostics { - private final T value; - private final List diagnostics; - - public ValueWithDiagnostics(T value, List diagnostics) { - this.value = value; - this.diagnostics = List.copyOf(diagnostics); - } - - public ValueWithDiagnostics(T value, Diagnostic... diagnostics) { - this.value = value; - this.diagnostics = List.of(diagnostics); - } - - public T getValue() { - return value; - } - - public List getDiagnostics() { - return diagnostics; - } - - public void log() { - log(true, false); - } - - public void log(boolean withException) { - log(withException, false); - } - - public void log(boolean withException, boolean withStackTrace) { - for (Diagnostic diagnostic : diagnostics) { - diagnostic.log(withException, withStackTrace); - } - } -} diff --git a/core/src/main/java/art/arcane/iris/core/service/GlobalCacheSVC.java b/core/src/main/java/art/arcane/iris/core/service/GlobalCacheSVC.java index 9b2466f18..b8aaaa6e7 100644 --- a/core/src/main/java/art/arcane/iris/core/service/GlobalCacheSVC.java +++ b/core/src/main/java/art/arcane/iris/core/service/GlobalCacheSVC.java @@ -63,7 +63,9 @@ public class GlobalCacheSVC implements IrisService { activeTrimmer.interrupt(); try { activeTrimmer.join(TRIMMER_JOIN_MS); - } catch (InterruptedException ignored) { + } catch (InterruptedException interrupted) { + Thread.currentThread().interrupt(); + IrisLogging.warn("Interrupted while waiting for the global cache trimmer to stop."); } if (activeTrimmer.isAlive()) { IrisLogging.warn("Global cache trimmer did not stop within " + TRIMMER_JOIN_MS + "ms."); diff --git a/core/src/main/java/art/arcane/iris/core/service/MultiverseSVC.java b/core/src/main/java/art/arcane/iris/core/service/MultiverseSVC.java index bb27f660d..0cb6ed7a7 100644 --- a/core/src/main/java/art/arcane/iris/core/service/MultiverseSVC.java +++ b/core/src/main/java/art/arcane/iris/core/service/MultiverseSVC.java @@ -102,8 +102,10 @@ public class MultiverseSVC implements IrisService { guard = null; try { BukkitPlatform.volmitPlugin().unregisterListener(listener); - } catch (Throwable ignored) { + } catch (Throwable alreadyUnregistered) { // Shutdown ordering already unregisters every handler. + IrisLogging.debug("Multiverse guard listener was already unregistered: " + + alreadyUnregistered.getClass().getName()); } } } diff --git a/core/src/main/java/art/arcane/iris/engine/EngineDiagnostics.java b/core/src/main/java/art/arcane/iris/engine/EngineDiagnostics.java index c6507cd9e..7d7421363 100644 --- a/core/src/main/java/art/arcane/iris/engine/EngineDiagnostics.java +++ b/core/src/main/java/art/arcane/iris/engine/EngineDiagnostics.java @@ -45,7 +45,8 @@ final class EngineDiagnostics { + (version == null || version.isBlank() ? "unknown" : version)); } } catch (Throwable e) { - IrisLogging.debug("Pack compat summary failed: " + e.getMessage()); + IrisLogging.reportError("Failed to report pack compatibility for an Iris world;" + + " the world keeps generating and the summary is missing.", e); } } diff --git a/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java b/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java index 74c903135..c9ed90490 100644 --- a/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java +++ b/core/src/main/java/art/arcane/iris/engine/history/GenerationSemanticIndex.java @@ -1,6 +1,7 @@ package art.arcane.iris.engine.history; import art.arcane.iris.engine.hydrology.HydrologyFeatureType; +import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.util.common.io.Durability; import it.unimi.dsi.fastutil.longs.Long2IntOpenHashMap; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; @@ -1465,9 +1466,16 @@ public final class GenerationSemanticIndex { if (previousHash == null || previousHash.equals(currentHash)) { return; } + Path unreferenced = directory.resolve(fileName(regionX, regionZ, previousHash)); try { - Files.deleteIfExists(directory.resolve(fileName(regionX, regionZ, previousHash))); - } catch (IOException ignored) { + Files.deleteIfExists(unreferenced); + } catch (IOException failure) { + if (IrisLogging.warnOnce("generation-semantics-shard-delete", + "Could not delete the superseded generation semantics shard %s; stale shards accumulate on disk.", + unreferenced)) { + IrisLogging.reportError("Could not delete the superseded generation semantics shard " + + unreferenced + ".", failure); + } } } diff --git a/core/src/test/java/art/arcane/iris/core/IrisSafeguardLockPolicyTest.java b/core/src/test/java/art/arcane/iris/core/IrisSafeguardLockPolicyTest.java new file mode 100644 index 000000000..1f134d69e --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/IrisSafeguardLockPolicyTest.java @@ -0,0 +1,140 @@ +package art.arcane.iris.core; + +import art.arcane.iris.core.safeguard.IrisSafeguard; +import art.arcane.iris.core.safeguard.Mode; +import art.arcane.iris.core.safeguard.task.CheckResult; +import art.arcane.iris.core.safeguard.task.Diagnostic; +import art.arcane.iris.core.safeguard.task.Task; +import art.arcane.iris.core.safeguard.task.Tasks; +import org.junit.After; +import org.junit.Test; +import org.mockito.MockedStatic; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mockStatic; + +/** + * Danger Mode used to be a label: only the check whose id happened to be {@code injection} locked the + * runtime, and it did so from inside a catch that string-matched that id. Every other critical failure - + * an NMS binding that could not be bound, {@code general.disableNMS}, missing dimension types - printed + * Danger and then let the boot carry on with logins open. The severity a check declares is now the whole + * decision: any Danger result locks the runtime, and every check states the lock reason an operator reads. + */ +public class IrisSafeguardLockPolicyTest { + @After + public void resetValidationAndSafeguard() { + IrisStartupValidation.disable(); + try (MockedStatic tasks = mockStatic(Tasks.class)) { + tasks.when(Tasks::getTasks).thenReturn(List.of()); + IrisSafeguard.execute(); + } + } + + @Test + public void aDangerResultFromAnyCheckLocksTheRuntime() { + Task dimensionTypes = Task.critical("dimensionTypes", "unused throw reason", + () -> CheckResult.danger("Iris dimension types were not registered. Restart the server so the registries reload.", + Diagnostic.Logger.ERROR.create("Dimension Types"))); + + execute(dimensionTypes); + + assertEquals(Mode.UNSTABLE, IrisSafeguard.mode()); + assertFalse(IrisStartupValidation.isReady()); + assertEquals("Iris dimension types were not registered. Restart the server so the registries reload.", + IrisStartupValidation.denialReason().orElseThrow()); + assertThrows(IllegalStateException.class, IrisStartupValidation::requireWorldCreationReady); + } + + @Test + public void anAdvisoryCheckThatThrowsStaysWarningAndLeavesTheRuntimeReady() { + Task memory = Task.advisory("memory", () -> { + throw new IllegalStateException("no hardware probe"); + }); + + execute(memory); + + assertEquals(Mode.WARNING, IrisSafeguard.mode()); + assertTrue(IrisStartupValidation.isReady()); + assertEquals("warning", IrisSafeguard.asContext().get("memory")); + } + + @Test + public void aCriticalCheckThatThrowsLocksWithTheReasonItDeclared() { + Task injection = Task.critical("injection", + "Iris runtime injection failed. Resolve the startup errors and restart the server.", + () -> { + throw new IllegalStateException("Java agent unavailable"); + }); + + execute(injection); + + assertEquals(Mode.UNSTABLE, IrisSafeguard.mode()); + assertEquals("Iris runtime injection failed. Resolve the startup errors and restart the server.", + IrisStartupValidation.denialReason().orElseThrow()); + } + + @Test + public void theFirstDangerCheckOwnsTheLockReason() { + Task version = Task.critical("version", "unused throw reason", + () -> CheckResult.danger("first reason", Diagnostic.Logger.ERROR.create("Server Version"))); + Task injection = Task.critical("injection", "unused throw reason", + () -> CheckResult.danger("second reason", Diagnostic.Logger.ERROR.create("Java Agent"))); + + execute(version, injection); + + assertEquals("first reason", IrisStartupValidation.denialReason().orElseThrow()); + } + + @Test + public void everyCheckStableLeavesTheRuntimeReady() { + execute(Task.advisory("memory", CheckResult::stable), Task.critical("injection", "unused", CheckResult::stable)); + + assertEquals(Mode.STABLE, IrisSafeguard.mode()); + assertTrue(IrisStartupValidation.isReady()); + } + + /** + * A Danger result has to name what the operator must fix, so a check cannot raise one without a reason. + */ + @Test + public void aDangerResultWithoutALockReasonIsRejected() { + assertThrows(IllegalArgumentException.class, + () -> CheckResult.danger(" ", Diagnostic.Logger.ERROR.create("Broken"))); + } + + /** + * The per-check modes and diagnostic lines were collected on every boot and read by nothing. + * {@code /iris debugdump} carries them now, so a support report says which check failed. + */ + @Test + public void theDebugReportNamesEveryCheckWithItsModeAndDiagnosticLines() { + Task memory = Task.advisory("memory", () -> CheckResult.warning( + Diagnostic.Logger.WARN.create("Low Memory"), + Diagnostic.Logger.WARN.create("- JVM maximum heap: 1024 MB"))); + Task injection = Task.critical("injection", "unused", CheckResult::stable); + + execute(memory, injection); + String report = IrisSafeguard.debugReport(); + + assertTrue(report, report.contains("Startup safeguard: warning")); + assertTrue(report, report.contains("memory: warning")); + assertTrue(report, report.contains("Low Memory")); + assertTrue(report, report.contains("- JVM maximum heap: 1024 MB")); + assertTrue(report, report.contains("injection: stable")); + } + + private void execute(Task... checks) { + IrisStartupValidation.begin(); + IrisStartupValidation.markDatapacksReady(); + IrisStartupValidation.markPacksReady(); + try (MockedStatic tasks = mockStatic(Tasks.class)) { + tasks.when(Tasks::getTasks).thenReturn(List.of(checks)); + IrisSafeguard.execute(); + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/IrisSafeguardTest.java b/core/src/test/java/art/arcane/iris/core/IrisSafeguardTest.java index c05aa7f30..a3e5eb752 100644 --- a/core/src/test/java/art/arcane/iris/core/IrisSafeguardTest.java +++ b/core/src/test/java/art/arcane/iris/core/IrisSafeguardTest.java @@ -15,6 +15,7 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertThrows; import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.anyString; import static org.mockito.Mockito.mockStatic; public class IrisSafeguardTest { @@ -30,9 +31,11 @@ public class IrisSafeguardTest { @Test public void injectionExceptionRevokesReadinessAndReportsUnstableRuntime() { IllegalStateException injectionFailure = new IllegalStateException("Java agent unavailable"); - Task injection = Task.of("injection", () -> { - throw injectionFailure; - }); + Task injection = Task.critical("injection", + "Iris runtime injection failed. Resolve the startup errors and restart the server.", + () -> { + throw injectionFailure; + }); IrisStartupValidation.begin(); IrisStartupValidation.markDatapacksReady(); IrisStartupValidation.markPacksReady(); @@ -53,7 +56,7 @@ public class IrisSafeguardTest { assertEquals("Iris runtime injection failed. Resolve the startup errors and restart the server.", IrisStartupValidation.denialReason().orElseThrow()); assertThrows(IllegalStateException.class, IrisStartupValidation::requireWorldCreationReady); - logging.verify(() -> IrisLogging.reportError(injectionFailure)); + logging.verify(() -> IrisLogging.reportError(anyString(), org.mockito.ArgumentMatchers.same(injectionFailure))); } } } diff --git a/core/src/test/java/art/arcane/iris/core/IrisSettingsRewriteFailureTest.java b/core/src/test/java/art/arcane/iris/core/IrisSettingsRewriteFailureTest.java new file mode 100644 index 000000000..5acea5075 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/IrisSettingsRewriteFailureTest.java @@ -0,0 +1,79 @@ +package art.arcane.iris.core; + +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import org.junit.After; +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; + +import java.io.File; +import java.nio.file.Files; + +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.ArgumentMatchers.contains; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +/** + * Iris rewrites iris.json on every read so a file written by an older build gains the keys it is missing. + * That write used to fail into an empty catch, which is how a read-only or full data folder turned every + * settings change an operator made in game into something that silently vanished on the next boot. + */ +public class IrisSettingsRewriteFailureTest { + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + private IrisPlatform capturingPlatform; + private IrisPlatform previousPlatform; + private IrisSettings previousSettings; + + @Before + public void captureReports() { + previousSettings = IrisSettings.settings; + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + capturingPlatform = mock(IrisPlatform.class); + IrisPlatforms.bind(capturingPlatform); + } + + @After + public void restore() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + IrisSettings.settings = previousSettings; + } + + @Test + public void anUnwritableSettingsFileIsReported() throws Exception { + File settingsFile = temporaryFolder.newFile("iris.json"); + Files.writeString(settingsFile.toPath(), "{}"); + assertTrue("this test needs a file the JVM can mark read-only", settingsFile.setWritable(false)); + doReturn(settingsFile).when(capturingPlatform).dataFile("iris.json"); + + IrisSettings.invalidate(); + IrisSettings.get(); + + verify(capturingPlatform).reportError(contains(settingsFile.getAbsolutePath()), any(Throwable.class)); + } + + @Test + public void aWritableSettingsFileIsRewrittenQuietly() throws Exception { + File settingsFile = temporaryFolder.newFile("iris.json"); + Files.writeString(settingsFile.toPath(), "{}"); + doReturn(settingsFile).when(capturingPlatform).dataFile("iris.json"); + + IrisSettings.invalidate(); + IrisSettings.get(); + + verify(capturingPlatform, never()).reportError(anyString(), any(Throwable.class)); + assertTrue(Files.readString(settingsFile.toPath()).contains("general")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupportCloseFailureTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupportCloseFailureTest.java new file mode 100644 index 000000000..6fa5b55e3 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/WorldLifecycleSupportCloseFailureTest.java @@ -0,0 +1,66 @@ +package art.arcane.iris.core.lifecycle; + +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentCaptor; + +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; + +/** + * A level storage access that will not close still holds the world's session lock, and the next attempt to + * open that world fails with a lock message that names no cause. The close failure used to be swallowed + * whole, so the console had nothing to connect the two. + */ +public class WorldLifecycleSupportCloseFailureTest { + private IrisPlatform capturingPlatform; + private IrisPlatform previousPlatform; + + @Before + public void captureReports() { + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + capturingPlatform = mock(IrisPlatform.class); + IrisPlatforms.bind(capturingPlatform); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + + @Test + public void aFailedStorageCloseIsReportedWithItsCause() { + WorldLifecycleSupport.closeLevelStorageAccess(new FailingStorageAccess()); + + ArgumentCaptor reported = ArgumentCaptor.forClass(Throwable.class); + verify(capturingPlatform).reportError(anyString(), reported.capture()); + assertEquals("session lock still held", reported.getValue().getMessage()); + } + + @Test + public void aClosableStorageAccessReportsNothing() { + WorldLifecycleSupport.closeLevelStorageAccess(new ClosableStorageAccess()); + + verify(capturingPlatform, org.mockito.Mockito.never()).reportError(anyString(), org.mockito.ArgumentMatchers.any()); + } + + public static final class FailingStorageAccess { + public void close() { + throw new IllegalStateException("session lock still held"); + } + } + + public static final class ClosableStorageAccess { + public void close() { + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/runtime/WorldRuntimeControlServiceTimeLockTest.java b/core/src/test/java/art/arcane/iris/core/runtime/WorldRuntimeControlServiceTimeLockTest.java index eae476848..efdfd4fd4 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/WorldRuntimeControlServiceTimeLockTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/WorldRuntimeControlServiceTimeLockTest.java @@ -2,7 +2,10 @@ package art.arcane.iris.core.runtime; import art.arcane.iris.core.lifecycle.CapabilitySnapshot; import art.arcane.iris.core.lifecycle.ServerFamily; +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.testsupport.BukkitTestServer; +import org.mockito.ArgumentCaptor; import org.bukkit.Bukkit; import org.bukkit.World; import org.junit.Before; @@ -15,7 +18,11 @@ import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicLong; import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.contains; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; public class WorldRuntimeControlServiceTimeLockTest { @Before @@ -47,6 +54,32 @@ public class WorldRuntimeControlServiceTimeLockTest { assertTrue(setTimeCalled.get()); } + /** + * A runtime that refuses the clock write used to leave a single debug line with no trace, so a world + * stuck at night looked like a pack setting rather than a rejected reflective call. + */ + @Test + public void reportsTheFailureWhenTheRuntimeClockSetterThrows() throws Exception { + IrisPlatform previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + IrisPlatform capturingPlatform = mock(IrisPlatform.class); + IrisPlatforms.bind(capturingPlatform); + try { + World world = createWorldProxy("rejecting-clock", false, new AtomicBoolean(false), new AtomicLong(0L), true); + + assertFalse(createService().applyNoonTimeLock(world)); + + ArgumentCaptor reported = ArgumentCaptor.forClass(Throwable.class); + verify(capturingPlatform).reportError(contains("rejecting-clock"), reported.capture()); + assertNotNull(reported.getValue()); + } finally { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + } + @Test public void appliesTimeLockWhenWorldHasMutableClock() throws Exception { AtomicBoolean setTimeCalled = new AtomicBoolean(false); diff --git a/core/src/test/java/art/arcane/iris/core/safeguard/RuntimeLockNoticeTest.java b/core/src/test/java/art/arcane/iris/core/safeguard/RuntimeLockNoticeTest.java new file mode 100644 index 000000000..7ffe4ca6e --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/safeguard/RuntimeLockNoticeTest.java @@ -0,0 +1,42 @@ +package art.arcane.iris.core.safeguard; + +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +/** + * A boot that ends in Danger Mode used to say so only in the banner. The server then ran on with every + * configured Iris world bound to a generator that throws on the first chunk, and nothing after the banner + * said that out loud. {@code refuseVanillaFallback} never covers this case because it only runs when enable + * itself fails. + */ +public class RuntimeLockNoticeTest { + @Test + public void aReadyRuntimeSaysNothing() { + assertTrue(RuntimeLockNotice.compose(null, true).isEmpty()); + assertTrue(RuntimeLockNotice.compose(" ", true).isEmpty()); + } + + @Test + public void aLockedRuntimeWithIrisWorldsNamesTheReasonAndWhatItBlocks() { + List lines = RuntimeLockNotice.compose("Iris runtime injection failed.", true); + + assertEquals(2, lines.size()); + assertEquals("Iris enabled with a locked runtime: Iris runtime injection failed.", lines.getFirst()); + assertEquals("Every configured Iris world is generation-locked and refuses to generate terrain" + + " until this is resolved and the server restarts.", lines.get(1)); + } + + @Test + public void aLockedRuntimeWithoutIrisWorldsSaysOnlyWhatIsBlocked() { + List lines = RuntimeLockNotice.compose("Iris runtime injection failed.", false); + + assertEquals(2, lines.size()); + assertEquals("Iris enabled with a locked runtime: Iris runtime injection failed.", lines.getFirst()); + assertEquals("This server has no Iris world storage, so nothing is generation-locked;" + + " world creation and player login stay refused until this is resolved.", lines.get(1)); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/safeguard/TasksIncompatibilityTest.java b/core/src/test/java/art/arcane/iris/core/safeguard/TasksIncompatibilityTest.java new file mode 100644 index 000000000..d5efcbf68 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/safeguard/TasksIncompatibilityTest.java @@ -0,0 +1,87 @@ +package art.arcane.iris.core.safeguard; + +import art.arcane.iris.core.safeguard.task.CheckResult; +import art.arcane.iris.core.safeguard.task.Diagnostic; +import art.arcane.iris.core.safeguard.task.Task; +import art.arcane.iris.core.safeguard.task.Tasks; +import art.arcane.iris.testsupport.BukkitTestServer; +import org.bukkit.Bukkit; +import org.bukkit.plugin.Plugin; +import org.bukkit.plugin.PluginManager; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; + +/** + * The incompatibility check used to ask the plugin manager for the exact strings "dynmap" and "Stratos". + * Both plugins register under a different case than that - Dynmap's plugin.yml name is "dynmap" on some + * builds and "Dynmap" on others - so the check silently passed on the servers it exists for. + */ +public class TasksIncompatibilityTest { + private PluginManager pluginManager; + + @Before + public void installServer() { + BukkitTestServer.install(); + pluginManager = Bukkit.getServer().getPluginManager(); + doReturn(new Plugin[0]).when(pluginManager).getPlugins(); + } + + @After + public void clearPlugins() { + doReturn(new Plugin[0]).when(pluginManager).getPlugins(); + } + + @Test + public void anIncompatiblePluginIsFoundWhateverCaseItRegistersUnder() { + doReturn(new Plugin[]{namedPlugin("DynMap")}).when(pluginManager).getPlugins(); + + CheckResult result = incompatibilities().run(); + + assertEquals(Mode.WARNING, result.mode()); + assertTrue(headings(result).toString(), headings(result).contains("Dynmap")); + } + + @Test + public void aSecondIncompatiblePluginIsReportedTogetherWithTheFirst() { + doReturn(new Plugin[]{namedPlugin("stratos"), namedPlugin("dynmap")}).when(pluginManager).getPlugins(); + + CheckResult result = incompatibilities().run(); + + assertEquals(Mode.WARNING, result.mode()); + assertTrue(headings(result).toString(), headings(result).containsAll(List.of("Dynmap", "Stratos"))); + } + + @Test + public void aCleanPluginSetIsStable() { + doReturn(new Plugin[]{namedPlugin("BlueMap")}).when(pluginManager).getPlugins(); + + assertEquals(Mode.STABLE, incompatibilities().run().mode()); + } + + private static Task incompatibilities() { + for (Task task : Tasks.getTasks()) { + if ("incompatibilities".equals(task.getId())) { + return task; + } + } + throw new IllegalStateException("The incompatibilities check is missing from the safeguard task list"); + } + + private static List headings(CheckResult result) { + return result.diagnostics().stream().map(Diagnostic::getMessage).toList(); + } + + private static Plugin namedPlugin(String name) { + Plugin plugin = mock(Plugin.class); + doReturn(name).when(plugin).getName(); + return plugin; + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/EngineDiagnosticsFailureTest.java b/core/src/test/java/art/arcane/iris/engine/EngineDiagnosticsFailureTest.java new file mode 100644 index 000000000..78cc2cfe0 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/EngineDiagnosticsFailureTest.java @@ -0,0 +1,53 @@ +package art.arcane.iris.engine; + +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.mockito.ArgumentCaptor; + +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +/** + * The pack-compat summary is the line that tells an operator a pack cannot generate on the running + * Minecraft version. It must never take a working world down, but a failure to produce it used to leave + * only a debug line with no class and no trace, so the missing summary looked like "the pack is fine". + */ +public class EngineDiagnosticsFailureTest { + private IrisPlatform capturingPlatform; + private IrisPlatform previousPlatform; + + @Before + public void captureReports() { + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + capturingPlatform = mock(IrisPlatform.class); + IrisPlatforms.bind(capturingPlatform); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + + @Test + public void aFailedCompatSummaryIsReportedWithItsCauseAndDoesNotThrow() { + IrisEngine engine = mock(IrisEngine.class); + IllegalStateException failure = new IllegalStateException("engine data unavailable"); + when(engine.getData()).thenThrow(failure); + + new EngineDiagnostics(engine).logPackCompatSummary(); + + ArgumentCaptor reported = ArgumentCaptor.forClass(Throwable.class); + verify(capturingPlatform).reportError(anyString(), reported.capture()); + assertEquals(failure, reported.getValue()); + } +} diff --git a/core/src/test/java/art/arcane/iris/purity/SwallowedFailurePolicyTest.java b/core/src/test/java/art/arcane/iris/purity/SwallowedFailurePolicyTest.java new file mode 100644 index 000000000..674b75b29 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/purity/SwallowedFailurePolicyTest.java @@ -0,0 +1,89 @@ +package art.arcane.iris.purity; + +import org.junit.Test; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Stream; + +import static org.junit.Assert.assertTrue; + +/** + * A catch whose body is empty says nothing about whether the failure was expected. On world lifecycle, + * world replacement, runtime control, safeguard, service enable and disable, and generation paths that is + * the difference between a diagnosable server and a silent one, so these packages carry none: an optional + * API that is genuinely absent goes through {@code CapabilityProbe}, and everything else reports. + */ +public class SwallowedFailurePolicyTest { + private static final List PROTECTED_ROOTS = List.of( + "src/main/java/art/arcane/iris/core/runtime", + "src/main/java/art/arcane/iris/core/lifecycle", + "src/main/java/art/arcane/iris/core/safeguard", + "src/main/java/art/arcane/iris/core/link", + "src/main/java/art/arcane/iris/core/service", + "src/main/java/art/arcane/iris/core/localization", + "src/main/java/art/arcane/iris/core/structure/authoring", + "src/main/java/art/arcane/iris/core/IrisSettings.java", + "src/main/java/art/arcane/iris/engine/decorator", + "src/main/java/art/arcane/iris/engine/history", + "../spi/src/main/java", + "../adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java", + "../adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/PendingWorldReplacementManager.java" + ); + private static final Pattern IGNORED_CATCH = Pattern.compile("^\\s*}?\\s*catch \\([^)]*\\)\\s*\\{\\s*$"); + + @Test + public void noProtectedPathEndsAFailureInAnEmptyCatch() throws IOException { + List offenders = new ArrayList<>(); + for (Path file : protectedSources()) { + List lines = Files.readAllLines(file); + for (int i = 0; i < lines.size() - 1; i++) { + Matcher matcher = IGNORED_CATCH.matcher(lines.get(i)); + if (matcher.matches() && "}".equals(lines.get(i + 1).trim())) { + offenders.add(file + ":" + (i + 1) + " " + lines.get(i).trim()); + } + } + } + + assertTrue("Empty catch blocks on protected paths: " + String.join("\n", offenders), offenders.isEmpty()); + } + + /** + * The reporting front door is what makes a failure visible, so a protected path must not print a + * caught throwable's message on its own and call that handled. + */ + @Test + public void theProbeHelperIsTheOnlyQuietFailurePath() throws IOException { + List offenders = new ArrayList<>(); + for (Path file : protectedSources()) { + String source = Files.readString(file); + if (source.contains("catch (Throwable ignored)") || source.contains("catch (Exception ignored)")) { + offenders.add(file.toString()); + } + } + + assertTrue("Protected paths still name a caught failure \"ignored\": " + String.join("\n", offenders), + offenders.isEmpty()); + } + + private static List protectedSources() throws IOException { + List files = new ArrayList<>(); + for (String root : PROTECTED_ROOTS) { + Path path = Path.of(root); + assertTrue("Protected root is missing: " + root, Files.exists(path)); + if (Files.isRegularFile(path)) { + files.add(path); + continue; + } + try (Stream walk = Files.walk(path)) { + walk.filter(candidate -> candidate.toString().endsWith(".java")).forEach(files::add); + } + } + return files; + } +} diff --git a/core/src/test/java/art/arcane/iris/spi/CapabilityProbeTest.java b/core/src/test/java/art/arcane/iris/spi/CapabilityProbeTest.java new file mode 100644 index 000000000..747a884a9 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/spi/CapabilityProbeTest.java @@ -0,0 +1,136 @@ +package art.arcane.iris.spi; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; + +/** + * An optional API that is not there is not a failure, but a bare ignored catch makes it impossible to tell + * that miss apart from a real breakage. The probe keeps the miss quiet at INFO and states the failure class + * and message at DEBUG, so an operator running with debug on can see exactly what was not found. + */ +public class CapabilityProbeTest { + private final List levels = new ArrayList<>(); + private final List messages = new ArrayList<>(); + private IrisPlatform previousPlatform; + + @Before + public void captureLog() { + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + levels.clear(); + messages.clear(); + bindCapturingPlatform(); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + + @Test + public void aFailedProbeNamesTheFailureClassAndMessageAtDebug() { + String resolved = CapabilityProbe.attempt("world#getChunkAtAsync", + () -> { + throw new NoSuchMethodException("getChunkAtAsync"); + }, + null); + + assertNull(resolved); + assertEquals(List.of(LogLevel.DEBUG), levels); + assertEquals("Capability probe \"world#getChunkAtAsync\" is unavailable: " + + "java.lang.NoSuchMethodException: getChunkAtAsync", messages.getFirst()); + } + + @Test + public void aFailedProbeReturnsTheUnavailableValue() { + String resolved = CapabilityProbe.attempt("optional", () -> { + throw new NoClassDefFoundError("net/example/Missing"); + }, "absent"); + + assertEquals("absent", resolved); + } + + @Test + public void aMessagelessFailureStillNamesItsClass() { + CapabilityProbe.attempt("optional", () -> { + throw new IllegalStateException(); + }, null); + + assertEquals("Capability probe \"optional\" is unavailable: java.lang.IllegalStateException", + messages.getFirst()); + } + + @Test + public void aSuccessfulProbeReturnsItsValueWithoutLogging() { + String resolved = CapabilityProbe.attempt("present", () -> "value", null); + + assertEquals("value", resolved); + assertTrue(messages.toString(), messages.isEmpty()); + } + + @Test + public void anActionProbeReportsWhetherItCompleted() { + assertTrue(CapabilityProbe.succeeds("action", () -> { + })); + assertTrue(messages.toString(), messages.isEmpty()); + + assertFalse(CapabilityProbe.succeeds("action", () -> { + throw new LinkageError("bad class"); + })); + assertEquals("Capability probe \"action\" is unavailable: java.lang.LinkageError: bad class", + messages.getFirst()); + } + + /** + * Swallowing an InterruptedException also swallows the interrupt, which strands whatever asked the + * thread to stop. The probe hands the flag back. + */ + @Test + public void anInterruptedProbeRestoresTheInterruptFlag() { + try { + CapabilityProbe.attempt("interruptible", () -> { + throw new InterruptedException("stop"); + }, null); + + assertTrue(Thread.currentThread().isInterrupted()); + } finally { + Thread.interrupted(); + } + } + + @Test + public void anUnnamedCapabilityStillProducesAReadableLine() { + CapabilityProbe.attempt(null, () -> { + throw new IllegalArgumentException("nope"); + }, null); + + assertEquals("Capability probe \"unnamed\" is unavailable: java.lang.IllegalArgumentException: nope", + messages.getFirst()); + } + + private void bindCapturingPlatform() { + IrisPlatform platform = mock(IrisPlatform.class); + doAnswer(invocation -> { + levels.add(invocation.getArgument(0, LogLevel.class)); + messages.add(invocation.getArgument(1, String.class)); + return null; + }).when(platform).log(any(LogLevel.class), anyString()); + IrisPlatforms.bind(platform); + } +} diff --git a/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java b/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java new file mode 100644 index 000000000..6020ab8c8 --- /dev/null +++ b/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java @@ -0,0 +1,88 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.spi; + +/** + * Runs a lookup whose failure means "this optional API, plugin or server capability is not here" and answers + * with a fallback instead of throwing. + *

+ * This is the only sanctioned form of a quiet catch in Iris. A probe states the capability it was looking + * for, and a miss is recorded at {@link LogLevel#DEBUG} with the failure's class and message, so an operator + * running with debug on can tell a genuinely absent API apart from one that broke while being reached. Every + * other catch - world lifecycle, world replacement, runtime control, safeguard, service enable and disable, + * generation - reports through {@link IrisLogging#reportError(String, Throwable)} with the full trace. + *

+ * Internal to Iris; not a published integration surface. + */ +public final class CapabilityProbe { + private CapabilityProbe() { + } + + /** + * Resolves {@code probe}, or returns {@code unavailable} when it throws. + * + * @param capability what was being looked for, for the debug record - for example + * {@code "world#getChunkAtAsync"} + * @param probe the lookup; any {@link Throwable} it raises means the capability is absent + * @param unavailable the value that stands for an absent capability + */ + public static T attempt(String capability, Probe probe, T unavailable) { + try { + return probe.resolve(); + } catch (Throwable failure) { + recordUnavailable(capability, failure); + return unavailable; + } + } + + /** + * Runs {@code attempt} and reports whether it completed, for a probe whose only result is that it worked. + */ + public static boolean succeeds(String capability, Attempt attempt) { + try { + attempt.run(); + return true; + } catch (Throwable failure) { + recordUnavailable(capability, failure); + return false; + } + } + + private static void recordUnavailable(String capability, Throwable failure) { + if (failure instanceof InterruptedException) { + Thread.currentThread().interrupt(); + } + + String name = capability == null || capability.isBlank() ? "unnamed" : capability; + String message = failure.getMessage(); + IrisLogging.debug("Capability probe \"" + name + "\" is unavailable: " + + failure.getClass().getName() + + (message == null ? "" : ": " + message)); + } + + @FunctionalInterface + public interface Probe { + T resolve() throws Throwable; + } + + @FunctionalInterface + public interface Attempt { + void run() throws Throwable; + } +} From 6c6dba0232ad575dcd52fd32cc565688f8db5689 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 03:47:53 -0400 Subject: [PATCH 14/35] Release runtime statics - Null Iris.instance, the console sender, the Multiverse link, the compat set and the chunk tickets at the end of teardownRuntime - Bind the host bridge suppliers to the constructing plugin instead of reading the instance static on every call - State that Iris is disabled when service, getTemp or getSender is reached after teardown instead of raising a bare NullPointerException - Add IrisRuntimeStatics so a disable drops the service registry, both capability singletons, the loaded datapack runtime and the localization roots - Add WorldLifecycleService.reset and WorldRuntimeControlService.reset so the next boot snapshots the server it is running on - Add ServerConfigurator.resetLoadedDatapackRuntime so an enable revalidates instead of trusting the previous boot's fingerprint - Clear the localization data folder and plain-text memo on shutdown - Add BukkitPlatform.releaseHost and call it last in terminal cleanup so the disabled plugin, console sender and log bridge stop being reachable from a static --- .../src/main/java/art/arcane/iris/Iris.java | 53 ++++++++++++++----- .../arcane/iris/core/ServerConfigurator.java | 14 +++++ .../core/lifecycle/IrisRuntimeStatics.java | 28 ++++++++++ .../core/lifecycle/WorldLifecycleService.java | 9 ++++ .../iris/core/localization/IrisLanguage.java | 2 + .../runtime/WorldRuntimeControlService.java | 9 ++++ .../iris/engine/decorator/DecoratorCore.java | 1 + .../iris/platform/bukkit/BukkitPlatform.java | 13 +++++ .../lifecycle/IrisRuntimeStaticsTest.java | 51 ++++++++++++++++++ .../bukkit/BukkitPlatformHostReleaseTest.java | 30 +++++++++++ 10 files changed, 197 insertions(+), 13 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java create mode 100644 core/src/test/java/art/arcane/iris/core/lifecycle/IrisRuntimeStaticsTest.java create mode 100644 core/src/test/java/art/arcane/iris/platform/bukkit/BukkitPlatformHostReleaseTest.java diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java index a9a7d5bfb..8960222b8 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java @@ -39,6 +39,7 @@ import art.arcane.iris.core.SettingsHotloadWatch; import art.arcane.iris.core.ServerConfigurator; import art.arcane.iris.core.datapack.DatapackIngestService; import art.arcane.iris.core.datapack.DatapackIngestService.StartupValidationOutcome; +import art.arcane.iris.core.lifecycle.IrisRuntimeStatics; import art.arcane.iris.core.lifecycle.ManagedWorldLoader; import art.arcane.iris.core.lifecycle.MissingWorldStorageLog; import art.arcane.iris.core.lifecycle.PaperLibBootstrap; @@ -216,16 +217,23 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { private volatile ServerShutdownBoundary serverShutdownBoundary; public static VolmitSender getSender() { - if (sender == null) { - sender = new VolmitSender(Bukkit.getConsoleSender()); - sender.setTag(instance.getTag()); + VolmitSender current = sender; + if (current == null) { + Iris plugin = instance; + current = new VolmitSender(Bukkit.getConsoleSender()); + current.setTag(plugin == null ? IrisSafeguard.mode().tag("") : plugin.getTag()); + sender = current; } - return sender; + return current; } @SuppressWarnings("unchecked") public static T service(Class c) { - return (T) instance.services.get(c); + Iris plugin = instance; + if (plugin == null || plugin.services == null) { + throw new IllegalStateException("Iris is disabled; " + c.getSimpleName() + " is unavailable"); + } + return (T) plugin.services.get(c); } public static void callEvent(Event e) { @@ -264,7 +272,11 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { } public static File getTemp() { - return instance.getDataFolder("cache", "temp"); + Iris plugin = instance; + if (plugin == null) { + throw new IllegalStateException("Iris is disabled; the temp folder is unavailable"); + } + return plugin.getDataFolder("cache", "temp"); } public static void msg(String string) { @@ -543,11 +555,11 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { Iris::msg, Iris::reportError, (event) -> Iris.callEvent((org.bukkit.event.Event) event), - () -> Iris.instance.getDataFolder(), - (path) -> Iris.instance.getDataFile(path), - () -> Iris.instance.getJarFile(), - () -> Iris.instance.getIrisVersion(), - () -> Iris.instance.getMCVersion())); + this::getDataFolder, + this::getDataFile, + this::getJarFile, + this::getIrisVersion, + this::getMCVersion)); SlimJar.load(); } @@ -1055,10 +1067,24 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { Iris.reportError("Failed to close Iris I/O workers.", failure); } clearQueues(); - IrisServices.clear(); + IrisRuntimeStatics.reset(); + releaseStatics(); } } + /** + * A disabled plugin must not stay reachable through a static. Everything that reads these either runs + * while Iris is enabled or already handles their absence; the platform binding outlives them because + * core still logs through it until finishTerminalCleanup unbinds it. + */ + private static void releaseStatics() { + linkMultiverseCore = null; + compat = null; + tickets = null; + sender = null; + instance = null; + } + private void quiesceRuntimeForServerShutdown(String reason) { serverStopTeardownDeferred.set(true); INMS.get().deferPluginClassLoaderClose(); @@ -1201,6 +1227,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { failure.printStackTrace(SHUTDOWN_ERRORS); } } + BukkitPlatform.releaseHost(); } } @@ -1395,7 +1422,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { } public int getIrisVersion() { - String input = Iris.instance.getDescription().getVersion(); + String input = getDescription().getVersion(); int hyphenIndex = input.indexOf('-'); if (hyphenIndex != -1) { String result = input.substring(0, hyphenIndex); diff --git a/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java b/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java index ed709bf7d..d9edd7444 100644 --- a/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java +++ b/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java @@ -158,6 +158,20 @@ public class ServerConfigurator { } } + /** + * Forgets what the previous boot loaded, so an enable in the same JVM recompiles and revalidates rather + * than trusting a fingerprint taken against a server that is gone. + */ + public static void resetLoadedDatapackRuntime() { + synchronized (DATAPACK_INSTALL_LOCK) { + loadedDatapackRuntimeReady = false; + loadedDatapackCompilerInputFingerprint = ""; + loadedDatapackRegistryRequirements = Map.of(); + loadedDatapackRuntimeGeneration++; + loadedDatapackRestartRequired = false; + } + } + public static LoadedDatapackRuntimeInvalidation invalidateLoadedDatapackRuntime() { synchronized (DATAPACK_INSTALL_LOCK) { boolean wasReady = loadedDatapackRuntimeReady; diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java new file mode 100644 index 000000000..7ae8da04b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java @@ -0,0 +1,28 @@ +package art.arcane.iris.core.lifecycle; + +import art.arcane.iris.core.ServerConfigurator; +import art.arcane.iris.core.localization.IrisLanguage; +import art.arcane.iris.core.runtime.WorldRuntimeControlService; +import art.arcane.iris.spi.IrisServices; + +/** + * Drops every process-wide cache core keeps about the running server, so a disable leaves nothing an + * enable in the same JVM could answer from. + *

+ * The capability singletons are the reason this exists: each holds reflective handles onto the live + * CraftServer and MinecraftServer, and a boot that reused them would be talking to the previous server's + * objects. The platform binding itself is not cleared here - core still logs through it while the adapter + * finishes its own teardown - and is unbound last by the adapter. + */ +public final class IrisRuntimeStatics { + private IrisRuntimeStatics() { + } + + public static void reset() { + IrisServices.clear(); + WorldLifecycleService.reset(); + WorldRuntimeControlService.reset(); + ServerConfigurator.resetLoadedDatapackRuntime(); + IrisLanguage.shutdown(); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java index 5ed11e45d..68818c289 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java @@ -51,6 +51,15 @@ public final class WorldLifecycleService { this.worldBackendByKey = new ConcurrentHashMap<>(); } + /** + * Drops the cached snapshot so the next boot in this JVM builds one against the server it is running on. + */ + public static void reset() { + synchronized (WorldLifecycleService.class) { + instance = null; + } + } + public static WorldLifecycleService get() { WorldLifecycleService current = instance; if (current != null) { diff --git a/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java b/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java index 4dc586eee..13094df67 100644 --- a/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java +++ b/core/src/main/java/art/arcane/iris/core/localization/IrisLanguage.java @@ -429,6 +429,8 @@ public final class IrisLanguage { } public static synchronized void shutdown() { + dataFolder = null; + PLAIN_MEMO.set(null); PluginLanguageService current = selections; selections = null; if (current != null) { diff --git a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java index d8ddb486b..fc3e3470a 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java @@ -76,6 +76,15 @@ public final class WorldRuntimeControlService { + ", " + backend.describeCapabilities(); } + /** + * Drops the cached snapshot so the next boot in this JVM builds one against the server it is running on. + */ + public static void reset() { + synchronized (WorldRuntimeControlService.class) { + instance = null; + } + } + public static WorldRuntimeControlService get() { WorldRuntimeControlService current = instance; if (current != null) { diff --git a/core/src/main/java/art/arcane/iris/engine/decorator/DecoratorCore.java b/core/src/main/java/art/arcane/iris/engine/decorator/DecoratorCore.java index 0a4111d46..c79f19978 100644 --- a/core/src/main/java/art/arcane/iris/engine/decorator/DecoratorCore.java +++ b/core/src/main/java/art/arcane/iris/engine/decorator/DecoratorCore.java @@ -50,6 +50,7 @@ final class DecoratorCore { static final ThreadLocal SCRATCH_OPTS = ThreadLocal.withInitial(PlaceOpts::new); + static final class PlaceOpts { boolean caveSkipFluid; boolean underwater; diff --git a/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java b/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java index b681fe28e..e52f400ef 100644 --- a/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java +++ b/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java @@ -103,6 +103,19 @@ public final class BukkitPlatform implements IrisPlatform { PLUGIN = plugin; } + /** + * Drops every reference this class holds to the disabled plugin. Called last in the adapter's teardown, + * after core has stopped logging through the host bridge, so a disabled plugin instance is not reachable + * from a static for the life of the JVM. + */ + public static void releaseHost() { + PLUGIN = null; + HUD_BAR = null; + HUD_LANES = null; + CONSOLE = null; + BRIDGE = null; + } + public static Plugin plugin() { Plugin plugin = PLUGIN; if (plugin == null) { diff --git a/core/src/test/java/art/arcane/iris/core/lifecycle/IrisRuntimeStaticsTest.java b/core/src/test/java/art/arcane/iris/core/lifecycle/IrisRuntimeStaticsTest.java new file mode 100644 index 000000000..57a515c00 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/lifecycle/IrisRuntimeStaticsTest.java @@ -0,0 +1,51 @@ +package art.arcane.iris.core.lifecycle; + +import art.arcane.iris.core.runtime.WorldRuntimeControlService; +import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.testsupport.BukkitTestServer; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import static org.junit.Assert.assertNotSame; +import static org.junit.Assert.assertNull; + +/** + * Iris keeps process-wide caches that describe the running server: the service registry, and the lifecycle + * and runtime-control singletons that each hold a capability snapshot of reflective handles onto the live + * server. Nothing cleared them on disable, so a re-enable in the same JVM kept answering from the previous + * boot's snapshot. + */ +public class IrisRuntimeStaticsTest { + @Before + public void installServer() { + BukkitTestServer.install(); + } + + @After + public void clearStatics() { + IrisRuntimeStatics.reset(); + } + + @Test + public void resetUnbindsEveryRegisteredService() { + Runnable service = () -> { + }; + IrisServices.register(Runnable.class, service); + + IrisRuntimeStatics.reset(); + + assertNull(IrisServices.getOrNull(Runnable.class)); + } + + @Test + public void resetDropsTheCachedCapabilitySingletons() { + WorldLifecycleService lifecycle = WorldLifecycleService.get(); + WorldRuntimeControlService control = WorldRuntimeControlService.get(); + + IrisRuntimeStatics.reset(); + + assertNotSame(lifecycle, WorldLifecycleService.get()); + assertNotSame(control, WorldRuntimeControlService.get()); + } +} diff --git a/core/src/test/java/art/arcane/iris/platform/bukkit/BukkitPlatformHostReleaseTest.java b/core/src/test/java/art/arcane/iris/platform/bukkit/BukkitPlatformHostReleaseTest.java new file mode 100644 index 000000000..361fc42b2 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/platform/bukkit/BukkitPlatformHostReleaseTest.java @@ -0,0 +1,30 @@ +package art.arcane.iris.platform.bukkit; + +import org.bukkit.plugin.Plugin; +import org.junit.After; +import org.junit.Test; + +import static org.junit.Assert.assertFalse; +import static org.mockito.Mockito.mock; + +/** + * The host statics are how core reaches the plugin. Nothing cleared them on disable, so the disabled + * plugin instance, its console sender and its log bridge stayed reachable from a static for the life of + * the JVM. + */ +public class BukkitPlatformHostReleaseTest { + @After + public void clearHost() { + BukkitPlatform.releaseHost(); + } + + @Test + public void releasingTheHostDropsThePluginAndTheHud() { + BukkitPlatform.hostPlugin(mock(Plugin.class)); + + BukkitPlatform.releaseHost(); + + assertFalse(BukkitPlatform.hasPlugin()); + assertFalse(BukkitPlatform.hasHud()); + } +} From 486c6eeae9b10ddfa8bd113e1cd904305c141692 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:37:35 -0400 Subject: [PATCH 15/35] Defer runtime injection - Add RuntimeInjection so the Java agent attach and the server-code injection run once, on demand, instead of during every enable - Install the injection when a world Iris created is about to be built and when Bukkit asks for the generator of a world configured outside Iris - Lock the runtime with the same reason a boot-time injection failure used to raise when the deferred install fails - Add general.eagerRuntimeInjection to keep boot-time injection and its startup verification - Re-read the startup lock after a deferred install so a failed install refuses the world instead of generating it - Move the stale cache/temp sweep off the boot thread and make every pack import wait it out - Move the default-pack presence warning off the boot thread; it walks the whole pack tree to pick a warning - Build the wand and dust templates on the first tick instead of during service enable - Report enable duration, per-phase timings and the three slowest services on every boot - Drop the wand and dust templates on service disable --- .../src/main/java/art/arcane/iris/Iris.java | 67 ++++++++++- .../iris/core/IrisWorldGeneratorResolver.java | 28 ++++- .../art/arcane/iris/core/service/WandSVC.java | 17 ++- .../art/arcane/iris/core/IrisSettings.java | 7 ++ .../core/lifecycle/IrisRuntimeStatics.java | 2 + .../core/lifecycle/WorldLifecycleService.java | 2 + .../iris/core/runtime/RuntimeInjection.java | 105 ++++++++++++++++++ .../iris/core/safeguard/task/Tasks.java | 33 +++--- .../arcane/iris/core/service/StudioSVC.java | 48 +++++++- .../core/runtime/RuntimeInjectionTest.java | 73 ++++++++++++ .../safeguard/TasksInjectionDeferralTest.java | 79 +++++++++++++ 11 files changed, 426 insertions(+), 35 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java create mode 100644 core/src/test/java/art/arcane/iris/core/runtime/RuntimeInjectionTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/safeguard/TasksInjectionDeferralTest.java diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java index 8960222b8..569d0d0a2 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java @@ -149,6 +149,7 @@ import java.lang.reflect.Modifier; import java.util.ArrayList; import java.util.concurrent.CopyOnWriteArrayList; import java.util.Date; +import java.util.LinkedHashMap; import java.util.List; import java.util.Map; import java.util.Objects; @@ -161,6 +162,7 @@ import java.util.logging.Level; import java.util.logging.Logger; import java.util.regex.Matcher; import java.util.regex.Pattern; +import java.util.stream.Collectors; @SuppressWarnings("CanBeFinal") public class Iris extends VolmitPlugin implements Listener, ReloadAware { @@ -626,6 +628,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { J.s(() -> Bukkit.getPluginManager().disablePlugin(this), 1); return false; } + EnableTimings timings = new EnableTimings(); alreadyDrained.set(false); postStopFinisherStarted.set(false); serverStopTeardownDeferred.set(false); @@ -647,6 +650,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { DirectorMiniMenu.Theme.irisGreen(), IrisLanguage.directorResolver(), IrisLanguage.editorOptions())); PaperLibBootstrap.install(); SimdSupport.install(); + timings.mark("bootstrap"); services = new KMap<>(); BukkitPlatform.hostHud(new HudActionBar(this), new HudBossBarLane()); // Explicit, ordered service list: the previous reflective jar scan gave hash-ordered @@ -685,9 +689,13 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { IrisServices.register(PreservationRegistry.class, services.get(PreservationSVC.class)); compat = IrisCompat.configured(getDataFile("compat.json")); IrisServices.register(IrisCompat.class, compat); + timings.mark("services"); ServerConfigurator.configure(); + timings.mark("serverConfig"); StartupValidationOutcome datapackValidation = DatapackIngestService.validateOnStartup(); + timings.mark("datapacks"); IrisSafeguard.execute(); + timings.mark("safeguard"); getSender().setTag(getTag()); // A cosmetic banner must never abort the bootstrap. J.attempt(this::splash); @@ -696,6 +704,7 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { // Paper's bootstrap runs before any plugin logger exists, so orphan-storage warnings raised there // never reach logs/latest.log. Replay them once now that the platform log is up. MissingWorldStorageLog.replayToPlatformLog(); + timings.mark("splash"); tickets = new ChunkTickets(); linkMultiverseCore = new MultiverseCoreLink(); IrisServices.register(MultiverseCoreLink.class, linkMultiverseCore); @@ -708,18 +717,24 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { IrisServices.register(ManagedWorldLoader.class, (ManagedWorldLoader) this::loadManagedWorld); SettingsHotloadWatch watch = new SettingsHotloadWatch(getDataFile("iris.json")); settingsHotloadWatch = watch; - // Stale-temp cleanup must complete before services enable: StudioSVC.onEnable downloads - // packs through cache/temp on an async thread, and a concurrent delete of that folder - // truncated pack imports mid-copy (partial packs/ without dimensions/). - IO.delete(getTemp()); + // Off the boot thread, because a stale cache/temp can hold a whole abandoned pack import and + // deleting it recursively is unbounded. Every pack import waits this sweep out instead, which is + // the invariant that mattered: a delete running underneath an import truncated it mid-copy. + StudioSVC.gateDownloadsOnStaleTempCleanup(MultiBurst.ioBurst.completeValueAsync(() -> { + IO.delete(getTemp()); + return null; + })); + timings.mark("tempSweep"); // One throwing service must not abort the bootstrap: the steps after this loop // (listeners, shutdown hook, replacement journals) are the safety-critical ones. // Only services that actually enabled get listeners and a later onDisable. enabledServices.clear(); for (IrisService service : orderedServices) { + long serviceStartedAt = System.nanoTime(); try { service.onEnable(); enabledServices.add(service); + timings.markService(service.getClass().getSimpleName(), serviceStartedAt); } catch (Throwable e) { // A service failure is NOT a datapack validation failure: the admission gate // must never lock every login over a broken cosmetic service. Log loudly, @@ -740,10 +755,12 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { Iris.reportError("Failed to register listener for " + service.getClass().getSimpleName() + ".", e); } } + timings.mark("serviceEnable"); if (datapackValidation == StartupValidationOutcome.READY) { IrisServices.get(ExternalDataSVC.class).setContentChangeListener(generatorResolver::requestExternalContentRefresh); generatorResolver.validateAllPacks(); } + timings.mark("packValidation"); addShutdownHook(); pendingWorldReplacements.processPendingStartupReplacements(); pendingWorldDeletes.processPendingStartupWorldDeletes(); @@ -771,9 +788,51 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { // match a slice type; the block-state slice is deliberately never retainable (regenerable, huge). IrisToolbelt.retainMantleDataForSlice(TreeBlockMaterial.class.getCanonicalName()); }); + timings.mark("startupTasks"); + timings.report(); return true; } + /** + * Where the enable thread went, so a boot that got slower can be attributed to a phase rather than to + * Iris in general. The total is a lifecycle milestone and lands in logs/latest.log; the breakdown is + * for whoever is looking. + */ + private static final class EnableTimings { + private static final int REPORTED_SERVICES = 3; + + private final long startedAt = System.nanoTime(); + private final StringBuilder phases = new StringBuilder(); + private final Map serviceMillis = new LinkedHashMap<>(); + private long lastMark = startedAt; + + private void mark(String phase) { + long now = System.nanoTime(); + if (!phases.isEmpty()) { + phases.append(' '); + } + phases.append(phase).append('=').append(TimeUnit.NANOSECONDS.toMillis(now - lastMark)).append("ms"); + lastMark = now; + } + + private void markService(String service, long serviceStartedAt) { + serviceMillis.put(service, TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - serviceStartedAt)); + } + + private void report() { + IrisLogging.notice("Enabled in %dms (%s)", + TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startedAt), phases); + String slowest = serviceMillis.entrySet().stream() + .sorted(Map.Entry.comparingByValue().reversed()) + .limit(REPORTED_SERVICES) + .map(entry -> entry.getKey() + "=" + entry.getValue() + "ms") + .collect(Collectors.joining(" ")); + if (!slowest.isBlank()) { + IrisLogging.notice("Slowest services: %s", slowest); + } + } + } + private void reconcileStartupWorlds() { generatorResolver.startupWorldsReady().whenComplete((ignored, failure) -> { if (failure != null) { diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java index 2171388af..09ee5a08e 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java @@ -30,6 +30,7 @@ import art.arcane.iris.core.pack.PackValidationCache; import art.arcane.iris.core.pack.PackValidationRegistry; import art.arcane.iris.core.pack.PackValidationResult; import art.arcane.iris.core.pack.PackValidator; +import art.arcane.iris.core.runtime.RuntimeInjection; import art.arcane.iris.core.service.ExternalDataSVC; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; @@ -486,17 +487,23 @@ public final class IrisWorldGeneratorResolver { Iris.debug("Generator discovery probe for loaded world " + worldName); return IrisFailClosedChunkGenerator.discoveryProbe(worldName); } - Optional startupDenial = IrisStartupValidation.denialReason(); - if (startupDenial.isPresent()) { - Iris.warn("Keeping configured Iris world '" + worldName - + "' generation-locked: " + startupDenial.get()); - return IrisFailClosedChunkGenerator.startupLock(worldName, startupDenial.get()); + ChunkGenerator startupLock = startupLockedGenerator(worldName); + if (startupLock != null) { + return startupLock; } ChunkGenerator stagedGenerator = WorldLifecycleStaging.consumeGenerator(worldName); if (stagedGenerator != null) { Iris.debug("Using staged runtime generator for " + worldName); return stagedGenerator; } + // A world Iris created staged its generator above and installed the injection on the way in. This + // is a world configured outside Iris, and Bukkit asks for its generator before it builds the level, + // so this is the last point at which the injection it needs can still be installed in time. + RuntimeInjection.installIfDeferred(); + startupLock = startupLockedGenerator(worldName); + if (startupLock != null) { + return startupLock; + } Iris.debug("Default World Generator Called for " + worldName + " using ID: " + id); if (id == null || id.isEmpty()) id = IrisSettings.get().getGenerator().getDefaultWorldType(); Iris.debug("Generator ID: " + id + " requested by bukkit/plugin"); @@ -516,6 +523,17 @@ public final class IrisWorldGeneratorResolver { } } + @Nullable + private static ChunkGenerator startupLockedGenerator(String worldName) { + Optional startupDenial = IrisStartupValidation.denialReason(); + if (startupDenial.isEmpty()) { + return null; + } + Iris.warn("Keeping configured Iris world '" + worldName + + "' generation-locked: " + startupDenial.get()); + return IrisFailClosedChunkGenerator.startupLock(worldName, startupDenial.get()); + } + private static boolean isPlotSquaredGeneratorDiscoveryProbe(String worldName, String id) { return PLOT_SQUARED_DISCOVERY_WORLD.equals(worldName) && id != null && id.isEmpty(); } diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java index 927dbaf06..af0d02536 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java @@ -75,8 +75,8 @@ public class WandSVC implements IrisService { private static final int MS_PER_TICK = Integer.parseInt(System.getProperty("iris.ms_per_tick", "30")); private static final int PLAYER_RESCAN_INTERVAL_TICKS = 100; - private static ItemStack dust; - private static ItemStack wand; + private static volatile ItemStack dust; + private static volatile ItemStack wand; private final Map activePlayers = new ConcurrentHashMap<>(); private final AtomicBoolean playerRescanScheduled = new AtomicBoolean(false); @@ -374,12 +374,16 @@ public class WandSVC implements IrisService { @Override public void onEnable() { - wand = createWand(); - dust = createDust(); enabled = true; activePlayers.clear(); ticksUntilPlayerRescan = 0; taskId = J.ar(this::tickAll, 1); + // Building the templates reaches the item and enchantment registries, which costs more than the + // rest of this service's startup put together and is only needed to recognise a pre-marker wand. + J.s(() -> { + wand = createWand(); + dust = createDust(); + }); } @Override @@ -389,6 +393,8 @@ public class WandSVC implements IrisService { J.car(taskId); taskId = -1; } + wand = null; + dust = null; activePlayers.clear(); playerRescanScheduled.set(false); } @@ -607,7 +613,8 @@ public class WandSVC implements IrisService { return false; } Byte marker = is.getItemMeta().getPersistentDataContainer().get(dustKey(), PersistentDataType.BYTE); - return (marker != null && marker == (byte) 1) || is.isSimilar(dust); + ItemStack template = dust; + return (marker != null && marker == (byte) 1) || (template != null && is.isSimilar(template)); } private static NamespacedKey wandKey() { diff --git a/core/src/main/java/art/arcane/iris/core/IrisSettings.java b/core/src/main/java/art/arcane/iris/core/IrisSettings.java index 936a12d22..85f428455 100644 --- a/core/src/main/java/art/arcane/iris/core/IrisSettings.java +++ b/core/src/main/java/art/arcane/iris/core/IrisSettings.java @@ -308,6 +308,13 @@ public class IrisSettings { public boolean debug = false; public boolean dumpMantleOnError = false; public boolean disableNMS = false; + /** + * Attach the Java agent and install the server-code injection while Iris enables, instead of the + * first time a world Iris generates is about to load. Boot-time injection costs roughly a second + * on a server that may never load an Iris world; turn this on to pay it up front and have the + * startup safeguard verify it. + */ + public boolean eagerRuntimeInjection = false; public boolean splashLogoStartup = true; public boolean useConsoleCustomColors = true; public boolean useCustomColorsIngame = true; diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java index 7ae8da04b..9381a3433 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java @@ -2,6 +2,7 @@ package art.arcane.iris.core.lifecycle; import art.arcane.iris.core.ServerConfigurator; import art.arcane.iris.core.localization.IrisLanguage; +import art.arcane.iris.core.runtime.RuntimeInjection; import art.arcane.iris.core.runtime.WorldRuntimeControlService; import art.arcane.iris.spi.IrisServices; @@ -22,6 +23,7 @@ public final class IrisRuntimeStatics { IrisServices.clear(); WorldLifecycleService.reset(); WorldRuntimeControlService.reset(); + RuntimeInjection.reset(); ServerConfigurator.resetLoadedDatapackRuntime(); IrisLanguage.shutdown(); } diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java index 68818c289..bc04a5120 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java @@ -1,6 +1,7 @@ package art.arcane.iris.core.lifecycle; import art.arcane.iris.core.ServerConfigurator; +import art.arcane.iris.core.runtime.RuntimeInjection; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.core.tools.IrisToolbelt; import art.arcane.iris.util.common.scheduling.J; @@ -85,6 +86,7 @@ public final class WorldLifecycleService { public CompletableFuture create(WorldLifecycleRequest request) { WorldLifecycleBackend backend; try { + RuntimeInjection.installIfDeferred(); if (request.callerKind() == WorldLifecycleCaller.FORCED_STUDIO) { ServerConfigurator.requireWorldCreationReady(true); } else { diff --git a/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java b/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java new file mode 100644 index 000000000..6b65a9270 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java @@ -0,0 +1,105 @@ +package art.arcane.iris.core.runtime; + +import art.arcane.iris.core.IrisStartupValidation; +import art.arcane.iris.core.nms.INMS; +import art.arcane.iris.core.nms.v1X.NMSBinding1X; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.project.agent.Agent; + +/** + * Attaches the Java agent and installs the server-code injection Iris generation needs, once per boot. + *

+ * Both steps are expensive - a self-attach to the running JVM, then three class retransformations - and + * neither is needed until a world that Iris generates is about to exist. A server that never loads an Iris + * world never pays for them. Whoever is about to produce such a world calls {@link #installIfDeferred()} + * first; it is idempotent, and a failure marks the runtime invalid so the same lock that guards a failed + * boot-time injection guards a failed deferred one. + */ +public final class RuntimeInjection { + private static final Object LOCK = new Object(); + + private static volatile Outcome outcome; + + private RuntimeInjection() { + } + + public enum Failure { + NONE, + NO_BINDING, + AGENT, + INJECTION + } + + public record Outcome(boolean installed, Failure failure, String lockReason) { + } + + /** + * Runs the install if it has not run yet and reports what happened. Never throws. + */ + public static Outcome install() { + Outcome current = outcome; + if (current != null) { + return current; + } + + synchronized (LOCK) { + if (outcome != null) { + return outcome; + } + Outcome resolved = attemptInstall(); + outcome = resolved; + return resolved; + } + } + + /** + * Installs on the deferred path and locks the runtime when that fails, so the caller's own readiness + * check refuses the world instead of loading it onto uninstrumented server code. + */ + public static void installIfDeferred() { + Outcome resolved = install(); + if (resolved.installed()) { + return; + } + + IrisLogging.error("Iris runtime injection is unavailable: " + resolved.lockReason()); + IrisStartupValidation.markRuntimeInvalid(resolved.lockReason()); + } + + public static boolean isInstalled() { + Outcome current = outcome; + return current != null && current.installed(); + } + + /** + * Forgets the result so the next boot in this JVM installs against the binding it is running with. + */ + public static void reset() { + synchronized (LOCK) { + outcome = null; + } + } + + static String agentLockReason() { + return "Iris Java agent is unavailable. Add -javaagent:" + Agent.AGENT_JAR.getPath() + + " to the JVM arguments before -jar and restart the server."; + } + + private static Outcome attemptInstall() { + if (!INMS.isBound() || INMS.get() instanceof NMSBinding1X) { + return new Outcome(false, Failure.NO_BINDING, + "Iris cannot use this server's NMS runtime. Resolve the Server Version or NMS Disabled error above and restart the server."); + } + + if (!Agent.install()) { + return new Outcome(false, Failure.AGENT, agentLockReason()); + } + + if (!INMS.get().injectBukkit()) { + return new Outcome(false, Failure.INJECTION, + "Iris runtime injection failed. Resolve the startup errors and restart the server."); + } + + return new Outcome(true, Failure.NONE, null); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java index 79d0dc8cb..46dad3f52 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java @@ -2,7 +2,9 @@ package art.arcane.iris.core.safeguard.task; import art.arcane.iris.BuildConstants; import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.IrisWorlds; +import art.arcane.iris.core.runtime.RuntimeInjection; import art.arcane.iris.core.IrisWorldStorage; import art.arcane.iris.core.nms.INMS; import art.arcane.iris.core.nms.v1X.NMSBinding1X; @@ -128,28 +130,29 @@ public final class Tasks { }); private static final Task INJECTION = Task.critical("injection", INJECTION_LOCK_REASON, () -> { - if (!INMS.isBound() || INMS.get() instanceof NMSBinding1X) { - return CheckResult.danger(NMS_LOCK_REASON, - Diagnostic.Logger.ERROR.create("Code Injection"), - Diagnostic.Logger.ERROR.create("- Runtime injection was skipped because Iris has no usable NMS binding.")); + if (!IrisSettings.get().getGeneral().isEagerRuntimeInjection()) { + return CheckResult.stable( + Diagnostic.Logger.INFO.create("Runtime Injection"), + Diagnostic.Logger.INFO.create("- Deferred to the first world load. Set general.eagerRuntimeInjection to verify it during startup.")); } - if (!Agent.install()) { - String agentLockReason = "Iris Java agent is unavailable. Add -javaagent:" - + Agent.AGENT_JAR.getPath() + " to the JVM arguments before -jar and restart the server."; - return CheckResult.danger(agentLockReason, + RuntimeInjection.Outcome outcome = RuntimeInjection.install(); + if (outcome.installed()) { + return CheckResult.stable(); + } + + return switch (outcome.failure()) { + case NO_BINDING -> CheckResult.danger(outcome.lockReason(), + Diagnostic.Logger.ERROR.create("Code Injection"), + Diagnostic.Logger.ERROR.create("- Runtime injection was skipped because Iris has no usable NMS binding.")); + case AGENT -> CheckResult.danger(outcome.lockReason(), Diagnostic.Logger.ERROR.create("Java Agent"), Diagnostic.Logger.ERROR.create("- Add -javaagent:" + Agent.AGENT_JAR.getPath() + " before -jar in your startup command and restart the server."), Diagnostic.Logger.ERROR.create("- Dynamic attachment requires -XX:+EnableDynamicAgentLoading and a host that permits JVM attachment.")); - } - - if (!INMS.get().injectBukkit()) { - return CheckResult.danger(INJECTION_LOCK_REASON, + case INJECTION, NONE -> CheckResult.danger(INJECTION_LOCK_REASON, Diagnostic.Logger.ERROR.create("Code Injection"), Diagnostic.Logger.ERROR.create("- Failed to inject code. Please contact support")); - } - - return CheckResult.stable(); + }; }); private static final Task DIMENSION_TYPES = Task.critical("dimensionTypes", DIMENSION_TYPE_LOCK_REASON, () -> { diff --git a/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java b/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java index 876fed1bb..d11262a7b 100644 --- a/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java +++ b/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java @@ -90,8 +90,10 @@ import java.util.Objects; import java.util.Optional; import java.util.UUID; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.function.Consumer; import java.util.function.Supplier; import java.util.regex.Pattern; @@ -106,23 +108,54 @@ public class StudioSVC implements IrisService { private static final Pattern PROJECT_NAME = Pattern.compile("[a-z0-9_-]+"); private static final AtomicCache counter = new AtomicCache<>(); private final StudioTransitionQueue studioTransitions = new StudioTransitionQueue(); + private static final long STALE_TEMP_CLEANUP_TIMEOUT_SECONDS = 120L; + private static volatile CompletableFuture staleTempCleanup = CompletableFuture.completedFuture(null); + private final Object downloadAdmissionMonitor = new Object(); private volatile IrisProject activeProject; private volatile CompletableFuture activeOpen; private PackDownloadExecution activeDownload; private boolean downloadAdmissionOpen; + /** + * Binds the stale cache/temp sweep a boot starts in the background. Pack imports stage through that + * folder, so a delete running underneath one truncates it; the import waits the sweep out instead of + * the boot waiting for the sweep. + */ + public static void gateDownloadsOnStaleTempCleanup(CompletableFuture cleanup) { + staleTempCleanup = cleanup == null ? CompletableFuture.completedFuture(null) : cleanup; + } + + private static void awaitStaleTempCleanup() { + CompletableFuture cleanup = staleTempCleanup; + if (cleanup.isDone()) { + return; + } + + try { + cleanup.get(STALE_TEMP_CLEANUP_TIMEOUT_SECONDS, TimeUnit.SECONDS); + } catch (InterruptedException interrupted) { + Thread.currentThread().interrupt(); + IrisLogging.reportError("Interrupted while waiting for the stale Iris temp sweep to finish.", interrupted); + } catch (ExecutionException | TimeoutException failure) { + IrisLogging.reportError("The stale Iris temp sweep did not finish; this pack import may race it.", failure); + } + } + @Override public void onEnable() { synchronized (downloadAdmissionMonitor) { activeDownload = null; downloadAdmissionOpen = true; } - String configuredPack = IrisSettings.get().getGenerator().getDefaultWorldType(); - if (!PackDownloader.isPackPresent(getWorkspaceFolder(), configuredPack)) { - IrisLogging.warn("Default pack '" + configuredPack - + "' is not installed. Install a built-in pack with /iris download pack=overworld or provide /iris download link=."); - } + MultiBurst.ioBurst.completeValueAsync(() -> { + String configuredPack = IrisSettings.get().getGenerator().getDefaultWorldType(); + if (!PackDownloader.isPackPresent(getWorkspaceFolder(), configuredPack)) { + IrisLogging.warn("Default pack '" + configuredPack + + "' is not installed. Install a built-in pack with /iris download pack=overworld or provide /iris download link=."); + } + return null; + }); } @Override @@ -1274,7 +1307,10 @@ public class StudioSVC implements IrisService { execution = new PackDownloadExecution( lease, - cancellation -> executePackMutation(mutation, reporter, failureMessage, cancellation) + cancellation -> { + awaitStaleTempCleanup(); + executePackMutation(mutation, reporter, failureMessage, cancellation); + } ); PackDownloadExecution trackedExecution = execution; execution.onCompletion(() -> { diff --git a/core/src/test/java/art/arcane/iris/core/runtime/RuntimeInjectionTest.java b/core/src/test/java/art/arcane/iris/core/runtime/RuntimeInjectionTest.java new file mode 100644 index 000000000..be058c945 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/runtime/RuntimeInjectionTest.java @@ -0,0 +1,73 @@ +package art.arcane.iris.core.runtime; + +import art.arcane.iris.core.IrisStartupValidation; +import art.arcane.iris.testsupport.BukkitTestServer; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; + +/** + * Attaching the agent and retransforming server classes costs about a second of every boot, and a server + * that never loads an Iris world never needs either. Deferring it only stays safe while a deferred failure + * locks the runtime exactly like a boot-time one did, so the world it was about to generate is refused + * rather than handed to uninstrumented server code. + */ +public class RuntimeInjectionTest { + @Before + public void resetInjection() { + BukkitTestServer.install(); + RuntimeInjection.reset(); + } + + @After + public void clearValidation() { + RuntimeInjection.reset(); + IrisStartupValidation.disable(); + } + + @Test + public void anInstallWithoutAUsableNmsBindingIsRefusedAndNamesTheReason() { + RuntimeInjection.Outcome outcome = RuntimeInjection.install(); + + assertFalse(outcome.installed()); + assertEquals(RuntimeInjection.Failure.NO_BINDING, outcome.failure()); + assertTrue(outcome.lockReason(), outcome.lockReason().contains("NMS runtime")); + } + + @Test + public void theOutcomeIsResolvedOnceUntilReset() { + RuntimeInjection.Outcome first = RuntimeInjection.install(); + + assertSame(first, RuntimeInjection.install()); + + RuntimeInjection.reset(); + assertFalse(RuntimeInjection.install() == first); + } + + @Test + public void aDeferredInstallFailureLocksTheRuntimeWithItsReason() { + IrisStartupValidation.begin(); + IrisStartupValidation.markDatapacksReady(); + IrisStartupValidation.markPacksReady(); + IrisStartupValidation.markRuntimeReady(); + assertTrue(IrisStartupValidation.isReady()); + + RuntimeInjection.installIfDeferred(); + + assertFalse(IrisStartupValidation.isReady()); + assertEquals(RuntimeInjection.install().lockReason(), + IrisStartupValidation.denialReason().orElseThrow()); + } + + @Test + public void anUninstalledRuntimeReportsItself() { + RuntimeInjection.install(); + + assertFalse(RuntimeInjection.isInstalled()); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/safeguard/TasksInjectionDeferralTest.java b/core/src/test/java/art/arcane/iris/core/safeguard/TasksInjectionDeferralTest.java new file mode 100644 index 000000000..264876eaf --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/safeguard/TasksInjectionDeferralTest.java @@ -0,0 +1,79 @@ +package art.arcane.iris.core.safeguard; + +import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.core.safeguard.task.CheckResult; +import art.arcane.iris.core.safeguard.task.Diagnostic; +import art.arcane.iris.core.safeguard.task.Task; +import art.arcane.iris.core.safeguard.task.Tasks; +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.testsupport.BukkitTestServer; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; + +/** + * With injection deferred the injection check has nothing to verify yet, so it must say so and stay Stable + * rather than reporting a Danger the server has not actually hit. Turning the setting on brings the boot + * verification back. + */ +public class TasksInjectionDeferralTest { + private IrisPlatform previousPlatform; + private IrisSettings previousSettings; + + @Before + public void installServerAndSettings() { + BukkitTestServer.install(); + previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + IrisPlatforms.unbind(); + IrisPlatforms.bind(mock(IrisPlatform.class)); + previousSettings = IrisSettings.settings; + IrisSettings.settings = new IrisSettings(); + } + + @After + public void restore() { + IrisSettings.settings = previousSettings; + IrisPlatforms.unbind(); + if (previousPlatform != null) { + IrisPlatforms.bind(previousPlatform); + } + } + + @Test + public void injectionIsDeferredByDefaultAndSaysSo() { + assertTrue("deferred injection is the default", !IrisSettings.settings.getGeneral().isEagerRuntimeInjection()); + + CheckResult result = injection().run(); + + assertEquals(Mode.STABLE, result.mode()); + List lines = result.diagnostics().stream().map(Diagnostic::getMessage).toList(); + assertTrue(lines.toString(), lines.contains("Runtime Injection")); + assertTrue(lines.toString(), lines.stream().anyMatch(line -> line.contains("general.eagerRuntimeInjection"))); + } + + @Test + public void theEagerSettingBringsBackBootTimeVerification() { + IrisSettings.settings.getGeneral().setEagerRuntimeInjection(true); + + CheckResult result = injection().run(); + + assertEquals(Mode.UNSTABLE, result.mode()); + assertTrue(result.lockReason(), result.lockReason().contains("NMS runtime")); + } + + private static Task injection() { + for (Task task : Tasks.getTasks()) { + if ("injection".equals(task.getId())) { + return task; + } + } + throw new IllegalStateException("The injection check is missing from the safeguard task list"); + } +} From fd146de1adc42e53adc64e7202b95c9d07a6996d Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:48:43 -0400 Subject: [PATCH 16/35] Drop added code comments - Remove the Javadoc and inline comment blocks the three runtime-safety commits added under src/main - Keep the GPL file header on the new spi type, matching every other file in that module - Leave the superseded stale-temp ordering comment deleted rather than restoring text the new boot path contradicts --- .../src/main/java/art/arcane/iris/Iris.java | 18 --------------- .../iris/core/IrisWorldGeneratorResolver.java | 3 --- .../art/arcane/iris/core/service/WandSVC.java | 2 -- .../art/arcane/iris/core/IrisSettings.java | 6 ----- .../arcane/iris/core/ServerConfigurator.java | 4 ---- .../core/lifecycle/IrisRuntimeStatics.java | 9 -------- .../core/lifecycle/WorldLifecycleService.java | 3 --- .../iris/core/runtime/RuntimeInjection.java | 19 --------------- .../runtime/WorldRuntimeControlService.java | 3 --- .../iris/core/safeguard/IrisSafeguard.java | 6 ----- .../core/safeguard/RuntimeLockNotice.java | 7 ------ .../iris/core/safeguard/task/CheckResult.java | 8 ------- .../arcane/iris/core/safeguard/task/Task.java | 15 ------------ .../iris/core/safeguard/task/Tasks.java | 4 ---- .../arcane/iris/core/service/StudioSVC.java | 5 ---- .../iris/platform/bukkit/BukkitPlatform.java | 5 ---- .../art/arcane/iris/spi/CapabilityProbe.java | 23 ------------------- 17 files changed, 140 deletions(-) diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java index 569d0d0a2..2165b997d 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/Iris.java @@ -717,9 +717,6 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { IrisServices.register(ManagedWorldLoader.class, (ManagedWorldLoader) this::loadManagedWorld); SettingsHotloadWatch watch = new SettingsHotloadWatch(getDataFile("iris.json")); settingsHotloadWatch = watch; - // Off the boot thread, because a stale cache/temp can hold a whole abandoned pack import and - // deleting it recursively is unbounded. Every pack import waits this sweep out instead, which is - // the invariant that mattered: a delete running underneath an import truncated it mid-copy. StudioSVC.gateDownloadsOnStaleTempCleanup(MultiBurst.ioBurst.completeValueAsync(() -> { IO.delete(getTemp()); return null; @@ -793,11 +790,6 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { return true; } - /** - * Where the enable thread went, so a boot that got slower can be attributed to a phase rather than to - * Iris in general. The total is a lifecycle milestone and lands in logs/latest.log; the breakdown is - * for whoever is looking. - */ private static final class EnableTimings { private static final int REPORTED_SERVICES = 3; @@ -946,11 +938,6 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { reportLockedRuntime(); } - /** - * refuseVanillaFallback only ever runs when enable itself failed. A boot that enabled into Danger Mode - * keeps every configured Iris world bound to a generator that throws, and until now said so nowhere - * after the banner. - */ private static void reportLockedRuntime() { String denial = IrisStartupValidation.denialReason().orElse(null); if (denial == null) { @@ -1131,11 +1118,6 @@ public class Iris extends VolmitPlugin implements Listener, ReloadAware { } } - /** - * A disabled plugin must not stay reachable through a static. Everything that reads these either runs - * while Iris is enabled or already handles their absence; the platform binding outlives them because - * core still logs through it until finishTerminalCleanup unbinds it. - */ private static void releaseStatics() { linkMultiverseCore = null; compat = null; diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java index 09ee5a08e..205dfb725 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/IrisWorldGeneratorResolver.java @@ -496,9 +496,6 @@ public final class IrisWorldGeneratorResolver { Iris.debug("Using staged runtime generator for " + worldName); return stagedGenerator; } - // A world Iris created staged its generator above and installed the injection on the way in. This - // is a world configured outside Iris, and Bukkit asks for its generator before it builds the level, - // so this is the last point at which the injection it needs can still be installed in time. RuntimeInjection.installIfDeferred(); startupLock = startupLockedGenerator(worldName); if (startupLock != null) { diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java index af0d02536..676e1bce8 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/service/WandSVC.java @@ -378,8 +378,6 @@ public class WandSVC implements IrisService { activePlayers.clear(); ticksUntilPlayerRescan = 0; taskId = J.ar(this::tickAll, 1); - // Building the templates reaches the item and enchantment registries, which costs more than the - // rest of this service's startup put together and is only needed to recognise a pre-marker wand. J.s(() -> { wand = createWand(); dust = createDust(); diff --git a/core/src/main/java/art/arcane/iris/core/IrisSettings.java b/core/src/main/java/art/arcane/iris/core/IrisSettings.java index 85f428455..f4f29db1c 100644 --- a/core/src/main/java/art/arcane/iris/core/IrisSettings.java +++ b/core/src/main/java/art/arcane/iris/core/IrisSettings.java @@ -308,12 +308,6 @@ public class IrisSettings { public boolean debug = false; public boolean dumpMantleOnError = false; public boolean disableNMS = false; - /** - * Attach the Java agent and install the server-code injection while Iris enables, instead of the - * first time a world Iris generates is about to load. Boot-time injection costs roughly a second - * on a server that may never load an Iris world; turn this on to pay it up front and have the - * startup safeguard verify it. - */ public boolean eagerRuntimeInjection = false; public boolean splashLogoStartup = true; public boolean useConsoleCustomColors = true; diff --git a/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java b/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java index d9edd7444..be8c06d86 100644 --- a/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java +++ b/core/src/main/java/art/arcane/iris/core/ServerConfigurator.java @@ -158,10 +158,6 @@ public class ServerConfigurator { } } - /** - * Forgets what the previous boot loaded, so an enable in the same JVM recompiles and revalidates rather - * than trusting a fingerprint taken against a server that is gone. - */ public static void resetLoadedDatapackRuntime() { synchronized (DATAPACK_INSTALL_LOCK) { loadedDatapackRuntimeReady = false; diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java index 9381a3433..802650dd5 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/IrisRuntimeStatics.java @@ -6,15 +6,6 @@ import art.arcane.iris.core.runtime.RuntimeInjection; import art.arcane.iris.core.runtime.WorldRuntimeControlService; import art.arcane.iris.spi.IrisServices; -/** - * Drops every process-wide cache core keeps about the running server, so a disable leaves nothing an - * enable in the same JVM could answer from. - *

- * The capability singletons are the reason this exists: each holds reflective handles onto the live - * CraftServer and MinecraftServer, and a boot that reused them would be talking to the previous server's - * objects. The platform binding itself is not cleared here - core still logs through it while the adapter - * finishes its own teardown - and is unbound last by the adapter. - */ public final class IrisRuntimeStatics { private IrisRuntimeStatics() { } diff --git a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java index bc04a5120..8b9d6182b 100644 --- a/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java +++ b/core/src/main/java/art/arcane/iris/core/lifecycle/WorldLifecycleService.java @@ -52,9 +52,6 @@ public final class WorldLifecycleService { this.worldBackendByKey = new ConcurrentHashMap<>(); } - /** - * Drops the cached snapshot so the next boot in this JVM builds one against the server it is running on. - */ public static void reset() { synchronized (WorldLifecycleService.class) { instance = null; diff --git a/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java b/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java index 6b65a9270..1cdf7985f 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/RuntimeInjection.java @@ -6,15 +6,6 @@ import art.arcane.iris.core.nms.v1X.NMSBinding1X; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.util.project.agent.Agent; -/** - * Attaches the Java agent and installs the server-code injection Iris generation needs, once per boot. - *

- * Both steps are expensive - a self-attach to the running JVM, then three class retransformations - and - * neither is needed until a world that Iris generates is about to exist. A server that never loads an Iris - * world never pays for them. Whoever is about to produce such a world calls {@link #installIfDeferred()} - * first; it is idempotent, and a failure marks the runtime invalid so the same lock that guards a failed - * boot-time injection guards a failed deferred one. - */ public final class RuntimeInjection { private static final Object LOCK = new Object(); @@ -33,9 +24,6 @@ public final class RuntimeInjection { public record Outcome(boolean installed, Failure failure, String lockReason) { } - /** - * Runs the install if it has not run yet and reports what happened. Never throws. - */ public static Outcome install() { Outcome current = outcome; if (current != null) { @@ -52,10 +40,6 @@ public final class RuntimeInjection { } } - /** - * Installs on the deferred path and locks the runtime when that fails, so the caller's own readiness - * check refuses the world instead of loading it onto uninstrumented server code. - */ public static void installIfDeferred() { Outcome resolved = install(); if (resolved.installed()) { @@ -71,9 +55,6 @@ public final class RuntimeInjection { return current != null && current.installed(); } - /** - * Forgets the result so the next boot in this JVM installs against the binding it is running with. - */ public static void reset() { synchronized (LOCK) { outcome = null; diff --git a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java index fc3e3470a..548358613 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/WorldRuntimeControlService.java @@ -76,9 +76,6 @@ public final class WorldRuntimeControlService { + ", " + backend.describeCapabilities(); } - /** - * Drops the cached snapshot so the next boot in this JVM builds one against the server it is running on. - */ public static void reset() { synchronized (WorldRuntimeControlService.class) { instance = null; diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java b/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java index 13d96105e..0e785025c 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/IrisSafeguard.java @@ -74,8 +74,6 @@ public final class IrisSafeguard { mode = currentMode; count = issueCount; - // Danger is the lock. Recognising one check by its id and letting every other critical failure - // through was how a no-op NMS binding or a missing dimension type reached an open login queue. if (currentMode == Mode.UNSTABLE) { IrisStartupValidation.markRuntimeInvalid(lockReason == null ? GENERIC_LOCK_REASON : lockReason); return; @@ -96,10 +94,6 @@ public final class IrisSafeguard { return attachment; } - /** - * The per-check record for {@code /iris debugdump}. Without it a support report carried the server and - * plugin state but not one word about which startup check put the server in the mode it is in. - */ public static String debugReport() { StringBuilder builder = new StringBuilder(); builder.append("Startup safeguard: ").append(mode.getId()) diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java b/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java index 26a1ab56e..de78114ab 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/RuntimeLockNotice.java @@ -2,13 +2,6 @@ package art.arcane.iris.core.safeguard; import java.util.List; -/** - * The operator lines a boot prints when Iris enabled but its runtime is locked. - *

- * The Danger banner states the mode; this states the consequence. A locked runtime that still enabled is not - * covered by the vanilla-fallback refusal - that only runs when enable itself fails - so without this the - * only evidence is the first chunk request throwing hours later. - */ public final class RuntimeLockNotice { private RuntimeLockNotice() { } diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java index 28f8bd85b..81fcf8fb6 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/CheckResult.java @@ -4,14 +4,6 @@ import art.arcane.iris.core.safeguard.Mode; import java.util.List; -/** - * What one startup check found: the severity it reached, the console lines it wants printed, and - for a - * Danger result only - the reason the runtime is locked. - *

- * The lock reason is mandatory on {@link #danger(String, Diagnostic...)} because Danger is what stops player - * login, world creation and generation, and an operator has to be told which check did that and what fixes - * it. A check cannot reach Danger without answering that. - */ public record CheckResult(Mode mode, String lockReason, List diagnostics) { public CheckResult { if (mode == null) { diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java index a181bc863..9da4b7543 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/Task.java @@ -4,14 +4,6 @@ import art.arcane.iris.core.safeguard.Mode; import java.util.function.Supplier; -/** - * One startup check, plus the severity its own failure carries. - *

- * A check declares whether it is advisory or critical at the point it is written, so nothing downstream has - * to recognise a check by its id to decide what a failure means. An advisory check that throws is a Warning - * and leaves the runtime open; a critical one that throws is Danger and locks the runtime with the reason it - * carries here. - */ public abstract class Task { private final String id; private final Mode failureMode; @@ -37,9 +29,6 @@ public abstract class Task { public abstract CheckResult run(); - /** - * A check whose failure degrades Iris but leaves it usable. - */ public static Task advisory(String id, Supplier action) { return new Task(id, Mode.WARNING, null) { @Override @@ -49,10 +38,6 @@ public abstract class Task { }; } - /** - * A check whose failure means Iris cannot safely run. {@code throwLockReason} is what an operator is told - * when the check itself throws rather than returning a result. - */ public static Task critical(String id, String throwLockReason, Supplier action) { return new Task(id, Mode.UNSTABLE, throwLockReason) { @Override diff --git a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java index 46dad3f52..456ae6bf4 100644 --- a/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java +++ b/core/src/main/java/art/arcane/iris/core/safeguard/task/Tasks.java @@ -229,10 +229,6 @@ public final class Tasks { return Bukkit.getServer(); } - /** - * Matched against every registered plugin rather than asked for by exact name: a plugin.yml decides its - * own capitalization, and asking the plugin manager for "dynmap" misses a build that registers "Dynmap". - */ private static Set installedIncompatiblePlugins() { Set found = new LinkedHashSet<>(); Plugin[] plugins = server().getPluginManager().getPlugins(); diff --git a/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java b/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java index d11262a7b..03821df86 100644 --- a/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java +++ b/core/src/main/java/art/arcane/iris/core/service/StudioSVC.java @@ -117,11 +117,6 @@ public class StudioSVC implements IrisService { private PackDownloadExecution activeDownload; private boolean downloadAdmissionOpen; - /** - * Binds the stale cache/temp sweep a boot starts in the background. Pack imports stage through that - * folder, so a delete running underneath one truncates it; the import waits the sweep out instead of - * the boot waiting for the sweep. - */ public static void gateDownloadsOnStaleTempCleanup(CompletableFuture cleanup) { staleTempCleanup = cleanup == null ? CompletableFuture.completedFuture(null) : cleanup; } diff --git a/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java b/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java index e52f400ef..cc330514f 100644 --- a/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java +++ b/core/src/main/java/art/arcane/iris/platform/bukkit/BukkitPlatform.java @@ -103,11 +103,6 @@ public final class BukkitPlatform implements IrisPlatform { PLUGIN = plugin; } - /** - * Drops every reference this class holds to the disabled plugin. Called last in the adapter's teardown, - * after core has stopped logging through the host bridge, so a disabled plugin instance is not reachable - * from a static for the life of the JVM. - */ public static void releaseHost() { PLUGIN = null; HUD_BAR = null; diff --git a/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java b/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java index 6020ab8c8..4c32b64ab 100644 --- a/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java +++ b/spi/src/main/java/art/arcane/iris/spi/CapabilityProbe.java @@ -18,30 +18,10 @@ package art.arcane.iris.spi; -/** - * Runs a lookup whose failure means "this optional API, plugin or server capability is not here" and answers - * with a fallback instead of throwing. - *

- * This is the only sanctioned form of a quiet catch in Iris. A probe states the capability it was looking - * for, and a miss is recorded at {@link LogLevel#DEBUG} with the failure's class and message, so an operator - * running with debug on can tell a genuinely absent API apart from one that broke while being reached. Every - * other catch - world lifecycle, world replacement, runtime control, safeguard, service enable and disable, - * generation - reports through {@link IrisLogging#reportError(String, Throwable)} with the full trace. - *

- * Internal to Iris; not a published integration surface. - */ public final class CapabilityProbe { private CapabilityProbe() { } - /** - * Resolves {@code probe}, or returns {@code unavailable} when it throws. - * - * @param capability what was being looked for, for the debug record - for example - * {@code "world#getChunkAtAsync"} - * @param probe the lookup; any {@link Throwable} it raises means the capability is absent - * @param unavailable the value that stands for an absent capability - */ public static T attempt(String capability, Probe probe, T unavailable) { try { return probe.resolve(); @@ -51,9 +31,6 @@ public final class CapabilityProbe { } } - /** - * Runs {@code attempt} and reports whether it completed, for a probe whose only result is that it worked. - */ public static boolean succeeds(String capability, Attempt attempt) { try { attempt.run(); From 9dcaed531552874d58259492778cb634b1d5ac58 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:55:29 -0400 Subject: [PATCH 17/35] Share test fixtures across modules - Move art.arcane.iris.testsupport into core/src/testFixtures and apply java-test-fixtures to core - Consume core test fixtures from the bukkit plugin, nms, probe and the three loader adapters - Delete the duplicate ProjectPaths copies in the bukkit-plugin and modded-common test trees - Point ModdedMessageContributorTest at the shared ProjectPaths - Guard CommandPackCompatTest, NativeTransitionColumnTest and StubPlatformStateTest with PlatformLeakGuard - Release the probe runtime state after DimensionStackSuperflatProbeTest opens a workspace - Keep core main classes ahead of the core jar on the test classpath so the bytecode gates still scan a directory --- .../nativegen/NativeTransitionColumnTest.java | 5 ++ adapters/bukkit/plugin/build.gradle | 1 + .../core/commands/CommandPackCompatTest.java | 24 +----- adapters/fabric/build.gradle | 1 + adapters/forge/build.gradle | 1 + .../ModdedMessageContributorTest.java | 2 +- .../iris/modded/testsupport/ProjectPaths.java | 82 ------------------- adapters/neoforge/build.gradle | 1 + build.gradle | 1 + core/build.gradle | 7 +- .../arcane/iris/testsupport/ProjectPaths.java | 82 ------------------- .../art/arcane/iris/testsupport/Await.java | 0 .../iris/testsupport/BukkitTestServer.java | 0 .../iris/testsupport/DurabilityMode.java | 0 .../iris/testsupport/IrisRuntimeState.java | 0 .../iris/testsupport/PlatformBinding.java | 0 .../iris/testsupport/PlatformLeakGuard.java | 0 .../arcane/iris/testsupport/ProjectPaths.java | 0 probe/build.gradle | 1 + .../DimensionStackSuperflatProbeTest.java | 7 ++ .../iris/probe/StubPlatformStateTest.java | 6 +- 21 files changed, 34 insertions(+), 187 deletions(-) delete mode 100644 adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java delete mode 100644 core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/Await.java (100%) rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/BukkitTestServer.java (100%) rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/DurabilityMode.java (100%) rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/IrisRuntimeState.java (100%) rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/PlatformBinding.java (100%) rename core/src/{test => testFixtures}/java/art/arcane/iris/testsupport/PlatformLeakGuard.java (100%) rename {adapters/bukkit/plugin/src/test => core/src/testFixtures}/java/art/arcane/iris/testsupport/ProjectPaths.java (100%) diff --git a/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeTransitionColumnTest.java b/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeTransitionColumnTest.java index 23b0e5fa8..82b350995 100644 --- a/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeTransitionColumnTest.java +++ b/adapters/bukkit/nms/v26_2_R1/src/test/java/art/arcane/iris/nativegen/NativeTransitionColumnTest.java @@ -6,6 +6,7 @@ import art.arcane.iris.spi.IrisPlatform; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.testsupport.PlatformLeakGuard; import net.minecraft.SharedConstants; import net.minecraft.core.Direction; import net.minecraft.server.Bootstrap; @@ -16,6 +17,7 @@ import net.minecraft.world.level.block.RotatedPillarBlock; import net.minecraft.world.level.block.LiquidBlock; import net.minecraft.world.level.levelgen.Heightmap; import org.junit.BeforeClass; +import org.junit.Rule; import org.junit.Test; import org.mockito.MockedStatic; @@ -30,6 +32,9 @@ import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.when; public final class NativeTransitionColumnTest { + @Rule + public final PlatformLeakGuard leakGuard = PlatformLeakGuard.clean(); + @BeforeClass public static void bootstrap() { SharedConstants.tryDetectVersion(); diff --git a/adapters/bukkit/plugin/build.gradle b/adapters/bukkit/plugin/build.gradle index f0a3df139..38793cded 100644 --- a/adapters/bukkit/plugin/build.gradle +++ b/adapters/bukkit/plugin/build.gradle @@ -22,6 +22,7 @@ dependencies { testImplementation(libs.paper.api) testImplementation(libs.bstats) testImplementation(project(':core')) + testImplementation(testFixtures(project(':core'))) testImplementation(volmLibCoordinate) { transitive = false } diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandPackCompatTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandPackCompatTest.java index c85d1ed66..5853c4966 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandPackCompatTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandPackCompatTest.java @@ -7,10 +7,8 @@ import art.arcane.iris.core.pack.PackValidationResult; import art.arcane.volmlib.util.director.compat.DirectorAnnotationCompatibility; import art.arcane.volmlib.util.director.runtime.DirectorNodeDescriptor; import art.arcane.volmlib.util.director.runtime.DirectorParameterDescriptor; -import art.arcane.iris.spi.IrisPlatform; -import art.arcane.iris.spi.IrisPlatforms; -import org.junit.After; -import org.junit.Before; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import org.junit.Rule; import org.junit.Test; import java.util.List; @@ -20,22 +18,8 @@ import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertTrue; public class CommandPackCompatTest { - private IrisPlatform previousPlatform; - - /** The persisted Minecraft version is only used when no platform is bound, so pin that here. */ - @Before - public void unbindPlatform() { - previousPlatform = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; - IrisPlatforms.unbind(); - } - - @After - public void rebindPlatform() { - IrisPlatforms.unbind(); - if (previousPlatform != null) { - IrisPlatforms.bind(previousPlatform); - } - } + @Rule + public final PlatformLeakGuard leakGuard = PlatformLeakGuard.clean(); private static CompatFinding block(CompatAction action, String subjectKey) { return new CompatFinding( diff --git a/adapters/fabric/build.gradle b/adapters/fabric/build.gradle index 8725b0e34..db9b4e52b 100644 --- a/adapters/fabric/build.gradle +++ b/adapters/fabric/build.gradle @@ -141,6 +141,7 @@ dependencies { implementation("net.fabricmc:fabric-loader:${fabricLoaderVersion}") testImplementation('junit:junit:4.13.2') testImplementation('org.mockito:mockito-core:5.23.0') + testImplementation(testFixtures('art.arcane:core')) testImplementation(libs.spigot) { transitive = false } diff --git a/adapters/forge/build.gradle b/adapters/forge/build.gradle index 68d7280ae..2e509514e 100644 --- a/adapters/forge/build.gradle +++ b/adapters/forge/build.gradle @@ -158,6 +158,7 @@ dependencies { implementation minecraft.dependency("net.minecraftforge:forge:${forgeVersion}") testImplementation('junit:junit:4.13.2') testImplementation('org.mockito:mockito-core:5.23.0') + testImplementation(testFixtures('art.arcane:core')) testImplementation(libs.spigot) { transitive = false } diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java index 55a0038a5..97873c1cb 100644 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java +++ b/adapters/modded-common/src/test/java/art/arcane/iris/modded/localization/ModdedMessageContributorTest.java @@ -2,7 +2,7 @@ package art.arcane.iris.modded.localization; import art.arcane.iris.core.localization.IrisLanguage; import art.arcane.iris.core.localization.IrisMessages; -import art.arcane.iris.modded.testsupport.ProjectPaths; +import art.arcane.iris.testsupport.ProjectPaths; import art.arcane.volmlib.util.localization.MessageKey; import art.arcane.volmlib.util.localization.VolmitLocales; import com.google.gson.JsonObject; diff --git a/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java b/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java deleted file mode 100644 index feab80d42..000000000 --- a/adapters/modded-common/src/test/java/art/arcane/iris/modded/testsupport/ProjectPaths.java +++ /dev/null @@ -1,82 +0,0 @@ -package art.arcane.iris.modded.testsupport; - -import java.io.File; -import java.net.URISyntaxException; -import java.net.URL; -import java.nio.file.Files; -import java.nio.file.Path; -import java.security.CodeSource; -import java.security.ProtectionDomain; - -public final class ProjectPaths { - private static final Path MODULE_ROOT = resolveModuleRoot(); - private static final Path REPOSITORY_ROOT = resolveRepositoryRoot(MODULE_ROOT); - - private ProjectPaths() { - } - - public static Path moduleRoot() { - return MODULE_ROOT; - } - - public static Path repositoryRoot() { - return REPOSITORY_ROOT; - } - - public static Path moduleFile(String relative) { - return MODULE_ROOT.resolve(relative).normalize(); - } - - public static Path repositoryFile(String relative) { - return REPOSITORY_ROOT.resolve(relative).normalize(); - } - - public static File moduleFileAt(String relative) { - return moduleFile(relative).toFile(); - } - - public static File repositoryFileAt(String relative) { - return repositoryFile(relative).toFile(); - } - - private static Path resolveModuleRoot() { - ProtectionDomain domain = ProjectPaths.class.getProtectionDomain(); - CodeSource source = domain == null ? null : domain.getCodeSource(); - URL location = source == null ? null : source.getLocation(); - - if (location != null) { - try { - Path current = Path.of(location.toURI()).toAbsolutePath().normalize(); - - while (current != null) { - Path name = current.getFileName(); - - if (name != null && "build".equals(name.toString()) && current.getParent() != null) { - return current.getParent(); - } - - current = current.getParent(); - } - } catch (URISyntaxException | IllegalArgumentException ignored) { - return Path.of("").toAbsolutePath().normalize(); - } - } - - return Path.of("").toAbsolutePath().normalize(); - } - - private static Path resolveRepositoryRoot(Path moduleRoot) { - Path current = moduleRoot; - - while (current != null) { - if (Files.isRegularFile(current.resolve("settings.gradle")) - && Files.isDirectory(current.resolve("core/src/main/java"))) { - return current; - } - - current = current.getParent(); - } - - return moduleRoot; - } -} diff --git a/adapters/neoforge/build.gradle b/adapters/neoforge/build.gradle index ca7ea081c..90cb64c20 100644 --- a/adapters/neoforge/build.gradle +++ b/adapters/neoforge/build.gradle @@ -132,6 +132,7 @@ configurations.testRuntimeClasspath.extendsFrom(configurations.runtimeClasspath, dependencies { testImplementation('junit:junit:4.13.2') testImplementation('org.mockito:mockito-core:5.23.0') + testImplementation(testFixtures('art.arcane:core')) testImplementation(libs.spigot) { transitive = false } diff --git a/build.gradle b/build.gradle index cac409c7f..c5a95e685 100644 --- a/build.gradle +++ b/build.gradle @@ -164,6 +164,7 @@ nmsBindings.each { key, value -> testImplementation('junit:junit:4.13.2') testImplementation('org.mockito:mockito-core:5.23.0') testImplementation(project(':core')) + testImplementation(testFixtures(project(':core'))) testCompileOnly(volmLibCoordinate) { transitive = false } diff --git a/core/build.gradle b/core/build.gradle index 2ba42ad7b..326c988fc 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -29,6 +29,7 @@ import java.nio.charset.StandardCharsets plugins { id 'java' id 'java-library' + id 'java-test-fixtures' alias(libs.plugins.shadow) alias(libs.plugins.slimjar) } @@ -130,6 +131,10 @@ dependencies { slim(libs.dom4j) slim(libs.jaxen) + testFixturesImplementation('junit:junit:4.13.2') + testFixturesImplementation('org.mockito:mockito-core:5.23.0') + testFixturesCompileOnly(libs.paper.api) + testImplementation('junit:junit:4.13.2') testImplementation('org.mockito:mockito-core:5.23.0') testImplementation(libs.paper.api) @@ -232,7 +237,7 @@ tasks.named('compileJava', JavaCompile).configure { tasks.named('test', Test).configure { jvmArgs('--add-modules', 'jdk.incubator.vector') dependsOn(languageSourceManifestTask) - classpath = files(layout.buildDirectory.dir('generated/language-source')) + files('src/main/resources') + classpath + classpath = files(layout.buildDirectory.dir('generated/language-source')) + files('src/main/resources') + sourceSets.main.output + classpath } configurations.matching { it.name.startsWith('slim') }.all { } diff --git a/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java deleted file mode 100644 index 3617450f5..000000000 --- a/core/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java +++ /dev/null @@ -1,82 +0,0 @@ -package art.arcane.iris.testsupport; - -import java.io.File; -import java.net.URISyntaxException; -import java.net.URL; -import java.nio.file.Files; -import java.nio.file.Path; -import java.security.CodeSource; -import java.security.ProtectionDomain; - -public final class ProjectPaths { - private static final Path MODULE_ROOT = resolveModuleRoot(); - private static final Path REPOSITORY_ROOT = resolveRepositoryRoot(MODULE_ROOT); - - private ProjectPaths() { - } - - public static Path moduleRoot() { - return MODULE_ROOT; - } - - public static Path repositoryRoot() { - return REPOSITORY_ROOT; - } - - public static Path moduleFile(String relative) { - return MODULE_ROOT.resolve(relative).normalize(); - } - - public static Path repositoryFile(String relative) { - return REPOSITORY_ROOT.resolve(relative).normalize(); - } - - public static File moduleFileAt(String relative) { - return moduleFile(relative).toFile(); - } - - public static File repositoryFileAt(String relative) { - return repositoryFile(relative).toFile(); - } - - private static Path resolveModuleRoot() { - ProtectionDomain domain = ProjectPaths.class.getProtectionDomain(); - CodeSource source = domain == null ? null : domain.getCodeSource(); - URL location = source == null ? null : source.getLocation(); - - if (location != null) { - try { - Path current = Path.of(location.toURI()).toAbsolutePath().normalize(); - - while (current != null) { - Path name = current.getFileName(); - - if (name != null && "build".equals(name.toString()) && current.getParent() != null) { - return current.getParent(); - } - - current = current.getParent(); - } - } catch (URISyntaxException | IllegalArgumentException ignored) { - return Path.of("").toAbsolutePath().normalize(); - } - } - - return Path.of("").toAbsolutePath().normalize(); - } - - private static Path resolveRepositoryRoot(Path moduleRoot) { - Path current = moduleRoot; - - while (current != null) { - if (Files.isRegularFile(current.resolve("settings.gradle")) - && Files.isDirectory(current.resolve("core/src/main/java"))) { - return current; - } - - current = current.getParent(); - } - - return moduleRoot; - } -} diff --git a/core/src/test/java/art/arcane/iris/testsupport/Await.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/Await.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/Await.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/Await.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/BukkitTestServer.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/BukkitTestServer.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/BukkitTestServer.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/DurabilityMode.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/DurabilityMode.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/DurabilityMode.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/IrisRuntimeState.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/IrisRuntimeState.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/IrisRuntimeState.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/PlatformBinding.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/PlatformBinding.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/PlatformBinding.java diff --git a/core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/PlatformLeakGuard.java similarity index 100% rename from core/src/test/java/art/arcane/iris/testsupport/PlatformLeakGuard.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/PlatformLeakGuard.java diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java b/core/src/testFixtures/java/art/arcane/iris/testsupport/ProjectPaths.java similarity index 100% rename from adapters/bukkit/plugin/src/test/java/art/arcane/iris/testsupport/ProjectPaths.java rename to core/src/testFixtures/java/art/arcane/iris/testsupport/ProjectPaths.java diff --git a/probe/build.gradle b/probe/build.gradle index 502539bc4..ac5eaf979 100644 --- a/probe/build.gradle +++ b/probe/build.gradle @@ -17,6 +17,7 @@ dependencies { implementation(project(':core')) compileOnly(libs.spigot) testImplementation('junit:junit:4.13.2') + testImplementation(testFixtures(project(':core'))) testImplementation(volmLibCoordinate) { transitive = false } diff --git a/probe/src/test/java/art/arcane/iris/probe/DimensionStackSuperflatProbeTest.java b/probe/src/test/java/art/arcane/iris/probe/DimensionStackSuperflatProbeTest.java index 7bcfd1a3c..36b8535ea 100644 --- a/probe/src/test/java/art/arcane/iris/probe/DimensionStackSuperflatProbeTest.java +++ b/probe/src/test/java/art/arcane/iris/probe/DimensionStackSuperflatProbeTest.java @@ -4,6 +4,8 @@ import art.arcane.iris.engine.DimensionStackContext; import art.arcane.iris.engine.DimensionStackLayout; import art.arcane.iris.engine.framework.Engine; import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.testsupport.IrisRuntimeState; +import org.junit.AfterClass; import org.junit.Test; import java.io.File; @@ -20,6 +22,11 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; public final class DimensionStackSuperflatProbeTest { + @AfterClass + public static void releaseProbeRuntime() { + IrisRuntimeState.reset(); + } + private static final long SEED = 1_337L; private static final long ALTERNATE_SEED = 8_675_309L; private static final int WORLD_HEIGHT = 128; diff --git a/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java b/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java index 41c4fa350..8c5ee1cfc 100644 --- a/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java +++ b/probe/src/test/java/art/arcane/iris/probe/StubPlatformStateTest.java @@ -4,9 +4,11 @@ import art.arcane.iris.engine.decorator.IrisSpeleothems; import art.arcane.iris.engine.object.IrisObjectRotation; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.testsupport.PlatformLeakGuard; import art.arcane.iris.util.project.hunk.Hunk; import org.junit.AfterClass; import org.junit.BeforeClass; +import org.junit.ClassRule; import org.junit.Test; import static org.junit.Assert.assertEquals; @@ -15,9 +17,11 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; public final class StubPlatformStateTest { + @ClassRule + public static final PlatformLeakGuard LEAK_GUARD = PlatformLeakGuard.clean(); + @BeforeClass public static void bindPlatform() { - IrisPlatforms.unbind(); IrisPlatforms.bind(new StubPlatform()); StubPlatform.bindGenerationStateHandlers(); } From c3bc0f5d1886227b7252b0138a97024142d92b1a Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:55:38 -0400 Subject: [PATCH 18/35] Split the router fork floor - Replace GenerationHistoryRuntimeRouterTest with promotion, routing and lifecycle classes - Add GenerationHistoryRuntimeRouterSupport on top of GenerationHistorySupport for the shared fakes and helpers - Drop the router-local copies of createPack, createHistory, stage, contract, signature and writeRegion --- ...tionHistoryRuntimeRouterLifecycleTest.java | 316 ++++ ...tionHistoryRuntimeRouterPromotionTest.java | 350 +++++ ...rationHistoryRuntimeRouterRoutingTest.java | 428 +++++ ...GenerationHistoryRuntimeRouterSupport.java | 290 ++++ .../GenerationHistoryRuntimeRouterTest.java | 1375 ----------------- 5 files changed, 1384 insertions(+), 1375 deletions(-) create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterLifecycleTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterPromotionTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterRoutingTest.java create mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterSupport.java delete mode 100644 core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterLifecycleTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterLifecycleTest.java new file mode 100644 index 000000000..b4431a952 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterLifecycleTest.java @@ -0,0 +1,316 @@ +package art.arcane.iris.engine.history; + +import art.arcane.iris.engine.IrisEngine; +import org.junit.Test; + +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicReference; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertArrayEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotSame; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +public final class GenerationHistoryRuntimeRouterLifecycleTest extends GenerationHistoryRuntimeRouterSupport { + @Test + public void concurrentHistoricalRoutesShareTheCurrentRuntimeWithoutLoadingOldFactories() throws Exception { + Path world = temporaryFolder.newFolder("router-deduplicated-load-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-deduplicated-load"); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + ExecutorService executor = Executors.newFixedThreadPool(2); + CountDownLatch ready = new CountDownLatch(2); + CountDownLatch start = new CountDownLatch(1); + try { + CompletableFuture first = openRouteAsync( + router, executor, ready, start, 0, 0); + CompletableFuture second = openRouteAsync( + router, executor, ready, start, 0, 0); + assertTrue(ready.await(5L, TimeUnit.SECONDS)); + start.countDown(); + GenerationHistoryRuntimeRouter.RuntimeRoute firstRoute = first.get(5L, TimeUnit.SECONDS); + GenerationHistoryRuntimeRouter.RuntimeRoute secondRoute = second.get(5L, TimeUnit.SECONDS); + + assertEquals(0, runtimes.loadCount(1L)); + assertEquals(3L, firstRoute.activation().activationId()); + assertEquals(3L, secondRoute.activation().activationId()); + firstRoute.close(); + secondRoute.close(); + } finally { + executor.shutdownNow(); + } + router.close(); + } + + @Test + public void closeRejectsNewRoutesAndAwaitsExistingLeases() throws Exception { + Path world = temporaryFolder.newFolder("router-close-await-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-close-await"); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes); + GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + CompletableFuture closing = CompletableFuture.runAsync(router::close, executor); + awaitClosed(router); + assertThrows(IllegalStateException.class, () -> router.openRoute(2, 0)); + assertThrows(TimeoutException.class, () -> closing.get(100L, TimeUnit.MILLISECONDS)); + route.close(); + closing.get(5L, TimeUnit.SECONDS); + } finally { + route.close(); + executor.shutdownNow(); + } + verify(engine).detachGenerationHistoryRuntimeRouter(router); + verify(engine, never()).closeDetachedGenerationRuntime(active); + } + + @Test + public void closeCompletesWhileWorkersContinuouslyAcquireReadyRoutes() throws Exception { + Path world = temporaryFolder.newFolder("router-contended-close-world").toPath(); + GenerationHistory history = createHistory(world, createPack("router-contended-close-pack", "alpha")); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + ExecutorService executor = Executors.newFixedThreadPool(9); + CountDownLatch routing = new CountDownLatch(8); + CompletableFuture[] workers = new CompletableFuture[8]; + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes); + try { + for (int i = 0; i < workers.length; i++) { + workers[i] = CompletableFuture.runAsync(() -> routeUntilClosed(router, routing), executor); + } + assertTrue(routing.await(5, TimeUnit.SECONDS)); + CompletableFuture.runAsync(router::close, executor).get(5, TimeUnit.SECONDS); + CompletableFuture.allOf(workers).get(5, TimeUnit.SECONDS); + verify(engine).detachGenerationHistoryRuntimeRouter(router); + verify(engine, never()).closeDetachedGenerationRuntime(active); + } finally { + executor.shutdownNow(); + assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS)); + router.close(); + } + } + + @Test + public void closeLeavesTheSingleDefaultRuntimeOwnedByTheEngine() throws Exception { + Path world = temporaryFolder.newFolder("router-close-current-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-close-current"); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); + installScopeTracking(engine); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { + } + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { + } + } + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + verify(engine, never()).closeDetachedGenerationRuntime(any()); + } + + @Test + public void runtimeRouteScopesWorkAndCloseAcrossAsyncThreads() throws Exception { + Path world = temporaryFolder.newFolder("router-async-world").toPath(); + Path pack = createPack("router-async-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + AtomicReference scoped = installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(-1, -2); + Thread caller = Thread.currentThread(); + AtomicReference completionThread = new AtomicReference<>(); + ExecutorService executor = Executors.newSingleThreadExecutor(); + try { + CompletableFuture work = CompletableFuture.runAsync(() -> { + try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { + assertSame(first, scoped.get()); + assertThrows(IllegalStateException.class, route::close); + } + }, executor); + CompletableFuture completion = work.whenCompleteAsync((ignored, failure) -> { + completionThread.set(Thread.currentThread()); + route.close(); + }, executor); + completion.get(5L, TimeUnit.SECONDS); + } finally { + executor.shutdownNow(); + } + + assertNotSame(caller, completionThread.get()); + assertEquals(-1, route.chunkX()); + assertEquals(-2, route.chunkZ()); + assertThrows(IllegalStateException.class, route::openRuntimeScope); + router.close(); + } + + @Test + public void liveStudioPromotionPreservesChunksAndRoutesExpansionAcrossRepeatedUpdates() throws Exception { + Path world = temporaryFolder.newFolder("live-studio-world").toPath(); + Path packA = createPack("live-studio-a", "flat-lowland"); + Path packB = createPack("live-studio-b", "massive-mountains"); + Path packC = createPack("live-studio-c", "deep-ocean"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{0, 0}}); + byte[] original = Files.readAllBytes(region); + IrisEngine engine = mock(IrisEngine.class); + when(engine.isStudio()).thenReturn(true); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + AtomicReference scoped = installScopeTracking(engine); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0)) { + assertEquals(1L, stage.activation().activationId()); + } + stage(history, packB); + try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { + assertEquals(2L, cutover.promotePending().activationId()); + } + assertArrayEquals(original, Files.readAllBytes(region)); + try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0)) { + assertSame(runtimes.bindings.get(2L), scoped.get()); + assertEquals(2L, stage.activation().activationId()); + } + try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(1, 0)) { + assertSame(runtimes.bindings.get(2L), scoped.get()); + assertEquals(2L, stage.activation().activationId()); + } + writeRegion(region, new int[][]{{0, 0}, {1, 0}}); + byte[] expanded = Files.readAllBytes(region); + stage(history, packC); + try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { + assertEquals(3L, cutover.promotePending().activationId()); + } + assertArrayEquals(expanded, Files.readAllBytes(region)); + assertEquals(1L, history.resolveActivation(0, 0).activationId()); + assertEquals(2L, history.resolveActivation(1, 0).activationId()); + assertEquals(3L, history.resolveActivation(2, 0).activationId()); + } + GenerationHistory reopened = GenerationHistory.open(world); + assertEquals(1L, reopened.resolveActivation(0, 0).activationId()); + assertEquals(2L, reopened.resolveActivation(1, 0).activationId()); + assertEquals(3L, reopened.resolveActivation(2, 0).activationId()); + } + + @Test + public void liveStudioCutoverDrainsExistingRoutesAndBlocksNewRoutesUntilPublicationCompletes() throws Exception { + Path world = temporaryFolder.newFolder("studio-drain-world").toPath(); + Path pack = createPack("studio-drain-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + when(engine.isStudio()).thenReturn(true); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initialBinding = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initialBinding); + ExecutorService executor = Executors.newFixedThreadPool(2); + CountDownLatch cutoverRequested = new CountDownLatch(1); + CountDownLatch cutoverAcquired = new CountDownLatch(1); + CountDownLatch releaseCutover = new CountDownLatch(1); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + GenerationHistoryRuntimeRouter.RuntimeRoute initial = router.openRoute(0, 0); + try { + CompletableFuture cutover = CompletableFuture.runAsync(() -> { + cutoverRequested.countDown(); + try (GenerationHistoryRuntimeRouter.StudioCutover ignored = router.beginStudioCutover(5_000L)) { + cutoverAcquired.countDown(); + if (!releaseCutover.await(5, TimeUnit.SECONDS)) { + throw new IllegalStateException("Timed out waiting to release the Studio cutover."); + } + } catch (InterruptedException interrupted) { + Thread.currentThread().interrupt(); + throw new IllegalStateException(interrupted); + } + }, executor); + assertTrue(cutoverRequested.await(5, TimeUnit.SECONDS)); + assertFalse(cutoverAcquired.await(100, TimeUnit.MILLISECONDS)); + initial.close(); + assertTrue(cutoverAcquired.await(5, TimeUnit.SECONDS)); + CompletableFuture waiting = + CompletableFuture.supplyAsync(() -> openRouteUnchecked(router, 1, 0), executor); + assertThrows(TimeoutException.class, () -> waiting.get(100, TimeUnit.MILLISECONDS)); + releaseCutover.countDown(); + cutover.get(5, TimeUnit.SECONDS); + try (GenerationHistoryRuntimeRouter.RuntimeRoute route = waiting.get(5, TimeUnit.SECONDS)) { + assertEquals(1L, route.activation().activationId()); + } + } finally { + initial.close(); + releaseCutover.countDown(); + } + } finally { + releaseCutover.countDown(); + executor.shutdownNow(); + assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS)); + } + } + + @Test + public void liveCutoverRejectsProductionWorldsAndNestedGenerationScopes() throws Exception { + Path world = temporaryFolder.newFolder("studio-guard-world").toPath(); + Path pack = createPack("studio-guard-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initialBinding = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initialBinding); + installScopeTracking(engine); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); + when(engine.isStudio()).thenReturn(true); + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { + assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); + } + try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { + assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); + assertEquals(1L, cutover.promotePending().activationId()); + } + } + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterPromotionTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterPromotionTest.java new file mode 100644 index 000000000..8d3625096 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterPromotionTest.java @@ -0,0 +1,350 @@ +package art.arcane.iris.engine.history; + +import art.arcane.iris.engine.IrisEngine; +import art.arcane.volmlib.util.mantle.runtime.Mantle; +import org.junit.Test; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicReference; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +public final class GenerationHistoryRuntimeRouterPromotionTest extends GenerationHistoryRuntimeRouterSupport { + @Test + public void promotionSamplesSavedBoundaryWithoutOpeningHistoricalRuntimeScopes() throws Exception { + Path world = temporaryFolder.newFolder("router-promotion-world").toPath(); + Path packA = createPack("router-promotion-a", "alpha"); + Path packB = createPack("router-promotion-b", "beta"); + GenerationHistory history = createHistory(world, packA); + writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), + new int[][]{{0, 0}}); + stage(history, packB); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + AtomicReference scoped = installScopeTracking(engine); + int[] samples = new int[1]; + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, + history, + (routedEngine, blockX, blockZ) -> { + assertSame(engine, routedEngine); + assertNull(scoped.get()); + samples[0]++; + return signature(blockX, blockZ); + }, + 256, + runtimes + ); + + GenerationActivation activated = history.activeActivation(); + IrisEngine.GenerationRuntimeBinding second = runtimes.bindings.get(2L); + + assertEquals(2L, activated.activationId()); + assertEquals(history.boundary(2L).exposedBlockColumns().size(), samples[0]); + verify(engine).setDefaultGenerationRuntime(second); + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { + assertSame(second, scoped.get()); + } + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { + assertSame(second, scoped.get()); + } + router.close(); + } + + @Test + public void repeatedPackActivationUsesOnlyItsCurrentMantleAndBinding() throws Exception { + Path world = temporaryFolder.newFolder("router-repeat-world").toPath(); + Path packA = createPack("router-repeat-a", "alpha"); + Path packB = createPack("router-repeat-b", "beta"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{0, 0}}); + stage(history, packB); + promoteWithSignatures(history); + writeRegion(region, new int[][]{{0, 0}, {1, 0}}); + stage(history, packA); + GenerationActivation third = promoteWithSignatures(history); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding current = runtimes.binding(history, third); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(current); + AtomicReference scoped = installScopeTracking(engine); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + for (int chunkX = 0; chunkX < 3; chunkX++) { + try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(chunkX, 0)) { + assertSame(current, scoped.get()); + assertEquals(3L, stage.activation().activationId()); + } + } + assertEquals(history.manifest().activation(1L).orElseThrow().epochId(), third.epochId()); + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + assertEquals(history.paths().activationMantleRoot(3L), current.mantleStorageDirectory()); + assertEquals(1L, history.resolveActivation(0, 0).activationId()); + assertEquals(2L, history.resolveActivation(1, 0).activationId()); + } + } + + @Test + public void startupPromotionPinsNewDefaultAndRetiresOldDefault() throws Exception { + Path world = temporaryFolder.newFolder("router-promotion-lease-world").toPath(); + Path packA = createPack("router-promotion-lease-a", "alpha"); + Path packB = createPack("router-promotion-lease-b", "beta"); + GenerationHistory history = createHistory(world, packA); + writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), + new int[][]{{0, 0}}); + stage(history, packB); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + 256, + runtimes + ); + + assertEquals(2L, history.activeActivation().activationId()); + verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); + verify(engine).closeDetachedGenerationRuntime(initial); + router.close(); + } + + @Test + public void attachAndLoadedRuntimeRejectKernelMismatches() throws Exception { + Path baseWorld = temporaryFolder.newFolder("router-base-kernel-world").toPath(); + Path basePack = createPack("router-base-kernel-pack", "alpha"); + GenerationHistory baseHistory = createHistory(baseWorld, basePack); + IrisEngine baseEngine = mock(IrisEngine.class); + FakeRuntimeFactory baseRuntimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding mismatchedBase = baseRuntimes.binding( + baseHistory, + baseHistory.activeActivation(), + new GenerationKernelRegistry.Version(2, 1, 1) + ); + when(baseEngine.getActiveGenerationRuntimeBinding()).thenReturn(mismatchedBase); + + assertThrows( + IOException.class, + () -> GenerationHistoryRuntimeRouter.attach( + baseEngine, + baseHistory, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + baseRuntimes + ) + ); + verify(baseEngine, never()).attachGenerationHistoryRuntimeRouter(any()); + + Path loadedWorld = temporaryFolder.newFolder("router-loaded-kernel-world").toPath(); + Path loadedPackA = createPack("router-loaded-kernel-a", "alpha"); + Path loadedPackB = createPack("router-loaded-kernel-b", "beta"); + GenerationHistory loadedHistory = createHistory(loadedWorld, loadedPackA); + stage(loadedHistory, loadedPackB); + IrisEngine loadedEngine = mock(IrisEngine.class); + FakeRuntimeFactory loadedRuntimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding correctBase = loadedRuntimes.binding( + loadedHistory, + loadedHistory.activeActivation() + ); + when(loadedEngine.getActiveGenerationRuntimeBinding()).thenReturn(correctBase); + installScopeTracking(loadedEngine); + loadedRuntimes.loadedVersion = new GenerationKernelRegistry.Version(2, 1, 1); + + assertThrows( + IOException.class, + () -> GenerationHistoryRuntimeRouter.attachAndPromotePending( + loadedEngine, + loadedHistory, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + 256, + loadedRuntimes + ) + ); + verify(loadedEngine, never()).setDefaultGenerationRuntime(any()); + verify(loadedEngine).closeDetachedGenerationRuntime(loadedRuntimes.bindings.get(2L)); + assertEquals(2L, loadedHistory.activeActivation().activationId()); + } + + @Test + public void attachPromotesSamePackWhenTheCurrentKernelChanges() throws Exception { + Path world = temporaryFolder.newFolder("router-kernel-update-world").toPath(); + Path pack = createPack("router-kernel-update-pack", "alpha"); + GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); + GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); + GenerationKernelRegistry kernels = kernels(versionTwo); + GenerationHistory history = createHistory(world, pack, versionOne, kernels); + history = GenerationHistory.open(world, new GenerationKernelRegistry(versionTwo, + List.of(kernels.requireSupported(versionTwo)))); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + installScopeTracking(engine); + + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + 64, + runtimes + ); + + GenerationActivation active = history.activeActivation(); + assertEquals(2L, active.activationId()); + assertEquals(versionTwo, history.activeEpoch().kernelVersion()); + GenerationActivation initial = history.manifest().activation(1L).orElseThrow(); + assertEquals(history.manifest().epoch(initial.epochId()).orElseThrow().packFingerprint(), + history.activeEpoch().packFingerprint()); + verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); + router.close(); + } + + @Test + public void changedBuildRevisionWithTheSameAbiAutomaticallyCreatesANewActivation() throws Exception { + Path world = temporaryFolder.newFolder("router-build-revision-world").toPath(); + Path pack = createPack("router-build-revision-pack", "alpha"); + GenerationKernelRegistry.Version version = new GenerationKernelRegistry.Version(1, 1, 1); + GenerationHistory original = createHistory(world, pack, version, kernels(version)); + GenerationKernelRegistry upgraded = new GenerationKernelRegistry(version, List.of( + new GenerationKernelRegistry.Kernel(1, "9".repeat(64), Map.of( + new GenerationKernelRegistry.AlgorithmVersion(1, 1), + (engine, plan) -> { throw new AssertionError("Mock runtime factory owns this test."); })))); + GenerationHistory history = GenerationHistory.open(world, upgraded); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, history, (ignored, x, z) -> signature(x, z), 256, runtimes)) { + assertEquals(2L, history.activeActivation().activationId()); + assertEquals(version, history.activeEpoch().kernelVersion()); + assertEquals("9".repeat(64), history.activeEpoch().kernelImplementationFingerprint()); + assertEquals(original.activeEpoch().packFingerprint(), history.activeEpoch().packFingerprint()); + assertEquals(0, runtimes.loadCount(1L)); + try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0)) { + assertEquals(2L, route.activation().activationId()); + } + } + } + + @Test + public void pendingOldRevisionPromotesWithoutLoadingItsArchivedImplementation() throws Exception { + Path world = temporaryFolder.newFolder("router-pending-kernel-world").toPath(); + Path packA = createPack("router-pending-kernel-a", "alpha"); + Path packB = createPack("router-pending-kernel-b", "beta"); + GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); + GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); + GenerationKernelRegistry kernels = kernels(versionTwo); + GenerationHistory history = createHistory(world, packA, versionOne, kernels); + history.stageUpdate( + packB, + GenerationPackFingerprint.compute(packB, GenerationPackFingerprint.CURRENT_VERSION), + contract(), + GenerationRegistryContract.empty(), + 64, + versionOne + ); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + installScopeTracking(engine); + + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + 64, + runtimes + ); + + assertEquals(3L, history.activeActivation().activationId()); + assertEquals(versionTwo, history.activeEpoch().kernelVersion()); + assertEquals(GenerationPackFingerprint.compute(packB, GenerationPackFingerprint.CURRENT_VERSION), + history.activeEpoch().packFingerprint()); + assertEquals(0, runtimes.loadCount(2L)); + verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(3L)); + router.close(); + } + + @Test + public void closeWaitsForAnInFlightPromotionLoad() throws Exception { + Path world = temporaryFolder.newFolder("router-promotion-close-world").toPath(); + GenerationHistory history = createHistory(world, createPack("router-promotion-close-a", "alpha")); + IrisEngine engine = mock(IrisEngine.class); + when(engine.isStudio()).thenReturn(true); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); + stage(history, createPack("router-promotion-close-b", "beta")); + runtimes.blockLoad(2L); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes); + ExecutorService executor = Executors.newFixedThreadPool(2); + try { + CompletableFuture promoting = CompletableFuture.runAsync(() -> { + try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { + cutover.promotePending(); + } catch (IOException failure) { + throw new IllegalStateException(failure); + } + }, executor); + assertTrue(runtimes.loadStarted.await(5L, TimeUnit.SECONDS)); + CompletableFuture closing = CompletableFuture.runAsync(router::close, executor); + awaitClosed(router); + assertThrows(TimeoutException.class, () -> closing.get(100L, TimeUnit.MILLISECONDS)); + runtimes.releaseLoad.countDown(); + promoting.get(5L, TimeUnit.SECONDS); + closing.get(5L, TimeUnit.SECONDS); + assertEquals(1, runtimes.loadCount(2L)); + verify(engine).detachGenerationHistoryRuntimeRouter(router); + } finally { + runtimes.releaseLoad.countDown(); + executor.shutdownNow(); + } + } + + @Test + public void failedOutgoingRuntimeRetirementReportsTheCommittedCutoverFailure() throws Exception { + Path world = temporaryFolder.newFolder("router-retirement-failure-world").toPath(); + GenerationHistory history = createHistory(world, createPack("router-retirement-failure-a", "alpha")); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding outgoing = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(outgoing); + stage(history, createPack("router-retirement-failure-b", "beta")); + doAnswer(invocation -> { + throw new IllegalStateException("Mantle did not close"); + }).when(engine).closeDetachedGenerationRuntime(outgoing); + assertThrows(IllegalStateException.class, () -> GenerationHistoryRuntimeRouter.attachAndPromotePending( + engine, history, (ignored, x, z) -> signature(x, z), 256, runtimes)); + assertEquals(2L, history.activeActivation().activationId()); + verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); + assertEquals(0, runtimes.loadCount(1L)); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterRoutingTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterRoutingTest.java new file mode 100644 index 000000000..df4e7fd20 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterRoutingTest.java @@ -0,0 +1,428 @@ +package art.arcane.iris.engine.history; + +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.pack.AtomicDirectoryPublisher; +import art.arcane.iris.engine.IrisEngine; +import art.arcane.iris.engine.IrisEngineMantle; +import art.arcane.iris.engine.IrisComplex; +import art.arcane.iris.engine.object.IrisBiome; +import art.arcane.iris.engine.object.IrisRegion; +import art.arcane.iris.engine.mantle.EngineMantle; +import art.arcane.volmlib.util.mantle.runtime.Mantle; +import art.arcane.volmlib.util.matter.Matter; +import org.junit.Test; +import org.mockito.MockedStatic; + +import java.io.File; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.atomic.AtomicReference; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.anyInt; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +public final class GenerationHistoryRuntimeRouterRoutingTest extends GenerationHistoryRuntimeRouterSupport { + @Test + public void preloadAndRoutesDoNotConstructHistoricalBindings() throws Exception { + Path world = temporaryFolder.newFolder("router-lazy-world").toPath(); + Path packA = createPack("router-lazy-a", "alpha"); + Path packB = createPack("router-lazy-b", "beta"); + Path packC = createPack("router-lazy-c", "gamma"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{0, 0}}); + stage(history, packB); + promoteWithSignatures(history); + writeRegion(region, new int[][]{{0, 0}, {1, 0}}); + stage(history, packC); + promoteWithSignatures(history); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + + router.preloadActiveRuntimes(); + + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + } + try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + } + router.close(); + } + + @Test + public void savedChunkMantlesShareRecordedStorageWithoutLoadingHistoricalRuntimes() throws Exception { + Path world = temporaryFolder.newFolder("router-saved-chunk-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-saved-chunk"); + int recordedChunks = history.explicitChunkCount(); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + AtomicReference scoped = installScopeTracking(engine); + EngineMantle activeEngineMantle = mock(EngineMantle.class); + Mantle activeMantle = mock(Mantle.class); + when(engine.getMantle()).thenReturn(activeEngineMantle); + when(activeEngineMantle.getMantle()).thenReturn(activeMantle); + Map dataByPack = new HashMap<>(); + Map> storageByPath = new HashMap<>(); + for (long activationId : List.of(1L, 2L)) { + dataByPack.put(history.packRoot(activationId).toFile(), mock(IrisData.class)); + storageByPath.put(history.paths().activationMantleRoot(activationId), mock(Mantle.class)); + } + + try (MockedStatic data = mockStatic(IrisData.class); + MockedStatic storage = mockStatic(IrisEngineMantle.class); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + data.when(() -> IrisData.openRuntime(any(File.class))) + .thenAnswer(invocation -> dataByPack.get(invocation.getArgument(0, File.class))); + storage.when(() -> IrisEngineMantle.createMantle(any(), any(), any())) + .thenAnswer(invocation -> storageByPath.get(invocation.getArgument(1, Path.class))); + for (int chunkX = 0; chunkX < 3; chunkX++) { + long activationId = chunkX + 1L; + Mantle expected = activationId == 3L ? activeMantle + : storageByPath.get(history.paths().activationMantleRoot(activationId)); + try (GenerationHistoryRuntimeRouter.SavedChunkMantle first = router.openSavedChunkMantle(chunkX, 0)) { + assertSame(expected, first.mantle()); + assertNull(scoped.get()); + try (GenerationHistoryRuntimeRouter.SavedChunkMantle second = router.openSavedChunkMantle(chunkX, 0)) { + assertSame(first.mantle(), second.mantle()); + } + verify(expected, never()).close(); + } + if (activationId != 3L) { + verify(expected).close(); + IrisData savedData = dataByPack.get(history.packRoot(activationId).toFile()); + verify(savedData).bindGenerationRegistryContract(history.resolveEpoch(chunkX, 0).registryContract()); + verify(savedData).registerEngine(engine); + verify(savedData).unregisterEngine(engine); + verify(savedData).close(); + } + try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(chunkX, 0)) { + assertEquals(3L, stage.activation().activationId()); + assertSame(active, scoped.get()); + } + assertTrue(history.semantics(chunkX, 0).isEmpty()); + } + storage.verify(() -> IrisEngineMantle.createMantle(any(), any(), any()), times(2)); + assertEquals(recordedChunks, history.explicitChunkCount()); + assertEquals(3L, history.activeActivation().activationId()); + assertEquals(1L, history.resolveActivation(0, 0).activationId()); + assertEquals(2L, history.resolveActivation(1, 0).activationId()); + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + verify(activeMantle, never()).close(); + verify(engine, never()).setDefaultGenerationRuntime(any()); + } + } + + @Test + public void savedChunkMantleOpensAfterItsGeneratorKernelIsNoLongerAvailable() throws Exception { + Path world = temporaryFolder.newFolder("router-saved-old-kernel-world").toPath(); + Path pack = createPack("router-saved-old-kernel-pack", "alpha"); + GenerationKernelRegistry.Version oldVersion = new GenerationKernelRegistry.Version(1, 1, 1); + GenerationKernelRegistry.Version currentVersion = new GenerationKernelRegistry.Version(2, 1, 1); + GenerationKernelRegistry kernels = kernels(currentVersion); + createHistory(world, pack, oldVersion, kernels); + writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), new int[][]{{0, 0}}); + GenerationHistory history = GenerationHistory.open(world, + new GenerationKernelRegistry(currentVersion, List.of(kernels.requireSupported(currentVersion)))); + history.stageCurrentKernel(256); + promoteWithSignatures(history); + assertEquals(oldVersion, history.resolveEpoch(0, 0).kernelVersion()); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + IrisData savedData = mock(IrisData.class); + Mantle savedStorage = mock(Mantle.class); + try (MockedStatic data = mockStatic(IrisData.class); + MockedStatic storage = mockStatic(IrisEngineMantle.class); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + data.when(() -> IrisData.openRuntime(history.packRoot(1L).toFile())).thenReturn(savedData); + storage.when(() -> IrisEngineMantle.createMantle(any(), any(), any())).thenReturn(savedStorage); + try (GenerationHistoryRuntimeRouter.SavedChunkMantle saved = router.openSavedChunkMantle(0, 0)) { + assertSame(savedStorage, saved.mantle()); + } + verify(savedStorage).close(); + storage.verify(() -> IrisEngineMantle.createMantle( + any(), eq(history.paths().activationMantleRoot(1L)), any())); + assertEquals(Set.of(2L), runtimes.bindings.keySet()); + assertEquals(0, runtimes.loadCount(1L)); + verify(engine, never()).openGenerationRuntimeScope(any()); + } + } + + @Test + public void savedChunkScopeRejectsReentrantCloseAndCutoverAfterThreadHandoff() throws Exception { + Path world = temporaryFolder.newFolder("router-saved-scope-world").toPath(); + GenerationHistory history = createHistory(world, createPack("router-saved-scope-pack", "alpha")); + IrisEngine engine = mock(IrisEngine.class); + when(engine.isStudio()).thenReturn(true); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + AtomicReference scoped = installScopeTracking(engine); + EngineMantle engineMantle = mock(EngineMantle.class); + when(engine.getMantle()).thenReturn(engineMantle); + when(engineMantle.getMantle()).thenReturn(mock(Mantle.class)); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes); + GenerationHistoryRuntimeRouter.SavedChunkMantle saved = router.openSavedChunkMantle(0, 0)) { + saved.detachThread(); + try (GenerationHistoryRuntimeRouter.SavedChunkMantle.Scope ignored = saved.openScope()) { + assertNull(scoped.get()); + assertThrows(IllegalStateException.class, router::close); + assertThrows(IllegalStateException.class, saved::close); + assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(1L)); + assertThrows(IllegalStateException.class, + () -> engine.getGenerationSessions().transitionGate().beginTransition(1L)); + } + } + } + + @Test + public void historicalTerrainRoutesWorkWhenFrozenPackFixturesAreMissing() throws Exception { + Path world = temporaryFolder.newFolder("router-archived-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-archived"); + for (long activationId : List.of(1L, 2L)) { + Path archivedPack = history.paths().packRoot(history.manifest().activation(activationId).orElseThrow().epochId()); + assertTrue(Files.isDirectory(archivedPack)); + AtomicDirectoryPublisher.deleteTree(archivedPack); + } + assertFalse(Files.exists(history.paths().packRoot(history.manifest().activation(1L).orElseThrow().epochId()))); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding current = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(current); + try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { + for (int chunkX = 0; chunkX < 3; chunkX++) { + try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(chunkX, 0)) { + assertEquals(3L, route.activation().activationId()); + } + } + assertEquals(Set.of(3L), runtimes.bindings.keySet()); + assertEquals(0, runtimes.loadCount(1L)); + assertEquals(0, runtimes.loadCount(2L)); + } + assertEquals(history.manifest(), GenerationHistory.open(world).manifest()); + } + + @Test + public void routeLeaseSurvivesNestedScopesUntilRouteCloses() throws Exception { + Path world = temporaryFolder.newFolder("router-nested-lease-world").toPath(); + GenerationHistory history = createThreeActivationHistory(world, "router-nested-lease"); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0); + + try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope outer = route.openRuntimeScope(); + GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope inner = route.openRuntimeScope()) { + assertThrows(IllegalStateException.class, route::close); + verify(engine, never()).closeDetachedGenerationRuntime(active); + } + verify(engine, never()).closeDetachedGenerationRuntime(active); + + route.close(); + + verify(engine, never()).closeDetachedGenerationRuntime(active); + router.close(); + } + + @Test + public void stageCloseReleasesItsRouteWhenRuntimeScopeCloseFails() throws Exception { + Path world = temporaryFolder.newFolder("router-scope-close-failure-world").toPath(); + Path pack = createPack("router-scope-close-failure-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); + IrisEngine.GenerationRuntimeScope runtimeScope = mock(IrisEngine.GenerationRuntimeScope.class); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); + when(engine.openGenerationRuntimeScope(active)).thenReturn(runtimeScope); + doAnswer(ignored -> { + throw new IllegalStateException("scope close failed"); + }).when(runtimeScope).close(); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0); + + IllegalStateException failure = assertThrows(IllegalStateException.class, stage::close); + + assertEquals("scope close failed", failure.getMessage()); + router.close(); + verify(engine).detachGenerationHistoryRuntimeRouter(router); + } + + @Test + public void coordinateScopesUseFloorDivAndCloseRejectsFurtherRoutes() throws Exception { + Path world = temporaryFolder.newFolder("router-coordinate-world").toPath(); + Path pack = createPack("router-coordinate-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + AtomicReference scoped = installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + + try (GenerationHistoryRuntimeRouter.CoordinateScope scope = router.openCoordinateScope(-1, -17)) { + assertEquals(-1, scope.blockX()); + assertEquals(-17, scope.blockZ()); + assertEquals(-1, scope.chunkX()); + assertEquals(-2, scope.chunkZ()); + assertEquals(1L, scope.activation().activationId()); + assertSame(first, scoped.get()); + } + + router.close(); + + assertTrue(router.isClosed()); + verify(engine).detachGenerationHistoryRuntimeRouter(router); + verify(engine, never()).closeDetachedGenerationRuntime(any()); + assertThrows(IllegalStateException.class, () -> router.openStage(-1, -2)); + } + + @Test + public void routeClaimsSealedSemanticsWhileItsRuntimeScopeIsOpen() throws Exception { + Path world = temporaryFolder.newFolder("router-claim-world").toPath(); + Path pack = createPack("router-claim-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + IrisComplex complex = mock(IrisComplex.class); + IrisBiome biome = new IrisBiome(); + biome.setLoadKey("alpha"); + IrisRegion region = new IrisRegion(); + region.setLoadKey("alpha"); + when(engine.getMinHeight()).thenReturn(-64); + when(engine.getHeight()).thenReturn(384); + when(engine.getSurfaceBiome(anyInt(), anyInt())).thenReturn(biome); + when(engine.getCaveBiome(anyInt(), anyInt())).thenReturn(biome); + when(engine.getBiome(anyInt(), anyInt(), anyInt())).thenReturn(biome); + when(engine.getBiomeOrMantle(anyInt(), anyInt(), anyInt())).thenReturn(biome); + when(engine.getRegion(anyInt(), anyInt())).thenReturn(region); + when(engine.getRegion(anyInt(), anyInt(), anyInt())).thenReturn(region); + EngineMantle engineMantle = mock(EngineMantle.class); + @SuppressWarnings("unchecked") + Mantle mantle = mock(Mantle.class); + when(engine.getComplex()).thenReturn(complex); + when(engine.getMantle()).thenReturn(engineMantle); + when(engineMantle.getMantle()).thenReturn(mantle); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(4, -3); + + assertThrows(IllegalStateException.class, route::claimGeneratedSemantics); + try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { + assertTrue(route.claimGeneratedSemantics()); + assertFalse(route.claimGeneratedSemantics()); + } + route.close(); + + ChunkGenerationSemantics semantics = history.semantics(4, -3).orElseThrow(); + assertTrue(semantics.sealed()); + assertEquals(1L, semantics.activationId()); + assertEquals("alpha", history.savedBiomes().get(4, -3).orElseThrow().biomeAt(0, 0, 0).biomeKey()); + router.close(); + } + + @Test + public void coordinateScopeBorrowsMatchingRouteAndBypassesRawRuntimeScopes() throws Exception { + Path world = temporaryFolder.newFolder("router-borrow-world").toPath(); + Path pack = createPack("router-borrow-pack", "alpha"); + GenerationHistory history = createHistory(world, pack); + IrisEngine engine = mock(IrisEngine.class); + FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); + IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); + when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); + installScopeTracking(engine); + GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( + engine, + history, + (ignored, blockX, blockZ) -> signature(blockX, blockZ), + runtimes + ); + + try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(-1, -2); + GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { + try (GenerationHistoryRuntimeRouter.CoordinateScope borrowed = router.openCoordinateScope(-1, -17)) { + assertEquals(-1, borrowed.chunkX()); + assertEquals(-2, borrowed.chunkZ()); + assertSame(route.activation(), borrowed.activation()); + assertFalse(borrowed.claimGeneratedSemantics()); + } + try (GenerationHistoryRuntimeRouter.CoordinateScope routed = router.openCoordinateScope(16, 0)) { + assertEquals(1, routed.chunkX()); + assertEquals(0, routed.chunkZ()); + assertSame(route.activation(), routed.activation()); + } + } + verify(engine, times(2)).openGenerationRuntimeScope(first); + + when(engine.hasGenerationRuntimeScope()).thenReturn(true); + try (GenerationHistoryRuntimeRouter.CoordinateScope bypassed = router.openCoordinateScope(31, 47)) { + assertEquals(1, bypassed.chunkX()); + assertEquals(2, bypassed.chunkZ()); + assertThrows(IllegalStateException.class, bypassed::activation); + assertFalse(bypassed.claimGeneratedSemantics()); + } + verify(engine, times(2)).openGenerationRuntimeScope(first); + router.close(); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterSupport.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterSupport.java new file mode 100644 index 000000000..ca5dcaa50 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterSupport.java @@ -0,0 +1,290 @@ +package art.arcane.iris.engine.history; + +import art.arcane.iris.engine.IrisEngine; +import art.arcane.iris.engine.IrisComplex; +import art.arcane.iris.engine.framework.GenerationSessionManager; +import art.arcane.iris.engine.mantle.EngineMantle; +import art.arcane.iris.util.common.data.B; +import art.arcane.iris.spi.PlatformBlockState; +import org.junit.BeforeClass; +import org.mockito.MockedStatic; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doAnswer; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.when; + +abstract class GenerationHistoryRuntimeRouterSupport extends GenerationHistorySupport { + @BeforeClass + public static void initializeMantleBlockState() throws Exception { + PlatformBlockState air = mock(PlatformBlockState.class); + try (MockedStatic blocks = mockStatic(B.class)) { + blocks.when(() -> B.getState("AIR")).thenReturn(air); + Class.forName(EngineMantle.class.getName()); + } + } + + static void routeUntilClosed(GenerationHistoryRuntimeRouter router, CountDownLatch routing) { + boolean started = false; + while (!Thread.currentThread().isInterrupted()) { + try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0)) { + assertEquals(1L, route.activation().activationId()); + if (!started) { + started = true; + routing.countDown(); + } + } catch (IOException failure) { + throw new AssertionError(failure); + } catch (IllegalStateException closed) { + assertEquals("Generation-history runtime router is closed.", closed.getMessage()); + return; + } + } + } + + AtomicReference installScopeTracking(IrisEngine engine) { + AtomicReference scoped = new AtomicReference<>(); + when(engine.openGenerationRuntimeScope(any())).thenAnswer(invocation -> { + IrisEngine.GenerationRuntimeBinding binding = invocation.getArgument(0); + scoped.set(binding); + IrisEngine.GenerationRuntimeScope scope = mock(IrisEngine.GenerationRuntimeScope.class); + doAnswer(ignored -> { + scoped.compareAndSet(binding, null); + return null; + }).when(scope).close(); + return scope; + }); + return scoped; + } + + CompletableFuture openRouteAsync( + GenerationHistoryRuntimeRouter router, + ExecutorService executor, + CountDownLatch ready, + CountDownLatch start, + int chunkX, + int chunkZ + ) { + return CompletableFuture.supplyAsync(() -> { + ready.countDown(); + try { + if (!start.await(5L, TimeUnit.SECONDS)) { + throw new IllegalStateException("Timed out waiting to start concurrent route acquisition."); + } + } catch (InterruptedException interrupted) { + Thread.currentThread().interrupt(); + throw new IllegalStateException("Interrupted before concurrent route acquisition.", interrupted); + } + return openRouteUnchecked(router, chunkX, chunkZ); + }, executor); + } + + static GenerationHistoryRuntimeRouter.RuntimeRoute openRouteUnchecked( + GenerationHistoryRuntimeRouter router, + int chunkX, + int chunkZ + ) { + try { + return router.openRoute(chunkX, chunkZ); + } catch (IOException failure) { + throw new IllegalStateException(failure); + } + } + + static void awaitClosed(GenerationHistoryRuntimeRouter router) throws InterruptedException { + long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); + while (!router.isClosed() && System.nanoTime() < deadline) { + Thread.onSpinWait(); + } + assertTrue(router.isClosed()); + } + + GenerationHistory createThreeActivationHistory(Path world, String prefix) throws IOException { + Path packA = createPack(prefix + "-a", "alpha"); + Path packB = createPack(prefix + "-b", "beta"); + Path packC = createPack(prefix + "-c", "gamma"); + GenerationHistory history = createHistory(world, packA); + Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); + writeRegion(region, new int[][]{{0, 0}}); + stage(history, packB); + promoteWithSignatures(history); + writeRegion(region, new int[][]{{0, 0}, {1, 0}}); + stage(history, packC); + promoteWithSignatures(history); + return history; + } + + static GenerationHistory createHistory( + Path world, + Path pack, + GenerationKernelRegistry.Version version, + GenerationKernelRegistry kernels + ) throws IOException { + return GenerationHistory.create( + world, + pack, + GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION), + 42L, + contract(), + GenerationRegistryContract.empty(), + version, + kernels + ); + } + + static GenerationKernelRegistry kernels(GenerationKernelRegistry.Version current) { + return new GenerationKernelRegistry( + current, + Set.of( + new GenerationKernelRegistry.Kernel( + 1, + "1".repeat(64), + Map.of( + new GenerationKernelRegistry.AlgorithmVersion(1, 1), + (engine, transitionPlan) -> { + throw new AssertionError("Mock runtime factory owns this test."); + } + ) + ), + new GenerationKernelRegistry.Kernel( + 2, + "2".repeat(64), + Map.of( + new GenerationKernelRegistry.AlgorithmVersion(1, 1), + (engine, transitionPlan) -> { + throw new AssertionError("Mock runtime factory owns this test."); + } + ) + ) + ) + ); + } + + static GenerationActivation promoteWithSignatures(GenerationHistory history) throws IOException { + return history.promotePending(boundary -> GenerationHistorySupport::signature); + } + + static final class FakeRuntimeFactory + implements GenerationHistoryRuntimeRouter.ActivationRuntimeFactory { + final Map bindings = new HashMap<>(); + final Map mantles = new HashMap<>(); + final Map loadCounts = new HashMap<>(); + GenerationKernelRegistry.Version loadedVersion; + long blockedActivation = -1L; + CountDownLatch loadStarted = new CountDownLatch(0); + CountDownLatch releaseLoad = new CountDownLatch(0); + + @Override + public void validateBase( + IrisEngine engine, + GenerationHistory history, + GenerationActivation activation, + GenerationEpoch epoch, + IrisEngine.GenerationRuntimeBinding binding + ) { + if (engine.getGenerationSessions() == null) { + when(engine.getGenerationSessions()).thenReturn(new GenerationSessionManager(true)); + } + } + + @Override + public IrisEngine.GenerationRuntimeBinding load( + IrisEngine engine, + GenerationHistory history, + GenerationActivation activation, + GenerationEpoch epoch + ) throws IOException { + if (!epoch.kernelVersion().equals(history.currentKernelVersion()) + || !history.usesCurrentGenerator()) { + throw new AssertionError("Archived generator implementations must never load."); + } + synchronized (loadCounts) { + loadCounts.computeIfAbsent(activation.activationId(), ignored -> new AtomicInteger()).incrementAndGet(); + } + if (activation.activationId() == blockedActivation) { + loadStarted.countDown(); + try { + if (!releaseLoad.await(5L, TimeUnit.SECONDS)) { + throw new IOException("Timed out waiting to release the blocked runtime load."); + } + } catch (InterruptedException interrupted) { + Thread.currentThread().interrupt(); + throw new IOException("Interrupted while loading a test runtime.", interrupted); + } + } + GenerationKernelRegistry.Version version = loadedVersion == null + ? epoch.kernelVersion() + : loadedVersion; + return binding(history, activation, version); + } + + void blockLoad(long activationId) { + blockedActivation = activationId; + loadStarted = new CountDownLatch(1); + releaseLoad = new CountDownLatch(1); + } + + int loadCount(long activationId) { + synchronized (loadCounts) { + AtomicInteger count = loadCounts.get(activationId); + return count == null ? 0 : count.get(); + } + } + + IrisEngine.GenerationRuntimeBinding binding( + GenerationHistory history, + GenerationActivation activation + ) throws IOException { + return binding(history, activation, requireEpoch(history, activation).kernelVersion()); + } + + IrisEngine.GenerationRuntimeBinding binding( + GenerationHistory history, + GenerationActivation activation, + GenerationKernelRegistry.Version version + ) throws IOException { + GenerationEpoch epoch = requireEpoch(history, activation); + IrisEngine.GenerationRuntimeBinding binding = mock(IrisEngine.GenerationRuntimeBinding.class); + Path mantle = history.paths().activationMantleRoot(activation.activationId()); + TransitionGenerationPlan plan = activation.isInitial() + ? null + : history.transitionPlan(activation.activationId()); + when(binding.kernelVersion()).thenReturn(version); + when(binding.runtimeKernel()).thenReturn(new GenerationKernelRegistry.RuntimeKernel( + version, + epoch.kernelImplementationFingerprint(), + (engine, transitionPlan) -> mock(IrisComplex.class) + )); + when(binding.mantleStorageDirectory()).thenReturn(mantle); + when(binding.transitionPlan()).thenReturn(plan); + when(binding.runtimeId()).thenReturn(Math.toIntExact(activation.activationId())); + bindings.put(activation.activationId(), binding); + mantles.put(activation.activationId(), mantle); + return binding; + } + + static GenerationEpoch requireEpoch( + GenerationHistory history, + GenerationActivation activation + ) { + return history.manifest().epoch(activation.epochId()).orElseThrow(); + } + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java b/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java deleted file mode 100644 index c65a26820..000000000 --- a/core/src/test/java/art/arcane/iris/engine/history/GenerationHistoryRuntimeRouterTest.java +++ /dev/null @@ -1,1375 +0,0 @@ -package art.arcane.iris.engine.history; - -import art.arcane.iris.core.loader.IrisData; -import art.arcane.iris.core.pack.AtomicDirectoryPublisher; -import art.arcane.iris.engine.IrisEngine; -import art.arcane.iris.engine.IrisEngineMantle; -import art.arcane.iris.engine.IrisComplex; -import art.arcane.iris.engine.object.IrisBiome; -import art.arcane.iris.engine.object.IrisRegion; -import art.arcane.iris.engine.framework.GenerationSessionManager; -import art.arcane.iris.engine.mantle.EngineMantle; -import art.arcane.iris.testsupport.DurabilityMode; -import art.arcane.iris.util.common.data.B; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.volmlib.util.mantle.runtime.Mantle; -import art.arcane.volmlib.util.matter.Matter; -import org.junit.ClassRule; -import org.junit.Rule; -import org.junit.BeforeClass; -import org.junit.Test; -import org.mockito.MockedStatic; -import org.junit.rules.TemporaryFolder; - -import java.io.File; -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.OptionalInt; -import java.util.Set; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.CountDownLatch; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import java.util.concurrent.atomic.AtomicInteger; -import java.util.concurrent.atomic.AtomicReference; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertArrayEquals; -import static org.junit.Assert.assertFalse; -import static org.junit.Assert.assertNotSame; -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertSame; -import static org.junit.Assert.assertThrows; -import static org.junit.Assert.assertTrue; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyInt; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doAnswer; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.mockStatic; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -public final class GenerationHistoryRuntimeRouterTest { - @ClassRule - public static final DurabilityMode DURABILITY = DurabilityMode.relaxed(); - - @Rule - public final TemporaryFolder temporaryFolder = new TemporaryFolder(); - - @BeforeClass - public static void initializeMantleBlockState() throws Exception { - PlatformBlockState air = mock(PlatformBlockState.class); - try (MockedStatic blocks = mockStatic(B.class)) { - blocks.when(() -> B.getState("AIR")).thenReturn(air); - Class.forName(EngineMantle.class.getName()); - } - } - - @Test - public void promotionSamplesSavedBoundaryWithoutOpeningHistoricalRuntimeScopes() throws Exception { - Path world = temporaryFolder.newFolder("router-promotion-world").toPath(); - Path packA = createPack("router-promotion-a", "alpha"); - Path packB = createPack("router-promotion-b", "beta"); - GenerationHistory history = createHistory(world, packA); - writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), - new int[][]{{0, 0}}); - stage(history, packB); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - AtomicReference scoped = installScopeTracking(engine); - int[] samples = new int[1]; - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, - history, - (routedEngine, blockX, blockZ) -> { - assertSame(engine, routedEngine); - assertNull(scoped.get()); - samples[0]++; - return signature(blockX, blockZ); - }, - 256, - runtimes - ); - - GenerationActivation activated = history.activeActivation(); - IrisEngine.GenerationRuntimeBinding second = runtimes.bindings.get(2L); - - assertEquals(2L, activated.activationId()); - assertEquals(history.boundary(2L).exposedBlockColumns().size(), samples[0]); - verify(engine).setDefaultGenerationRuntime(second); - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { - assertSame(second, scoped.get()); - } - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { - assertSame(second, scoped.get()); - } - router.close(); - } - - @Test - public void repeatedPackActivationUsesOnlyItsCurrentMantleAndBinding() throws Exception { - Path world = temporaryFolder.newFolder("router-repeat-world").toPath(); - Path packA = createPack("router-repeat-a", "alpha"); - Path packB = createPack("router-repeat-b", "beta"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{0, 0}}); - stage(history, packB); - promoteWithSignatures(history); - writeRegion(region, new int[][]{{0, 0}, {1, 0}}); - stage(history, packA); - GenerationActivation third = promoteWithSignatures(history); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding current = runtimes.binding(history, third); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(current); - AtomicReference scoped = installScopeTracking(engine); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - for (int chunkX = 0; chunkX < 3; chunkX++) { - try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(chunkX, 0)) { - assertSame(current, scoped.get()); - assertEquals(3L, stage.activation().activationId()); - } - } - assertEquals(history.manifest().activation(1L).orElseThrow().epochId(), third.epochId()); - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - assertEquals(history.paths().activationMantleRoot(3L), current.mantleStorageDirectory()); - assertEquals(1L, history.resolveActivation(0, 0).activationId()); - assertEquals(2L, history.resolveActivation(1, 0).activationId()); - } - } - - @Test - public void preloadAndRoutesDoNotConstructHistoricalBindings() throws Exception { - Path world = temporaryFolder.newFolder("router-lazy-world").toPath(); - Path packA = createPack("router-lazy-a", "alpha"); - Path packB = createPack("router-lazy-b", "beta"); - Path packC = createPack("router-lazy-c", "gamma"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{0, 0}}); - stage(history, packB); - promoteWithSignatures(history); - writeRegion(region, new int[][]{{0, 0}, {1, 0}}); - stage(history, packC); - promoteWithSignatures(history); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - - router.preloadActiveRuntimes(); - - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - } - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - } - router.close(); - } - - @Test - public void savedChunkMantlesShareRecordedStorageWithoutLoadingHistoricalRuntimes() throws Exception { - Path world = temporaryFolder.newFolder("router-saved-chunk-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-saved-chunk"); - int recordedChunks = history.explicitChunkCount(); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - AtomicReference scoped = installScopeTracking(engine); - EngineMantle activeEngineMantle = mock(EngineMantle.class); - Mantle activeMantle = mock(Mantle.class); - when(engine.getMantle()).thenReturn(activeEngineMantle); - when(activeEngineMantle.getMantle()).thenReturn(activeMantle); - Map dataByPack = new HashMap<>(); - Map> storageByPath = new HashMap<>(); - for (long activationId : List.of(1L, 2L)) { - dataByPack.put(history.packRoot(activationId).toFile(), mock(IrisData.class)); - storageByPath.put(history.paths().activationMantleRoot(activationId), mock(Mantle.class)); - } - - try (MockedStatic data = mockStatic(IrisData.class); - MockedStatic storage = mockStatic(IrisEngineMantle.class); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - data.when(() -> IrisData.openRuntime(any(File.class))) - .thenAnswer(invocation -> dataByPack.get(invocation.getArgument(0, File.class))); - storage.when(() -> IrisEngineMantle.createMantle(any(), any(), any())) - .thenAnswer(invocation -> storageByPath.get(invocation.getArgument(1, Path.class))); - for (int chunkX = 0; chunkX < 3; chunkX++) { - long activationId = chunkX + 1L; - Mantle expected = activationId == 3L ? activeMantle - : storageByPath.get(history.paths().activationMantleRoot(activationId)); - try (GenerationHistoryRuntimeRouter.SavedChunkMantle first = router.openSavedChunkMantle(chunkX, 0)) { - assertSame(expected, first.mantle()); - assertNull(scoped.get()); - try (GenerationHistoryRuntimeRouter.SavedChunkMantle second = router.openSavedChunkMantle(chunkX, 0)) { - assertSame(first.mantle(), second.mantle()); - } - verify(expected, never()).close(); - } - if (activationId != 3L) { - verify(expected).close(); - IrisData savedData = dataByPack.get(history.packRoot(activationId).toFile()); - verify(savedData).bindGenerationRegistryContract(history.resolveEpoch(chunkX, 0).registryContract()); - verify(savedData).registerEngine(engine); - verify(savedData).unregisterEngine(engine); - verify(savedData).close(); - } - try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(chunkX, 0)) { - assertEquals(3L, stage.activation().activationId()); - assertSame(active, scoped.get()); - } - assertTrue(history.semantics(chunkX, 0).isEmpty()); - } - storage.verify(() -> IrisEngineMantle.createMantle(any(), any(), any()), times(2)); - assertEquals(recordedChunks, history.explicitChunkCount()); - assertEquals(3L, history.activeActivation().activationId()); - assertEquals(1L, history.resolveActivation(0, 0).activationId()); - assertEquals(2L, history.resolveActivation(1, 0).activationId()); - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - verify(activeMantle, never()).close(); - verify(engine, never()).setDefaultGenerationRuntime(any()); - } - } - - @Test - public void savedChunkMantleOpensAfterItsGeneratorKernelIsNoLongerAvailable() throws Exception { - Path world = temporaryFolder.newFolder("router-saved-old-kernel-world").toPath(); - Path pack = createPack("router-saved-old-kernel-pack", "alpha"); - GenerationKernelRegistry.Version oldVersion = new GenerationKernelRegistry.Version(1, 1, 1); - GenerationKernelRegistry.Version currentVersion = new GenerationKernelRegistry.Version(2, 1, 1); - GenerationKernelRegistry kernels = kernels(currentVersion); - createHistory(world, pack, oldVersion, kernels); - writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), new int[][]{{0, 0}}); - GenerationHistory history = GenerationHistory.open(world, - new GenerationKernelRegistry(currentVersion, List.of(kernels.requireSupported(currentVersion)))); - history.stageCurrentKernel(256); - promoteWithSignatures(history); - assertEquals(oldVersion, history.resolveEpoch(0, 0).kernelVersion()); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - IrisData savedData = mock(IrisData.class); - Mantle savedStorage = mock(Mantle.class); - try (MockedStatic data = mockStatic(IrisData.class); - MockedStatic storage = mockStatic(IrisEngineMantle.class); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - data.when(() -> IrisData.openRuntime(history.packRoot(1L).toFile())).thenReturn(savedData); - storage.when(() -> IrisEngineMantle.createMantle(any(), any(), any())).thenReturn(savedStorage); - try (GenerationHistoryRuntimeRouter.SavedChunkMantle saved = router.openSavedChunkMantle(0, 0)) { - assertSame(savedStorage, saved.mantle()); - } - verify(savedStorage).close(); - storage.verify(() -> IrisEngineMantle.createMantle( - any(), eq(history.paths().activationMantleRoot(1L)), any())); - assertEquals(Set.of(2L), runtimes.bindings.keySet()); - assertEquals(0, runtimes.loadCount(1L)); - verify(engine, never()).openGenerationRuntimeScope(any()); - } - } - - @Test - public void savedChunkScopeRejectsReentrantCloseAndCutoverAfterThreadHandoff() throws Exception { - Path world = temporaryFolder.newFolder("router-saved-scope-world").toPath(); - GenerationHistory history = createHistory(world, createPack("router-saved-scope-pack", "alpha")); - IrisEngine engine = mock(IrisEngine.class); - when(engine.isStudio()).thenReturn(true); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - AtomicReference scoped = installScopeTracking(engine); - EngineMantle engineMantle = mock(EngineMantle.class); - when(engine.getMantle()).thenReturn(engineMantle); - when(engineMantle.getMantle()).thenReturn(mock(Mantle.class)); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes); - GenerationHistoryRuntimeRouter.SavedChunkMantle saved = router.openSavedChunkMantle(0, 0)) { - saved.detachThread(); - try (GenerationHistoryRuntimeRouter.SavedChunkMantle.Scope ignored = saved.openScope()) { - assertNull(scoped.get()); - assertThrows(IllegalStateException.class, router::close); - assertThrows(IllegalStateException.class, saved::close); - assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(1L)); - assertThrows(IllegalStateException.class, - () -> engine.getGenerationSessions().transitionGate().beginTransition(1L)); - } - } - } - - @Test - public void historicalTerrainRoutesWorkWhenFrozenPackFixturesAreMissing() throws Exception { - Path world = temporaryFolder.newFolder("router-archived-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-archived"); - for (long activationId : List.of(1L, 2L)) { - Path archivedPack = history.paths().packRoot(history.manifest().activation(activationId).orElseThrow().epochId()); - assertTrue(Files.isDirectory(archivedPack)); - AtomicDirectoryPublisher.deleteTree(archivedPack); - } - assertFalse(Files.exists(history.paths().packRoot(history.manifest().activation(1L).orElseThrow().epochId()))); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding current = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(current); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - for (int chunkX = 0; chunkX < 3; chunkX++) { - try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(chunkX, 0)) { - assertEquals(3L, route.activation().activationId()); - } - } - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - assertEquals(0, runtimes.loadCount(1L)); - assertEquals(0, runtimes.loadCount(2L)); - } - assertEquals(history.manifest(), GenerationHistory.open(world).manifest()); - } - - @Test - public void closeWaitsForAnInFlightPromotionLoad() throws Exception { - Path world = temporaryFolder.newFolder("router-promotion-close-world").toPath(); - GenerationHistory history = createHistory(world, createPack("router-promotion-close-a", "alpha")); - IrisEngine engine = mock(IrisEngine.class); - when(engine.isStudio()).thenReturn(true); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); - stage(history, createPack("router-promotion-close-b", "beta")); - runtimes.blockLoad(2L); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes); - ExecutorService executor = Executors.newFixedThreadPool(2); - try { - CompletableFuture promoting = CompletableFuture.runAsync(() -> { - try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { - cutover.promotePending(); - } catch (IOException failure) { - throw new IllegalStateException(failure); - } - }, executor); - assertTrue(runtimes.loadStarted.await(5L, TimeUnit.SECONDS)); - CompletableFuture closing = CompletableFuture.runAsync(router::close, executor); - awaitClosed(router); - assertThrows(TimeoutException.class, () -> closing.get(100L, TimeUnit.MILLISECONDS)); - runtimes.releaseLoad.countDown(); - promoting.get(5L, TimeUnit.SECONDS); - closing.get(5L, TimeUnit.SECONDS); - assertEquals(1, runtimes.loadCount(2L)); - verify(engine).detachGenerationHistoryRuntimeRouter(router); - } finally { - runtimes.releaseLoad.countDown(); - executor.shutdownNow(); - } - } - - @Test - public void failedOutgoingRuntimeRetirementReportsTheCommittedCutoverFailure() throws Exception { - Path world = temporaryFolder.newFolder("router-retirement-failure-world").toPath(); - GenerationHistory history = createHistory(world, createPack("router-retirement-failure-a", "alpha")); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding outgoing = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(outgoing); - stage(history, createPack("router-retirement-failure-b", "beta")); - doAnswer(invocation -> { - throw new IllegalStateException("Mantle did not close"); - }).when(engine).closeDetachedGenerationRuntime(outgoing); - assertThrows(IllegalStateException.class, () -> GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, history, (ignored, x, z) -> signature(x, z), 256, runtimes)); - assertEquals(2L, history.activeActivation().activationId()); - verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); - assertEquals(0, runtimes.loadCount(1L)); - } - - @Test - public void routeLeaseSurvivesNestedScopesUntilRouteCloses() throws Exception { - Path world = temporaryFolder.newFolder("router-nested-lease-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-nested-lease"); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0); - - try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope outer = route.openRuntimeScope(); - GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope inner = route.openRuntimeScope()) { - assertThrows(IllegalStateException.class, route::close); - verify(engine, never()).closeDetachedGenerationRuntime(active); - } - verify(engine, never()).closeDetachedGenerationRuntime(active); - - route.close(); - - verify(engine, never()).closeDetachedGenerationRuntime(active); - router.close(); - } - - @Test - public void stageCloseReleasesItsRouteWhenRuntimeScopeCloseFails() throws Exception { - Path world = temporaryFolder.newFolder("router-scope-close-failure-world").toPath(); - Path pack = createPack("router-scope-close-failure-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - IrisEngine.GenerationRuntimeScope runtimeScope = mock(IrisEngine.GenerationRuntimeScope.class); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - when(engine.openGenerationRuntimeScope(active)).thenReturn(runtimeScope); - doAnswer(ignored -> { - throw new IllegalStateException("scope close failed"); - }).when(runtimeScope).close(); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0); - - IllegalStateException failure = assertThrows(IllegalStateException.class, stage::close); - - assertEquals("scope close failed", failure.getMessage()); - router.close(); - verify(engine).detachGenerationHistoryRuntimeRouter(router); - } - - @Test - public void concurrentHistoricalRoutesShareTheCurrentRuntimeWithoutLoadingOldFactories() throws Exception { - Path world = temporaryFolder.newFolder("router-deduplicated-load-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-deduplicated-load"); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - ExecutorService executor = Executors.newFixedThreadPool(2); - CountDownLatch ready = new CountDownLatch(2); - CountDownLatch start = new CountDownLatch(1); - try { - CompletableFuture first = openRouteAsync( - router, executor, ready, start, 0, 0); - CompletableFuture second = openRouteAsync( - router, executor, ready, start, 0, 0); - assertTrue(ready.await(5L, TimeUnit.SECONDS)); - start.countDown(); - GenerationHistoryRuntimeRouter.RuntimeRoute firstRoute = first.get(5L, TimeUnit.SECONDS); - GenerationHistoryRuntimeRouter.RuntimeRoute secondRoute = second.get(5L, TimeUnit.SECONDS); - - assertEquals(0, runtimes.loadCount(1L)); - assertEquals(3L, firstRoute.activation().activationId()); - assertEquals(3L, secondRoute.activation().activationId()); - firstRoute.close(); - secondRoute.close(); - } finally { - executor.shutdownNow(); - } - router.close(); - } - - @Test - public void closeRejectsNewRoutesAndAwaitsExistingLeases() throws Exception { - Path world = temporaryFolder.newFolder("router-close-await-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-close-await"); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes); - GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0); - ExecutorService executor = Executors.newSingleThreadExecutor(); - try { - CompletableFuture closing = CompletableFuture.runAsync(router::close, executor); - awaitClosed(router); - assertThrows(IllegalStateException.class, () -> router.openRoute(2, 0)); - assertThrows(TimeoutException.class, () -> closing.get(100L, TimeUnit.MILLISECONDS)); - route.close(); - closing.get(5L, TimeUnit.SECONDS); - } finally { - route.close(); - executor.shutdownNow(); - } - verify(engine).detachGenerationHistoryRuntimeRouter(router); - verify(engine, never()).closeDetachedGenerationRuntime(active); - } - - @Test - public void closeCompletesWhileWorkersContinuouslyAcquireReadyRoutes() throws Exception { - Path world = temporaryFolder.newFolder("router-contended-close-world").toPath(); - GenerationHistory history = createHistory(world, createPack("router-contended-close-pack", "alpha")); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding active = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(active); - ExecutorService executor = Executors.newFixedThreadPool(9); - CountDownLatch routing = new CountDownLatch(8); - CompletableFuture[] workers = new CompletableFuture[8]; - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes); - try { - for (int i = 0; i < workers.length; i++) { - workers[i] = CompletableFuture.runAsync(() -> routeUntilClosed(router, routing), executor); - } - assertTrue(routing.await(5, TimeUnit.SECONDS)); - CompletableFuture.runAsync(router::close, executor).get(5, TimeUnit.SECONDS); - CompletableFuture.allOf(workers).get(5, TimeUnit.SECONDS); - verify(engine).detachGenerationHistoryRuntimeRouter(router); - verify(engine, never()).closeDetachedGenerationRuntime(active); - } finally { - executor.shutdownNow(); - assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS)); - router.close(); - } - } - - @Test - public void closeLeavesTheSingleDefaultRuntimeOwnedByTheEngine() throws Exception { - Path world = temporaryFolder.newFolder("router-close-current-world").toPath(); - GenerationHistory history = createThreeActivationHistory(world, "router-close-current"); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); - installScopeTracking(engine); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { - } - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(1, 0)) { - } - } - assertEquals(Set.of(3L), runtimes.bindings.keySet()); - verify(engine, never()).closeDetachedGenerationRuntime(any()); - } - - @Test - public void startupPromotionPinsNewDefaultAndRetiresOldDefault() throws Exception { - Path world = temporaryFolder.newFolder("router-promotion-lease-world").toPath(); - Path packA = createPack("router-promotion-lease-a", "alpha"); - Path packB = createPack("router-promotion-lease-b", "beta"); - GenerationHistory history = createHistory(world, packA); - writeRegion(Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"), - new int[][]{{0, 0}}); - stage(history, packB); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - 256, - runtimes - ); - - assertEquals(2L, history.activeActivation().activationId()); - verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); - verify(engine).closeDetachedGenerationRuntime(initial); - router.close(); - } - - @Test - public void attachAndLoadedRuntimeRejectKernelMismatches() throws Exception { - Path baseWorld = temporaryFolder.newFolder("router-base-kernel-world").toPath(); - Path basePack = createPack("router-base-kernel-pack", "alpha"); - GenerationHistory baseHistory = createHistory(baseWorld, basePack); - IrisEngine baseEngine = mock(IrisEngine.class); - FakeRuntimeFactory baseRuntimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding mismatchedBase = baseRuntimes.binding( - baseHistory, - baseHistory.activeActivation(), - new GenerationKernelRegistry.Version(2, 1, 1) - ); - when(baseEngine.getActiveGenerationRuntimeBinding()).thenReturn(mismatchedBase); - - assertThrows( - IOException.class, - () -> GenerationHistoryRuntimeRouter.attach( - baseEngine, - baseHistory, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - baseRuntimes - ) - ); - verify(baseEngine, never()).attachGenerationHistoryRuntimeRouter(any()); - - Path loadedWorld = temporaryFolder.newFolder("router-loaded-kernel-world").toPath(); - Path loadedPackA = createPack("router-loaded-kernel-a", "alpha"); - Path loadedPackB = createPack("router-loaded-kernel-b", "beta"); - GenerationHistory loadedHistory = createHistory(loadedWorld, loadedPackA); - stage(loadedHistory, loadedPackB); - IrisEngine loadedEngine = mock(IrisEngine.class); - FakeRuntimeFactory loadedRuntimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding correctBase = loadedRuntimes.binding( - loadedHistory, - loadedHistory.activeActivation() - ); - when(loadedEngine.getActiveGenerationRuntimeBinding()).thenReturn(correctBase); - installScopeTracking(loadedEngine); - loadedRuntimes.loadedVersion = new GenerationKernelRegistry.Version(2, 1, 1); - - assertThrows( - IOException.class, - () -> GenerationHistoryRuntimeRouter.attachAndPromotePending( - loadedEngine, - loadedHistory, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - 256, - loadedRuntimes - ) - ); - verify(loadedEngine, never()).setDefaultGenerationRuntime(any()); - verify(loadedEngine).closeDetachedGenerationRuntime(loadedRuntimes.bindings.get(2L)); - assertEquals(2L, loadedHistory.activeActivation().activationId()); - } - - @Test - public void coordinateScopesUseFloorDivAndCloseRejectsFurtherRoutes() throws Exception { - Path world = temporaryFolder.newFolder("router-coordinate-world").toPath(); - Path pack = createPack("router-coordinate-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - AtomicReference scoped = installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - - try (GenerationHistoryRuntimeRouter.CoordinateScope scope = router.openCoordinateScope(-1, -17)) { - assertEquals(-1, scope.blockX()); - assertEquals(-17, scope.blockZ()); - assertEquals(-1, scope.chunkX()); - assertEquals(-2, scope.chunkZ()); - assertEquals(1L, scope.activation().activationId()); - assertSame(first, scoped.get()); - } - - router.close(); - - assertTrue(router.isClosed()); - verify(engine).detachGenerationHistoryRuntimeRouter(router); - verify(engine, never()).closeDetachedGenerationRuntime(any()); - assertThrows(IllegalStateException.class, () -> router.openStage(-1, -2)); - } - - @Test - public void runtimeRouteScopesWorkAndCloseAcrossAsyncThreads() throws Exception { - Path world = temporaryFolder.newFolder("router-async-world").toPath(); - Path pack = createPack("router-async-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - AtomicReference scoped = installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(-1, -2); - Thread caller = Thread.currentThread(); - AtomicReference completionThread = new AtomicReference<>(); - ExecutorService executor = Executors.newSingleThreadExecutor(); - try { - CompletableFuture work = CompletableFuture.runAsync(() -> { - try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { - assertSame(first, scoped.get()); - assertThrows(IllegalStateException.class, route::close); - } - }, executor); - CompletableFuture completion = work.whenCompleteAsync((ignored, failure) -> { - completionThread.set(Thread.currentThread()); - route.close(); - }, executor); - completion.get(5L, TimeUnit.SECONDS); - } finally { - executor.shutdownNow(); - } - - assertNotSame(caller, completionThread.get()); - assertEquals(-1, route.chunkX()); - assertEquals(-2, route.chunkZ()); - assertThrows(IllegalStateException.class, route::openRuntimeScope); - router.close(); - } - - @Test - public void routeClaimsSealedSemanticsWhileItsRuntimeScopeIsOpen() throws Exception { - Path world = temporaryFolder.newFolder("router-claim-world").toPath(); - Path pack = createPack("router-claim-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - IrisComplex complex = mock(IrisComplex.class); - IrisBiome biome = new IrisBiome(); - biome.setLoadKey("alpha"); - IrisRegion region = new IrisRegion(); - region.setLoadKey("alpha"); - when(engine.getMinHeight()).thenReturn(-64); - when(engine.getHeight()).thenReturn(384); - when(engine.getSurfaceBiome(anyInt(), anyInt())).thenReturn(biome); - when(engine.getCaveBiome(anyInt(), anyInt())).thenReturn(biome); - when(engine.getBiome(anyInt(), anyInt(), anyInt())).thenReturn(biome); - when(engine.getBiomeOrMantle(anyInt(), anyInt(), anyInt())).thenReturn(biome); - when(engine.getRegion(anyInt(), anyInt())).thenReturn(region); - when(engine.getRegion(anyInt(), anyInt(), anyInt())).thenReturn(region); - EngineMantle engineMantle = mock(EngineMantle.class); - @SuppressWarnings("unchecked") - Mantle mantle = mock(Mantle.class); - when(engine.getComplex()).thenReturn(complex); - when(engine.getMantle()).thenReturn(engineMantle); - when(engineMantle.getMantle()).thenReturn(mantle); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(4, -3); - - assertThrows(IllegalStateException.class, route::claimGeneratedSemantics); - try (GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { - assertTrue(route.claimGeneratedSemantics()); - assertFalse(route.claimGeneratedSemantics()); - } - route.close(); - - ChunkGenerationSemantics semantics = history.semantics(4, -3).orElseThrow(); - assertTrue(semantics.sealed()); - assertEquals(1L, semantics.activationId()); - assertEquals("alpha", history.savedBiomes().get(4, -3).orElseThrow().biomeAt(0, 0, 0).biomeKey()); - router.close(); - } - - @Test - public void coordinateScopeBorrowsMatchingRouteAndBypassesRawRuntimeScopes() throws Exception { - Path world = temporaryFolder.newFolder("router-borrow-world").toPath(); - Path pack = createPack("router-borrow-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - installScopeTracking(engine); - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - runtimes - ); - - try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(-1, -2); - GenerationHistoryRuntimeRouter.RuntimeRoute.RuntimeScope ignored = route.openRuntimeScope()) { - try (GenerationHistoryRuntimeRouter.CoordinateScope borrowed = router.openCoordinateScope(-1, -17)) { - assertEquals(-1, borrowed.chunkX()); - assertEquals(-2, borrowed.chunkZ()); - assertSame(route.activation(), borrowed.activation()); - assertFalse(borrowed.claimGeneratedSemantics()); - } - try (GenerationHistoryRuntimeRouter.CoordinateScope routed = router.openCoordinateScope(16, 0)) { - assertEquals(1, routed.chunkX()); - assertEquals(0, routed.chunkZ()); - assertSame(route.activation(), routed.activation()); - } - } - verify(engine, times(2)).openGenerationRuntimeScope(first); - - when(engine.hasGenerationRuntimeScope()).thenReturn(true); - try (GenerationHistoryRuntimeRouter.CoordinateScope bypassed = router.openCoordinateScope(31, 47)) { - assertEquals(1, bypassed.chunkX()); - assertEquals(2, bypassed.chunkZ()); - assertThrows(IllegalStateException.class, bypassed::activation); - assertFalse(bypassed.claimGeneratedSemantics()); - } - verify(engine, times(2)).openGenerationRuntimeScope(first); - router.close(); - } - - @Test - public void attachPromotesSamePackWhenTheCurrentKernelChanges() throws Exception { - Path world = temporaryFolder.newFolder("router-kernel-update-world").toPath(); - Path pack = createPack("router-kernel-update-pack", "alpha"); - GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); - GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); - GenerationKernelRegistry kernels = kernels(versionTwo); - GenerationHistory history = createHistory(world, pack, versionOne, kernels); - history = GenerationHistory.open(world, new GenerationKernelRegistry(versionTwo, - List.of(kernels.requireSupported(versionTwo)))); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - installScopeTracking(engine); - - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - 64, - runtimes - ); - - GenerationActivation active = history.activeActivation(); - assertEquals(2L, active.activationId()); - assertEquals(versionTwo, history.activeEpoch().kernelVersion()); - GenerationActivation initial = history.manifest().activation(1L).orElseThrow(); - assertEquals(history.manifest().epoch(initial.epochId()).orElseThrow().packFingerprint(), - history.activeEpoch().packFingerprint()); - verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(2L)); - router.close(); - } - - @Test - public void changedBuildRevisionWithTheSameAbiAutomaticallyCreatesANewActivation() throws Exception { - Path world = temporaryFolder.newFolder("router-build-revision-world").toPath(); - Path pack = createPack("router-build-revision-pack", "alpha"); - GenerationKernelRegistry.Version version = new GenerationKernelRegistry.Version(1, 1, 1); - GenerationHistory original = createHistory(world, pack, version, kernels(version)); - GenerationKernelRegistry upgraded = new GenerationKernelRegistry(version, List.of( - new GenerationKernelRegistry.Kernel(1, "9".repeat(64), Map.of( - new GenerationKernelRegistry.AlgorithmVersion(1, 1), - (engine, plan) -> { throw new AssertionError("Mock runtime factory owns this test."); })))); - GenerationHistory history = GenerationHistory.open(world, upgraded); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initial = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initial); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, history, (ignored, x, z) -> signature(x, z), 256, runtimes)) { - assertEquals(2L, history.activeActivation().activationId()); - assertEquals(version, history.activeEpoch().kernelVersion()); - assertEquals("9".repeat(64), history.activeEpoch().kernelImplementationFingerprint()); - assertEquals(original.activeEpoch().packFingerprint(), history.activeEpoch().packFingerprint()); - assertEquals(0, runtimes.loadCount(1L)); - try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0)) { - assertEquals(2L, route.activation().activationId()); - } - } - } - - @Test - public void liveStudioPromotionPreservesChunksAndRoutesExpansionAcrossRepeatedUpdates() throws Exception { - Path world = temporaryFolder.newFolder("live-studio-world").toPath(); - Path packA = createPack("live-studio-a", "flat-lowland"); - Path packB = createPack("live-studio-b", "massive-mountains"); - Path packC = createPack("live-studio-c", "deep-ocean"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{0, 0}}); - byte[] original = Files.readAllBytes(region); - IrisEngine engine = mock(IrisEngine.class); - when(engine.isStudio()).thenReturn(true); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - AtomicReference scoped = installScopeTracking(engine); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0)) { - assertEquals(1L, stage.activation().activationId()); - } - stage(history, packB); - try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { - assertEquals(2L, cutover.promotePending().activationId()); - } - assertArrayEquals(original, Files.readAllBytes(region)); - try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(0, 0)) { - assertSame(runtimes.bindings.get(2L), scoped.get()); - assertEquals(2L, stage.activation().activationId()); - } - try (GenerationHistoryRuntimeRouter.RuntimeStage stage = router.openStage(1, 0)) { - assertSame(runtimes.bindings.get(2L), scoped.get()); - assertEquals(2L, stage.activation().activationId()); - } - writeRegion(region, new int[][]{{0, 0}, {1, 0}}); - byte[] expanded = Files.readAllBytes(region); - stage(history, packC); - try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { - assertEquals(3L, cutover.promotePending().activationId()); - } - assertArrayEquals(expanded, Files.readAllBytes(region)); - assertEquals(1L, history.resolveActivation(0, 0).activationId()); - assertEquals(2L, history.resolveActivation(1, 0).activationId()); - assertEquals(3L, history.resolveActivation(2, 0).activationId()); - } - GenerationHistory reopened = GenerationHistory.open(world); - assertEquals(1L, reopened.resolveActivation(0, 0).activationId()); - assertEquals(2L, reopened.resolveActivation(1, 0).activationId()); - assertEquals(3L, reopened.resolveActivation(2, 0).activationId()); - } - - @Test - public void liveStudioCutoverDrainsExistingRoutesAndBlocksNewRoutesUntilPublicationCompletes() throws Exception { - Path world = temporaryFolder.newFolder("studio-drain-world").toPath(); - Path pack = createPack("studio-drain-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - when(engine.isStudio()).thenReturn(true); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initialBinding = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initialBinding); - ExecutorService executor = Executors.newFixedThreadPool(2); - CountDownLatch cutoverRequested = new CountDownLatch(1); - CountDownLatch cutoverAcquired = new CountDownLatch(1); - CountDownLatch releaseCutover = new CountDownLatch(1); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - GenerationHistoryRuntimeRouter.RuntimeRoute initial = router.openRoute(0, 0); - try { - CompletableFuture cutover = CompletableFuture.runAsync(() -> { - cutoverRequested.countDown(); - try (GenerationHistoryRuntimeRouter.StudioCutover ignored = router.beginStudioCutover(5_000L)) { - cutoverAcquired.countDown(); - if (!releaseCutover.await(5, TimeUnit.SECONDS)) { - throw new IllegalStateException("Timed out waiting to release the Studio cutover."); - } - } catch (InterruptedException interrupted) { - Thread.currentThread().interrupt(); - throw new IllegalStateException(interrupted); - } - }, executor); - assertTrue(cutoverRequested.await(5, TimeUnit.SECONDS)); - assertFalse(cutoverAcquired.await(100, TimeUnit.MILLISECONDS)); - initial.close(); - assertTrue(cutoverAcquired.await(5, TimeUnit.SECONDS)); - CompletableFuture waiting = - CompletableFuture.supplyAsync(() -> openRouteUnchecked(router, 1, 0), executor); - assertThrows(TimeoutException.class, () -> waiting.get(100, TimeUnit.MILLISECONDS)); - releaseCutover.countDown(); - cutover.get(5, TimeUnit.SECONDS); - try (GenerationHistoryRuntimeRouter.RuntimeRoute route = waiting.get(5, TimeUnit.SECONDS)) { - assertEquals(1L, route.activation().activationId()); - } - } finally { - initial.close(); - releaseCutover.countDown(); - } - } finally { - releaseCutover.countDown(); - executor.shutdownNow(); - assertTrue(executor.awaitTermination(5, TimeUnit.SECONDS)); - } - } - - @Test - public void liveCutoverRejectsProductionWorldsAndNestedGenerationScopes() throws Exception { - Path world = temporaryFolder.newFolder("studio-guard-world").toPath(); - Path pack = createPack("studio-guard-pack", "alpha"); - GenerationHistory history = createHistory(world, pack); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding initialBinding = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(initialBinding); - installScopeTracking(engine); - try (GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attach( - engine, history, (ignored, x, z) -> signature(x, z), runtimes)) { - assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); - when(engine.isStudio()).thenReturn(true); - try (GenerationHistoryRuntimeRouter.RuntimeStage ignored = router.openStage(0, 0)) { - assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); - } - try (GenerationHistoryRuntimeRouter.StudioCutover cutover = router.beginStudioCutover(5_000L)) { - assertThrows(IllegalStateException.class, () -> router.beginStudioCutover(5_000L)); - assertEquals(1L, cutover.promotePending().activationId()); - } - } - } - - @Test - public void pendingOldRevisionPromotesWithoutLoadingItsArchivedImplementation() throws Exception { - Path world = temporaryFolder.newFolder("router-pending-kernel-world").toPath(); - Path packA = createPack("router-pending-kernel-a", "alpha"); - Path packB = createPack("router-pending-kernel-b", "beta"); - GenerationKernelRegistry.Version versionOne = new GenerationKernelRegistry.Version(1, 1, 1); - GenerationKernelRegistry.Version versionTwo = new GenerationKernelRegistry.Version(2, 1, 1); - GenerationKernelRegistry kernels = kernels(versionTwo); - GenerationHistory history = createHistory(world, packA, versionOne, kernels); - history.stageUpdate( - packB, - GenerationPackFingerprint.compute(packB, GenerationPackFingerprint.CURRENT_VERSION), - contract(), - GenerationRegistryContract.empty(), - 64, - versionOne - ); - IrisEngine engine = mock(IrisEngine.class); - FakeRuntimeFactory runtimes = new FakeRuntimeFactory(); - IrisEngine.GenerationRuntimeBinding first = runtimes.binding(history, history.activeActivation()); - when(engine.getActiveGenerationRuntimeBinding()).thenReturn(first); - installScopeTracking(engine); - - GenerationHistoryRuntimeRouter router = GenerationHistoryRuntimeRouter.attachAndPromotePending( - engine, - history, - (ignored, blockX, blockZ) -> signature(blockX, blockZ), - 64, - runtimes - ); - - assertEquals(3L, history.activeActivation().activationId()); - assertEquals(versionTwo, history.activeEpoch().kernelVersion()); - assertEquals(GenerationPackFingerprint.compute(packB, GenerationPackFingerprint.CURRENT_VERSION), - history.activeEpoch().packFingerprint()); - assertEquals(0, runtimes.loadCount(2L)); - verify(engine).setDefaultGenerationRuntime(runtimes.bindings.get(3L)); - router.close(); - } - - private static void routeUntilClosed(GenerationHistoryRuntimeRouter router, CountDownLatch routing) { - boolean started = false; - while (!Thread.currentThread().isInterrupted()) { - try (GenerationHistoryRuntimeRouter.RuntimeRoute route = router.openRoute(0, 0)) { - assertEquals(1L, route.activation().activationId()); - if (!started) { - started = true; - routing.countDown(); - } - } catch (IOException failure) { - throw new AssertionError(failure); - } catch (IllegalStateException closed) { - assertEquals("Generation-history runtime router is closed.", closed.getMessage()); - return; - } - } - } - - private AtomicReference installScopeTracking(IrisEngine engine) { - AtomicReference scoped = new AtomicReference<>(); - when(engine.openGenerationRuntimeScope(any())).thenAnswer(invocation -> { - IrisEngine.GenerationRuntimeBinding binding = invocation.getArgument(0); - scoped.set(binding); - IrisEngine.GenerationRuntimeScope scope = mock(IrisEngine.GenerationRuntimeScope.class); - doAnswer(ignored -> { - scoped.compareAndSet(binding, null); - return null; - }).when(scope).close(); - return scope; - }); - return scoped; - } - - private CompletableFuture openRouteAsync( - GenerationHistoryRuntimeRouter router, - ExecutorService executor, - CountDownLatch ready, - CountDownLatch start, - int chunkX, - int chunkZ - ) { - return CompletableFuture.supplyAsync(() -> { - ready.countDown(); - try { - if (!start.await(5L, TimeUnit.SECONDS)) { - throw new IllegalStateException("Timed out waiting to start concurrent route acquisition."); - } - } catch (InterruptedException interrupted) { - Thread.currentThread().interrupt(); - throw new IllegalStateException("Interrupted before concurrent route acquisition.", interrupted); - } - return openRouteUnchecked(router, chunkX, chunkZ); - }, executor); - } - - private static GenerationHistoryRuntimeRouter.RuntimeRoute openRouteUnchecked( - GenerationHistoryRuntimeRouter router, - int chunkX, - int chunkZ - ) { - try { - return router.openRoute(chunkX, chunkZ); - } catch (IOException failure) { - throw new IllegalStateException(failure); - } - } - - private static void awaitClosed(GenerationHistoryRuntimeRouter router) throws InterruptedException { - long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5L); - while (!router.isClosed() && System.nanoTime() < deadline) { - Thread.onSpinWait(); - } - assertTrue(router.isClosed()); - } - - private Path createPack(String name, String content) throws IOException { - Path pack = temporaryFolder.newFolder(name).toPath(); - Files.createDirectories(pack.resolve("dimensions")); - Files.writeString(pack.resolve("dimensions/main.json"), content); - return pack; - } - - private GenerationHistory createThreeActivationHistory(Path world, String prefix) throws IOException { - Path packA = createPack(prefix + "-a", "alpha"); - Path packB = createPack(prefix + "-b", "beta"); - Path packC = createPack(prefix + "-c", "gamma"); - GenerationHistory history = createHistory(world, packA); - Path region = Files.createDirectories(world.resolve("region")).resolve("r.0.0.mca"); - writeRegion(region, new int[][]{{0, 0}}); - stage(history, packB); - promoteWithSignatures(history); - writeRegion(region, new int[][]{{0, 0}, {1, 0}}); - stage(history, packC); - promoteWithSignatures(history); - return history; - } - - private static GenerationHistory createHistory(Path world, Path pack) throws IOException { - return GenerationHistory.create( - world, - pack, - GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION), - 42L, - contract(), - GenerationRegistryContract.empty() - ); - } - - private static GenerationHistory createHistory( - Path world, - Path pack, - GenerationKernelRegistry.Version version, - GenerationKernelRegistry kernels - ) throws IOException { - return GenerationHistory.create( - world, - pack, - GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION), - 42L, - contract(), - GenerationRegistryContract.empty(), - version, - kernels - ); - } - - private static GenerationKernelRegistry kernels(GenerationKernelRegistry.Version current) { - return new GenerationKernelRegistry( - current, - Set.of( - new GenerationKernelRegistry.Kernel( - 1, - "1".repeat(64), - Map.of( - new GenerationKernelRegistry.AlgorithmVersion(1, 1), - (engine, transitionPlan) -> { - throw new AssertionError("Mock runtime factory owns this test."); - } - ) - ), - new GenerationKernelRegistry.Kernel( - 2, - "2".repeat(64), - Map.of( - new GenerationKernelRegistry.AlgorithmVersion(1, 1), - (engine, transitionPlan) -> { - throw new AssertionError("Mock runtime factory owns this test."); - } - ) - ) - ) - ); - } - - private static GenerationActivation stage(GenerationHistory history, Path pack) throws IOException { - return history.stageUpdate( - pack, - GenerationPackFingerprint.compute(pack, GenerationPackFingerprint.CURRENT_VERSION), - contract(), - GenerationRegistryContract.empty(), - 256 - ); - } - - private static GenerationActivation promoteWithSignatures(GenerationHistory history) throws IOException { - return history.promotePending(boundary -> GenerationHistoryRuntimeRouterTest::signature); - } - - private static GenerationEpoch.DimensionContract contract() { - return new GenerationEpoch.DimensionContract( - "overworld", - "iris:overworld_type", - "NORMAL", - "OVERWORLD", - 127, - -64, - 384, - 384, - 1D, - false, - "none", - 0, - "0".repeat(64), - GenerationEpochContractFactory.CURRENT_DIMENSION_TYPE_FINGERPRINT_SCHEMA, - "c".repeat(64) - ); - } - - private static TerrainBoundarySignature signature(int blockX, int blockZ) { - return new TerrainBoundarySignature( - new TerrainBoundarySignature.Column(blockX, blockZ, 64, 63, OptionalInt.empty(), OptionalInt.empty()), - new TerrainBoundarySignature.Samples( - new TerrainBoundarySignature.VerticalLayout(-64, 64, 2), - new TerrainBoundarySignature.BiomeEncoding(List.of("iris:test"), new short[]{0, 0}) - ) - , BoundaryColumnGeometry.empty()); - } - - private static void writeRegion(Path file, int[][] chunks) throws IOException { - SavedTerrainTestRegion.write(file, chunks); - } - - private static final class FakeRuntimeFactory - implements GenerationHistoryRuntimeRouter.ActivationRuntimeFactory { - private final Map bindings = new HashMap<>(); - private final Map mantles = new HashMap<>(); - private final Map loadCounts = new HashMap<>(); - private GenerationKernelRegistry.Version loadedVersion; - private long blockedActivation = -1L; - private CountDownLatch loadStarted = new CountDownLatch(0); - private CountDownLatch releaseLoad = new CountDownLatch(0); - - @Override - public void validateBase( - IrisEngine engine, - GenerationHistory history, - GenerationActivation activation, - GenerationEpoch epoch, - IrisEngine.GenerationRuntimeBinding binding - ) { - if (engine.getGenerationSessions() == null) { - when(engine.getGenerationSessions()).thenReturn(new GenerationSessionManager(true)); - } - } - - @Override - public IrisEngine.GenerationRuntimeBinding load( - IrisEngine engine, - GenerationHistory history, - GenerationActivation activation, - GenerationEpoch epoch - ) throws IOException { - if (!epoch.kernelVersion().equals(history.currentKernelVersion()) - || !history.usesCurrentGenerator()) { - throw new AssertionError("Archived generator implementations must never load."); - } - synchronized (loadCounts) { - loadCounts.computeIfAbsent(activation.activationId(), ignored -> new AtomicInteger()).incrementAndGet(); - } - if (activation.activationId() == blockedActivation) { - loadStarted.countDown(); - try { - if (!releaseLoad.await(5L, TimeUnit.SECONDS)) { - throw new IOException("Timed out waiting to release the blocked runtime load."); - } - } catch (InterruptedException interrupted) { - Thread.currentThread().interrupt(); - throw new IOException("Interrupted while loading a test runtime.", interrupted); - } - } - GenerationKernelRegistry.Version version = loadedVersion == null - ? epoch.kernelVersion() - : loadedVersion; - return binding(history, activation, version); - } - - private void blockLoad(long activationId) { - blockedActivation = activationId; - loadStarted = new CountDownLatch(1); - releaseLoad = new CountDownLatch(1); - } - - private int loadCount(long activationId) { - synchronized (loadCounts) { - AtomicInteger count = loadCounts.get(activationId); - return count == null ? 0 : count.get(); - } - } - - private IrisEngine.GenerationRuntimeBinding binding( - GenerationHistory history, - GenerationActivation activation - ) throws IOException { - return binding(history, activation, requireEpoch(history, activation).kernelVersion()); - } - - private IrisEngine.GenerationRuntimeBinding binding( - GenerationHistory history, - GenerationActivation activation, - GenerationKernelRegistry.Version version - ) throws IOException { - GenerationEpoch epoch = requireEpoch(history, activation); - IrisEngine.GenerationRuntimeBinding binding = mock(IrisEngine.GenerationRuntimeBinding.class); - Path mantle = history.paths().activationMantleRoot(activation.activationId()); - TransitionGenerationPlan plan = activation.isInitial() - ? null - : history.transitionPlan(activation.activationId()); - when(binding.kernelVersion()).thenReturn(version); - when(binding.runtimeKernel()).thenReturn(new GenerationKernelRegistry.RuntimeKernel( - version, - epoch.kernelImplementationFingerprint(), - (engine, transitionPlan) -> mock(IrisComplex.class) - )); - when(binding.mantleStorageDirectory()).thenReturn(mantle); - when(binding.transitionPlan()).thenReturn(plan); - when(binding.runtimeId()).thenReturn(Math.toIntExact(activation.activationId())); - bindings.put(activation.activationId(), binding); - mantles.put(activation.activationId(), mantle); - return binding; - } - - private static GenerationEpoch requireEpoch( - GenerationHistory history, - GenerationActivation activation - ) { - return history.manifest().epoch(activation.epochId()).orElseThrow(); - } - } -} From 71e3af727f17d98601bc463b775d07ef522f945d Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:01:44 -0400 Subject: [PATCH 19/35] Parameterize template-identical tests - Split PackValidatorCustomBiomeSpawnTest into parameterized accepted and rejected suites plus the resolver-failure case - Drive IrisCarveWallPaletteScopeTest from its four generation-scope modes - Parameterize the legacy bilerp parity samples in IrisComplexGridBoundsCacheTest behind Enclosed - Parameterize the resolved bounds in IrisStructureYBandTest - Parameterize the entity key normalization in IrisBiomeCustomSpawnTest - Parameterize the platform identity in IrisWorldIdentityTest - Parameterize the layer lock in IrisBiomeLayerSlopeSourceTest --- .../PackValidatorCustomBiomeSpawnTest.java | 308 +++++++++--------- .../engine/IrisCarveWallPaletteScopeTest.java | 39 ++- .../IrisComplexGridBoundsCacheTest.java | 183 ++++++----- .../object/IrisBiomeCustomSpawnTest.java | 39 ++- .../object/IrisBiomeLayerSlopeSourceTest.java | 28 +- .../engine/object/IrisStructureYBandTest.java | 85 +++-- .../engine/object/IrisWorldIdentityTest.java | 30 +- 7 files changed, 381 insertions(+), 331 deletions(-) diff --git a/core/src/test/java/art/arcane/iris/core/pack/PackValidatorCustomBiomeSpawnTest.java b/core/src/test/java/art/arcane/iris/core/pack/PackValidatorCustomBiomeSpawnTest.java index d7d8ff772..1d0198487 100644 --- a/core/src/test/java/art/arcane/iris/core/pack/PackValidatorCustomBiomeSpawnTest.java +++ b/core/src/test/java/art/arcane/iris/core/pack/PackValidatorCustomBiomeSpawnTest.java @@ -2,178 +2,172 @@ package art.arcane.iris.core.pack; import org.junit.Rule; import org.junit.Test; +import org.junit.experimental.runners.Enclosed; import org.junit.rules.TemporaryFolder; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; import java.io.File; import java.nio.charset.StandardCharsets; import java.nio.file.Files; +import java.util.Collection; import java.util.List; +import java.util.function.Function; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; +@RunWith(Enclosed.class) public class PackValidatorCustomBiomeSpawnTest { - @Rule - public TemporaryFolder temporaryFolder = new TemporaryFolder(); + private static final Function MONSTER = + key -> PackSpawnValidator.SpawnCategoryResolution.known("monster"); + private static final Function MISC = + key -> PackSpawnValidator.SpawnCategoryResolution.known("misc"); + private static final Function AXOLOTLS = + key -> PackSpawnValidator.SpawnCategoryResolution.known("axolotls"); + private static final Function UNKNOWN = + key -> PackSpawnValidator.SpawnCategoryResolution.unknown(); - @Test - public void acceptsExplicitMatchingSpawnGroup() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MONSTER\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("monster")); - - assertTrue(errors.isEmpty()); - } - - @Test - public void acceptsBiomeWithoutCustomSpawns() throws Exception { - File biomes = createBiomes("{\"name\":\"Plains\"}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("monster")); - - assertTrue(errors.isEmpty()); - } - - @Test - public void rejectsMissingSpawnGroup() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("monster")); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("must declare group 'MONSTER'")); - } - - @Test - public void acceptsImplicitMiscSpawnGroup() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"effects\",\"spawns\":[{\"type\":\"minecraft:armor_stand\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("misc")); - - assertTrue(errors.isEmpty()); - } - - @Test - public void rejectsSpawnGroupThatDisagreesWithRegistry() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MISC\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("monster")); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("live entity registry requires 'MONSTER'")); - } - - @Test - public void acceptsAxolotlSpawnCategory() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"cave\",\"spawns\":[{\"type\":\"minecraft:axolotl\",\"group\":\"AXOLOTLS\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("axolotls")); - - assertTrue(errors.isEmpty()); - } - - @Test - public void rejectsUnknownSpawnEntity() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"missing:entity\",\"group\":\"MISC\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.unknown()); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("unknown entity type 'missing:entity'")); - } - - @Test - public void rejectsCaseNormalizedGroupThatRuntimeWouldNotParse() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"monster\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns( - biomes, key -> PackSpawnValidator.SpawnCategoryResolution.known("monster")); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("unknown group 'monster'")); - } - - @Test - public void rejectsWrongCustomDerivativeContainerType() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":{}}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("customDerivitives must be an array")); - } - - @Test - public void rejectsWrongSpawnContainerType() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":{}}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("spawns must be an array")); - } - - @Test - public void acceptsNullCustomDerivativeContainerAsAbsent() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":null}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertTrue(errors.isEmpty()); - } - - @Test - public void acceptsNullSpawnContainerAsAbsent() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":null}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertTrue(errors.isEmpty()); - } - - @Test - public void acceptsNamespacedCustomBiomeTags() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"tags\":[\"minecraft:allows_surface_slime_spawns\"]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertTrue(errors.isEmpty()); - } - - @Test - public void rejectsUnsafeCustomBiomeTags() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"tags\":[\"minecraft:../outside\"]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, null); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("invalid tag")); - } - - @Test - public void convertsSpawnCategoryResolverFailureIntoBlockingError() throws Exception { - File biomes = createBiomes("{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MONSTER\"}]}]}"); - - List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, key -> { - throw new IllegalStateException("registry unavailable"); - }); - - assertEquals(1, errors.size()); - assertTrue(errors.get(0).contains("spawn category lookup failed")); - assertTrue(errors.get(0).contains("registry unavailable")); - } - - private File createBiomes(String json) throws Exception { + private static File createBiomes(TemporaryFolder temporaryFolder, String json) throws Exception { File biomes = temporaryFolder.newFolder("biomes"); File biome = new File(biomes, "test.json"); Files.writeString(biome.toPath(), json, StandardCharsets.UTF_8); return biomes; } + + @RunWith(Parameterized.class) + public static class Accepted { + @Parameters(name = "{0}") + public static Collection biomes() { + return List.of( + new Object[]{"explicitMatchingSpawnGroup", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MONSTER\"}]}]}", + MONSTER}, + new Object[]{"biomeWithoutCustomSpawns", + "{\"name\":\"Plains\"}", + MONSTER}, + new Object[]{"implicitMiscSpawnGroup", + "{\"customDerivitives\":[{\"id\":\"effects\",\"spawns\":[{\"type\":\"minecraft:armor_stand\"}]}]}", + MISC}, + new Object[]{"axolotlSpawnCategory", + "{\"customDerivitives\":[{\"id\":\"cave\",\"spawns\":[{\"type\":\"minecraft:axolotl\",\"group\":\"AXOLOTLS\"}]}]}", + AXOLOTLS}, + new Object[]{"nullCustomDerivativeContainerAsAbsent", + "{\"customDerivitives\":null}", + null}, + new Object[]{"nullSpawnContainerAsAbsent", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":null}]}", + null}, + new Object[]{"namespacedCustomBiomeTags", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"tags\":[\"minecraft:allows_surface_slime_spawns\"]}]}", + null} + ); + } + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + private final String scenario; + private final String json; + private final Function categoryResolver; + + public Accepted( + String scenario, + String json, + Function categoryResolver + ) { + this.scenario = scenario; + this.json = json; + this.categoryResolver = categoryResolver; + } + + @Test + public void reportsNoSpawnErrors() throws Exception { + File biomes = createBiomes(temporaryFolder, json); + + List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, categoryResolver); + + assertTrue(scenario + " " + errors, errors.isEmpty()); + } + } + + @RunWith(Parameterized.class) + public static class Rejected { + @Parameters(name = "{0}") + public static Collection biomes() { + return List.of( + new Object[]{"missingSpawnGroup", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\"}]}]}", + MONSTER, "must declare group 'MONSTER'"}, + new Object[]{"spawnGroupThatDisagreesWithRegistry", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MISC\"}]}]}", + MONSTER, "live entity registry requires 'MONSTER'"}, + new Object[]{"unknownSpawnEntity", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"missing:entity\",\"group\":\"MISC\"}]}]}", + UNKNOWN, "unknown entity type 'missing:entity'"}, + new Object[]{"caseNormalizedGroupThatRuntimeWouldNotParse", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"monster\"}]}]}", + MONSTER, "unknown group 'monster'"}, + new Object[]{"wrongCustomDerivativeContainerType", + "{\"customDerivitives\":{}}", + null, "customDerivitives must be an array"}, + new Object[]{"wrongSpawnContainerType", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":{}}]}", + null, "spawns must be an array"}, + new Object[]{"unsafeCustomBiomeTags", + "{\"customDerivitives\":[{\"id\":\"swamp\",\"tags\":[\"minecraft:../outside\"]}]}", + null, "invalid tag"} + ); + } + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + private final String scenario; + private final String json; + private final Function categoryResolver; + private final String expectedError; + + public Rejected( + String scenario, + String json, + Function categoryResolver, + String expectedError + ) { + this.scenario = scenario; + this.json = json; + this.categoryResolver = categoryResolver; + this.expectedError = expectedError; + } + + @Test + public void reportsExactlyOneSpawnError() throws Exception { + File biomes = createBiomes(temporaryFolder, json); + + List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, categoryResolver); + + assertEquals(scenario + " " + errors, 1, errors.size()); + assertTrue(errors.get(0), errors.get(0).contains(expectedError)); + } + } + + public static class ResolverFailure { + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + @Test + public void convertsSpawnCategoryResolverFailureIntoBlockingError() throws Exception { + File biomes = createBiomes(temporaryFolder, + "{\"customDerivitives\":[{\"id\":\"swamp\",\"spawns\":[{\"type\":\"minecraft:slime\",\"group\":\"MONSTER\"}]}]}"); + + List errors = PackSpawnValidator.validateCustomBiomeSpawns(biomes, key -> { + throw new IllegalStateException("registry unavailable"); + }); + + assertEquals(1, errors.size()); + assertTrue(errors.get(0).contains("spawn category lookup failed")); + assertTrue(errors.get(0).contains("registry unavailable")); + } + } } diff --git a/core/src/test/java/art/arcane/iris/engine/IrisCarveWallPaletteScopeTest.java b/core/src/test/java/art/arcane/iris/engine/IrisCarveWallPaletteScopeTest.java index 84423ea8f..51f79f2e6 100644 --- a/core/src/test/java/art/arcane/iris/engine/IrisCarveWallPaletteScopeTest.java +++ b/core/src/test/java/art/arcane/iris/engine/IrisCarveWallPaletteScopeTest.java @@ -24,11 +24,16 @@ import art.arcane.volmlib.util.math.RNG; import art.arcane.volmlib.util.matter.Matter; import art.arcane.volmlib.util.matter.MatterCavern; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; import org.mockito.MockedStatic; import java.lang.reflect.Field; +import java.util.Collection; import java.util.Collections; import java.util.IdentityHashMap; +import java.util.List; import java.util.concurrent.atomic.AtomicInteger; import static org.junit.Assert.assertEquals; @@ -47,25 +52,27 @@ import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mockStatic; import static org.mockito.Mockito.verify; +@RunWith(Parameterized.class) public class IrisCarveWallPaletteScopeTest { - @Test - public void naturalWallsUseOneSelectedDataLookup() throws Exception { - verifyWalls(Mode.NATURAL); + @Parameters(name = "{0}") + public static Collection scopes() { + return List.of( + new Object[]{Mode.NATURAL}, + new Object[]{Mode.CONTENT}, + new Object[]{Mode.DETACHED}, + new Object[]{Mode.ASSEMBLY} + ); + } + + private final Mode mode; + + public IrisCarveWallPaletteScopeTest(Mode mode) { + this.mode = mode; } @Test - public void contentWallsRestoreDataAfterNestedSampling() throws Exception { - verifyWalls(Mode.CONTENT); - } - - @Test - public void detachedWallsUseDetachedData() throws Exception { - verifyWalls(Mode.DETACHED); - } - - @Test - public void assemblyWallsUseUnpublishedData() throws Exception { - verifyWalls(Mode.ASSEMBLY); + public void wallsUseTheDataOfTheirGenerationScope() throws Exception { + verifyWalls(mode); } private static void verifyWalls(Mode mode) throws Exception { @@ -159,7 +166,7 @@ public class IrisCarveWallPaletteScopeTest { return runtime; } - private enum Mode { + enum Mode { NATURAL, CONTENT, DETACHED, diff --git a/core/src/test/java/art/arcane/iris/engine/IrisComplexGridBoundsCacheTest.java b/core/src/test/java/art/arcane/iris/engine/IrisComplexGridBoundsCacheTest.java index 00dfa3d9a..dcdf5d5af 100644 --- a/core/src/test/java/art/arcane/iris/engine/IrisComplexGridBoundsCacheTest.java +++ b/core/src/test/java/art/arcane/iris/engine/IrisComplexGridBoundsCacheTest.java @@ -6,11 +6,17 @@ import art.arcane.iris.engine.object.IrisInterpolator; import art.arcane.iris.util.project.interpolation.NoiseBounds; import art.arcane.iris.util.project.interpolation.NoiseBoundsProvider; import org.junit.Test; +import org.junit.experimental.runners.Enclosed; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; import java.lang.reflect.Constructor; import java.lang.reflect.Field; import java.lang.reflect.Method; +import java.util.Collection; import java.util.HashMap; +import java.util.List; import java.util.concurrent.atomic.AtomicInteger; import static org.junit.Assert.assertEquals; @@ -19,109 +25,102 @@ import static org.junit.Assert.assertNotEquals; import static org.mockito.Answers.CALLS_REAL_METHODS; import static org.mockito.Mockito.mock; +@RunWith(Enclosed.class) public class IrisComplexGridBoundsCacheTest { + public static class CornerCache { @Test - public void gridBoundsCacheIsIsolatedPerComplex() throws Exception { - IrisComplex first = createComplex(); - IrisComplex second = createComplex(); - Method cornerBounds = cornerBoundsMethod(); + public void gridBoundsCacheIsIsolatedPerComplex() throws Exception { + IrisComplex first = createComplex(); + IrisComplex second = createComplex(); + Method cornerBounds = cornerBoundsMethod(); - long firstPacked = invokeCornerBounds(first, cornerBounds, new CountingInterpolator(1.25D, 2.5D), 64, -32); - long secondPacked = invokeCornerBounds(second, cornerBounds, new CountingInterpolator(10.25D, 20.5D), 64, -32); + long firstPacked = invokeCornerBounds(first, cornerBounds, new CountingInterpolator(1.25D, 2.5D), 64, -32); + long secondPacked = invokeCornerBounds(second, cornerBounds, new CountingInterpolator(10.25D, 20.5D), 64, -32); - assertNotEquals(firstPacked, secondPacked); - assertEquals(1.25F, unpackLow(firstPacked), 0D); - assertEquals(2.5F, unpackHigh(firstPacked), 0D); - assertEquals(10.25F, unpackLow(secondPacked), 0D); - assertEquals(20.5F, unpackHigh(secondPacked), 0D); - } + assertNotEquals(firstPacked, secondPacked); + assertEquals(1.25F, unpackLow(firstPacked), 0D); + assertEquals(2.5F, unpackHigh(firstPacked), 0D); + assertEquals(10.25F, unpackLow(secondPacked), 0D); + assertEquals(20.5F, unpackHigh(secondPacked), 0D); + } @Test - public void gridBoundsCacheReusesCornersWithinSameComplex() throws Exception { - IrisComplex complex = createComplex(); - Method cornerBounds = cornerBoundsMethod(); - CountingInterpolator interpolator = new CountingInterpolator(3.5D, 7.25D); + public void gridBoundsCacheReusesCornersWithinSameComplex() throws Exception { + IrisComplex complex = createComplex(); + Method cornerBounds = cornerBoundsMethod(); + CountingInterpolator interpolator = new CountingInterpolator(3.5D, 7.25D); - long firstPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); - long secondPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); + long firstPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); + long secondPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); - assertEquals(firstPacked, secondPacked); - assertEquals(1, interpolator.getInvocations()); - } + assertEquals(firstPacked, secondPacked); + assertEquals(1, interpolator.getInvocations()); + } @Test - public void nonFiniteCornerBoundsAreNeverCached() throws Exception { - IrisComplex complex = createComplex(); - Method cornerBounds = cornerBoundsMethod(); - CountingInterpolator interpolator = new CountingInterpolator(Double.NaN, 7.25D); + public void nonFiniteCornerBoundsAreNeverCached() throws Exception { + IrisComplex complex = createComplex(); + Method cornerBounds = cornerBoundsMethod(); + CountingInterpolator interpolator = new CountingInterpolator(Double.NaN, 7.25D); - long firstPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); - long secondPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); + long firstPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); + long secondPacked = invokeCornerBounds(complex, cornerBounds, interpolator, 128, 96); - assertTrue(Double.isNaN(unpackLow(firstPacked))); - assertTrue(Double.isNaN(unpackLow(secondPacked))); - assertEquals(2, interpolator.getInvocations()); - } + assertTrue(Double.isNaN(unpackLow(firstPacked))); + assertTrue(Double.isNaN(unpackLow(secondPacked))); + assertEquals(2, interpolator.getInvocations()); + } @Test - public void alignedGridSampleUsesOnlyTheContributingCorner() throws Exception { - IrisComplex complex = createComplex(); - Method gridSampleBounds = gridSampleBoundsMethod(); - CountingInterpolator interpolator = new CountingInterpolator(3.5D, 7.25D); + public void alignedGridSampleUsesOnlyTheContributingCorner() throws Exception { + IrisComplex complex = createComplex(); + Method gridSampleBounds = gridSampleBoundsMethod(); + CountingInterpolator interpolator = new CountingInterpolator(3.5D, 7.25D); - NoiseBounds bounds = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, 64D, -32D); + NoiseBounds bounds = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, 64D, -32D); - assertEquals(3.5F, bounds.min(), 0D); - assertEquals(7.25F, bounds.max(), 0D); - assertEquals(1, interpolator.getInvocations()); + assertEquals(3.5F, bounds.min(), 0D); + assertEquals(7.25F, bounds.max(), 0D); + assertEquals(1, interpolator.getInvocations()); + } } - @Test - public void horizontalGridAxisMatchesLegacyBilerpBitForBit() throws Exception { - IrisComplex complex = createComplex(); - Method gridSampleBounds = gridSampleBoundsMethod(); - CoordinateInterpolator interpolator = new CoordinateInterpolator(); - double x = 67D; - double z = -32D; + @RunWith(Parameterized.class) + public static class LegacyBilerpParity { + @Parameters(name = "x={0} z={1}") + public static Collection samples() { + return List.of( + new Object[]{67D, -32D, 2}, + new Object[]{-32D, -29D, 2}, + new Object[]{-29D, 67D, 4} + ); + } - NoiseBounds actual = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, x, z); - NoiseBounds expected = legacyGridSampleBounds(x, z); + private final double x; + private final double z; + private final int expectedInvocations; - assertBoundsBitsEqual(expected, actual); - assertEquals(2, interpolator.getInvocations()); + public LegacyBilerpParity(double x, double z, int expectedInvocations) { + this.x = x; + this.z = z; + this.expectedInvocations = expectedInvocations; + } + + @Test + public void gridSampleMatchesLegacyBilerpBitForBit() throws Exception { + IrisComplex complex = createComplex(); + Method gridSampleBounds = gridSampleBoundsMethod(); + CoordinateInterpolator interpolator = new CoordinateInterpolator(); + + NoiseBounds actual = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, x, z); + NoiseBounds expected = legacyGridSampleBounds(x, z); + + assertBoundsBitsEqual(expected, actual); + assertEquals(expectedInvocations, interpolator.getInvocations()); + } } - @Test - public void verticalGridAxisMatchesLegacyBilerpBitForBitAtNegativeCoordinates() throws Exception { - IrisComplex complex = createComplex(); - Method gridSampleBounds = gridSampleBoundsMethod(); - CoordinateInterpolator interpolator = new CoordinateInterpolator(); - double x = -32D; - double z = -29D; - - NoiseBounds actual = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, x, z); - NoiseBounds expected = legacyGridSampleBounds(x, z); - - assertBoundsBitsEqual(expected, actual); - assertEquals(2, interpolator.getInvocations()); - } - - @Test - public void interiorGridSampleMatchesLegacyBilerpBitForBit() throws Exception { - IrisComplex complex = createComplex(); - Method gridSampleBounds = gridSampleBoundsMethod(); - CoordinateInterpolator interpolator = new CoordinateInterpolator(); - double x = -29D; - double z = 67D; - - NoiseBounds actual = invokeGridSampleBounds(complex, gridSampleBounds, interpolator, x, z); - NoiseBounds expected = legacyGridSampleBounds(x, z); - - assertBoundsBitsEqual(expected, actual); - assertEquals(4, interpolator.getInvocations()); - } - - private IrisComplex createComplex() throws Exception { + private static IrisComplex createComplex() throws Exception { IrisComplex complex = mock(IrisComplex.class, CALLS_REAL_METHODS); Field generatorBounds = IrisComplex.class.getDeclaredField("generatorBounds"); @@ -138,7 +137,7 @@ public class IrisComplexGridBoundsCacheTest { return complex; } - private Object newCache(Constructor constructor) { + private static Object newCache(Constructor constructor) { try { return constructor.newInstance(); } catch (ReflectiveOperationException e) { @@ -146,7 +145,7 @@ public class IrisComplexGridBoundsCacheTest { } } - private Method cornerBoundsMethod() throws Exception { + private static Method cornerBoundsMethod() throws Exception { Class cacheClass = Class.forName("art.arcane.iris.engine.IrisComplex$GridBoundsCache"); Method method = IrisComplex.class.getDeclaredMethod( "cornerBounds", @@ -162,7 +161,7 @@ public class IrisComplexGridBoundsCacheTest { return method; } - private Method gridSampleBoundsMethod() throws Exception { + private static Method gridSampleBoundsMethod() throws Exception { Method method = IrisComplex.class.getDeclaredMethod( "gridSampleBounds", Engine.class, @@ -176,14 +175,14 @@ public class IrisComplexGridBoundsCacheTest { return method; } - private long invokeCornerBounds(IrisComplex complex, Method method, IrisInterpolator interpolator, int x, int z) throws Exception { + private static long invokeCornerBounds(IrisComplex complex, Method method, IrisInterpolator interpolator, int x, int z) throws Exception { Field gridBoundsCache = IrisComplex.class.getDeclaredField("gridBoundsCache"); gridBoundsCache.setAccessible(true); ThreadLocal cache = (ThreadLocal) gridBoundsCache.get(complex); return (long) method.invoke(complex, cache.get(), null, interpolator, 0, new IrisGenerator[0], x, z); } - private NoiseBounds invokeGridSampleBounds( + private static NoiseBounds invokeGridSampleBounds( IrisComplex complex, Method method, IrisInterpolator interpolator, @@ -193,7 +192,7 @@ public class IrisComplexGridBoundsCacheTest { return (NoiseBounds) method.invoke(complex, null, interpolator, 0, new IrisGenerator[0], x, z); } - private NoiseBounds legacyGridSampleBounds(double x, double z) { + private static NoiseBounds legacyGridSampleBounds(double x, double z) { int grid = 4; int xi = (int) Math.floor(x); int zi = (int) Math.floor(z); @@ -212,14 +211,14 @@ public class IrisComplexGridBoundsCacheTest { ); } - private NoiseBounds packedCoordinateBounds(int x, int z) { + private static NoiseBounds packedCoordinateBounds(int x, int z) { return new NoiseBounds( (float) CoordinateInterpolator.low(x, z), (float) CoordinateInterpolator.high(x, z) ); } - private double legacyBiLerp( + private static double legacyBiLerp( double v00, double v10, double v01, @@ -232,16 +231,16 @@ public class IrisComplexGridBoundsCacheTest { return a + ((b - a) * fz); } - private void assertBoundsBitsEqual(NoiseBounds expected, NoiseBounds actual) { + private static void assertBoundsBitsEqual(NoiseBounds expected, NoiseBounds actual) { assertEquals(Double.doubleToRawLongBits(expected.min()), Double.doubleToRawLongBits(actual.min())); assertEquals(Double.doubleToRawLongBits(expected.max()), Double.doubleToRawLongBits(actual.max())); } - private float unpackLow(long packed) { + private static float unpackLow(long packed) { return Float.intBitsToFloat((int) (packed >>> 32)); } - private float unpackHigh(long packed) { + private static float unpackHigh(long packed) { return Float.intBitsToFloat((int) packed); } diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCustomSpawnTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCustomSpawnTest.java index 47548d9a8..b0bd91d2f 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCustomSpawnTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeCustomSpawnTest.java @@ -1,29 +1,38 @@ package art.arcane.iris.engine.object; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Collection; +import java.util.List; import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertNull; +@RunWith(Parameterized.class) public class IrisBiomeCustomSpawnTest { - @Test - public void normalizesNamespacedEntityKey() { - IrisBiomeCustomSpawn spawn = new IrisBiomeCustomSpawn().setType(" Minecraft:Slime "); + @Parameters(name = "{0} -> {1}") + public static Collection keys() { + return List.of( + new Object[]{" Minecraft:Slime ", "minecraft:slime"}, + new Object[]{"Slime", "minecraft:slime"}, + new Object[]{" ", null} + ); + } - assertEquals("minecraft:slime", spawn.getTypeKey()); + private final String authored; + private final String expectedKey; + + public IrisBiomeCustomSpawnTest(String authored, String expectedKey) { + this.authored = authored; + this.expectedKey = expectedKey; } @Test - public void prefixesBareEntityKey() { - IrisBiomeCustomSpawn spawn = new IrisBiomeCustomSpawn().setType("Slime"); + public void normalizesTheEntityKey() { + IrisBiomeCustomSpawn spawn = new IrisBiomeCustomSpawn().setType(authored); - assertEquals("minecraft:slime", spawn.getTypeKey()); - } - - @Test - public void returnsNullForBlankEntityKey() { - IrisBiomeCustomSpawn spawn = new IrisBiomeCustomSpawn().setType(" "); - - assertNull(spawn.getTypeKey()); + assertEquals(expectedKey, spawn.getTypeKey()); } } diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeLayerSlopeSourceTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeLayerSlopeSourceTest.java index ed445edb6..23f77061e 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeLayerSlopeSourceTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisBiomeLayerSlopeSourceTest.java @@ -8,6 +8,12 @@ import art.arcane.iris.util.project.stream.ProceduralStream; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.math.RNG; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Collection; +import java.util.List; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertSame; @@ -17,19 +23,25 @@ import static org.mockito.ArgumentMatchers.same; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.when; +@RunWith(Parameterized.class) public final class IrisBiomeLayerSlopeSourceTest { - @Test - public void explicitSlopeStreamControlsSurfacePaletteSelection() { - assertExplicitSlopeStreamControlsSurfacePaletteSelection(false); + @Parameters(name = "lockLayers={0}") + public static Collection layerLocks() { + return List.of( + new Object[]{false}, + new Object[]{true} + ); + } + + private final boolean lockLayers; + + public IrisBiomeLayerSlopeSourceTest(boolean lockLayers) { + this.lockLayers = lockLayers; } @Test - public void explicitSlopeStreamControlsLockedSurfacePaletteSelection() { - assertExplicitSlopeStreamControlsSurfacePaletteSelection(true); - } - @SuppressWarnings("unchecked") - private static void assertExplicitSlopeStreamControlsSurfacePaletteSelection(boolean lockLayers) { + public void explicitSlopeStreamControlsSurfacePaletteSelection() { IrisData data = mock(IrisData.class); IrisComplex hostComplex = mock(IrisComplex.class); ProceduralStream hostSlope = mock(ProceduralStream.class); diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisStructureYBandTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisStructureYBandTest.java index 51ea7bf81..5ed7ded0f 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisStructureYBandTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisStructureYBandTest.java @@ -3,51 +3,68 @@ package art.arcane.iris.engine.object; import art.arcane.iris.engine.object.annotations.MaxNumber; import art.arcane.iris.engine.object.annotations.MinNumber; import org.junit.Test; +import org.junit.experimental.runners.Enclosed; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; import java.lang.reflect.Field; +import java.util.Collection; +import java.util.List; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; +@RunWith(Enclosed.class) public class IrisStructureYBandTest { - @Test - public void authoredBoundsResolveInOrder() { - IrisStructureYBand band = new IrisStructureYBand().setMin(-120).setMax(-20); + @RunWith(Parameterized.class) + public static class Resolution { + @Parameters(name = "min={0} max={1}") + public static Collection bands() { + return List.of( + new Object[]{-120, -20, -120, -20}, + new Object[]{-20, -120, -120, -20}, + new Object[]{-64, -64, -64, -64} + ); + } - assertEquals(-120, band.resolvedMin()); - assertEquals(-20, band.resolvedMax()); + private final int min; + private final int max; + private final int expectedMin; + private final int expectedMax; + + public Resolution(int min, int max, int expectedMin, int expectedMax) { + this.min = min; + this.max = max; + this.expectedMin = expectedMin; + this.expectedMax = expectedMax; + } + + @Test + public void authoredBoundsResolveInOrder() { + IrisStructureYBand band = new IrisStructureYBand().setMin(min).setMax(max); + + assertEquals(expectedMin, band.resolvedMin()); + assertEquals(expectedMax, band.resolvedMax()); + } } - @Test - public void reversedBoundsNormalizeInsteadOfInverting() { - IrisStructureYBand band = new IrisStructureYBand().setMin(-20).setMax(-120); + public static class SchemaBounds { + @Test + public void numericSchemaBoundsCoverTheWholeBuildRange() throws NoSuchFieldException { + assertBounds("min"); + assertBounds("max"); + } - assertEquals(-120, band.resolvedMin()); - assertEquals(-20, band.resolvedMax()); - } + private void assertBounds(String fieldName) throws NoSuchFieldException { + Field field = IrisStructureYBand.class.getDeclaredField(fieldName); + MinNumber minimum = field.getAnnotation(MinNumber.class); + MaxNumber maximum = field.getAnnotation(MaxNumber.class); - @Test - public void collapsedBoundsResolveToASingleY() { - IrisStructureYBand band = new IrisStructureYBand().setMin(-64).setMax(-64); - - assertEquals(-64, band.resolvedMin()); - assertEquals(-64, band.resolvedMax()); - } - - @Test - public void numericSchemaBoundsCoverTheWholeBuildRange() throws NoSuchFieldException { - assertBounds("min"); - assertBounds("max"); - } - - private void assertBounds(String fieldName) throws NoSuchFieldException { - Field field = IrisStructureYBand.class.getDeclaredField(fieldName); - MinNumber minimum = field.getAnnotation(MinNumber.class); - MaxNumber maximum = field.getAnnotation(MaxNumber.class); - - assertNotNull(minimum); - assertNotNull(maximum); - assertEquals(-4064D, minimum.value(), 0D); - assertEquals(4064D, maximum.value(), 0D); + assertNotNull(minimum); + assertNotNull(maximum); + assertEquals(-4064D, minimum.value(), 0D); + assertEquals(4064D, maximum.value(), 0D); + } } } diff --git a/core/src/test/java/art/arcane/iris/engine/object/IrisWorldIdentityTest.java b/core/src/test/java/art/arcane/iris/engine/object/IrisWorldIdentityTest.java index f98b260c6..991582ceb 100644 --- a/core/src/test/java/art/arcane/iris/engine/object/IrisWorldIdentityTest.java +++ b/core/src/test/java/art/arcane/iris/engine/object/IrisWorldIdentityTest.java @@ -1,25 +1,37 @@ package art.arcane.iris.engine.object; import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.Parameterized; +import org.junit.runners.Parameterized.Parameters; + +import java.util.Collection; +import java.util.List; import static org.junit.Assert.assertEquals; +@RunWith(Parameterized.class) public class IrisWorldIdentityTest { - @Test - public void usesPlatformIdentity() { - IrisWorld world = IrisWorld.builder() - .platformIdentity("iris:bukkit") - .build(); + @Parameters(name = "{0}") + public static Collection identities() { + return List.of( + new Object[]{"iris:bukkit"}, + new Object[]{"minecraft:the_nether"} + ); + } - assertEquals("iris:bukkit", world.identity()); + private final String platformIdentity; + + public IrisWorldIdentityTest(String platformIdentity) { + this.platformIdentity = platformIdentity; } @Test - public void preservesModdedIdentity() { + public void preservesThePlatformIdentity() { IrisWorld world = IrisWorld.builder() - .platformIdentity("minecraft:the_nether") + .platformIdentity(platformIdentity) .build(); - assertEquals("minecraft:the_nether", world.identity()); + assertEquals(platformIdentity, world.identity()); } } From 290412b62a7029431bc5bf96c64e46fea13ba430 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:16:40 -0400 Subject: [PATCH 20/35] Cover untested contract surfaces - Add a test source set to spi with bind, service registry and platform value contracts - Prove the DataType probe contract, the ExternalDataProvider defaults and the string-only provider namespace claims - Prove Identifier parsing and rendering - Cover the data version, primitive and vector director handlers - Cover the vanilla export identifier, block state, orientation, request and settings values - Cover the structure adoption limits, diagnostics and result invariants - Cover the pregen mantle backpressure, heap reclaim urgency, empty cache, listener defaults and diagnostic descriptions --- .../arcane/iris/core/link/IdentifierTest.java | 48 +++++ .../link/data/DataTypeProbeContractTest.java | 156 +++++++++++++++ .../ExternalDataProviderDefaultsTest.java | 110 +++++++++++ .../link/data/ProviderNamespaceClaimTest.java | 90 +++++++++ .../MantleHeapPressureUrgencyTest.java | 47 +++++ .../PregenDiagnosticsDescriptionTest.java | 40 ++++ .../PregenListenerDefaultsTest.java | 104 ++++++++++ .../PregenMantleBackpressureTest.java | 152 ++++++++++++++ .../cache/PregenCacheDefaultsTest.java | 43 ++++ .../IrisStructureAdoptionValueTest.java | 187 ++++++++++++++++++ .../export/VanillaBlockStateTest.java | 73 +++++++ .../VanillaJigsawExportRequestTest.java | 124 ++++++++++++ .../export/VanillaResourceIdentifierTest.java | 66 +++++++ ...nillaStructureTemplateOrientationTest.java | 50 +++++ .../handlers/DataVersionHandlerTest.java | 56 ++++++ .../handlers/PrimitiveHandlerParsingTest.java | 94 +++++++++ .../handlers/VectorHandlerParsingTest.java | 144 ++++++++++++++ spi/build.gradle | 4 + .../spi/IrisPlatformsBindContractTest.java | 172 ++++++++++++++++ .../spi/IrisServicesRegistryContractTest.java | 93 +++++++++ .../iris/spi/PlatformValueContractTest.java | 177 +++++++++++++++++ 21 files changed, 2030 insertions(+) create mode 100644 core/src/test/java/art/arcane/iris/core/link/IdentifierTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/link/data/DataTypeProbeContractTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/link/data/ExternalDataProviderDefaultsTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/link/data/ProviderNamespaceClaimTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/MantleHeapPressureUrgencyTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsDescriptionTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenListenerDefaultsTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressureTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheDefaultsTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/structure/conversion/IrisStructureAdoptionValueTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/structure/export/VanillaBlockStateTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawExportRequestTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/structure/export/VanillaResourceIdentifierTest.java create mode 100644 core/src/test/java/art/arcane/iris/core/structure/export/VanillaStructureTemplateOrientationTest.java create mode 100644 core/src/test/java/art/arcane/iris/util/common/director/handlers/DataVersionHandlerTest.java create mode 100644 core/src/test/java/art/arcane/iris/util/common/director/handlers/PrimitiveHandlerParsingTest.java create mode 100644 core/src/test/java/art/arcane/iris/util/common/director/handlers/VectorHandlerParsingTest.java create mode 100644 spi/src/test/java/art/arcane/iris/spi/IrisPlatformsBindContractTest.java create mode 100644 spi/src/test/java/art/arcane/iris/spi/IrisServicesRegistryContractTest.java create mode 100644 spi/src/test/java/art/arcane/iris/spi/PlatformValueContractTest.java diff --git a/core/src/test/java/art/arcane/iris/core/link/IdentifierTest.java b/core/src/test/java/art/arcane/iris/core/link/IdentifierTest.java new file mode 100644 index 000000000..c3ddcd990 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/link/IdentifierTest.java @@ -0,0 +1,48 @@ +package art.arcane.iris.core.link; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; + +public class IdentifierTest { + @Test + public void abareKeyIsQualifiedIntoTheMinecraftNamespace() { + Identifier identifier = Identifier.fromString("stone"); + + assertEquals("minecraft", identifier.namespace()); + assertEquals("stone", identifier.key()); + } + + @Test + public void aQualifiedKeyKeepsBothHalves() { + Identifier identifier = Identifier.fromString("oraxen:ruby_ore"); + + assertEquals("oraxen", identifier.namespace()); + assertEquals("ruby_ore", identifier.key()); + } + + @Test + public void onlyTheFirstSeparatorSplitsTheIdentifier() { + Identifier identifier = Identifier.fromString("itemsadder:rocks/ruby:ore"); + + assertEquals("itemsadder", identifier.namespace()); + assertEquals("rocks/ruby:ore", identifier.key()); + } + + @Test + public void aLeadingSeparatorProducesAnEmptyNamespaceRatherThanADefault() { + Identifier identifier = Identifier.fromString(":ruby_ore"); + + assertEquals("", identifier.namespace()); + assertEquals("ruby_ore", identifier.key()); + } + + @Test + public void theRenderedFormRoundTripsThroughTheParser() { + Identifier identifier = new Identifier("nexo", "village/lamp"); + + assertEquals("nexo:village/lamp", identifier.toString()); + assertEquals(identifier, Identifier.fromString(identifier.toString())); + assertEquals(Identifier.fromString("stone"), Identifier.fromString("minecraft:stone")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/link/data/DataTypeProbeContractTest.java b/core/src/test/java/art/arcane/iris/core/link/data/DataTypeProbeContractTest.java new file mode 100644 index 000000000..b61bfc101 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/link/data/DataTypeProbeContractTest.java @@ -0,0 +1,156 @@ +package art.arcane.iris.core.link.data; + +import art.arcane.iris.core.link.ExternalDataProvider; +import art.arcane.iris.core.link.Identifier; +import art.arcane.volmlib.util.collection.KMap; +import org.bukkit.block.data.BlockData; +import org.bukkit.inventory.ItemStack; +import org.jetbrains.annotations.NotNull; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.MissingResourceException; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; + +public class DataTypeProbeContractTest { + private static final Identifier RUBY = new Identifier("testplugin", "ruby_ore"); + + @Test + public void anUnclaimedIdentifierIsRejectedWithoutProbingTheProvider() { + RecordingProvider provider = new RecordingProvider(false, true, true); + + assertFalse(DataType.BLOCK.test(provider, RUBY)); + assertFalse(DataType.ITEM.test(provider, RUBY)); + assertFalse(DataType.ENTITY.test(provider, RUBY)); + assertEquals(List.of(), provider.probes); + } + + @Test + public void aClaimedBlockIsProbedThroughTheStatelessBlockLookup() { + RecordingProvider provider = new RecordingProvider(true, true, true); + + assertTrue(DataType.BLOCK.test(provider, RUBY)); + assertEquals(List.of("block"), provider.probes); + } + + @Test + public void aClaimedItemIsProbedThroughTheStatelessItemLookup() { + RecordingProvider provider = new RecordingProvider(true, true, true); + + assertTrue(DataType.ITEM.test(provider, RUBY)); + assertEquals(List.of("item"), provider.probes); + } + + @Test + public void aClaimedEntityIsAcceptedOnTheClaimAlone() { + RecordingProvider provider = new RecordingProvider(true, false, false); + + assertTrue(DataType.ENTITY.test(provider, RUBY)); + assertEquals(List.of(), provider.probes); + } + + @Test + public void aMissingResourceDowngradesTheClaimInsteadOfFailing() { + RecordingProvider provider = new RecordingProvider(true, false, false); + + assertFalse(DataType.BLOCK.test(provider, RUBY)); + assertFalse(DataType.ITEM.test(provider, RUBY)); + assertEquals(List.of("block", "item"), provider.probes); + } + + @Test + public void anUnexpectedProviderFailureIsNotSwallowed() { + ExplodingProvider provider = new ExplodingProvider(); + + assertThrows(IllegalStateException.class, () -> DataType.BLOCK.test(provider, RUBY)); + } + + @Test + public void thePredicateFormFiltersEveryElementThroughTheSameProvider() { + RecordingProvider provider = new RecordingProvider(true, true, true); + List claimed = List.of(RUBY, new Identifier("other", "quartz")); + + List filtered = claimed.stream().filter(DataType.BLOCK.asPredicate(provider)).toList(); + + assertEquals(claimed, filtered); + assertEquals(List.of("block", "block"), provider.probes); + } + + private static final class RecordingProvider extends ExternalDataProvider { + private final List probes = new ArrayList<>(); + private final boolean claims; + private final boolean resolvesBlocks; + private final boolean resolvesItems; + + private RecordingProvider(boolean claims, boolean resolvesBlocks, boolean resolvesItems) { + super("TestPlugin"); + this.claims = claims; + this.resolvesBlocks = resolvesBlocks; + this.resolvesItems = resolvesItems; + } + + @Override + public void init() { + } + + @Override + public @NotNull BlockData getBlockData(@NotNull Identifier blockId, @NotNull KMap state) { + probes.add("block"); + if (!resolvesBlocks) { + throw new MissingResourceException("no block", blockId.namespace(), blockId.key()); + } + return mock(BlockData.class); + } + + @Override + public @NotNull ItemStack getItemStack(@NotNull Identifier itemId, @NotNull KMap customNbt) { + probes.add("item"); + if (!resolvesItems) { + throw new MissingResourceException("no item", itemId.namespace(), itemId.key()); + } + return mock(ItemStack.class); + } + + @Override + public @NotNull Collection<@NotNull Identifier> getTypes(@NotNull DataType dataType) { + return List.of(); + } + + @Override + public boolean isValidProvider(@NotNull Identifier id, DataType dataType) { + return claims; + } + } + + private static final class ExplodingProvider extends ExternalDataProvider { + private ExplodingProvider() { + super("TestPlugin"); + } + + @Override + public void init() { + } + + @Override + public @NotNull BlockData getBlockData(@NotNull Identifier blockId, @NotNull KMap state) { + throw new IllegalStateException("the provider backend is broken"); + } + + @Override + public @NotNull Collection<@NotNull Identifier> getTypes(@NotNull DataType dataType) { + return List.of(); + } + + @Override + public boolean isValidProvider(@NotNull Identifier id, DataType dataType) { + return true; + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/link/data/ExternalDataProviderDefaultsTest.java b/core/src/test/java/art/arcane/iris/core/link/data/ExternalDataProviderDefaultsTest.java new file mode 100644 index 000000000..a71f0bf87 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/link/data/ExternalDataProviderDefaultsTest.java @@ -0,0 +1,110 @@ +package art.arcane.iris.core.link.data; + +import art.arcane.iris.core.link.ExternalDataProvider; +import art.arcane.iris.core.link.Identifier; +import art.arcane.volmlib.util.collection.KMap; +import org.bukkit.Location; +import org.bukkit.block.data.BlockData; +import org.bukkit.inventory.ItemStack; +import org.jetbrains.annotations.NotNull; +import org.junit.Test; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.MissingResourceException; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; + +public class ExternalDataProviderDefaultsTest { + private static final Identifier RUBY = new Identifier("testplugin", "ruby_ore"); + + @Test + public void theProviderRemembersThePluginItSpeaksFor() { + assertEquals("TestPlugin", new StatelessProvider().getPluginId()); + } + + @Test + public void aProviderWithoutAPluginIdIsRejected() { + assertThrows(NullPointerException.class, () -> new StatelessProvider(null)); + } + + @Test + public void anUnimplementedProviderRefusesEveryResourceKind() { + StatelessProvider provider = new StatelessProvider(); + + MissingResourceException blockFailure = + assertThrows(MissingResourceException.class, () -> provider.getBlockData(RUBY)); + MissingResourceException itemFailure = + assertThrows(MissingResourceException.class, () -> provider.getItemStack(RUBY)); + + assertEquals("testplugin", blockFailure.getClassName()); + assertEquals("ruby_ore", blockFailure.getKey()); + assertEquals("testplugin", itemFailure.getClassName()); + assertEquals("ruby_ore", itemFailure.getKey()); + assertThrows(MissingResourceException.class, () -> provider.spawnMob(mock(Location.class), RUBY)); + } + + @Test + public void anUnimplementedProviderExposesNoBlockProperties() { + assertTrue(new StatelessProvider().getBlockProperties(RUBY).isEmpty()); + } + + @Test + public void theStatelessLookupsDelegateWithAnEmptyStateMap() { + DelegationProvider provider = new DelegationProvider(); + + provider.getBlockData(RUBY); + provider.getItemStack(RUBY); + + assertEquals(List.of("block:0", "item:0"), provider.calls); + } + + @Test + public void deferredPlacementIsANoOpUntilAProviderImplementsIt() { + new StatelessProvider().processUpdate(null, null, RUBY); + } + + private static class StatelessProvider extends ExternalDataProvider { + private StatelessProvider() { + super("TestPlugin"); + } + + private StatelessProvider(String pluginId) { + super(pluginId); + } + + @Override + public void init() { + } + + @Override + public @NotNull Collection<@NotNull Identifier> getTypes(@NotNull DataType dataType) { + return List.of(); + } + + @Override + public boolean isValidProvider(@NotNull Identifier id, DataType dataType) { + return false; + } + } + + private static final class DelegationProvider extends StatelessProvider { + private final List calls = new ArrayList<>(); + + @Override + public @NotNull BlockData getBlockData(@NotNull Identifier blockId, @NotNull KMap state) { + calls.add("block:" + state.size()); + return mock(BlockData.class); + } + + @Override + public @NotNull ItemStack getItemStack(@NotNull Identifier itemId, @NotNull KMap customNbt) { + calls.add("item:" + customNbt.size()); + return mock(ItemStack.class); + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/link/data/ProviderNamespaceClaimTest.java b/core/src/test/java/art/arcane/iris/core/link/data/ProviderNamespaceClaimTest.java new file mode 100644 index 000000000..a99c4b957 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/link/data/ProviderNamespaceClaimTest.java @@ -0,0 +1,90 @@ +package art.arcane.iris.core.link.data; + +import art.arcane.iris.core.link.Identifier; +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +public class ProviderNamespaceClaimTest { + @Test + public void ecoItemsClaimsOnlyItemsInItsOwnNamespace() { + EcoItemsDataProvider provider = new EcoItemsDataProvider(); + + assertTrue(provider.isValidProvider(new Identifier("ecoitems", "ruby"), DataType.ITEM)); + assertTrue(provider.isValidProvider(new Identifier("EcoItems", "ruby"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("ecoitems", "ruby"), DataType.BLOCK)); + assertFalse(provider.isValidProvider(new Identifier("ecoitems", "ruby"), DataType.ENTITY)); + assertFalse(provider.isValidProvider(new Identifier("oraxen", "ruby"), DataType.ITEM)); + } + + @Test + public void executableItemsClaimsOnlyItemsInItsOwnNamespace() { + ExecutableItemsDataProvider provider = new ExecutableItemsDataProvider(); + + assertTrue(provider.isValidProvider(new Identifier("executable_items", "wand"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("executable_items", "wand"), DataType.BLOCK)); + assertFalse(provider.isValidProvider(new Identifier("executableitems", "wand"), DataType.ITEM)); + } + + @Test + public void kgeneratorsClaimsItemsWithoutConsultingTheGeneratorRegistry() { + KGeneratorsDataProvider provider = new KGeneratorsDataProvider(); + + assertTrue(provider.isValidProvider(new Identifier("kgenerators", "cobble"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("kgenerators", "cobble"), DataType.ENTITY)); + assertFalse(provider.isValidProvider(new Identifier("oraxen", "cobble"), DataType.ITEM)); + } + + @Test + public void mmoItemsEncodesItsItemTypeInTheNamespace() { + MMOItemsDataProvider provider = new MMOItemsDataProvider(); + + assertTrue(provider.isValidProvider(new Identifier("mmoitems_sword", "excalibur"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("mmoitems", "excalibur"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("mmoitems_sword", "excalibur"), DataType.ENTITY)); + assertFalse(provider.isValidProvider(new Identifier("MMOITEMS", "1"), DataType.BLOCK)); + } + + @Test + public void mythicCrucibleClaimsItemsWithoutConsultingItsItemManager() { + MythicCrucibleDataProvider provider = new MythicCrucibleDataProvider(); + + assertTrue(provider.isValidProvider(new Identifier("crucible", "ruby"), DataType.ITEM)); + assertTrue(provider.isValidProvider(new Identifier("Crucible", "ruby"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("crucible", "ruby"), DataType.ENTITY)); + assertFalse(provider.isValidProvider(new Identifier("oraxen", "ruby"), DataType.ITEM)); + } + + @Test + public void oraxenRefusesForeignNamespacesBeforeTouchingItsApi() { + OraxenDataProvider provider = new OraxenDataProvider(); + + assertFalse(provider.isValidProvider(new Identifier("nexo", "ruby_ore"), DataType.BLOCK)); + assertFalse(provider.isValidProvider(new Identifier("nexo", "ruby_ore"), DataType.ITEM)); + assertEquals(List.of(), provider.getTypes(DataType.ENTITY)); + } + + @Test + public void nexoRefusesForeignNamespacesBeforeTouchingItsApi() { + NexoDataProvider provider = new NexoDataProvider(); + + assertFalse(provider.isValidProvider(new Identifier("oraxen", "lamp"), DataType.BLOCK)); + assertFalse(provider.isValidProvider(new Identifier("oraxen", "lamp"), DataType.ITEM)); + assertEquals(List.of(), provider.getTypes(DataType.ENTITY)); + } + + @Test + public void itemsAdderClaimsNothingBeforeItsRegistryHasLoaded() { + ItemAdderDataProvider provider = new ItemAdderDataProvider(); + + assertFalse(provider.isValidProvider(new Identifier("rocks", "ruby_ore"), DataType.ITEM)); + assertFalse(provider.isValidProvider(new Identifier("rocks", "ruby_ore"), DataType.BLOCK)); + assertFalse(provider.isValidProvider(new Identifier("rocks", "ruby_ore"), DataType.ENTITY)); + assertTrue(provider.getTypes(DataType.ITEM).isEmpty()); + assertTrue(provider.getTypes(DataType.BLOCK).isEmpty()); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/MantleHeapPressureUrgencyTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/MantleHeapPressureUrgencyTest.java new file mode 100644 index 000000000..d530d419e --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/MantleHeapPressureUrgencyTest.java @@ -0,0 +1,47 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class MantleHeapPressureUrgencyTest { + @Test + public void headroomBelowTheLowWaterMarkAsksForNothing() { + assertEquals(0D, MantleHeapPressure.reclaimUrgency(0D), 0D); + assertEquals(0D, MantleHeapPressure.reclaimUrgency(0.5D), 0D); + assertEquals(0D, MantleHeapPressure.reclaimUrgency(0.82D), 0D); + } + + @Test + public void pressureAtOrAboveTheHighWaterMarkIsFullyUrgent() { + assertEquals(1D, MantleHeapPressure.reclaimUrgency(0.92D), 0D); + assertEquals(1D, MantleHeapPressure.reclaimUrgency(0.99D), 0D); + assertEquals(1D, MantleHeapPressure.reclaimUrgency(4D), 0D); + } + + @Test + public void pressureBetweenTheMarksRampsLinearly() { + assertEquals(0.25D, MantleHeapPressure.reclaimUrgency(0.845D), 1.0E-9D); + assertEquals(0.5D, MantleHeapPressure.reclaimUrgency(0.87D), 1.0E-9D); + assertEquals(0.75D, MantleHeapPressure.reclaimUrgency(0.895D), 1.0E-9D); + } + + @Test + public void urgencyNeverDecreasesAsPressureRises() { + double previous = -1D; + + for (int step = 0; step <= 100; step++) { + double urgency = MantleHeapPressure.reclaimUrgency(step / 100D); + assertTrue("urgency dropped at " + step, urgency >= previous); + previous = urgency; + } + } + + @Test + public void unmeasurableHeapPressureAsksForNothing() { + assertEquals(0D, MantleHeapPressure.reclaimUrgency(Double.NaN), 0D); + assertEquals(0D, MantleHeapPressure.reclaimUrgency(Double.POSITIVE_INFINITY), 0D); + assertEquals(0D, MantleHeapPressure.reclaimUrgency(Double.NEGATIVE_INFINITY), 0D); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsDescriptionTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsDescriptionTest.java new file mode 100644 index 000000000..5c9c929e2 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenDiagnosticsDescriptionTest.java @@ -0,0 +1,40 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; + +public class PregenDiagnosticsDescriptionTest { + @Test + public void anUnnamedProbeStillReadsAsAProbe() { + assertEquals("unnamed", PregenDiagnostics.describeProbe(null)); + assertEquals("unnamed", PregenDiagnostics.describeProbe("")); + assertEquals("unnamed", PregenDiagnostics.describeProbe(" ")); + } + + @Test + public void aNamedProbeIsReportedVerbatim() { + assertEquals("mantle handle for backpressure", + PregenDiagnostics.describeProbe("mantle handle for backpressure")); + assertEquals("%s throughput", PregenDiagnostics.describeProbe("%s throughput")); + } + + @Test + public void anAbsentThrowableIsCalledOutInsteadOfPrintingNull() { + assertEquals("no throwable reported", PregenDiagnostics.describeFailure(null)); + } + + @Test + public void aThrowableWithoutAMessageIsIdentifiedByItsType() { + assertEquals("java.lang.IllegalStateException", + PregenDiagnostics.describeFailure(new IllegalStateException())); + } + + @Test + public void aThrowableWithAMessageCarriesBothTypeAndMessage() { + assertEquals("java.lang.IllegalStateException: mantle is gone", + PregenDiagnostics.describeFailure(new IllegalStateException("mantle is gone"))); + assertEquals("java.lang.RuntimeException: ", + PregenDiagnostics.describeFailure(new RuntimeException(""))); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenListenerDefaultsTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenListenerDefaultsTest.java new file mode 100644 index 000000000..368bc8709 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenListenerDefaultsTest.java @@ -0,0 +1,104 @@ +package art.arcane.iris.core.pregenerator; + +import org.junit.Test; + +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class PregenListenerDefaultsTest { + @Test + public void anUnqualifiedChunkIsReportedAsFreshlyGenerated() { + RecordingListener listener = new RecordingListener(); + + listener.onChunkGenerated(4, -9); + + assertEquals(List.of("4/-9/false"), listener.generated); + } + + @Test + public void anExplicitCacheFlagIsPassedThroughUnchanged() { + RecordingListener listener = new RecordingListener(); + + listener.onChunkGenerated(1, 2, true); + listener.onChunkGenerated(3, 4, false); + + assertEquals(List.of("1/2/true", "3/4/false"), listener.generated); + } + + @Test + public void aFailedChunkIsIgnoredByListenersThatDoNotCare() { + RecordingListener listener = new RecordingListener(); + + listener.onChunkFailed(7, 7); + + assertTrue(listener.generated.isEmpty()); + } + + private static final class RecordingListener implements PregenListener { + private final List generated = new ArrayList<>(); + + @Override + public void onTick(double chunksPerSecond, double chunksPerMinute, double regionsPerMinute, double percent, long generatedChunks, long totalChunks, long chunksRemaining, long eta, long elapsed, String method, boolean cached) { + } + + @Override + public void onChunkGenerating(int x, int z) { + } + + @Override + public void onChunkGenerated(int x, int z, boolean cached) { + generated.add(x + "/" + z + "/" + cached); + } + + @Override + public void onRegionGenerated(int x, int z) { + } + + @Override + public void onRegionGenerating(int x, int z) { + } + + @Override + public void onChunkCleaned(int x, int z) { + } + + @Override + public void onRegionSkipped(int x, int z) { + } + + @Override + public void onNetworkStarted(int x, int z) { + } + + @Override + public void onNetworkFailed(int x, int z) { + } + + @Override + public void onNetworkReclaim(int revert) { + } + + @Override + public void onNetworkGeneratedChunk(int x, int z) { + } + + @Override + public void onNetworkDownloaded(int x, int z) { + } + + @Override + public void onClose() { + } + + @Override + public void onSaving() { + } + + @Override + public void onChunkExistsInRegionGen(int x, int z) { + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressureTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressureTest.java new file mode 100644 index 000000000..5ddaedfaf --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/PregenMantleBackpressureTest.java @@ -0,0 +1,152 @@ +package art.arcane.iris.core.pregenerator; + +import art.arcane.iris.testsupport.Await; +import art.arcane.volmlib.util.mantle.runtime.Mantle; +import org.junit.Test; + +import java.time.Duration; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.function.Supplier; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +public class PregenMantleBackpressureTest { + @Test + public void aDisabledPlateCapNeverAsksForAMantle() { + AtomicInteger supplierCalls = new AtomicInteger(); + Supplier supplier = () -> { + supplierCalls.incrementAndGet(); + return null; + }; + + backpressure(supplier, 0, 1_000L, () -> { + }).enforceMantleBudget(); + + assertEquals(0, supplierCalls.get()); + } + + @Test + public void aFailingMantleProbeDoesNotPropagate() { + AtomicInteger timeouts = new AtomicInteger(); + + backpressure(() -> { + throw new IllegalStateException("no mantle here"); + }, 4, 1_000L, timeouts::incrementAndGet).enforceMantleBudget(); + + assertEquals(0, timeouts.get()); + } + + @Test + public void residencyAtTwiceThePlateCapIsNotTrimmed() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(8); + + backpressure(() -> mantle, 4, 1_000L, () -> { + }).enforceMantleBudget(); + + verify(mantle, never()).trim(0L, 0); + verify(mantle, never()).unloadTectonicPlate(0); + } + + @Test + public void residencyOverTheHardCapIsTrimmedUntilItFits() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20, 20, 3); + + backpressure(() -> mantle, 4, 1_000L, () -> { + }).enforceMantleBudget(); + + verify(mantle, times(1)).trim(0L, 0); + verify(mantle, times(1)).unloadTectonicPlate(0); + } + + @Test + public void aTrimFailureEndsTheWaitInsteadOfSpinning() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20); + doThrow(new IllegalStateException("mantle is gone")).when(mantle).trim(0L, 0); + AtomicInteger timeouts = new AtomicInteger(); + + backpressure(() -> mantle, 4, 1_000L, timeouts::incrementAndGet).enforceMantleBudget(); + + verify(mantle, never()).unloadTectonicPlate(0); + assertEquals(0, timeouts.get()); + } + + @Test + public void anExhaustedBudgetReportsTheTimeoutOnceAndProceeds() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20); + AtomicInteger timeouts = new AtomicInteger(); + + backpressure(() -> mantle, 4, 0L, timeouts::incrementAndGet).enforceMantleBudget(); + + assertEquals(1, timeouts.get()); + } + + @Test + public void cancellationStopsTheWaitWithoutReportingATimeout() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20); + AtomicInteger timeouts = new AtomicInteger(); + PregenMantleBackpressure backpressure = new PregenMantleBackpressure( + () -> mantle, 4, 5, 0L, timeouts::incrementAndGet, () -> "cancelled", () -> true); + + backpressure.enforceMantleBudget(); + + verify(mantle, never()).trim(0L, 0); + verify(mantle, never()).unloadTectonicPlate(0); + assertEquals(0, timeouts.get()); + } + + @Test + public void aFailingCancellationProbeIsTreatedAsRunning() { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20); + AtomicInteger timeouts = new AtomicInteger(); + PregenMantleBackpressure backpressure = new PregenMantleBackpressure( + () -> mantle, 4, 5, 0L, timeouts::incrementAndGet, () -> "probing", () -> { + throw new IllegalStateException("cancellation probe exploded"); + }); + + backpressure.enforceMantleBudget(); + + assertEquals(1, timeouts.get()); + } + + @Test + public void signalledProgressReleasesTheWaitAheadOfThePollInterval() throws Exception { + Mantle mantle = mock(Mantle.class); + when(mantle.getLoadedRegionCount()).thenReturn(20, 20, 20, 3); + PregenMantleBackpressure backpressure = new PregenMantleBackpressure( + () -> mantle, 4, 600_000, 600_000L, () -> { + }, () -> "waiting"); + Thread waiter = new Thread(backpressure::enforceMantleBudget, "pregen-backpressure-waiter"); + + waiter.start(); + Await.until("the parked backpressure wait to be released", Duration.ofSeconds(10L), () -> { + backpressure.signalProgress(); + return !waiter.isAlive(); + }); + waiter.join(1_000L); + + assertFalse(waiter.isAlive()); + } + + private static PregenMantleBackpressure backpressure( + Supplier mantleSupplier, + int maxResidentTectonicPlates, + long timeoutMs, + Runnable onBudgetTimeout + ) { + return new PregenMantleBackpressure( + mantleSupplier, maxResidentTectonicPlates, 5, timeoutMs, onBudgetTimeout, () -> "test"); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheDefaultsTest.java b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheDefaultsTest.java new file mode 100644 index 000000000..c897901ee --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/pregenerator/cache/PregenCacheDefaultsTest.java @@ -0,0 +1,43 @@ +package art.arcane.iris.core.pregenerator.cache; + +import org.junit.Test; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertSame; + +public class PregenCacheDefaultsTest { + @Test + public void anAbsentDirectoryResolvesToTheSharedEmptyCache() { + assertSame(PregenCache.EMPTY, PregenCache.create(null)); + } + + @Test + public void theEmptyCacheNeverClaimsAChunkItWasToldToCache() { + PregenCache.EMPTY.cacheChunk(3, -7); + PregenCache.EMPTY.cacheChunk(0, 0); + + assertFalse(PregenCache.EMPTY.isChunkCached(3, -7)); + assertFalse(PregenCache.EMPTY.isChunkCached(0, 0)); + } + + @Test + public void theEmptyCacheNeverClaimsARegionItWasToldToCache() { + PregenCache.EMPTY.cacheRegion(-2, 5); + + assertFalse(PregenCache.EMPTY.isRegionCached(-2, 5)); + } + + @Test + public void theEmptyCacheSurvivesMaintenanceCalls() { + PregenCache.EMPTY.write(); + PregenCache.EMPTY.trim(0L); + PregenCache.EMPTY.trim(60_000L); + + assertFalse(PregenCache.EMPTY.isChunkCached(0, 0)); + } + + @Test + public void aCacheIsItsOwnSynchronousView() { + assertSame(PregenCache.EMPTY, PregenCache.EMPTY.sync()); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/structure/conversion/IrisStructureAdoptionValueTest.java b/core/src/test/java/art/arcane/iris/core/structure/conversion/IrisStructureAdoptionValueTest.java new file mode 100644 index 000000000..1097812fa --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/structure/conversion/IrisStructureAdoptionValueTest.java @@ -0,0 +1,187 @@ +package art.arcane.iris.core.structure.conversion; + +import org.junit.Test; + +import java.time.Duration; +import java.util.List; +import java.util.Optional; +import java.util.UUID; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class IrisStructureAdoptionValueTest { + @Test + public void theDefaultLimitsAreTheOnesTheServiceShipsWith() { + IrisStructureAdoptionLimits limits = IrisStructureAdoptionLimits.defaults(); + + assertEquals(10_000, limits.maxResources()); + assertEquals(8 * 1024 * 1024, limits.maxJsonBytes()); + assertEquals(64 * 1024 * 1024, limits.maxBinaryBytes()); + assertEquals(1024L * 1024L * 1024L, limits.maxTotalBytes()); + assertEquals(10_000, limits.maxStructuresScanned()); + assertEquals(1_000, limits.maxDiagnostics()); + assertEquals(1_024, limits.maxActivePlans()); + assertEquals(Duration.ofMinutes(15L), limits.planTtl()); + } + + @Test + public void everyLimitRejectsBothEndsOfItsRange() { + assertThrows(IllegalArgumentException.class, () -> limits(0, 1, 1, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(100_001, 1, 1, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 0, 1, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 67_108_865, 1, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 0, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 268_435_457, 1L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 0L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1_073_741_825L, 1, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 0, 1, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 0, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 10_001, 1, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 1, 0, Duration.ofMinutes(1L))); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 1, 10_001, Duration.ofMinutes(1L))); + } + + @Test + public void thePlanTtlMustBePositiveAndWithinADay() { + assertThrows(NullPointerException.class, () -> limits(1, 1, 1, 1L, 1, 1, 1, null)); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 1, 1, Duration.ZERO)); + assertThrows(IllegalArgumentException.class, () -> limits(1, 1, 1, 1L, 1, 1, 1, Duration.ofSeconds(-1L))); + assertThrows(IllegalArgumentException.class, + () -> limits(1, 1, 1, 1L, 1, 1, 1, Duration.ofHours(24L).plusNanos(1L))); + + assertEquals(Duration.ofHours(24L), limits(1, 1, 1, 1L, 1, 1, 1, Duration.ofHours(24L)).planTtl()); + assertEquals(Duration.ofNanos(1L), limits(1, 1, 1, 1L, 1, 1, 1, Duration.ofNanos(1L)).planTtl()); + } + + @Test + public void aDiagnosticRendersItsSeverityCodeResourceAndAdvice() { + IrisStructureAdoptionDiagnostic diagnostic = new IrisStructureAdoptionDiagnostic( + IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.TARGET_RESOURCE_EXISTS, + " structures/village.json ", + "the target already exists", + " pick another target "); + + assertEquals("structures/village.json", diagnostic.resource()); + assertEquals("ERROR TARGET_RESOURCE_EXISTS [structures/village.json]: " + + "the target already exists pick another target", diagnostic.summary()); + assertTrue(diagnostic.blocking()); + } + + @Test + public void aDiagnosticWithoutAResourceOrAdviceStillReadsCleanly() { + IrisStructureAdoptionDiagnostic diagnostic = new IrisStructureAdoptionDiagnostic( + IrisStructureAdoptionDiagnostic.Severity.INFO, + IrisStructureAdoptionDiagnostic.Code.IN_PLACE_AVAILABLE, + null, + "the source can be claimed in place", + null); + + assertEquals("INFO IN_PLACE_AVAILABLE: the source can be claimed in place", diagnostic.summary()); + assertFalse(diagnostic.blocking()); + } + + @Test + public void aDiagnosticWithoutADetailIsRejected() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> new IrisStructureAdoptionDiagnostic( + IrisStructureAdoptionDiagnostic.Severity.WARNING, + IrisStructureAdoptionDiagnostic.Code.SHARED_DEPENDENCY, + "structures/village.json", + " ", + null)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("detail cannot be blank")); + assertThrows(NullPointerException.class, () -> new IrisStructureAdoptionDiagnostic( + null, + IrisStructureAdoptionDiagnostic.Code.SHARED_DEPENDENCY, + null, + "detail", + null)); + } + + @Test + public void diagnosticsSortErrorsAheadOfWarningsAndInfo() { + IrisStructureAdoptionDiagnostic error = diagnostic( + IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.PLAN_BLOCKED, "b", "second"); + IrisStructureAdoptionDiagnostic warning = diagnostic( + IrisStructureAdoptionDiagnostic.Severity.WARNING, + IrisStructureAdoptionDiagnostic.Code.SHARED_DEPENDENCY, "a", "first"); + IrisStructureAdoptionDiagnostic sameSeverityEarlierCode = diagnostic( + IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.SOURCE_GRAPH_INVALID, "z", "third"); + + assertTrue(error.compareTo(warning) < 0); + assertTrue(sameSeverityEarlierCode.compareTo(error) < 0); + assertTrue(diagnostic(IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.PLAN_BLOCKED, "a", "x") + .compareTo(error) < 0); + assertEquals(0, error.compareTo(diagnostic( + IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.PLAN_BLOCKED, "b", "second"))); + } + + @Test + public void anUnappliedResultCarriesItsDiagnosticsAndNoReceipt() { + UUID planId = UUID.randomUUID(); + IrisStructureAdoptionResult result = new IrisStructureAdoptionResult( + IrisStructureAdoptionResult.Status.BLOCKED, + planId, + List.of(diagnostic(IrisStructureAdoptionDiagnostic.Severity.ERROR, + IrisStructureAdoptionDiagnostic.Code.PLAN_BLOCKED, "structures/village.json", "blocked")), + Optional.empty(), + Optional.empty()); + + assertFalse(result.successful()); + assertEquals(List.of( + "Adoption plan " + planId + ": BLOCKED", + "ERROR PLAN_BLOCKED [structures/village.json]: blocked"), result.summaryLines()); + } + + @Test + public void anAppliedResultWithoutAReceiptIsRejected() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> new IrisStructureAdoptionResult( + IrisStructureAdoptionResult.Status.APPLIED, + UUID.randomUUID(), + List.of(), + Optional.empty(), + Optional.empty())); + + assertTrue(failure.getMessage(), failure.getMessage().contains("requires a receipt")); + } + + private static IrisStructureAdoptionDiagnostic diagnostic( + IrisStructureAdoptionDiagnostic.Severity severity, + IrisStructureAdoptionDiagnostic.Code code, + String resource, + String detail + ) { + return new IrisStructureAdoptionDiagnostic(severity, code, resource, detail, null); + } + + private static IrisStructureAdoptionLimits limits( + int maxResources, + int maxJsonBytes, + int maxBinaryBytes, + long maxTotalBytes, + int maxStructuresScanned, + int maxDiagnostics, + int maxActivePlans, + Duration planTtl + ) { + return new IrisStructureAdoptionLimits( + maxResources, + maxJsonBytes, + maxBinaryBytes, + maxTotalBytes, + maxStructuresScanned, + maxDiagnostics, + maxActivePlans, + planTtl); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaBlockStateTest.java b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaBlockStateTest.java new file mode 100644 index 000000000..f5d42318d --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaBlockStateTest.java @@ -0,0 +1,73 @@ +package art.arcane.iris.core.structure.export; + +import art.arcane.volmlib.util.nbt.tag.CompoundTag; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class VanillaBlockStateTest { + @Test + public void aBareBlockKeepsItsNameAndNoProperties() { + VanillaBlockState state = VanillaBlockState.parse(" minecraft:stone "); + + assertEquals("minecraft:stone", state.name()); + assertTrue(state.properties().isEmpty()); + assertEquals("minecraft:stone", state.canonical()); + } + + @Test + public void propertiesAreCanonicalizedIntoAlphabeticalOrder() { + VanillaBlockState state = VanillaBlockState.parse("minecraft:oak_stairs[waterlogged=false,facing=north,half=top]"); + + assertEquals("minecraft:oak_stairs[facing=north,half=top,waterlogged=false]", state.canonical()); + assertEquals("north", state.properties().get("facing")); + } + + @Test + public void theCanonicalFormRoundTripsThroughTheParser() { + String canonical = VanillaBlockState.parse("minecraft:oak_log[axis=z]").canonical(); + + assertEquals(canonical, VanillaBlockState.parse(canonical).canonical()); + } + + @Test + public void theNbtFormCarriesTheNameAndOnlyRealProperties() { + CompoundTag bare = VanillaBlockState.parse("minecraft:air").toNbt(); + CompoundTag stairs = VanillaBlockState.parse("minecraft:oak_stairs[facing=north]").toNbt(); + + assertEquals("minecraft:air", bare.getString("Name")); + assertNull(bare.get("Properties")); + assertEquals("minecraft:oak_stairs", stairs.getString("Name")); + assertEquals("north", stairs.getCompoundTag("Properties").getString("facing")); + } + + @Test + public void nonMinecraftBlocksAreRejectedBeforeAnythingIsWritten() { + IllegalArgumentException failure = + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("iris:custom_block")); + + assertTrue(failure.getMessage(), failure.getMessage().contains("non-Minecraft block")); + } + + @Test + public void malformedPropertyBlocksAreRejected() { + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse(null)); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[facing=north")); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[]")); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[facing]")); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[facing=]")); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[=north]")); + assertThrows(IllegalArgumentException.class, () -> VanillaBlockState.parse("minecraft:stone[a=1][b=2]")); + } + + @Test + public void aRepeatedPropertyIsRejectedInsteadOfSilentlyWinning() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> VanillaBlockState.parse("minecraft:stone[facing=north,facing=south]")); + + assertTrue(failure.getMessage(), failure.getMessage().contains("Duplicate block property")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawExportRequestTest.java b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawExportRequestTest.java new file mode 100644 index 000000000..7ead6f8df --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaJigsawExportRequestTest.java @@ -0,0 +1,124 @@ +package art.arcane.iris.core.structure.export; + +import art.arcane.iris.engine.framework.structure.StructureGraphResolver; +import art.arcane.iris.engine.object.IrisStructure; +import org.junit.Test; + +import java.nio.file.Path; +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; + +public class VanillaJigsawExportRequestTest { + @Test + public void aStructureSourceKeepsTheSuppliedGraphInsteadOfLoadingOne() { + IrisStructure structure = mock(IrisStructure.class); + StructureGraphResolver resolver = mock(StructureGraphResolver.class); + + VanillaJigsawExportSource source = VanillaJigsawExportSource.forStructure(" village ", structure, resolver); + + assertEquals("village", source.structureKey()); + assertSame(structure, source.loadStructure()); + assertSame(resolver, source.resolver()); + } + + @Test + public void aBlankStructureKeyIsRejected() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> VanillaJigsawExportSource.forStructure(" ", mock(IrisStructure.class), mock(StructureGraphResolver.class))); + + assertTrue(failure.getMessage(), failure.getMessage().contains("must not be blank")); + assertThrows(NullPointerException.class, + () -> VanillaJigsawExportSource.forStructure(null, mock(IrisStructure.class), mock(StructureGraphResolver.class))); + } + + @Test + public void theResourcePathDefaultsToTheStructureKey() { + VanillaJigsawExportRequest request = request().build(); + + assertEquals("village", request.resourcePath()); + assertEquals("iris", request.namespace()); + assertEquals(VanillaJigsawExportFormat.DIRECTORY, request.format()); + assertFalse(request.replaceExisting()); + } + + @Test + public void theOutputPathIsStoredAbsoluteAndNormalized() { + VanillaJigsawExportRequest request = VanillaJigsawExportRequest + .builder(source(), Path.of("build", "exports", "..", "datapack")) + .build(); + + assertTrue(request.output().isAbsolute()); + assertEquals("datapack", request.output().getFileName().toString()); + assertFalse(request.output().toString().contains("..")); + } + + @Test + public void identityFieldsAreTrimmedButTheDescriptionIsNot() { + VanillaJigsawExportRequest request = request() + .namespace(" mypack ") + .resourcePath(" village/plains ") + .description(" a description ") + .format(VanillaJigsawExportFormat.ZIP) + .replaceExisting(true) + .build(); + + assertEquals("mypack", request.namespace()); + assertEquals("village/plains", request.resourcePath()); + assertEquals(" a description ", request.description()); + assertEquals(VanillaJigsawExportFormat.ZIP, request.format()); + assertTrue(request.replaceExisting()); + } + + @Test + public void theDefaultSettingsDescribeAVanillaSurfaceStructure() { + VanillaJigsawExportSettings settings = VanillaJigsawExportSettings.defaults(); + + assertEquals(List.of("minecraft:plains"), settings.biomes()); + assertEquals(0, settings.startHeight()); + assertEquals(4064, settings.maxDistanceVertical()); + assertEquals(32, settings.spacing()); + assertEquals(8, settings.separation()); + assertEquals(0, settings.salt()); + assertEquals(1.0F, settings.frequency(), 0F); + assertFalse(settings.expansionHack()); + assertEquals(VanillaJigsawExportSettings.ProjectHeightmap.WORLD_SURFACE_WG, settings.projectHeightmap()); + assertEquals(VanillaJigsawExportSettings.GenerationStep.SURFACE_STRUCTURES, settings.generationStep()); + assertEquals(VanillaJigsawExportSettings.TerrainAdaptation.NONE, settings.terrainAdaptation()); + assertEquals(VanillaJigsawExportSettings.SpreadType.LINEAR, settings.spreadType()); + assertNull(VanillaJigsawExportSettings.ProjectHeightmap.NONE.serializedName()); + } + + @Test + public void theSettingsBuilderReplacesTheBiomeListRatherThanAppendingToIt() { + VanillaJigsawExportSettings settings = VanillaJigsawExportSettings.builder() + .biomes(List.of("minecraft:desert", "minecraft:savanna")) + .biomes(List.of("minecraft:taiga")) + .startHeight(64) + .randomSpread(48, 12, 7) + .frequency(0.5F) + .build(); + + assertEquals(List.of("minecraft:taiga"), settings.biomes()); + assertEquals(64, settings.startHeight()); + assertEquals(48, settings.spacing()); + assertEquals(12, settings.separation()); + assertEquals(7, settings.salt()); + assertEquals(0.5F, settings.frequency(), 0F); + } + + private static VanillaJigsawExportSource source() { + return VanillaJigsawExportSource.forStructure( + "village", mock(IrisStructure.class), mock(StructureGraphResolver.class)); + } + + private static VanillaJigsawExportRequest.Builder request() { + return VanillaJigsawExportRequest.builder(source(), Path.of("build", "datapack")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaResourceIdentifierTest.java b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaResourceIdentifierTest.java new file mode 100644 index 000000000..c2552746f --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaResourceIdentifierTest.java @@ -0,0 +1,66 @@ +package art.arcane.iris.core.structure.export; + +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class VanillaResourceIdentifierTest { + @Test + public void namespacesAcceptOnlyTheVanillaCharacterSet() { + assertTrue(VanillaResourceIdentifier.validNamespace("minecraft")); + assertTrue(VanillaResourceIdentifier.validNamespace("iris_pack-1.0")); + assertFalse(VanillaResourceIdentifier.validNamespace(null)); + assertFalse(VanillaResourceIdentifier.validNamespace("")); + assertFalse(VanillaResourceIdentifier.validNamespace("Minecraft")); + assertFalse(VanillaResourceIdentifier.validNamespace("iris/pack")); + } + + @Test + public void pathsAllowNestingButNeverTraversal() { + assertTrue(VanillaResourceIdentifier.validPath("village/plains/houses")); + assertTrue(VanillaResourceIdentifier.validPath("empty")); + assertFalse(VanillaResourceIdentifier.validPath("/village")); + assertFalse(VanillaResourceIdentifier.validPath("village/")); + assertFalse(VanillaResourceIdentifier.validPath("village//houses")); + assertFalse(VanillaResourceIdentifier.validPath("village/../secrets")); + assertFalse(VanillaResourceIdentifier.validPath("village/./houses")); + assertFalse(VanillaResourceIdentifier.validPath("Village")); + } + + @Test + public void identifiersRequireExactlyOneSeparatorWithBothHalvesPresent() { + assertTrue(VanillaResourceIdentifier.validIdentifier("minecraft:village/plains")); + assertFalse(VanillaResourceIdentifier.validIdentifier("village")); + assertFalse(VanillaResourceIdentifier.validIdentifier(":village")); + assertFalse(VanillaResourceIdentifier.validIdentifier("minecraft:")); + assertFalse(VanillaResourceIdentifier.validIdentifier("minecraft:village:plains")); + assertFalse(VanillaResourceIdentifier.validIdentifier(null)); + } + + @Test + public void anAbsentConnectorTargetBecomesTheVanillaEmptyPool() { + assertEquals("minecraft:empty", VanillaResourceIdentifier.normalizeConnectorIdentifier(null)); + assertEquals("minecraft:empty", VanillaResourceIdentifier.normalizeConnectorIdentifier("")); + assertEquals("minecraft:empty", VanillaResourceIdentifier.normalizeConnectorIdentifier(" ")); + } + + @Test + public void abareConnectorNameIsQualifiedIntoTheMinecraftNamespace() { + assertEquals("minecraft:bottom", VanillaResourceIdentifier.normalizeConnectorIdentifier("bottom")); + assertEquals("minecraft:bottom", VanillaResourceIdentifier.normalizeConnectorIdentifier(" bottom ")); + assertEquals("iris:side", VanillaResourceIdentifier.normalizeConnectorIdentifier("iris:side")); + } + + @Test + public void aMalformedConnectorTargetIsRejectedWithItsOriginalText() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> VanillaResourceIdentifier.normalizeConnectorIdentifier("Iris:Side")); + + assertTrue(failure.getMessage(), failure.getMessage().contains("Iris:Side")); + assertThrows(IllegalArgumentException.class, + () -> VanillaResourceIdentifier.normalizeConnectorIdentifier("iris:../escape")); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/structure/export/VanillaStructureTemplateOrientationTest.java b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaStructureTemplateOrientationTest.java new file mode 100644 index 000000000..89e81f0d6 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/structure/export/VanillaStructureTemplateOrientationTest.java @@ -0,0 +1,50 @@ +package art.arcane.iris.core.structure.export; + +import art.arcane.iris.engine.object.IrisDirection; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class VanillaStructureTemplateOrientationTest { + @Test + public void aHorizontalFrontIsRenderedAgainstAnUpwardTop() { + assertEquals("north_up", VanillaStructureTemplateEncoder.orientation( + IrisDirection.NORTH_NEGATIVE_Z, IrisDirection.UP_POSITIVE_Y)); + assertEquals("south_up", VanillaStructureTemplateEncoder.orientation( + IrisDirection.SOUTH_POSITIVE_Z, IrisDirection.UP_POSITIVE_Y)); + assertEquals("east_up", VanillaStructureTemplateEncoder.orientation( + IrisDirection.EAST_POSITIVE_X, IrisDirection.UP_POSITIVE_Y)); + assertEquals("west_up", VanillaStructureTemplateEncoder.orientation( + IrisDirection.WEST_NEGATIVE_X, IrisDirection.UP_POSITIVE_Y)); + } + + @Test + public void averticalFrontIsRenderedAgainstItsHorizontalTop() { + assertEquals("up_north", VanillaStructureTemplateEncoder.orientation( + IrisDirection.UP_POSITIVE_Y, IrisDirection.NORTH_NEGATIVE_Z)); + assertEquals("down_east", VanillaStructureTemplateEncoder.orientation( + IrisDirection.DOWN_NEGATIVE_Y, IrisDirection.EAST_POSITIVE_X)); + } + + @Test + public void averticalFrontCannotTakeAVerticalTop() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> VanillaStructureTemplateEncoder.orientation( + IrisDirection.UP_POSITIVE_Y, IrisDirection.UP_POSITIVE_Y)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("horizontal top direction")); + } + + @Test + public void aHorizontalFrontCannotTakeANonUpwardTop() { + IllegalArgumentException failure = assertThrows(IllegalArgumentException.class, + () -> VanillaStructureTemplateEncoder.orientation( + IrisDirection.NORTH_NEGATIVE_Z, IrisDirection.SOUTH_POSITIVE_Z)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("upward top direction")); + assertThrows(IllegalArgumentException.class, () -> VanillaStructureTemplateEncoder.orientation( + IrisDirection.EAST_POSITIVE_X, IrisDirection.DOWN_NEGATIVE_Y)); + } +} diff --git a/core/src/test/java/art/arcane/iris/util/common/director/handlers/DataVersionHandlerTest.java b/core/src/test/java/art/arcane/iris/util/common/director/handlers/DataVersionHandlerTest.java new file mode 100644 index 000000000..48770c6dc --- /dev/null +++ b/core/src/test/java/art/arcane/iris/util/common/director/handlers/DataVersionHandlerTest.java @@ -0,0 +1,56 @@ +package art.arcane.iris.util.common.director.handlers; + +import art.arcane.iris.core.nms.datapack.DataVersion; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; +import org.junit.Test; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class DataVersionHandlerTest { + private final DataVersionHandler handler = new DataVersionHandler(); + + @Test + public void latestResolvesToTheNewestShippedDatapackVersion() throws DirectorParsingException { + assertSame(DataVersion.getLatest(), handler.parse("latest", false)); + assertSame(DataVersion.getLatest(), handler.parse("LATEST", false)); + } + + @Test + public void anExactVersionStringResolvesRegardlessOfCase() throws DirectorParsingException { + assertSame(DataVersion.V26_2, handler.parse("26.2", false)); + assertSame(DataVersion.V26_1_2, handler.parse("26.1.2", false)); + } + + @Test + public void theUnsupportedSentinelIsHiddenFromSuggestionsButStillParses() throws DirectorParsingException { + KList possibilities = handler.getPossibilities(); + + assertFalse(possibilities.contains(DataVersion.UNSUPPORTED)); + assertTrue(possibilities.contains(DataVersion.getLatest())); + assertSame(DataVersion.UNSUPPORTED, handler.parse(DataVersion.UNSUPPORTED.getVersion(), false)); + } + + @Test + public void anUnknownVersionNamesTheOffendingInput() { + DirectorParsingException failure = + assertThrows(DirectorParsingException.class, () -> handler.parse("nope", false)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("nope")); + } + + @Test + public void theRenderedFormIsTheVersionString() { + assertSame(DataVersion.V26_2.getVersion(), handler.toString(DataVersion.V26_2)); + } + + @Test + public void onlyDataVersionParametersAreClaimed() { + assertTrue(handler.supports(DataVersion.class)); + assertFalse(handler.supports(String.class)); + assertFalse(handler.supports(Integer.class)); + } +} diff --git a/core/src/test/java/art/arcane/iris/util/common/director/handlers/PrimitiveHandlerParsingTest.java b/core/src/test/java/art/arcane/iris/util/common/director/handlers/PrimitiveHandlerParsingTest.java new file mode 100644 index 000000000..59ea36282 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/util/common/director/handlers/PrimitiveHandlerParsingTest.java @@ -0,0 +1,94 @@ +package art.arcane.iris.util.common.director.handlers; + +import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; +import org.junit.Test; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class PrimitiveHandlerParsingTest { + @Test + public void integerSuffixesScaleTheParsedValue() throws DirectorParsingException { + IntegerHandler handler = new IntegerHandler(); + + assertEquals(Integer.valueOf(5), handler.parse("5", false)); + assertEquals(Integer.valueOf(64), handler.parse("4c", false)); + assertEquals(Integer.valueOf(1_000), handler.parse("1k", false)); + assertEquals(Integer.valueOf(200), handler.parse("2h", false)); + assertEquals(Integer.valueOf(512), handler.parse("1r", false)); + } + + @Test + public void stackedIntegerSuffixesMultiplyTogether() throws DirectorParsingException { + assertEquals(Integer.valueOf(2_000_000), new IntegerHandler().parse("2kk", false)); + } + + @Test + public void anUnparseableIntegerNamesTheOffendingInput() { + DirectorParsingException failure = + assertThrows(DirectorParsingException.class, () -> new IntegerHandler().parse("abc", false)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("abc")); + } + + @Test + public void anUnscaledLongKeepsFullPrecision() throws DirectorParsingException { + LongHandler handler = new LongHandler(); + + assertEquals(Long.valueOf(9_007_199_254_740_993L), handler.parse("9007199254740993", false)); + assertEquals(Long.valueOf(1_000L), handler.parse("1k", false)); + } + + @Test + public void shortAndFloatingPointHandlersShareTheSuffixTable() throws DirectorParsingException { + assertEquals(Short.valueOf((short) 32), new ShortHandler().parse("2c", false)); + assertEquals(1_500F, new FloatHandler().parse("1.5k", false), 0F); + assertEquals(1_500D, new DoubleHandler().parse("1.5k", false), 0D); + } + + @Test + public void byteParsingHasNoSuffixTable() throws DirectorParsingException { + ByteHandler handler = new ByteHandler(); + + assertEquals(Byte.valueOf((byte) 12), handler.parse("12", false)); + assertThrows(DirectorParsingException.class, () -> handler.parse("1k", false)); + } + + @Test + public void booleanSentinelsAreCaseSensitiveAndEverythingElseFallsBackToFalse() throws DirectorParsingException { + BooleanHandler handler = new BooleanHandler(); + + assertNull(handler.parse("null", false)); + assertNull(handler.parse("other", false)); + assertNull(handler.parse("flip", false)); + assertEquals(Boolean.TRUE, handler.parse("TRUE", false)); + assertEquals(Boolean.FALSE, handler.parse("yes", false)); + assertEquals(Boolean.FALSE, handler.parse("NULL", false)); + } + + @Test + public void stringParsingIsVerbatim() throws DirectorParsingException { + StringHandler handler = new StringHandler(); + + assertEquals(" spaced ", handler.parse(" spaced ", false)); + assertEquals("", handler.parse("", false)); + } + + @Test + public void eachHandlerClaimsOnlyItsOwnParameterType() { + assertTrue(new IntegerHandler().supports(int.class)); + assertTrue(new IntegerHandler().supports(Integer.class)); + assertFalse(new IntegerHandler().supports(Long.class)); + assertTrue(new LongHandler().supports(long.class)); + assertTrue(new ShortHandler().supports(short.class)); + assertTrue(new ByteHandler().supports(byte.class)); + assertTrue(new FloatHandler().supports(float.class)); + assertTrue(new DoubleHandler().supports(double.class)); + assertTrue(new BooleanHandler().supports(boolean.class)); + assertTrue(new StringHandler().supports(String.class)); + assertFalse(new StringHandler().supports(Object.class)); + } +} diff --git a/core/src/test/java/art/arcane/iris/util/common/director/handlers/VectorHandlerParsingTest.java b/core/src/test/java/art/arcane/iris/util/common/director/handlers/VectorHandlerParsingTest.java new file mode 100644 index 000000000..9e4d81c44 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/util/common/director/handlers/VectorHandlerParsingTest.java @@ -0,0 +1,144 @@ +package art.arcane.iris.util.common.director.handlers; + +import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; +import org.bukkit.Location; +import org.bukkit.entity.Player; +import org.bukkit.util.Vector; +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class VectorHandlerParsingTest { + @Test + public void threeComponentsMapToTheirAxes() throws DirectorParsingException { + Vector parsed = console().parse("1, 2 ,3", false); + + assertEquals(1D, parsed.getX(), 0D); + assertEquals(2D, parsed.getY(), 0D); + assertEquals(3D, parsed.getZ(), 0D); + } + + @Test + public void twoComponentsAreTreatedAsAHorizontalPair() throws DirectorParsingException { + Vector parsed = console().parse("4,6", false); + + assertEquals(4D, parsed.getX(), 0D); + assertEquals(0D, parsed.getY(), 0D); + assertEquals(6D, parsed.getZ(), 0D); + } + + @Test + public void anyOtherComponentCountIsRejectedWithItsArity() { + DirectorParsingException failure = + assertThrows(DirectorParsingException.class, () -> console().parse("1,2,3,4", false)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("4 components")); + assertTrue(failure.getMessage(), failure.getMessage().contains("Expected 2 or 3")); + } + + @Test + public void positionalKeywordsAreRefusedForAConsoleSender() { + VectorHandler handler = console(); + + assertTrue(assertThrows(DirectorParsingException.class, () -> handler.parse("here", false)) + .getMessage().contains("as a console")); + assertTrue(assertThrows(DirectorParsingException.class, () -> handler.parse("SELF", false)) + .getMessage().contains("as a console")); + assertTrue(assertThrows(DirectorParsingException.class, () -> handler.parse("look", false)) + .getMessage().contains("as a console")); + assertTrue(assertThrows(DirectorParsingException.class, () -> handler.parse("Crosshair", false)) + .getMessage().contains("as a console")); + } + + @Test + public void positionalKeywordsResolveForAPlayerSender() throws DirectorParsingException { + VectorHandler handler = new TestVectorHandler(true, new Vector(10, 20, 30), new Vector(-1, -2, -3), List.of()); + + assertEquals(new Vector(10, 20, 30), handler.parse("me", false)); + assertEquals(new Vector(-1, -2, -3), handler.parse("cursor", false)); + } + + @Test + public void aNamedPlayerResolvesToThatPlayersPosition() throws DirectorParsingException { + Player player = mock(Player.class); + when(player.getLocation()).thenReturn(new Location(null, 7D, 8D, 9D)); + VectorHandler handler = new TestVectorHandler(false, null, null, List.of(player)); + + assertEquals(new Vector(7, 8, 9), handler.parse("player:steve", false)); + } + + @Test + public void anUnmatchedPlayerQueryNamesTheQuery() { + VectorHandler handler = new TestVectorHandler(false, null, null, List.of()); + + DirectorParsingException failure = + assertThrows(DirectorParsingException.class, () -> handler.parse("player:steve", false)); + + assertTrue(failure.getMessage(), failure.getMessage().contains("steve")); + } + + @Test + public void anUnrecognizedTokenResolvesToNothingRatherThanFailing() throws DirectorParsingException { + assertNull(console().parse("garbage", false)); + assertNull(console().parse("", false)); + } + + @Test + public void theRenderedFormOmitsAZeroHeight() { + VectorHandler handler = console(); + + assertEquals(2, handler.toString(new Vector(1, 0, 3)).split(",").length); + assertEquals(3, handler.toString(new Vector(1, 2, 3)).split(",").length); + } + + @Test + public void onlyVectorParametersAreClaimed() { + assertTrue(console().supports(Vector.class)); + assertEquals(false, console().supports(Location.class)); + } + + private static VectorHandler console() { + return new TestVectorHandler(false, null, null, List.of()); + } + + private static final class TestVectorHandler extends VectorHandler { + private final boolean senderIsPlayer; + private final Vector senderVector; + private final Vector lookVector; + private final List players; + + private TestVectorHandler(boolean senderIsPlayer, Vector senderVector, Vector lookVector, List players) { + this.senderIsPlayer = senderIsPlayer; + this.senderVector = senderVector; + this.lookVector = lookVector; + this.players = players; + } + + @Override + protected boolean isSenderPlayer() { + return senderIsPlayer; + } + + @Override + protected Vector getSenderVector() { + return senderVector; + } + + @Override + protected Vector getLookVector() { + return lookVector; + } + + @Override + protected List playerPossibilities(String query) { + return players; + } + } +} diff --git a/spi/build.gradle b/spi/build.gradle index 019cf2024..39b8096ca 100644 --- a/spi/build.gradle +++ b/spi/build.gradle @@ -11,6 +11,10 @@ java { } } +dependencies { + testImplementation('junit:junit:4.13.2') +} + tasks.named('jar', Jar).configure { archiveBaseName.set('iris-spi') } diff --git a/spi/src/test/java/art/arcane/iris/spi/IrisPlatformsBindContractTest.java b/spi/src/test/java/art/arcane/iris/spi/IrisPlatformsBindContractTest.java new file mode 100644 index 000000000..4a34bced2 --- /dev/null +++ b/spi/src/test/java/art/arcane/iris/spi/IrisPlatformsBindContractTest.java @@ -0,0 +1,172 @@ +package art.arcane.iris.spi; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import java.io.File; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class IrisPlatformsBindContractTest { + @Before + public void requireUnbound() { + IrisPlatforms.unbind(); + } + + @After + public void releaseBinding() { + IrisPlatforms.unbind(); + } + + @Test + public void unboundLookupsReportAbsenceInsteadOfImprovising() { + assertFalse(IrisPlatforms.isBound()); + assertNull(IrisPlatforms.getOrNull()); + + IllegalStateException failure = assertThrows(IllegalStateException.class, IrisPlatforms::get); + + assertTrue(failure.getMessage(), failure.getMessage().contains("No Iris platform is bound")); + } + + @Test + public void bindingIsVisibleThroughEveryAccessor() { + IrisPlatform platform = new StubPlatform(); + + IrisPlatforms.bind(platform); + + assertTrue(IrisPlatforms.isBound()); + assertSame(platform, IrisPlatforms.get()); + assertSame(platform, IrisPlatforms.getOrNull()); + } + + @Test + public void rebindingTheSameInstanceIsAccepted() { + IrisPlatform platform = new StubPlatform(); + + IrisPlatforms.bind(platform); + IrisPlatforms.bind(platform); + + assertSame(platform, IrisPlatforms.get()); + } + + @Test + public void aSecondPlatformCannotDisplaceTheBoundOne() { + IrisPlatform first = new StubPlatform(); + IrisPlatforms.bind(first); + + IllegalStateException failure = assertThrows( + IllegalStateException.class, () -> IrisPlatforms.bind(new StubPlatform())); + + assertTrue(failure.getMessage(), failure.getMessage().contains("already bound")); + assertSame(first, IrisPlatforms.get()); + } + + @Test + public void unbindIsIdempotentAndClearsTheBinding() { + IrisPlatforms.bind(new StubPlatform()); + + IrisPlatforms.unbind(); + IrisPlatforms.unbind(); + + assertFalse(IrisPlatforms.isBound()); + assertNull(IrisPlatforms.getOrNull()); + } + + @Test + public void unbindingClearsTheOnceKeysSoLaterRunsWarnAgain() { + IrisPlatforms.bind(new StubPlatform()); + assertTrue(IrisLogging.warnOnce("spi-contract-once", "first")); + assertFalse(IrisLogging.warnOnce("spi-contract-once", "second")); + + IrisPlatforms.unbind(); + + assertTrue(IrisLogging.warnOnce("spi-contract-once", "third")); + } + + private static final class StubPlatform implements IrisPlatform { + @Override + public String platformName() { + return "stub"; + } + + @Override + public String minecraftVersion() { + return "26.2"; + } + + @Override + public PlatformRegistries registries() { + throw new UnsupportedOperationException(); + } + + @Override + public PlatformScheduler scheduler() { + throw new UnsupportedOperationException(); + } + + @Override + public PlatformStructureHooks structureHooks() { + throw new UnsupportedOperationException(); + } + + @Override + public PlatformBiomeWriter biomeWriter() { + throw new UnsupportedOperationException(); + } + + @Override + public File dataFolder() { + throw new UnsupportedOperationException(); + } + + @Override + public File dataFile(String... path) { + throw new UnsupportedOperationException(); + } + + @Override + public File pluginJar() { + throw new UnsupportedOperationException(); + } + + @Override + public int irisVersionNumber() { + return 0; + } + + @Override + public int minecraftVersionNumber() { + return 0; + } + + @Override + public void callEvent(Object event) { + } + + @Override + public void dispatchConsoleCommand(String command) { + } + + @Override + public boolean spawnEntity(PlatformWorld world, String entityKey, double x, double y, double z) { + return false; + } + + @Override + public void log(LogLevel level, String message) { + } + + @Override + public void msg(String message) { + } + + @Override + public void reportError(Throwable error) { + } + } +} diff --git a/spi/src/test/java/art/arcane/iris/spi/IrisServicesRegistryContractTest.java b/spi/src/test/java/art/arcane/iris/spi/IrisServicesRegistryContractTest.java new file mode 100644 index 000000000..eea4b67b1 --- /dev/null +++ b/spi/src/test/java/art/arcane/iris/spi/IrisServicesRegistryContractTest.java @@ -0,0 +1,93 @@ +package art.arcane.iris.spi; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; + +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class IrisServicesRegistryContractTest { + @Before + public void requireEmptyRegistry() { + IrisServices.clear(); + } + + @After + public void releaseRegistry() { + IrisServices.clear(); + } + + @Test + public void registeredServicesResolveThroughBothAccessors() { + Greeter greeter = new Greeter(); + + IrisServices.register(Greeter.class, greeter); + + assertSame(greeter, IrisServices.get(Greeter.class)); + assertSame(greeter, IrisServices.getOrNull(Greeter.class)); + } + + @Test + public void anAbsentServiceNamesItselfInTheFailure() { + assertNull(IrisServices.getOrNull(Greeter.class)); + + IllegalStateException failure = assertThrows(IllegalStateException.class, () -> IrisServices.get(Greeter.class)); + + assertTrue(failure.getMessage(), failure.getMessage().contains(Greeter.class.getName())); + } + + @Test + public void reregisteringATypeReplacesThePreviousImplementation() { + Greeter first = new Greeter(); + Greeter second = new Greeter(); + + IrisServices.register(Greeter.class, first); + IrisServices.register(Greeter.class, second); + + assertSame(second, IrisServices.get(Greeter.class)); + } + + @Test + public void removingAServiceLeavesTheRegistryUsable() { + IrisServices.register(Greeter.class, new Greeter()); + + IrisServices.remove(Greeter.class); + IrisServices.remove(Greeter.class); + + assertNull(IrisServices.getOrNull(Greeter.class)); + } + + @Test + public void clearDropsEveryRegistration() { + IrisServices.register(Greeter.class, new Greeter()); + IrisServices.register(Counter.class, new Counter()); + + IrisServices.clear(); + + assertNull(IrisServices.getOrNull(Greeter.class)); + assertNull(IrisServices.getOrNull(Counter.class)); + } + + @Test + public void aMismatchedImplementationIsRejectedBeforeItEntersTheRegistry() { + assertThrows(ClassCastException.class, () -> IrisServices.register(Greeter.class, new Counter())); + + assertNull(IrisServices.getOrNull(Greeter.class)); + } + + @Test + public void aNullImplementationIsRejectedBeforeItEntersTheRegistry() { + assertThrows(NullPointerException.class, () -> IrisServices.register(Greeter.class, null)); + + assertNull(IrisServices.getOrNull(Greeter.class)); + } + + private static final class Greeter { + } + + private static final class Counter { + } +} diff --git a/spi/src/test/java/art/arcane/iris/spi/PlatformValueContractTest.java b/spi/src/test/java/art/arcane/iris/spi/PlatformValueContractTest.java new file mode 100644 index 000000000..52e24a3a0 --- /dev/null +++ b/spi/src/test/java/art/arcane/iris/spi/PlatformValueContractTest.java @@ -0,0 +1,177 @@ +package art.arcane.iris.spi; + +import org.junit.Test; + +import java.util.List; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThrows; +import static org.junit.Assert.assertTrue; + +public class PlatformValueContractTest { + private static final String FINGERPRINT = "a".repeat(64); + + @Test + public void jigsawMetadataAcceptsTheWholeDocumentedRange() { + PlatformStructureHooks.JigsawSourceMetadata smallest = + new PlatformStructureHooks.JigsawSourceMetadata(1, 0, 0); + PlatformStructureHooks.JigsawSourceMetadata largest = + new PlatformStructureHooks.JigsawSourceMetadata(128, 7, 96); + + assertEquals(1, smallest.maxDistanceHorizontal()); + assertEquals(128, largest.maxDistanceHorizontal()); + assertEquals(7, largest.referenceExpansion()); + assertEquals(96, largest.maxStartElementHorizontalSpan()); + } + + @Test + public void jigsawMetadataDefaultsTheStartElementSpanToZero() { + PlatformStructureHooks.JigsawSourceMetadata metadata = + new PlatformStructureHooks.JigsawSourceMetadata(64, 3); + + assertEquals(0, metadata.maxStartElementHorizontalSpan()); + } + + @Test + public void jigsawMetadataRejectsOutOfRangeGeometry() { + assertThrows(IllegalArgumentException.class, + () -> new PlatformStructureHooks.JigsawSourceMetadata(0, 0, 0)); + assertThrows(IllegalArgumentException.class, + () -> new PlatformStructureHooks.JigsawSourceMetadata(129, 0, 0)); + assertThrows(IllegalArgumentException.class, + () -> new PlatformStructureHooks.JigsawSourceMetadata(64, -1, 0)); + assertThrows(IllegalArgumentException.class, + () -> new PlatformStructureHooks.JigsawSourceMetadata(64, 0, -1)); + } + + @Test + public void unimplementedStructureHookDefaultsRefuseInsteadOfReturningNothing() { + PlatformStructureHooks hooks = new MinimalStructureHooks(); + + assertEquals(List.of(), hooks.jigsawStructureKeys()); + assertEquals(List.of(), hooks.templatePoolKeys()); + assertThrows(UnsupportedOperationException.class, () -> hooks.jigsawSourceMetadata("iris:village")); + assertThrows(UnsupportedOperationException.class, () -> hooks.templatePoolHorizontalSpan("iris:pool")); + assertThrows(UnsupportedOperationException.class, + () -> hooks.jigsawStartPoolHorizontalSpan("iris:village", "iris:pool")); + } + + @Test + public void definitionFactoriesCarryTheirEncoding() { + PlatformGenerationRegistry.Definition json = PlatformGenerationRegistry.Definition.exactJson("{}"); + PlatformGenerationRegistry.Definition identity = + PlatformGenerationRegistry.Definition.conservativeIdentity("abc"); + + assertEquals(PlatformGenerationRegistry.Encoding.JSON, json.encoding()); + assertEquals("{}", json.value()); + assertEquals(PlatformGenerationRegistry.Encoding.CONSERVATIVE_IDENTITY, identity.encoding()); + assertEquals("abc", identity.value()); + } + + @Test + public void resourceIdentityTrimsItsPartsIntoAStableKey() { + PlatformGenerationRegistry.Definition definition = + PlatformGenerationRegistry.Definition.resourceIdentity(" worldgen/biome ", " iris:plains "); + + assertEquals(PlatformGenerationRegistry.Encoding.CONSERVATIVE_IDENTITY, definition.encoding()); + assertEquals("registry-resource-key-v1|worldgen/biome|iris:plains", definition.value()); + } + + @Test + public void definitionsRejectMissingAndBlankValues() { + assertThrows(NullPointerException.class, + () -> new PlatformGenerationRegistry.Definition(null, "value")); + assertThrows(NullPointerException.class, + () -> new PlatformGenerationRegistry.Definition(PlatformGenerationRegistry.Encoding.JSON, null)); + assertThrows(IllegalArgumentException.class, + () -> new PlatformGenerationRegistry.Definition(PlatformGenerationRegistry.Encoding.JSON, " ")); + assertThrows(IllegalArgumentException.class, + () -> PlatformGenerationRegistry.Definition.resourceIdentity(" ", "iris:plains")); + assertThrows(IllegalArgumentException.class, + () -> PlatformGenerationRegistry.Definition.resourceIdentity("worldgen/biome", " ")); + } + + @Test + public void customBiomeResourceKeysAreContentAddressed() { + assertEquals("iris:biomes/" + FINGERPRINT, + PlatformGenerationRegistry.contentAddressedCustomBiomeResourceKey(FINGERPRINT)); + } + + @Test + public void customBiomeResourceKeysRejectAnythingButALowercaseSha256() { + assertThrows(NullPointerException.class, + () -> PlatformGenerationRegistry.contentAddressedCustomBiomeResourceKey(null)); + assertThrows(IllegalArgumentException.class, + () -> PlatformGenerationRegistry.contentAddressedCustomBiomeResourceKey(FINGERPRINT.toUpperCase())); + assertThrows(IllegalArgumentException.class, + () -> PlatformGenerationRegistry.contentAddressedCustomBiomeResourceKey("a".repeat(63))); + assertThrows(IllegalArgumentException.class, + () -> PlatformGenerationRegistry.contentAddressedCustomBiomeResourceKey("z".repeat(64))); + } + + @Test + public void blockPropertiesReportWhetherTheyCarryANumericRange() { + PlatformNumericRange range = new PlatformNumericRange(0D, 15D, false, true); + PlatformBlockProperty numeric = + new PlatformBlockProperty("level", "integer", 0, List.of(0, 15), range); + PlatformBlockProperty enumerated = + new PlatformBlockProperty("axis", "string", "y", List.of("x", "y", "z"), null); + + assertTrue(numeric.hasNumericRange()); + assertEquals(range, numeric.numericRange()); + assertEquals(0D, range.minimum(), 0D); + assertEquals(15D, range.maximum(), 0D); + assertFalse(range.exclusiveMinimum()); + assertTrue(range.exclusiveMaximum()); + assertFalse(enumerated.hasNumericRange()); + assertEquals(List.of("x", "y", "z"), enumerated.allowedValues()); + } + + private static final class MinimalStructureHooks implements PlatformStructureHooks { + @Override + public List structureKeys() { + return List.of(); + } + + @Override + public List structureSetKeys() { + return List.of(); + } + + @Override + public List structureBiomeKeys(String structureKey) { + return List.of(); + } + + @Override + public List objectFeatureKeys() { + return List.of(); + } + + @Override + public List reachableStructureKeys(PlatformWorld world) { + return List.of(); + } + + @Override + public List possibleBiomeKeys(PlatformWorld world) { + return List.of(); + } + + @Override + public boolean placeFeature(PlatformWorld world, int x, int y, int z, String featureKey, long seed) { + return false; + } + + @Override + public int[] placeStructure(PlatformWorld world, int chunkX, int chunkZ, String structureKey, long seed, int maxSpan) { + return new int[0]; + } + + @Override + public boolean supportsStructurePlacement() { + return false; + } + } +} From 9775a50b269b08efce75ddc6b8f8154e834509d4 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 04:49:11 -0400 Subject: [PATCH 21/35] Split schema property builder - Move registry catalogs, enum definitions and block-state groups out of SchemaBuilder into SchemaRegistryCatalog, SchemaEnums and SchemaBlockStates - Decompose buildProperty into SchemaPropertyBuilder per-type handlers with SchemaRegistryProperties owning the per-annotation registry chains - Report the font enumeration, registry list function and default value probe failures instead of swallowing them - Pin the generated studio schema digest for fifteen pack roots in SchemaBuilderIdentityTest --- .../iris/core/project/SchemaBlockStates.java | 136 +++ .../iris/core/project/SchemaBuilder.java | 810 +----------------- .../arcane/iris/core/project/SchemaEnums.java | 100 +++ .../core/project/SchemaPropertyBuilder.java | 269 ++++++ .../core/project/SchemaRegistryCatalog.java | 252 ++++++ .../project/SchemaRegistryProperties.java | 288 +++++++ .../project/SchemaBuilderIdentityTest.java | 395 +++++++++ 7 files changed, 1453 insertions(+), 797 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/project/SchemaBlockStates.java create mode 100644 core/src/main/java/art/arcane/iris/core/project/SchemaEnums.java create mode 100644 core/src/main/java/art/arcane/iris/core/project/SchemaPropertyBuilder.java create mode 100644 core/src/main/java/art/arcane/iris/core/project/SchemaRegistryCatalog.java create mode 100644 core/src/main/java/art/arcane/iris/core/project/SchemaRegistryProperties.java create mode 100644 core/src/test/java/art/arcane/iris/core/project/SchemaBuilderIdentityTest.java diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaBlockStates.java b/core/src/main/java/art/arcane/iris/core/project/SchemaBlockStates.java new file mode 100644 index 000000000..6d9f49148 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaBlockStates.java @@ -0,0 +1,136 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.PlatformBlockProperty; +import art.arcane.iris.spi.PlatformNumericRange; +import art.arcane.volmlib.util.json.JSONArray; +import art.arcane.volmlib.util.json.JSONObject; + +import java.lang.reflect.Field; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +final class SchemaBlockStates { + private final SchemaBuilder builder; + + SchemaBlockStates(SchemaBuilder builder) { + this.builder = builder; + } + + void applyBlockStateMap(JSONObject prop, Field k, String blockType) { + prop.put("!top", true); + JSONArray any = new JSONArray(); + prop.put("anyOf", any); + + for (BlockStateGroup group : reconstructBlockStateGroups()) { + List blocks = group.blocks(); + if (blocks.isEmpty()) { + continue; + } + + String raw = blocks.get(0).replace(':', '_'); + String enumKey = "enum-block-state-" + raw; + String propertiesKey = "obj-block-state-" + raw; + + any.put(new JSONObject() + .put("if", new JSONObject() + .put("properties", new JSONObject() + .put(blockType, new JSONObject() + .put("type", "string") + .put("$ref", definitionReference(enumKey))))) + .put("then", new JSONObject() + .put("properties", new JSONObject() + .put(k.getName(), new JSONObject() + .put("type", "object") + .put("$ref", definitionReference(propertiesKey))))) + .put("else", false)); + + if (!builder.definitions.containsKey(enumKey)) { + JSONArray filters = new JSONArray(); + blocks.forEach(filters::put); + + builder.definitions.put(enumKey, new JSONObject() + .put("type", "string") + .put("enum", filters)); + } + + if (!builder.definitions.containsKey(propertiesKey)) { + JSONObject props = new JSONObject(); + for (PlatformBlockProperty property : group.properties()) { + props.put(property.name(), buildBlockPropertyJson(property)); + } + + builder.definitions.put(propertiesKey, new JSONObject() + .put("type", "object") + .put("properties", props)); + } + } + } + + private static String definitionReference(String key) { + return "#/definitions/" + key.replace("~", "~0").replace("/", "~1"); + } + + private static JSONObject buildBlockPropertyJson(PlatformBlockProperty property) { + JSONObject json = new JSONObject(); + json.put("type", property.jsonType()); + json.put("default", property.defaultValue()); + List allowed = property.allowedValues(); + if (!allowed.isEmpty()) { + json.put("enum", new JSONArray(allowed)); + } + if (property.hasNumericRange()) { + PlatformNumericRange range = property.numericRange(); + if ("integer".equals(property.jsonType())) { + json.put("minimum", (long) range.minimum()); + json.put("maximum", (long) range.maximum()); + } else { + json.put("minimum", range.minimum()); + json.put("maximum", range.maximum()); + } + json.put("exclusiveMinimum", range.exclusiveMinimum()); + json.put("exclusiveMaximum", range.exclusiveMaximum()); + } + return json; + } + + private static List reconstructBlockStateGroups() { + List groups = new ArrayList<>(); + List currentProperties = null; + List currentBlocks = null; + for (Map.Entry> entry : IrisPlatforms.get().registries().blockStateProperties().entrySet()) { + List value = entry.getValue(); + if (currentProperties != null && value == currentProperties) { + currentBlocks.add(entry.getKey()); + } else { + currentBlocks = new ArrayList<>(); + currentBlocks.add(entry.getKey()); + currentProperties = value; + groups.add(new BlockStateGroup(currentBlocks, value)); + } + } + return groups; + } + + private record BlockStateGroup(List blocks, List properties) { + } +} diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java b/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java index 41c41b45e..bf197724a 100644 --- a/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaBuilder.java @@ -18,76 +18,37 @@ package art.arcane.iris.core.project; -import art.arcane.iris.spi.CapabilityProbe; import art.arcane.iris.spi.IrisLogging; -import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.spi.PlatformBlockProperty; -import art.arcane.iris.spi.PlatformNumericRange; import art.arcane.iris.core.loader.IrisData; import art.arcane.iris.core.loader.IrisRegistrant; -import art.arcane.iris.core.loader.ResourceLoader; -import art.arcane.iris.core.structure.StructureSchemaKeys; -import art.arcane.iris.engine.framework.ListFunction; -import art.arcane.iris.engine.object.annotations.ArrayType; import art.arcane.iris.engine.object.annotations.Desc; -import art.arcane.iris.engine.object.annotations.MaxNumber; -import art.arcane.iris.engine.object.annotations.MinNumber; -import art.arcane.iris.engine.object.annotations.RegistryListBiome; -import art.arcane.iris.engine.object.annotations.RegistryListBlockType; -import art.arcane.iris.engine.object.annotations.RegistryListEnchantment; -import art.arcane.iris.engine.object.annotations.RegistryListEntityType; -import art.arcane.iris.engine.object.annotations.RegistryListFont; -import art.arcane.iris.engine.object.annotations.RegistryListFunction; -import art.arcane.iris.engine.object.annotations.RegistryListItemType; -import art.arcane.iris.engine.object.annotations.RegistryListNativeJigsawPool; -import art.arcane.iris.engine.object.annotations.RegistryListPotionEffect; -import art.arcane.iris.engine.object.annotations.RegistryListResource; -import art.arcane.iris.engine.object.annotations.RegistryListSpecialEntity; -import art.arcane.iris.engine.object.annotations.RegistryListStructure; -import art.arcane.iris.engine.object.annotations.RegistryListVanillaStructure; -import art.arcane.iris.engine.object.annotations.RegistryListVanillaStructureSet; -import art.arcane.iris.engine.object.annotations.RegistryMapBlockState; import art.arcane.iris.engine.object.annotations.Required; import art.arcane.iris.engine.object.annotations.Snippet; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.json.JSONArray; import art.arcane.volmlib.util.json.JSONObject; -import org.jetbrains.annotations.NotNull; -import java.awt.GraphicsEnvironment; import java.lang.reflect.Field; import java.lang.reflect.InaccessibleObjectException; import java.lang.reflect.Modifier; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Locale; import java.util.Map; -import java.util.Set; -import java.util.function.Function; -import java.util.function.Supplier; public class SchemaBuilder { - private static final String SYMBOL_LIMIT__N = "*"; - private static final String SYMBOL_TYPE__N = ""; - private static final String MINECRAFT_NAMESPACE = "minecraft:"; - /** Namespaced key or family/namespace prefix: "minecraft:village_plains", "minecraft:village", "nova_structures:". */ - private static final String VANILLA_STRUCTURE_PREFIX_PATTERN = "^[a-z0-9_.-]+:[a-z0-9_./-]*$"; - private static volatile JSONArray fontTypes; - private final KMap definitions; + static final String SYMBOL_LIMIT__N = "*"; + static final String SYMBOL_TYPE__N = ""; + final KMap definitions; + final KList warnings; + final IrisData data; private final Class root; - private final KList warnings; - private final IrisData data; - private JSONArray potionTypes; - private JSONArray enchantTypes; + private final SchemaPropertyBuilder propertyBuilder; public SchemaBuilder(Class root, IrisData data) { this.data = data; warnings = new KList<>(); this.definitions = new KMap<>(); this.root = root; + this.propertyBuilder = new SchemaPropertyBuilder(this); } public JSONObject construct() { @@ -118,209 +79,7 @@ public class SchemaBuilder { return schema; } - /** - * Font families are only used for schema completion. Enumerating them touches AWT, which can fail outright on a - * headless or mod-loader JVM - a failure degrades to no completion, never to a broken schema. - */ - private static JSONArray fontTypes() { - JSONArray cached = fontTypes; - if (cached != null) { - return cached; - } - JSONArray built = CapabilityProbe.attempt("java.awt font families", - () -> new JSONArray(GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()), - new JSONArray()); - fontTypes = built; - return built; - } - - private JSONArray potionTypes() { - if (potionTypes == null) { - potionTypes = registryKeyForms(IrisPlatforms.get().registries().potionEffectKeys(), true); - } - return potionTypes; - } - - private JSONArray enchantTypes() { - if (enchantTypes == null) { - enchantTypes = registryKeyForms(IrisPlatforms.get().registries().enchantmentKeys(), false); - } - return enchantTypes; - } - - /** - * Emits the full namespaced key for every registry entry, so mod and datapack content is addressable - * unambiguously, plus the legacy short form for the vanilla namespace so existing packs stay valid. - */ - private static JSONArray registryKeyForms(List keys, boolean upperCaseLegacy) { - JSONArray a = new JSONArray(); - Set seen = new LinkedHashSet<>(); - if (keys != null) { - for (String key : keys) { - if (key == null || key.isBlank()) { - continue; - } - seen.add(key); - if (key.startsWith(MINECRAFT_NAMESPACE) || key.indexOf(':') < 0) { - String path = stripNamespace(key); - seen.add(upperCaseLegacy ? path.toUpperCase(Locale.ROOT).replace(' ', '_') : path); - } - } - } - for (String key : seen) { - a.put(key); - } - return a; - } - - /** - * Biome derivatives resolve through NamespacedKey.fromString, which accepts a full key or a bare vanilla path, - * so both forms are offered. - */ - private JSONArray biomeTypes() { - return registryKeyForms(IrisPlatforms.get().registries().biomeKeys(), false); - } - - private JSONArray entityTypes() { - return keysAsArray(IrisPlatforms.get().registries().entityKeys()); - } - - private JSONArray specialEntityTypes() { - return keysAsArray(IrisPlatforms.get().registries().specialEntityKeys()); - } - - private JSONArray vanillaStructures() { - return keysAsArray(IrisPlatforms.get().registries().structureKeys()); - } - - private JSONArray vanillaStructureSets() { - if (IrisPlatforms.get().structureHooks() == null) { - return new JSONArray(); - } - List keys = IrisPlatforms.get().structureHooks().structureSetKeys(); - return keysAsArray(keys == null ? List.of() : keys); - } - - private JSONArray nativeJigsawPools() { - return keysAsArray(templatePoolKeys()); - } - - private static JSONArray keysAsArray(List keys) { - JSONArray a = new JSONArray(); - if (keys != null) { - for (String key : keys) { - if (key != null && !key.isBlank()) { - a.put(key); - } - } - } - return a; - } - - /** - * Registers a registry-backed enum definition under {@code definitionKey} and points {@code target} at it. - *

- * An empty key list means the registry has nothing to offer yet - the server is still booting, a modded registry - * has not been frozen, or the host simply does not expose that catalog. Emitting {@code "enum": []} in that case - * writes a schema that rejects every value the author could possibly type, turning a missing autocomplete list - * into a pack that reads as broken in the editor. The reference is omitted instead, leaving the field - * unconstrained, and the values are only computed when the definition does not exist yet. - */ - private void putRegistryEnumRef(JSONObject target, String definitionKey, Supplier values) { - if (!definitions.containsKey(definitionKey)) { - JSONArray built = values.get(); - if (built == null || built.length() == 0) { - IrisLogging.debug("Schema enum '" + definitionKey + "' omitted: the registry returned no keys"); - return; - } - JSONObject definition = new JSONObject(); - definition.put("enum", built); - definitions.put(definitionKey, definition); - } - target.put("$ref", "#/definitions/" + definitionKey); - } - - /** - * {@link #putRegistryEnumRef(JSONObject, String, Supplier)} for a list-typed property. When the enum is omitted no - * {@code items} schema is written at all, which is valid and simply means "any element". - */ - private void putRegistryEnumItems(JSONObject prop, String definitionKey, Supplier values) { - JSONObject items = new JSONObject(); - putRegistryEnumRef(items, definitionKey, values); - if (items.has("$ref")) { - prop.put("items", items); - } - } - - /** - * A registry enum that ALSO accepts family/namespace prefixes ("minecraft:village", - * "nova_structures:") — the runtime prefix-matching contract of importedStructures.disabled and - * adjustments[].match. Emitted as anyOf(enum, pattern) so autocomplete still offers registered - * keys while prefix entries validate instead of being rejected. - */ - private void putRegistryEnumOrPrefixRef(JSONObject target, String definitionKey, - String enumDefinitionKey, Supplier values, - String pattern) { - if (!definitions.containsKey(definitionKey)) { - JSONArray anyOf = new JSONArray(); - JSONObject enumRef = new JSONObject(); - try { - putRegistryEnumRef(enumRef, enumDefinitionKey, values); - } catch (RuntimeException e) { - IrisLogging.debug("Schema enum '" + enumDefinitionKey + "' unavailable (" - + e.getMessage() + "); emitting prefix pattern only"); - } - if (enumRef.has("$ref")) { - anyOf.put(enumRef); - } - JSONObject prefix = new JSONObject(); - prefix.put("type", "string"); - prefix.put("pattern", pattern); - anyOf.put(prefix); - JSONObject definition = new JSONObject(); - definition.put("anyOf", anyOf); - definitions.put(definitionKey, definition); - } - target.put("$ref", "#/definitions/" + definitionKey); - } - - private void putRegistryEnumOrPrefixItems(JSONObject prop, String definitionKey, - String enumDefinitionKey, Supplier values, - String pattern) { - JSONObject items = new JSONObject(); - putRegistryEnumOrPrefixRef(items, definitionKey, enumDefinitionKey, values, pattern); - prop.put("items", items); - } - - private JSONArray itemTypes() { - JSONArray a = new JSONArray(); - for (String key : IrisPlatforms.get().registries().itemKeys()) { - a.put(key.startsWith(MINECRAFT_NAMESPACE) ? key.substring(MINECRAFT_NAMESPACE.length()) : key); - } - return a; - } - - private JSONArray blockTypes() { - JSONArray a = new JSONArray(); - for (String i : data.getBlockLoader().getPossibleKeys()) { - a.put(i); - } - for (String i : IrisPlatforms.get().registries().blockTypeKeys()) { - a.put(i); - } - return a; - } - - private static String definitionReference(String key) { - return "#/definitions/" + key.replace("~", "~0").replace("/", "~1"); - } - - private static String stripNamespace(String key) { - int idx = key.indexOf(':'); - return idx < 0 ? key : key.substring(idx + 1); - } - - private JSONObject buildProperties(Class c) { + JSONObject buildProperties(Class c) { JSONObject o = new JSONObject(); JSONObject properties = new JSONObject(); String desc = getDescription(c); @@ -363,7 +122,7 @@ public class SchemaBuilder { continue; } - JSONObject property = buildProperty(k, c); + JSONObject property = propertyBuilder.buildProperty(k, c); if (Boolean.TRUE == property.remove("!top")) { extended.put(property); @@ -378,437 +137,7 @@ public class SchemaBuilder { } } - private JSONObject buildProperty(Field k, Class cl) { - JSONObject prop = new JSONObject(); - String type = getType(k.getType()); - KList description = new KList<>(); - prop.put("!required", k.isAnnotationPresent(Required.class)); - prop.put("type", type); - String fancyType = "Unknown Type"; - - switch (type) { - case "boolean" -> fancyType = "Boolean"; - case "integer" -> { - fancyType = "Integer"; - if (k.isAnnotationPresent(MinNumber.class)) { - int min = (int) k.getDeclaredAnnotation(MinNumber.class).value(); - prop.put("minimum", min); - description.add(SYMBOL_LIMIT__N + " Minimum allowed is " + min); - } - if (k.isAnnotationPresent(MaxNumber.class)) { - int max = (int) k.getDeclaredAnnotation(MaxNumber.class).value(); - prop.put("maximum", max); - description.add(SYMBOL_LIMIT__N + " Maximum allowed is " + max); - } - } - case "number" -> { - fancyType = "Number"; - if (k.isAnnotationPresent(MinNumber.class)) { - double min = k.getDeclaredAnnotation(MinNumber.class).value(); - prop.put("minimum", min); - description.add(SYMBOL_LIMIT__N + " Minimum allowed is " + min); - } - if (k.isAnnotationPresent(MaxNumber.class)) { - double max = k.getDeclaredAnnotation(MaxNumber.class).value(); - prop.put("maximum", max); - description.add(SYMBOL_LIMIT__N + " Maximum allowed is " + max); - } - } - case "string" -> { - fancyType = "Text"; - if (k.isAnnotationPresent(MinNumber.class)) { - int min = (int) k.getDeclaredAnnotation(MinNumber.class).value(); - prop.put("minLength", min); - description.add(SYMBOL_LIMIT__N + " Minimum Length allowed is " + min); - } - if (k.isAnnotationPresent(MaxNumber.class)) { - int max = (int) k.getDeclaredAnnotation(MaxNumber.class).value(); - prop.put("maxLength", max); - description.add(SYMBOL_LIMIT__N + " Maximum Length allowed is " + max); - } - - - if (k.isAnnotationPresent(RegistryListResource.class)) { - RegistryListResource rr = k.getDeclaredAnnotation(RegistryListResource.class); - ResourceLoader loader = data.getLoaders().get(rr.value()); - - if (loader != null) { - String key = "erz" + loader.getFolderName(); - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", new JSONArray(loader.getPossibleKeys())); - definitions.put(key, j); - } - - fancyType = "Iris " + loader.getResourceTypeName(); - prop.put("$ref", "#/definitions/" + key); - description.add(SYMBOL_TYPE__N + " Must be a valid " + loader.getFolderName() + " (use ctrl+space for auto complete!)"); - } else { - IrisLogging.error("Cannot find Registry Loader for type " + rr.value() + " used in " + k.getDeclaringClass().getCanonicalName() + " in field " + k.getName()); - } - } else if (k.isAnnotationPresent(RegistryListStructure.class)) { - String key = "enum-iris-structure-placement"; - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", new JSONArray(StructureSchemaKeys.collect( - Arrays.asList(data.getStructureLoader().getPossibleKeys()), - Arrays.asList(data.getJigsawPieceLoader().getPossibleKeys())).toArray(new String[0]))); - definitions.put(key, j); - } - - fancyType = "Structure"; - prop.put("$ref", "#/definitions/" + key); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or imported Iris structure (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListBlockType.class)) { - fancyType = "Block Type"; - putRegistryEnumRef(prop, "enum-block-type", this::blockTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Block Type (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListNativeJigsawPool.class)) { - fancyType = "Native Jigsaw Pool"; - putRegistryEnumRef(prop, "enum-native-jigsaw-pool", this::nativeJigsawPools); - description.add(SYMBOL_TYPE__N + " Must be a registered vanilla, datapack, or modded template pool key (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListVanillaStructure.class)) { - fancyType = "Vanilla Structure"; - if (k.getAnnotation(RegistryListVanillaStructure.class).prefixes()) { - putRegistryEnumOrPrefixRef(prop, "enum-vanilla-structure-or-prefix", - "enum-vanilla-structure", this::vanillaStructures, VANILLA_STRUCTURE_PREFIX_PATTERN); - description.add(SYMBOL_TYPE__N + " Must be a vanilla/datapack structure key or a family/namespace prefix like 'minecraft:village' or 'nova_structures:' (use ctrl+space for auto complete!)"); - } else { - putRegistryEnumRef(prop, "enum-vanilla-structure", this::vanillaStructures); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure key (use ctrl+space for auto complete!)"); - } - - } else if (k.isAnnotationPresent(RegistryListVanillaStructureSet.class)) { - fancyType = "Vanilla Structure Set"; - putRegistryEnumRef(prop, "enum-vanilla-structure-set", this::vanillaStructureSets); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure SET key (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListItemType.class)) { - fancyType = "Item Type"; - putRegistryEnumRef(prop, "enum-item-type", this::itemTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Item Type (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListEntityType.class)) { - fancyType = "Entity Type"; - putRegistryEnumRef(prop, "enum-entity-type", this::entityTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Entity Type (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListBiome.class)) { - fancyType = "Biome Type"; - putRegistryEnumRef(prop, "enum-biome-type", this::biomeTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or mod biome key (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListSpecialEntity.class)) { - fancyType = "Custom Mob Type"; - putRegistryEnumRef(prop, "enum-reg-specialentity", this::specialEntityTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Custom Mob Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListFont.class)) { - fancyType = "Font Family"; - putRegistryEnumRef(prop, "enum-font", SchemaBuilder::fontTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Font Family (use ctrl+space for auto complete!)"); - - } else if (k.isAnnotationPresent(RegistryListEnchantment.class)) { - fancyType = "Enchantment Type"; - putRegistryEnumRef(prop, "enum-enchantment", this::enchantTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Enchantment Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListPotionEffect.class)) { - fancyType = "Potion Effect Type"; - putRegistryEnumRef(prop, "enum-potion-effect-type", this::potionTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Potion Effect Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListFunction.class)) { - Class>> functionClass = k.getDeclaredAnnotation(RegistryListFunction.class).value(); - try { - ListFunction> instance = functionClass.getDeclaredConstructor().newInstance(); - String key = instance.key(); - fancyType = instance.fancyName(); - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", instance.apply(data)); - definitions.put(key, j); - } - - prop.put("$ref", "#/definitions/" + key); - description.add(SYMBOL_TYPE__N + " Must be a valid " + fancyType + " (use ctrl+space for auto complete!)"); - } catch (Throwable e) { - IrisLogging.error("Could not execute apply method in " + functionClass.getName()); - } - } else if (SchemaKeyedTypes.isKeyed(k.getType())) { - fancyType = addEnum(k.getType(), prop, description, SchemaKeyedTypes.values(k.getType()), Function.identity()); - } else if (k.getType().isEnum()) { - fancyType = addEnum(k.getType(), prop, description, enumNames(k.getType()), Function.identity()); - } - } - case "object" -> { - if (k.isAnnotationPresent(RegistryMapBlockState.class)) { - String blockType = k.getDeclaredAnnotation(RegistryMapBlockState.class).value(); - fancyType = "Block State"; - prop.put("!top", true); - JSONArray any = new JSONArray(); - prop.put("anyOf", any); - - for (BlockStateGroup group : reconstructBlockStateGroups()) { - List blocks = group.blocks(); - if (blocks.isEmpty()) { - continue; - } - - String raw = blocks.get(0).replace(':', '_'); - String enumKey = "enum-block-state-" + raw; - String propertiesKey = "obj-block-state-" + raw; - - any.put(new JSONObject() - .put("if", new JSONObject() - .put("properties", new JSONObject() - .put(blockType, new JSONObject() - .put("type", "string") - .put("$ref", definitionReference(enumKey))))) - .put("then", new JSONObject() - .put("properties", new JSONObject() - .put(k.getName(), new JSONObject() - .put("type", "object") - .put("$ref", definitionReference(propertiesKey))))) - .put("else", false)); - - if (!definitions.containsKey(enumKey)) { - JSONArray filters = new JSONArray(); - blocks.forEach(filters::put); - - definitions.put(enumKey, new JSONObject() - .put("type", "string") - .put("enum", filters)); - } - - if (!definitions.containsKey(propertiesKey)) { - JSONObject props = new JSONObject(); - for (PlatformBlockProperty property : group.properties()) { - props.put(property.name(), buildBlockPropertyJson(property)); - } - - definitions.put(propertiesKey, new JSONObject() - .put("type", "object") - .put("properties", props)); - } - } - } else { - fancyType = k.getType().getSimpleName().replaceAll("\\QIris\\E", "") + " (Object)"; - String key = "obj-" + k.getType().getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); - if (!definitions.containsKey(key)) { - definitions.put(key, new JSONObject()); - definitions.put(key, buildProperties(k.getType())); - } - prop.put("$ref", "#/definitions/" + key); - } - } - case "array" -> { - fancyType = "List of Something...?"; - ArrayType t = k.getDeclaredAnnotation(ArrayType.class); - if (t != null) { - if (t.min() > 0) { - prop.put("minItems", t.min()); - if (t.min() == 1) { - description.add(SYMBOL_LIMIT__N + " At least one entry must be defined, or just remove this list."); - } else { - description.add(SYMBOL_LIMIT__N + " Requires at least " + t.min() + " entries."); - } - } - - String arrayType = getType(t.type()); - - switch (arrayType) { - case "integer" -> fancyType = "List of Integers"; - case "number" -> fancyType = "List of Numbers"; - case "object" -> { - fancyType = "List of " + t.type().getSimpleName().replaceAll("\\QIris\\E", "") + "s (Objects)"; - String key = "obj-" + t.type().getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); - if (!definitions.containsKey(key)) { - definitions.put(key, new JSONObject()); - definitions.put(key, buildProperties(t.type())); - } - JSONObject items = new JSONObject(); - items.put("$ref", "#/definitions/" + key); - prop.put("items", items); - } - case "string" -> { - fancyType = "List of Text"; - - if (k.isAnnotationPresent(RegistryListResource.class)) { - RegistryListResource rr = k.getDeclaredAnnotation(RegistryListResource.class); - ResourceLoader loader = data.getLoaders().get(rr.value()); - - if (loader != null) { - fancyType = "List<" + loader.getResourceTypeName() + ">"; - String key = "erz" + loader.getFolderName(); - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", new JSONArray(loader.getPossibleKeys())); - definitions.put(key, j); - } - - JSONObject items = new JSONObject(); - items.put("$ref", "#/definitions/" + key); - prop.put("items", items); - description.add(SYMBOL_TYPE__N + " Must be a valid " + loader.getResourceTypeName() + " (use ctrl+space for auto complete!)"); - } else { - IrisLogging.error("Cannot find Registry Loader for type (list schema) " + rr.value() + " used in " + k.getDeclaringClass().getCanonicalName() + " in field " + k.getName()); - } - } else if (k.isAnnotationPresent(RegistryListStructure.class)) { - fancyType = "List"; - String key = "enum-iris-structure-placement"; - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", new JSONArray(StructureSchemaKeys.collect( - Arrays.asList(data.getStructureLoader().getPossibleKeys()), - Arrays.asList(data.getJigsawPieceLoader().getPossibleKeys())).toArray(new String[0]))); - definitions.put(key, j); - } - - JSONObject items = new JSONObject(); - items.put("$ref", "#/definitions/" + key); - prop.put("items", items); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or imported Iris structure (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListNativeJigsawPool.class)) { - fancyType = "List"; - putRegistryEnumItems(prop, "enum-native-jigsaw-pool", this::nativeJigsawPools); - description.add(SYMBOL_TYPE__N + " Must be a registered vanilla, datapack, or modded template pool key (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListVanillaStructure.class)) { - fancyType = "List"; - if (k.getAnnotation(RegistryListVanillaStructure.class).prefixes()) { - putRegistryEnumOrPrefixItems(prop, "enum-vanilla-structure-or-prefix", - "enum-vanilla-structure", this::vanillaStructures, VANILLA_STRUCTURE_PREFIX_PATTERN); - description.add(SYMBOL_TYPE__N + " Must be a vanilla/datapack structure key or a family/namespace prefix like 'minecraft:village' or 'nova_structures:' (use ctrl+space for auto complete!)"); - } else { - putRegistryEnumItems(prop, "enum-vanilla-structure", this::vanillaStructures); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure key (use ctrl+space for auto complete!)"); - } - } else if (k.isAnnotationPresent(RegistryListVanillaStructureSet.class)) { - fancyType = "List"; - putRegistryEnumItems(prop, "enum-vanilla-structure-set", this::vanillaStructureSets); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure set key (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListBlockType.class)) { - fancyType = "List of Block Types"; - putRegistryEnumItems(prop, "enum-block-type", this::blockTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Block Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListItemType.class)) { - fancyType = "List of Item Types"; - putRegistryEnumItems(prop, "enum-item-type", this::itemTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Item Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListEntityType.class)) { - fancyType = "List of Entity Types"; - putRegistryEnumItems(prop, "enum-entity-type", this::entityTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Entity Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListBiome.class)) { - fancyType = "List of Biome Types"; - putRegistryEnumItems(prop, "enum-biome-type", this::biomeTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or mod biome key (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListFont.class)) { - fancyType = "List of Font Families"; - putRegistryEnumItems(prop, "enum-font", SchemaBuilder::fontTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Font Family (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListEnchantment.class)) { - fancyType = "List of Enchantment Types"; - putRegistryEnumItems(prop, "enum-enchantment", this::enchantTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Enchantment Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListPotionEffect.class)) { - fancyType = "List of Potion Effect Types"; - putRegistryEnumItems(prop, "enum-potion-effect-type", this::potionTypes); - description.add(SYMBOL_TYPE__N + " Must be a valid Potion Effect Type (use ctrl+space for auto complete!)"); - } else if (k.isAnnotationPresent(RegistryListFunction.class)) { - Class>> functionClass = k.getDeclaredAnnotation(RegistryListFunction.class).value(); - try { - ListFunction> instance = functionClass.getDeclaredConstructor().newInstance(); - String key = instance.key(); - fancyType = instance.fancyName(); - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put("enum", instance.apply(data)); - definitions.put(key, j); - } - - JSONObject items = new JSONObject(); - items.put("$ref", "#/definitions/" + key); - prop.put("items", items); - description.add(SYMBOL_TYPE__N + " Must be a valid " + fancyType + " (use ctrl+space for auto complete!)"); - } catch (Throwable e) { - IrisLogging.error("Could not execute apply method in " + functionClass.getName()); - } - } else if (SchemaKeyedTypes.isKeyed(t.type())) { - fancyType = addEnumList(prop, description, t, SchemaKeyedTypes.values(t.type()), Function.identity()); - } else if (t.type().isEnum()) { - fancyType = addEnumList(prop, description, t, enumNames(t.type()), Function.identity()); - } - } - } - } else { - warnings.add("Undefined array type for field " + k.getName() + " (" + k.getType().getSimpleName() + ") in class " + cl.getSimpleName()); - } - } - default -> - warnings.add("Unexpected Schema Type: " + type + " for field " + k.getName() + " (" + k.getType().getSimpleName() + ") in class " + cl.getSimpleName()); - } - - KList d = new KList<>(); - d.add("" + k.getName() + ""); - d.add(getFieldDescription(k) + "

"); - d.add("" + fancyType + ""); - String typeDesc = getDescription(k.getType()); - boolean present = !typeDesc.isBlank(); - if (present) d.add(typeDesc); - - Snippet snippet = k.getType().getDeclaredAnnotation(Snippet.class); - if (snippet == null) { - ArrayType array = k.getType().getDeclaredAnnotation(ArrayType.class); - if (array != null) { - snippet = array.type().getDeclaredAnnotation(Snippet.class); - } - } - - if (snippet != null) { - String sm = snippet.value(); - if (present) d.add(" "); - d.add("You can instead specify \"snippet/" + sm + "/some-name.json\" to use a snippet file instead of specifying it here."); - present = false; - } - - try { - k.setAccessible(true); - Object value = k.get(cl.getDeclaredConstructor().newInstance()); - - if (value != null) { - if (present) d.add(" "); - if (value instanceof List) { - d.add(SYMBOL_LIMIT__N + " Default Value is an empty list"); - } else if (!k.getType().isPrimitive() && !(value instanceof Number) && !(value instanceof String) && !(value instanceof Enum) && !SchemaKeyedTypes.isKeyed(k.getType())) { - d.add(SYMBOL_LIMIT__N + " Default Value is a default object (create this object to see default properties)"); - } else { - d.add(SYMBOL_LIMIT__N + " Default Value is " + value); - } - } - } catch (Throwable ignored) { - - } - - description.forEach((g) -> d.add(g.trim())); - String desc = d.toString("\n") - .replace("
", "\n") - .replace("", "") - .replace("", ""); - String hDesc = d.toString("
"); - prop.put("type", type); - prop.put("description", desc); - prop.put("x-intellij-html-description", hDesc); - return buildSnippet(prop, k.getType()); - } - - private JSONObject buildSnippet(JSONObject prop, Class type) { + JSONObject buildSnippet(JSONObject prop, Class type) { Snippet snippet = type.getDeclaredAnnotation(Snippet.class); if (snippet == null) return prop; @@ -847,117 +176,7 @@ public class SchemaBuilder { return anyOf; } - @NotNull - private String addEnumList(JSONObject prop, KList description, ArrayType t, T[] values, Function function) { - JSONObject items = new JSONObject(); - String s = addEnum(t.type(), items, description, values, function); - prop.put("items", items); - - return "List of " + s + "s"; - } - - private static String[] enumNames(Class enumType) { - try { - Object[] constants = enumType.getEnumConstants(); - String[] names = new String[constants.length]; - for (int index = 0; index < constants.length; index++) { - names[index] = ((Enum) constants[index]).name(); - } - return names; - } catch (LinkageError error) { - return Arrays.stream(enumType.getDeclaredFields()) - .filter(Field::isEnumConstant) - .map(Field::getName) - .toArray(String[]::new); - } - } - - @NotNull - private String addEnum(Class type, JSONObject prop, KList description, T[] values, Function function) { - JSONArray a = new JSONArray(); - boolean advanced = type.isAnnotationPresent(Desc.class); - for (T gg : values) { - if (advanced) { - try { - JSONObject j = new JSONObject(); - String name = function.apply(gg); - j.put("const", name); - Desc dd = type.getField(name).getAnnotation(Desc.class); - String desc = dd == null ? ("No Description for " + name) : dd.value(); - j.put("description", desc); - j.put("x-intellij-html-description", desc.replace("\n", "
")); - a.put(j); - } catch (Throwable e) { - IrisLogging.reportError(e); - } - } else { - a.put(function.apply(gg)); - } - } - - String key = (advanced ? "oneof-" : "") + "enum-" + type.getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); - - if (!definitions.containsKey(key)) { - JSONObject j = new JSONObject(); - j.put(advanced ? "oneOf" : "enum", a); - definitions.put(key, j); - } - - prop.put("$ref", "#/definitions/" + key); - description.add(SYMBOL_TYPE__N + " Must be a valid " + type.getSimpleName().replaceAll("\\QIris\\E", "") + " (use ctrl+space for auto complete!)"); - return type.getSimpleName().replaceAll("\\QIris\\E", ""); - } - - private JSONObject buildBlockPropertyJson(PlatformBlockProperty property) { - JSONObject json = new JSONObject(); - json.put("type", property.jsonType()); - json.put("default", property.defaultValue()); - List allowed = property.allowedValues(); - if (!allowed.isEmpty()) { - json.put("enum", new JSONArray(allowed)); - } - if (property.hasNumericRange()) { - PlatformNumericRange range = property.numericRange(); - if ("integer".equals(property.jsonType())) { - json.put("minimum", (long) range.minimum()); - json.put("maximum", (long) range.maximum()); - } else { - json.put("minimum", range.minimum()); - json.put("maximum", range.maximum()); - } - json.put("exclusiveMinimum", range.exclusiveMinimum()); - json.put("exclusiveMaximum", range.exclusiveMaximum()); - } - return json; - } - - private List reconstructBlockStateGroups() { - List groups = new ArrayList<>(); - List currentProperties = null; - List currentBlocks = null; - for (Map.Entry> entry : IrisPlatforms.get().registries().blockStateProperties().entrySet()) { - List value = entry.getValue(); - if (currentProperties != null && value == currentProperties) { - currentBlocks.add(entry.getKey()); - } else { - currentBlocks = new ArrayList<>(); - currentBlocks.add(entry.getKey()); - currentProperties = value; - groups.add(new BlockStateGroup(currentBlocks, value)); - } - } - return groups; - } - - private List templatePoolKeys() { - if (IrisPlatforms.get().structureHooks() == null) { - return List.of(); - } - List keys = IrisPlatforms.get().structureHooks().templatePoolKeys(); - return keys == null ? List.of() : keys; - } - - private String getType(Class c) { + String getType(Class c) { if (c.equals(int.class) || c.equals(Integer.class) || c.equals(long.class) || c.equals(Long.class)) { return "integer"; } @@ -989,7 +208,7 @@ public class SchemaBuilder { return "object"; } - private String getFieldDescription(Field r) { + String getFieldDescription(Field r) { if (r.isAnnotationPresent(Desc.class)) { return r.getDeclaredAnnotation(Desc.class).value(); @@ -999,7 +218,7 @@ public class SchemaBuilder { return "No Field Description"; } - private String getDescription(Class r) { + String getDescription(Class r) { if (r.isAnnotationPresent(Desc.class)) { return r.getDeclaredAnnotation(Desc.class).value(); } @@ -1009,7 +228,4 @@ public class SchemaBuilder { } return ""; } - - private record BlockStateGroup(List blocks, List properties) { - } } diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaEnums.java b/core/src/main/java/art/arcane/iris/core/project/SchemaEnums.java new file mode 100644 index 000000000..3fe493a15 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaEnums.java @@ -0,0 +1,100 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.engine.object.annotations.ArrayType; +import art.arcane.iris.engine.object.annotations.Desc; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.json.JSONArray; +import art.arcane.volmlib.util.json.JSONObject; +import org.jetbrains.annotations.NotNull; + +import java.lang.reflect.Field; +import java.util.Arrays; +import java.util.function.Function; + +final class SchemaEnums { + private final SchemaBuilder builder; + + SchemaEnums(SchemaBuilder builder) { + this.builder = builder; + } + + @NotNull + String addEnumList(JSONObject prop, KList description, ArrayType t, T[] values, Function function) { + JSONObject items = new JSONObject(); + String s = addEnum(t.type(), items, description, values, function); + prop.put("items", items); + + return "List of " + s + "s"; + } + + static String[] enumNames(Class enumType) { + try { + Object[] constants = enumType.getEnumConstants(); + String[] names = new String[constants.length]; + for (int index = 0; index < constants.length; index++) { + names[index] = ((Enum) constants[index]).name(); + } + return names; + } catch (LinkageError error) { + return Arrays.stream(enumType.getDeclaredFields()) + .filter(Field::isEnumConstant) + .map(Field::getName) + .toArray(String[]::new); + } + } + + @NotNull + String addEnum(Class type, JSONObject prop, KList description, T[] values, Function function) { + JSONArray a = new JSONArray(); + boolean advanced = type.isAnnotationPresent(Desc.class); + for (T gg : values) { + if (advanced) { + try { + JSONObject j = new JSONObject(); + String name = function.apply(gg); + j.put("const", name); + Desc dd = type.getField(name).getAnnotation(Desc.class); + String desc = dd == null ? ("No Description for " + name) : dd.value(); + j.put("description", desc); + j.put("x-intellij-html-description", desc.replace("\n", "
")); + a.put(j); + } catch (Throwable e) { + IrisLogging.reportError(e); + } + } else { + a.put(function.apply(gg)); + } + } + + String key = (advanced ? "oneof-" : "") + "enum-" + type.getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); + + if (!builder.definitions.containsKey(key)) { + JSONObject j = new JSONObject(); + j.put(advanced ? "oneOf" : "enum", a); + builder.definitions.put(key, j); + } + + prop.put("$ref", "#/definitions/" + key); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid " + type.getSimpleName().replaceAll("\\QIris\\E", "") + " (use ctrl+space for auto complete!)"); + return type.getSimpleName().replaceAll("\\QIris\\E", ""); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaPropertyBuilder.java b/core/src/main/java/art/arcane/iris/core/project/SchemaPropertyBuilder.java new file mode 100644 index 000000000..d9c77bf9f --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaPropertyBuilder.java @@ -0,0 +1,269 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.engine.object.annotations.ArrayType; +import art.arcane.iris.engine.object.annotations.MaxNumber; +import art.arcane.iris.engine.object.annotations.MinNumber; +import art.arcane.iris.engine.object.annotations.RegistryMapBlockState; +import art.arcane.iris.engine.object.annotations.Required; +import art.arcane.iris.engine.object.annotations.Snippet; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.json.JSONObject; + +import java.lang.reflect.Field; +import java.util.List; +import java.util.function.Function; + +final class SchemaPropertyBuilder { + private final SchemaBuilder builder; + private final SchemaEnums enums; + private final SchemaBlockStates blockStates; + private final SchemaRegistryProperties registryProperties; + + SchemaPropertyBuilder(SchemaBuilder builder) { + this.builder = builder; + SchemaRegistryCatalog catalog = new SchemaRegistryCatalog(builder); + this.enums = new SchemaEnums(builder); + this.blockStates = new SchemaBlockStates(builder); + this.registryProperties = new SchemaRegistryProperties(builder, catalog); + } + + JSONObject buildProperty(Field k, Class cl) { + JSONObject prop = new JSONObject(); + String type = builder.getType(k.getType()); + KList description = new KList<>(); + prop.put("!required", k.isAnnotationPresent(Required.class)); + prop.put("type", type); + + String fancyType = switch (type) { + case "boolean" -> "Boolean"; + case "integer" -> integerProperty(k, prop, description); + case "number" -> numberProperty(k, prop, description); + case "string" -> stringProperty(k, prop, description); + case "object" -> objectProperty(k, prop); + case "array" -> arrayProperty(k, cl, prop, description); + default -> unexpectedType(type, k, cl); + }; + + return describeProperty(k, cl, prop, type, fancyType, description); + } + + private String integerProperty(Field k, JSONObject prop, KList description) { + if (k.isAnnotationPresent(MinNumber.class)) { + int min = (int) k.getDeclaredAnnotation(MinNumber.class).value(); + prop.put("minimum", min); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Minimum allowed is " + min); + } + if (k.isAnnotationPresent(MaxNumber.class)) { + int max = (int) k.getDeclaredAnnotation(MaxNumber.class).value(); + prop.put("maximum", max); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Maximum allowed is " + max); + } + return "Integer"; + } + + private String numberProperty(Field k, JSONObject prop, KList description) { + if (k.isAnnotationPresent(MinNumber.class)) { + double min = k.getDeclaredAnnotation(MinNumber.class).value(); + prop.put("minimum", min); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Minimum allowed is " + min); + } + if (k.isAnnotationPresent(MaxNumber.class)) { + double max = k.getDeclaredAnnotation(MaxNumber.class).value(); + prop.put("maximum", max); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Maximum allowed is " + max); + } + return "Number"; + } + + private String stringProperty(Field k, JSONObject prop, KList description) { + if (k.isAnnotationPresent(MinNumber.class)) { + int min = (int) k.getDeclaredAnnotation(MinNumber.class).value(); + prop.put("minLength", min); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Minimum Length allowed is " + min); + } + if (k.isAnnotationPresent(MaxNumber.class)) { + int max = (int) k.getDeclaredAnnotation(MaxNumber.class).value(); + prop.put("maxLength", max); + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Maximum Length allowed is " + max); + } + + String registryType = registryProperties.stringRegistryType(k, prop, description); + if (registryType != null) { + return registryType; + } + if (SchemaKeyedTypes.isKeyed(k.getType())) { + return enums.addEnum(k.getType(), prop, description, SchemaKeyedTypes.values(k.getType()), Function.identity()); + } + if (k.getType().isEnum()) { + return enums.addEnum(k.getType(), prop, description, SchemaEnums.enumNames(k.getType()), Function.identity()); + } + return "Text"; + } + + private String objectProperty(Field k, JSONObject prop) { + if (k.isAnnotationPresent(RegistryMapBlockState.class)) { + blockStates.applyBlockStateMap(prop, k, k.getDeclaredAnnotation(RegistryMapBlockState.class).value()); + return "Block State"; + } + + String key = "obj-" + k.getType().getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); + if (!builder.definitions.containsKey(key)) { + builder.definitions.put(key, new JSONObject()); + builder.definitions.put(key, builder.buildProperties(k.getType())); + } + prop.put("$ref", "#/definitions/" + key); + return k.getType().getSimpleName().replaceAll("\\QIris\\E", "") + " (Object)"; + } + + private String arrayProperty(Field k, Class cl, JSONObject prop, KList description) { + ArrayType t = k.getDeclaredAnnotation(ArrayType.class); + if (t == null) { + builder.warnings.add("Undefined array type for field " + k.getName() + " (" + k.getType().getSimpleName() + ") in class " + cl.getSimpleName()); + return "List of Something...?"; + } + + if (t.min() > 0) { + prop.put("minItems", t.min()); + if (t.min() == 1) { + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " At least one entry must be defined, or just remove this list."); + } else { + description.add(SchemaBuilder.SYMBOL_LIMIT__N + " Requires at least " + t.min() + " entries."); + } + } + + return switch (builder.getType(t.type())) { + case "integer" -> "List of Integers"; + case "number" -> "List of Numbers"; + case "object" -> objectArrayProperty(t, prop); + case "string" -> stringArrayProperty(k, t, prop, description); + default -> "List of Something...?"; + }; + } + + private String objectArrayProperty(ArrayType t, JSONObject prop) { + String key = "obj-" + t.type().getCanonicalName().replaceAll("\\Q.\\E", "-").toLowerCase(); + if (!builder.definitions.containsKey(key)) { + builder.definitions.put(key, new JSONObject()); + builder.definitions.put(key, builder.buildProperties(t.type())); + } + JSONObject items = new JSONObject(); + items.put("$ref", "#/definitions/" + key); + prop.put("items", items); + return "List of " + t.type().getSimpleName().replaceAll("\\QIris\\E", "") + "s (Objects)"; + } + + private String stringArrayProperty(Field k, ArrayType t, JSONObject prop, KList description) { + String registryType = registryProperties.stringArrayRegistryType(k, prop, description); + if (registryType != null) { + return registryType; + } + if (SchemaKeyedTypes.isKeyed(t.type())) { + return enums.addEnumList(prop, description, t, SchemaKeyedTypes.values(t.type()), Function.identity()); + } + if (t.type().isEnum()) { + return enums.addEnumList(prop, description, t, SchemaEnums.enumNames(t.type()), Function.identity()); + } + return "List of Text"; + } + + private String unexpectedType(String type, Field k, Class cl) { + builder.warnings.add("Unexpected Schema Type: " + type + " for field " + k.getName() + " (" + k.getType().getSimpleName() + ") in class " + cl.getSimpleName()); + return "Unknown Type"; + } + + private JSONObject describeProperty(Field k, Class cl, JSONObject prop, String type, String fancyType, KList description) { + KList d = new KList<>(); + d.add("" + k.getName() + ""); + d.add(builder.getFieldDescription(k) + "
"); + d.add("" + fancyType + ""); + String typeDesc = builder.getDescription(k.getType()); + boolean present = !typeDesc.isBlank(); + if (present) { + d.add(typeDesc); + } + + present = appendSnippetHint(k, d, present); + appendDefaultValue(k, cl, d, present); + + description.forEach((g) -> d.add(g.trim())); + String desc = d.toString("\n") + .replace("
", "\n") + .replace("", "") + .replace("", ""); + String hDesc = d.toString("
"); + prop.put("type", type); + prop.put("description", desc); + prop.put("x-intellij-html-description", hDesc); + return builder.buildSnippet(prop, k.getType()); + } + + private boolean appendSnippetHint(Field k, KList d, boolean present) { + Snippet snippet = k.getType().getDeclaredAnnotation(Snippet.class); + if (snippet == null) { + ArrayType array = k.getType().getDeclaredAnnotation(ArrayType.class); + if (array != null) { + snippet = array.type().getDeclaredAnnotation(Snippet.class); + } + } + + if (snippet == null) { + return present; + } + + String sm = snippet.value(); + if (present) { + d.add(" "); + } + d.add("You can instead specify \"snippet/" + sm + "/some-name.json\" to use a snippet file instead of specifying it here."); + return false; + } + + private void appendDefaultValue(Field k, Class cl, KList d, boolean present) { + Object instance; + try { + instance = cl.getDeclaredConstructor().newInstance(); + } catch (ReflectiveOperationException | LinkageError e) { + return; + } + + try { + k.setAccessible(true); + Object value = k.get(instance); + + if (value != null) { + if (present) { + d.add(" "); + } + if (value instanceof List) { + d.add(SchemaBuilder.SYMBOL_LIMIT__N + " Default Value is an empty list"); + } else if (!k.getType().isPrimitive() && !(value instanceof Number) && !(value instanceof String) && !(value instanceof Enum) && !SchemaKeyedTypes.isKeyed(k.getType())) { + d.add(SchemaBuilder.SYMBOL_LIMIT__N + " Default Value is a default object (create this object to see default properties)"); + } else { + d.add(SchemaBuilder.SYMBOL_LIMIT__N + " Default Value is " + value); + } + } + } catch (Throwable e) { + IrisLogging.reportError("Schema default value unavailable for " + + cl.getCanonicalName() + "." + k.getName(), e); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryCatalog.java b/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryCatalog.java new file mode 100644 index 000000000..706c6fc24 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryCatalog.java @@ -0,0 +1,252 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.spi.CapabilityProbe; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.volmlib.util.json.JSONArray; +import art.arcane.volmlib.util.json.JSONObject; + +import java.awt.GraphicsEnvironment; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.function.Supplier; + +final class SchemaRegistryCatalog { + /** Namespaced key or family/namespace prefix: "minecraft:village_plains", "minecraft:village", "nova_structures:". */ + static final String VANILLA_STRUCTURE_PREFIX_PATTERN = "^[a-z0-9_.-]+:[a-z0-9_./-]*$"; + private static final String MINECRAFT_NAMESPACE = "minecraft:"; + private static volatile JSONArray fontTypes; + private final SchemaBuilder builder; + private JSONArray potionTypes; + private JSONArray enchantTypes; + + SchemaRegistryCatalog(SchemaBuilder builder) { + this.builder = builder; + } + + /** + * Font families are only used for schema completion. Enumerating them touches AWT, which can fail outright on a + * headless or mod-loader JVM - a failure degrades to no completion, never to a broken schema. + */ + static JSONArray fontTypes() { + JSONArray cached = fontTypes; + if (cached != null) { + return cached; + } + JSONArray built = CapabilityProbe.attempt("java.awt font families", + () -> new JSONArray(GraphicsEnvironment.getLocalGraphicsEnvironment().getAvailableFontFamilyNames()), + new JSONArray()); + fontTypes = built; + return built; + } + + JSONArray potionTypes() { + if (potionTypes == null) { + potionTypes = registryKeyForms(IrisPlatforms.get().registries().potionEffectKeys(), true); + } + return potionTypes; + } + + JSONArray enchantTypes() { + if (enchantTypes == null) { + enchantTypes = registryKeyForms(IrisPlatforms.get().registries().enchantmentKeys(), false); + } + return enchantTypes; + } + + /** + * Emits the full namespaced key for every registry entry, so mod and datapack content is addressable + * unambiguously, plus the legacy short form for the vanilla namespace so existing packs stay valid. + */ + private static JSONArray registryKeyForms(List keys, boolean upperCaseLegacy) { + JSONArray a = new JSONArray(); + Set seen = new LinkedHashSet<>(); + if (keys != null) { + for (String key : keys) { + if (key == null || key.isBlank()) { + continue; + } + seen.add(key); + if (key.startsWith(MINECRAFT_NAMESPACE) || key.indexOf(':') < 0) { + String path = stripNamespace(key); + seen.add(upperCaseLegacy ? path.toUpperCase(Locale.ROOT).replace(' ', '_') : path); + } + } + } + for (String key : seen) { + a.put(key); + } + return a; + } + + /** + * Biome derivatives resolve through NamespacedKey.fromString, which accepts a full key or a bare vanilla path, + * so both forms are offered. + */ + JSONArray biomeTypes() { + return registryKeyForms(IrisPlatforms.get().registries().biomeKeys(), false); + } + + JSONArray entityTypes() { + return keysAsArray(IrisPlatforms.get().registries().entityKeys()); + } + + JSONArray specialEntityTypes() { + return keysAsArray(IrisPlatforms.get().registries().specialEntityKeys()); + } + + JSONArray vanillaStructures() { + return keysAsArray(IrisPlatforms.get().registries().structureKeys()); + } + + JSONArray vanillaStructureSets() { + if (IrisPlatforms.get().structureHooks() == null) { + return new JSONArray(); + } + List keys = IrisPlatforms.get().structureHooks().structureSetKeys(); + return keysAsArray(keys == null ? List.of() : keys); + } + + JSONArray nativeJigsawPools() { + return keysAsArray(templatePoolKeys()); + } + + private static JSONArray keysAsArray(List keys) { + JSONArray a = new JSONArray(); + if (keys != null) { + for (String key : keys) { + if (key != null && !key.isBlank()) { + a.put(key); + } + } + } + return a; + } + + /** + * Registers a registry-backed enum definition under {@code definitionKey} and points {@code target} at it. + *

+ * An empty key list means the registry has nothing to offer yet - the server is still booting, a modded registry + * has not been frozen, or the host simply does not expose that catalog. Emitting {@code "enum": []} in that case + * writes a schema that rejects every value the author could possibly type, turning a missing autocomplete list + * into a pack that reads as broken in the editor. The reference is omitted instead, leaving the field + * unconstrained, and the values are only computed when the definition does not exist yet. + */ + void putRegistryEnumRef(JSONObject target, String definitionKey, Supplier values) { + if (!builder.definitions.containsKey(definitionKey)) { + JSONArray built = values.get(); + if (built == null || built.length() == 0) { + IrisLogging.debug("Schema enum '" + definitionKey + "' omitted: the registry returned no keys"); + return; + } + JSONObject definition = new JSONObject(); + definition.put("enum", built); + builder.definitions.put(definitionKey, definition); + } + target.put("$ref", "#/definitions/" + definitionKey); + } + + /** + * {@link #putRegistryEnumRef(JSONObject, String, Supplier)} for a list-typed property. When the enum is omitted no + * {@code items} schema is written at all, which is valid and simply means "any element". + */ + void putRegistryEnumItems(JSONObject prop, String definitionKey, Supplier values) { + JSONObject items = new JSONObject(); + putRegistryEnumRef(items, definitionKey, values); + if (items.has("$ref")) { + prop.put("items", items); + } + } + + /** + * A registry enum that ALSO accepts family/namespace prefixes ("minecraft:village", + * "nova_structures:") — the runtime prefix-matching contract of importedStructures.disabled and + * adjustments[].match. Emitted as anyOf(enum, pattern) so autocomplete still offers registered + * keys while prefix entries validate instead of being rejected. + */ + void putRegistryEnumOrPrefixRef(JSONObject target, String definitionKey, + String enumDefinitionKey, Supplier values, + String pattern) { + if (!builder.definitions.containsKey(definitionKey)) { + JSONArray anyOf = new JSONArray(); + JSONObject enumRef = new JSONObject(); + try { + putRegistryEnumRef(enumRef, enumDefinitionKey, values); + } catch (RuntimeException e) { + IrisLogging.reportError("Schema enum '" + enumDefinitionKey + + "' unavailable; emitting prefix pattern only", e); + } + if (enumRef.has("$ref")) { + anyOf.put(enumRef); + } + JSONObject prefix = new JSONObject(); + prefix.put("type", "string"); + prefix.put("pattern", pattern); + anyOf.put(prefix); + JSONObject definition = new JSONObject(); + definition.put("anyOf", anyOf); + builder.definitions.put(definitionKey, definition); + } + target.put("$ref", "#/definitions/" + definitionKey); + } + + void putRegistryEnumOrPrefixItems(JSONObject prop, String definitionKey, + String enumDefinitionKey, Supplier values, + String pattern) { + JSONObject items = new JSONObject(); + putRegistryEnumOrPrefixRef(items, definitionKey, enumDefinitionKey, values, pattern); + prop.put("items", items); + } + + JSONArray itemTypes() { + JSONArray a = new JSONArray(); + for (String key : IrisPlatforms.get().registries().itemKeys()) { + a.put(key.startsWith(MINECRAFT_NAMESPACE) ? key.substring(MINECRAFT_NAMESPACE.length()) : key); + } + return a; + } + + JSONArray blockTypes() { + JSONArray a = new JSONArray(); + for (String i : builder.data.getBlockLoader().getPossibleKeys()) { + a.put(i); + } + for (String i : IrisPlatforms.get().registries().blockTypeKeys()) { + a.put(i); + } + return a; + } + + private static String stripNamespace(String key) { + int idx = key.indexOf(':'); + return idx < 0 ? key : key.substring(idx + 1); + } + + private List templatePoolKeys() { + if (IrisPlatforms.get().structureHooks() == null) { + return List.of(); + } + List keys = IrisPlatforms.get().structureHooks().templatePoolKeys(); + return keys == null ? List.of() : keys; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryProperties.java b/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryProperties.java new file mode 100644 index 000000000..9b445a51c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/project/SchemaRegistryProperties.java @@ -0,0 +1,288 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.core.loader.ResourceLoader; +import art.arcane.iris.core.structure.StructureSchemaKeys; +import art.arcane.iris.engine.framework.ListFunction; +import art.arcane.iris.engine.object.annotations.RegistryListBiome; +import art.arcane.iris.engine.object.annotations.RegistryListBlockType; +import art.arcane.iris.engine.object.annotations.RegistryListEnchantment; +import art.arcane.iris.engine.object.annotations.RegistryListEntityType; +import art.arcane.iris.engine.object.annotations.RegistryListFont; +import art.arcane.iris.engine.object.annotations.RegistryListFunction; +import art.arcane.iris.engine.object.annotations.RegistryListItemType; +import art.arcane.iris.engine.object.annotations.RegistryListNativeJigsawPool; +import art.arcane.iris.engine.object.annotations.RegistryListPotionEffect; +import art.arcane.iris.engine.object.annotations.RegistryListResource; +import art.arcane.iris.engine.object.annotations.RegistryListSpecialEntity; +import art.arcane.iris.engine.object.annotations.RegistryListStructure; +import art.arcane.iris.engine.object.annotations.RegistryListVanillaStructure; +import art.arcane.iris.engine.object.annotations.RegistryListVanillaStructureSet; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.json.JSONArray; +import art.arcane.volmlib.util.json.JSONObject; + +import java.lang.reflect.Field; +import java.util.Arrays; + +final class SchemaRegistryProperties { + private static final String IRIS_STRUCTURE_DEFINITION = "enum-iris-structure-placement"; + private final SchemaBuilder builder; + private final SchemaRegistryCatalog catalog; + + SchemaRegistryProperties(SchemaBuilder builder, SchemaRegistryCatalog catalog) { + this.builder = builder; + this.catalog = catalog; + } + + String stringRegistryType(Field k, JSONObject prop, KList description) { + if (k.isAnnotationPresent(RegistryListResource.class)) { + return resourceReference(k, prop, description); + } + if (k.isAnnotationPresent(RegistryListStructure.class)) { + putIrisStructureDefinition(); + prop.put("$ref", "#/definitions/" + IRIS_STRUCTURE_DEFINITION); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or imported Iris structure (use ctrl+space for auto complete!)"); + return "Structure"; + } + if (k.isAnnotationPresent(RegistryListBlockType.class)) { + catalog.putRegistryEnumRef(prop, "enum-block-type", catalog::blockTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Block Type (use ctrl+space for auto complete!)"); + return "Block Type"; + } + if (k.isAnnotationPresent(RegistryListNativeJigsawPool.class)) { + catalog.putRegistryEnumRef(prop, "enum-native-jigsaw-pool", catalog::nativeJigsawPools); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a registered vanilla, datapack, or modded template pool key (use ctrl+space for auto complete!)"); + return "Native Jigsaw Pool"; + } + if (k.isAnnotationPresent(RegistryListVanillaStructure.class)) { + if (k.getAnnotation(RegistryListVanillaStructure.class).prefixes()) { + catalog.putRegistryEnumOrPrefixRef(prop, "enum-vanilla-structure-or-prefix", + "enum-vanilla-structure", catalog::vanillaStructures, SchemaRegistryCatalog.VANILLA_STRUCTURE_PREFIX_PATTERN); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a vanilla/datapack structure key or a family/namespace prefix like 'minecraft:village' or 'nova_structures:' (use ctrl+space for auto complete!)"); + } else { + catalog.putRegistryEnumRef(prop, "enum-vanilla-structure", catalog::vanillaStructures); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure key (use ctrl+space for auto complete!)"); + } + return "Vanilla Structure"; + } + if (k.isAnnotationPresent(RegistryListVanillaStructureSet.class)) { + catalog.putRegistryEnumRef(prop, "enum-vanilla-structure-set", catalog::vanillaStructureSets); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure SET key (use ctrl+space for auto complete!)"); + return "Vanilla Structure Set"; + } + if (k.isAnnotationPresent(RegistryListItemType.class)) { + catalog.putRegistryEnumRef(prop, "enum-item-type", catalog::itemTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Item Type (use ctrl+space for auto complete!)"); + return "Item Type"; + } + if (k.isAnnotationPresent(RegistryListEntityType.class)) { + catalog.putRegistryEnumRef(prop, "enum-entity-type", catalog::entityTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Entity Type (use ctrl+space for auto complete!)"); + return "Entity Type"; + } + if (k.isAnnotationPresent(RegistryListBiome.class)) { + catalog.putRegistryEnumRef(prop, "enum-biome-type", catalog::biomeTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or mod biome key (use ctrl+space for auto complete!)"); + return "Biome Type"; + } + if (k.isAnnotationPresent(RegistryListSpecialEntity.class)) { + catalog.putRegistryEnumRef(prop, "enum-reg-specialentity", catalog::specialEntityTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Custom Mob Type (use ctrl+space for auto complete!)"); + return "Custom Mob Type"; + } + if (k.isAnnotationPresent(RegistryListFont.class)) { + catalog.putRegistryEnumRef(prop, "enum-font", SchemaRegistryCatalog::fontTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Font Family (use ctrl+space for auto complete!)"); + return "Font Family"; + } + if (k.isAnnotationPresent(RegistryListEnchantment.class)) { + catalog.putRegistryEnumRef(prop, "enum-enchantment", catalog::enchantTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Enchantment Type (use ctrl+space for auto complete!)"); + return "Enchantment Type"; + } + if (k.isAnnotationPresent(RegistryListPotionEffect.class)) { + catalog.putRegistryEnumRef(prop, "enum-potion-effect-type", catalog::potionTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Potion Effect Type (use ctrl+space for auto complete!)"); + return "Potion Effect Type"; + } + if (k.isAnnotationPresent(RegistryListFunction.class)) { + return functionReference(k, prop, description, "Text", false); + } + return null; + } + + String stringArrayRegistryType(Field k, JSONObject prop, KList description) { + if (k.isAnnotationPresent(RegistryListResource.class)) { + return resourceItems(k, prop, description); + } + if (k.isAnnotationPresent(RegistryListStructure.class)) { + putIrisStructureDefinition(); + putItemsReference(prop, IRIS_STRUCTURE_DEFINITION); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or imported Iris structure (use ctrl+space for auto complete!)"); + return "List"; + } + if (k.isAnnotationPresent(RegistryListNativeJigsawPool.class)) { + catalog.putRegistryEnumItems(prop, "enum-native-jigsaw-pool", catalog::nativeJigsawPools); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a registered vanilla, datapack, or modded template pool key (use ctrl+space for auto complete!)"); + return "List"; + } + if (k.isAnnotationPresent(RegistryListVanillaStructure.class)) { + if (k.getAnnotation(RegistryListVanillaStructure.class).prefixes()) { + catalog.putRegistryEnumOrPrefixItems(prop, "enum-vanilla-structure-or-prefix", + "enum-vanilla-structure", catalog::vanillaStructures, SchemaRegistryCatalog.VANILLA_STRUCTURE_PREFIX_PATTERN); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a vanilla/datapack structure key or a family/namespace prefix like 'minecraft:village' or 'nova_structures:' (use ctrl+space for auto complete!)"); + } else { + catalog.putRegistryEnumItems(prop, "enum-vanilla-structure", catalog::vanillaStructures); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure key (use ctrl+space for auto complete!)"); + } + return "List"; + } + if (k.isAnnotationPresent(RegistryListVanillaStructureSet.class)) { + catalog.putRegistryEnumItems(prop, "enum-vanilla-structure-set", catalog::vanillaStructureSets); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla/datapack structure set key (use ctrl+space for auto complete!)"); + return "List"; + } + if (k.isAnnotationPresent(RegistryListBlockType.class)) { + catalog.putRegistryEnumItems(prop, "enum-block-type", catalog::blockTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Block Type (use ctrl+space for auto complete!)"); + return "List of Block Types"; + } + if (k.isAnnotationPresent(RegistryListItemType.class)) { + catalog.putRegistryEnumItems(prop, "enum-item-type", catalog::itemTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Item Type (use ctrl+space for auto complete!)"); + return "List of Item Types"; + } + if (k.isAnnotationPresent(RegistryListEntityType.class)) { + catalog.putRegistryEnumItems(prop, "enum-entity-type", catalog::entityTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Entity Type (use ctrl+space for auto complete!)"); + return "List of Entity Types"; + } + if (k.isAnnotationPresent(RegistryListBiome.class)) { + catalog.putRegistryEnumItems(prop, "enum-biome-type", catalog::biomeTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid vanilla, datapack, or mod biome key (use ctrl+space for auto complete!)"); + return "List of Biome Types"; + } + if (k.isAnnotationPresent(RegistryListFont.class)) { + catalog.putRegistryEnumItems(prop, "enum-font", SchemaRegistryCatalog::fontTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Font Family (use ctrl+space for auto complete!)"); + return "List of Font Families"; + } + if (k.isAnnotationPresent(RegistryListEnchantment.class)) { + catalog.putRegistryEnumItems(prop, "enum-enchantment", catalog::enchantTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Enchantment Type (use ctrl+space for auto complete!)"); + return "List of Enchantment Types"; + } + if (k.isAnnotationPresent(RegistryListPotionEffect.class)) { + catalog.putRegistryEnumItems(prop, "enum-potion-effect-type", catalog::potionTypes); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid Potion Effect Type (use ctrl+space for auto complete!)"); + return "List of Potion Effect Types"; + } + if (k.isAnnotationPresent(RegistryListFunction.class)) { + return functionReference(k, prop, description, "List of Text", true); + } + return null; + } + + private String resourceReference(Field k, JSONObject prop, KList description) { + RegistryListResource rr = k.getDeclaredAnnotation(RegistryListResource.class); + ResourceLoader loader = builder.data.getLoaders().get(rr.value()); + + if (loader == null) { + IrisLogging.error("Cannot find Registry Loader for type " + rr.value() + " used in " + k.getDeclaringClass().getCanonicalName() + " in field " + k.getName()); + return "Text"; + } + + String key = "erz" + loader.getFolderName(); + putResourceDefinition(key, loader); + prop.put("$ref", "#/definitions/" + key); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid " + loader.getFolderName() + " (use ctrl+space for auto complete!)"); + return "Iris " + loader.getResourceTypeName(); + } + + private String resourceItems(Field k, JSONObject prop, KList description) { + RegistryListResource rr = k.getDeclaredAnnotation(RegistryListResource.class); + ResourceLoader loader = builder.data.getLoaders().get(rr.value()); + + if (loader == null) { + IrisLogging.error("Cannot find Registry Loader for type (list schema) " + rr.value() + " used in " + k.getDeclaringClass().getCanonicalName() + " in field " + k.getName()); + return "List of Text"; + } + + String key = "erz" + loader.getFolderName(); + putResourceDefinition(key, loader); + putItemsReference(prop, key); + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid " + loader.getResourceTypeName() + " (use ctrl+space for auto complete!)"); + return "List<" + loader.getResourceTypeName() + ">"; + } + + private String functionReference(Field k, JSONObject prop, KList description, String fallbackType, boolean asItems) { + Class>> functionClass = k.getDeclaredAnnotation(RegistryListFunction.class).value(); + String fancyType = fallbackType; + + try { + ListFunction> instance = functionClass.getDeclaredConstructor().newInstance(); + String key = instance.key(); + fancyType = instance.fancyName(); + + if (!builder.definitions.containsKey(key)) { + JSONObject j = new JSONObject(); + j.put("enum", instance.apply(builder.data)); + builder.definitions.put(key, j); + } + + if (asItems) { + putItemsReference(prop, key); + } else { + prop.put("$ref", "#/definitions/" + key); + } + description.add(SchemaBuilder.SYMBOL_TYPE__N + " Must be a valid " + fancyType + " (use ctrl+space for auto complete!)"); + } catch (Throwable e) { + IrisLogging.reportError("Could not execute apply method in " + functionClass.getName(), e); + } + + return fancyType; + } + + private void putResourceDefinition(String key, ResourceLoader loader) { + if (!builder.definitions.containsKey(key)) { + JSONObject j = new JSONObject(); + j.put("enum", new JSONArray(loader.getPossibleKeys())); + builder.definitions.put(key, j); + } + } + + private void putIrisStructureDefinition() { + if (!builder.definitions.containsKey(IRIS_STRUCTURE_DEFINITION)) { + JSONObject j = new JSONObject(); + j.put("enum", new JSONArray(StructureSchemaKeys.collect( + Arrays.asList(builder.data.getStructureLoader().getPossibleKeys()), + Arrays.asList(builder.data.getJigsawPieceLoader().getPossibleKeys())).toArray(new String[0]))); + builder.definitions.put(IRIS_STRUCTURE_DEFINITION, j); + } + } + + private void putItemsReference(JSONObject prop, String key) { + JSONObject items = new JSONObject(); + items.put("$ref", "#/definitions/" + key); + prop.put("items", items); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderIdentityTest.java b/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderIdentityTest.java new file mode 100644 index 000000000..93dda171a --- /dev/null +++ b/core/src/test/java/art/arcane/iris/core/project/SchemaBuilderIdentityTest.java @@ -0,0 +1,395 @@ +/* + * Iris is a World Generator for Minecraft Servers + * Copyright (c) 2026 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.project; + +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.loader.IrisRegistrant; +import art.arcane.iris.core.loader.ResourceLoader; +import art.arcane.iris.engine.object.IrisBiome; +import art.arcane.iris.engine.object.IrisBlockData; +import art.arcane.iris.engine.object.IrisDimension; +import art.arcane.iris.engine.object.IrisEntity; +import art.arcane.iris.engine.object.IrisExpression; +import art.arcane.iris.engine.object.IrisGenerator; +import art.arcane.iris.engine.object.IrisHydrology; +import art.arcane.iris.engine.object.IrisImageMap; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisLootTable; +import art.arcane.iris.engine.object.IrisObjectPlacement; +import art.arcane.iris.engine.object.IrisRegion; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.engine.object.IrisStructurePlacement; +import art.arcane.iris.engine.object.IrisVanillaStructureAdjustment; +import art.arcane.iris.spi.IrisPlatform; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.spi.LogLevel; +import art.arcane.iris.spi.PlatformBiome; +import art.arcane.iris.spi.PlatformBiomeWriter; +import art.arcane.iris.spi.PlatformBlockProperty; +import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.spi.PlatformEntityType; +import art.arcane.iris.spi.PlatformItem; +import art.arcane.iris.spi.PlatformNumericRange; +import art.arcane.iris.spi.PlatformRegistries; +import art.arcane.iris.spi.PlatformScheduler; +import art.arcane.iris.spi.PlatformStructureHooks; +import art.arcane.iris.spi.PlatformWorld; +import art.arcane.iris.testsupport.PlatformLeakGuard; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.collection.KMap; +import art.arcane.volmlib.util.json.JSONArray; +import art.arcane.volmlib.util.json.JSONObject; +import org.junit.After; +import org.junit.Before; +import org.junit.ClassRule; +import org.junit.Test; + +import java.io.File; +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.TreeSet; + +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +public class SchemaBuilderIdentityTest { + @ClassRule + public static final PlatformLeakGuard PLATFORM_GUARD = PlatformLeakGuard.clean(); + + private static final String EXPECTED_SCHEMA_DIGEST = "375be26228878d948d5dd4ccd4593fc3285c9a5a1dd1943a38e289d7c932c711"; + + private static final List> SCHEMA_ROOTS = List.of( + IrisDimension.class, + IrisRegion.class, + IrisBiome.class, + IrisGenerator.class, + IrisHydrology.class, + IrisObjectPlacement.class, + IrisStructure.class, + IrisStructurePlacement.class, + IrisJigsawPiece.class, + IrisVanillaStructureAdjustment.class, + IrisEntity.class, + IrisLootTable.class, + IrisBlockData.class, + IrisImageMap.class, + IrisExpression.class); + + private IrisPlatform previous; + + @Before + public void bindFakePlatform() { + previous = IrisPlatforms.isBound() ? IrisPlatforms.get() : null; + if (previous != null) { + IrisPlatforms.unbind(); + } + IrisPlatforms.bind(new FakePlatform()); + } + + @After + public void restorePlatform() { + IrisPlatforms.unbind(); + if (previous != null) { + IrisPlatforms.bind(previous); + } + } + + @Test + public void studioSchemaOutputIsByteIdentical() { + StringBuilder canonical = new StringBuilder(); + for (Class root : SCHEMA_ROOTS) { + canonical.append(root.getName()).append('\n'); + canonical.append(canonicalize(new SchemaBuilder(root, schemaData()).construct())); + canonical.append('\n'); + } + assertEquals(EXPECTED_SCHEMA_DIGEST, digest(canonical.toString())); + } + + private static String digest(String value) { + MessageDigest sha256; + try { + sha256 = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException(e); + } + byte[] hash = sha256.digest(value.getBytes(StandardCharsets.UTF_8)); + StringBuilder hex = new StringBuilder(hash.length * 2); + for (byte b : hash) { + hex.append(Character.forDigit((b >> 4) & 0xF, 16)); + hex.append(Character.forDigit(b & 0xF, 16)); + } + return hex.toString(); + } + + private static String canonicalize(Object value) { + StringBuilder out = new StringBuilder(); + appendCanonical(out, value); + return out.toString(); + } + + private static void appendCanonical(StringBuilder out, Object value) { + if (value instanceof JSONObject object) { + out.append('{'); + boolean first = true; + for (String key : new TreeSet<>(object.keySet())) { + if (!first) { + out.append(','); + } + first = false; + out.append('"').append(key).append("\":"); + appendCanonical(out, object.get(key)); + } + out.append('}'); + return; + } + if (value instanceof JSONArray array) { + out.append('['); + for (int index = 0; index < array.length(); index++) { + if (index > 0) { + out.append(','); + } + appendCanonical(out, array.get(index)); + } + out.append(']'); + return; + } + out.append('<').append(value == null ? "null" : value.getClass().getSimpleName()).append(':'); + out.append(String.valueOf(value)).append('>'); + } + + private static IrisData schemaData() { + IrisData data = mock(IrisData.class); + ResourceLoader structureLoader = mock(ResourceLoader.class); + ResourceLoader pieceLoader = mock(ResourceLoader.class); + ResourceLoader expressionLoader = mock(ResourceLoader.class); + ResourceLoader blockLoader = mock(ResourceLoader.class); + KMap, ResourceLoader> loaders = new KMap<>(); + loaders.put(IrisExpression.class, expressionLoader); + when(data.getStructureLoader()).thenReturn(structureLoader); + when(data.getJigsawPieceLoader()).thenReturn(pieceLoader); + when(data.getBlockLoader()).thenReturn(blockLoader); + when(data.getLoaders()).thenReturn(loaders); + when(data.getPossibleSnippets(anyString())).thenReturn(new KList().qadd("alpha").qadd("beta")); + when(structureLoader.getPossibleKeys()).thenReturn(new String[]{"pack/tower", "pack/keep"}); + when(pieceLoader.getPossibleKeys()).thenReturn(new String[]{"pack/tower-base"}); + when(blockLoader.getPossibleKeys()).thenReturn(new String[]{"pack/mossy_stone"}); + when(expressionLoader.getPossibleKeys()).thenReturn(new String[]{"pack/height"}); + when(expressionLoader.getFolderName()).thenReturn("expressions"); + when(expressionLoader.getResourceTypeName()).thenReturn("Expression"); + return data; + } + + private static final class FakeRegistries implements PlatformRegistries { + private static final List STONE_PROPERTIES = List.of( + new PlatformBlockProperty("waterlogged", "boolean", Boolean.FALSE, List.of(Boolean.TRUE, Boolean.FALSE), null), + new PlatformBlockProperty("level", "integer", 0, List.of(0, 1, 2), + new PlatformNumericRange(0D, 2D, false, false))); + private static final List LOG_PROPERTIES = List.of( + new PlatformBlockProperty("axis", "string", "y", List.of("x", "y", "z"), null)); + + @Override + public PlatformBlockState block(String key) { + return null; + } + + @Override + public PlatformBlockState blockOrNull(String key) { + return null; + } + + @Override + public PlatformBlockState blockOrNull(String key, boolean warn) { + return null; + } + + @Override + public PlatformBlockState air() { + return null; + } + + @Override + public PlatformBlockState deepSlateOre(PlatformBlockState block, PlatformBlockState ore) { + return null; + } + + @Override + public PlatformBiome biome(String key) { + return null; + } + + @Override + public PlatformItem item(String key) { + return null; + } + + @Override + public PlatformEntityType entity(String key) { + return null; + } + + @Override + public List blockKeys() { + return List.of("minecraft:stone", "minecraft:oak_log"); + } + + @Override + public List biomeKeys() { + return List.of("minecraft:plains", "minecraft:desert", "cool_mod:sky_meadow"); + } + + @Override + public List specialEntityKeys() { + return List.of("mythicmobs:skeleton_king"); + } + + @Override + public List structureKeys() { + return List.of("minecraft:monument", "minecraft:stronghold", "cool_mod:sky_temple"); + } + + @Override + public List itemKeys() { + return List.of("minecraft:stone", "minecraft:diamond_sword", "cool_mod:ruby"); + } + + @Override + public List entityKeys() { + return List.of("minecraft:zombie", "cool_mod:grizzly_bear"); + } + + @Override + public List blockTypeKeys() { + return List.of("minecraft:stone", "minecraft:oak_log"); + } + + @Override + public List enchantmentKeys() { + return List.of("minecraft:sharpness", "cool_mod:vorpal"); + } + + @Override + public List potionEffectKeys() { + return List.of("minecraft:speed", "minecraft:slow_falling", "sniffer_mod:mega_boost"); + } + + @Override + public List lootTableKeys() { + return List.of("minecraft:chests/simple_dungeon", "cool_mod:chests/sky_temple"); + } + + @Override + public Map> blockStateProperties() { + Map> properties = new LinkedHashMap<>(); + properties.put("minecraft:stone", STONE_PROPERTIES); + properties.put("minecraft:andesite", STONE_PROPERTIES); + properties.put("minecraft:oak_log", LOG_PROPERTIES); + return properties; + } + } + + private static final class FakePlatform implements IrisPlatform { + private final PlatformRegistries registries = new FakeRegistries(); + + @Override + public String platformName() { + return "fake"; + } + + @Override + public String minecraftVersion() { + return "0.0.0"; + } + + @Override + public PlatformRegistries registries() { + return registries; + } + + @Override + public PlatformScheduler scheduler() { + return null; + } + + @Override + public PlatformStructureHooks structureHooks() { + return null; + } + + @Override + public PlatformBiomeWriter biomeWriter() { + return null; + } + + @Override + public File dataFolder() { + return new File("."); + } + + @Override + public File dataFile(String... path) { + return new File("."); + } + + @Override + public File pluginJar() { + return new File("."); + } + + @Override + public int irisVersionNumber() { + return 0; + } + + @Override + public int minecraftVersionNumber() { + return 0; + } + + @Override + public void callEvent(Object event) { + } + + @Override + public void dispatchConsoleCommand(String command) { + } + + @Override + public boolean spawnEntity(PlatformWorld world, String entityKey, double x, double y, double z) { + return false; + } + + @Override + public void log(LogLevel level, String message) { + } + + @Override + public void msg(String message) { + } + + @Override + public void reportError(Throwable error) { + } + } +} From 422618282edc5c680f6869a7481a422a8ea8d7f4 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:04:48 -0400 Subject: [PATCH 22/35] Split datapack ingest service - Keep ingest orchestration and the public entry points in DatapackIngestService and move startup validation, staging reapply, removal, install planning, ownership, manifests, transactions and recovery into dedicated package classes - Promote the shared ingest data types to top level so every collaborator addresses them directly - Report the managed metadata IO failures on the reapply path instead of logging them at debug - Requalify DatapackIngestServiceTest call sites onto the new owners without changing any test --- .../core/datapack/CoordinatorDirectory.java | 37 + .../core/datapack/CoordinatorEditable.java | 26 + .../core/datapack/CoordinatorJournal.java | 37 + .../core/datapack/CoordinatorOperation.java | 25 + .../iris/core/datapack/CoordinatorPhase.java | 31 + .../iris/core/datapack/DatapackArchive.java | 415 ++ .../core/datapack/DatapackCoordinator.java | 41 + .../DatapackCoordinatorResolution.java | 438 ++ .../core/datapack/DatapackImportSources.java | 146 + .../core/datapack/DatapackIngestService.java | 5915 +---------------- .../iris/core/datapack/DatapackInstall.java | 331 + .../core/datapack/DatapackInstallPlanner.java | 394 ++ .../core/datapack/DatapackManifestStore.java | 316 + .../iris/core/datapack/DatapackOwnership.java | 379 ++ .../core/datapack/DatapackPackMetadata.java | 155 + .../iris/core/datapack/DatapackRemoval.java | 468 ++ .../datapack/DatapackScratchRecovery.java | 436 ++ .../core/datapack/DatapackStagingGuard.java | 256 + .../core/datapack/DatapackStagingReapply.java | 312 + .../datapack/DatapackStartupValidation.java | 385 ++ .../datapack/DatapackStructureImports.java | 489 ++ .../iris/core/datapack/DatapackSupport.java | 277 + .../core/datapack/DatapackTransactions.java | 342 + .../iris/core/datapack/DirectoryDeleter.java | 26 + .../iris/core/datapack/DirectoryMove.java | 34 + .../iris/core/datapack/DirectoryRemoval.java | 179 + .../iris/core/datapack/DownloadResult.java | 23 + .../core/datapack/EditableImportRemoval.java | 171 + .../iris/core/datapack/InstallExecution.java | 96 + .../iris/core/datapack/InstallPlan.java | 45 + .../iris/core/datapack/InstallResult.java | 23 + .../arcane/iris/core/datapack/Manifest.java | 61 + .../iris/core/datapack/ManifestWrite.java | 96 + .../iris/core/datapack/MetadataEntry.java | 24 + .../arcane/iris/core/datapack/Ownership.java | 69 + .../iris/core/datapack/PackResources.java | 28 + .../core/datapack/PreparedEditableImport.java | 29 + .../iris/core/datapack/RemoveOutcome.java | 26 + .../iris/core/datapack/StagingInspection.java | 27 + .../core/datapack/StartupValidationCache.java | 31 + .../core/datapack/VerifiedStagingInstall.java | 248 + .../datapack/DatapackIngestServiceTest.java | 530 +- 42 files changed, 7338 insertions(+), 6079 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/CoordinatorDirectory.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/CoordinatorEditable.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/CoordinatorJournal.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/CoordinatorOperation.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/CoordinatorPhase.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackArchive.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinator.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinatorResolution.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackImportSources.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackInstall.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackInstallPlanner.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackManifestStore.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackOwnership.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackPackMetadata.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackRemoval.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackScratchRecovery.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingGuard.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingReapply.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackStructureImports.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DatapackTransactions.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DirectoryDeleter.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DirectoryMove.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DirectoryRemoval.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/DownloadResult.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/EditableImportRemoval.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/InstallExecution.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/InstallPlan.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/InstallResult.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/Manifest.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/ManifestWrite.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/MetadataEntry.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/Ownership.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/PackResources.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/PreparedEditableImport.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/RemoveOutcome.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/StagingInspection.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/StartupValidationCache.java create mode 100644 core/src/main/java/art/arcane/iris/core/datapack/VerifiedStagingInstall.java diff --git a/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorDirectory.java b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorDirectory.java new file mode 100644 index 000000000..c596644f3 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorDirectory.java @@ -0,0 +1,37 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +final class CoordinatorDirectory { + String target; + String pending; + String backup; + boolean hadTarget; + String originalHash; + String desiredHash; + String originalMarkerHash; + String desiredMarkerHash; + String originalIdentity; + String desiredIdentity; + String targetRoot; + String scratchRoot; + String targetRootIdentity; + String scratchRootIdentity; +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorEditable.java b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorEditable.java new file mode 100644 index 000000000..48c684d9d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorEditable.java @@ -0,0 +1,26 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +final class CoordinatorEditable { + String packRoot; + String transactionId; + String claimId; +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorJournal.java b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorJournal.java new file mode 100644 index 000000000..49529e55c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorJournal.java @@ -0,0 +1,37 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.util.ArrayList; +import java.util.List; + +final class CoordinatorJournal { + int schemaVersion; + String transactionId; + CoordinatorOperation operation; + CoordinatorPhase phase; + String id; + String url; + String versionId; + String versionNumber; + String sha1; + boolean manifestAlreadyMatched; + List directories = new ArrayList<>(); + List editables = new ArrayList<>(); +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorOperation.java b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorOperation.java new file mode 100644 index 000000000..8638f9e29 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorOperation.java @@ -0,0 +1,25 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +enum CoordinatorOperation { + INSTALL, + REMOVE +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorPhase.java b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorPhase.java new file mode 100644 index 000000000..9ee762e90 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/CoordinatorPhase.java @@ -0,0 +1,31 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +enum CoordinatorPhase { + PREPARED, + PUBLISHING, + PUBLISHED, + COMMITTED; + + boolean published() { + return this == PUBLISHED || this == COMMITTED; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackArchive.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackArchive.java new file mode 100644 index 000000000..952aff3b5 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackArchive.java @@ -0,0 +1,415 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.core.datapack.ModrinthResolver.ResolvedDatapack; +import art.arcane.volmlib.util.io.IO; +import art.arcane.volmlib.util.io.ZipUtils; + +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.UncheckedIOException; +import java.net.HttpURLConnection; +import java.net.URI; +import java.net.URISyntaxException; +import java.net.URL; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.StandardOpenOption; +import java.nio.file.attribute.BasicFileAttributes; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.List; +import java.util.Locale; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; + +final class DatapackArchive { + static final String USER_AGENT = "VolmitSoftware/Iris (datapack-ingest)"; + + static final int MAX_REDIRECTS = 5; + + static final int MAX_ARCHIVE_ENTRIES = 100_000; + + static final int MAX_CACHE_FILES = 32; + + static final long MAX_DOWNLOAD_BYTES = 256L * 1024L * 1024L; + + static final long MAX_EXPANDED_BYTES = 1024L * 1024L * 1024L; + + static final long MAX_ENTRY_BYTES = 256L * 1024L * 1024L; + + static final long MAX_CACHE_BYTES = 1024L * 1024L * 1024L; + + static final Set RESERVED_IDS = Set.of("iris"); + + private DatapackArchive() { + } + + static File extractArchive(File zip, File stagingRoot, Entry entry) throws IOException { + DatapackSupport.ensureScratchDirectory(stagingRoot, "datapack staging"); + File pending = new File(stagingRoot, ".pending-" + entry.id + "-" + UUID.randomUUID()); + try { + if (!pending.mkdirs() && !pending.isDirectory()) { + throw new IOException("Couldn't create datapack extraction directory " + pending.getPath()); + } + ZipUtils.unzipFile(zip, pending, MAX_ARCHIVE_ENTRIES, MAX_EXPANDED_BYTES, MAX_ENTRY_BYTES); + flattenIfWrapped(pending); + DatapackPackMetadata.validatePackMetadata(pending); + PackResources resources = DatapackOwnership.scanPackResources(pending); + entry.structureKeys = resources.structureKeys(); + entry.templateKeys = resources.templateKeys(); + DatapackOwnership.writeOwnership(pending, entry); + return pending; + } catch (UncheckedIOException e) { + IOException failure = e.getCause(); + cleanupFailedExtraction(pending, failure); + throw failure; + } catch (IOException | RuntimeException e) { + cleanupFailedExtraction(pending, e); + throw e; + } + } + + static void cleanupFailedExtraction(File pending, Throwable failure) { + try { + DatapackInstall.deleteInstallScratch(pending, "failed datapack extraction"); + } catch (IOException cleanupFailure) { + failure.addSuppressed(cleanupFailure); + } + } + + static void cleanupExtractedStaging(File extractedDir) { + try { + DatapackInstall.deleteInstallScratch(extractedDir, "extracted datapack staging"); + } catch (IOException e) { + IrisLogging.warn("Preserving extracted datapack staging for restart cleanup: " + + extractedDir.getPath() + " (" + e.getMessage() + ")"); + } + } + + static void flattenIfWrapped(File dir) throws IOException { + if (new File(dir, "pack.mcmeta").isFile()) { + return; + } + File[] children = dir.listFiles(); + if (children == null) { + return; + } + File singleDir = null; + int dirCount = 0; + int fileCount = 0; + for (File child : children) { + if (child.isDirectory()) { + dirCount++; + singleDir = child; + } else { + fileCount++; + } + } + if (dirCount != 1 || fileCount != 0 || singleDir == null || !new File(singleDir, "pack.mcmeta").isFile()) { + return; + } + File[] inner = singleDir.listFiles(); + if (inner != null) { + for (File item : inner) { + File moved = new File(dir, item.getName()); + if (item.renameTo(moved)) { + continue; + } + if (item.isDirectory()) { + IO.copyDirectory(item.toPath(), moved.toPath()); + } else { + Files.copy(item.toPath(), moved.toPath(), StandardCopyOption.REPLACE_EXISTING); + } + } + } + DatapackInstall.deleteInstallScratch(singleDir, "wrapped datapack extraction"); + } + + static DownloadResult download(String url, File dest, String etag, String lastModified) throws IOException { + URI current = DatapackStartupValidation.parseSourceUri(url); + if (current == null) { + throw new IOException("Empty datapack URL"); + } + if ("file".equalsIgnoreCase(current.getScheme())) { + return copyLocalDatapack(current, dest); + } + for (int attempt = 0; attempt < MAX_REDIRECTS; attempt++) { + if (!"http".equalsIgnoreCase(current.getScheme()) && !"https".equalsIgnoreCase(current.getScheme())) { + throw new IOException("Datapack URL must use HTTP or HTTPS: " + current); + } + URL target = current.toURL(); + HttpURLConnection connection = (HttpURLConnection) target.openConnection(); + connection.setRequestMethod("GET"); + connection.setRequestProperty("User-Agent", USER_AGENT); + if (etag != null && !etag.isBlank()) { + connection.setRequestProperty("If-None-Match", etag); + } + if (lastModified != null && !lastModified.isBlank()) { + connection.setRequestProperty("If-Modified-Since", lastModified); + } + connection.setConnectTimeout(20000); + connection.setReadTimeout(60000); + connection.setInstanceFollowRedirects(false); + try { + int code = connection.getResponseCode(); + if (code == HttpURLConnection.HTTP_NOT_MODIFIED) { + String responseEtag = headerOrFallback(connection, "ETag", etag); + String responseLastModified = headerOrFallback(connection, "Last-Modified", lastModified); + return new DownloadResult(true, responseEtag, responseLastModified); + } + if (code / 100 == 3) { + String location = connection.getHeaderField("Location"); + if (location == null || location.isBlank()) { + throw new IOException("Redirect without a location header from " + current); + } + try { + current = current.resolve(new URI(location)); + } catch (URISyntaxException e) { + throw new IOException("Invalid redirect location from " + current + ": " + location, e); + } + continue; + } + if (code != 200) { + throw new IOException("HTTP " + code + " downloading " + current); + } + long declaredLength = connection.getContentLengthLong(); + if (declaredLength > MAX_DOWNLOAD_BYTES) { + throw new IOException("Datapack download exceeds " + MAX_DOWNLOAD_BYTES + " bytes"); + } + + File parent = dest.getParentFile(); + Path parentPath = parent == null ? Path.of(".").toAbsolutePath().normalize() : parent.toPath(); + DatapackSupport.ensureScratchDirectory(parentPath.toFile(), "datapack download cache"); + Path temporary = Files.createTempFile(parentPath, dest.getName() + "-", ".part"); + try { + long downloaded = 0; + String responseEtag = connection.getHeaderField("ETag"); + String responseLastModified = connection.getHeaderField("Last-Modified"); + try (InputStream in = connection.getInputStream(); + OutputStream out = Files.newOutputStream(temporary)) { + byte[] buffer = new byte[8192]; + int length; + while ((length = in.read(buffer)) > 0) { + downloaded += length; + if (downloaded > MAX_DOWNLOAD_BYTES) { + throw new IOException("Datapack download exceeds " + MAX_DOWNLOAD_BYTES + " bytes"); + } + out.write(buffer, 0, length); + } + } + DatapackSupport.move(temporary, dest.toPath()); + return new DownloadResult(false, responseEtag, responseLastModified); + } finally { + Files.deleteIfExists(temporary); + } + } finally { + connection.disconnect(); + } + } + throw new IOException("Too many redirects downloading " + url); + } + + static DownloadResult copyLocalDatapack(URI source, File destination) throws IOException { + Path sourcePath = requireLocalDatapackPath(source); + Path destinationPath = destination.toPath().toAbsolutePath().normalize(); + if (Files.exists(destinationPath, LinkOption.NOFOLLOW_LINKS) + && Files.isSameFile(sourcePath, destinationPath)) { + throw new IOException("Local datapack source and cache destination are the same file: " + sourcePath); + } + Path parent = destinationPath.getParent(); + if (parent == null) { + throw new IOException("Local datapack cache destination has no parent: " + destinationPath); + } + DatapackSupport.ensureScratchDirectory(parent.toFile(), "datapack download cache"); + BasicFileAttributes before = Files.readAttributes( + sourcePath, + BasicFileAttributes.class, + LinkOption.NOFOLLOW_LINKS); + Path temporary = Files.createTempFile(parent, destination.getName() + "-", ".part"); + try { + long copied = 0; + try (InputStream input = Files.newInputStream( + sourcePath, + StandardOpenOption.READ, + LinkOption.NOFOLLOW_LINKS); + OutputStream output = Files.newOutputStream(temporary)) { + byte[] buffer = new byte[DatapackOwnership.HASH_BUFFER_BYTES]; + int length; + while ((length = input.read(buffer)) > 0) { + copied += length; + if (copied > MAX_DOWNLOAD_BYTES) { + throw new IOException("Local datapack exceeds " + MAX_DOWNLOAD_BYTES + " bytes: " + sourcePath); + } + output.write(buffer, 0, length); + } + } + BasicFileAttributes after = Files.readAttributes( + sourcePath, + BasicFileAttributes.class, + LinkOption.NOFOLLOW_LINKS); + if (!after.isRegularFile() + || before.size() != after.size() + || !before.lastModifiedTime().equals(after.lastModifiedTime()) + || !Objects.equals(before.fileKey(), after.fileKey()) + || copied != after.size()) { + throw new IOException("Local datapack changed while Iris was copying it: " + sourcePath); + } + DatapackSupport.move(temporary, destinationPath); + return new DownloadResult(false, null, null); + } finally { + Files.deleteIfExists(temporary); + } + } + + static Path requireLocalDatapackPath(URI source) throws IOException { + if (source == null + || !"file".equalsIgnoreCase(source.getScheme()) + || source.isOpaque() + || source.getRawAuthority() != null + || source.getRawQuery() != null + || source.getRawFragment() != null) { + throw new IOException("Datapack file URL must be an absolute local file URI without authority, query, or fragment: " + source); + } + Path path; + try { + path = Path.of(source).toAbsolutePath().normalize(); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid local datapack file URL: " + source, exception); + } + if (Files.isSymbolicLink(path) + || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Local datapack is not a regular non-symbolic-link file: " + path); + } + long size = Files.size(path); + if (size > MAX_DOWNLOAD_BYTES) { + throw new IOException("Local datapack exceeds " + MAX_DOWNLOAD_BYTES + " bytes: " + path); + } + return path; + } + + static String headerOrFallback(HttpURLConnection connection, String name, String fallback) { + String value = connection.getHeaderField(name); + return value == null || value.isBlank() ? fallback : value; + } + + static String sha1(File file) throws IOException { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-1"); + try (InputStream in = new FileInputStream(file)) { + byte[] buffer = new byte[8192]; + int length; + while ((length = in.read(buffer)) > 0) { + digest.update(buffer, 0, length); + } + } + byte[] hash = digest.digest(); + StringBuilder builder = new StringBuilder(hash.length * 2); + for (byte value : hash) { + builder.append(String.format("%02x", value)); + } + return builder.toString(); + } catch (NoSuchAlgorithmException e) { + throw new IOException("SHA-1 algorithm unavailable", e); + } + } + + static String deriveId(ResolvedDatapack resolved) { + String base = resolved.getProjectSlug(); + if (base == null || base.isBlank()) { + base = resolved.getFileName(); + int dot = base.lastIndexOf('.'); + if (dot > 0) { + base = base.substring(0, dot); + } + } + String id = sanitizeId(base); + if (resolved.isDirect()) { + return id + "-" + ModrinthResolver.directIdentity(resolved.getDownloadUrl()); + } + return id; + } + + static String sanitizeId(String value) { + if (value == null) { + return "datapack"; + } + String lower = value.toLowerCase(Locale.ROOT).trim(); + StringBuilder builder = new StringBuilder(lower.length()); + for (int i = 0; i < lower.length(); i++) { + char c = lower.charAt(i); + if ((c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '-' || c == '_' || c == '.') { + builder.append(c); + } else if (c == ' ' || c == '/' || c == '\\') { + builder.append('-'); + } + } + String cleaned = builder.toString().replaceAll("-+", "-"); + cleaned = cleaned.replaceAll("^[-_.]+", "").replaceAll("[-_.]+$", ""); + return cleaned.isBlank() ? "datapack" : cleaned; + } + + static boolean isValidManagedId(String value) { + return value != null && !value.isBlank() && value.equals(sanitizeId(value)) + && !RESERVED_IDS.contains(value); + } + + static void pruneCache(File cacheDir) { + File[] files = cacheDir.listFiles(File::isFile); + if (files == null) { + return; + } + List archives = new ArrayList<>(); + long totalBytes = 0; + for (File file : files) { + if (file.getName().endsWith(".part")) { + IO.delete(file); + continue; + } + if (file.getName().endsWith(".zip")) { + archives.add(file); + totalBytes += Math.max(0, file.length()); + } + } + archives.sort(Comparator.comparingLong(File::lastModified)); + int remaining = archives.size(); + for (File archive : archives) { + if (remaining <= MAX_CACHE_FILES && totalBytes <= MAX_CACHE_BYTES) { + break; + } + long size = Math.max(0, archive.length()); + IO.delete(archive); + if (!archive.exists()) { + remaining--; + totalBytes -= size; + } + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinator.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinator.java new file mode 100644 index 000000000..116e5552a --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinator.java @@ -0,0 +1,41 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.IOException; +import java.nio.file.Path; + +final class DatapackCoordinator { + private final Path transactionRoot; + final CoordinatorJournal journal; + + DatapackCoordinator(Path transactionRoot, CoordinatorJournal journal) { + this.transactionRoot = transactionRoot; + this.journal = journal; + } + + void phase(CoordinatorPhase phase) throws IOException { + journal.phase = phase; + DatapackTransactions.writeCoordinatorJournal(transactionRoot, journal); + } + + void finish() throws IOException { + DatapackTransactions.deleteCoordinatorTransaction(transactionRoot); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinatorResolution.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinatorResolution.java new file mode 100644 index 000000000..f40e7240d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackCoordinatorResolution.java @@ -0,0 +1,438 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; +import art.arcane.volmlib.util.io.IO; + +import java.io.File; +import java.io.IOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; + +final class DatapackCoordinatorResolution { + + private DatapackCoordinatorResolution() { + } + + static Set authoritativeEditableRoots( + Manifest committedManifest, + CoordinatorJournal journal + ) throws IOException { + Set roots = new HashSet<>(); + Entry committed = committedManifest.findById(journal.id); + if (committed != null) { + if (!Objects.equals(committed.url, journal.url)) { + throw new IOException("Datapack transaction conflicts with the committed editable pack owner"); + } + addExistingPackRoots(roots, committed.importedTargets.keySet()); + addExistingPackRoots(roots, committed.importAttempts.keySet()); + addExistingPackRoots(roots, committed.importedBundles.keySet()); + return roots; + } + if (journal.operation != CoordinatorOperation.REMOVE || !journal.phase.published()) { + throw new IOException("Datapack transaction has no committed editable pack authority"); + } + for (CoordinatorEditable editable : journal.editables) { + Path packRoot = DatapackTransactions.coordinatorPath(editable.packRoot, "editable pack root"); + if (Files.isSymbolicLink(packRoot) || !Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid editable pack root in datapack transaction: " + packRoot); + } + Path realPackRoot = packRoot.toRealPath(); + if (!packRoot.equals(realPackRoot)) { + throw new IOException("Editable pack root changed before datapack recovery: " + packRoot); + } + roots.add(realPackRoot); + } + return roots; + } + + static void addExistingPackRoots(Set roots, Set paths) throws IOException { + for (String path : paths) { + try { + Path root = Path.of(path).toAbsolutePath().normalize(); + if (Files.isDirectory(root)) { + roots.add(root.toRealPath()); + } + } catch (RuntimeException e) { + throw new IOException("Invalid editable pack root in the datapack manifest: " + path, e); + } + } + } + + static void validateCoordinatorDirectory( + CoordinatorDirectory directory, + CoordinatorOperation operation, + Set allowedTargets, + Set seenTargets, + Set seenTargetIdentities + ) throws IOException { + if (directory == null || directory.target == null || directory.backup == null + || directory.originalHash == null || directory.desiredHash == null + || directory.originalMarkerHash == null || directory.desiredMarkerHash == null + || directory.originalIdentity == null || directory.desiredIdentity == null + || directory.targetRoot == null || directory.scratchRoot == null + || directory.targetRootIdentity == null || directory.scratchRootIdentity == null) { + throw new IOException("Incomplete directory participant in datapack transaction"); + } + Path target = DatapackTransactions.coordinatorPath(directory.target, "target"); + if (!allowedTargets.contains(target) || !seenTargets.add(target)) { + throw new IOException("Datapack transaction target is outside its configured roots: " + target); + } + File targetFile = target.toFile(); + File targetParent = targetFile.getParentFile(); + Path targetRootIdentity = DatapackTransactions.coordinatorPath(directory.targetRoot, "target root"); + if (!seenTargetIdentities.add(targetRootIdentity.resolve(target.getFileName()).normalize())) { + throw new IOException("Aliased datapack transaction target " + target); + } + validateRecoveryContainer( + targetParent.toPath(), + targetRootIdentity, + true, + "datapack target root" + ); + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + targetParent, directory.targetRoot, directory.targetRootIdentity, "datapack target root"); + File scratchRoot = new File( + targetParent.getParentFile() == null ? targetParent : targetParent.getParentFile(), + operation == CoordinatorOperation.INSTALL ? ".iris-datapack-install" : ".iris-datapack-remove" + ); + Path expectedScratch = scratchRoot.toPath().toAbsolutePath().normalize(); + Path backup = DatapackTransactions.coordinatorPath(directory.backup, "backup"); + if (!Objects.equals(backup.getParent(), expectedScratch) || Files.isSymbolicLink(backup)) { + throw new IOException("Invalid datapack transaction backup path " + backup); + } + Path pending = null; + if (operation == CoordinatorOperation.INSTALL) { + if (directory.pending == null || directory.pending.isBlank()) { + throw new IOException("Install transaction is missing its pending directory"); + } + pending = DatapackTransactions.coordinatorPath(directory.pending, "pending directory"); + if (!Objects.equals(pending.getParent(), expectedScratch) || Files.isSymbolicLink(pending)) { + throw new IOException("Invalid datapack transaction pending path " + pending); + } + } else if (directory.pending != null && !directory.pending.isBlank()) { + throw new IOException("Removal transaction unexpectedly contains a pending directory"); + } + boolean scratchRequired = Files.exists(backup, LinkOption.NOFOLLOW_LINKS) + || pending != null && Files.exists(pending, LinkOption.NOFOLLOW_LINKS); + validateRecoveryContainer( + expectedScratch, + DatapackTransactions.coordinatorPath(directory.scratchRoot, "scratch root"), + scratchRequired, + "datapack transaction scratch root" + ); + if (scratchRequired) { + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + expectedScratch.toFile(), directory.scratchRoot, + directory.scratchRootIdentity, "datapack transaction scratch root"); + } + } + + static void validateRecoveryContainer( + Path container, + Path expectedRealPath, + boolean required, + String purpose + ) throws IOException { + Path normalized = container.toAbsolutePath().normalize(); + Path normalizedExpected = expectedRealPath.toAbsolutePath().normalize(); + if (!Files.exists(normalized, LinkOption.NOFOLLOW_LINKS)) { + if (required) { + throw new IOException("Missing " + purpose + " " + normalized); + } + return; + } + if (Files.isSymbolicLink(normalized) + || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) + || !Objects.equals(normalized.toRealPath(), normalizedExpected)) { + throw new IOException("Changed or unsafe " + purpose + " " + normalized); + } + } + + static boolean coordinatorCommitDecision(Manifest manifest, CoordinatorJournal journal) throws IOException { + Entry committed = manifest.findById(journal.id); + if (journal.operation == CoordinatorOperation.REMOVE) { + if (committed == null) { + if (!journal.phase.published()) { + throw new IOException("Datapack removal manifest changed before every participant was published"); + } + return true; + } + if (!Objects.equals(committed.url, journal.url) || journal.phase == CoordinatorPhase.COMMITTED) { + throw new IOException("Datapack removal journal conflicts with the committed manifest"); + } + return false; + } + + boolean matches = committed != null + && Objects.equals(committed.url, journal.url) + && Objects.equals(committed.versionId, journal.versionId) + && Objects.equals(committed.versionNumber, journal.versionNumber) + && Objects.equals(committed.sha1, journal.sha1); + if (journal.manifestAlreadyMatched) { + if (!matches) { + throw new IOException("Committed datapack changed while an install transaction was incomplete"); + } + return journal.phase.published(); + } + if (matches) { + if (!journal.phase.published()) { + throw new IOException("Datapack install manifest changed before every target was published"); + } + return true; + } + if (journal.phase == CoordinatorPhase.COMMITTED) { + throw new IOException("Committed datapack install journal conflicts with the manifest"); + } + return false; + } + + static void resolveCoordinatorDirectories(CoordinatorJournal journal, boolean commit) throws IOException { + List directories = new ArrayList<>(journal.directories); + if (!commit) { + Collections.reverse(directories); + } + IOException failure = null; + for (CoordinatorDirectory directory : directories) { + try { + if (journal.operation == CoordinatorOperation.INSTALL) { + resolveInstallDirectory(journal, directory, commit); + } else { + resolveRemovalDirectory(directory, commit); + } + } catch (IOException | RuntimeException e) { + IOException participantFailure = e instanceof IOException ioFailure + ? ioFailure : new IOException("Failed resolving datapack directory participant", e); + if (failure == null) { + failure = participantFailure; + } else { + failure.addSuppressed(participantFailure); + } + } + } + if (failure != null) { + throw failure; + } + } + + static void resolveInstallDirectory( + CoordinatorJournal journal, + CoordinatorDirectory directory, + boolean commit + ) throws IOException { + File target = new File(directory.target); + File pending = new File(directory.pending); + File backup = new File(directory.backup); + File targetRoot = new File(directory.targetRoot); + if (commit) { + verifyDesiredDirectory( + target, targetRoot, journal, directory.desiredHash, + directory.desiredMarkerHash, directory.desiredIdentity); + deleteOriginalBackupIfPresent( + backup, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity); + deleteDesiredDirectoryIfPresent( + pending, targetRoot, journal, directory.desiredHash, + directory.desiredMarkerHash, directory.desiredIdentity); + cleanupScratchParent(backup); + return; + } + + if (directory.hadTarget) { + if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { + DatapackInstallPlanner.verifyDirectorySnapshot( + backup, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity, + "datapack install backup"); + deleteDesiredDirectoryIfPresent( + target, targetRoot, journal, directory.desiredHash, + directory.desiredMarkerHash, directory.desiredIdentity); + DatapackSupport.moveNew(backup.toPath(), target.toPath()); + DatapackSupport.forceDirectoryIfSupported(target.getParentFile().toPath()); + DatapackSupport.forceDirectoryIfSupported(backup.getParentFile().toPath()); + } else { + DatapackInstallPlanner.verifyDirectorySnapshot( + target, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity, + "original datapack target"); + } + } else { + if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Unexpected backup for newly-installed datapack " + backup.getPath()); + } + deleteDesiredDirectoryIfPresent( + target, targetRoot, journal, directory.desiredHash, + directory.desiredMarkerHash, directory.desiredIdentity); + } + deleteDesiredDirectoryIfPresent( + pending, targetRoot, journal, directory.desiredHash, + directory.desiredMarkerHash, directory.desiredIdentity); + cleanupScratchParent(backup); + } + + static void resolveRemovalDirectory(CoordinatorDirectory directory, boolean commit) throws IOException { + File target = new File(directory.target); + File backup = new File(directory.backup); + File targetRoot = new File(directory.targetRoot); + if (commit) { + if (Files.exists(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Removed datapack target reappeared before transaction cleanup: " + target.getPath()); + } + deleteOriginalBackupIfPresent( + backup, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity); + cleanupScratchParent(backup); + return; + } + if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { + DatapackInstallPlanner.verifyDirectorySnapshot( + backup, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity, + "datapack removal backup"); + if (Files.exists(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Datapack removal target was concurrently recreated: " + target.getPath()); + } + DatapackSupport.moveNew(backup.toPath(), target.toPath()); + DatapackSupport.forceDirectoryIfSupported(target.getParentFile().toPath()); + DatapackSupport.forceDirectoryIfSupported(backup.getParentFile().toPath()); + } else { + DatapackInstallPlanner.verifyDirectorySnapshot( + target, targetRoot, directory.originalHash, + directory.originalMarkerHash, directory.originalIdentity, + "original datapack target"); + } + cleanupScratchParent(backup); + } + + static void resolveCoordinatorEditables( + CoordinatorJournal journal, + Path transactionRoot, + boolean commit + ) throws IOException { + IOException failure = null; + for (CoordinatorEditable editable : journal.editables) { + try { + Path packRoot = DatapackTransactions.coordinatorPath(editable.packRoot, "editable pack root"); + StructureTransactionWriter writer = new StructureTransactionWriter(packRoot); + writer.resolvePreparedRemoval( + new StructureTransactionWriter.PreparedRemovalToken( + packRoot, + UUID.fromString(editable.transactionId) + ), + new StructureTransactionWriter.RecoveryOwner( + transactionRoot, + UUID.fromString(journal.transactionId), + UUID.fromString(editable.claimId) + ), + commit + ); + IrisData.invalidateLoadedStructureResources(packRoot.toFile()); + } catch (IOException | RuntimeException e) { + IOException participantFailure = e instanceof IOException ioFailure + ? ioFailure : new IOException("Failed resolving editable structure participant", e); + if (failure == null) { + failure = participantFailure; + } else { + failure.addSuppressed(participantFailure); + } + } + } + if (failure != null) { + throw failure; + } + } + + static void verifyDesiredDirectory( + File directory, + File targetRoot, + CoordinatorJournal journal, + String expectedHash, + String expectedMarkerHash, + String expectedIdentity + ) throws IOException { + DatapackInstallPlanner.verifyDirectorySnapshot( + directory, targetRoot, expectedHash, expectedMarkerHash, + expectedIdentity, "installed datapack target"); + Ownership ownership = DatapackOwnership.readOwnership(directory); + if (!Objects.equals(ownership.id, journal.id) || !Objects.equals(ownership.url, journal.url) + || !Objects.equals(ownership.contentHash, expectedHash)) { + throw new IOException("Installed datapack ownership does not match its transaction at " + directory.getPath()); + } + } + + static void deleteDesiredDirectoryIfPresent( + File directory, + File targetRoot, + CoordinatorJournal journal, + String expectedHash, + String expectedMarkerHash, + String expectedIdentity + ) throws IOException { + if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + return; + } + verifyDesiredDirectory( + directory, targetRoot, journal, expectedHash, + expectedMarkerHash, expectedIdentity); + deleteVerifiedDirectory(directory); + } + + static void deleteOriginalBackupIfPresent( + File backup, + File targetRoot, + String expectedHash, + String expectedMarkerHash, + String expectedIdentity + ) throws IOException { + if (!Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { + return; + } + DatapackInstallPlanner.verifyDirectorySnapshot( + backup, targetRoot, expectedHash, expectedMarkerHash, + expectedIdentity, "datapack transaction backup"); + deleteVerifiedDirectory(backup); + } + + static void deleteVerifiedDirectory(File directory) throws IOException { + File parent = Objects.requireNonNull(directory.getParentFile(), "datapack transaction parent"); + DatapackInstall.validateInstallTree(directory, parent, "Datapack transaction directory"); + IO.delete(directory); + if (Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Could not delete datapack transaction directory " + directory.getPath()); + } + } + + static void cleanupScratchParent(File participant) { + File parent = participant.getParentFile(); + if (parent != null) { + parent.delete(); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackImportSources.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackImportSources.java new file mode 100644 index 000000000..5fee31d21 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackImportSources.java @@ -0,0 +1,146 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.engine.object.IrisDimension; +import art.arcane.volmlib.util.collection.KList; + +import java.io.File; +import java.io.IOException; +import java.net.URI; +import java.net.URISyntaxException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Comparator; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Locale; +import java.util.Set; +import java.util.stream.Stream; + +final class DatapackImportSources { + static final String LOCAL_IMPORT_DIRECTORY = "imports"; + + private DatapackImportSources() { + } + + static Set mergeConfiguredImports( + Iterable explicit, + Iterable discovered + ) { + LinkedHashSet sources = new LinkedHashSet<>(); + if (explicit != null) { + addImports(explicit, sources); + } + if (discovered != null) { + addImports(discovered, sources); + } + return sources.isEmpty() ? Set.of() : Set.copyOf(sources); + } + + static List discoverLocalDatapackImports(File directory) throws IOException { + Path root = directory.toPath().toAbsolutePath().normalize(); + if (Files.notExists(root, LinkOption.NOFOLLOW_LINKS)) { + Files.createDirectories(root); + } + if (Files.isSymbolicLink(root) + || !Files.isDirectory(root, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Local datapack import path is not a safe directory: " + root); + } + try (Stream stream = Files.list(root)) { + return stream + .filter(path -> !Files.isSymbolicLink(path)) + .filter(path -> Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) + .filter(DatapackImportSources::isLocalDatapackArchive) + .sorted(Comparator.comparing( + (Path path) -> path.getFileName().toString(), + String.CASE_INSENSITIVE_ORDER) + .thenComparing((Path path) -> path.getFileName().toString())) + .map(path -> path.toAbsolutePath().normalize().toUri().toASCIIString()) + .toList(); + } + } + + static boolean isLocalDatapackArchive(Path path) { + String name = path.getFileName().toString(); + return !name.startsWith(".") && name.toLowerCase(Locale.ROOT).endsWith(".zip"); + } + + static List localDatapackImports() { + File directory = IrisPlatforms.get().dataFolder("datapacks", LOCAL_IMPORT_DIRECTORY); + try { + return discoverLocalDatapackImports(directory); + } catch (IOException exception) { + IrisLogging.reportError("Could not discover local datapack imports under " + + directory.getPath() + ".", exception); + return List.of(); + } + } + + static void collectImports(IrisData data, LinkedHashSet urls) { + if (data == null || data.getDimensionLoader() == null) { + return; + } + for (IrisDimension dimension : data.getDimensionLoader().loadAll(data.getDimensionLoader().getPossibleKeys())) { + if (dimension == null) { + continue; + } + KList imports = dimension.getDatapackImports(); + if (imports == null) { + continue; + } + addImports(imports, urls); + } + } + + static void addImports(Iterable imports, LinkedHashSet sources) { + for (String source : imports) { + if (source != null && !source.isBlank()) { + sources.add(normalizeConfiguredSource(source)); + } + } + } + + static String normalizeConfiguredSource(String source) { + String normalized = source.trim(); + try { + URI uri = new URI(normalized); + if ("file".equalsIgnoreCase(uri.getScheme())) { + return Path.of(uri).toAbsolutePath().normalize().toUri().toASCIIString(); + } + } catch (IllegalArgumentException | URISyntaxException ignored) { + } + return normalized; + } + + static Set configuredImports(IrisData data) { + LinkedHashSet urls = new LinkedHashSet<>(); + collectImports(data, urls); + urls.addAll(localDatapackImports()); + return urls; + } + + static boolean hasImports(IrisData data) { + return !configuredImports(data).isEmpty(); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java index 4de16d223..4c7005fe8 100644 --- a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java @@ -18,116 +18,44 @@ package art.arcane.iris.core.datapack; +import art.arcane.iris.core.datapack.DatapackIngestService.StructureScopeResources; +import art.arcane.iris.core.datapack.DatapackIngestService.StartupValidationOutcome; +import art.arcane.iris.core.datapack.DatapackIngestService.Report; +import art.arcane.iris.core.datapack.DatapackIngestService.ReapplyStatus; +import art.arcane.iris.core.datapack.DatapackIngestService.ReapplyOutcome; +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; -import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.core.IrisStartupValidation; import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.ServerConfigurator; import art.arcane.iris.core.datapack.ModrinthResolver.ResolvedDatapack; import art.arcane.iris.core.loader.IrisData; -import art.arcane.iris.core.nms.MinecraftVersion; import art.arcane.iris.core.project.IrisProject; import art.arcane.iris.core.project.IrisCodeWorkspace; -import art.arcane.iris.core.structure.BulkStructureImporter; -import art.arcane.iris.core.structure.StructureImporter; -import art.arcane.iris.core.structure.authoring.StructureKey; -import art.arcane.iris.core.structure.authoring.StructureSource; -import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.engine.object.IrisDimension; -import art.arcane.iris.engine.object.IrisImportedStructureControl; import art.arcane.iris.util.common.format.C; -import art.arcane.iris.util.common.io.Durability; import art.arcane.iris.util.common.plugin.VolmitSender; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.io.IO; -import art.arcane.volmlib.util.io.ZipUtils; -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParser; -import org.bukkit.Bukkit; -import org.bukkit.Server; import java.io.File; -import java.io.FileInputStream; import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.UncheckedIOException; -import java.net.HttpURLConnection; -import java.net.URI; -import java.net.URISyntaxException; -import java.net.URL; -import java.nio.channels.FileChannel; -import java.nio.charset.StandardCharsets; -import java.nio.file.AtomicMoveNotSupportedException; -import java.nio.file.FileVisitResult; -import java.nio.file.FileStore; -import java.nio.file.FileSystems; import java.nio.file.LinkOption; import java.nio.file.Files; import java.nio.file.Path; -import java.nio.file.SimpleFileVisitor; -import java.nio.file.StandardCopyOption; -import java.nio.file.StandardOpenOption; -import java.nio.file.attribute.BasicFileAttributes; -import java.security.MessageDigest; -import java.security.NoSuchAlgorithmException; import java.util.ArrayList; -import java.util.Collections; -import java.util.Comparator; import java.util.HashMap; -import java.util.HashSet; -import java.util.Iterator; import java.util.LinkedHashSet; import java.util.List; -import java.util.Locale; import java.util.Map; import java.util.Objects; import java.util.Optional; import java.util.Set; -import java.util.TreeSet; import java.util.TreeMap; -import java.util.UUID; -import java.util.concurrent.locks.ReentrantLock; import java.util.stream.Stream; public final class DatapackIngestService { - private static final String USER_AGENT = "VolmitSoftware/Iris (datapack-ingest)"; - private static final String FINDER_METADATA = ".DS_Store"; - private static final String OVERRIDES_STRIPPED_MARKER = ".iris-overrides-stripped"; - private static final String OWNERSHIP_MARKER = ".iris-managed.json"; - private static final String TRANSACTION_DIRECTORY = ".iris-datapack-transactions"; - private static final String TRANSACTION_JOURNAL = "journal.json"; - private static final String TRANSACTION_JOURNAL_NEXT = "journal.next.json"; - private static final String STARTUP_VALIDATION_CACHE = "startup-validation.json"; - private static final String LOCAL_IMPORT_DIRECTORY = "imports"; - private static final int OWNERSHIP_SCHEMA = 1; - private static final int TRANSACTION_SCHEMA = 2; - private static final int STARTUP_VALIDATION_SCHEMA = 1; - private static final int STRUCTURE_IMPORT_FORMAT_REVISION = 3; - private static final int MAX_REDIRECTS = 5; - private static final int MAX_ARCHIVE_ENTRIES = 100_000; - private static final int MAX_CACHE_FILES = 32; - private static final int MAX_MANAGED_PATHS = MAX_ARCHIVE_ENTRIES + 16; - private static final long MAX_DOWNLOAD_BYTES = 256L * 1024L * 1024L; - private static final long MAX_EXPANDED_BYTES = 1024L * 1024L * 1024L; - private static final long MAX_ENTRY_BYTES = 256L * 1024L * 1024L; - private static final long MAX_CACHE_BYTES = 1024L * 1024L * 1024L; - private static final long MAX_MANIFEST_BYTES = 16L * 1024L * 1024L; - private static final long MAX_TRANSACTION_JOURNAL_BYTES = 4L * 1024L * 1024L; - private static final long MAX_METADATA_BYTES = 1024L * 1024L; - private static final long MAX_OWNERSHIP_BYTES = 1024L * 1024L; - private static final int MAX_TRANSACTION_COUNT = 1_024; - private static final int MAX_SCRATCH_DELETE_ATTEMPTS = 3; - private static final int WINDOWS_LEGACY_PATH_LIMIT = 247; - private static final int HASH_BUFFER_BYTES = 64 * 1024; - private static final Set RESERVED_IDS = Set.of("iris"); - private static final ReentrantLock TRANSACTION_LOCK = new ReentrantLock(); - private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); - private static volatile StartupValidationCache activeStartupValidation; private DatapackIngestService() { } @@ -144,24 +72,24 @@ public final class DatapackIngestService { } public static StartupValidationOutcome validateOnStartup() { - activeStartupValidation = null; + DatapackStartupValidation.activeStartupValidation = null; IrisStartupValidation.beginDatapackValidation(); KList configured = collectConfiguredImports(); List urls = configured.stream().sorted().toList(); boolean autoIngest = IrisSettings.get().getGeneral().autoIngestDatapacks; - boolean stripOverrides = resolveStripOverrides(); - String mcVersion = serverMcVersion(); + boolean stripOverrides = DatapackPackMetadata.resolveStripOverrides(); + String mcVersion = DatapackSupport.serverMcVersion(); int irisVersion = IrisPlatforms.get().irisVersionNumber(); File root = IrisPlatforms.get().dataFolder("datapacks"); KList worldFolders = ServerConfigurator.getDatapacksFolder(); - Path cacheFile = new File(root, STARTUP_VALIDATION_CACHE).toPath(); + Path cacheFile = new File(root, DatapackStartupValidation.STARTUP_VALIDATION_CACHE).toPath(); try { - StartupValidationCache cached = readStartupValidationCache(cacheFile); - if (startupValidationContextMatches( + StartupValidationCache cached = DatapackStartupValidation.readStartupValidationCache(cacheFile); + if (DatapackStartupValidation.startupValidationContextMatches( cached, mcVersion, irisVersion, autoIngest, stripOverrides, urls)) { - String localFingerprint = startupValidationFingerprint(root, worldFolders, urls); - if (startupValidationCacheMatches( + String localFingerprint = DatapackStartupValidation.startupValidationFingerprint(root, worldFolders, urls); + if (DatapackStartupValidation.startupValidationCacheMatches( cached, mcVersion, irisVersion, @@ -169,7 +97,7 @@ public final class DatapackIngestService { stripOverrides, urls, localFingerprint)) { - activeStartupValidation = cached; + DatapackStartupValidation.activeStartupValidation = cached; IrisLogging.info("External datapacks match the persisted startup validation; remote resolution and full revalidation were skipped."); IrisStartupValidation.markDatapacksReady(); return StartupValidationOutcome.READY; @@ -177,7 +105,7 @@ public final class DatapackIngestService { } } catch (IOException | RuntimeException exception) { IrisLogging.warn("Persisted external datapack validation could not be reused: " - + failureMessage(exception)); + + DatapackSupport.failureMessage(exception)); } if (autoIngest && !configured.isEmpty()) { @@ -192,7 +120,7 @@ public final class DatapackIngestService { StartupValidationOutcome outcome = report.changed() ? StartupValidationOutcome.RESTART_REQUIRED : StartupValidationOutcome.READY; - activeStartupValidation = cacheStartupValidation(root, worldFolders, cacheFile, mcVersion, irisVersion, + DatapackStartupValidation.activeStartupValidation = DatapackStartupValidation.cacheStartupValidation(root, worldFolders, cacheFile, mcVersion, irisVersion, autoIngest, stripOverrides, urls); if (outcome == StartupValidationOutcome.RESTART_REQUIRED) { IrisStartupValidation.requireRestart( @@ -206,12 +134,12 @@ public final class DatapackIngestService { ReapplyOutcome reapply = reapplyFromStaging(worldFolders); if (!reapply.succeeded()) { String failure = reapply.failure() - .map(DatapackIngestService::failureMessage) + .map(DatapackSupport::failureMessage) .orElse("External datapack recovery failed."); IrisStartupValidation.markDatapacksInvalid(failure); return StartupValidationOutcome.FAILED; } - activeStartupValidation = cacheStartupValidation(root, worldFolders, cacheFile, mcVersion, irisVersion, + DatapackStartupValidation.activeStartupValidation = DatapackStartupValidation.cacheStartupValidation(root, worldFolders, cacheFile, mcVersion, irisVersion, autoIngest, stripOverrides, urls); if (reapply.changed()) { IrisStartupValidation.requireRestart( @@ -224,343 +152,8 @@ public final class DatapackIngestService { public static void runPostStartupTasks() { refreshWorkspaces(); - boolean maintenanceChanged = autoImportDatapackStructures(); - refreshStartupValidationAfterMaintenance(maintenanceChanged); - } - - private static StartupValidationCache cacheStartupValidation( - File root, - KList worldFolders, - Path cacheFile, - String mcVersion, - int irisVersion, - boolean autoIngest, - boolean stripOverrides, - List urls - ) { - try { - StartupValidationCache cache = createStartupValidationCache( - mcVersion, - irisVersion, - autoIngest, - stripOverrides, - urls, - startupValidationFingerprint(root, worldFolders, urls)); - writeStartupValidationCache(cacheFile, cache); - return cache; - } catch (IOException | RuntimeException exception) { - IrisLogging.warn("Could not persist external datapack startup validation: " - + failureMessage(exception)); - return null; - } - } - - private static void refreshStartupValidationAfterMaintenance(boolean maintenanceChanged) { - if (!maintenanceChanged) { - return; - } - StartupValidationCache validated = activeStartupValidation; - if (validated == null || !IrisStartupValidation.isReady()) { - return; - } - KList configured = collectConfiguredImports(); - List urls = configured.stream().sorted().toList(); - boolean autoIngest = IrisSettings.get().getGeneral().autoIngestDatapacks; - boolean stripOverrides = resolveStripOverrides(); - String mcVersion = serverMcVersion(); - int irisVersion = IrisPlatforms.get().irisVersionNumber(); - if (!startupValidationContextMatches( - validated, mcVersion, irisVersion, autoIngest, stripOverrides, urls)) { - return; - } - File root = IrisPlatforms.get().dataFolder("datapacks"); - KList worldFolders = ServerConfigurator.getDatapacksFolder(); - Path cacheFile = new File(root, STARTUP_VALIDATION_CACHE).toPath(); - TRANSACTION_LOCK.lock(); - try { - recoverTransactions(root, worldFolders); - StartupValidationCache refreshed = refreshStartupValidationCache( - validated, root, worldFolders); - writeStartupValidationCache(cacheFile, refreshed); - activeStartupValidation = refreshed; - } catch (IOException | RuntimeException exception) { - IrisLogging.warn("Could not refresh external datapack validation after startup maintenance: " - + failureMessage(exception)); - } finally { - TRANSACTION_LOCK.unlock(); - } - } - - static StartupValidationCache refreshStartupValidationCache( - StartupValidationCache validated, - File root, - KList worldFolders - ) throws IOException { - Objects.requireNonNull(validated, "Validated external datapack startup state"); - return createStartupValidationCache( - validated.minecraftVersion, - validated.irisVersion, - validated.autoIngest, - validated.stripOverrides, - validated.urls, - startupValidationFingerprint(root, worldFolders, validated.urls)); - } - - private static StartupValidationCache createStartupValidationCache( - String mcVersion, - int irisVersion, - boolean autoIngest, - boolean stripOverrides, - List urls, - String localFingerprint - ) { - StartupValidationCache cache = new StartupValidationCache(); - cache.schemaVersion = STARTUP_VALIDATION_SCHEMA; - cache.minecraftVersion = Objects.requireNonNullElse(mcVersion, ""); - cache.irisVersion = irisVersion; - cache.autoIngest = autoIngest; - cache.stripOverrides = stripOverrides; - cache.urls = List.copyOf(urls); - cache.localFingerprint = localFingerprint; - return cache; - } - - static boolean startupValidationContextMatches( - StartupValidationCache cache, - String mcVersion, - int irisVersion, - boolean autoIngest, - boolean stripOverrides, - List urls - ) { - return cache != null - && cache.schemaVersion == STARTUP_VALIDATION_SCHEMA - && Objects.equals(cache.minecraftVersion, Objects.requireNonNullElse(mcVersion, "")) - && cache.irisVersion == irisVersion - && cache.autoIngest == autoIngest - && cache.stripOverrides == stripOverrides - && Objects.equals(cache.urls, urls); - } - - static boolean startupValidationCacheMatches( - StartupValidationCache cache, - String mcVersion, - int irisVersion, - boolean autoIngest, - boolean stripOverrides, - List urls, - String localFingerprint - ) { - return startupValidationContextMatches( - cache, mcVersion, irisVersion, autoIngest, stripOverrides, urls) - && localFingerprint != null && !localFingerprint.isBlank() - && Objects.equals(cache.localFingerprint, localFingerprint); - } - - static StartupValidationCache readStartupValidationCache(Path cacheFile) { - if (cacheFile == null - || Files.isSymbolicLink(cacheFile) - || !Files.isRegularFile(cacheFile, LinkOption.NOFOLLOW_LINKS)) { - return null; - } - try { - if (Files.size(cacheFile) > MAX_METADATA_BYTES) { - return null; - } - StartupValidationCache cache = GSON.fromJson( - readBoundedUtf8(cacheFile, MAX_METADATA_BYTES, "External datapack startup validation"), - StartupValidationCache.class); - if (cache == null || cache.urls == null) { - return null; - } - List sortedUrls = cache.urls.stream() - .filter(Objects::nonNull) - .sorted() - .toList(); - if (sortedUrls.size() != cache.urls.size() - || new HashSet<>(sortedUrls).size() != sortedUrls.size() - || !sortedUrls.equals(cache.urls)) { - return null; - } - cache.urls = sortedUrls; - return cache; - } catch (IOException | RuntimeException exception) { - return null; - } - } - - private static void writeStartupValidationCache(Path cacheFile, StartupValidationCache cache) throws IOException { - Path absolute = cacheFile.toAbsolutePath().normalize(); - Path parent = Objects.requireNonNull(absolute.getParent(), "External datapack startup validation parent"); - Files.createDirectories(parent); - Path staged = Files.createTempFile(parent, ".startup-validation-", ".tmp"); - try { - byte[] content = GSON.toJson(cache).getBytes(StandardCharsets.UTF_8); - if (content.length > MAX_METADATA_BYTES) { - throw new IOException("External datapack startup validation exceeds " + MAX_METADATA_BYTES + " bytes"); - } - Files.write(staged, content, StandardOpenOption.TRUNCATE_EXISTING); - forceFile(staged); - try { - Files.move(staged, absolute, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING); - } catch (AtomicMoveNotSupportedException exception) { - Files.move(staged, absolute, StandardCopyOption.REPLACE_EXISTING); - } - forceDirectoryIfSupported(parent); - } finally { - Files.deleteIfExists(staged); - } - } - - static String startupValidationFingerprint(File root, KList worldFolders) throws IOException { - return startupValidationFingerprint(root, worldFolders, List.of()); - } - - static String startupValidationFingerprint( - File root, - KList worldFolders, - Iterable sources - ) throws IOException { - try { - MessageDigest digest = MessageDigest.getInstance("SHA-256"); - Path manifestPath = new File(root, "manifest.json").toPath(); - updateFingerprintValue(digest, "manifest"); - if (Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - if (Files.isSymbolicLink(manifestPath) - || !Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid datapack manifest path " + manifestPath); - } - byte[] manifest = readBoundedBytes( - manifestPath, MAX_MANIFEST_BYTES, "Datapack manifest fingerprint"); - updateDigestLong(digest, manifest.length); - digest.update(manifest); - } else if (Files.notExists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - updateDigestLong(digest, -1L); - } else { - throw new IOException("Cannot determine datapack manifest state at " + manifestPath); - } - - Manifest manifest = readCommittedManifest(root); - updateDirectoryFingerprint(digest, "staging", new File(root, "staging")); - updateDirectoryFingerprint(digest, "transactions", new File(root, TRANSACTION_DIRECTORY)); - updateDirectoryFingerprint( - digest, - "storage-install-scratch", - installScratchRoot(new File(root, "staging"))); - - List entries = new ArrayList<>(manifest.entries); - entries.sort(Comparator.comparing(entry -> entry.id)); - List targets = new ArrayList<>(worldFolders == null ? List.of() : worldFolders); - targets.sort(Comparator.comparing(file -> file.toPath().toAbsolutePath().normalize().toString())); - for (File worldFolder : targets) { - String worldIdentity = worldFolder.toPath().toAbsolutePath().normalize().toString(); - updateFingerprintValue(digest, "world:" + worldIdentity); - updateDirectoryFingerprint( - digest, - "world-install-scratch:" + worldIdentity, - installScratchRoot(worldFolder)); - for (Entry entry : entries) { - updateDirectoryFingerprint( - digest, - "world-pack:" + worldIdentity + ":" + entry.id, - new File(worldFolder, entry.id)); - } - } - updateLocalSourceFingerprint(digest, sources); - return hex(digest.digest()); - } catch (NoSuchAlgorithmException exception) { - throw new IOException("SHA-256 algorithm unavailable", exception); - } - } - - private static void updateLocalSourceFingerprint( - MessageDigest digest, - Iterable sources - ) throws IOException { - if (sources == null) { - return; - } - List localSources = new ArrayList<>(); - for (String source : sources) { - URI uri = parseSourceUri(source); - if (uri != null && "file".equalsIgnoreCase(uri.getScheme())) { - localSources.add(uri.normalize().toASCIIString()); - } - } - localSources.sort(String::compareTo); - byte[] buffer = new byte[HASH_BUFFER_BYTES]; - for (String source : localSources) { - Path path = requireLocalDatapackPath(parseSourceUri(source)); - updateFingerprintValue(digest, "local-source:" + source); - try (InputStream input = Files.newInputStream( - path, - StandardOpenOption.READ, - LinkOption.NOFOLLOW_LINKS)) { - long bytes = 0; - int length; - while ((length = input.read(buffer)) > 0) { - bytes += length; - if (bytes > MAX_DOWNLOAD_BYTES) { - throw new IOException("Local datapack exceeds " + MAX_DOWNLOAD_BYTES + " bytes: " + path); - } - digest.update(buffer, 0, length); - } - updateDigestLong(digest, bytes); - } - } - } - - private static URI parseSourceUri(String source) throws IOException { - if (source == null || source.isBlank()) { - return null; - } - try { - return new URI(source.trim()); - } catch (URISyntaxException exception) { - throw new IOException("Invalid datapack URL " + source, exception); - } - } - - private static void updateDirectoryFingerprint( - MessageDigest digest, - String identity, - File directory - ) throws IOException { - updateFingerprintValue(digest, identity); - Path path = directory.toPath(); - if (Files.notExists(path, LinkOption.NOFOLLOW_LINKS)) { - updateFingerprintValue(digest, "missing"); - return; - } - if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS) - || Files.isSymbolicLink(path) - || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid external datapack validation directory " + path); - } - updateFingerprintValue(digest, directoryHash(directory)); - Path ownership = new File(directory, OWNERSHIP_MARKER).toPath(); - if (Files.isRegularFile(ownership, LinkOption.NOFOLLOW_LINKS) && !Files.isSymbolicLink(ownership)) { - byte[] marker = readBoundedBytes( - ownership, MAX_OWNERSHIP_BYTES, "External datapack ownership fingerprint"); - updateDigestLong(digest, marker.length); - digest.update(marker); - } else { - updateDigestLong(digest, -1L); - } - } - - private static void updateFingerprintValue(MessageDigest digest, String value) { - byte[] bytes = Objects.requireNonNullElse(value, "").getBytes(StandardCharsets.UTF_8); - updateDigestInt(digest, bytes.length); - digest.update(bytes); - } - - private static String failureMessage(Throwable exception) { - if (exception == null) { - return "unknown failure"; - } - String message = exception.getMessage(); - return message == null || message.isBlank() ? exception.getClass().getSimpleName() : message; + boolean maintenanceChanged = DatapackStructureImports.autoImportDatapackStructures(); + DatapackStartupValidation.refreshStartupValidationAfterMaintenance(maintenanceChanged); } public static void refreshWorkspaces() { @@ -570,7 +163,7 @@ public final class DatapackIngestService { } public static void refreshWorkspace(IrisData data) { - if (data == null || !hasImports(data)) { + if (data == null || !DatapackImportSources.hasImports(data)) { return; } try { @@ -599,12 +192,12 @@ public final class DatapackIngestService { ServerConfigurator.invalidateLoadedDatapackRuntime(); Report report; boolean settled = false; - TRANSACTION_LOCK.lock(); + DatapackTransactions.TRANSACTION_LOCK.lock(); try { report = ingestLocked(sender, urls, restart); settled = true; } finally { - TRANSACTION_LOCK.unlock(); + DatapackTransactions.TRANSACTION_LOCK.unlock(); if (!settled && gateAdmission) { // Never strand the admission gate at PENDING on an unexpected throw. IrisStartupValidation.markDatapacksInvalid( @@ -633,7 +226,7 @@ public final class DatapackIngestService { private static Report ingestLocked(VolmitSender sender, KList urls, boolean restart) { Report report = new Report(); if (urls == null || urls.isEmpty()) { - message(sender, C.YELLOW + "No external datapacks found. Add an HTTP(S) or file URL to a dimension's 'datapackImports', or place a ZIP in Iris/datapacks/imports, then run /iris datapack ingest."); + DatapackSupport.message(sender, C.YELLOW + "No external datapacks found. Add an HTTP(S) or file URL to a dimension's 'datapackImports', or place a ZIP in Iris/datapacks/imports, then run /iris datapack ingest."); return report; } @@ -641,30 +234,30 @@ public final class DatapackIngestService { File cacheDir = new File(root, "cache"); File stagingDir = new File(root, "staging"); try { - ensureScratchDirectory(cacheDir, "datapack download cache"); - ensureScratchDirectory(stagingDir, "datapack staging"); + DatapackSupport.ensureScratchDirectory(cacheDir, "datapack download cache"); + DatapackSupport.ensureScratchDirectory(stagingDir, "datapack staging"); } catch (IOException e) { report.failed.add("local storage - " + e.getMessage()); - message(sender, C.RED + "Datapack ingest failed: " + e.getMessage()); + DatapackSupport.message(sender, C.RED + "Datapack ingest failed: " + e.getMessage()); IrisLogging.reportError(e); return report; } KList worldFolders = ServerConfigurator.getDatapacksFolder(); - String mcVersion = serverMcVersion(); + String mcVersion = DatapackSupport.serverMcVersion(); try { - recoverTransactions(root, worldFolders); + DatapackScratchRecovery.recoverTransactions(root, worldFolders); } catch (IOException e) { report.failed.add("transaction recovery - " + e.getMessage()); - message(sender, C.RED + "Datapack ingest blocked by incomplete transaction recovery: " + e.getMessage()); + DatapackSupport.message(sender, C.RED + "Datapack ingest blocked by incomplete transaction recovery: " + e.getMessage()); IrisLogging.reportError(e); return report; } - Manifest manifest = readManifest(root); - boolean stripOverrides = resolveStripOverrides(); + Manifest manifest = DatapackManifestStore.readManifest(root); + boolean stripOverrides = DatapackPackMetadata.resolveStripOverrides(); List installs = new ArrayList<>(); - message(sender, C.GRAY + "Ingesting " + C.WHITE + urls.size() + C.GRAY + " datapack import(s)" + (mcVersion == null ? "" : " for MC " + mcVersion) + (stripOverrides ? C.GRAY + " (datapackOverrides=false: minecraft-namespaced structure overrides will be stripped)" : "") + "..."); + DatapackSupport.message(sender, C.GRAY + "Ingesting " + C.WHITE + urls.size() + C.GRAY + " datapack import(s)" + (mcVersion == null ? "" : " for MC " + mcVersion) + (stripOverrides ? C.GRAY + " (datapackOverrides=false: minecraft-namespaced structure overrides will be stripped)" : "") + "..."); for (String url : urls) { try { @@ -682,7 +275,7 @@ public final class DatapackIngestService { ); } catch (Exception e) { report.failed.add(url + " - " + e.getMessage()); - message(sender, C.RED + " Failed: " + C.WHITE + url + C.RED + " - " + e.getMessage()); + DatapackSupport.message(sender, C.RED + " Failed: " + C.WHITE + url + C.RED + " - " + e.getMessage()); IrisLogging.reportError(e); } } @@ -692,19 +285,19 @@ public final class DatapackIngestService { boolean manifestDurabilityConfirmed = false; try { for (InstallExecution install : installs) { - verifyInstallExecution(install); + DatapackInstall.verifyInstallExecution(install); } - manifestWrite = prepareManifestWrite(root, manifest); + manifestWrite = DatapackManifestStore.prepareManifestWrite(root, manifest); manifestWrite.publish(); manifestDurabilityConfirmed = true; } catch (IOException manifestFailure) { if (manifestWrite == null || !manifestWrite.published()) { - rollbackInstallExecutions(installs, manifestFailure); + DatapackInstall.rollbackInstallExecutions(installs, manifestFailure); report.failed.add("manifest - " + manifestFailure.getMessage()); report.updated.clear(); report.upToDate.clear(); report.requiresRestart = false; - message(sender, C.RED + "Datapack ingest rolled back before the manifest commit: " + DatapackSupport.message(sender, C.RED + "Datapack ingest rolled back before the manifest commit: " + manifestFailure.getMessage()); IrisLogging.reportError(manifestFailure); return report; @@ -723,22 +316,22 @@ public final class DatapackIngestService { if (manifestDurabilityConfirmed) { for (InstallExecution install : installs) { try { - finishInstallExecution(install); + DatapackInstall.finishInstallExecution(install); } catch (IOException cleanupFailure) { IrisLogging.reportError("Datapack install committed but transaction cleanup requires restart recovery.", cleanupFailure); } } } - pruneCache(cacheDir); - message(sender, C.GREEN + "Datapack ingest complete: " + C.WHITE + report.updated.size() + C.GREEN + " updated, " + C.WHITE + report.upToDate.size() + C.GREEN + " up to date, " + C.WHITE + report.failed.size() + C.GREEN + " failed."); + DatapackArchive.pruneCache(cacheDir); + DatapackSupport.message(sender, C.GREEN + "Datapack ingest complete: " + C.WHITE + report.updated.size() + C.GREEN + " updated, " + C.WHITE + report.upToDate.size() + C.GREEN + " up to date, " + C.WHITE + report.failed.size() + C.GREEN + " failed."); if (report.changed()) { - message(sender, C.YELLOW + "New datapack structures were installed. A server restart is required for them to register and generate."); - message(sender, C.GRAY + "After the restart they generate natively in Iris dimensions that declare their source URL; ZIPs from Iris/datapacks/imports are enabled for every Iris dimension. To get editable Iris copies (jigsaw pools, pieces & objects written into the pack) run /iris structure import , or set general.autoImportDatapackStructures=true to do it on every ingest. Place any registered key directly with a 'structures' placement using nativeStructures."); - message(sender, C.GRAY + "Datapacks replace matching vanilla structure keys by default. Set 'importedStructures.datapackOverrides' to false to keep minecraft-namespaced structure definitions untouched; deny non-minecraft datapack and mod structure families with importedStructures.disabled or complete keys with importedStructures.disabledExact."); + DatapackSupport.message(sender, C.YELLOW + "New datapack structures were installed. A server restart is required for them to register and generate."); + DatapackSupport.message(sender, C.GRAY + "After the restart they generate natively in Iris dimensions that declare their source URL; ZIPs from Iris/datapacks/imports are enabled for every Iris dimension. To get editable Iris copies (jigsaw pools, pieces & objects written into the pack) run /iris structure import , or set general.autoImportDatapackStructures=true to do it on every ingest. Place any registered key directly with a 'structures' placement using nativeStructures."); + DatapackSupport.message(sender, C.GRAY + "Datapacks replace matching vanilla structure keys by default. Set 'importedStructures.datapackOverrides' to false to keep minecraft-namespaced structure definitions untouched; deny non-minecraft datapack and mod structure families with importedStructures.disabled or complete keys with importedStructures.disabledExact."); if (!restart) { - message(sender, C.GRAY + "Run with restart=true to restart now, or restart manually. After restart, run /iris structure list to see the new keys."); + DatapackSupport.message(sender, C.GRAY + "Run with restart=true to restart now, or restart manually. After restart, run /iris structure list to see the new keys."); } } @@ -749,11 +342,11 @@ public final class DatapackIngestService { ServerConfigurator.LoadedDatapackRuntimeInvalidation invalidation = ServerConfigurator.invalidateLoadedDatapackRuntime(); ReapplyOutcome outcome; - TRANSACTION_LOCK.lock(); + DatapackTransactions.TRANSACTION_LOCK.lock(); try { - outcome = reapplyFromStagingLocked(worldFolders); + outcome = DatapackStagingReapply.reapplyFromStagingLocked(worldFolders); } finally { - TRANSACTION_LOCK.unlock(); + DatapackTransactions.TRANSACTION_LOCK.unlock(); } if (outcome.succeeded() && !outcome.changed()) { ServerConfigurator.restoreLoadedDatapackRuntimeIfUnchanged(invalidation); @@ -761,299 +354,21 @@ public final class DatapackIngestService { ServerConfigurator.requireDatapackRestart(); } else { IrisStartupValidation.markDatapacksInvalid(outcome.failure() - .map(DatapackIngestService::failureMessage) + .map(DatapackSupport::failureMessage) .orElse("External datapack recovery failed.")); } return outcome; } - private static ReapplyOutcome reapplyFromStagingLocked(KList worldFolders) { - File root = IrisPlatforms.get().dataFolder("datapacks"); - ReapplyOutcome recovery = recoverBeforeReapplyOutcome(root, worldFolders); - if (!recovery.succeeded()) { - return reportReapplyFailure(recovery); - } - File stagingDir = IrisPlatforms.get().dataFolderNoCreate("datapacks", "staging"); - ReapplyOutcome repair = reapplyStagingRootOutcome( - root, - stagingDir, - worldFolders, - resolveStripOverrides()); - if (!repair.succeeded()) { - return reportReapplyFailure(repair); - } - return ReapplyOutcome.success(recovery.recovered(), repair.repaired()); - } - - static boolean reapplyStagingRoot( - File root, - File stagingDir, - KList worldFolders, - boolean stripOverrides - ) { - return reportReapplyFailure(reapplyStagingRootOutcome( - root, - stagingDir, - worldFolders, - stripOverrides)).succeeded(); - } - - static ReapplyOutcome reapplyStagingRootOutcome( - File root, - File stagingDir, - KList worldFolders, - boolean stripOverrides - ) { - Manifest manifest = readManifest(root); - if (stagingDir == null - || !Files.exists(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { - if (manifest.entries.isEmpty()) { - return ReapplyOutcome.success(false, false); - } - File missing = stagingDir == null ? new File(root, "staging") : stagingDir; - return ReapplyOutcome.failed(new IOException( - "Managed datapack staging is missing at " + missing.getPath())); - } - if (Files.isSymbolicLink(stagingDir.toPath()) - || !Files.isDirectory(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { - return ReapplyOutcome.failed(new IOException( - "Managed datapack staging is not a safe directory at " + stagingDir.getPath())); - } - return reapplyStagedDirectoriesOutcome( - root, stagingDir, worldFolders, stripOverrides, manifest); - } - - static boolean reapplyStagedDirectories( - File root, - File stagingDir, - KList worldFolders, - boolean stripOverrides - ) { - if (Files.isSymbolicLink(stagingDir.toPath()) - || !Files.isDirectory(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { - return reportReapplyFailure(ReapplyOutcome.failed(new IOException( - "Managed datapack staging is not a safe directory at " - + stagingDir.getPath()))).succeeded(); - } - return reportReapplyFailure(reapplyStagedDirectoriesOutcome( - root, - stagingDir, - worldFolders, - stripOverrides, - readManifest(root))).succeeded(); - } - - private static ReapplyOutcome reapplyStagedDirectoriesOutcome( - File root, - File stagingDir, - KList worldFolders, - boolean stripOverrides, - Manifest manifest - ) { - File[] staged = stagingDir.listFiles(File::isDirectory); - if (staged == null) { - return ReapplyOutcome.failed(new IOException( - "Unable to enumerate managed datapack staging at " + stagingDir.getPath())); - } - boolean repaired = false; - IOException failure = null; - for (Entry entry : manifest.entries) { - File stagedDir = new File(stagingDir, entry.id); - if (isRecordedUnchangedInstall(stagedDir, worldFolders, entry, stripOverrides)) { - continue; - } - if (!isUsableStaging(stagedDir, entry)) { - forgetInstallMetadata(entry); - failure = appendFailure(failure, new IOException( - "Managed datapack staging is unusable for '" + entry.id - + "' at " + stagedDir.getPath())); - continue; - } - try { - InstallResult result = install(stagedDir, worldFolders, entry, stripOverrides); - if (result.changed()) { - repaired = true; - IrisLogging.warn("Repaired installed datapack '" + entry.id - + "' from Iris staging before datapack compilation."); - } - recordInstallMetadata(stagedDir, worldFolders, entry); - } catch (IOException e) { - forgetInstallMetadata(entry); - failure = appendFailure(failure, e); - } - } - writeManifest(root, manifest); - return failure == null - ? ReapplyOutcome.success(false, repaired) - : ReapplyOutcome.failed(failure); - } - - private static IOException appendFailure(IOException current, IOException additional) { - if (current == null) { - return additional; - } - current.addSuppressed(additional); - return current; - } - - private static ReapplyOutcome reportReapplyFailure(ReapplyOutcome outcome) { - if (!outcome.succeeded()) { - IrisLogging.reportError( - "External datapack recovery or staging repair failed.", - outcome.failure().orElseThrow()); - } - return outcome; - } - - private static boolean isRecordedUnchangedInstall( - File stagedDir, - KList worldFolders, - Entry entry, - boolean stripOverrides - ) { - if (entry.stagingMetadata == null || entry.stagingMetadata.isBlank() - || entry.installMetadata == null || entry.installMetadata.size() != worldFolders.size()) { - return false; - } - try { - if (!isRecordedManagedDirectory(stagedDir, entry) - || !entry.stagingMetadata.equals(metadataDigest(stagedDir))) { - return false; - } - for (File worldFolder : worldFolders) { - File target = new File(worldFolder, entry.id); - if (!isRecordedManagedDirectory(target, entry) - || new File(target, OVERRIDES_STRIPPED_MARKER).isFile() != stripOverrides) { - return false; - } - String recorded = entry.installMetadata.get(installMetadataKey(target)); - if (recorded == null || !recorded.equals(metadataDigest(target))) { - return false; - } - } - return true; - } catch (IOException e) { - IrisLogging.debug("Managed datapack '" + entry.id - + "' requires full verification: " + e.getMessage()); - return false; - } - } - - private static boolean isRecordedManagedDirectory(File directory, Entry entry) throws IOException { - Path path = directory.toPath(); - if (!Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS) || Files.isSymbolicLink(path)) { - return false; - } - if (!new File(directory, "pack.mcmeta").isFile()) { - return false; - } - Ownership ownership = readOwnershipOrNull(directory); - return ownership != null - && ownershipSourceMatches(ownership, entry) - && Objects.equals(ownership.versionId, entry.versionId) - && Objects.equals(ownership.versionNumber, entry.versionNumber) - && Objects.equals(ownership.sha1, entry.sha1); - } - - private static void recordInstallMetadata(File stagedDir, KList worldFolders, Entry entry) { - try { - Map recorded = new HashMap<>(); - for (File worldFolder : worldFolders) { - File target = new File(worldFolder, entry.id); - recorded.put(installMetadataKey(target), metadataDigest(target)); - } - entry.stagingMetadata = metadataDigest(stagedDir); - entry.installMetadata = recorded; - } catch (IOException e) { - IrisLogging.debug("Unable to record managed datapack metadata for '" + entry.id - + "': " + e.getMessage()); - forgetInstallMetadata(entry); - } - } - - private static void forgetInstallMetadata(Entry entry) { - entry.stagingMetadata = ""; - entry.installMetadata = new HashMap<>(); - } - - private static String installMetadataKey(File target) { - return target.toPath().toAbsolutePath().normalize().toString(); - } - - private static String metadataDigest(File root) throws IOException { - try { - MessageDigest digest = MessageDigest.getInstance("SHA-256"); - Path rootPath = root.toPath().toAbsolutePath().normalize(); - List entries = new ArrayList<>(); - try (Stream paths = Files.walk(rootPath)) { - Iterator iterator = paths.iterator(); - int pathCount = 0; - while (iterator.hasNext()) { - Path path = iterator.next(); - if (path.equals(rootPath) || isFinderMetadata(path)) { - continue; - } - pathCount++; - if (pathCount > MAX_MANAGED_PATHS) { - throw new IOException("Datapack contains more than " + MAX_MANAGED_PATHS + " paths"); - } - if (Files.isSymbolicLink(path)) { - throw new IOException("Datapack contains a symbolic link: " + path); - } - String relativePath = rootPath.relativize(path).toString(); - entries.add(new MetadataEntry(path, relativePath)); - } - } - entries.sort(Comparator.comparing(MetadataEntry::relativePath)); - for (MetadataEntry entry : entries) { - String relative = entry.relativePath().replace(File.separatorChar, '/'); - byte[] relativeBytes = relative.getBytes(StandardCharsets.UTF_8); - BasicFileAttributes attributes = Files.readAttributes( - entry.path(), BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); - if (!attributes.isDirectory() && !attributes.isRegularFile()) { - throw new IOException("Datapack contains an unsupported filesystem entry: " + entry.path()); - } - digest.update((byte) (attributes.isDirectory() ? 1 : 2)); - updateDigestInt(digest, relativeBytes.length); - digest.update(relativeBytes); - if (!attributes.isDirectory()) { - updateDigestLong(digest, attributes.size()); - updateDigestLong(digest, attributes.lastModifiedTime().toMillis()); - } - } - return hex(digest.digest()); - } catch (NoSuchAlgorithmException e) { - throw new IOException("SHA-256 algorithm unavailable", e); - } - } - - static boolean recoverBeforeReapply(File root, List worldFolders) { - return reportReapplyFailure(recoverBeforeReapplyOutcome(root, worldFolders)).succeeded(); - } - - private static ReapplyOutcome recoverBeforeReapplyOutcome(File root, List worldFolders) { - try { - return ReapplyOutcome.success(recoverTransactions(root, worldFolders), false); - } catch (IOException e) { - return ReapplyOutcome.failed(e); - } - } - - enum RemoveOutcome { - REMOVED, - REJECTED, - FAILED_AFTER_MUTATION - } - public static boolean remove(VolmitSender sender, String id) { ServerConfigurator.LoadedDatapackRuntimeInvalidation invalidation = ServerConfigurator.invalidateLoadedDatapackRuntime(); RemoveOutcome outcome; - TRANSACTION_LOCK.lock(); + DatapackTransactions.TRANSACTION_LOCK.lock(); try { - outcome = removeOutcomeLocked(sender, id); + outcome = DatapackRemoval.removeOutcomeLocked(sender, id); } finally { - TRANSACTION_LOCK.unlock(); + DatapackTransactions.TRANSACTION_LOCK.unlock(); } if (outcome == RemoveOutcome.REMOVED) { ServerConfigurator.requireDatapackRestart(); @@ -1066,438 +381,12 @@ public final class DatapackIngestService { return outcome == RemoveOutcome.REMOVED; } - private static RemoveOutcome removeOutcomeLocked(VolmitSender sender, String id) { - File root = IrisPlatforms.get().dataFolder("datapacks"); - return removeOutcomeLocked(sender, id, root, ServerConfigurator.getDatapacksFolder()); - } - - static boolean removeLocked(VolmitSender sender, String id, File root, List worldFolders) { - return removeOutcomeLocked(sender, id, root, worldFolders) == RemoveOutcome.REMOVED; - } - - static RemoveOutcome removeOutcomeLocked(VolmitSender sender, String id, File root, List worldFolders) { - String requested = id == null ? "" : id.trim().toLowerCase(Locale.ROOT); - String cleaned = sanitizeId(id); - if (requested.isBlank() || !requested.equals(cleaned) || RESERVED_IDS.contains(cleaned)) { - message(sender, C.RED + "Invalid Iris-managed datapack id '" + requested + "'. Run /iris datapack list and use the exact listed id."); - return RemoveOutcome.REJECTED; - } - try { - recoverTransactions(root, worldFolders); - } catch (IOException e) { - message(sender, C.RED + "Datapack removal blocked by incomplete transaction recovery: " + e.getMessage()); - IrisLogging.reportError(e); - return RemoveOutcome.REJECTED; - } - Manifest manifest = readManifest(root); - Entry ownedEntry = manifest.findById(cleaned); - if (ownedEntry == null) { - message(sender, C.YELLOW + "No Iris-managed datapack named '" + cleaned + "'. Unmanaged world datapacks are never removed by Iris."); - return RemoveOutcome.REJECTED; - } - - List targets; - try { - targets = preflightRemovalTargets(root, worldFolders, ownedEntry); - } catch (IOException e) { - message(sender, C.RED + "Refused to remove datapack '" + cleaned + "': " + e.getMessage()); - IrisLogging.reportError(e); - return RemoveOutcome.REJECTED; - } - - EditableImportRemoval editableRemoval = null; - DirectoryRemoval directoryRemoval = null; - ManifestWrite manifestWrite = null; - DatapackCoordinator coordinator = null; - try { - editableRemoval = prepareEntryImportRemoval(ownedEntry, manifest.entries); - directoryRemoval = prepareOwnedDirectories(targets); - if (!manifest.removeById(cleaned)) { - throw new IOException("Datapack manifest entry disappeared during removal"); - } - manifestWrite = prepareManifestWrite(root, manifest); - coordinator = createRemovalCoordinator(root, ownedEntry, directoryRemoval, editableRemoval); - coordinator.phase(CoordinatorPhase.PUBLISHING); - directoryRemoval.prepare(); - coordinator.phase(CoordinatorPhase.PUBLISHED); - manifestWrite.publish(); - } catch (IOException | RuntimeException removalFailure) { - boolean manifestCommitted = manifestWrite != null && manifestWrite.published(); - if (manifestCommitted) { - finishCommittedRemoval(cleaned, manifestWrite, directoryRemoval, editableRemoval, coordinator, - removalFailure); - message(sender, C.GREEN + "Removed datapack '" + C.WHITE + cleaned + C.GREEN - + "'. Restart for it to stop generating, and delete its URL from the pack's datapackImports to keep it gone."); - return RemoveOutcome.REMOVED; - } - boolean restored = rollbackRemoval(manifestWrite, directoryRemoval, editableRemoval, removalFailure); - if (restored && coordinator != null) { - try { - coordinator.finish(); - } catch (IOException cleanupFailure) { - removalFailure.addSuppressed(cleanupFailure); - } - } - message(sender, C.RED + "Failed to remove datapack '" + cleaned - + "'; Iris attempted to restore every prior location: " + removalFailure.getMessage()); - IrisLogging.reportError(removalFailure); - // A mutation was attempted; even a successful rollback is not provably identical - // (the fingerprint does not cover datapacks/), so stay conservatively invalidated. - return RemoveOutcome.FAILED_AFTER_MUTATION; - } - finishCommittedRemoval(cleaned, manifestWrite, directoryRemoval, editableRemoval, coordinator, null); - message(sender, C.GREEN + "Removed datapack '" + C.WHITE + cleaned + C.GREEN - + "'. Restart for it to stop generating, and delete its URL from the pack's datapackImports to keep it gone."); - return RemoveOutcome.REMOVED; - } - - private static void finishCommittedRemoval( - String id, - ManifestWrite manifestWrite, - DirectoryRemoval directoryRemoval, - EditableImportRemoval editableRemoval, - DatapackCoordinator coordinator, - Throwable priorFailure - ) { - if (priorFailure != null) { - IOException recoveryFailure = new IOException( - "Datapack manifest committed before publication durability was confirmed", - priorFailure - ); - if (editableRemoval != null) { - try { - editableRemoval.leaveForRecovery(); - } catch (IOException releaseFailure) { - recoveryFailure.addSuppressed(releaseFailure); - } - } - try { - manifestWrite.discard(); - } catch (IOException cleanupFailure) { - recoveryFailure.addSuppressed(cleanupFailure); - } - IrisLogging.reportError("Datapack '" + id - + "' was removed but transaction cleanup requires restart recovery.", recoveryFailure); - return; - } - - IOException failure = null; - if (coordinator != null) { - try { - coordinator.phase(CoordinatorPhase.COMMITTED); - } catch (IOException phaseFailure) { - failure = appendIOException(failure, phaseFailure); - if (editableRemoval != null) { - try { - editableRemoval.leaveForRecovery(); - } catch (IOException releaseFailure) { - failure = appendIOException(failure, releaseFailure); - } - } - try { - manifestWrite.discard(); - } catch (IOException cleanupFailure) { - failure = appendIOException(failure, cleanupFailure); - } - IrisLogging.reportError("Datapack '" + id - + "' was removed but transaction cleanup requires restart recovery.", failure); - return; - } - } - if (editableRemoval != null) { - try { - editableRemoval.markCommitted(); - editableRemoval.finishCommit(); - } catch (IOException | RuntimeException cleanupFailure) { - failure = appendIOException(failure, cleanupFailure); - try { - editableRemoval.leaveForRecovery(); - } catch (IOException releaseFailure) { - failure = appendIOException(failure, releaseFailure); - } - } - } - if (directoryRemoval != null) { - try { - directoryRemoval.finishCommit(); - } catch (IOException | RuntimeException cleanupFailure) { - failure = appendIOException(failure, cleanupFailure); - } - } - try { - manifestWrite.discard(); - } catch (IOException cleanupFailure) { - failure = appendIOException(failure, cleanupFailure); - } - if (failure == null && coordinator != null) { - try { - coordinator.finish(); - } catch (IOException cleanupFailure) { - failure = cleanupFailure; - } - } - if (failure != null) { - IrisLogging.reportError("Datapack '" + id - + "' was removed but transaction cleanup requires restart recovery.", failure); - } - } - - private static IOException appendIOException(IOException current, Throwable failure) { - IOException next = failure instanceof IOException ioFailure - ? ioFailure : new IOException("Datapack transaction participant failed", failure); - if (current == null) { - return next; - } - current.addSuppressed(next); - return current; - } - - private static List preflightRemovalTargets(File root, List worldFolders, Entry entry) throws IOException { - List targets = new ArrayList<>(); - Set seen = new HashSet<>(); - File staging = new File(root, "staging"); - verifyDirectoryContainerIfPresent(staging, "datapack staging"); - File stagedDir = new File(staging, entry.id); - verifyAndCollectRemovalTarget(stagedDir, entry, targets, seen); - for (File worldFolder : worldFolders) { - verifyDirectoryContainerIfPresent(worldFolder, "world datapacks"); - verifyAndCollectRemovalTarget(new File(worldFolder, entry.id), entry, targets, seen); - } - return targets; - } - - private static void verifyAndCollectRemovalTarget( - File target, - Entry entry, - List targets, - Set seen - ) throws IOException { - verifyOwnedDirectoryIfPresent(target, entry); - Path normalized = target.toPath().toAbsolutePath().normalize(); - if (pathExists(normalized, "datapack removal target")) { - Path identity = normalized.toRealPath(); - if (!seen.add(identity)) { - throw new IOException("Aliased datapack removal target " + normalized); - } - targets.add(target); - } - } - - private static EditableImportRemoval prepareEntryImportRemoval( - Entry entry, - List manifestEntries - ) throws IOException { - List prepared = new ArrayList<>(); - Set targetIdSet = new TreeSet<>(entry.importedBundles.keySet()); - targetIdSet.addAll(entry.importedTargets.keySet()); - targetIdSet.addAll(entry.importAttempts.keySet()); - List targetIds = new ArrayList<>(targetIdSet); - targetIds.sort(String::compareTo); - try { - for (String targetId : targetIds) { - Set retainedKeys = invalidateRetainedImportClaims( - entry, targetId, manifestEntries); - File dataFolder = new File(targetId); - if (!dataFolder.isDirectory()) { - continue; - } - StructureTransactionWriter writer = new StructureTransactionWriter(dataFolder.toPath()); - List removals = ownedImportRemovals( - writer, - entry, - targetId, - retainedKeys - ); - StructureTransactionWriter.PreparedRemoval removal = - writer.prepareMatchingOwnedRemovals(removals); - prepared.add(new PreparedEditableImport(dataFolder, removal)); - } - return new EditableImportRemoval(prepared); - } catch (IOException | RuntimeException preparationFailure) { - IOException failure = preparationFailure instanceof IOException ioFailure - ? ioFailure - : new IOException("Failed preparing editable datapack import cleanup", preparationFailure); - for (int i = prepared.size() - 1; i >= 0; i--) { - try { - prepared.get(i).removal().rollback(); - } catch (IOException rollbackFailure) { - failure.addSuppressed(rollbackFailure); - } - } - throw failure; - } - } - - private static List ownedImportRemovals( - StructureTransactionWriter writer, - Entry removingEntry, - String targetId, - Set retainedKeys - ) throws IOException { - List removals = new ArrayList<>(); - Map> removingClaims = importBundleClaims(removingEntry, targetId); - for (Map.Entry> bundle : removingClaims.entrySet()) { - try { - StructureKey targetKey = StructureKey.parse(bundle.getKey()); - if (retainedKeys.contains(bundle.getKey())) { - continue; - } - Optional ownedSource = writer.ownedSource(targetKey); - if (ownedSource.isEmpty() || !sourceClaimsContain(bundle.getValue(), ownedSource.get())) { - continue; - } - removals.add(StructureTransactionWriter.OwnedRemoval.managedDatapack( - targetKey, - ownedSource.get().kind(), - ownedSource.get().key() - )); - } catch (RuntimeException e) { - throw new IOException("Invalid editable structure import inventory entry '" - + bundle.getKey() + "' -> '" + bundle.getValue() + "'", e); - } - } - return List.copyOf(removals); - } - - private static Set invalidateRetainedImportClaims( - Entry removingEntry, - String targetId, - List manifestEntries - ) { - Set removingKeys = importBundleClaims(removingEntry, targetId).keySet(); - Set retainedKeys = new TreeSet<>(); - for (Entry candidate : manifestEntries) { - if (candidate == removingEntry) { - continue; - } - Set candidateKeys = importBundleClaims(candidate, targetId).keySet(); - boolean candidateRetained = false; - for (String candidateKey : candidateKeys) { - if (removingKeys.contains(candidateKey)) { - retainedKeys.add(candidateKey); - candidateRetained = true; - } - } - if (candidateRetained) { - candidate.importedTargets.remove(targetId); - candidate.importAttempts.remove(targetId); - candidate.structuresImported = false; - } - } - return Set.copyOf(retainedKeys); - } - - private static Map> importBundleClaims(Entry entry, String targetId) { - Map> claims = new TreeMap<>(); - addImportBundleClaims(claims, entry.importedBundles.getOrDefault(targetId, Map.of())); - if (entry.importedBundles.containsKey(targetId) || entry.importedTargets.containsKey(targetId)) { - addImportBundleClaims(claims, importBundleInventory(entry)); - } - return claims; - } - - private static void addImportBundleClaims( - Map> claims, - Map inventory - ) { - for (Map.Entry bundle : inventory.entrySet()) { - claims.computeIfAbsent(bundle.getKey(), ignored -> new TreeSet<>()).add(bundle.getValue()); - } - } - - private static boolean sourceClaimsContain(Set claims, StructureSource source) throws IOException { - for (String claimedKey : claims) { - try { - StructureKey sourceKey = StructureKey.parse(claimedKey); - StructureSource.Kind sourceKind = sourceKey.namespace().equals("minecraft") - ? StructureSource.Kind.VANILLA : StructureSource.Kind.DATAPACK; - if (source.kind() == sourceKind && source.key().equals(sourceKey)) { - return true; - } - } catch (RuntimeException e) { - throw new IOException("Invalid editable structure source key '" + claimedKey + "'", e); - } - } - return false; - } - - private static DirectoryRemoval prepareOwnedDirectories(List targets) throws IOException { - List planned = new ArrayList<>(); - for (File target : targets) { - File parent = target.getParentFile(); - File backupRoot = new File(parent.getParentFile() == null ? parent : parent.getParentFile(), ".iris-datapack-remove"); - File backup = new File(backupRoot, target.getName() + "-" + UUID.randomUUID()); - ensureScratchDirectory(backupRoot, "datapack removal backup"); - validateInstallTree(target, parent, "Datapack removal target"); - planned.add(new DirectoryMove( - target, - backup, - directoryHash(target), - ownershipMarkerFingerprint(target), - directoryIdentity(target), - realDirectoryPath(parent, "datapack target root"), - realDirectoryPath(backupRoot, "datapack removal scratch root"), - directoryIdentity(parent), - directoryIdentity(backupRoot) - )); - } - return new DirectoryRemoval(planned); - } - - private static boolean rollbackRemoval( - ManifestWrite manifestWrite, - DirectoryRemoval directoryRemoval, - EditableImportRemoval editableRemoval, - Throwable removalFailure - ) { - if (manifestWrite != null) { - try { - manifestWrite.discard(); - } catch (IOException discardFailure) { - removalFailure.addSuppressed(discardFailure); - } - } - if (directoryRemoval != null) { - try { - directoryRemoval.rollback(); - } catch (IOException rollbackFailure) { - removalFailure.addSuppressed(rollbackFailure); - } - } - if (editableRemoval != null) { - try { - editableRemoval.rollback(); - } catch (IOException rollbackFailure) { - removalFailure.addSuppressed(rollbackFailure); - } - } - return removalFailure.getSuppressed().length == 0; - } - - private static void verifyOwnedDirectoryIfPresent(File directory, Entry entry) throws IOException { - if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - return; - } - if (Files.isSymbolicLink(directory.toPath()) - || !Files.isDirectory(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing non-directory or symbolic-link target " + directory.getPath()); - } - Ownership ownership = readOwnership(directory); - if (!ownershipSourceMatches(ownership, entry)) { - throw new IOException("Ownership marker at " + directory.getPath() + " belongs to '" + ownership.id + "'"); - } - removeFinderMetadata(directory); - if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { - throw new IOException("Refusing to remove modified or corrupt Iris-managed datapack " + directory.getPath()); - } - } - public static KList collectConfiguredImports() { LinkedHashSet sources = new LinkedHashSet<>(); try (Stream stream = ServerConfigurator.allPacks()) { - stream.forEach(data -> collectImports(data, sources)); + stream.forEach(data -> DatapackImportSources.collectImports(data, sources)); } - sources.addAll(localDatapackImports()); + sources.addAll(DatapackImportSources.localDatapackImports()); KList result = new KList<>(); result.addAll(sources); return result; @@ -1505,83 +394,30 @@ public final class DatapackIngestService { public static Set configuredImports(IrisDimension dimension) { Iterable explicit = dimension == null ? List.of() : dimension.getDatapackImports(); - return mergeConfiguredImports(explicit, localDatapackImports()); - } - - static Set mergeConfiguredImports( - Iterable explicit, - Iterable discovered - ) { - LinkedHashSet sources = new LinkedHashSet<>(); - if (explicit != null) { - addImports(explicit, sources); - } - if (discovered != null) { - addImports(discovered, sources); - } - return sources.isEmpty() ? Set.of() : Set.copyOf(sources); - } - - static List discoverLocalDatapackImports(File directory) throws IOException { - Path root = directory.toPath().toAbsolutePath().normalize(); - if (Files.notExists(root, LinkOption.NOFOLLOW_LINKS)) { - Files.createDirectories(root); - } - if (Files.isSymbolicLink(root) - || !Files.isDirectory(root, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Local datapack import path is not a safe directory: " + root); - } - try (Stream stream = Files.list(root)) { - return stream - .filter(path -> !Files.isSymbolicLink(path)) - .filter(path -> Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) - .filter(DatapackIngestService::isLocalDatapackArchive) - .sorted(Comparator.comparing( - (Path path) -> path.getFileName().toString(), - String.CASE_INSENSITIVE_ORDER) - .thenComparing((Path path) -> path.getFileName().toString())) - .map(path -> path.toAbsolutePath().normalize().toUri().toASCIIString()) - .toList(); - } - } - - private static boolean isLocalDatapackArchive(Path path) { - String name = path.getFileName().toString(); - return !name.startsWith(".") && name.toLowerCase(Locale.ROOT).endsWith(".zip"); - } - - private static List localDatapackImports() { - File directory = IrisPlatforms.get().dataFolder("datapacks", LOCAL_IMPORT_DIRECTORY); - try { - return discoverLocalDatapackImports(directory); - } catch (IOException exception) { - IrisLogging.reportError("Could not discover local datapack imports under " - + directory.getPath() + ".", exception); - return List.of(); - } + return DatapackImportSources.mergeConfiguredImports(explicit, DatapackImportSources.localDatapackImports()); } public static List installed() { - TRANSACTION_LOCK.lock(); + DatapackTransactions.TRANSACTION_LOCK.lock(); try { File root = IrisPlatforms.get().dataFolder("datapacks"); try { - recoverTransactions(root, ServerConfigurator.getDatapacksFolder()); + DatapackScratchRecovery.recoverTransactions(root, ServerConfigurator.getDatapacksFolder()); } catch (IOException e) { IrisLogging.reportError("Could not recover datapack transactions before listing installed packs.", e); return List.of(); } - return List.copyOf(readManifest(root).entries); + return List.copyOf(DatapackManifestStore.readManifest(root).entries); } finally { - TRANSACTION_LOCK.unlock(); + DatapackTransactions.TRANSACTION_LOCK.unlock(); } } public static List installedStructureScopeResources() throws IOException { - TRANSACTION_LOCK.lock(); + DatapackTransactions.TRANSACTION_LOCK.lock(); try { File root = IrisPlatforms.get().dataFolder("datapacks"); - Manifest manifest = readManifest(root); + Manifest manifest = DatapackManifestStore.readManifest(root); KList datapackFolders = ServerConfigurator.getDatapacksFolder(); List resources = new ArrayList<>(); for (Entry entry : manifest.entries) { @@ -1600,7 +436,7 @@ public final class DatapackIngestService { } return List.copyOf(resources); } finally { - TRANSACTION_LOCK.unlock(); + DatapackTransactions.TRANSACTION_LOCK.unlock(); } } @@ -1610,17 +446,17 @@ public final class DatapackIngestService { || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { throw new IOException("Invalid installed Iris-managed datapack directory " + directory.getPath()); } - validatePackMetadata(directory); - rejectSymbolicLinks(directory); - Ownership ownership = readOwnership(directory); - if (!ownershipSourceMatches(ownership, entry)) { + DatapackPackMetadata.validatePackMetadata(directory); + DatapackOwnership.rejectSymbolicLinks(directory); + Ownership ownership = DatapackOwnership.readOwnership(directory); + if (!DatapackInstall.ownershipSourceMatches(ownership, entry)) { throw new IOException("Installed datapack ownership mismatch at " + directory.getPath()); } - if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { + if (!Objects.equals(ownership.contentHash, DatapackOwnership.directoryHash(directory))) { throw new IOException("Installed Iris-managed datapack is modified or corrupt at " + directory.getPath()); } - PackResources resources = scanPackResources(directory); + PackResources resources = DatapackOwnership.scanPackResources(directory); return new StructureScopeResources( entry.url, resources.structureKeys(), @@ -1641,8 +477,8 @@ public final class DatapackIngestService { ) throws IOException { ResolvedDatapack resolved = ModrinthResolver.resolve(url, mcVersion); Entry existing = manifest.find(url); - String id = existing == null ? deriveId(resolved) : existing.id; - if (RESERVED_IDS.contains(id)) { + String id = existing == null ? DatapackArchive.deriveId(resolved) : existing.id; + if (DatapackArchive.RESERVED_IDS.contains(id)) { throw new IOException("Datapack id '" + id + "' is reserved by Iris"); } Entry idCollision = manifest.findById(id); @@ -1650,7 +486,7 @@ public final class DatapackIngestService { throw new IOException("Datapack id '" + id + "' is already owned by " + idCollision.url); } File stagedDir = new File(stagingDir, id); - boolean stageUsable = existing != null && isUsableStaging(stagedDir, existing); + boolean stageUsable = existing != null && DatapackStagingGuard.isUsableStaging(stagedDir, existing); boolean recoveringManagedStaging = existing != null && !stageUsable; boolean sameVersion = !resolved.isDirect() && existing != null @@ -1659,18 +495,18 @@ public final class DatapackIngestService { && stageUsable; if (sameVersion) { - InstallExecution execution = prepareInstallExecution( + InstallExecution execution = DatapackInstall.prepareInstallExecution( stagedDir, worldFolders, existing, stripOverrides, cacheDir.getParentFile()); installs.add(execution); InstallResult installResult = execution.result(); - recordInstallResult( + DatapackStagingGuard.recordInstallResult( sender, report, stagedDir, worldFolders, existing, installResult, resolved.getVersionNumber()); return; } - message(sender, C.GRAY + " Checking " + C.WHITE + id + C.GRAY + " " + safe(resolved.getVersionNumber()) + "..."); - File zip = new File(cacheDir, id + "-" + safeFile(resolved.getVersionId()) + ".zip"); - DownloadResult download = download( + DatapackSupport.message(sender, C.GRAY + " Checking " + C.WHITE + id + C.GRAY + " " + DatapackSupport.safe(resolved.getVersionNumber()) + "..."); + File zip = new File(cacheDir, id + "-" + DatapackSupport.safeFile(resolved.getVersionId()) + ".zip"); + DownloadResult download = DatapackArchive.download( resolved.getDownloadUrl(), zip, resolved.isDirect() && stageUsable ? existing.etag : null, @@ -1680,42 +516,42 @@ public final class DatapackIngestService { if (!stageUsable) { throw new IOException("Remote returned not-modified but Iris staging is missing or corrupt for " + id); } - Entry updated = copyEntry(existing); + Entry updated = DatapackManifestStore.copyEntry(existing); updated.etag = download.etag(); updated.lastModified = download.lastModified(); - InstallExecution execution = prepareInstallExecution( + InstallExecution execution = DatapackInstall.prepareInstallExecution( stagedDir, worldFolders, updated, stripOverrides, cacheDir.getParentFile()); installs.add(execution); InstallResult installResult = execution.result(); manifest.put(updated); - recordInstallResult( + DatapackStagingGuard.recordInstallResult( sender, report, stagedDir, worldFolders, updated, installResult, resolved.getVersionNumber()); return; } - String checksum = sha1(zip); + String checksum = DatapackArchive.sha1(zip); if (resolved.getSha1() != null && !resolved.getSha1().isBlank() && !resolved.getSha1().equalsIgnoreCase(checksum)) { IO.delete(zip); throw new IOException("Checksum mismatch for " + id + " (expected " + resolved.getSha1() + ", got " + checksum + ")"); } if (resolved.isDirect() && existing != null && Objects.equals(existing.sha1, checksum) && stageUsable) { - Entry updated = copyEntry(existing); + Entry updated = DatapackManifestStore.copyEntry(existing); updated.etag = download.etag(); updated.lastModified = download.lastModified(); updated.installedEpoch = System.currentTimeMillis(); - InstallExecution execution = prepareInstallExecution( + InstallExecution execution = DatapackInstall.prepareInstallExecution( stagedDir, worldFolders, updated, stripOverrides, cacheDir.getParentFile()); installs.add(execution); InstallResult installResult = execution.result(); - writeOwnership(stagedDir, updated); + DatapackOwnership.writeOwnership(stagedDir, updated); manifest.put(updated); - recordInstallResult( + DatapackStagingGuard.recordInstallResult( sender, report, stagedDir, worldFolders, updated, installResult, resolved.getVersionNumber()); return; } - Entry entry = existing != null ? copyEntry(existing) : new Entry(); + Entry entry = existing != null ? DatapackManifestStore.copyEntry(existing) : new Entry(); entry.url = url; entry.id = id; entry.versionId = resolved.getVersionId(); @@ -1726,2186 +562,41 @@ public final class DatapackIngestService { entry.lastModified = download.lastModified(); entry.installedEpoch = System.currentTimeMillis(); entry.structuresImported = false; - File extractedDir = extractArchive(zip, stagingDir, entry); + File extractedDir = DatapackArchive.extractArchive(zip, stagingDir, entry); InstallExecution execution; try { VerifiedStagingInstall verifiedStagingInstall = - authorizeVerifiedStagingInstall( + DatapackStagingGuard.authorizeVerifiedStagingInstall( cacheDir.getParentFile(), stagingDir, extractedDir, entry); - execution = prepareInstallExecution( + execution = DatapackInstall.prepareInstallExecution( extractedDir, worldFolders, entry, stripOverrides, cacheDir.getParentFile(), verifiedStagingInstall); } finally { - cleanupExtractedStaging(extractedDir); + DatapackArchive.cleanupExtractedStaging(extractedDir); } installs.add(execution); InstallResult installResult = execution.result(); - recordInstallMetadata(stagedDir, worldFolders, entry); + DatapackStagingReapply.recordInstallMetadata(stagedDir, worldFolders, entry); manifest.put(entry); - report.updated.add(id + " (" + safe(resolved.getVersionNumber()) + ")"); + report.updated.add(id + " (" + DatapackSupport.safe(resolved.getVersionNumber()) + ")"); if (freshInstallRequiresRestart(installResult.changed(), recoveringManagedStaging)) { report.requiresRestart = true; } - message(sender, C.GREEN + " Installed " + C.WHITE + id + C.GREEN + " " + safe(resolved.getVersionNumber())); + DatapackSupport.message(sender, C.GREEN + " Installed " + C.WHITE + id + C.GREEN + " " + DatapackSupport.safe(resolved.getVersionNumber())); } static boolean freshInstallRequiresRestart(boolean contentChanged, boolean recoveringManagedStaging) { return contentChanged || recoveringManagedStaging; } - private static File extractArchive(File zip, File stagingRoot, Entry entry) throws IOException { - ensureScratchDirectory(stagingRoot, "datapack staging"); - File pending = new File(stagingRoot, ".pending-" + entry.id + "-" + UUID.randomUUID()); - try { - if (!pending.mkdirs() && !pending.isDirectory()) { - throw new IOException("Couldn't create datapack extraction directory " + pending.getPath()); - } - ZipUtils.unzipFile(zip, pending, MAX_ARCHIVE_ENTRIES, MAX_EXPANDED_BYTES, MAX_ENTRY_BYTES); - flattenIfWrapped(pending); - validatePackMetadata(pending); - PackResources resources = scanPackResources(pending); - entry.structureKeys = resources.structureKeys; - entry.templateKeys = resources.templateKeys; - writeOwnership(pending, entry); - return pending; - } catch (UncheckedIOException e) { - IOException failure = e.getCause(); - cleanupFailedExtraction(pending, failure); - throw failure; - } catch (IOException | RuntimeException e) { - cleanupFailedExtraction(pending, e); - throw e; - } - } - - private static void cleanupFailedExtraction(File pending, Throwable failure) { - try { - deleteInstallScratch(pending, "failed datapack extraction"); - } catch (IOException cleanupFailure) { - failure.addSuppressed(cleanupFailure); - } - } - - private static void cleanupExtractedStaging(File extractedDir) { - try { - deleteInstallScratch(extractedDir, "extracted datapack staging"); - } catch (IOException e) { - IrisLogging.warn("Preserving extracted datapack staging for restart cleanup: " - + extractedDir.getPath() + " (" + e.getMessage() + ")"); - } - } - - static VerifiedStagingInstall authorizeVerifiedStagingInstall( - File root, - File stagingRoot, - File verifiedSource, - Entry entry - ) throws IOException { - Path normalizedRoot = requireDirectoryIdentity(root, "datapack storage root"); - Path normalizedStagingRoot = requireDirectoryIdentity(stagingRoot, "datapack staging root"); - requireNoSymbolicLinkComponents(normalizedRoot, "datapack storage root"); - requireNoSymbolicLinkComponents(normalizedStagingRoot, "datapack staging root"); - Path expectedStagingRoot = normalizedRoot.resolve("staging").normalize(); - if (!normalizedStagingRoot.equals(expectedStagingRoot) - || !Files.isSameFile(normalizedStagingRoot, expectedStagingRoot)) { - throw new IOException("Verified datapack staging root is not Iris's canonical staging directory"); - } - Path normalizedSource = requireDirectoryIdentity(verifiedSource, "verified datapack extraction"); - requireNoSymbolicLinkComponents(normalizedSource, "verified datapack extraction"); - if (!Objects.equals(normalizedSource.getParent(), normalizedStagingRoot) - || !Files.isSameFile(normalizedSource.getParent(), normalizedStagingRoot)) { - throw new IOException("Verified datapack extraction is outside Iris's canonical staging directory"); - } - verifyPendingExtractionName(normalizedSource.getFileName().toString(), entry.id); - validateManagedDirectory(verifiedSource, entry.id); - validateScratchTree(normalizedSource); - if (!sameScratchVolume(normalizedSource, normalizedStagingRoot)) { - throw new IOException("Verified datapack extraction crosses a filesystem boundary"); - } - String desiredHash = directoryHash(verifiedSource); - Ownership ownership = readOwnership(verifiedSource); - if (!ownershipMetadataMatches(ownership, entry, desiredHash)) { - throw new IOException("Verified datapack extraction does not match the resolved archive metadata"); - } - Manifest committedManifest = readCommittedManifest(root); - Entry committed = committedManifest.findById(entry.id); - boolean legacyReplacementAuthorized = committed != null - && Objects.equals(committed.id, entry.id) - && Objects.equals(committed.url, entry.url); - LegacyStagingSnapshot legacyStagingSnapshot = captureLegacyStagingSnapshot( - normalizedStagingRoot, entry.id, legacyReplacementAuthorized); - return new VerifiedStagingInstall( - normalizedRoot, - normalizedStagingRoot, - normalizedSource, - entry, - desiredHash, - committed, - legacyReplacementAuthorized, - legacyStagingSnapshot - ); - } - - private static LegacyStagingSnapshot captureLegacyStagingSnapshot( - Path normalizedStagingRoot, - String id, - boolean legacyReplacementAuthorized - ) throws IOException { - if (!legacyReplacementAuthorized) { - return null; - } - Path target = normalizedStagingRoot.resolve(id).normalize(); - if (!pathExists(target, "legacy datapack staging target")) { - return null; - } - if (Files.isSymbolicLink(target) - || !Files.isDirectory(target, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid legacy datapack staging target " + target); - } - validateInstallTree(target.toFile(), normalizedStagingRoot.toFile(), "Legacy datapack staging"); - String markerHash = ownershipMarkerFingerprint(target.toFile()); - if (!"absent".equals(markerHash)) { - return null; - } - return new LegacyStagingSnapshot( - target, - target.toRealPath(), - directoryIdentity(target.toFile()), - directoryHash(target.toFile()), - markerHash - ); - } - - private static Path requireDirectoryIdentity(File directory, String purpose) throws IOException { - Path normalized = directory.toPath().toAbsolutePath().normalize(); - BasicFileAttributes attributes = Files.readAttributes( - normalized, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); - if (!isSupportedScratchDirectory(attributes)) { - throw new IOException("Invalid " + purpose + " " + normalized); - } - normalized.toRealPath(); - return normalized; - } - - private static void requireNoSymbolicLinkComponents(Path normalized, String purpose) throws IOException { - Path current = normalized.getRoot(); - for (Path component : normalized) { - current = current == null ? component : current.resolve(component); - BasicFileAttributes attributes = Files.readAttributes( - current, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); - if (attributes.isSymbolicLink()) { - throw new IOException("Refusing symbolic-link component in " + purpose + " " + normalized); - } - if (attributes.isOther()) { - throw new IOException("Refusing special filesystem component in " + purpose + " " + normalized); - } - if (!isSupportedScratchDirectory(attributes)) { - throw new IOException("Refusing unsupported component in " + purpose + " " + normalized); - } - } - } - - private static void verifyPendingExtractionName(String name, String id) throws IOException { - String prefix = ".pending-" + id + "-"; - if (!name.startsWith(prefix)) { - throw new IOException("Verified datapack extraction has an invalid staging name " + name); - } - try { - UUID.fromString(name.substring(prefix.length())); - } catch (IllegalArgumentException e) { - throw new IOException("Verified datapack extraction has an invalid staging identity " + name, e); - } - } - - private static void validateInstallParticipants( - List worldFolders, - VerifiedStagingInstall verifiedStagingInstall, - Entry entry - ) throws IOException { - List roots = new ArrayList<>(worldFolders); - if (verifiedStagingInstall != null) { - roots.add(verifiedStagingInstall.stagingRoot().toFile()); - } - Set normalizedTargets = new HashSet<>(); - Set realRoots = new HashSet<>(); - Set targetIdentities = new HashSet<>(); - List existingTargets = new ArrayList<>(); - for (File folder : roots) { - ensureInstallTargetRoot(folder); - Path normalizedRoot = folder.toPath().toAbsolutePath().normalize(); - Path realRoot = normalizedRoot.toRealPath(); - Path normalizedTarget = normalizedRoot.resolve(entry.id).normalize(); - if (!realRoots.add(realRoot) || !normalizedTargets.add(normalizedTarget)) { - throw new IOException("Duplicate datapack install target " + normalizedTarget); - } - Path targetIdentity = realRoot.resolve(entry.id).normalize(); - if (Files.exists(normalizedTarget, LinkOption.NOFOLLOW_LINKS)) { - if (Files.isSymbolicLink(normalizedTarget) - || !Files.isDirectory(normalizedTarget, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing invalid datapack install target " + normalizedTarget); - } - targetIdentity = normalizedTarget.toRealPath(); - for (Path existingTarget : existingTargets) { - if (Files.isSameFile(normalizedTarget, existingTarget)) { - throw new IOException("Aliased datapack install target " + normalizedTarget); - } - } - existingTargets.add(normalizedTarget); - } - if (!targetIdentities.add(targetIdentity)) { - throw new IOException("Aliased datapack install target " + normalizedTarget); - } - } - if (verifiedStagingInstall != null) { - verifiedStagingInstall.verifyStagingRoot(); - } - } - - private static void ensureInstallTargetRoot(File directory) throws IOException { - if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - Files.createDirectories(directory.toPath()); - } - requireDirectoryIdentity(directory, "datapack install root"); - } - - static void recordInstallResult( - VolmitSender sender, - Report report, - File stagedDir, - KList worldFolders, - Entry entry, - InstallResult result, - String versionNumber - ) { - recordInstallMetadata(stagedDir, worldFolders, entry); - if (result.changed()) { - report.updated.add(entry.id + " (" + safe(versionNumber) + ")"); - report.requiresRestart = true; - message(sender, C.GREEN + " Repaired " + C.WHITE + entry.id + C.GREEN + " " + safe(versionNumber)); - return; - } - report.upToDate.add(entry.id + " (" + safe(versionNumber) + ")"); - message(sender, C.GRAY + " Up to date: " + C.WHITE + entry.id + C.GRAY + " " + safe(versionNumber)); - } - - private static void collectImports(IrisData data, LinkedHashSet urls) { - if (data == null || data.getDimensionLoader() == null) { - return; - } - for (IrisDimension dimension : data.getDimensionLoader().loadAll(data.getDimensionLoader().getPossibleKeys())) { - if (dimension == null) { - continue; - } - KList imports = dimension.getDatapackImports(); - if (imports == null) { - continue; - } - addImports(imports, urls); - } - } - - private static void addImports(Iterable imports, LinkedHashSet sources) { - for (String source : imports) { - if (source != null && !source.isBlank()) { - sources.add(normalizeConfiguredSource(source)); - } - } - } - - static String normalizeConfiguredSource(String source) { - String normalized = source.trim(); - try { - URI uri = new URI(normalized); - if ("file".equalsIgnoreCase(uri.getScheme())) { - return Path.of(uri).toAbsolutePath().normalize().toUri().toASCIIString(); - } - } catch (IllegalArgumentException | URISyntaxException ignored) { - } - return normalized; - } - - private static Set configuredImports(IrisData data) { - LinkedHashSet urls = new LinkedHashSet<>(); - collectImports(data, urls); - urls.addAll(localDatapackImports()); - return urls; - } - - private static boolean hasImports(IrisData data) { - return !configuredImports(data).isEmpty(); - } - - static InstallResult install(File stagedDir, KList worldFolders, Entry entry, boolean stripOverrides) throws IOException { - File root = inferDatapackRoot(stagedDir); - recoverTransactions(root, worldFolders); - InstallExecution execution = prepareInstallExecution( - stagedDir, - worldFolders, - entry, - stripOverrides, - root - ); - try { - verifyInstallExecution(execution); - } catch (IOException failure) { - rollbackInstallExecutions(List.of(execution), failure); - throw failure; - } - finishInstallExecution(execution); - return execution.result(); - } - - static InstallExecution prepareInstallExecution( - File stagedDir, - KList worldFolders, - Entry entry, - boolean stripOverrides, - File root - ) throws IOException { - return prepareInstallExecution( - stagedDir, worldFolders, entry, stripOverrides, root, null); - } - - static InstallExecution prepareInstallExecution( - File stagedDir, - KList worldFolders, - Entry entry, - boolean stripOverrides, - File root, - VerifiedStagingInstall verifiedStagingInstall - ) throws IOException { - validateManagedDirectory(stagedDir, entry.id); - Ownership stagedOwnership = readOwnership(stagedDir); - String stagedHash = directoryHash(stagedDir); - if (!ownershipMetadataMatches(stagedOwnership, entry, stagedHash)) { - throw new IOException("Iris datapack staging does not match the committed manifest entry for " + entry.id); - } - validateInstallParticipants(worldFolders, verifiedStagingInstall, entry); - List plans = new ArrayList<>(); - try { - for (File worldFolder : worldFolders) { - plans.add(prepareInstall( - stagedDir, worldFolder, entry, stagedHash, stripOverrides, verifiedStagingInstall)); - } - if (verifiedStagingInstall != null) { - plans.add(prepareInstall( - stagedDir, - verifiedStagingInstall.stagingRoot().toFile(), - entry, - stagedHash, - false, - verifiedStagingInstall)); - } - } catch (IOException | RuntimeException preparationFailure) { - for (InstallPlan plan : plans) { - try { - cleanupInstallPlan(plan, false); - } catch (IOException cleanupFailure) { - preparationFailure.addSuppressed(cleanupFailure); - } - } - if (preparationFailure instanceof UncheckedIOException unchecked) { - throw unchecked.getCause(); - } - if (preparationFailure instanceof IOException ioFailure) { - throw ioFailure; - } - throw preparationFailure; - } - - boolean changed = false; - List publishPlans = new ArrayList<>(); - List unchangedPlans = new ArrayList<>(); - try { - for (InstallPlan plan : plans) { - changed |= plan.contentChanged(); - if (plan.publishRequired()) { - publishPlans.add(plan); - } else { - unchangedPlans.add(plan); - cleanupInstallPlan(plan, true); - } - } - } catch (IOException cleanupFailure) { - for (InstallPlan plan : plans) { - try { - cleanupInstallPlan(plan, false); - } catch (IOException additionalFailure) { - cleanupFailure.addSuppressed(additionalFailure); - } - } - throw cleanupFailure; - } - if (publishPlans.isEmpty()) { - return new InstallExecution( - new InstallResult(changed), - null, - stagedDir, - entry, - stagedHash, - verifiedStagingInstall == null, - publishPlans, - unchangedPlans); - } - - Manifest committedManifest = readCommittedManifest(root); - boolean manifestAlreadyMatched = manifestEntryMatches(committedManifest.findById(entry.id), entry); - DatapackCoordinator coordinator; - try { - coordinator = createInstallCoordinator(root, entry, publishPlans, manifestAlreadyMatched); - } catch (IOException | RuntimeException coordinatorFailure) { - for (InstallPlan plan : publishPlans) { - try { - cleanupInstallPlan(plan, false); - } catch (IOException cleanupFailure) { - coordinatorFailure.addSuppressed(cleanupFailure); - } - } - if (coordinatorFailure instanceof IOException ioFailure) { - throw ioFailure; - } - throw coordinatorFailure; - } - - try { - coordinator.phase(CoordinatorPhase.PUBLISHING); - for (InstallPlan plan : publishPlans) { - publishInstallPlan(plan); - } - coordinator.phase(CoordinatorPhase.PUBLISHED); - } catch (IOException | RuntimeException publishFailure) { - try { - resolveCoordinatorDirectories(coordinator.journal, false); - coordinator.finish(); - } catch (IOException rollbackFailure) { - publishFailure.addSuppressed(rollbackFailure); - } - if (publishFailure instanceof IOException ioFailure) { - throw ioFailure; - } - throw publishFailure; - } - return new InstallExecution( - new InstallResult(changed), - coordinator, - stagedDir, - entry, - stagedHash, - verifiedStagingInstall == null, - publishPlans, - unchangedPlans); - } - - static void verifyInstallExecution(InstallExecution execution) throws IOException { - if (execution.verified()) { - return; - } - if (execution.verifyStagedSource()) { - validateManagedDirectory(execution.stagedDir(), execution.entry().id); - Ownership stagedOwnership = readOwnership(execution.stagedDir()); - String stagedHash = directoryHash(execution.stagedDir()); - if (!Objects.equals(stagedHash, execution.stagedHash()) - || !ownershipMetadataMatches(stagedOwnership, execution.entry(), stagedHash)) { - throw new IOException("Iris datapack staging changed before installation commit for " - + execution.entry().id); - } - } - for (InstallPlan plan : execution.publishedPlans()) { - verifyDesiredInstallSnapshot(plan.target(), plan, "published datapack target"); - } - for (InstallPlan plan : execution.unchangedPlans()) { - verifyOriginalInstallSnapshot(plan.target(), plan, "unchanged datapack target"); - } - execution.markVerified(); - } - - static void finishInstallExecution(InstallExecution execution) throws IOException { - if (!execution.verified()) { - throw new IOException("Datapack install cannot commit before final verification"); - } - if (execution.coordinator() == null) { - return; - } - execution.coordinator().phase(CoordinatorPhase.COMMITTED); - resolveCoordinatorDirectories(execution.coordinator().journal, true); - execution.coordinator().finish(); - } - - static void rollbackInstallExecutions(List executions, Throwable failure) { - List reversed = new ArrayList<>(executions); - Collections.reverse(reversed); - for (InstallExecution execution : reversed) { - if (execution.coordinator() == null) { - continue; - } - try { - resolveCoordinatorDirectories(execution.coordinator().journal, false); - execution.coordinator().finish(); - } catch (IOException rollbackFailure) { - failure.addSuppressed(rollbackFailure); - } - } - } - - private static File inferDatapackRoot(File stagedDir) { - File parent = stagedDir.getParentFile(); - if (parent != null && "staging".equals(parent.getName()) && parent.getParentFile() != null) { - return parent.getParentFile(); - } - return parent == null ? stagedDir : parent; - } - - private static boolean manifestEntryMatches(Entry committed, Entry desired) { - return committed != null - && Objects.equals(committed.id, desired.id) - && Objects.equals(committed.url, desired.url) - && Objects.equals(committed.versionId, desired.versionId) - && Objects.equals(committed.versionNumber, desired.versionNumber) - && Objects.equals(committed.sha1, desired.sha1); - } - - static String directoryIdentity(File directory) throws IOException { - BasicFileAttributes attributes = Files.readAttributes( - directory.toPath(), BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); - if (!attributes.isDirectory() || attributes.isSymbolicLink()) { - throw new IOException("Invalid datapack directory identity at " + directory.getPath()); - } - Object fileKey = attributes.fileKey(); - if (fileKey != null) { - return "key:" + fileKey; - } - // Windows exposes no inode-equivalent for a directory, and returning nothing here fails - // the identity gate closed, which disables legacy staging replacement on that platform - // outright. Creation time is the one stable discriminator the filesystem still offers: a - // directory swapped in at the same path brings its own, so a swap is still caught. It is - // a weaker guarantee than an inode, so it is only ever the fallback. - return "created:" + attributes.creationTime(); - } - - private static boolean pathExists(Path path, String purpose) throws IOException { - if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - return true; - } - if (Files.notExists(path, LinkOption.NOFOLLOW_LINKS)) { - return false; - } - throw new IOException("Cannot determine " + purpose + " state at " + path); - } - - private static void validateInstallTree(File directory, File storeAnchor, String purpose) throws IOException { - validateScratchTree(directory.toPath()); - if (!sameScratchVolume(directory.toPath(), storeAnchor.toPath())) { - throw new IOException(purpose + " crosses a filesystem boundary at " + directory.getPath()); - } - } - - static InstallPlan prepareInstall( - File stagedDir, - File worldFolder, - Entry entry, - String stagedHash, - boolean stripOverrides, - VerifiedStagingInstall verifiedStagingInstall - ) throws IOException { - ensureInstallTargetRoot(worldFolder); - File target = new File(worldFolder, entry.id); - InstallPlan unchanged = tryPrepareUnchangedManagedInstall( - stagedDir, - worldFolder, - target, - entry, - stagedHash, - stripOverrides, - verifiedStagingInstall); - if (unchanged != null) { - return unchanged; - } - boolean canonicalStagingInstall = verifiedStagingInstall != null - && verifiedStagingInstall.isCanonicalInstall(worldFolder, target); - boolean legacyReplacementAuthorized = canonicalStagingInstall - && verifiedStagingInstall.consume(stagedDir, worldFolder, target, entry, stagedHash); - VerifiedStagingInstall legacyWorldAuthorization = null; - File pendingRoot = installScratchRoot(worldFolder); - File pending = new File(pendingRoot, entry.id + "-" + UUID.randomUUID()); - File backup = new File(pendingRoot, entry.id + "-backup-" + UUID.randomUUID()); - try { - ensureScratchDirectory(pendingRoot, "datapack install staging"); - String targetRootIdentity = realDirectoryPath(worldFolder, "datapack target root"); - String scratchRootIdentity = realDirectoryPath(pendingRoot, "datapack install scratch root"); - String targetRootFileIdentity = directoryIdentity(worldFolder); - String scratchRootFileIdentity = directoryIdentity(pendingRoot); - IO.copyDirectory(stagedDir.toPath(), pending.toPath()); - Files.deleteIfExists(new File(pending, OWNERSHIP_MARKER).toPath()); - String copiedHash = directoryHash(pending); - if (!Objects.equals(stagedHash, copiedHash)) { - throw new IOException("Datapack staging changed or copied incompletely while preparing " + entry.id); - } - boolean removedOverrideMarker = Files.deleteIfExists( - new File(pending, OVERRIDES_STRIPPED_MARKER).toPath()); - if (stripOverrides) { - stripVanillaStructureOverrides(pending); - writeMarker(new File(pending, OVERRIDES_STRIPPED_MARKER)); - } - validatePackMetadata(pending); - if (!stripOverrides && !removedOverrideMarker) { - writeOwnership(pending, entry, copiedHash); - } else { - writeOwnership(pending, entry); - } - validateInstallTree(pending, worldFolder, "Prepared datapack install"); - Ownership desiredOwnership = readOwnership(pending); - String desiredHash = desiredOwnership.contentHash; - String desiredMarkerHash = ownershipMarkerFingerprint(pending); - String desiredIdentity = directoryIdentity(pending); - boolean hadTarget = pathExists(target.toPath(), "datapack install target"); - String originalHash = ""; - String originalMarkerHash = "absent"; - String originalIdentity = ""; - boolean contentChanged = !hadTarget; - boolean publishRequired = !hadTarget; - if (hadTarget) { - if (Files.isSymbolicLink(target.toPath()) - || !Files.isDirectory(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing to replace non-directory or symbolic-link datapack " + target.getPath()); - } - validateInstallTree(target, worldFolder, "Existing datapack install"); - Ownership ownership = readOwnershipOrNull(target); - if (ownership != null) { - removeFinderMetadata(target); - } - String currentHash = directoryHash(target); - originalHash = currentHash; - originalMarkerHash = ownershipMarkerFingerprint(target); - originalIdentity = directoryIdentity(target); - if (ownership == null) { - boolean differingLegacyTarget = !Objects.equals(currentHash, desiredHash); - if (differingLegacyTarget && !legacyReplacementAuthorized - && verifiedStagingInstall != null - && verifiedStagingInstall.authorizeLegacyWorldReplacement( - stagedDir, - worldFolder, - target, - entry, - stagedHash, - currentHash, - originalMarkerHash)) { - legacyReplacementAuthorized = true; - legacyWorldAuthorization = verifiedStagingInstall; - } - if (differingLegacyTarget && !legacyReplacementAuthorized) { - throw new IOException("Refusing to replace unmanaged datapack at " + target.getPath()); - } - if (differingLegacyTarget && (originalIdentity.isEmpty() - || targetRootFileIdentity.isEmpty() - || scratchRootFileIdentity.isEmpty() - || verifiedStagingInstall == null - || !verifiedStagingInstall.hasStablePathIdentities())) { - throw new IOException("Cannot safely identify legacy datapack staging at " + target.getPath()); - } - publishRequired = true; - } else { - if (!entry.id.equals(ownership.id)) { - throw new IOException("Datapack ownership mismatch at " + target.getPath()); - } - publishRequired = !Objects.equals(ownership.contentHash, currentHash) - || !ownershipMetadataMatches(ownership, entry, desiredHash); - } - contentChanged = !Objects.equals(currentHash, desiredHash); - publishRequired |= contentChanged; - if (ownership != null && !Objects.equals(ownership.contentHash, currentHash)) { - IrisLogging.warn("Repairing modified or corrupt Iris-managed datapack at " + target.getPath()); - } - } - return new InstallPlan( - target, - pending, - backup, - pendingRoot, - hadTarget, - publishRequired, - contentChanged, - originalHash, - desiredHash, - originalMarkerHash, - desiredMarkerHash, - originalIdentity, - desiredIdentity, - targetRootIdentity, - scratchRootIdentity, - targetRootFileIdentity, - scratchRootFileIdentity, - entry.id, - entry.url, - legacyWorldAuthorization - ); - } catch (UncheckedIOException e) { - IOException cause = e.getCause(); - cleanupPreparedInstall(pending, pendingRoot, cause); - throw cause; - } catch (IOException e) { - cleanupPreparedInstall(pending, pendingRoot, e); - throw e; - } catch (RuntimeException e) { - cleanupPreparedInstall(pending, pendingRoot, e); - throw e; - } - } - - private static InstallPlan tryPrepareUnchangedManagedInstall( - File stagedDir, - File worldFolder, - File target, - Entry entry, - String stagedHash, - boolean stripOverrides, - VerifiedStagingInstall verifiedStagingInstall - ) throws IOException { - if (verifiedStagingInstall != null - || stripOverrides - || pathExists(new File(stagedDir, OVERRIDES_STRIPPED_MARKER).toPath(), - "staged datapack override marker") - || !pathExists(target.toPath(), "datapack install target")) { - return null; - } - if (Files.isSymbolicLink(target.toPath()) - || !Files.isDirectory(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing to replace non-directory or symbolic-link datapack " + target.getPath()); - } - Ownership ownership = readOwnershipOrNull(target); - if (ownership == null) { - return null; - } - if (!entry.id.equals(ownership.id)) { - throw new IOException("Datapack ownership mismatch at " + target.getPath()); - } - if (!ownershipMetadataMatches(ownership, entry, stagedHash)) { - return null; - } - validateInstallTree(target, worldFolder, "Existing datapack install"); - removeFinderMetadata(target); - String currentHash = directoryHash(target); - if (!Objects.equals(currentHash, stagedHash)) { - return null; - } - String markerHash = ownershipMarkerFingerprint(target); - String identity = directoryIdentity(target); - File pendingRoot = installScratchRoot(worldFolder); - return new InstallPlan( - target, - new File(pendingRoot, entry.id + "-" + UUID.randomUUID()), - new File(pendingRoot, entry.id + "-backup-" + UUID.randomUUID()), - pendingRoot, - true, - false, - false, - currentHash, - currentHash, - markerHash, - markerHash, - identity, - identity, - realDirectoryPath(worldFolder, "datapack target root"), - "", - directoryIdentity(worldFolder), - "", - entry.id, - entry.url, - null - ); - } - - private static File installScratchRoot(File targetFolder) { - File parent = targetFolder.getParentFile(); - return new File(parent == null ? targetFolder : parent, ".iris-datapack-install"); - } - - private static void cleanupPreparedInstall(File pending, File pendingRoot, Throwable failure) { - try { - deleteInstallScratch(pending, "prepared datapack install"); - } catch (IOException cleanupFailure) { - failure.addSuppressed(cleanupFailure); - } - pendingRoot.delete(); - } - - private static boolean ownershipMetadataMatches(Ownership ownership, Entry entry, String contentHash) { - return ownership.schemaVersion == OWNERSHIP_SCHEMA - && Objects.equals(ownership.id, entry.id) - && Objects.equals(ownership.url, entry.url) - && Objects.equals(ownership.versionId, entry.versionId) - && Objects.equals(ownership.versionNumber, entry.versionNumber) - && Objects.equals(ownership.sha1, entry.sha1) - && Objects.equals(ownership.contentHash, contentHash) - && copyList(ownership.structureKeys).equals(copyList(entry.structureKeys)) - && copyList(ownership.templateKeys).equals(copyList(entry.templateKeys)); - } - - private static boolean ownershipSourceMatches(Ownership ownership, Entry entry) { - return ownership.schemaVersion == OWNERSHIP_SCHEMA - && Objects.equals(ownership.id, entry.id) - && Objects.equals(ownership.url, entry.url); - } - - static void publishInstallPlan(InstallPlan plan) throws IOException { - verifyDirectoryContainerIdentity( - plan.target().getParentFile(), plan.targetRootIdentity(), - plan.targetRootFileIdentity(), "datapack target root"); - verifyDirectoryContainerIdentity( - plan.pendingRoot(), plan.scratchRootIdentity(), - plan.scratchRootFileIdentity(), "datapack install scratch root"); - verifyDesiredInstallSnapshot(plan.pending(), plan, "prepared datapack install"); - if (plan.hadTarget()) { - verifyOriginalInstallSnapshot(plan.target(), plan, "original datapack target"); - } else if (pathExists(plan.target().toPath(), "new datapack target")) { - throw new IOException("Datapack install target was concurrently created at " + plan.target().getPath()); - } - if (plan.legacyWorldAuthorization() != null) { - plan.legacyWorldAuthorization().verifyLegacyWorldSnapshot(); - } - try { - if (plan.hadTarget()) { - moveNew(plan.target().toPath(), plan.backup().toPath()); - verifyOriginalInstallSnapshot(plan.backup(), plan, "datapack install backup"); - if (pathExists(plan.target().toPath(), "moved datapack target")) { - throw new IOException("Datapack install target reappeared after backup at " + plan.target().getPath()); - } - forceInstallMoveDirectories(plan); - } - moveNew(plan.pending().toPath(), plan.target().toPath()); - verifyDesiredInstallSnapshot(plan.target(), plan, "installed datapack target"); - forceInstallMoveDirectories(plan); - } catch (IOException publishFailure) { - if (plan.hadTarget() - && Files.exists(plan.backup().toPath(), LinkOption.NOFOLLOW_LINKS) - && Files.exists(plan.pending().toPath(), LinkOption.NOFOLLOW_LINKS) - && Files.notExists(plan.target().toPath(), LinkOption.NOFOLLOW_LINKS)) { - try { - verifyOriginalInstallSnapshot(plan.backup(), plan, "datapack install backup"); - moveNew(plan.backup().toPath(), plan.target().toPath()); - forceInstallMoveDirectories(plan); - } catch (IOException restoreFailure) { - publishFailure.addSuppressed(restoreFailure); - } - } - throw publishFailure; - } - } - - private static void forceInstallMoveDirectories(InstallPlan plan) throws IOException { - forceDirectoryIfSupported(plan.target().getParentFile().toPath()); - forceDirectoryIfSupported(plan.pendingRoot().toPath()); - } - - private static void verifyDirectoryContainerIdentity( - File directory, - String expectedRealPath, - String expectedFileIdentity, - String purpose - ) throws IOException { - Path normalized = directory.toPath().toAbsolutePath().normalize(); - if (Files.isSymbolicLink(normalized) - || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) - || !Objects.equals(normalized.toRealPath(), Path.of(expectedRealPath)) - || (!expectedFileIdentity.isEmpty() - && !Objects.equals(directoryIdentity(directory), expectedFileIdentity))) { - throw new IOException("Changed or unsafe " + purpose + " " + normalized); - } - } - - private static void verifyOriginalInstallSnapshot( - File directory, - InstallPlan plan, - String purpose - ) throws IOException { - verifyDirectorySnapshot( - directory, - plan.target().getParentFile(), - plan.originalHash(), - plan.originalMarkerHash(), - plan.originalIdentity(), - purpose - ); - } - - private static void verifyDesiredInstallSnapshot( - File directory, - InstallPlan plan, - String purpose - ) throws IOException { - verifyDirectorySnapshot( - directory, - plan.target().getParentFile(), - plan.desiredHash(), - plan.desiredMarkerHash(), - plan.desiredIdentity(), - purpose - ); - Ownership ownership = readOwnership(directory); - if (!Objects.equals(ownership.id, plan.id()) - || !Objects.equals(ownership.url, plan.url()) - || !Objects.equals(ownership.contentHash, plan.desiredHash())) { - throw new IOException("Datapack ownership changed in " + purpose + " at " + directory.getPath()); - } - } - - private static void verifyDirectorySnapshot( - File directory, - File storeAnchor, - String expectedHash, - String expectedMarkerHash, - String expectedIdentity, - String purpose - ) throws IOException { - if (!pathExists(directory.toPath(), purpose) - || Files.isSymbolicLink(directory.toPath()) - || !Files.isDirectory(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Missing or unsafe " + purpose + " at " + directory.getPath()); - } - validateInstallTree(directory, storeAnchor, purpose); - if (Files.exists(new File(directory, OWNERSHIP_MARKER).toPath(), LinkOption.NOFOLLOW_LINKS)) { - removeFinderMetadata(directory); - } - if (!expectedIdentity.isEmpty() - && !Objects.equals(directoryIdentity(directory), expectedIdentity)) { - throw new IOException("Datapack directory identity changed in " + purpose + " at " + directory.getPath()); - } - if (!Objects.equals(expectedHash, directoryHash(directory)) - || !Objects.equals(expectedMarkerHash, ownershipMarkerFingerprint(directory))) { - throw new IOException("Datapack content changed in " + purpose + " at " + directory.getPath()); - } - } - - private static void cleanupInstallPlan(InstallPlan plan, boolean committed) throws IOException { - deleteInstallScratch(plan.pending, "datapack install pending directory"); - if (committed) { - deleteInstallScratch(plan.backup, "datapack install backup"); - } - if (Files.exists(plan.backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Preserving prior datapack backup after incomplete install: " - + plan.backup.getPath()); - } - plan.pendingRoot.delete(); - } - - static void deleteInstallScratch(File scratch, String purpose) throws IOException { - Path scratchPath = scratch.toPath(); - File parent = Objects.requireNonNull(scratch.getParentFile(), "datapack scratch parent"); - for (int attempt = 0; attempt < MAX_SCRATCH_DELETE_ATTEMPTS; attempt++) { - if (Files.notExists(scratchPath, LinkOption.NOFOLLOW_LINKS)) { - return; - } - if (!Files.exists(scratchPath, LinkOption.NOFOLLOW_LINKS) - || Files.isSymbolicLink(scratchPath) - || !Files.isDirectory(scratchPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing to remove unsafe " + purpose + " " + scratch.getPath()); - } - validateInstallTree(scratch, parent, purpose); - removeFinderMetadata(scratch); - IO.delete(scratch); - if (Files.notExists(scratchPath, LinkOption.NOFOLLOW_LINKS)) { - return; - } - } - throw new IOException("Could not remove " + purpose + " " + scratch.getPath()); - } - - private static boolean resolveStripOverrides() { - try (Stream stream = ServerConfigurator.allPacks()) { - return stream.anyMatch(DatapackIngestService::packDisablesOverrides); - } - } - - private static boolean packDisablesOverrides(IrisData data) { - if (data == null || data.getDimensionLoader() == null) { - return false; - } - for (IrisDimension dimension : data.getDimensionLoader().loadAll(data.getDimensionLoader().getPossibleKeys())) { - if (dimension == null) { - continue; - } - IrisImportedStructureControl control = dimension.getImportedStructures(); - if (control != null && !control.isDatapackOverrides()) { - return true; - } - } - return false; - } - - private static void stripVanillaStructureOverrides(File datapackRoot) throws IOException { - stripVanillaStructureOverrides(datapackRoot, IO::delete); - } - - static void stripVanillaStructureOverrides( - File datapackRoot, - DirectoryDeleter deleter - ) throws IOException { - File minecraftData = new File(new File(datapackRoot, "data"), "minecraft"); - if (!minecraftData.isDirectory()) { - return; - } - String[] relativeTrees = { - "worldgen" + File.separator + "structure_set", - "worldgen" + File.separator + "structure", - "worldgen" + File.separator + "template_pool", - "structure" - }; - for (String tree : relativeTrees) { - File dir = new File(minecraftData, tree); - if (dir.exists()) { - deleter.delete(dir); - if (Files.exists(dir.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Could not remove vanilla structure override tree " + dir.getPath()); - } - } - } - } - - private static void writeMarker(File marker) throws IOException { - Files.writeString(marker.toPath(), "stripped", StandardCharsets.UTF_8); - } - - static void validatePackMetadata(File datapackRoot) throws IOException { - File metadata = new File(datapackRoot, "pack.mcmeta"); - if (!metadata.isFile() || Files.isSymbolicLink(metadata.toPath())) { - throw new IOException("Datapack is missing a regular pack.mcmeta"); - } - if (metadata.length() > MAX_METADATA_BYTES) { - throw new IOException("Datapack pack.mcmeta exceeds 1 MiB"); - } - JsonElement parsed; - try { - parsed = JsonParser.parseString(readBoundedUtf8( - metadata.toPath(), MAX_METADATA_BYTES, "Datapack pack.mcmeta")); - } catch (RuntimeException e) { - throw new IOException("Datapack pack.mcmeta is not valid JSON", e); - } - if (!parsed.isJsonObject()) { - throw new IOException("Datapack pack.mcmeta root must be an object"); - } - JsonObject root = parsed.getAsJsonObject(); - if (!root.has("pack") || !root.get("pack").isJsonObject()) { - throw new IOException("Datapack pack.mcmeta must contain a pack object"); - } - JsonObject pack = root.getAsJsonObject("pack"); - boolean hasPackFormat = pack.has("pack_format") && pack.get("pack_format").isJsonPrimitive() - && pack.getAsJsonPrimitive("pack_format").isNumber(); - boolean hasRange = validFormatValue(pack.get("min_format")) && validFormatValue(pack.get("max_format")); - if (!hasPackFormat && !hasRange) { - throw new IOException("Datapack pack.mcmeta must declare numeric pack_format or valid min_format/max_format"); - } - if (!pack.has("description") || pack.get("description").isJsonNull()) { - throw new IOException("Datapack pack.mcmeta must declare a description"); - } - File data = new File(datapackRoot, "data"); - if (data.exists() && (!data.isDirectory() || Files.isSymbolicLink(data.toPath()))) { - throw new IOException("Datapack data path is not a regular directory"); - } - } - - private static boolean validFormatValue(JsonElement value) { - if (value == null || value.isJsonNull()) { - return false; - } - if (value.isJsonPrimitive() && value.getAsJsonPrimitive().isNumber()) { - return true; - } - if (!value.isJsonArray() || value.getAsJsonArray().size() != 2) { - return false; - } - for (JsonElement component : value.getAsJsonArray()) { - if (!component.isJsonPrimitive() || !component.getAsJsonPrimitive().isNumber()) { - return false; - } - } - return true; - } - - static void writeOwnership(File directory, Entry entry) throws IOException { - writeOwnership(directory, entry, directoryHash(directory)); - } - - private static void writeOwnership(File directory, Entry entry, String contentHash) throws IOException { - if (!isValidManagedId(entry.id) || entry.url == null || entry.url.isBlank()) { - throw new IOException("Invalid Iris datapack ownership identity for " + directory.getPath()); - } - if (contentHash == null || contentHash.isBlank()) { - throw new IOException("Missing Iris datapack ownership content hash for " + directory.getPath()); - } - Ownership ownership = new Ownership( - OWNERSHIP_SCHEMA, - entry.id, - entry.url, - entry.versionId, - entry.versionNumber, - entry.sha1, - contentHash, - copyList(entry.structureKeys), - copyList(entry.templateKeys) - ); - Path marker = new File(directory, OWNERSHIP_MARKER).toPath(); - Path temporary = Files.createTempFile(directory.toPath(), OWNERSHIP_MARKER, ".tmp"); - try { - Files.writeString( - temporary, - GSON.toJson(ownership), - StandardCharsets.UTF_8, - StandardOpenOption.TRUNCATE_EXISTING - ); - move(temporary, marker); - } finally { - Files.deleteIfExists(temporary); - } - } - - private static Ownership readOwnership(File directory) throws IOException { - Ownership ownership = readOwnershipOrNull(directory); - if (ownership == null) { - throw new IOException("Missing Iris datapack ownership marker in " + directory.getPath()); - } - return ownership; - } - - private static Ownership readOwnershipOrNull(File directory) throws IOException { - File marker = new File(directory, OWNERSHIP_MARKER); - Path markerPath = marker.toPath(); - if (Files.notExists(markerPath, LinkOption.NOFOLLOW_LINKS)) { - return null; - } - if (!Files.exists(markerPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Cannot determine Iris datapack ownership marker state in " + directory.getPath()); - } - if (Files.isSymbolicLink(markerPath) - || !Files.isRegularFile(markerPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); - } - if (marker.length() > MAX_OWNERSHIP_BYTES) { - throw new IOException("Oversized Iris datapack ownership marker in " + directory.getPath()); - } - try { - Ownership ownership = GSON.fromJson(readBoundedUtf8( - marker.toPath(), MAX_OWNERSHIP_BYTES, "Iris datapack ownership marker"), Ownership.class); - if (ownership == null || ownership.schemaVersion != OWNERSHIP_SCHEMA - || !isValidManagedId(ownership.id) || ownership.url == null || ownership.url.isBlank() - || ownership.contentHash == null || ownership.contentHash.isBlank()) { - throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); - } - return ownership; - } catch (RuntimeException e) { - throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath(), e); - } - } - - static String ownershipMarkerFingerprint(File directory) throws IOException { - Path marker = new File(directory, OWNERSHIP_MARKER).toPath(); - if (Files.notExists(marker, LinkOption.NOFOLLOW_LINKS)) { - return "absent"; - } - if (!Files.exists(marker, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Cannot determine Iris datapack ownership marker state in " + directory.getPath()); - } - if (Files.isSymbolicLink(marker) - || !Files.isRegularFile(marker, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); - } - try { - MessageDigest digest = MessageDigest.getInstance("SHA-256"); - return "sha256:" + hex(digest.digest(readBoundedBytes( - marker, MAX_OWNERSHIP_BYTES, "Iris datapack ownership marker"))); - } catch (NoSuchAlgorithmException e) { - throw new IOException("SHA-256 algorithm unavailable", e); - } - } - - static boolean isUsableStaging(File stagedDir, Entry entry) { - return inspectUsableStaging(stagedDir, entry).usable(); - } - - private static StagingInspection inspectUsableStaging(File stagedDir, Entry entry) { - try { - validateManagedDirectory(stagedDir, entry.id); - Ownership ownership = readOwnership(stagedDir); - String contentHash = directoryHash(stagedDir); - if (!ownershipSourceMatches(ownership, entry) - || !Objects.equals(ownership.versionId, entry.versionId) - || !Objects.equals(ownership.versionNumber, entry.versionNumber) - || !Objects.equals(ownership.sha1, entry.sha1) - || !Objects.equals(ownership.contentHash, contentHash)) { - return new StagingInspection(false, false, false); - } - PackResources resources = scanPackResources(stagedDir); - List previousStructureKeys = copyList(entry.structureKeys); - List previousTemplateKeys = copyList(entry.templateKeys); - boolean ownershipCorrected = false; - if (!copyList(resources.structureKeys).equals(copyList(ownership.structureKeys)) - || !copyList(resources.templateKeys).equals(copyList(ownership.templateKeys))) { - Entry corrected = copyEntry(entry); - corrected.structureKeys = resources.structureKeys; - corrected.templateKeys = resources.templateKeys; - writeOwnership(stagedDir, corrected); - ownershipCorrected = true; - } - entry.structureKeys = resources.structureKeys; - entry.templateKeys = resources.templateKeys; - boolean manifestChanged = !previousStructureKeys.equals(copyList(entry.structureKeys)) - || !previousTemplateKeys.equals(copyList(entry.templateKeys)); - return new StagingInspection(true, ownershipCorrected, manifestChanged); - } catch (IOException e) { - IrisLogging.warn("Ignoring unusable Iris datapack staging at " + stagedDir.getPath() + ": " + e.getMessage()); - return new StagingInspection(false, false, false); - } - } - - private static void validateManagedDirectory(File directory, String id) throws IOException { - Path path = directory.toPath(); - if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Missing datapack directory " + directory.getPath()); - } - if (Files.isSymbolicLink(path)) { - throw new IOException("Refusing symbolic-link datapack directory " + directory.getPath()); - } - validatePackMetadata(directory); - rejectSymbolicLinks(directory); - Ownership ownership = readOwnershipOrNull(directory); - if (ownership == null) { - throw new IOException("Datapack is not Iris-managed: " + directory.getPath()); - } - if (!id.equals(ownership.id)) { - throw new IOException("Datapack ownership mismatch at " + directory.getPath()); - } - removeFinderMetadata(directory); - } - - private static void rejectSymbolicLinks(File root) throws IOException { - try (Stream paths = Files.walk(root.toPath())) { - Path symbolicLink = paths.filter(Files::isSymbolicLink).findFirst().orElse(null); - if (symbolicLink != null) { - throw new IOException("Datapack contains a symbolic link: " + symbolicLink); - } - } - } - - private static boolean sameDatapackVolume( - Path root, - FileStore rootStore, - Path entry - ) throws IOException { - return sameScratchVolume(root, rootStore, entry, Files.getFileStore(entry)); - } - - private static String directoryHash(File root) throws IOException { - try { - MessageDigest digest = MessageDigest.getInstance("SHA-256"); - Path rootPath = root.toPath().toAbsolutePath().normalize(); - Path rootMarker = rootPath.resolve(OWNERSHIP_MARKER); - FileStore rootStore = Files.getFileStore(rootPath); - List entries = new ArrayList<>(); - try (Stream paths = Files.walk(rootPath)) { - Iterator iterator = paths.iterator(); - int pathCount = 0; - while (iterator.hasNext()) { - Path path = iterator.next(); - if (path.equals(rootPath) || path.equals(rootMarker)) { - continue; - } - if (isFinderMetadata(path)) { - if (Files.isSymbolicLink(path) - || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Suspicious Finder metadata in datapack: " + path); - } - continue; - } - pathCount++; - if (pathCount > MAX_MANAGED_PATHS) { - throw new IOException("Datapack contains more than " + MAX_MANAGED_PATHS + " paths"); - } - if (Files.isSymbolicLink(path)) { - throw new IOException("Datapack contains a symbolic link: " + path); - } - if (!Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS) - && !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Datapack contains an unsupported filesystem entry: " + path); - } - entries.add(path); - } - } - entries.sort(Comparator.comparing(path -> rootPath.relativize(path).toString())); - byte[] buffer = new byte[HASH_BUFFER_BYTES]; - long totalBytes = 0; - for (Path entry : entries) { - String relative = rootPath.relativize(entry).toString().replace(File.separatorChar, '/'); - byte[] relativeBytes = relative.getBytes(StandardCharsets.UTF_8); - BasicFileAttributes attributes = Files.readAttributes( - entry, - BasicFileAttributes.class, - LinkOption.NOFOLLOW_LINKS - ); - if (attributes.isSymbolicLink() - || attributes.isOther() - || !attributes.isDirectory() && !attributes.isRegularFile()) { - throw new IOException("Datapack entry changed while hashing: " + relative); - } - if (!sameScratchVolume(rootPath, rootStore, entry, Files.getFileStore(entry))) { - throw new IOException("Datapack entry crosses a filesystem boundary: " + entry); - } - boolean directory = attributes.isDirectory(); - digest.update((byte) (directory ? 1 : 2)); - updateDigestInt(digest, relativeBytes.length); - digest.update(relativeBytes); - if (!directory) { - long expectedBytes = attributes.size(); - if (expectedBytes > MAX_ENTRY_BYTES) { - throw new IOException("Datapack file exceeds " + MAX_ENTRY_BYTES + " bytes: " + relative); - } - totalBytes += expectedBytes; - if (totalBytes > MAX_EXPANDED_BYTES) { - throw new IOException("Datapack contents exceed " + MAX_EXPANDED_BYTES + " bytes"); - } - updateDigestLong(digest, expectedBytes); - long entryBytes = 0; - try (InputStream input = Files.newInputStream( - entry, - StandardOpenOption.READ, - LinkOption.NOFOLLOW_LINKS - )) { - int length; - while ((length = input.read(buffer)) > 0) { - entryBytes += length; - if (entryBytes > expectedBytes) { - throw new IOException("Datapack file changed while hashing: " + relative); - } - digest.update(buffer, 0, length); - } - } - if (entryBytes != expectedBytes) { - throw new IOException("Datapack file changed while hashing: " + relative); - } - } - } - return hex(digest.digest()); - } catch (NoSuchAlgorithmException e) { - throw new IOException("SHA-256 algorithm unavailable", e); - } - } - - private static void removeFinderMetadata(File root) throws IOException { - List entries; - try (Stream paths = Files.walk(root.toPath())) { - entries = paths.limit(MAX_MANAGED_PATHS + 1L).toList(); - } - if (entries.size() > MAX_MANAGED_PATHS) { - throw new IOException("Datapack contains more than " + MAX_MANAGED_PATHS + " paths"); - } - for (Path path : entries) { - if (!isFinderMetadata(path)) { - continue; - } - if (Files.isSymbolicLink(path) - || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Suspicious Finder metadata in datapack: " + path); - } - Files.delete(path); - } - } - - private static boolean isFinderMetadata(Path path) { - Path fileName = path.getFileName(); - return fileName != null && FINDER_METADATA.equals(fileName.toString()); - } - - private static PackResources scanPackResources(File root) throws IOException { - TreeSet structureKeys = new TreeSet<>(); - TreeSet structureSetKeys = new TreeSet<>(); - TreeSet templateKeys = new TreeSet<>(); - Path dataRoot = new File(root, "data").toPath(); - if (!Files.isDirectory(dataRoot, LinkOption.NOFOLLOW_LINKS)) { - return new PackResources(new ArrayList<>(), new ArrayList<>(), new ArrayList<>()); - } - try (Stream paths = Files.walk(dataRoot)) { - for (Path path : paths.filter(file -> Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS)).toList()) { - Path relative = dataRoot.relativize(path); - if (relative.getNameCount() < 3) { - continue; - } - String namespace = relative.getName(0).toString().toLowerCase(Locale.ROOT); - String normalized = relative.subpath(1, relative.getNameCount()).toString().replace(File.separatorChar, '/'); - addResourceKey(structureKeys, namespace, normalized, "worldgen/structure/", ".json"); - addResourceKey(structureKeys, namespace, normalized, "worldgen/structures/", ".json"); - addResourceKey(structureSetKeys, namespace, normalized, "worldgen/structure_set/", ".json"); - addResourceKey(structureSetKeys, namespace, normalized, "worldgen/structure_sets/", ".json"); - addResourceKey(templateKeys, namespace, normalized, "structure/", ".nbt"); - addResourceKey(templateKeys, namespace, normalized, "structures/", ".nbt"); - } - } - return new PackResources( - new ArrayList<>(structureKeys), - new ArrayList<>(structureSetKeys), - new ArrayList<>(templateKeys)); - } - - private static void addResourceKey(Set keys, String namespace, String path, String prefix, String suffix) { - if (!path.startsWith(prefix) || !path.endsWith(suffix)) { - return; - } - String resourcePath = path.substring(prefix.length(), path.length() - suffix.length()); - if (!resourcePath.isBlank()) { - keys.add(namespace + ":" + resourcePath); - } - } - - static boolean deleteOwnedDirectory(File directory, String id) throws IOException { - Path path = directory.toPath(); - if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - return false; - } - if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing non-directory or symbolic-link target " + directory.getPath()); - } - Ownership ownership = readOwnership(directory); - if (!id.equals(ownership.id)) { - throw new IOException("Ownership marker belongs to '" + ownership.id + "'"); - } - removeFinderMetadata(directory); - if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { - throw new IOException("Refusing to delete modified or corrupt Iris-managed datapack " + directory.getPath()); - } - File parent = Objects.requireNonNull(directory.getParentFile(), "managed datapack parent"); - validateInstallTree(directory, parent, "Managed datapack deletion"); - IO.delete(directory); - if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Could not delete " + directory.getPath()); - } - return true; - } - - private static boolean autoImportDatapackStructures() { - TRANSACTION_LOCK.lock(); - try { - return autoImportDatapackStructuresLocked(); - } finally { - TRANSACTION_LOCK.unlock(); - } - } - - private static boolean autoImportDatapackStructuresLocked() { - boolean autoImportEnabled = IrisSettings.get().getGeneral().autoImportDatapackStructures; - File root = IrisPlatforms.get().dataFolder("datapacks"); - boolean recovered; - try { - recovered = recoverTransactions(root, ServerConfigurator.getDatapacksFolder()); - } catch (IOException e) { - IrisLogging.reportError("Automatic datapack structure import blocked by incomplete transaction recovery.", e); - return false; - } - Manifest manifest = readManifest(root); - if (manifest.entries.isEmpty()) { - return recovered; - } - Map manifestEntriesByUrl = new HashMap<>(); - for (Entry entry : manifest.entries) { - if (entry.url != null) { - manifestEntriesByUrl.put(entry.url, entry); - } - } - - List packs; - try (Stream stream = ServerConfigurator.allPacks()) { - packs = stream.filter(Objects::nonNull).toList(); - } - if (!autoImportEnabled && !hasRemovedImportState(packs, manifest.entries)) { - return recovered; - } - - Map entriesByUrl = new HashMap<>(); - File stagingRoot = new File(root, "staging"); - boolean stagingStateChanged = false; - boolean manifestStagingMetadataChanged = false; - for (Entry entry : manifest.entries) { - if (entry.url == null) { - continue; - } - StagingInspection inspection = inspectUsableStaging(new File(stagingRoot, entry.id), entry); - stagingStateChanged |= inspection.ownershipCorrected(); - manifestStagingMetadataChanged |= inspection.manifestChanged(); - if (inspection.usable()) { - entriesByUrl.put(entry.url, entry); - } - } - - int attemptedPacks = 0; - int completedPacks = 0; - int cleanupTargets = 0; - Set completedUrls = new HashSet<>(); - Set failedUrls = new HashSet<>(); - for (IrisData data : packs) { - Set configured = configuredImports(data); - String targetId = data.getDataFolder().toPath().toAbsolutePath().normalize().toString(); - for (Entry entry : manifest.entries) { - if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { - cleanupTargets++; - } - } - if (!cleanupRemovedImports(data, targetId, configured, manifest.entries, manifestEntriesByUrl)) { - for (Entry entry : manifest.entries) { - if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { - failedUrls.add(entry.url); - } - } - } - if (!autoImportEnabled) { - continue; - } - - Set pendingUrls = new HashSet<>(); - for (String url : configured) { - Entry entry = entriesByUrl.get(url); - if (entry != null && importPending(entry, targetId)) { - pendingUrls.add(url); - } - } - if (pendingUrls.isEmpty()) { - continue; - } - for (String pendingUrl : pendingUrls) { - Entry entry = entriesByUrl.get(pendingUrl); - prepareImportRecoveryInventory(entry, targetId); - } - try { - writeManifestChecked(root, manifest); - } catch (IOException e) { - failedUrls.addAll(pendingUrls); - IrisLogging.reportError("Datapack structure import for pack '" - + data.getDataFolder().getPath() - + "' was blocked because its recovery inventory could not be persisted.", e); - continue; - } - Set structureKeys = new TreeSet<>(); - Set templateKeys = new TreeSet<>(); - for (Entry entry : manifest.entries) { - if (!configured.contains(entry.url)) { - continue; - } - structureKeys.addAll(copyList(entry.structureKeys)); - templateKeys.addAll(copyList(entry.templateKeys)); - } - attemptedPacks++; - try { - BulkStructureImporter.Report report = BulkStructureImporter.importManagedDatapackStructures( - data, - StructureImporter.Mode.OVERWRITE, - BukkitPlatform.console(), - structureKeys, - templateKeys - ); - Set successfulPendingUrls = new HashSet<>(pendingUrls); - Set incompleteUrls = new HashSet<>(); - for (String pendingUrl : pendingUrls) { - Entry entry = entriesByUrl.get(pendingUrl); - Map desired = importBundleInventory(entry); - if (!report.successfulBundles().entrySet().containsAll(desired.entrySet())) { - successfulPendingUrls.remove(pendingUrl); - incompleteUrls.add(pendingUrl); - failedUrls.add(pendingUrl); - } - } - if (report.failed() > 0 && incompleteUrls.isEmpty()) { - successfulPendingUrls.clear(); - incompleteUrls.addAll(pendingUrls); - failedUrls.addAll(pendingUrls); - } - if (!incompleteUrls.isEmpty()) { - boolean reconciled = reconcileFailedImportInventories( - root, manifest, data, targetId, incompleteUrls, entriesByUrl); - if (report.retryRequired() || !reconciled) { - IrisLogging.error("Datapack structure import for pack '%s' reported %d incomplete source(s) and remains pending because a retryable runtime failure occurred.", - data.getDataFolder().getPath(), incompleteUrls.size()); - } else if (recordDeterministicImportAttempts( - root, manifest, targetId, incompleteUrls, entriesByUrl)) { - IrisLogging.warn("Datapack structure import for pack '" - + data.getDataFolder().getPath() + "' left " + incompleteUrls.size() - + " source(s) incomplete after deterministic validation failures. Iris will retain the partial editable imports without retrying until the datapack source, importer format, or target pack changes."); - } - } - Map sharedBundles = desiredBundles(configured, entriesByUrl); - boolean packCompleted = false; - for (String pendingUrl : successfulPendingUrls) { - Entry entry = entriesByUrl.get(pendingUrl); - Map desired = importBundleInventory(entry); - Map previous = entry.importedBundles.getOrDefault(targetId, Map.of()); - Map stale = new TreeMap<>(previous); - stale.keySet().removeAll(desired.keySet()); - stale.keySet().removeAll(sharedBundles.keySet()); - Map remaining = cleanupImportedBundles(data, stale); - if (!remaining.isEmpty()) { - failedUrls.add(pendingUrl); - continue; - } - entry.importedBundles.put(targetId, desired); - recordSuccessfulImport(entry, targetId); - completedUrls.add(pendingUrl); - packCompleted = true; - } - if (packCompleted) { - completedPacks++; - } - } catch (RuntimeException e) { - failedUrls.addAll(pendingUrls); - IrisLogging.reportError("Datapack structure import failed for pack '" - + data.getDataFolder().getPath() + "'; the manifest remains pending for retry.", e); - reconcileFailedImportInventories(root, manifest, data, targetId, pendingUrls, entriesByUrl); - } - } - - for (Entry entry : manifest.entries) { - if (failedUrls.contains(entry.url)) { - entry.structuresImported = false; - } else if (completedUrls.contains(entry.url)) { - entry.structuresImported = true; - } - } - if (attemptedPacks == 0 && cleanupTargets == 0) { - if (manifestStagingMetadataChanged) { - writeManifest(root, manifest); - } - return recovered || stagingStateChanged || manifestStagingMetadataChanged; - } - writeManifest(root, manifest); - if (attemptedPacks == 0) { - IrisLogging.info("Datapack editable-import cleanup reconciled " + cleanupTargets + " removed source target(s)."); - return true; - } - IrisLogging.info("Datapack structure import refreshed " + completedUrls.size() + " source(s) across " - + completedPacks + "/" + attemptedPacks - + " pack(s). Reference the imported keys from a 'structures' placement to position them manually."); - return true; - } - - private static boolean hasRemovedImportState(List packs, List entries) { - for (IrisData data : packs) { - Set configured = configuredImports(data); - String targetId = data.getDataFolder().toPath().toAbsolutePath().normalize().toString(); - for (Entry entry : entries) { - if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { - return true; - } - } - } - return false; - } - - static String importRevision(Entry entry) { - return importRevision(entry, STRUCTURE_IMPORT_FORMAT_REVISION); - } - - static String importRevision(Entry entry, int importerFormatRevision) { - return "v" + importerFormatRevision + ":" + safe(entry.versionId) + ":" + safe(entry.sha1); - } - - static boolean importPending(Entry entry, String targetId) { - String revision = importRevision(entry); - return !revision.equals(entry.importedTargets.get(targetId)) - && !revision.equals(entry.importAttempts.get(targetId)); - } - - static void recordDeterministicImportAttempt(Entry entry, String targetId) { - entry.importedTargets.remove(targetId); - entry.importAttempts.put(targetId, importRevision(entry)); - entry.structuresImported = false; - } - - static void recordSuccessfulImport(Entry entry, String targetId) { - entry.importedTargets.put(targetId, importRevision(entry)); - entry.importAttempts.remove(targetId); - } - - static void prepareImportRecoveryInventory(Entry entry, String targetId) { - Map desired = importBundleInventory(entry); - Map recovery = new TreeMap<>(desired); - recovery.putAll(entry.importedBundles.getOrDefault(targetId, Map.of())); - entry.importedBundles.put(targetId, recovery); - entry.importedTargets.remove(targetId); - entry.importAttempts.remove(targetId); - entry.structuresImported = false; - } - - private static boolean reconcileFailedImportInventories( - File root, - Manifest manifest, - IrisData data, - String targetId, - Set pendingUrls, - Map entriesByUrl - ) { - boolean reconciled = true; - for (String pendingUrl : pendingUrls) { - Entry entry = entriesByUrl.get(pendingUrl); - try { - reconcileFailedImportInventory(data, entry, targetId); - } catch (IOException | RuntimeException e) { - reconciled = false; - IrisLogging.reportError("Could not reconcile partial editable structure imports for '" - + pendingUrl + "' in pack '" + data.getDataFolder().getPath() - + "'; the conservative recovery inventory remains pending.", e); - } - } - try { - writeManifestChecked(root, manifest); - } catch (IOException e) { - reconciled = false; - IrisLogging.reportError("Could not persist reconciled partial editable structure imports for pack '" - + data.getDataFolder().getPath() + "'; the earlier recovery inventory remains durable.", e); - } - return reconciled; - } - - private static boolean recordDeterministicImportAttempts( - File root, - Manifest manifest, - String targetId, - Set incompleteUrls, - Map entriesByUrl - ) { - for (String incompleteUrl : incompleteUrls) { - recordDeterministicImportAttempt(entriesByUrl.get(incompleteUrl), targetId); - } - try { - writeManifestChecked(root, manifest); - return true; - } catch (IOException e) { - for (String incompleteUrl : incompleteUrls) { - entriesByUrl.get(incompleteUrl).importAttempts.remove(targetId); - } - IrisLogging.reportError("Could not persist deterministic editable structure import attempts; the sources remain pending for retry.", e); - return false; - } - } - - private static void reconcileFailedImportInventory( - IrisData data, - Entry entry, - String targetId - ) throws IOException { - Map> claims = importBundleClaims(entry, targetId); - Map reconciled = new TreeMap<>(); - StructureTransactionWriter writer = new StructureTransactionWriter(data.getDataFolder().toPath()); - for (Map.Entry> bundle : claims.entrySet()) { - StructureKey targetKey; - try { - targetKey = StructureKey.parse(bundle.getKey()); - } catch (RuntimeException e) { - throw new IOException("Invalid editable structure target key '" + bundle.getKey() + "'", e); - } - Optional source = writer.ownedSource(targetKey); - if (source.isPresent() && sourceClaimsContain(bundle.getValue(), source.get())) { - reconciled.put(bundle.getKey(), source.get().key().value()); - } - } - if (reconciled.isEmpty()) { - entry.importedBundles.remove(targetId); - } else { - entry.importedBundles.put(targetId, reconciled); - } - entry.importedTargets.remove(targetId); - entry.importAttempts.remove(targetId); - entry.structuresImported = false; - } - - static boolean cleanupRemovedImports( - IrisData data, - String targetId, - Set configured, - List entries, - Map entriesByUrl - ) { - boolean successful = true; - Map retainedBundles = desiredBundles(configured, entriesByUrl); - for (Entry entry : entries) { - if (configured.contains(entry.url)) { - continue; - } - Map inventory = entry.importedBundles.get(targetId); - if (inventory == null && !hasImportState(entry, targetId)) { - continue; - } - Map resolvedInventory = inventory == null ? Map.of() : inventory; - for (Entry retainedEntry : entries) { - if (configured.contains(retainedEntry.url)) { - retainedEntry.importedTargets.remove(targetId); - retainedEntry.importAttempts.remove(targetId); - retainedEntry.structuresImported = false; - } - } - Map removable = new TreeMap<>(resolvedInventory); - removable.keySet().removeAll(retainedBundles.keySet()); - Map remaining = cleanupImportedBundles(data, removable); - if (!remaining.isEmpty()) { - Map retained = new TreeMap<>(); - for (Map.Entry bundle : resolvedInventory.entrySet()) { - if (retainedBundles.containsKey(bundle.getKey()) || remaining.containsKey(bundle.getKey())) { - retained.put(bundle.getKey(), bundle.getValue()); - } - } - entry.importedBundles.put(targetId, retained); - entry.importedTargets.remove(targetId); - entry.importAttempts.remove(targetId); - entry.structuresImported = false; - successful = false; - continue; - } - entry.importedBundles.remove(targetId); - entry.importedTargets.remove(targetId); - entry.importAttempts.remove(targetId); - } - return successful; - } - - private static boolean hasImportState(Entry entry, String targetId) { - return entry.importedBundles.containsKey(targetId) - || entry.importedTargets.containsKey(targetId) - || entry.importAttempts.containsKey(targetId); - } - - private static Map cleanupImportedBundles(IrisData data, Map inventory) { - Map remaining = new TreeMap<>(); - StructureTransactionWriter writer = new StructureTransactionWriter(data.getDataFolder().toPath()); - boolean removed = false; - for (Map.Entry bundle : inventory.entrySet()) { - StructureKey sourceKey; - try { - sourceKey = StructureKey.parse(bundle.getValue()); - StructureSource.Kind sourceKind = sourceKey.namespace().equals("minecraft") - ? StructureSource.Kind.VANILLA : StructureSource.Kind.DATAPACK; - removed |= writer.removeManagedDatapackOwned( - StructureKey.parse(bundle.getKey()), - sourceKind, - sourceKey - ); - } catch (IOException | RuntimeException e) { - remaining.put(bundle.getKey(), bundle.getValue()); - IrisLogging.reportError("Preserving imported structure bundle '" + bundle.getKey() - + "' in pack '" + data.getDataFolder().getPath() - + "' because ownership-safe cleanup failed.", e); - } - } - if (removed) { - data.invalidateStructureResources(); - } - return remaining; - } - - private static Map desiredBundles(Set configured, Map entriesByUrl) { - Map bundles = new TreeMap<>(); - for (String url : configured) { - Entry entry = entriesByUrl.get(url); - if (entry != null) { - bundles.putAll(importBundleInventory(entry)); - } - } - return bundles; - } - - static Map importBundleInventory(Entry entry) { - Map bundles = new TreeMap<>(); - for (String structureKey : copyList(entry.structureKeys)) { - bundles.put("iris:" + StructureImporter.deriveName(structureKey), structureKey); - } - for (String templateKey : copyList(entry.templateKeys)) { - bundles.put("iris:" + BulkStructureImporter.templateNameFor(templateKey), templateKey); - } - return bundles; - } - - private static void flattenIfWrapped(File dir) throws IOException { - if (new File(dir, "pack.mcmeta").isFile()) { - return; - } - File[] children = dir.listFiles(); - if (children == null) { - return; - } - File singleDir = null; - int dirCount = 0; - int fileCount = 0; - for (File child : children) { - if (child.isDirectory()) { - dirCount++; - singleDir = child; - } else { - fileCount++; - } - } - if (dirCount != 1 || fileCount != 0 || singleDir == null || !new File(singleDir, "pack.mcmeta").isFile()) { - return; - } - File[] inner = singleDir.listFiles(); - if (inner != null) { - for (File item : inner) { - File moved = new File(dir, item.getName()); - if (item.renameTo(moved)) { - continue; - } - if (item.isDirectory()) { - IO.copyDirectory(item.toPath(), moved.toPath()); - } else { - Files.copy(item.toPath(), moved.toPath(), StandardCopyOption.REPLACE_EXISTING); - } - } - } - deleteInstallScratch(singleDir, "wrapped datapack extraction"); - } - - static DownloadResult download(String url, File dest, String etag, String lastModified) throws IOException { - URI current = parseSourceUri(url); - if (current == null) { - throw new IOException("Empty datapack URL"); - } - if ("file".equalsIgnoreCase(current.getScheme())) { - return copyLocalDatapack(current, dest); - } - for (int attempt = 0; attempt < MAX_REDIRECTS; attempt++) { - if (!"http".equalsIgnoreCase(current.getScheme()) && !"https".equalsIgnoreCase(current.getScheme())) { - throw new IOException("Datapack URL must use HTTP or HTTPS: " + current); - } - URL target = current.toURL(); - HttpURLConnection connection = (HttpURLConnection) target.openConnection(); - connection.setRequestMethod("GET"); - connection.setRequestProperty("User-Agent", USER_AGENT); - if (etag != null && !etag.isBlank()) { - connection.setRequestProperty("If-None-Match", etag); - } - if (lastModified != null && !lastModified.isBlank()) { - connection.setRequestProperty("If-Modified-Since", lastModified); - } - connection.setConnectTimeout(20000); - connection.setReadTimeout(60000); - connection.setInstanceFollowRedirects(false); - try { - int code = connection.getResponseCode(); - if (code == HttpURLConnection.HTTP_NOT_MODIFIED) { - String responseEtag = headerOrFallback(connection, "ETag", etag); - String responseLastModified = headerOrFallback(connection, "Last-Modified", lastModified); - return new DownloadResult(true, responseEtag, responseLastModified); - } - if (code / 100 == 3) { - String location = connection.getHeaderField("Location"); - if (location == null || location.isBlank()) { - throw new IOException("Redirect without a location header from " + current); - } - try { - current = current.resolve(new URI(location)); - } catch (URISyntaxException e) { - throw new IOException("Invalid redirect location from " + current + ": " + location, e); - } - continue; - } - if (code != 200) { - throw new IOException("HTTP " + code + " downloading " + current); - } - long declaredLength = connection.getContentLengthLong(); - if (declaredLength > MAX_DOWNLOAD_BYTES) { - throw new IOException("Datapack download exceeds " + MAX_DOWNLOAD_BYTES + " bytes"); - } - - File parent = dest.getParentFile(); - Path parentPath = parent == null ? Path.of(".").toAbsolutePath().normalize() : parent.toPath(); - ensureScratchDirectory(parentPath.toFile(), "datapack download cache"); - Path temporary = Files.createTempFile(parentPath, dest.getName() + "-", ".part"); - try { - long downloaded = 0; - String responseEtag = connection.getHeaderField("ETag"); - String responseLastModified = connection.getHeaderField("Last-Modified"); - try (InputStream in = connection.getInputStream(); - OutputStream out = Files.newOutputStream(temporary)) { - byte[] buffer = new byte[8192]; - int length; - while ((length = in.read(buffer)) > 0) { - downloaded += length; - if (downloaded > MAX_DOWNLOAD_BYTES) { - throw new IOException("Datapack download exceeds " + MAX_DOWNLOAD_BYTES + " bytes"); - } - out.write(buffer, 0, length); - } - } - move(temporary, dest.toPath()); - return new DownloadResult(false, responseEtag, responseLastModified); - } finally { - Files.deleteIfExists(temporary); - } - } finally { - connection.disconnect(); - } - } - throw new IOException("Too many redirects downloading " + url); - } - - private static DownloadResult copyLocalDatapack(URI source, File destination) throws IOException { - Path sourcePath = requireLocalDatapackPath(source); - Path destinationPath = destination.toPath().toAbsolutePath().normalize(); - if (Files.exists(destinationPath, LinkOption.NOFOLLOW_LINKS) - && Files.isSameFile(sourcePath, destinationPath)) { - throw new IOException("Local datapack source and cache destination are the same file: " + sourcePath); - } - Path parent = destinationPath.getParent(); - if (parent == null) { - throw new IOException("Local datapack cache destination has no parent: " + destinationPath); - } - ensureScratchDirectory(parent.toFile(), "datapack download cache"); - BasicFileAttributes before = Files.readAttributes( - sourcePath, - BasicFileAttributes.class, - LinkOption.NOFOLLOW_LINKS); - Path temporary = Files.createTempFile(parent, destination.getName() + "-", ".part"); - try { - long copied = 0; - try (InputStream input = Files.newInputStream( - sourcePath, - StandardOpenOption.READ, - LinkOption.NOFOLLOW_LINKS); - OutputStream output = Files.newOutputStream(temporary)) { - byte[] buffer = new byte[HASH_BUFFER_BYTES]; - int length; - while ((length = input.read(buffer)) > 0) { - copied += length; - if (copied > MAX_DOWNLOAD_BYTES) { - throw new IOException("Local datapack exceeds " + MAX_DOWNLOAD_BYTES + " bytes: " + sourcePath); - } - output.write(buffer, 0, length); - } - } - BasicFileAttributes after = Files.readAttributes( - sourcePath, - BasicFileAttributes.class, - LinkOption.NOFOLLOW_LINKS); - if (!after.isRegularFile() - || before.size() != after.size() - || !before.lastModifiedTime().equals(after.lastModifiedTime()) - || !Objects.equals(before.fileKey(), after.fileKey()) - || copied != after.size()) { - throw new IOException("Local datapack changed while Iris was copying it: " + sourcePath); - } - move(temporary, destinationPath); - return new DownloadResult(false, null, null); - } finally { - Files.deleteIfExists(temporary); - } - } - - private static Path requireLocalDatapackPath(URI source) throws IOException { - if (source == null - || !"file".equalsIgnoreCase(source.getScheme()) - || source.isOpaque() - || source.getRawAuthority() != null - || source.getRawQuery() != null - || source.getRawFragment() != null) { - throw new IOException("Datapack file URL must be an absolute local file URI without authority, query, or fragment: " + source); - } - Path path; - try { - path = Path.of(source).toAbsolutePath().normalize(); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid local datapack file URL: " + source, exception); - } - if (Files.isSymbolicLink(path) - || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Local datapack is not a regular non-symbolic-link file: " + path); - } - long size = Files.size(path); - if (size > MAX_DOWNLOAD_BYTES) { - throw new IOException("Local datapack exceeds " + MAX_DOWNLOAD_BYTES + " bytes: " + path); - } - return path; - } - - private static String headerOrFallback(HttpURLConnection connection, String name, String fallback) { - String value = connection.getHeaderField(name); - return value == null || value.isBlank() ? fallback : value; - } - - private static String sha1(File file) throws IOException { - try { - MessageDigest digest = MessageDigest.getInstance("SHA-1"); - try (InputStream in = new FileInputStream(file)) { - byte[] buffer = new byte[8192]; - int length; - while ((length = in.read(buffer)) > 0) { - digest.update(buffer, 0, length); - } - } - byte[] hash = digest.digest(); - StringBuilder builder = new StringBuilder(hash.length * 2); - for (byte value : hash) { - builder.append(String.format("%02x", value)); - } - return builder.toString(); - } catch (NoSuchAlgorithmException e) { - throw new IOException("SHA-1 algorithm unavailable", e); - } - } - - private static String deriveId(ResolvedDatapack resolved) { - String base = resolved.getProjectSlug(); - if (base == null || base.isBlank()) { - base = resolved.getFileName(); - int dot = base.lastIndexOf('.'); - if (dot > 0) { - base = base.substring(0, dot); - } - } - String id = sanitizeId(base); - if (resolved.isDirect()) { - return id + "-" + ModrinthResolver.directIdentity(resolved.getDownloadUrl()); - } - return id; - } - - private static String sanitizeId(String value) { - if (value == null) { - return "datapack"; - } - String lower = value.toLowerCase(Locale.ROOT).trim(); - StringBuilder builder = new StringBuilder(lower.length()); - for (int i = 0; i < lower.length(); i++) { - char c = lower.charAt(i); - if ((c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '-' || c == '_' || c == '.') { - builder.append(c); - } else if (c == ' ' || c == '/' || c == '\\') { - builder.append('-'); - } - } - String cleaned = builder.toString().replaceAll("-+", "-"); - cleaned = cleaned.replaceAll("^[-_.]+", "").replaceAll("[-_.]+$", ""); - return cleaned.isBlank() ? "datapack" : cleaned; - } - - private static boolean isValidManagedId(String value) { - return value != null && !value.isBlank() && value.equals(sanitizeId(value)) - && !RESERVED_IDS.contains(value); - } - - private static String serverMcVersion() { - return serverMcVersion(Bukkit.getServer()); - } - - static String serverMcVersion(Server server) { - MinecraftVersion detected = MinecraftVersion.detect(server); - return detected == null ? null : detected.value(); - } - - private static String safe(String value) { - return value == null || value.isBlank() ? "?" : value; - } - - private static String safeFile(String value) { - return value == null || value.isBlank() ? "unknown" : value.replaceAll("[^a-zA-Z0-9._-]", "_"); - } - private static void diagnoseConflicts(VolmitSender sender, Manifest manifest) { Map> owners = new TreeMap<>(); for (Entry entry : manifest.entries) { - for (String key : copyList(entry.structureKeys)) { + for (String key : DatapackManifestStore.copyList(entry.structureKeys)) { owners.computeIfAbsent("structure " + key, ignored -> new ArrayList<>()).add(entry.id); } - for (String key : copyList(entry.templateKeys)) { + for (String key : DatapackManifestStore.copyList(entry.templateKeys)) { owners.computeIfAbsent("template " + key, ignored -> new ArrayList<>()).add(entry.id); } } @@ -3916,1812 +607,23 @@ public final class DatapackIngestService { } conflicts++; if (conflicts <= 20) { - message(sender, C.YELLOW + " Registry conflict: " + C.WHITE + resource.getKey() + DatapackSupport.message(sender, C.YELLOW + " Registry conflict: " + C.WHITE + resource.getKey() + C.YELLOW + " is supplied by " + String.join(", ", resource.getValue())); } } if (conflicts > 0) { - message(sender, C.YELLOW + "Detected " + conflicts + " external datapack registry conflict(s). Minecraft's enabled-pack order in level.dat determines precedence; datapackImports order does not."); + DatapackSupport.message(sender, C.YELLOW + "Detected " + conflicts + " external datapack registry conflict(s). Minecraft's enabled-pack order in level.dat determines precedence; datapackImports order does not."); } if (conflicts > 20) { - message(sender, C.GRAY + " " + (conflicts - 20) + " additional conflict(s) omitted."); - } - } - - private static void pruneCache(File cacheDir) { - File[] files = cacheDir.listFiles(File::isFile); - if (files == null) { - return; - } - List archives = new ArrayList<>(); - long totalBytes = 0; - for (File file : files) { - if (file.getName().endsWith(".part")) { - IO.delete(file); - continue; - } - if (file.getName().endsWith(".zip")) { - archives.add(file); - totalBytes += Math.max(0, file.length()); - } - } - archives.sort(Comparator.comparingLong(File::lastModified)); - int remaining = archives.size(); - for (File archive : archives) { - if (remaining <= MAX_CACHE_FILES && totalBytes <= MAX_CACHE_BYTES) { - break; - } - long size = Math.max(0, archive.length()); - IO.delete(archive); - if (!archive.exists()) { - remaining--; - totalBytes -= size; - } - } - } - - private static List copyList(List values) { - return values == null ? List.of() : List.copyOf(values); - } - - static Entry copyEntry(Entry source) { - Entry resolved = Objects.requireNonNull(source, "Datapack manifest entry must not be null"); - Entry copy = new Entry(); - copy.url = resolved.url; - copy.id = resolved.id; - copy.versionId = resolved.versionId; - copy.versionNumber = resolved.versionNumber; - copy.sha1 = resolved.sha1; - copy.filename = resolved.filename; - copy.etag = resolved.etag; - copy.lastModified = resolved.lastModified; - copy.installedEpoch = resolved.installedEpoch; - copy.structuresImported = resolved.structuresImported; - copy.stagingMetadata = resolved.stagingMetadata; - copy.structureKeys = new ArrayList<>(copyList(resolved.structureKeys)); - copy.templateKeys = new ArrayList<>(copyList(resolved.templateKeys)); - copy.installMetadata = new HashMap<>(Objects.requireNonNullElseGet( - resolved.installMetadata, Map::of)); - copy.importedTargets = new HashMap<>(Objects.requireNonNullElseGet( - resolved.importedTargets, Map::of)); - copy.importAttempts = new HashMap<>(Objects.requireNonNullElseGet( - resolved.importAttempts, Map::of)); - copy.importedBundles = new HashMap<>(); - if (resolved.importedBundles != null) { - for (Map.Entry> bundle : resolved.importedBundles.entrySet()) { - copy.importedBundles.put(bundle.getKey(), new HashMap<>(bundle.getValue())); - } - } - return copy; - } - - private static String hex(byte[] hash) { - StringBuilder builder = new StringBuilder(hash.length * 2); - for (byte value : hash) { - builder.append(String.format("%02x", value)); - } - return builder.toString(); - } - - private static void updateDigestInt(MessageDigest digest, int value) { - digest.update((byte) (value >>> 24)); - digest.update((byte) (value >>> 16)); - digest.update((byte) (value >>> 8)); - digest.update((byte) value); - } - - private static void updateDigestLong(MessageDigest digest, long value) { - digest.update((byte) (value >>> 56)); - digest.update((byte) (value >>> 48)); - digest.update((byte) (value >>> 40)); - digest.update((byte) (value >>> 32)); - digest.update((byte) (value >>> 24)); - digest.update((byte) (value >>> 16)); - digest.update((byte) (value >>> 8)); - digest.update((byte) value); - } - - private static void message(VolmitSender sender, String text) { - if (sender != null) { - sender.sendMessage(text); - return; - } - IrisLogging.info(text); - } - - private static Manifest readManifest(File root) { - File file = new File(root, "manifest.json"); - Manifest manifest = null; - boolean recoverFromStaging = false; - Path path = file.toPath(); - if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - manifest = new Manifest(); - } else if (Files.isSymbolicLink(path) || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { - IrisLogging.error("Unreadable datapack manifest " + file.getPath() - + "; moving the non-regular path aside before recovering Iris-managed staging"); - recoverFromStaging = quarantine(path); - } else { - try { - String json = readBoundedUtf8(path, MAX_MANIFEST_BYTES, "Datapack manifest"); - manifest = GSON.fromJson(json, Manifest.class); - if (manifest == null) { - throw new IOException("Datapack manifest is empty"); - } - } catch (Exception e) { - IrisLogging.reportError("Unreadable datapack manifest " + file.getPath() - + "; moving it aside before recovering Iris-managed staging", e); - recoverFromStaging = quarantine(file.toPath()); - } - } - if (manifest == null) { - manifest = new Manifest(); - } - normalizeManifest(manifest); - if (recoverFromStaging) { - recoverManifestFromStaging(root, manifest); - } - return manifest; - } - - private static boolean quarantine(Path file) { - try { - move(file, file.resolveSibling(file.getFileName().toString() + ".corrupt-" + System.currentTimeMillis())); - return true; - } catch (IOException e) { - IrisLogging.reportError("Failed to move aside corrupt datapack manifest " + file, e); - return false; - } - } - - private static void normalizeManifest(Manifest manifest) { - if (manifest.entries == null) { - manifest.entries = new ArrayList<>(); - return; - } - List normalized = new ArrayList<>(); - Set urls = new HashSet<>(); - Set ids = new HashSet<>(); - for (Entry entry : manifest.entries) { - if (entry == null || entry.url == null || entry.url.isBlank() || entry.id == null || entry.id.isBlank()) { - continue; - } - entry.url = entry.url.trim(); - if (!isValidManagedId(entry.id)) { - IrisLogging.warn("Ignoring datapack manifest entry with invalid id '" + entry.id + "'"); - continue; - } - entry.structureKeys = normalizeKeys(entry.structureKeys); - entry.templateKeys = normalizeKeys(entry.templateKeys); - entry.stagingMetadata = entry.stagingMetadata == null ? "" : entry.stagingMetadata.trim(); - entry.installMetadata = normalizeImportedTargets(entry.installMetadata); - entry.importedTargets = normalizeImportedTargets(entry.importedTargets); - entry.importAttempts = normalizeImportedTargets(entry.importAttempts); - entry.importedBundles = normalizeImportedBundles(entry.importedBundles); - if (!urls.add(entry.url) || !ids.add(entry.id)) { - IrisLogging.warn("Ignoring duplicate datapack manifest entry for id '" + entry.id + "' and url " + entry.url); - continue; - } - normalized.add(entry); - } - manifest.entries = normalized; - } - - private static void recoverManifestFromStaging(File root, Manifest manifest) { - File staging = new File(root, "staging"); - File[] directories = staging.listFiles(File::isDirectory); - if (directories == null) { - return; - } - for (File directory : directories) { - try { - Ownership ownership = readOwnershipOrNull(directory); - if (ownership == null || !directory.getName().equals(ownership.id) - || manifest.find(ownership.url) != null || manifest.findById(ownership.id) != null) { - continue; - } - validateManagedDirectory(directory, ownership.id); - if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { - IrisLogging.warn("Ignoring corrupt Iris-managed datapack staging at " + directory.getPath()); - continue; - } - Entry recovered = ownership.toEntry(); - recovered.installedEpoch = directory.lastModified(); - manifest.put(recovered); - IrisLogging.warn("Recovered Iris-managed datapack manifest entry '" + recovered.id + "' from staging."); - } catch (IOException e) { - IrisLogging.warn("Ignoring orphan datapack staging at " + directory.getPath() + ": " + e.getMessage()); - } - } - } - - private static List normalizeKeys(List keys) { - TreeSet normalized = new TreeSet<>(); - if (keys != null) { - for (String key : keys) { - if (key != null && !key.isBlank()) { - normalized.add(key.trim().toLowerCase(Locale.ROOT)); - } - } - } - return new ArrayList<>(normalized); - } - - private static Map normalizeImportedTargets(Map targets) { - Map normalized = new HashMap<>(); - if (targets == null) { - return normalized; - } - for (Map.Entry target : targets.entrySet()) { - if (target.getKey() != null && !target.getKey().isBlank() - && target.getValue() != null && !target.getValue().isBlank()) { - normalized.put(target.getKey(), target.getValue()); - } - } - return normalized; - } - - private static Map> normalizeImportedBundles( - Map> targets - ) { - Map> normalized = new HashMap<>(); - if (targets == null) { - return normalized; - } - for (Map.Entry> target : targets.entrySet()) { - if (target.getKey() == null || target.getKey().isBlank() || target.getValue() == null) { - continue; - } - Map bundles = new TreeMap<>(); - for (Map.Entry bundle : target.getValue().entrySet()) { - if (bundle.getKey() != null && !bundle.getKey().isBlank() - && bundle.getValue() != null && !bundle.getValue().isBlank()) { - bundles.put(bundle.getKey(), bundle.getValue()); - } - } - normalized.put(target.getKey(), bundles); - } - return normalized; - } - - private static void writeManifest(File root, Manifest manifest) { - try { - writeManifestChecked(root, manifest); - } catch (IOException e) { - IrisLogging.reportError("Failed to write datapack manifest " - + new File(root, "manifest.json").toPath(), e); - } - } - - private static void writeManifestChecked(File root, Manifest manifest) throws IOException { - try (ManifestWrite write = prepareManifestWrite(root, manifest)) { - write.publish(); - } - } - - private static ManifestWrite prepareManifestWrite(File root, Manifest manifest) throws IOException { - Path file = new File(root, "manifest.json").toPath(); - Path parent = file.getParent(); - Files.createDirectories(parent); - Path temp = Files.createTempFile(parent, "manifest", ".json.tmp"); - Path rollback = null; - try { - byte[] content = GSON.toJson(manifest).getBytes(StandardCharsets.UTF_8); - if (content.length > MAX_MANIFEST_BYTES) { - throw new IOException("Datapack manifest exceeds " + MAX_MANIFEST_BYTES + " bytes"); - } - Files.write(temp, content, StandardOpenOption.TRUNCATE_EXISTING); - forceFile(temp); - if (Files.exists(file, LinkOption.NOFOLLOW_LINKS)) { - if (!Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS) || Files.isSymbolicLink(file)) { - throw new IOException("Datapack manifest is not a regular file: " + file); - } - rollback = Files.createTempFile(parent, "manifest-rollback", ".json.tmp"); - Files.copy(file, rollback, StandardCopyOption.REPLACE_EXISTING); - forceFile(rollback); - } - return new ManifestWrite(temp, file, rollback); - } catch (IOException | RuntimeException e) { - try { - Files.deleteIfExists(temp); - } catch (IOException cleanupFailure) { - e.addSuppressed(cleanupFailure); - } - if (rollback != null) { - try { - Files.deleteIfExists(rollback); - } catch (IOException cleanupFailure) { - e.addSuppressed(cleanupFailure); - } - } - throw e; - } - } - - private static void move(Path source, Path target) throws IOException { - try { - Files.move(source, target, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING); - } catch (AtomicMoveNotSupportedException e) { - Files.move(source, target, StandardCopyOption.REPLACE_EXISTING); - } - } - - private static void moveNew(Path source, Path target) throws IOException { - if (pathExists(target, "move target")) { - throw new IOException("Refusing to replace concurrently-created path " + target); - } - Files.move(source, target); - } - - private static void ensureScratchDirectory(File directory, String purpose) throws IOException { - Path path = directory.toPath(); - if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing invalid " + purpose + " directory " + directory.getPath()); - } - return; - } - Files.createDirectories(path); - if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Could not create a safe " + purpose + " directory " + directory.getPath()); - } - } - - private static void verifyDirectoryContainerIfPresent(File directory, String purpose) throws IOException { - Path path = directory.toPath(); - if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { - return; - } - if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Refusing invalid " + purpose + " directory " + directory.getPath()); - } - } - - private static DatapackCoordinator createInstallCoordinator( - File root, - Entry entry, - List plans, - boolean manifestAlreadyMatched - ) throws IOException { - CoordinatorJournal journal = newCoordinatorJournal( - CoordinatorOperation.INSTALL, - entry, - manifestAlreadyMatched - ); - for (InstallPlan plan : plans) { - if (!plan.publishRequired()) { - continue; - } - CoordinatorDirectory directory = new CoordinatorDirectory(); - directory.target = normalizedPath(plan.target()); - directory.pending = normalizedPath(plan.pending()); - directory.backup = normalizedPath(plan.backup()); - directory.hadTarget = plan.hadTarget(); - directory.originalHash = plan.originalHash(); - directory.desiredHash = plan.desiredHash(); - directory.originalMarkerHash = plan.originalMarkerHash(); - directory.desiredMarkerHash = plan.desiredMarkerHash(); - directory.originalIdentity = plan.originalIdentity(); - directory.desiredIdentity = plan.desiredIdentity(); - directory.targetRoot = plan.targetRootIdentity(); - directory.scratchRoot = plan.scratchRootIdentity(); - directory.targetRootIdentity = plan.targetRootFileIdentity(); - directory.scratchRootIdentity = plan.scratchRootFileIdentity(); - journal.directories.add(directory); - } - return createCoordinator(root, journal); - } - - private static DatapackCoordinator createRemovalCoordinator( - File root, - Entry entry, - DirectoryRemoval directoryRemoval, - EditableImportRemoval editableRemoval - ) throws IOException { - CoordinatorJournal journal = newCoordinatorJournal(CoordinatorOperation.REMOVE, entry, true); - for (DirectoryMove move : directoryRemoval.moves()) { - CoordinatorDirectory directory = new CoordinatorDirectory(); - directory.target = normalizedPath(move.target()); - directory.pending = ""; - directory.backup = normalizedPath(move.backup()); - directory.hadTarget = true; - directory.originalHash = move.originalHash(); - directory.desiredHash = ""; - directory.originalMarkerHash = move.originalMarkerHash(); - directory.desiredMarkerHash = ""; - directory.originalIdentity = move.originalIdentity(); - directory.desiredIdentity = ""; - directory.targetRoot = move.targetRootIdentity(); - directory.scratchRoot = move.scratchRootIdentity(); - directory.targetRootIdentity = move.targetRootFileIdentity(); - directory.scratchRootIdentity = move.scratchRootFileIdentity(); - journal.directories.add(directory); - } - for (StructureTransactionWriter.PreparedRemovalToken token : editableRemoval.recoveryTokens()) { - CoordinatorEditable editable = new CoordinatorEditable(); - editable.packRoot = token.packRoot().toString(); - editable.transactionId = token.transactionId().toString(); - editable.claimId = UUID.randomUUID().toString(); - journal.editables.add(editable); - } - Path transactionRoot = coordinatorTransactionRoot(root, journal); - try { - editableRemoval.claimRecoveryOwners(transactionRoot, journal); - writeCoordinatorJournal(transactionRoot, journal); - return new DatapackCoordinator(transactionRoot, journal); - } catch (IOException | RuntimeException creationFailure) { - try { - deleteInstallScratch(transactionRoot.toFile(), "incomplete datapack transaction"); - } catch (IOException cleanupFailure) { - creationFailure.addSuppressed(cleanupFailure); - } - if (creationFailure instanceof IOException ioFailure) { - throw ioFailure; - } - throw creationFailure; - } - } - - private static CoordinatorJournal newCoordinatorJournal( - CoordinatorOperation operation, - Entry entry, - boolean manifestAlreadyMatched - ) { - CoordinatorJournal journal = new CoordinatorJournal(); - journal.schemaVersion = TRANSACTION_SCHEMA; - journal.transactionId = UUID.randomUUID().toString(); - journal.operation = operation; - journal.phase = CoordinatorPhase.PREPARED; - journal.id = entry.id; - journal.url = entry.url; - journal.versionId = entry.versionId; - journal.versionNumber = entry.versionNumber; - journal.sha1 = entry.sha1; - journal.manifestAlreadyMatched = manifestAlreadyMatched; - return journal; - } - - private static DatapackCoordinator createCoordinator(File root, CoordinatorJournal journal) throws IOException { - Path transactionRoot = coordinatorTransactionRoot(root, journal); - writeCoordinatorJournal(transactionRoot, journal); - return new DatapackCoordinator(transactionRoot, journal); - } - - private static Path coordinatorTransactionRoot(File root, CoordinatorJournal journal) throws IOException { - File transactionDirectory = new File(root, TRANSACTION_DIRECTORY); - ensureScratchDirectory(transactionDirectory, "datapack transaction"); - Path transactionRoot = new File(transactionDirectory, journal.transactionId).toPath().toAbsolutePath().normalize(); - if (Files.exists(transactionRoot, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Datapack transaction id already exists: " + journal.transactionId); - } - return transactionRoot; - } - - private static String normalizedPath(File file) { - return file.toPath().toAbsolutePath().normalize().toString(); - } - - private static String realDirectoryPath(File directory, String purpose) throws IOException { - Path path = directory.toPath().toAbsolutePath().normalize(); - if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid " + purpose + " " + path); - } - return path.toRealPath().toString(); - } - - static boolean recoverTransactions(File root, List worldFolders) throws IOException { - boolean changed = recoverStagingScratch(new File(root, "staging")); - File transactionDirectory = new File(root, TRANSACTION_DIRECTORY); - Path transactionPath = transactionDirectory.toPath(); - if (!Files.exists(transactionPath, LinkOption.NOFOLLOW_LINKS)) { - return recoverInstallScratch(root, worldFolders) | changed; - } - verifyDirectoryContainerIfPresent(transactionDirectory, "datapack transaction"); - Manifest committedManifest = readCommittedManifest(root); - List transactionRoots; - try (Stream paths = Files.list(transactionPath)) { - transactionRoots = paths.limit(MAX_TRANSACTION_COUNT + 2L).sorted().toList(); - } - if (transactionRoots.size() == MAX_TRANSACTION_COUNT + 2) { - throw new IOException("Datapack transaction directory contains too many entries"); - } - int transactionCount = 0; - for (Path transactionRoot : transactionRoots) { - if (isHarmlessRecoveryArtifact(transactionRoot)) { - continue; - } - transactionCount++; - if (transactionCount > MAX_TRANSACTION_COUNT) { - throw new IOException("Datapack transaction count exceeds " + MAX_TRANSACTION_COUNT); - } - } - for (Path transactionRoot : transactionRoots) { - if (isHarmlessRecoveryArtifact(transactionRoot)) { - changed |= Files.deleteIfExists(transactionRoot); - continue; - } - recoverTransaction(root, worldFolders, committedManifest, transactionPath, transactionRoot); - changed = true; - } - changed |= transactionDirectory.delete(); - return recoverInstallScratch(root, worldFolders) | changed; - } - - private static boolean recoverInstallScratch(File root, List worldFolders) throws IOException { - Set scratchRoots = new TreeSet<>(); - scratchRoots.add(installScratchRoot(new File(root, "staging")).toPath().toAbsolutePath().normalize()); - for (File worldFolder : worldFolders) { - scratchRoots.add(installScratchRoot(worldFolder).toPath().toAbsolutePath().normalize()); - } - boolean changed = false; - for (Path scratchRoot : scratchRoots) { - changed |= recoverInstallScratchRoot(scratchRoot); - } - return changed; - } - - private static boolean recoverInstallScratchRoot(Path scratchRoot) throws IOException { - if (!Files.exists(scratchRoot, LinkOption.NOFOLLOW_LINKS)) { - return false; - } - verifyDirectoryContainerIfPresent(scratchRoot.toFile(), "datapack install scratch"); - List children; - try (Stream paths = Files.list(scratchRoot)) { - children = paths.limit(MAX_MANAGED_PATHS + 2L).sorted().toList(); - } - int managedEntries = 0; - for (Path child : children) { - if (!isHarmlessRecoveryArtifact(child)) { - managedEntries++; - } - if (managedEntries > MAX_MANAGED_PATHS) { - throw new IOException("Datapack install scratch contains too many entries"); - } - } - - List pending = new ArrayList<>(); - List backups = new ArrayList<>(); - boolean changed = false; - for (Path child : children) { - if (isHarmlessRecoveryArtifact(child)) { - changed |= Files.deleteIfExists(child); - continue; - } - StagingScratch scratch = parseInstallScratch(scratchRoot, child); - if (scratch == null) { - throw new IOException("Unexpected datapack install scratch artifact " + child); - } - if (Files.isSymbolicLink(child) || !Files.isDirectory(child, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid datapack install scratch artifact " + child); - } - validateScratchTree(child); - if (scratch.kind() == StagingScratchKind.BACKUP) { - backups.add(scratch); - } else { - pending.add(scratch); - } - } - if (!backups.isEmpty()) { - throw new IOException("Preserving unjournaled datapack install backup " - + backups.getFirst().path()); - } - for (StagingScratch scratch : pending) { - deleteInstallScratch(scratch.path().toFile(), "orphan datapack install pending directory"); - changed = true; - } - changed |= scratchRoot.toFile().delete(); - return changed; - } - - private static StagingScratch parseInstallScratch(Path scratchRoot, Path child) throws IOException { - Path normalized = child.toAbsolutePath().normalize(); - if (!Objects.equals(normalized.getParent(), scratchRoot)) { - throw new IOException("Datapack install scratch artifact escapes its root: " + child); - } - String name = normalized.getFileName().toString(); - int uuidStart = name.length() - 36; - if (uuidStart <= 1 || name.charAt(uuidStart - 1) != '-') { - return null; - } - try { - UUID.fromString(name.substring(uuidStart)); - } catch (IllegalArgumentException e) { - return null; - } - String stem = name.substring(0, uuidStart - 1); - StagingScratchKind kind = stem.endsWith("-backup") - ? StagingScratchKind.BACKUP : StagingScratchKind.PENDING; - String id = kind == StagingScratchKind.BACKUP - ? stem.substring(0, stem.length() - "-backup".length()) : stem; - if (id.isBlank() || !id.equals(sanitizeId(id)) || RESERVED_IDS.contains(id)) { - return null; - } - return new StagingScratch(kind, id, normalized); - } - - private static boolean recoverStagingScratch(File stagingDirectory) throws IOException { - Path stagingRoot = stagingDirectory.toPath().toAbsolutePath().normalize(); - if (!Files.exists(stagingRoot, LinkOption.NOFOLLOW_LINKS)) { - return false; - } - verifyDirectoryContainerIfPresent(stagingDirectory, "datapack staging"); - List children; - try (Stream paths = Files.list(stagingRoot)) { - children = paths.limit(MAX_MANAGED_PATHS + 1L).sorted().toList(); - } - if (children.size() > MAX_MANAGED_PATHS) { - throw new IOException("Datapack staging contains too many entries"); - } - - List pending = new ArrayList<>(); - Map> backups = new TreeMap<>(); - for (Path child : children) { - StagingScratch scratch = parseStagingScratch(stagingRoot, child); - if (scratch == null) { - continue; - } - if (Files.isSymbolicLink(child) || !Files.isDirectory(child, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid datapack staging scratch artifact " + child); - } - if (scratch.kind() == StagingScratchKind.PENDING) { - validateScratchTree(child); - pending.add(scratch); - } else { - backups.computeIfAbsent(scratch.id(), ignored -> new ArrayList<>()).add(scratch); - } - } - - for (Map.Entry> entry : backups.entrySet()) { - if (entry.getValue().size() != 1) { - throw new IOException("Ambiguous datapack staging backups for '" + entry.getKey() + "'"); - } - StagingScratch backup = entry.getValue().getFirst(); - Ownership backupOwnership = verifyManagedScratchDirectory(backup.path().toFile(), backup.id()); - Path target = stagingRoot.resolve(backup.id()).normalize(); - if (!Objects.equals(target.getParent(), stagingRoot)) { - throw new IOException("Datapack staging backup target escapes its root"); - } - if (Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { - Ownership targetOwnership = verifyManagedScratchDirectory(target.toFile(), backup.id()); - if (!Objects.equals(backupOwnership.url, targetOwnership.url)) { - throw new IOException("Datapack staging backup source does not match its target: " + target); - } - } - } - - boolean changed = false; - for (List matches : backups.values()) { - StagingScratch backup = matches.getFirst(); - Path target = stagingRoot.resolve(backup.id()).normalize(); - if (Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { - deleteVerifiedDirectory(backup.path().toFile()); - } else { - moveNew(backup.path(), target); - } - changed = true; - } - for (StagingScratch scratch : pending) { - deleteVerifiedDirectory(scratch.path().toFile()); - changed = true; - } - forceDirectoryIfSupported(stagingRoot); - return changed; - } - - private static StagingScratch parseStagingScratch(Path stagingRoot, Path child) throws IOException { - Path normalized = child.toAbsolutePath().normalize(); - if (!Objects.equals(normalized.getParent(), stagingRoot)) { - throw new IOException("Datapack staging artifact escapes its root: " + child); - } - String name = normalized.getFileName().toString(); - StagingScratchKind kind; - String prefix; - if (name.startsWith(".pending-")) { - kind = StagingScratchKind.PENDING; - prefix = ".pending-"; - } else if (name.startsWith(".backup-")) { - kind = StagingScratchKind.BACKUP; - prefix = ".backup-"; - } else { - return null; - } - int uuidStart = name.length() - 36; - if (uuidStart <= prefix.length() || name.charAt(uuidStart - 1) != '-') { - return null; - } - String id = name.substring(prefix.length(), uuidStart - 1); - if (!id.equals(sanitizeId(id)) || RESERVED_IDS.contains(id)) { - return null; - } - try { - UUID.fromString(name.substring(uuidStart)); - } catch (IllegalArgumentException e) { - return null; - } - return new StagingScratch(kind, id, normalized); - } - - private static void validateScratchTree(Path root) throws IOException { - FileStore rootStore = Files.getFileStore(root); - int[] pathCount = new int[]{0}; - Files.walkFileTree(root, new SimpleFileVisitor<>() { - private FileVisitResult inspect(Path entry, BasicFileAttributes attributes) throws IOException { - pathCount[0]++; - if (pathCount[0] > MAX_MANAGED_PATHS) { - throw new IOException("Datapack scratch contains too many paths: " + root); - } - if (attributes.isSymbolicLink() - || attributes.isOther() - || (!attributes.isDirectory() && !attributes.isRegularFile())) { - throw new IOException("Datapack scratch contains an unsupported file: " + entry); - } - if (!sameDatapackVolume(root, rootStore, entry)) { - throw new IOException("Datapack scratch crosses a filesystem boundary: " + entry); - } - return FileVisitResult.CONTINUE; - } - - @Override - public FileVisitResult preVisitDirectory( - Path directory, - BasicFileAttributes attributes - ) throws IOException { - return inspect(directory, attributes); - } - - @Override - public FileVisitResult visitFile(Path file, BasicFileAttributes attributes) throws IOException { - return inspect(file, attributes); - } - - @Override - public FileVisitResult visitFileFailed(Path file, IOException failure) throws IOException { - throw new IOException("Unable to inspect datapack scratch entry: " + file, failure); - } - }); - } - - private static boolean sameScratchVolume(Path first, Path second) throws IOException { - return sameScratchVolume(first, Files.getFileStore(first), second, Files.getFileStore(second)); - } - - static boolean sameScratchVolume( - Path first, - FileStore firstStore, - Path second, - FileStore secondStore - ) { - if (Objects.equals(firstStore, secondStore)) { - return true; - } - if (!isDefaultWindowsPath(first) || !isDefaultWindowsPath(second)) { - return false; - } - Path firstAbsolute = first.toAbsolutePath().normalize(); - Path secondAbsolute = second.toAbsolutePath().normalize(); - if ((firstAbsolute.toString().length() > WINDOWS_LEGACY_PATH_LIMIT) - == (secondAbsolute.toString().length() > WINDOWS_LEGACY_PATH_LIMIT)) { - return false; - } - Path firstRoot = firstAbsolute.getRoot(); - Path secondRoot = secondAbsolute.getRoot(); - if (firstRoot == null || secondRoot == null) { - return false; - } - return sameWindowsVolume( - firstStore, firstRoot.toString(), secondStore, secondRoot.toString()); - } - - static boolean sameWindowsVolume( - FileStore firstStore, - String firstRoot, - FileStore secondStore, - String secondRoot - ) { - if (firstRoot == null || secondRoot == null || !firstRoot.equalsIgnoreCase(secondRoot)) { - return false; - } - try { - Object firstSerial = firstStore.getAttribute("volume:vsn"); - Object secondSerial = secondStore.getAttribute("volume:vsn"); - return firstSerial != null && firstSerial.equals(secondSerial); - } catch (IOException | RuntimeException exception) { - return false; - } - } - - static boolean isSupportedScratchDirectory(BasicFileAttributes attributes) { - return attributes != null - && attributes.isDirectory() - && !attributes.isSymbolicLink() - && !attributes.isOther(); - } - - private static boolean isDefaultWindowsPath(Path path) { - return File.separatorChar == '\\' - && path.getFileSystem().equals(FileSystems.getDefault()); - } - - private static Ownership verifyManagedScratchDirectory(File directory, String id) throws IOException { - validateManagedDirectory(directory, id); - Ownership ownership = readOwnership(directory); - if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { - throw new IOException("Datapack staging backup is modified or corrupt: " + directory.getPath()); - } - return ownership; - } - - private static boolean isHarmlessRecoveryArtifact(Path path) throws IOException { - if (!isFinderMetadata(path)) { - return false; - } - if (Files.isSymbolicLink(path) || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Suspicious datapack recovery artifact " + path); - } - return true; - } - - private static void recoverTransaction( - File root, - List worldFolders, - Manifest committedManifest, - Path transactionDirectory, - Path transactionRoot - ) throws IOException { - Path normalizedRoot = transactionRoot.toAbsolutePath().normalize(); - if (!Objects.equals(normalizedRoot.getParent(), transactionDirectory.toAbsolutePath().normalize()) - || Files.isSymbolicLink(normalizedRoot) - || !Files.isDirectory(normalizedRoot, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid datapack transaction directory " + transactionRoot); - } - try { - UUID.fromString(normalizedRoot.getFileName().toString()); - } catch (IllegalArgumentException e) { - throw new IOException("Invalid datapack transaction directory name " + transactionRoot, e); - } - CoordinatorJournal journal = readCoordinatorJournal(normalizedRoot); - if (journal == null) { - deleteCoordinatorTransaction(normalizedRoot); - return; - } - validateCoordinatorJournal(root, worldFolders, committedManifest, normalizedRoot, journal); - boolean commit = coordinatorCommitDecision(committedManifest, journal); - resolveCoordinatorDirectories(journal, commit); - resolveCoordinatorEditables(journal, normalizedRoot, commit); - deleteCoordinatorTransaction(normalizedRoot); - } - - private static Manifest readCommittedManifest(File root) throws IOException { - Path manifestPath = new File(root, "manifest.json").toPath(); - if (!Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - return new Manifest(); - } - if (Files.isSymbolicLink(manifestPath) - || !Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Datapack manifest is not a regular file: " + manifestPath); - } - Manifest manifest; - try { - manifest = GSON.fromJson( - readBoundedUtf8(manifestPath, MAX_MANIFEST_BYTES, "Datapack manifest"), - Manifest.class - ); - } catch (RuntimeException e) { - throw new IOException("Invalid datapack manifest " + manifestPath, e); - } - if (manifest == null) { - throw new IOException("Empty datapack manifest " + manifestPath); - } - normalizeManifest(manifest); - return manifest; - } - - private static CoordinatorJournal readCoordinatorJournal(Path transactionRoot) throws IOException { - Path committed = transactionRoot.resolve(TRANSACTION_JOURNAL); - Path next = transactionRoot.resolve(TRANSACTION_JOURNAL_NEXT); - if (Files.exists(committed, LinkOption.NOFOLLOW_LINKS)) { - return parseCoordinatorJournal(committed); - } - if (!Files.exists(next, LinkOption.NOFOLLOW_LINKS)) { - try (Stream entries = Files.list(transactionRoot)) { - if (entries.findAny().isEmpty()) { - return null; - } - } - throw new IOException("Missing datapack transaction journal " + committed); - } - try { - return parseCoordinatorJournal(next); - } catch (IOException firstWriteFailure) { - try (Stream entries = Files.list(transactionRoot)) { - List contents = entries.limit(2).toList(); - if (contents.size() == 1 && Objects.equals(contents.getFirst(), next) - && !Files.isSymbolicLink(next)) { - return null; - } - } - throw firstWriteFailure; - } - } - - private static CoordinatorJournal parseCoordinatorJournal(Path journalPath) throws IOException { - if (Files.isSymbolicLink(journalPath) - || !Files.isRegularFile(journalPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid datapack transaction journal " + journalPath); - } - try { - CoordinatorJournal journal = GSON.fromJson( - readBoundedUtf8( - journalPath, - MAX_TRANSACTION_JOURNAL_BYTES, - "Datapack transaction journal" - ), - CoordinatorJournal.class - ); - if (journal == null) { - throw new IOException("Empty datapack transaction journal " + journalPath); - } - return journal; - } catch (RuntimeException e) { - throw new IOException("Invalid datapack transaction journal " + journalPath, e); - } - } - - private static void validateCoordinatorJournal( - File root, - List worldFolders, - Manifest committedManifest, - Path transactionRoot, - CoordinatorJournal journal - ) throws IOException { - if (journal.schemaVersion != TRANSACTION_SCHEMA || journal.transactionId == null - || journal.operation == null || journal.phase == null || journal.id == null - || journal.url == null || journal.directories == null || journal.editables == null) { - throw new IOException("Incomplete datapack transaction journal at " + transactionRoot); - } - UUID transactionId; - try { - transactionId = UUID.fromString(journal.transactionId); - } catch (IllegalArgumentException e) { - throw new IOException("Invalid datapack transaction id " + journal.transactionId, e); - } - if (!transactionId.toString().equals(transactionRoot.getFileName().toString())) { - throw new IOException("Datapack transaction id does not match its directory"); - } - if (!journal.id.equals(sanitizeId(journal.id)) || RESERVED_IDS.contains(journal.id)) { - throw new IOException("Invalid datapack transaction entry id " + journal.id); - } - if (journal.directories.size() > worldFolders.size() + 1 || journal.editables.size() > 10_000) { - throw new IOException("Datapack transaction journal contains too many participants"); - } - if (journal.operation == CoordinatorOperation.INSTALL && !journal.editables.isEmpty()) { - throw new IOException("Datapack install transaction unexpectedly contains editable participants"); - } - - Set allowedTargets = new HashSet<>(); - allowedTargets.add(new File(new File(root, "staging"), journal.id).toPath().toAbsolutePath().normalize()); - for (File worldFolder : worldFolders) { - allowedTargets.add(new File(worldFolder, journal.id).toPath().toAbsolutePath().normalize()); - } - Set seenTargets = new HashSet<>(); - Set seenTargetIdentities = new HashSet<>(); - for (CoordinatorDirectory directory : journal.directories) { - validateCoordinatorDirectory( - directory, journal.operation, allowedTargets, seenTargets, seenTargetIdentities); - } - Set seenEditables = new HashSet<>(); - Set allowedEditableRoots = journal.editables.isEmpty() - ? Set.of() : authoritativeEditableRoots(committedManifest, journal); - for (CoordinatorEditable editable : journal.editables) { - if (editable == null || editable.packRoot == null || editable.transactionId == null - || editable.claimId == null - || !seenEditables.add(editable.packRoot)) { - throw new IOException("Invalid duplicate editable participant in datapack transaction"); - } - Path packRoot = coordinatorPath(editable.packRoot, "editable pack root"); - Path realPackRoot = Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS) - ? packRoot.toRealPath() : packRoot; - if (Files.isSymbolicLink(packRoot) || !Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS) - || !packRoot.equals(realPackRoot) || !allowedEditableRoots.contains(realPackRoot)) { - throw new IOException("Invalid editable pack root in datapack transaction: " + packRoot); - } - try { - UUID.fromString(editable.transactionId); - UUID.fromString(editable.claimId); - } catch (IllegalArgumentException e) { - throw new IOException("Invalid editable transaction recovery identity", e); - } - StructureTransactionWriter writer = new StructureTransactionWriter(packRoot); - boolean recoveryDataPresent = writer.verifyRecoveryOwner( - new StructureTransactionWriter.PreparedRemovalToken( - packRoot, - UUID.fromString(editable.transactionId) - ), - new StructureTransactionWriter.RecoveryOwner( - transactionRoot, - UUID.fromString(journal.transactionId), - UUID.fromString(editable.claimId) - ), - committedManifest.findById(journal.id) == null - && journal.phase == CoordinatorPhase.PUBLISHED - ); - if (!recoveryDataPresent && journal.phase != CoordinatorPhase.COMMITTED) { - throw new IOException("Editable structure recovery data disappeared before commit"); - } - } - } - - private static Set authoritativeEditableRoots( - Manifest committedManifest, - CoordinatorJournal journal - ) throws IOException { - Set roots = new HashSet<>(); - Entry committed = committedManifest.findById(journal.id); - if (committed != null) { - if (!Objects.equals(committed.url, journal.url)) { - throw new IOException("Datapack transaction conflicts with the committed editable pack owner"); - } - addExistingPackRoots(roots, committed.importedTargets.keySet()); - addExistingPackRoots(roots, committed.importAttempts.keySet()); - addExistingPackRoots(roots, committed.importedBundles.keySet()); - return roots; - } - if (journal.operation != CoordinatorOperation.REMOVE || !journal.phase.published()) { - throw new IOException("Datapack transaction has no committed editable pack authority"); - } - for (CoordinatorEditable editable : journal.editables) { - Path packRoot = coordinatorPath(editable.packRoot, "editable pack root"); - if (Files.isSymbolicLink(packRoot) || !Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Invalid editable pack root in datapack transaction: " + packRoot); - } - Path realPackRoot = packRoot.toRealPath(); - if (!packRoot.equals(realPackRoot)) { - throw new IOException("Editable pack root changed before datapack recovery: " + packRoot); - } - roots.add(realPackRoot); - } - return roots; - } - - private static void addExistingPackRoots(Set roots, Set paths) throws IOException { - for (String path : paths) { - try { - Path root = Path.of(path).toAbsolutePath().normalize(); - if (Files.isDirectory(root)) { - roots.add(root.toRealPath()); - } - } catch (RuntimeException e) { - throw new IOException("Invalid editable pack root in the datapack manifest: " + path, e); - } - } - } - - private static void validateCoordinatorDirectory( - CoordinatorDirectory directory, - CoordinatorOperation operation, - Set allowedTargets, - Set seenTargets, - Set seenTargetIdentities - ) throws IOException { - if (directory == null || directory.target == null || directory.backup == null - || directory.originalHash == null || directory.desiredHash == null - || directory.originalMarkerHash == null || directory.desiredMarkerHash == null - || directory.originalIdentity == null || directory.desiredIdentity == null - || directory.targetRoot == null || directory.scratchRoot == null - || directory.targetRootIdentity == null || directory.scratchRootIdentity == null) { - throw new IOException("Incomplete directory participant in datapack transaction"); - } - Path target = coordinatorPath(directory.target, "target"); - if (!allowedTargets.contains(target) || !seenTargets.add(target)) { - throw new IOException("Datapack transaction target is outside its configured roots: " + target); - } - File targetFile = target.toFile(); - File targetParent = targetFile.getParentFile(); - Path targetRootIdentity = coordinatorPath(directory.targetRoot, "target root"); - if (!seenTargetIdentities.add(targetRootIdentity.resolve(target.getFileName()).normalize())) { - throw new IOException("Aliased datapack transaction target " + target); - } - validateRecoveryContainer( - targetParent.toPath(), - targetRootIdentity, - true, - "datapack target root" - ); - verifyDirectoryContainerIdentity( - targetParent, directory.targetRoot, directory.targetRootIdentity, "datapack target root"); - File scratchRoot = new File( - targetParent.getParentFile() == null ? targetParent : targetParent.getParentFile(), - operation == CoordinatorOperation.INSTALL ? ".iris-datapack-install" : ".iris-datapack-remove" - ); - Path expectedScratch = scratchRoot.toPath().toAbsolutePath().normalize(); - Path backup = coordinatorPath(directory.backup, "backup"); - if (!Objects.equals(backup.getParent(), expectedScratch) || Files.isSymbolicLink(backup)) { - throw new IOException("Invalid datapack transaction backup path " + backup); - } - Path pending = null; - if (operation == CoordinatorOperation.INSTALL) { - if (directory.pending == null || directory.pending.isBlank()) { - throw new IOException("Install transaction is missing its pending directory"); - } - pending = coordinatorPath(directory.pending, "pending directory"); - if (!Objects.equals(pending.getParent(), expectedScratch) || Files.isSymbolicLink(pending)) { - throw new IOException("Invalid datapack transaction pending path " + pending); - } - } else if (directory.pending != null && !directory.pending.isBlank()) { - throw new IOException("Removal transaction unexpectedly contains a pending directory"); - } - boolean scratchRequired = Files.exists(backup, LinkOption.NOFOLLOW_LINKS) - || pending != null && Files.exists(pending, LinkOption.NOFOLLOW_LINKS); - validateRecoveryContainer( - expectedScratch, - coordinatorPath(directory.scratchRoot, "scratch root"), - scratchRequired, - "datapack transaction scratch root" - ); - if (scratchRequired) { - verifyDirectoryContainerIdentity( - expectedScratch.toFile(), directory.scratchRoot, - directory.scratchRootIdentity, "datapack transaction scratch root"); - } - } - - private static void validateRecoveryContainer( - Path container, - Path expectedRealPath, - boolean required, - String purpose - ) throws IOException { - Path normalized = container.toAbsolutePath().normalize(); - Path normalizedExpected = expectedRealPath.toAbsolutePath().normalize(); - if (!Files.exists(normalized, LinkOption.NOFOLLOW_LINKS)) { - if (required) { - throw new IOException("Missing " + purpose + " " + normalized); - } - return; - } - if (Files.isSymbolicLink(normalized) - || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) - || !Objects.equals(normalized.toRealPath(), normalizedExpected)) { - throw new IOException("Changed or unsafe " + purpose + " " + normalized); - } - } - - private static boolean coordinatorCommitDecision(Manifest manifest, CoordinatorJournal journal) throws IOException { - Entry committed = manifest.findById(journal.id); - if (journal.operation == CoordinatorOperation.REMOVE) { - if (committed == null) { - if (!journal.phase.published()) { - throw new IOException("Datapack removal manifest changed before every participant was published"); - } - return true; - } - if (!Objects.equals(committed.url, journal.url) || journal.phase == CoordinatorPhase.COMMITTED) { - throw new IOException("Datapack removal journal conflicts with the committed manifest"); - } - return false; - } - - boolean matches = committed != null - && Objects.equals(committed.url, journal.url) - && Objects.equals(committed.versionId, journal.versionId) - && Objects.equals(committed.versionNumber, journal.versionNumber) - && Objects.equals(committed.sha1, journal.sha1); - if (journal.manifestAlreadyMatched) { - if (!matches) { - throw new IOException("Committed datapack changed while an install transaction was incomplete"); - } - return journal.phase.published(); - } - if (matches) { - if (!journal.phase.published()) { - throw new IOException("Datapack install manifest changed before every target was published"); - } - return true; - } - if (journal.phase == CoordinatorPhase.COMMITTED) { - throw new IOException("Committed datapack install journal conflicts with the manifest"); - } - return false; - } - - private static void resolveCoordinatorDirectories(CoordinatorJournal journal, boolean commit) throws IOException { - List directories = new ArrayList<>(journal.directories); - if (!commit) { - Collections.reverse(directories); - } - IOException failure = null; - for (CoordinatorDirectory directory : directories) { - try { - if (journal.operation == CoordinatorOperation.INSTALL) { - resolveInstallDirectory(journal, directory, commit); - } else { - resolveRemovalDirectory(directory, commit); - } - } catch (IOException | RuntimeException e) { - IOException participantFailure = e instanceof IOException ioFailure - ? ioFailure : new IOException("Failed resolving datapack directory participant", e); - if (failure == null) { - failure = participantFailure; - } else { - failure.addSuppressed(participantFailure); - } - } - } - if (failure != null) { - throw failure; - } - } - - private static void resolveInstallDirectory( - CoordinatorJournal journal, - CoordinatorDirectory directory, - boolean commit - ) throws IOException { - File target = new File(directory.target); - File pending = new File(directory.pending); - File backup = new File(directory.backup); - File targetRoot = new File(directory.targetRoot); - if (commit) { - verifyDesiredDirectory( - target, targetRoot, journal, directory.desiredHash, - directory.desiredMarkerHash, directory.desiredIdentity); - deleteOriginalBackupIfPresent( - backup, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity); - deleteDesiredDirectoryIfPresent( - pending, targetRoot, journal, directory.desiredHash, - directory.desiredMarkerHash, directory.desiredIdentity); - cleanupScratchParent(backup); - return; - } - - if (directory.hadTarget) { - if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { - verifyDirectorySnapshot( - backup, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity, - "datapack install backup"); - deleteDesiredDirectoryIfPresent( - target, targetRoot, journal, directory.desiredHash, - directory.desiredMarkerHash, directory.desiredIdentity); - moveNew(backup.toPath(), target.toPath()); - forceDirectoryIfSupported(target.getParentFile().toPath()); - forceDirectoryIfSupported(backup.getParentFile().toPath()); - } else { - verifyDirectorySnapshot( - target, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity, - "original datapack target"); - } - } else { - if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Unexpected backup for newly-installed datapack " + backup.getPath()); - } - deleteDesiredDirectoryIfPresent( - target, targetRoot, journal, directory.desiredHash, - directory.desiredMarkerHash, directory.desiredIdentity); - } - deleteDesiredDirectoryIfPresent( - pending, targetRoot, journal, directory.desiredHash, - directory.desiredMarkerHash, directory.desiredIdentity); - cleanupScratchParent(backup); - } - - private static void resolveRemovalDirectory(CoordinatorDirectory directory, boolean commit) throws IOException { - File target = new File(directory.target); - File backup = new File(directory.backup); - File targetRoot = new File(directory.targetRoot); - if (commit) { - if (Files.exists(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Removed datapack target reappeared before transaction cleanup: " + target.getPath()); - } - deleteOriginalBackupIfPresent( - backup, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity); - cleanupScratchParent(backup); - return; - } - if (Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { - verifyDirectorySnapshot( - backup, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity, - "datapack removal backup"); - if (Files.exists(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Datapack removal target was concurrently recreated: " + target.getPath()); - } - moveNew(backup.toPath(), target.toPath()); - forceDirectoryIfSupported(target.getParentFile().toPath()); - forceDirectoryIfSupported(backup.getParentFile().toPath()); - } else { - verifyDirectorySnapshot( - target, targetRoot, directory.originalHash, - directory.originalMarkerHash, directory.originalIdentity, - "original datapack target"); - } - cleanupScratchParent(backup); - } - - private static void resolveCoordinatorEditables( - CoordinatorJournal journal, - Path transactionRoot, - boolean commit - ) throws IOException { - IOException failure = null; - for (CoordinatorEditable editable : journal.editables) { - try { - Path packRoot = coordinatorPath(editable.packRoot, "editable pack root"); - StructureTransactionWriter writer = new StructureTransactionWriter(packRoot); - writer.resolvePreparedRemoval( - new StructureTransactionWriter.PreparedRemovalToken( - packRoot, - UUID.fromString(editable.transactionId) - ), - new StructureTransactionWriter.RecoveryOwner( - transactionRoot, - UUID.fromString(journal.transactionId), - UUID.fromString(editable.claimId) - ), - commit - ); - IrisData.invalidateLoadedStructureResources(packRoot.toFile()); - } catch (IOException | RuntimeException e) { - IOException participantFailure = e instanceof IOException ioFailure - ? ioFailure : new IOException("Failed resolving editable structure participant", e); - if (failure == null) { - failure = participantFailure; - } else { - failure.addSuppressed(participantFailure); - } - } - } - if (failure != null) { - throw failure; - } - } - - private static void verifyDesiredDirectory( - File directory, - File targetRoot, - CoordinatorJournal journal, - String expectedHash, - String expectedMarkerHash, - String expectedIdentity - ) throws IOException { - verifyDirectorySnapshot( - directory, targetRoot, expectedHash, expectedMarkerHash, - expectedIdentity, "installed datapack target"); - Ownership ownership = readOwnership(directory); - if (!Objects.equals(ownership.id, journal.id) || !Objects.equals(ownership.url, journal.url) - || !Objects.equals(ownership.contentHash, expectedHash)) { - throw new IOException("Installed datapack ownership does not match its transaction at " + directory.getPath()); - } - } - - private static void deleteDesiredDirectoryIfPresent( - File directory, - File targetRoot, - CoordinatorJournal journal, - String expectedHash, - String expectedMarkerHash, - String expectedIdentity - ) throws IOException { - if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - return; - } - verifyDesiredDirectory( - directory, targetRoot, journal, expectedHash, - expectedMarkerHash, expectedIdentity); - deleteVerifiedDirectory(directory); - } - - private static void deleteOriginalBackupIfPresent( - File backup, - File targetRoot, - String expectedHash, - String expectedMarkerHash, - String expectedIdentity - ) throws IOException { - if (!Files.exists(backup.toPath(), LinkOption.NOFOLLOW_LINKS)) { - return; - } - verifyDirectorySnapshot( - backup, targetRoot, expectedHash, expectedMarkerHash, - expectedIdentity, "datapack transaction backup"); - deleteVerifiedDirectory(backup); - } - - private static void deleteVerifiedDirectory(File directory) throws IOException { - File parent = Objects.requireNonNull(directory.getParentFile(), "datapack transaction parent"); - validateInstallTree(directory, parent, "Datapack transaction directory"); - IO.delete(directory); - if (Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Could not delete datapack transaction directory " + directory.getPath()); - } - } - - private static void cleanupScratchParent(File participant) { - File parent = participant.getParentFile(); - if (parent != null) { - parent.delete(); - } - } - - private static void deleteCoordinatorTransaction(Path transactionRoot) throws IOException { - deleteInstallScratch(transactionRoot.toFile(), "completed datapack transaction"); - forceDirectoryIfSupported(Objects.requireNonNull(transactionRoot.getParent(), "transaction parent")); - } - - private static void writeCoordinatorJournal(Path transactionRoot, CoordinatorJournal journal) throws IOException { - byte[] content = GSON.toJson(journal).getBytes(StandardCharsets.UTF_8); - if (content.length > MAX_TRANSACTION_JOURNAL_BYTES) { - throw new IOException("Datapack transaction journal exceeds " + MAX_TRANSACTION_JOURNAL_BYTES + " bytes"); - } - Files.createDirectories(transactionRoot); - Path next = transactionRoot.resolve(TRANSACTION_JOURNAL_NEXT); - if (Files.isSymbolicLink(next)) { - throw new IOException("Datapack transaction journal cannot be a symbolic link: " + next); - } - Files.deleteIfExists(next); - Files.write(next, content, StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE); - forceFile(next); - move(next, transactionRoot.resolve(TRANSACTION_JOURNAL)); - forceDirectoryIfSupported(transactionRoot); - forceDirectoryIfSupported(Objects.requireNonNull(transactionRoot.getParent(), "transaction parent")); - } - - private static String readBoundedUtf8(Path path, long maxBytes, String purpose) throws IOException { - return new String(readBoundedBytes(path, maxBytes, purpose), StandardCharsets.UTF_8); - } - - private static byte[] readBoundedBytes(Path path, long maxBytes, String purpose) throws IOException { - int readLimit = Math.toIntExact(maxBytes + 1); - byte[] content; - try (InputStream input = Files.newInputStream( - path, - StandardOpenOption.READ, - LinkOption.NOFOLLOW_LINKS - )) { - content = input.readNBytes(readLimit); - } - if (content.length > maxBytes) { - throw new IOException(purpose + " exceeds " + maxBytes + " bytes"); - } - return content; - } - - private static Path coordinatorPath(String value, String purpose) throws IOException { - try { - return Path.of(value).toAbsolutePath().normalize(); - } catch (RuntimeException e) { - throw new IOException("Invalid datapack transaction " + purpose + " path", e); - } - } - - private static void forceFile(Path file) throws IOException { - if (!Durability.enabled()) { - return; - } - - try (FileChannel channel = FileChannel.open(file, StandardOpenOption.WRITE)) { - Durability.force(channel); - } - } - - private static void forceDirectoryIfSupported(Path directory) throws IOException { - if (!Durability.enabled()) { - return; - } - - if (!Files.getFileStore(directory).supportsFileAttributeView("posix")) { - return; - } - try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { - Durability.force(channel); - } - } - - private enum CoordinatorOperation { - INSTALL, - REMOVE - } - - private enum StagingScratchKind { - PENDING, - BACKUP - } - - private enum CoordinatorPhase { - PREPARED, - PUBLISHING, - PUBLISHED, - COMMITTED; - - private boolean published() { - return this == PUBLISHED || this == COMMITTED; - } - } - - private static final class CoordinatorJournal { - private int schemaVersion; - private String transactionId; - private CoordinatorOperation operation; - private CoordinatorPhase phase; - private String id; - private String url; - private String versionId; - private String versionNumber; - private String sha1; - private boolean manifestAlreadyMatched; - private List directories = new ArrayList<>(); - private List editables = new ArrayList<>(); - } - - private static final class CoordinatorDirectory { - private String target; - private String pending; - private String backup; - private boolean hadTarget; - private String originalHash; - private String desiredHash; - private String originalMarkerHash; - private String desiredMarkerHash; - private String originalIdentity; - private String desiredIdentity; - private String targetRoot; - private String scratchRoot; - private String targetRootIdentity; - private String scratchRootIdentity; - } - - private static final class CoordinatorEditable { - private String packRoot; - private String transactionId; - private String claimId; - } - - private static final class DatapackCoordinator { - private final Path transactionRoot; - private final CoordinatorJournal journal; - - private DatapackCoordinator(Path transactionRoot, CoordinatorJournal journal) { - this.transactionRoot = transactionRoot; - this.journal = journal; - } - - private void phase(CoordinatorPhase phase) throws IOException { - journal.phase = phase; - writeCoordinatorJournal(transactionRoot, journal); - } - - private void finish() throws IOException { - deleteCoordinatorTransaction(transactionRoot); - } - } - - static final class VerifiedStagingInstall { - private final Path normalizedRoot; - private final Path realRoot; - private final String rootIdentity; - private final Path normalizedStagingRoot; - private final Path realStagingRoot; - private final String stagingRootIdentity; - private final Path normalizedSource; - private final Path realSource; - private final String sourceIdentity; - private final String id; - private final String url; - private final String versionId; - private final String versionNumber; - private final String sha1; - private final String desiredHash; - private final Entry committedEntrySnapshot; - private final boolean legacyReplacementAuthorized; - private final LegacyStagingSnapshot legacyStagingSnapshot; - private boolean consumed; - - private VerifiedStagingInstall( - Path normalizedRoot, - Path normalizedStagingRoot, - Path normalizedSource, - Entry entry, - String desiredHash, - Entry committedEntrySnapshot, - boolean legacyReplacementAuthorized, - LegacyStagingSnapshot legacyStagingSnapshot - ) throws IOException { - this.normalizedRoot = normalizedRoot; - this.realRoot = normalizedRoot.toRealPath(); - this.rootIdentity = directoryIdentity(normalizedRoot.toFile()); - this.normalizedStagingRoot = normalizedStagingRoot; - this.realStagingRoot = normalizedStagingRoot.toRealPath(); - this.stagingRootIdentity = directoryIdentity(normalizedStagingRoot.toFile()); - this.normalizedSource = normalizedSource; - this.realSource = normalizedSource.toRealPath(); - this.sourceIdentity = directoryIdentity(normalizedSource.toFile()); - this.id = entry.id; - this.url = entry.url; - this.versionId = entry.versionId; - this.versionNumber = entry.versionNumber; - this.sha1 = entry.sha1; - this.desiredHash = desiredHash; - this.committedEntrySnapshot = committedEntrySnapshot == null ? null : copyEntry(committedEntrySnapshot); - this.legacyReplacementAuthorized = legacyReplacementAuthorized; - this.legacyStagingSnapshot = legacyStagingSnapshot; - } - - private Path stagingRoot() { - return normalizedStagingRoot; - } - - private boolean hasStablePathIdentities() { - return !rootIdentity.isEmpty() - && !stagingRootIdentity.isEmpty() - && !sourceIdentity.isEmpty(); - } - - private boolean isCanonicalInstall(File installRoot, File target) { - Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); - Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); - return suppliedRoot.equals(normalizedStagingRoot) - && suppliedTarget.equals(normalizedStagingRoot.resolve(id).normalize()); - } - - private void verifyStagingRoot() throws IOException { - verifyPathIdentity(normalizedRoot, realRoot, rootIdentity, "datapack storage root"); - verifyPathIdentity( - normalizedStagingRoot, realStagingRoot, stagingRootIdentity, "datapack staging root"); - if (!Objects.equals(normalizedStagingRoot.getParent(), normalizedRoot) - || !Files.isSameFile(normalizedStagingRoot.getParent(), normalizedRoot)) { - throw new IOException("Verified datapack staging root changed identity"); - } - } - - private boolean consume( - File source, - File installRoot, - File target, - Entry entry, - String stagedHash - ) throws IOException { - if (consumed) { - throw new IOException("Verified datapack staging authorization was already consumed"); - } - consumed = true; - Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); - Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); - if (!suppliedRoot.equals(normalizedStagingRoot) - || !suppliedTarget.equals(normalizedStagingRoot.resolve(id).normalize())) { - throw new IOException("Verified datapack staging authorization was paired with a different path"); - } - verifyAuthority(source, entry, stagedHash); - return legacyReplacementAuthorized; - } - - private boolean authorizeLegacyWorldReplacement( - File source, - File installRoot, - File target, - Entry entry, - String stagedHash, - String currentHash, - String currentMarkerHash - ) throws IOException { - if (legacyStagingSnapshot == null - || !"absent".equals(currentMarkerHash) - || !Objects.equals(currentHash, legacyStagingSnapshot.contentHash()) - || legacyStagingSnapshot.targetIdentity().isEmpty()) { - return false; - } - Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); - Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); - if (!Objects.equals(suppliedTarget.getParent(), suppliedRoot) - || !Objects.equals(suppliedTarget.getFileName().toString(), id) - || Files.isSameFile(suppliedRoot, normalizedStagingRoot) - || Files.isSameFile(suppliedTarget, legacyStagingSnapshot.normalizedTarget())) { - return false; - } - verifyAuthority(source, entry, stagedHash); - verifyLegacyWorldSnapshot(); - return true; - } - - private void verifyAuthority(File source, Entry entry, String stagedHash) throws IOException { - verifyAuthorityState(); - Path suppliedSource = source.toPath().toAbsolutePath().normalize(); - if (!suppliedSource.equals(normalizedSource)) { - throw new IOException("Verified datapack staging authorization was paired with a different path"); - } - if (!Objects.equals(entry.id, id) - || !Objects.equals(entry.url, url) - || !Objects.equals(entry.versionId, versionId) - || !Objects.equals(entry.versionNumber, versionNumber) - || !Objects.equals(entry.sha1, sha1) - || !Objects.equals(stagedHash, desiredHash)) { - throw new IOException("Verified datapack staging authorization was paired with different metadata"); - } - } - - private void verifyAuthorityState() throws IOException { - verifyStagingRoot(); - verifyPathIdentity(normalizedSource, realSource, sourceIdentity, "verified datapack extraction"); - Manifest committedManifest = readCommittedManifest(normalizedRoot.toFile()); - Entry committed = committedManifest.findById(id); - if (!manifestEntrySnapshotMatches(committed, committedEntrySnapshot)) { - throw new IOException("Committed datapack staging authority changed before installation"); - } - if (committedEntrySnapshot != null && !legacyReplacementAuthorized) { - throw new IOException("Committed datapack staging authority conflicts with " + id); - } - } - - private static boolean manifestEntrySnapshotMatches(Entry current, Entry expected) { - if (current == null || expected == null) { - return current == expected; - } - return Objects.equals(current.id, expected.id) - && Objects.equals(current.url, expected.url) - && Objects.equals(current.versionId, expected.versionId) - && Objects.equals(current.versionNumber, expected.versionNumber) - && Objects.equals(current.sha1, expected.sha1) - && Objects.equals(current.filename, expected.filename) - && Objects.equals(current.etag, expected.etag) - && Objects.equals(current.lastModified, expected.lastModified) - && current.installedEpoch == expected.installedEpoch - && current.structuresImported == expected.structuresImported - && copyList(current.structureKeys).equals(copyList(expected.structureKeys)) - && copyList(current.templateKeys).equals(copyList(expected.templateKeys)) - && Objects.equals(current.importedTargets, expected.importedTargets) - && Objects.equals(current.importAttempts, expected.importAttempts) - && Objects.equals(current.importedBundles, expected.importedBundles); - } - - private void verifyLegacyWorldSnapshot() throws IOException { - verifyAuthorityState(); - if (legacyStagingSnapshot == null || legacyStagingSnapshot.targetIdentity().isEmpty()) { - throw new IOException("Missing stable canonical legacy datapack staging snapshot for " + id); - } - if (!Objects.equals(legacyStagingSnapshot.normalizedTarget().getParent(), normalizedStagingRoot) - || !Files.isSameFile( - legacyStagingSnapshot.normalizedTarget().getParent(), normalizedStagingRoot) - || !sameScratchVolume( - legacyStagingSnapshot.normalizedTarget(), normalizedStagingRoot)) { - throw new IOException("Changed or unsafe canonical legacy datapack staging target for " + id); - } - verifyDirectorySnapshot( - legacyStagingSnapshot.normalizedTarget().toFile(), - normalizedStagingRoot.toFile(), - legacyStagingSnapshot.contentHash(), - legacyStagingSnapshot.markerHash(), - legacyStagingSnapshot.targetIdentity(), - "canonical legacy datapack staging target" - ); - if (!Objects.equals( - legacyStagingSnapshot.normalizedTarget().toRealPath(), - legacyStagingSnapshot.realTarget())) { - throw new IOException("Changed canonical legacy datapack staging target identity for " + id); - } - } - - private static void verifyPathIdentity( - Path normalized, - Path expectedReal, - String expectedIdentity, - String purpose - ) throws IOException { - if (Files.isSymbolicLink(normalized) - || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) - || !Objects.equals(normalized.toRealPath(), expectedReal) - || (!expectedIdentity.isEmpty() - && !Objects.equals(directoryIdentity(normalized.toFile()), expectedIdentity))) { - throw new IOException("Changed or unsafe " + purpose + " " + normalized); - } + DatapackSupport.message(sender, C.GRAY + " " + (conflicts - 20) + " additional conflict(s) omitted."); } } public static final class Report { - private final KList updated = new KList<>(); - private final KList upToDate = new KList<>(); + final KList updated = new KList<>(); + final KList upToDate = new KList<>(); private final KList failed = new KList<>(); - private boolean requiresRestart; + boolean requiresRestart; public boolean changed() { return requiresRestart; @@ -5760,65 +662,12 @@ public final class DatapackIngestService { public Map> importedBundles = new HashMap<>(); } - static final class StartupValidationCache { - int schemaVersion; - String minecraftVersion; - int irisVersion; - boolean autoIngest; - boolean stripOverrides; - List urls; - String localFingerprint; - } - public enum StartupValidationOutcome { READY, RESTART_REQUIRED, FAILED } - private static final class Manifest { - private List entries = new ArrayList<>(); - - private Entry find(String url) { - for (Entry entry : entries) { - if (entry.url != null && entry.url.equals(url)) { - return entry; - } - } - return null; - } - - private Entry findById(String id) { - for (Entry entry : entries) { - if (entry.id != null && entry.id.equals(id)) { - return entry; - } - } - return null; - } - - private void put(Entry entry) { - for (int i = 0; i < entries.size(); i++) { - Entry current = entries.get(i); - if (current.url != null && current.url.equals(entry.url)) { - entries.set(i, entry); - return; - } - } - entries.add(entry); - } - - private boolean removeById(String id) { - return entries.removeIf(entry -> id.equals(entry.id)); - } - } - - static record DownloadResult(boolean notModified, String etag, String lastModified) { - } - - static record InstallResult(boolean changed) { - } - public record ReapplyOutcome( ReapplyStatus status, Optional failure @@ -5881,572 +730,10 @@ public final class DatapackIngestService { FAILED } - static final class InstallExecution { - private final InstallResult result; - private final DatapackCoordinator coordinator; - private final File stagedDir; - private final Entry entry; - private final String stagedHash; - private final boolean verifyStagedSource; - private final List publishedPlans; - private final List unchangedPlans; - private boolean verified; - - private InstallExecution( - InstallResult result, - DatapackCoordinator coordinator, - File stagedDir, - Entry entry, - String stagedHash, - boolean verifyStagedSource, - List publishedPlans, - List unchangedPlans - ) { - this.result = result; - this.coordinator = coordinator; - this.stagedDir = stagedDir; - this.entry = copyEntry(entry); - this.stagedHash = stagedHash; - this.verifyStagedSource = verifyStagedSource; - this.publishedPlans = List.copyOf(publishedPlans); - this.unchangedPlans = List.copyOf(unchangedPlans); - } - - InstallResult result() { - return result; - } - - private DatapackCoordinator coordinator() { - return coordinator; - } - - private File stagedDir() { - return stagedDir; - } - - private Entry entry() { - return entry; - } - - private String stagedHash() { - return stagedHash; - } - - private boolean verifyStagedSource() { - return verifyStagedSource; - } - - private List publishedPlans() { - return publishedPlans; - } - - private List unchangedPlans() { - return unchangedPlans; - } - - private boolean verified() { - return verified; - } - - private void markVerified() { - verified = true; - } - } - - private record PackResources( - List structureKeys, - List structureSetKeys, - List templateKeys - ) { - } - - private record StagingInspection( - boolean usable, - boolean ownershipCorrected, - boolean manifestChanged - ) { - } - public record StructureScopeResources( String source, List structureKeys, List structureSetKeys ) { } - - private static final class EditableImportRemoval { - private final List prepared; - private boolean closed; - - private EditableImportRemoval(List prepared) { - this.prepared = List.copyOf(prepared); - } - - private List recoveryTokens() { - List tokens = new ArrayList<>(); - for (PreparedEditableImport editableImport : prepared) { - editableImport.removal().recoveryToken().ifPresent(tokens::add); - } - return List.copyOf(tokens); - } - - private void claimRecoveryOwners(Path transactionRoot, CoordinatorJournal journal) throws IOException { - int ownerIndex = 0; - for (PreparedEditableImport editableImport : prepared) { - Optional token = - editableImport.removal().recoveryToken(); - if (token.isEmpty()) { - continue; - } - if (ownerIndex >= journal.editables.size()) { - throw new IOException("Missing datapack coordinator claim for editable structure removal"); - } - CoordinatorEditable editable = journal.editables.get(ownerIndex++); - StructureTransactionWriter.PreparedRemovalToken recoveryToken = token.get(); - if (!Objects.equals(recoveryToken.packRoot().toString(), editable.packRoot) - || !Objects.equals(recoveryToken.transactionId().toString(), editable.transactionId)) { - throw new IOException("Datapack coordinator editable claim order changed during preparation"); - } - editableImport.removal().claimRecoveryOwner( - new StructureTransactionWriter.RecoveryOwner( - transactionRoot, - UUID.fromString(journal.transactionId), - UUID.fromString(editable.claimId) - ) - ); - } - if (ownerIndex != journal.editables.size()) { - throw new IOException("Unexpected datapack coordinator editable recovery claim"); - } - } - - private void markCommitted() throws IOException { - if (closed) { - throw new IllegalStateException("Editable import removal transaction is closed"); - } - for (PreparedEditableImport editableImport : prepared) { - editableImport.removal().markCommitted(); - } - } - - private void finishCommit() throws IOException { - if (closed) { - return; - } - IOException failure = null; - for (PreparedEditableImport editableImport : prepared) { - try { - editableImport.removal().finishCommit(); - } catch (IOException | RuntimeException cleanupFailure) { - IOException transactionFailure = cleanupFailure instanceof IOException ioFailure - ? ioFailure - : new IOException("Failed finalizing editable import removal", cleanupFailure); - if (failure == null) { - failure = transactionFailure; - } else { - failure.addSuppressed(transactionFailure); - } - } - if (editableImport.removal().changed()) { - try { - IrisData.getLoaded(editableImport.dataFolder()) - .ifPresent(IrisData::invalidateStructureResources); - } catch (RuntimeException invalidationFailure) { - IOException transactionFailure = new IOException( - "Failed invalidating editable import structure resources", - invalidationFailure - ); - if (failure == null) { - failure = transactionFailure; - } else { - failure.addSuppressed(transactionFailure); - } - } - } - } - closed = true; - if (failure != null) { - throw failure; - } - } - - private void rollback() throws IOException { - if (closed) { - return; - } - IOException failure = null; - for (int i = prepared.size() - 1; i >= 0; i--) { - try { - prepared.get(i).removal().rollback(); - } catch (IOException rollbackFailure) { - if (failure == null) { - failure = rollbackFailure; - } else { - failure.addSuppressed(rollbackFailure); - } - } - } - closed = true; - if (failure != null) { - throw failure; - } - } - - private void leaveForRecovery() throws IOException { - if (closed) { - return; - } - IOException failure = null; - for (PreparedEditableImport editableImport : prepared) { - try { - editableImport.removal().leaveForRecovery(); - } catch (IOException releaseFailure) { - if (failure == null) { - failure = releaseFailure; - } else { - failure.addSuppressed(releaseFailure); - } - } - } - closed = true; - if (failure != null) { - throw failure; - } - } - } - - private static final class DirectoryRemoval { - private final List moved; - private int prepared; - private boolean closed; - - private DirectoryRemoval(List moved) { - this.moved = List.copyOf(moved); - } - - private List moves() { - return moved; - } - - private void prepare() throws IOException { - if (closed || prepared > 0) { - throw new IllegalStateException("Datapack directory removal transaction is not new"); - } - try { - for (DirectoryMove directoryMove : moved) { - verifyDirectoryContainerIdentity( - directoryMove.target().getParentFile(), - directoryMove.targetRootIdentity(), - directoryMove.targetRootFileIdentity(), - "datapack removal target root" - ); - verifyDirectoryContainerIdentity( - directoryMove.backup().getParentFile(), - directoryMove.scratchRootIdentity(), - directoryMove.scratchRootFileIdentity(), - "datapack removal scratch root" - ); - verifyDirectorySnapshot( - directoryMove.target(), - new File(directoryMove.targetRootIdentity()), - directoryMove.originalHash(), - directoryMove.originalMarkerHash(), - directoryMove.originalIdentity(), - "datapack removal target" - ); - moveNew(directoryMove.target().toPath(), directoryMove.backup().toPath()); - prepared++; - forceDirectoryIfSupported(directoryMove.target().getParentFile().toPath()); - forceDirectoryIfSupported(directoryMove.backup().getParentFile().toPath()); - verifyDirectorySnapshot( - directoryMove.backup(), - new File(directoryMove.targetRootIdentity()), - directoryMove.originalHash(), - directoryMove.originalMarkerHash(), - directoryMove.originalIdentity(), - "datapack removal backup" - ); - } - } catch (IOException removalFailure) { - try { - rollback(); - } catch (IOException restoreFailure) { - removalFailure.addSuppressed(restoreFailure); - } - throw removalFailure; - } - } - - private void rollback() throws IOException { - if (closed) { - return; - } - IOException failure = null; - for (int i = prepared - 1; i >= 0; i--) { - DirectoryMove directoryMove = moved.get(i); - if (!Files.exists(directoryMove.backup().toPath(), LinkOption.NOFOLLOW_LINKS)) { - continue; - } - try { - verifyDirectoryContainerIdentity( - directoryMove.target().getParentFile(), - directoryMove.targetRootIdentity(), - directoryMove.targetRootFileIdentity(), - "datapack removal target root" - ); - verifyDirectoryContainerIdentity( - directoryMove.backup().getParentFile(), - directoryMove.scratchRootIdentity(), - directoryMove.scratchRootFileIdentity(), - "datapack removal scratch root" - ); - verifyDirectorySnapshot( - directoryMove.backup(), - new File(directoryMove.targetRootIdentity()), - directoryMove.originalHash(), - directoryMove.originalMarkerHash(), - directoryMove.originalIdentity(), - "datapack removal backup" - ); - if (pathExists(directoryMove.target().toPath(), "datapack removal target")) { - throw new IOException("Datapack removal target was concurrently recreated at " - + directoryMove.target().getPath()); - } - DatapackIngestService.moveNew( - directoryMove.backup().toPath(), - directoryMove.target().toPath() - ); - forceDirectoryIfSupported(directoryMove.target().getParentFile().toPath()); - forceDirectoryIfSupported(directoryMove.backup().getParentFile().toPath()); - } catch (IOException restoreFailure) { - if (failure == null) { - failure = restoreFailure; - } else { - failure.addSuppressed(restoreFailure); - } - } - } - for (int i = 0; i < prepared; i++) { - DirectoryMove directoryMove = moved.get(i); - directoryMove.backup().getParentFile().delete(); - } - closed = true; - if (failure != null) { - throw failure; - } - } - - private void finishCommit() throws IOException { - if (closed) { - return; - } - IOException failure = null; - for (int i = 0; i < prepared; i++) { - DirectoryMove directoryMove = moved.get(i); - try { - verifyDirectoryContainerIdentity( - directoryMove.backup().getParentFile(), - directoryMove.scratchRootIdentity(), - directoryMove.scratchRootFileIdentity(), - "datapack removal scratch root" - ); - deleteOriginalBackupIfPresent( - directoryMove.backup(), - new File(directoryMove.targetRootIdentity()), - directoryMove.originalHash(), - directoryMove.originalMarkerHash(), - directoryMove.originalIdentity() - ); - } catch (IOException cleanupFailure) { - failure = appendIOException(failure, cleanupFailure); - } - directoryMove.backup().getParentFile().delete(); - } - closed = true; - if (failure != null) { - throw failure; - } - } - } - - private static final class ManifestWrite implements AutoCloseable { - private final Path staged; - private final Path target; - private final Path rollback; - private boolean published; - - private ManifestWrite(Path staged, Path target, Path rollback) { - this.staged = staged; - this.target = target; - this.rollback = rollback; - } - - private void publish() throws IOException { - if (published) { - throw new IllegalStateException("Datapack manifest write was already published"); - } - try { - move(staged, target); - published = true; - } catch (IOException publishFailure) { - try { - restoreOriginal(); - } catch (IOException restoreFailure) { - publishFailure.addSuppressed(restoreFailure); - } - throw publishFailure; - } - forceDirectoryIfSupported(Objects.requireNonNull(target.getParent(), "manifest parent")); - } - - private boolean published() { - return published; - } - - private void discard() throws IOException { - IOException failure = null; - try { - Files.deleteIfExists(staged); - } catch (IOException cleanupFailure) { - failure = cleanupFailure; - } - if (rollback != null) { - try { - Files.deleteIfExists(rollback); - } catch (IOException cleanupFailure) { - if (failure == null) { - failure = cleanupFailure; - } else { - failure.addSuppressed(cleanupFailure); - } - } - } - if (failure != null) { - throw failure; - } - } - - @Override - public void close() throws IOException { - discard(); - } - - private void restoreOriginal() throws IOException { - if (rollback == null) { - Files.deleteIfExists(target); - } else { - move(rollback, target); - } - forceDirectoryIfSupported(Objects.requireNonNull(target.getParent(), "manifest parent")); - } - } - - private record PreparedEditableImport( - File dataFolder, - StructureTransactionWriter.PreparedRemoval removal - ) { - } - - private record MetadataEntry(Path path, String relativePath) { - } - - private record DirectoryMove( - File target, - File backup, - String originalHash, - String originalMarkerHash, - String originalIdentity, - String targetRootIdentity, - String scratchRootIdentity, - String targetRootFileIdentity, - String scratchRootFileIdentity - ) { - } - - record InstallPlan( - File target, - File pending, - File backup, - File pendingRoot, - boolean hadTarget, - boolean publishRequired, - boolean contentChanged, - String originalHash, - String desiredHash, - String originalMarkerHash, - String desiredMarkerHash, - String originalIdentity, - String desiredIdentity, - String targetRootIdentity, - String scratchRootIdentity, - String targetRootFileIdentity, - String scratchRootFileIdentity, - String id, - String url, - VerifiedStagingInstall legacyWorldAuthorization - ) { - } - - private record LegacyStagingSnapshot( - Path normalizedTarget, - Path realTarget, - String targetIdentity, - String contentHash, - String markerHash - ) { - } - - private record StagingScratch(StagingScratchKind kind, String id, Path path) { - } - - @FunctionalInterface - interface DirectoryDeleter { - void delete(File directory); - } - - private static final class Ownership { - private final int schemaVersion; - private final String id; - private final String url; - private final String versionId; - private final String versionNumber; - private final String sha1; - private final String contentHash; - private final List structureKeys; - private final List templateKeys; - - private Ownership( - int schemaVersion, - String id, - String url, - String versionId, - String versionNumber, - String sha1, - String contentHash, - List structureKeys, - List templateKeys - ) { - this.schemaVersion = schemaVersion; - this.id = id; - this.url = url; - this.versionId = versionId; - this.versionNumber = versionNumber; - this.sha1 = sha1; - this.contentHash = contentHash; - this.structureKeys = List.copyOf(structureKeys); - this.templateKeys = List.copyOf(templateKeys); - } - - private Entry toEntry() { - Entry entry = new Entry(); - entry.id = id; - entry.url = url; - entry.versionId = versionId; - entry.versionNumber = versionNumber; - entry.sha1 = sha1; - entry.structureKeys = normalizeKeys(structureKeys); - entry.templateKeys = normalizeKeys(templateKeys); - return entry; - } - } } diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstall.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstall.java new file mode 100644 index 000000000..24d223272 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstall.java @@ -0,0 +1,331 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.io.IO; + +import java.io.File; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Objects; + +final class DatapackInstall { + static final int MAX_SCRATCH_DELETE_ATTEMPTS = 3; + + private DatapackInstall() { + } + + static InstallResult install(File stagedDir, KList worldFolders, Entry entry, boolean stripOverrides) throws IOException { + File root = inferDatapackRoot(stagedDir); + DatapackScratchRecovery.recoverTransactions(root, worldFolders); + InstallExecution execution = prepareInstallExecution( + stagedDir, + worldFolders, + entry, + stripOverrides, + root + ); + try { + verifyInstallExecution(execution); + } catch (IOException failure) { + rollbackInstallExecutions(List.of(execution), failure); + throw failure; + } + finishInstallExecution(execution); + return execution.result(); + } + + static InstallExecution prepareInstallExecution( + File stagedDir, + KList worldFolders, + Entry entry, + boolean stripOverrides, + File root + ) throws IOException { + return prepareInstallExecution( + stagedDir, worldFolders, entry, stripOverrides, root, null); + } + + static InstallExecution prepareInstallExecution( + File stagedDir, + KList worldFolders, + Entry entry, + boolean stripOverrides, + File root, + VerifiedStagingInstall verifiedStagingInstall + ) throws IOException { + DatapackOwnership.validateManagedDirectory(stagedDir, entry.id); + Ownership stagedOwnership = DatapackOwnership.readOwnership(stagedDir); + String stagedHash = DatapackOwnership.directoryHash(stagedDir); + if (!ownershipMetadataMatches(stagedOwnership, entry, stagedHash)) { + throw new IOException("Iris datapack staging does not match the committed manifest entry for " + entry.id); + } + DatapackStagingGuard.validateInstallParticipants(worldFolders, verifiedStagingInstall, entry); + List plans = new ArrayList<>(); + try { + for (File worldFolder : worldFolders) { + plans.add(DatapackInstallPlanner.prepareInstall( + stagedDir, worldFolder, entry, stagedHash, stripOverrides, verifiedStagingInstall)); + } + if (verifiedStagingInstall != null) { + plans.add(DatapackInstallPlanner.prepareInstall( + stagedDir, + verifiedStagingInstall.stagingRoot().toFile(), + entry, + stagedHash, + false, + verifiedStagingInstall)); + } + } catch (IOException | RuntimeException preparationFailure) { + for (InstallPlan plan : plans) { + try { + DatapackInstallPlanner.cleanupInstallPlan(plan, false); + } catch (IOException cleanupFailure) { + preparationFailure.addSuppressed(cleanupFailure); + } + } + if (preparationFailure instanceof UncheckedIOException unchecked) { + throw unchecked.getCause(); + } + if (preparationFailure instanceof IOException ioFailure) { + throw ioFailure; + } + throw preparationFailure; + } + + boolean changed = false; + List publishPlans = new ArrayList<>(); + List unchangedPlans = new ArrayList<>(); + try { + for (InstallPlan plan : plans) { + changed |= plan.contentChanged(); + if (plan.publishRequired()) { + publishPlans.add(plan); + } else { + unchangedPlans.add(plan); + DatapackInstallPlanner.cleanupInstallPlan(plan, true); + } + } + } catch (IOException cleanupFailure) { + for (InstallPlan plan : plans) { + try { + DatapackInstallPlanner.cleanupInstallPlan(plan, false); + } catch (IOException additionalFailure) { + cleanupFailure.addSuppressed(additionalFailure); + } + } + throw cleanupFailure; + } + if (publishPlans.isEmpty()) { + return new InstallExecution( + new InstallResult(changed), + null, + stagedDir, + entry, + stagedHash, + verifiedStagingInstall == null, + publishPlans, + unchangedPlans); + } + + Manifest committedManifest = DatapackManifestStore.readCommittedManifest(root); + boolean manifestAlreadyMatched = manifestEntryMatches(committedManifest.findById(entry.id), entry); + DatapackCoordinator coordinator; + try { + coordinator = DatapackTransactions.createInstallCoordinator(root, entry, publishPlans, manifestAlreadyMatched); + } catch (IOException | RuntimeException coordinatorFailure) { + for (InstallPlan plan : publishPlans) { + try { + DatapackInstallPlanner.cleanupInstallPlan(plan, false); + } catch (IOException cleanupFailure) { + coordinatorFailure.addSuppressed(cleanupFailure); + } + } + if (coordinatorFailure instanceof IOException ioFailure) { + throw ioFailure; + } + throw coordinatorFailure; + } + + try { + coordinator.phase(CoordinatorPhase.PUBLISHING); + for (InstallPlan plan : publishPlans) { + DatapackInstallPlanner.publishInstallPlan(plan); + } + coordinator.phase(CoordinatorPhase.PUBLISHED); + } catch (IOException | RuntimeException publishFailure) { + try { + DatapackCoordinatorResolution.resolveCoordinatorDirectories(coordinator.journal, false); + coordinator.finish(); + } catch (IOException rollbackFailure) { + publishFailure.addSuppressed(rollbackFailure); + } + if (publishFailure instanceof IOException ioFailure) { + throw ioFailure; + } + throw publishFailure; + } + return new InstallExecution( + new InstallResult(changed), + coordinator, + stagedDir, + entry, + stagedHash, + verifiedStagingInstall == null, + publishPlans, + unchangedPlans); + } + + static void verifyInstallExecution(InstallExecution execution) throws IOException { + if (execution.verified()) { + return; + } + if (execution.verifyStagedSource()) { + DatapackOwnership.validateManagedDirectory(execution.stagedDir(), execution.entry().id); + Ownership stagedOwnership = DatapackOwnership.readOwnership(execution.stagedDir()); + String stagedHash = DatapackOwnership.directoryHash(execution.stagedDir()); + if (!Objects.equals(stagedHash, execution.stagedHash()) + || !ownershipMetadataMatches(stagedOwnership, execution.entry(), stagedHash)) { + throw new IOException("Iris datapack staging changed before installation commit for " + + execution.entry().id); + } + } + for (InstallPlan plan : execution.publishedPlans()) { + DatapackInstallPlanner.verifyDesiredInstallSnapshot(plan.target(), plan, "published datapack target"); + } + for (InstallPlan plan : execution.unchangedPlans()) { + DatapackInstallPlanner.verifyOriginalInstallSnapshot(plan.target(), plan, "unchanged datapack target"); + } + execution.markVerified(); + } + + static void finishInstallExecution(InstallExecution execution) throws IOException { + if (!execution.verified()) { + throw new IOException("Datapack install cannot commit before final verification"); + } + if (execution.coordinator() == null) { + return; + } + execution.coordinator().phase(CoordinatorPhase.COMMITTED); + DatapackCoordinatorResolution.resolveCoordinatorDirectories(execution.coordinator().journal, true); + execution.coordinator().finish(); + } + + static void rollbackInstallExecutions(List executions, Throwable failure) { + List reversed = new ArrayList<>(executions); + Collections.reverse(reversed); + for (InstallExecution execution : reversed) { + if (execution.coordinator() == null) { + continue; + } + try { + DatapackCoordinatorResolution.resolveCoordinatorDirectories(execution.coordinator().journal, false); + execution.coordinator().finish(); + } catch (IOException rollbackFailure) { + failure.addSuppressed(rollbackFailure); + } + } + } + + static File inferDatapackRoot(File stagedDir) { + File parent = stagedDir.getParentFile(); + if (parent != null && "staging".equals(parent.getName()) && parent.getParentFile() != null) { + return parent.getParentFile(); + } + return parent == null ? stagedDir : parent; + } + + static boolean manifestEntryMatches(Entry committed, Entry desired) { + return committed != null + && Objects.equals(committed.id, desired.id) + && Objects.equals(committed.url, desired.url) + && Objects.equals(committed.versionId, desired.versionId) + && Objects.equals(committed.versionNumber, desired.versionNumber) + && Objects.equals(committed.sha1, desired.sha1); + } + + static void validateInstallTree(File directory, File storeAnchor, String purpose) throws IOException { + DatapackScratchRecovery.validateScratchTree(directory.toPath()); + if (!DatapackScratchRecovery.sameScratchVolume(directory.toPath(), storeAnchor.toPath())) { + throw new IOException(purpose + " crosses a filesystem boundary at " + directory.getPath()); + } + } + + static File installScratchRoot(File targetFolder) { + File parent = targetFolder.getParentFile(); + return new File(parent == null ? targetFolder : parent, ".iris-datapack-install"); + } + + static void cleanupPreparedInstall(File pending, File pendingRoot, Throwable failure) { + try { + deleteInstallScratch(pending, "prepared datapack install"); + } catch (IOException cleanupFailure) { + failure.addSuppressed(cleanupFailure); + } + pendingRoot.delete(); + } + + static boolean ownershipMetadataMatches(Ownership ownership, Entry entry, String contentHash) { + return ownership.schemaVersion == DatapackOwnership.OWNERSHIP_SCHEMA + && Objects.equals(ownership.id, entry.id) + && Objects.equals(ownership.url, entry.url) + && Objects.equals(ownership.versionId, entry.versionId) + && Objects.equals(ownership.versionNumber, entry.versionNumber) + && Objects.equals(ownership.sha1, entry.sha1) + && Objects.equals(ownership.contentHash, contentHash) + && DatapackManifestStore.copyList(ownership.structureKeys).equals(DatapackManifestStore.copyList(entry.structureKeys)) + && DatapackManifestStore.copyList(ownership.templateKeys).equals(DatapackManifestStore.copyList(entry.templateKeys)); + } + + static boolean ownershipSourceMatches(Ownership ownership, Entry entry) { + return ownership.schemaVersion == DatapackOwnership.OWNERSHIP_SCHEMA + && Objects.equals(ownership.id, entry.id) + && Objects.equals(ownership.url, entry.url); + } + + static void deleteInstallScratch(File scratch, String purpose) throws IOException { + Path scratchPath = scratch.toPath(); + File parent = Objects.requireNonNull(scratch.getParentFile(), "datapack scratch parent"); + for (int attempt = 0; attempt < MAX_SCRATCH_DELETE_ATTEMPTS; attempt++) { + if (Files.notExists(scratchPath, LinkOption.NOFOLLOW_LINKS)) { + return; + } + if (!Files.exists(scratchPath, LinkOption.NOFOLLOW_LINKS) + || Files.isSymbolicLink(scratchPath) + || !Files.isDirectory(scratchPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing to remove unsafe " + purpose + " " + scratch.getPath()); + } + validateInstallTree(scratch, parent, purpose); + DatapackOwnership.removeFinderMetadata(scratch); + IO.delete(scratch); + if (Files.notExists(scratchPath, LinkOption.NOFOLLOW_LINKS)) { + return; + } + } + throw new IOException("Could not remove " + purpose + " " + scratch.getPath()); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstallPlanner.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstallPlanner.java new file mode 100644 index 000000000..443fd8163 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackInstallPlanner.java @@ -0,0 +1,394 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.volmlib.util.io.IO; + +import java.io.File; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Objects; +import java.util.UUID; + +final class DatapackInstallPlanner { + + private DatapackInstallPlanner() { + } + + static InstallPlan prepareInstall( + File stagedDir, + File worldFolder, + Entry entry, + String stagedHash, + boolean stripOverrides, + VerifiedStagingInstall verifiedStagingInstall + ) throws IOException { + DatapackStagingGuard.ensureInstallTargetRoot(worldFolder); + File target = new File(worldFolder, entry.id); + InstallPlan unchanged = tryPrepareUnchangedManagedInstall( + stagedDir, + worldFolder, + target, + entry, + stagedHash, + stripOverrides, + verifiedStagingInstall); + if (unchanged != null) { + return unchanged; + } + boolean canonicalStagingInstall = verifiedStagingInstall != null + && verifiedStagingInstall.isCanonicalInstall(worldFolder, target); + boolean legacyReplacementAuthorized = canonicalStagingInstall + && verifiedStagingInstall.consume(stagedDir, worldFolder, target, entry, stagedHash); + VerifiedStagingInstall legacyWorldAuthorization = null; + File pendingRoot = DatapackInstall.installScratchRoot(worldFolder); + File pending = new File(pendingRoot, entry.id + "-" + UUID.randomUUID()); + File backup = new File(pendingRoot, entry.id + "-backup-" + UUID.randomUUID()); + try { + DatapackSupport.ensureScratchDirectory(pendingRoot, "datapack install staging"); + String targetRootIdentity = DatapackSupport.realDirectoryPath(worldFolder, "datapack target root"); + String scratchRootIdentity = DatapackSupport.realDirectoryPath(pendingRoot, "datapack install scratch root"); + String targetRootFileIdentity = DatapackSupport.directoryIdentity(worldFolder); + String scratchRootFileIdentity = DatapackSupport.directoryIdentity(pendingRoot); + IO.copyDirectory(stagedDir.toPath(), pending.toPath()); + Files.deleteIfExists(new File(pending, DatapackOwnership.OWNERSHIP_MARKER).toPath()); + String copiedHash = DatapackOwnership.directoryHash(pending); + if (!Objects.equals(stagedHash, copiedHash)) { + throw new IOException("Datapack staging changed or copied incompletely while preparing " + entry.id); + } + boolean removedOverrideMarker = Files.deleteIfExists( + new File(pending, DatapackPackMetadata.OVERRIDES_STRIPPED_MARKER).toPath()); + if (stripOverrides) { + DatapackPackMetadata.stripVanillaStructureOverrides(pending); + DatapackPackMetadata.writeMarker(new File(pending, DatapackPackMetadata.OVERRIDES_STRIPPED_MARKER)); + } + DatapackPackMetadata.validatePackMetadata(pending); + if (!stripOverrides && !removedOverrideMarker) { + DatapackOwnership.writeOwnership(pending, entry, copiedHash); + } else { + DatapackOwnership.writeOwnership(pending, entry); + } + DatapackInstall.validateInstallTree(pending, worldFolder, "Prepared datapack install"); + Ownership desiredOwnership = DatapackOwnership.readOwnership(pending); + String desiredHash = desiredOwnership.contentHash; + String desiredMarkerHash = DatapackOwnership.ownershipMarkerFingerprint(pending); + String desiredIdentity = DatapackSupport.directoryIdentity(pending); + boolean hadTarget = DatapackSupport.pathExists(target.toPath(), "datapack install target"); + String originalHash = ""; + String originalMarkerHash = "absent"; + String originalIdentity = ""; + boolean contentChanged = !hadTarget; + boolean publishRequired = !hadTarget; + if (hadTarget) { + if (Files.isSymbolicLink(target.toPath()) + || !Files.isDirectory(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing to replace non-directory or symbolic-link datapack " + target.getPath()); + } + DatapackInstall.validateInstallTree(target, worldFolder, "Existing datapack install"); + Ownership ownership = DatapackOwnership.readOwnershipOrNull(target); + if (ownership != null) { + DatapackOwnership.removeFinderMetadata(target); + } + String currentHash = DatapackOwnership.directoryHash(target); + originalHash = currentHash; + originalMarkerHash = DatapackOwnership.ownershipMarkerFingerprint(target); + originalIdentity = DatapackSupport.directoryIdentity(target); + if (ownership == null) { + boolean differingLegacyTarget = !Objects.equals(currentHash, desiredHash); + if (differingLegacyTarget && !legacyReplacementAuthorized + && verifiedStagingInstall != null + && verifiedStagingInstall.authorizeLegacyWorldReplacement( + stagedDir, + worldFolder, + target, + entry, + stagedHash, + currentHash, + originalMarkerHash)) { + legacyReplacementAuthorized = true; + legacyWorldAuthorization = verifiedStagingInstall; + } + if (differingLegacyTarget && !legacyReplacementAuthorized) { + throw new IOException("Refusing to replace unmanaged datapack at " + target.getPath()); + } + if (differingLegacyTarget && (originalIdentity.isEmpty() + || targetRootFileIdentity.isEmpty() + || scratchRootFileIdentity.isEmpty() + || verifiedStagingInstall == null + || !verifiedStagingInstall.hasStablePathIdentities())) { + throw new IOException("Cannot safely identify legacy datapack staging at " + target.getPath()); + } + publishRequired = true; + } else { + if (!entry.id.equals(ownership.id)) { + throw new IOException("Datapack ownership mismatch at " + target.getPath()); + } + publishRequired = !Objects.equals(ownership.contentHash, currentHash) + || !DatapackInstall.ownershipMetadataMatches(ownership, entry, desiredHash); + } + contentChanged = !Objects.equals(currentHash, desiredHash); + publishRequired |= contentChanged; + if (ownership != null && !Objects.equals(ownership.contentHash, currentHash)) { + IrisLogging.warn("Repairing modified or corrupt Iris-managed datapack at " + target.getPath()); + } + } + return new InstallPlan( + target, + pending, + backup, + pendingRoot, + hadTarget, + publishRequired, + contentChanged, + originalHash, + desiredHash, + originalMarkerHash, + desiredMarkerHash, + originalIdentity, + desiredIdentity, + targetRootIdentity, + scratchRootIdentity, + targetRootFileIdentity, + scratchRootFileIdentity, + entry.id, + entry.url, + legacyWorldAuthorization + ); + } catch (UncheckedIOException e) { + IOException cause = e.getCause(); + DatapackInstall.cleanupPreparedInstall(pending, pendingRoot, cause); + throw cause; + } catch (IOException e) { + DatapackInstall.cleanupPreparedInstall(pending, pendingRoot, e); + throw e; + } catch (RuntimeException e) { + DatapackInstall.cleanupPreparedInstall(pending, pendingRoot, e); + throw e; + } + } + + static InstallPlan tryPrepareUnchangedManagedInstall( + File stagedDir, + File worldFolder, + File target, + Entry entry, + String stagedHash, + boolean stripOverrides, + VerifiedStagingInstall verifiedStagingInstall + ) throws IOException { + if (verifiedStagingInstall != null + || stripOverrides + || DatapackSupport.pathExists(new File(stagedDir, DatapackPackMetadata.OVERRIDES_STRIPPED_MARKER).toPath(), + "staged datapack override marker") + || !DatapackSupport.pathExists(target.toPath(), "datapack install target")) { + return null; + } + if (Files.isSymbolicLink(target.toPath()) + || !Files.isDirectory(target.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing to replace non-directory or symbolic-link datapack " + target.getPath()); + } + Ownership ownership = DatapackOwnership.readOwnershipOrNull(target); + if (ownership == null) { + return null; + } + if (!entry.id.equals(ownership.id)) { + throw new IOException("Datapack ownership mismatch at " + target.getPath()); + } + if (!DatapackInstall.ownershipMetadataMatches(ownership, entry, stagedHash)) { + return null; + } + DatapackInstall.validateInstallTree(target, worldFolder, "Existing datapack install"); + DatapackOwnership.removeFinderMetadata(target); + String currentHash = DatapackOwnership.directoryHash(target); + if (!Objects.equals(currentHash, stagedHash)) { + return null; + } + String markerHash = DatapackOwnership.ownershipMarkerFingerprint(target); + String identity = DatapackSupport.directoryIdentity(target); + File pendingRoot = DatapackInstall.installScratchRoot(worldFolder); + return new InstallPlan( + target, + new File(pendingRoot, entry.id + "-" + UUID.randomUUID()), + new File(pendingRoot, entry.id + "-backup-" + UUID.randomUUID()), + pendingRoot, + true, + false, + false, + currentHash, + currentHash, + markerHash, + markerHash, + identity, + identity, + DatapackSupport.realDirectoryPath(worldFolder, "datapack target root"), + "", + DatapackSupport.directoryIdentity(worldFolder), + "", + entry.id, + entry.url, + null + ); + } + + static void publishInstallPlan(InstallPlan plan) throws IOException { + verifyDirectoryContainerIdentity( + plan.target().getParentFile(), plan.targetRootIdentity(), + plan.targetRootFileIdentity(), "datapack target root"); + verifyDirectoryContainerIdentity( + plan.pendingRoot(), plan.scratchRootIdentity(), + plan.scratchRootFileIdentity(), "datapack install scratch root"); + verifyDesiredInstallSnapshot(plan.pending(), plan, "prepared datapack install"); + if (plan.hadTarget()) { + verifyOriginalInstallSnapshot(plan.target(), plan, "original datapack target"); + } else if (DatapackSupport.pathExists(plan.target().toPath(), "new datapack target")) { + throw new IOException("Datapack install target was concurrently created at " + plan.target().getPath()); + } + if (plan.legacyWorldAuthorization() != null) { + plan.legacyWorldAuthorization().verifyLegacyWorldSnapshot(); + } + try { + if (plan.hadTarget()) { + DatapackSupport.moveNew(plan.target().toPath(), plan.backup().toPath()); + verifyOriginalInstallSnapshot(plan.backup(), plan, "datapack install backup"); + if (DatapackSupport.pathExists(plan.target().toPath(), "moved datapack target")) { + throw new IOException("Datapack install target reappeared after backup at " + plan.target().getPath()); + } + forceInstallMoveDirectories(plan); + } + DatapackSupport.moveNew(plan.pending().toPath(), plan.target().toPath()); + verifyDesiredInstallSnapshot(plan.target(), plan, "installed datapack target"); + forceInstallMoveDirectories(plan); + } catch (IOException publishFailure) { + if (plan.hadTarget() + && Files.exists(plan.backup().toPath(), LinkOption.NOFOLLOW_LINKS) + && Files.exists(plan.pending().toPath(), LinkOption.NOFOLLOW_LINKS) + && Files.notExists(plan.target().toPath(), LinkOption.NOFOLLOW_LINKS)) { + try { + verifyOriginalInstallSnapshot(plan.backup(), plan, "datapack install backup"); + DatapackSupport.moveNew(plan.backup().toPath(), plan.target().toPath()); + forceInstallMoveDirectories(plan); + } catch (IOException restoreFailure) { + publishFailure.addSuppressed(restoreFailure); + } + } + throw publishFailure; + } + } + + static void forceInstallMoveDirectories(InstallPlan plan) throws IOException { + DatapackSupport.forceDirectoryIfSupported(plan.target().getParentFile().toPath()); + DatapackSupport.forceDirectoryIfSupported(plan.pendingRoot().toPath()); + } + + static void verifyDirectoryContainerIdentity( + File directory, + String expectedRealPath, + String expectedFileIdentity, + String purpose + ) throws IOException { + Path normalized = directory.toPath().toAbsolutePath().normalize(); + if (Files.isSymbolicLink(normalized) + || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) + || !Objects.equals(normalized.toRealPath(), Path.of(expectedRealPath)) + || (!expectedFileIdentity.isEmpty() + && !Objects.equals(DatapackSupport.directoryIdentity(directory), expectedFileIdentity))) { + throw new IOException("Changed or unsafe " + purpose + " " + normalized); + } + } + + static void verifyOriginalInstallSnapshot( + File directory, + InstallPlan plan, + String purpose + ) throws IOException { + verifyDirectorySnapshot( + directory, + plan.target().getParentFile(), + plan.originalHash(), + plan.originalMarkerHash(), + plan.originalIdentity(), + purpose + ); + } + + static void verifyDesiredInstallSnapshot( + File directory, + InstallPlan plan, + String purpose + ) throws IOException { + verifyDirectorySnapshot( + directory, + plan.target().getParentFile(), + plan.desiredHash(), + plan.desiredMarkerHash(), + plan.desiredIdentity(), + purpose + ); + Ownership ownership = DatapackOwnership.readOwnership(directory); + if (!Objects.equals(ownership.id, plan.id()) + || !Objects.equals(ownership.url, plan.url()) + || !Objects.equals(ownership.contentHash, plan.desiredHash())) { + throw new IOException("Datapack ownership changed in " + purpose + " at " + directory.getPath()); + } + } + + static void verifyDirectorySnapshot( + File directory, + File storeAnchor, + String expectedHash, + String expectedMarkerHash, + String expectedIdentity, + String purpose + ) throws IOException { + if (!DatapackSupport.pathExists(directory.toPath(), purpose) + || Files.isSymbolicLink(directory.toPath()) + || !Files.isDirectory(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Missing or unsafe " + purpose + " at " + directory.getPath()); + } + DatapackInstall.validateInstallTree(directory, storeAnchor, purpose); + if (Files.exists(new File(directory, DatapackOwnership.OWNERSHIP_MARKER).toPath(), LinkOption.NOFOLLOW_LINKS)) { + DatapackOwnership.removeFinderMetadata(directory); + } + if (!expectedIdentity.isEmpty() + && !Objects.equals(DatapackSupport.directoryIdentity(directory), expectedIdentity)) { + throw new IOException("Datapack directory identity changed in " + purpose + " at " + directory.getPath()); + } + if (!Objects.equals(expectedHash, DatapackOwnership.directoryHash(directory)) + || !Objects.equals(expectedMarkerHash, DatapackOwnership.ownershipMarkerFingerprint(directory))) { + throw new IOException("Datapack content changed in " + purpose + " at " + directory.getPath()); + } + } + + static void cleanupInstallPlan(InstallPlan plan, boolean committed) throws IOException { + DatapackInstall.deleteInstallScratch(plan.pending(), "datapack install pending directory"); + if (committed) { + DatapackInstall.deleteInstallScratch(plan.backup(), "datapack install backup"); + } + if (Files.exists(plan.backup().toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Preserving prior datapack backup after incomplete install: " + + plan.backup().getPath()); + } + plan.pendingRoot().delete(); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackManifestStore.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackManifestStore.java new file mode 100644 index 000000000..42582dc03 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackManifestStore.java @@ -0,0 +1,316 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.StandardOpenOption; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.TreeSet; +import java.util.TreeMap; + +final class DatapackManifestStore { + static final long MAX_MANIFEST_BYTES = 16L * 1024L * 1024L; + + private DatapackManifestStore() { + } + + static List copyList(List values) { + return values == null ? List.of() : List.copyOf(values); + } + + static Entry copyEntry(Entry source) { + Entry resolved = Objects.requireNonNull(source, "Datapack manifest entry must not be null"); + Entry copy = new Entry(); + copy.url = resolved.url; + copy.id = resolved.id; + copy.versionId = resolved.versionId; + copy.versionNumber = resolved.versionNumber; + copy.sha1 = resolved.sha1; + copy.filename = resolved.filename; + copy.etag = resolved.etag; + copy.lastModified = resolved.lastModified; + copy.installedEpoch = resolved.installedEpoch; + copy.structuresImported = resolved.structuresImported; + copy.stagingMetadata = resolved.stagingMetadata; + copy.structureKeys = new ArrayList<>(copyList(resolved.structureKeys)); + copy.templateKeys = new ArrayList<>(copyList(resolved.templateKeys)); + copy.installMetadata = new HashMap<>(Objects.requireNonNullElseGet( + resolved.installMetadata, Map::of)); + copy.importedTargets = new HashMap<>(Objects.requireNonNullElseGet( + resolved.importedTargets, Map::of)); + copy.importAttempts = new HashMap<>(Objects.requireNonNullElseGet( + resolved.importAttempts, Map::of)); + copy.importedBundles = new HashMap<>(); + if (resolved.importedBundles != null) { + for (Map.Entry> bundle : resolved.importedBundles.entrySet()) { + copy.importedBundles.put(bundle.getKey(), new HashMap<>(bundle.getValue())); + } + } + return copy; + } + + static Manifest readManifest(File root) { + File file = new File(root, "manifest.json"); + Manifest manifest = null; + boolean recoverFromStaging = false; + Path path = file.toPath(); + if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + manifest = new Manifest(); + } else if (Files.isSymbolicLink(path) || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { + IrisLogging.error("Unreadable datapack manifest " + file.getPath() + + "; moving the non-regular path aside before recovering Iris-managed staging"); + recoverFromStaging = quarantine(path); + } else { + try { + String json = DatapackSupport.readBoundedUtf8(path, MAX_MANIFEST_BYTES, "Datapack manifest"); + manifest = DatapackSupport.GSON.fromJson(json, Manifest.class); + if (manifest == null) { + throw new IOException("Datapack manifest is empty"); + } + } catch (Exception e) { + IrisLogging.reportError("Unreadable datapack manifest " + file.getPath() + + "; moving it aside before recovering Iris-managed staging", e); + recoverFromStaging = quarantine(file.toPath()); + } + } + if (manifest == null) { + manifest = new Manifest(); + } + normalizeManifest(manifest); + if (recoverFromStaging) { + recoverManifestFromStaging(root, manifest); + } + return manifest; + } + + static boolean quarantine(Path file) { + try { + DatapackSupport.move(file, file.resolveSibling(file.getFileName().toString() + ".corrupt-" + System.currentTimeMillis())); + return true; + } catch (IOException e) { + IrisLogging.reportError("Failed to move aside corrupt datapack manifest " + file, e); + return false; + } + } + + static void normalizeManifest(Manifest manifest) { + if (manifest.entries == null) { + manifest.entries = new ArrayList<>(); + return; + } + List normalized = new ArrayList<>(); + Set urls = new HashSet<>(); + Set ids = new HashSet<>(); + for (Entry entry : manifest.entries) { + if (entry == null || entry.url == null || entry.url.isBlank() || entry.id == null || entry.id.isBlank()) { + continue; + } + entry.url = entry.url.trim(); + if (!DatapackArchive.isValidManagedId(entry.id)) { + IrisLogging.warn("Ignoring datapack manifest entry with invalid id '" + entry.id + "'"); + continue; + } + entry.structureKeys = normalizeKeys(entry.structureKeys); + entry.templateKeys = normalizeKeys(entry.templateKeys); + entry.stagingMetadata = entry.stagingMetadata == null ? "" : entry.stagingMetadata.trim(); + entry.installMetadata = normalizeImportedTargets(entry.installMetadata); + entry.importedTargets = normalizeImportedTargets(entry.importedTargets); + entry.importAttempts = normalizeImportedTargets(entry.importAttempts); + entry.importedBundles = normalizeImportedBundles(entry.importedBundles); + if (!urls.add(entry.url) || !ids.add(entry.id)) { + IrisLogging.warn("Ignoring duplicate datapack manifest entry for id '" + entry.id + "' and url " + entry.url); + continue; + } + normalized.add(entry); + } + manifest.entries = normalized; + } + + static void recoverManifestFromStaging(File root, Manifest manifest) { + File staging = new File(root, "staging"); + File[] directories = staging.listFiles(File::isDirectory); + if (directories == null) { + return; + } + for (File directory : directories) { + try { + Ownership ownership = DatapackOwnership.readOwnershipOrNull(directory); + if (ownership == null || !directory.getName().equals(ownership.id) + || manifest.find(ownership.url) != null || manifest.findById(ownership.id) != null) { + continue; + } + DatapackOwnership.validateManagedDirectory(directory, ownership.id); + if (!Objects.equals(ownership.contentHash, DatapackOwnership.directoryHash(directory))) { + IrisLogging.warn("Ignoring corrupt Iris-managed datapack staging at " + directory.getPath()); + continue; + } + Entry recovered = ownership.toEntry(); + recovered.installedEpoch = directory.lastModified(); + manifest.put(recovered); + IrisLogging.warn("Recovered Iris-managed datapack manifest entry '" + recovered.id + "' from staging."); + } catch (IOException e) { + IrisLogging.warn("Ignoring orphan datapack staging at " + directory.getPath() + ": " + e.getMessage()); + } + } + } + + static List normalizeKeys(List keys) { + TreeSet normalized = new TreeSet<>(); + if (keys != null) { + for (String key : keys) { + if (key != null && !key.isBlank()) { + normalized.add(key.trim().toLowerCase(Locale.ROOT)); + } + } + } + return new ArrayList<>(normalized); + } + + static Map normalizeImportedTargets(Map targets) { + Map normalized = new HashMap<>(); + if (targets == null) { + return normalized; + } + for (Map.Entry target : targets.entrySet()) { + if (target.getKey() != null && !target.getKey().isBlank() + && target.getValue() != null && !target.getValue().isBlank()) { + normalized.put(target.getKey(), target.getValue()); + } + } + return normalized; + } + + static Map> normalizeImportedBundles( + Map> targets + ) { + Map> normalized = new HashMap<>(); + if (targets == null) { + return normalized; + } + for (Map.Entry> target : targets.entrySet()) { + if (target.getKey() == null || target.getKey().isBlank() || target.getValue() == null) { + continue; + } + Map bundles = new TreeMap<>(); + for (Map.Entry bundle : target.getValue().entrySet()) { + if (bundle.getKey() != null && !bundle.getKey().isBlank() + && bundle.getValue() != null && !bundle.getValue().isBlank()) { + bundles.put(bundle.getKey(), bundle.getValue()); + } + } + normalized.put(target.getKey(), bundles); + } + return normalized; + } + + static void writeManifest(File root, Manifest manifest) { + try { + writeManifestChecked(root, manifest); + } catch (IOException e) { + IrisLogging.reportError("Failed to write datapack manifest " + + new File(root, "manifest.json").toPath(), e); + } + } + + static void writeManifestChecked(File root, Manifest manifest) throws IOException { + try (ManifestWrite write = prepareManifestWrite(root, manifest)) { + write.publish(); + } + } + + static ManifestWrite prepareManifestWrite(File root, Manifest manifest) throws IOException { + Path file = new File(root, "manifest.json").toPath(); + Path parent = file.getParent(); + Files.createDirectories(parent); + Path temp = Files.createTempFile(parent, "manifest", ".json.tmp"); + Path rollback = null; + try { + byte[] content = DatapackSupport.GSON.toJson(manifest).getBytes(StandardCharsets.UTF_8); + if (content.length > MAX_MANIFEST_BYTES) { + throw new IOException("Datapack manifest exceeds " + MAX_MANIFEST_BYTES + " bytes"); + } + Files.write(temp, content, StandardOpenOption.TRUNCATE_EXISTING); + DatapackSupport.forceFile(temp); + if (Files.exists(file, LinkOption.NOFOLLOW_LINKS)) { + if (!Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS) || Files.isSymbolicLink(file)) { + throw new IOException("Datapack manifest is not a regular file: " + file); + } + rollback = Files.createTempFile(parent, "manifest-rollback", ".json.tmp"); + Files.copy(file, rollback, StandardCopyOption.REPLACE_EXISTING); + DatapackSupport.forceFile(rollback); + } + return new ManifestWrite(temp, file, rollback); + } catch (IOException | RuntimeException e) { + try { + Files.deleteIfExists(temp); + } catch (IOException cleanupFailure) { + e.addSuppressed(cleanupFailure); + } + if (rollback != null) { + try { + Files.deleteIfExists(rollback); + } catch (IOException cleanupFailure) { + e.addSuppressed(cleanupFailure); + } + } + throw e; + } + } + + static Manifest readCommittedManifest(File root) throws IOException { + Path manifestPath = new File(root, "manifest.json").toPath(); + if (!Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + return new Manifest(); + } + if (Files.isSymbolicLink(manifestPath) + || !Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Datapack manifest is not a regular file: " + manifestPath); + } + Manifest manifest; + try { + manifest = DatapackSupport.GSON.fromJson( + DatapackSupport.readBoundedUtf8(manifestPath, MAX_MANIFEST_BYTES, "Datapack manifest"), + Manifest.class + ); + } catch (RuntimeException e) { + throw new IOException("Invalid datapack manifest " + manifestPath, e); + } + if (manifest == null) { + throw new IOException("Empty datapack manifest " + manifestPath); + } + normalizeManifest(manifest); + return manifest; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackOwnership.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackOwnership.java new file mode 100644 index 000000000..c40e36913 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackOwnership.java @@ -0,0 +1,379 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.volmlib.util.io.IO; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.nio.file.FileStore; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.nio.file.attribute.BasicFileAttributes; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.Iterator; +import java.util.List; +import java.util.Locale; +import java.util.Objects; +import java.util.Set; +import java.util.TreeSet; +import java.util.stream.Stream; + +final class DatapackOwnership { + static final String FINDER_METADATA = ".DS_Store"; + + static final String OWNERSHIP_MARKER = ".iris-managed.json"; + + static final int OWNERSHIP_SCHEMA = 1; + + static final int MAX_MANAGED_PATHS = DatapackArchive.MAX_ARCHIVE_ENTRIES + 16; + + static final long MAX_OWNERSHIP_BYTES = 1024L * 1024L; + + static final int HASH_BUFFER_BYTES = 64 * 1024; + + private DatapackOwnership() { + } + + static void writeOwnership(File directory, Entry entry) throws IOException { + writeOwnership(directory, entry, directoryHash(directory)); + } + + static void writeOwnership(File directory, Entry entry, String contentHash) throws IOException { + if (!DatapackArchive.isValidManagedId(entry.id) || entry.url == null || entry.url.isBlank()) { + throw new IOException("Invalid Iris datapack ownership identity for " + directory.getPath()); + } + if (contentHash == null || contentHash.isBlank()) { + throw new IOException("Missing Iris datapack ownership content hash for " + directory.getPath()); + } + Ownership ownership = new Ownership( + OWNERSHIP_SCHEMA, + entry.id, + entry.url, + entry.versionId, + entry.versionNumber, + entry.sha1, + contentHash, + DatapackManifestStore.copyList(entry.structureKeys), + DatapackManifestStore.copyList(entry.templateKeys) + ); + Path marker = new File(directory, OWNERSHIP_MARKER).toPath(); + Path temporary = Files.createTempFile(directory.toPath(), OWNERSHIP_MARKER, ".tmp"); + try { + Files.writeString( + temporary, + DatapackSupport.GSON.toJson(ownership), + StandardCharsets.UTF_8, + StandardOpenOption.TRUNCATE_EXISTING + ); + DatapackSupport.move(temporary, marker); + } finally { + Files.deleteIfExists(temporary); + } + } + + static Ownership readOwnership(File directory) throws IOException { + Ownership ownership = readOwnershipOrNull(directory); + if (ownership == null) { + throw new IOException("Missing Iris datapack ownership marker in " + directory.getPath()); + } + return ownership; + } + + static Ownership readOwnershipOrNull(File directory) throws IOException { + File marker = new File(directory, OWNERSHIP_MARKER); + Path markerPath = marker.toPath(); + if (Files.notExists(markerPath, LinkOption.NOFOLLOW_LINKS)) { + return null; + } + if (!Files.exists(markerPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Cannot determine Iris datapack ownership marker state in " + directory.getPath()); + } + if (Files.isSymbolicLink(markerPath) + || !Files.isRegularFile(markerPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); + } + if (marker.length() > MAX_OWNERSHIP_BYTES) { + throw new IOException("Oversized Iris datapack ownership marker in " + directory.getPath()); + } + try { + Ownership ownership = DatapackSupport.GSON.fromJson(DatapackSupport.readBoundedUtf8( + marker.toPath(), MAX_OWNERSHIP_BYTES, "Iris datapack ownership marker"), Ownership.class); + if (ownership == null || ownership.schemaVersion != OWNERSHIP_SCHEMA + || !DatapackArchive.isValidManagedId(ownership.id) || ownership.url == null || ownership.url.isBlank() + || ownership.contentHash == null || ownership.contentHash.isBlank()) { + throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); + } + return ownership; + } catch (RuntimeException e) { + throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath(), e); + } + } + + static String ownershipMarkerFingerprint(File directory) throws IOException { + Path marker = new File(directory, OWNERSHIP_MARKER).toPath(); + if (Files.notExists(marker, LinkOption.NOFOLLOW_LINKS)) { + return "absent"; + } + if (!Files.exists(marker, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Cannot determine Iris datapack ownership marker state in " + directory.getPath()); + } + if (Files.isSymbolicLink(marker) + || !Files.isRegularFile(marker, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid Iris datapack ownership marker in " + directory.getPath()); + } + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + return "sha256:" + DatapackSupport.hex(digest.digest(DatapackSupport.readBoundedBytes( + marker, MAX_OWNERSHIP_BYTES, "Iris datapack ownership marker"))); + } catch (NoSuchAlgorithmException e) { + throw new IOException("SHA-256 algorithm unavailable", e); + } + } + + static void validateManagedDirectory(File directory, String id) throws IOException { + Path path = directory.toPath(); + if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Missing datapack directory " + directory.getPath()); + } + if (Files.isSymbolicLink(path)) { + throw new IOException("Refusing symbolic-link datapack directory " + directory.getPath()); + } + DatapackPackMetadata.validatePackMetadata(directory); + rejectSymbolicLinks(directory); + Ownership ownership = readOwnershipOrNull(directory); + if (ownership == null) { + throw new IOException("Datapack is not Iris-managed: " + directory.getPath()); + } + if (!id.equals(ownership.id)) { + throw new IOException("Datapack ownership mismatch at " + directory.getPath()); + } + removeFinderMetadata(directory); + } + + static void rejectSymbolicLinks(File root) throws IOException { + try (Stream paths = Files.walk(root.toPath())) { + Path symbolicLink = paths.filter(Files::isSymbolicLink).findFirst().orElse(null); + if (symbolicLink != null) { + throw new IOException("Datapack contains a symbolic link: " + symbolicLink); + } + } + } + + static boolean sameDatapackVolume( + Path root, + FileStore rootStore, + Path entry + ) throws IOException { + return DatapackScratchRecovery.sameScratchVolume(root, rootStore, entry, Files.getFileStore(entry)); + } + + static String directoryHash(File root) throws IOException { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + Path rootPath = root.toPath().toAbsolutePath().normalize(); + Path rootMarker = rootPath.resolve(OWNERSHIP_MARKER); + FileStore rootStore = Files.getFileStore(rootPath); + List entries = new ArrayList<>(); + try (Stream paths = Files.walk(rootPath)) { + Iterator iterator = paths.iterator(); + int pathCount = 0; + while (iterator.hasNext()) { + Path path = iterator.next(); + if (path.equals(rootPath) || path.equals(rootMarker)) { + continue; + } + if (isFinderMetadata(path)) { + if (Files.isSymbolicLink(path) + || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Suspicious Finder metadata in datapack: " + path); + } + continue; + } + pathCount++; + if (pathCount > MAX_MANAGED_PATHS) { + throw new IOException("Datapack contains more than " + MAX_MANAGED_PATHS + " paths"); + } + if (Files.isSymbolicLink(path)) { + throw new IOException("Datapack contains a symbolic link: " + path); + } + if (!Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS) + && !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Datapack contains an unsupported filesystem entry: " + path); + } + entries.add(path); + } + } + entries.sort(Comparator.comparing(path -> rootPath.relativize(path).toString())); + byte[] buffer = new byte[HASH_BUFFER_BYTES]; + long totalBytes = 0; + for (Path entry : entries) { + String relative = rootPath.relativize(entry).toString().replace(File.separatorChar, '/'); + byte[] relativeBytes = relative.getBytes(StandardCharsets.UTF_8); + BasicFileAttributes attributes = Files.readAttributes( + entry, + BasicFileAttributes.class, + LinkOption.NOFOLLOW_LINKS + ); + if (attributes.isSymbolicLink() + || attributes.isOther() + || !attributes.isDirectory() && !attributes.isRegularFile()) { + throw new IOException("Datapack entry changed while hashing: " + relative); + } + if (!DatapackScratchRecovery.sameScratchVolume(rootPath, rootStore, entry, Files.getFileStore(entry))) { + throw new IOException("Datapack entry crosses a filesystem boundary: " + entry); + } + boolean directory = attributes.isDirectory(); + digest.update((byte) (directory ? 1 : 2)); + DatapackSupport.updateDigestInt(digest, relativeBytes.length); + digest.update(relativeBytes); + if (!directory) { + long expectedBytes = attributes.size(); + if (expectedBytes > DatapackArchive.MAX_ENTRY_BYTES) { + throw new IOException("Datapack file exceeds " + DatapackArchive.MAX_ENTRY_BYTES + " bytes: " + relative); + } + totalBytes += expectedBytes; + if (totalBytes > DatapackArchive.MAX_EXPANDED_BYTES) { + throw new IOException("Datapack contents exceed " + DatapackArchive.MAX_EXPANDED_BYTES + " bytes"); + } + DatapackSupport.updateDigestLong(digest, expectedBytes); + long entryBytes = 0; + try (InputStream input = Files.newInputStream( + entry, + StandardOpenOption.READ, + LinkOption.NOFOLLOW_LINKS + )) { + int length; + while ((length = input.read(buffer)) > 0) { + entryBytes += length; + if (entryBytes > expectedBytes) { + throw new IOException("Datapack file changed while hashing: " + relative); + } + digest.update(buffer, 0, length); + } + } + if (entryBytes != expectedBytes) { + throw new IOException("Datapack file changed while hashing: " + relative); + } + } + } + return DatapackSupport.hex(digest.digest()); + } catch (NoSuchAlgorithmException e) { + throw new IOException("SHA-256 algorithm unavailable", e); + } + } + + static void removeFinderMetadata(File root) throws IOException { + List entries; + try (Stream paths = Files.walk(root.toPath())) { + entries = paths.limit(MAX_MANAGED_PATHS + 1L).toList(); + } + if (entries.size() > MAX_MANAGED_PATHS) { + throw new IOException("Datapack contains more than " + MAX_MANAGED_PATHS + " paths"); + } + for (Path path : entries) { + if (!isFinderMetadata(path)) { + continue; + } + if (Files.isSymbolicLink(path) + || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Suspicious Finder metadata in datapack: " + path); + } + Files.delete(path); + } + } + + static boolean isFinderMetadata(Path path) { + Path fileName = path.getFileName(); + return fileName != null && FINDER_METADATA.equals(fileName.toString()); + } + + static PackResources scanPackResources(File root) throws IOException { + TreeSet structureKeys = new TreeSet<>(); + TreeSet structureSetKeys = new TreeSet<>(); + TreeSet templateKeys = new TreeSet<>(); + Path dataRoot = new File(root, "data").toPath(); + if (!Files.isDirectory(dataRoot, LinkOption.NOFOLLOW_LINKS)) { + return new PackResources(new ArrayList<>(), new ArrayList<>(), new ArrayList<>()); + } + try (Stream paths = Files.walk(dataRoot)) { + for (Path path : paths.filter(file -> Files.isRegularFile(file, LinkOption.NOFOLLOW_LINKS)).toList()) { + Path relative = dataRoot.relativize(path); + if (relative.getNameCount() < 3) { + continue; + } + String namespace = relative.getName(0).toString().toLowerCase(Locale.ROOT); + String normalized = relative.subpath(1, relative.getNameCount()).toString().replace(File.separatorChar, '/'); + addResourceKey(structureKeys, namespace, normalized, "worldgen/structure/", ".json"); + addResourceKey(structureKeys, namespace, normalized, "worldgen/structures/", ".json"); + addResourceKey(structureSetKeys, namespace, normalized, "worldgen/structure_set/", ".json"); + addResourceKey(structureSetKeys, namespace, normalized, "worldgen/structure_sets/", ".json"); + addResourceKey(templateKeys, namespace, normalized, "structure/", ".nbt"); + addResourceKey(templateKeys, namespace, normalized, "structures/", ".nbt"); + } + } + return new PackResources( + new ArrayList<>(structureKeys), + new ArrayList<>(structureSetKeys), + new ArrayList<>(templateKeys)); + } + + static void addResourceKey(Set keys, String namespace, String path, String prefix, String suffix) { + if (!path.startsWith(prefix) || !path.endsWith(suffix)) { + return; + } + String resourcePath = path.substring(prefix.length(), path.length() - suffix.length()); + if (!resourcePath.isBlank()) { + keys.add(namespace + ":" + resourcePath); + } + } + + static boolean deleteOwnedDirectory(File directory, String id) throws IOException { + Path path = directory.toPath(); + if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + return false; + } + if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing non-directory or symbolic-link target " + directory.getPath()); + } + Ownership ownership = readOwnership(directory); + if (!id.equals(ownership.id)) { + throw new IOException("Ownership marker belongs to '" + ownership.id + "'"); + } + removeFinderMetadata(directory); + if (!Objects.equals(ownership.contentHash, directoryHash(directory))) { + throw new IOException("Refusing to delete modified or corrupt Iris-managed datapack " + directory.getPath()); + } + File parent = Objects.requireNonNull(directory.getParentFile(), "managed datapack parent"); + DatapackInstall.validateInstallTree(directory, parent, "Managed datapack deletion"); + IO.delete(directory); + if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Could not delete " + directory.getPath()); + } + return true; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackPackMetadata.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackPackMetadata.java new file mode 100644 index 000000000..4a529e39c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackPackMetadata.java @@ -0,0 +1,155 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.ServerConfigurator; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.engine.object.IrisDimension; +import art.arcane.iris.engine.object.IrisImportedStructureControl; +import art.arcane.volmlib.util.io.IO; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.util.stream.Stream; + +final class DatapackPackMetadata { + static final String OVERRIDES_STRIPPED_MARKER = ".iris-overrides-stripped"; + + static final long MAX_METADATA_BYTES = 1024L * 1024L; + + private DatapackPackMetadata() { + } + + static boolean resolveStripOverrides() { + try (Stream stream = ServerConfigurator.allPacks()) { + return stream.anyMatch(DatapackPackMetadata::packDisablesOverrides); + } + } + + static boolean packDisablesOverrides(IrisData data) { + if (data == null || data.getDimensionLoader() == null) { + return false; + } + for (IrisDimension dimension : data.getDimensionLoader().loadAll(data.getDimensionLoader().getPossibleKeys())) { + if (dimension == null) { + continue; + } + IrisImportedStructureControl control = dimension.getImportedStructures(); + if (control != null && !control.isDatapackOverrides()) { + return true; + } + } + return false; + } + + static void stripVanillaStructureOverrides(File datapackRoot) throws IOException { + stripVanillaStructureOverrides(datapackRoot, IO::delete); + } + + static void stripVanillaStructureOverrides( + File datapackRoot, + DirectoryDeleter deleter + ) throws IOException { + File minecraftData = new File(new File(datapackRoot, "data"), "minecraft"); + if (!minecraftData.isDirectory()) { + return; + } + String[] relativeTrees = { + "worldgen" + File.separator + "structure_set", + "worldgen" + File.separator + "structure", + "worldgen" + File.separator + "template_pool", + "structure" + }; + for (String tree : relativeTrees) { + File dir = new File(minecraftData, tree); + if (dir.exists()) { + deleter.delete(dir); + if (Files.exists(dir.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Could not remove vanilla structure override tree " + dir.getPath()); + } + } + } + } + + static void writeMarker(File marker) throws IOException { + Files.writeString(marker.toPath(), "stripped", StandardCharsets.UTF_8); + } + + static void validatePackMetadata(File datapackRoot) throws IOException { + File metadata = new File(datapackRoot, "pack.mcmeta"); + if (!metadata.isFile() || Files.isSymbolicLink(metadata.toPath())) { + throw new IOException("Datapack is missing a regular pack.mcmeta"); + } + if (metadata.length() > MAX_METADATA_BYTES) { + throw new IOException("Datapack pack.mcmeta exceeds 1 MiB"); + } + JsonElement parsed; + try { + parsed = JsonParser.parseString(DatapackSupport.readBoundedUtf8( + metadata.toPath(), MAX_METADATA_BYTES, "Datapack pack.mcmeta")); + } catch (RuntimeException e) { + throw new IOException("Datapack pack.mcmeta is not valid JSON", e); + } + if (!parsed.isJsonObject()) { + throw new IOException("Datapack pack.mcmeta root must be an object"); + } + JsonObject root = parsed.getAsJsonObject(); + if (!root.has("pack") || !root.get("pack").isJsonObject()) { + throw new IOException("Datapack pack.mcmeta must contain a pack object"); + } + JsonObject pack = root.getAsJsonObject("pack"); + boolean hasPackFormat = pack.has("pack_format") && pack.get("pack_format").isJsonPrimitive() + && pack.getAsJsonPrimitive("pack_format").isNumber(); + boolean hasRange = validFormatValue(pack.get("min_format")) && validFormatValue(pack.get("max_format")); + if (!hasPackFormat && !hasRange) { + throw new IOException("Datapack pack.mcmeta must declare numeric pack_format or valid min_format/max_format"); + } + if (!pack.has("description") || pack.get("description").isJsonNull()) { + throw new IOException("Datapack pack.mcmeta must declare a description"); + } + File data = new File(datapackRoot, "data"); + if (data.exists() && (!data.isDirectory() || Files.isSymbolicLink(data.toPath()))) { + throw new IOException("Datapack data path is not a regular directory"); + } + } + + static boolean validFormatValue(JsonElement value) { + if (value == null || value.isJsonNull()) { + return false; + } + if (value.isJsonPrimitive() && value.getAsJsonPrimitive().isNumber()) { + return true; + } + if (!value.isJsonArray() || value.getAsJsonArray().size() != 2) { + return false; + } + for (JsonElement component : value.getAsJsonArray()) { + if (!component.isJsonPrimitive() || !component.getAsJsonPrimitive().isNumber()) { + return false; + } + } + return true; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackRemoval.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackRemoval.java new file mode 100644 index 000000000..3d5d4afa7 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackRemoval.java @@ -0,0 +1,468 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.core.ServerConfigurator; +import art.arcane.iris.core.structure.authoring.StructureKey; +import art.arcane.iris.core.structure.authoring.StructureSource; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; +import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.plugin.VolmitSender; + +import java.io.File; +import java.io.IOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.TreeSet; +import java.util.TreeMap; +import java.util.UUID; + +final class DatapackRemoval { + + private DatapackRemoval() { + } + + static RemoveOutcome removeOutcomeLocked(VolmitSender sender, String id) { + File root = IrisPlatforms.get().dataFolder("datapacks"); + return removeOutcomeLocked(sender, id, root, ServerConfigurator.getDatapacksFolder()); + } + + static boolean removeLocked(VolmitSender sender, String id, File root, List worldFolders) { + return removeOutcomeLocked(sender, id, root, worldFolders) == RemoveOutcome.REMOVED; + } + + static RemoveOutcome removeOutcomeLocked(VolmitSender sender, String id, File root, List worldFolders) { + String requested = id == null ? "" : id.trim().toLowerCase(Locale.ROOT); + String cleaned = DatapackArchive.sanitizeId(id); + if (requested.isBlank() || !requested.equals(cleaned) || DatapackArchive.RESERVED_IDS.contains(cleaned)) { + DatapackSupport.message(sender, C.RED + "Invalid Iris-managed datapack id '" + requested + "'. Run /iris datapack list and use the exact listed id."); + return RemoveOutcome.REJECTED; + } + try { + DatapackScratchRecovery.recoverTransactions(root, worldFolders); + } catch (IOException e) { + DatapackSupport.message(sender, C.RED + "Datapack removal blocked by incomplete transaction recovery: " + e.getMessage()); + IrisLogging.reportError(e); + return RemoveOutcome.REJECTED; + } + Manifest manifest = DatapackManifestStore.readManifest(root); + Entry ownedEntry = manifest.findById(cleaned); + if (ownedEntry == null) { + DatapackSupport.message(sender, C.YELLOW + "No Iris-managed datapack named '" + cleaned + "'. Unmanaged world datapacks are never removed by Iris."); + return RemoveOutcome.REJECTED; + } + + List targets; + try { + targets = preflightRemovalTargets(root, worldFolders, ownedEntry); + } catch (IOException e) { + DatapackSupport.message(sender, C.RED + "Refused to remove datapack '" + cleaned + "': " + e.getMessage()); + IrisLogging.reportError(e); + return RemoveOutcome.REJECTED; + } + + EditableImportRemoval editableRemoval = null; + DirectoryRemoval directoryRemoval = null; + ManifestWrite manifestWrite = null; + DatapackCoordinator coordinator = null; + try { + editableRemoval = prepareEntryImportRemoval(ownedEntry, manifest.entries); + directoryRemoval = prepareOwnedDirectories(targets); + if (!manifest.removeById(cleaned)) { + throw new IOException("Datapack manifest entry disappeared during removal"); + } + manifestWrite = DatapackManifestStore.prepareManifestWrite(root, manifest); + coordinator = DatapackTransactions.createRemovalCoordinator(root, ownedEntry, directoryRemoval, editableRemoval); + coordinator.phase(CoordinatorPhase.PUBLISHING); + directoryRemoval.prepare(); + coordinator.phase(CoordinatorPhase.PUBLISHED); + manifestWrite.publish(); + } catch (IOException | RuntimeException removalFailure) { + boolean manifestCommitted = manifestWrite != null && manifestWrite.published(); + if (manifestCommitted) { + finishCommittedRemoval(cleaned, manifestWrite, directoryRemoval, editableRemoval, coordinator, + removalFailure); + DatapackSupport.message(sender, C.GREEN + "Removed datapack '" + C.WHITE + cleaned + C.GREEN + + "'. Restart for it to stop generating, and delete its URL from the pack's datapackImports to keep it gone."); + return RemoveOutcome.REMOVED; + } + boolean restored = rollbackRemoval(manifestWrite, directoryRemoval, editableRemoval, removalFailure); + if (restored && coordinator != null) { + try { + coordinator.finish(); + } catch (IOException cleanupFailure) { + removalFailure.addSuppressed(cleanupFailure); + } + } + DatapackSupport.message(sender, C.RED + "Failed to remove datapack '" + cleaned + + "'; Iris attempted to restore every prior location: " + removalFailure.getMessage()); + IrisLogging.reportError(removalFailure); + // A mutation was attempted; even a successful rollback is not provably identical + // (the fingerprint does not cover datapacks/), so stay conservatively invalidated. + return RemoveOutcome.FAILED_AFTER_MUTATION; + } + finishCommittedRemoval(cleaned, manifestWrite, directoryRemoval, editableRemoval, coordinator, null); + DatapackSupport.message(sender, C.GREEN + "Removed datapack '" + C.WHITE + cleaned + C.GREEN + + "'. Restart for it to stop generating, and delete its URL from the pack's datapackImports to keep it gone."); + return RemoveOutcome.REMOVED; + } + + static void finishCommittedRemoval( + String id, + ManifestWrite manifestWrite, + DirectoryRemoval directoryRemoval, + EditableImportRemoval editableRemoval, + DatapackCoordinator coordinator, + Throwable priorFailure + ) { + if (priorFailure != null) { + IOException recoveryFailure = new IOException( + "Datapack manifest committed before publication durability was confirmed", + priorFailure + ); + if (editableRemoval != null) { + try { + editableRemoval.leaveForRecovery(); + } catch (IOException releaseFailure) { + recoveryFailure.addSuppressed(releaseFailure); + } + } + try { + manifestWrite.discard(); + } catch (IOException cleanupFailure) { + recoveryFailure.addSuppressed(cleanupFailure); + } + IrisLogging.reportError("Datapack '" + id + + "' was removed but transaction cleanup requires restart recovery.", recoveryFailure); + return; + } + + IOException failure = null; + if (coordinator != null) { + try { + coordinator.phase(CoordinatorPhase.COMMITTED); + } catch (IOException phaseFailure) { + failure = DatapackSupport.appendIOException(failure, phaseFailure); + if (editableRemoval != null) { + try { + editableRemoval.leaveForRecovery(); + } catch (IOException releaseFailure) { + failure = DatapackSupport.appendIOException(failure, releaseFailure); + } + } + try { + manifestWrite.discard(); + } catch (IOException cleanupFailure) { + failure = DatapackSupport.appendIOException(failure, cleanupFailure); + } + IrisLogging.reportError("Datapack '" + id + + "' was removed but transaction cleanup requires restart recovery.", failure); + return; + } + } + if (editableRemoval != null) { + try { + editableRemoval.markCommitted(); + editableRemoval.finishCommit(); + } catch (IOException | RuntimeException cleanupFailure) { + failure = DatapackSupport.appendIOException(failure, cleanupFailure); + try { + editableRemoval.leaveForRecovery(); + } catch (IOException releaseFailure) { + failure = DatapackSupport.appendIOException(failure, releaseFailure); + } + } + } + if (directoryRemoval != null) { + try { + directoryRemoval.finishCommit(); + } catch (IOException | RuntimeException cleanupFailure) { + failure = DatapackSupport.appendIOException(failure, cleanupFailure); + } + } + try { + manifestWrite.discard(); + } catch (IOException cleanupFailure) { + failure = DatapackSupport.appendIOException(failure, cleanupFailure); + } + if (failure == null && coordinator != null) { + try { + coordinator.finish(); + } catch (IOException cleanupFailure) { + failure = cleanupFailure; + } + } + if (failure != null) { + IrisLogging.reportError("Datapack '" + id + + "' was removed but transaction cleanup requires restart recovery.", failure); + } + } + + static List preflightRemovalTargets(File root, List worldFolders, Entry entry) throws IOException { + List targets = new ArrayList<>(); + Set seen = new HashSet<>(); + File staging = new File(root, "staging"); + DatapackSupport.verifyDirectoryContainerIfPresent(staging, "datapack staging"); + File stagedDir = new File(staging, entry.id); + verifyAndCollectRemovalTarget(stagedDir, entry, targets, seen); + for (File worldFolder : worldFolders) { + DatapackSupport.verifyDirectoryContainerIfPresent(worldFolder, "world datapacks"); + verifyAndCollectRemovalTarget(new File(worldFolder, entry.id), entry, targets, seen); + } + return targets; + } + + static void verifyAndCollectRemovalTarget( + File target, + Entry entry, + List targets, + Set seen + ) throws IOException { + verifyOwnedDirectoryIfPresent(target, entry); + Path normalized = target.toPath().toAbsolutePath().normalize(); + if (DatapackSupport.pathExists(normalized, "datapack removal target")) { + Path identity = normalized.toRealPath(); + if (!seen.add(identity)) { + throw new IOException("Aliased datapack removal target " + normalized); + } + targets.add(target); + } + } + + static EditableImportRemoval prepareEntryImportRemoval( + Entry entry, + List manifestEntries + ) throws IOException { + List prepared = new ArrayList<>(); + Set targetIdSet = new TreeSet<>(entry.importedBundles.keySet()); + targetIdSet.addAll(entry.importedTargets.keySet()); + targetIdSet.addAll(entry.importAttempts.keySet()); + List targetIds = new ArrayList<>(targetIdSet); + targetIds.sort(String::compareTo); + try { + for (String targetId : targetIds) { + Set retainedKeys = invalidateRetainedImportClaims( + entry, targetId, manifestEntries); + File dataFolder = new File(targetId); + if (!dataFolder.isDirectory()) { + continue; + } + StructureTransactionWriter writer = new StructureTransactionWriter(dataFolder.toPath()); + List removals = ownedImportRemovals( + writer, + entry, + targetId, + retainedKeys + ); + StructureTransactionWriter.PreparedRemoval removal = + writer.prepareMatchingOwnedRemovals(removals); + prepared.add(new PreparedEditableImport(dataFolder, removal)); + } + return new EditableImportRemoval(prepared); + } catch (IOException | RuntimeException preparationFailure) { + IOException failure = preparationFailure instanceof IOException ioFailure + ? ioFailure + : new IOException("Failed preparing editable datapack import cleanup", preparationFailure); + for (int i = prepared.size() - 1; i >= 0; i--) { + try { + prepared.get(i).removal().rollback(); + } catch (IOException rollbackFailure) { + failure.addSuppressed(rollbackFailure); + } + } + throw failure; + } + } + + static List ownedImportRemovals( + StructureTransactionWriter writer, + Entry removingEntry, + String targetId, + Set retainedKeys + ) throws IOException { + List removals = new ArrayList<>(); + Map> removingClaims = importBundleClaims(removingEntry, targetId); + for (Map.Entry> bundle : removingClaims.entrySet()) { + try { + StructureKey targetKey = StructureKey.parse(bundle.getKey()); + if (retainedKeys.contains(bundle.getKey())) { + continue; + } + Optional ownedSource = writer.ownedSource(targetKey); + if (ownedSource.isEmpty() || !sourceClaimsContain(bundle.getValue(), ownedSource.get())) { + continue; + } + removals.add(StructureTransactionWriter.OwnedRemoval.managedDatapack( + targetKey, + ownedSource.get().kind(), + ownedSource.get().key() + )); + } catch (RuntimeException e) { + throw new IOException("Invalid editable structure import inventory entry '" + + bundle.getKey() + "' -> '" + bundle.getValue() + "'", e); + } + } + return List.copyOf(removals); + } + + static Set invalidateRetainedImportClaims( + Entry removingEntry, + String targetId, + List manifestEntries + ) { + Set removingKeys = importBundleClaims(removingEntry, targetId).keySet(); + Set retainedKeys = new TreeSet<>(); + for (Entry candidate : manifestEntries) { + if (candidate == removingEntry) { + continue; + } + Set candidateKeys = importBundleClaims(candidate, targetId).keySet(); + boolean candidateRetained = false; + for (String candidateKey : candidateKeys) { + if (removingKeys.contains(candidateKey)) { + retainedKeys.add(candidateKey); + candidateRetained = true; + } + } + if (candidateRetained) { + candidate.importedTargets.remove(targetId); + candidate.importAttempts.remove(targetId); + candidate.structuresImported = false; + } + } + return Set.copyOf(retainedKeys); + } + + static Map> importBundleClaims(Entry entry, String targetId) { + Map> claims = new TreeMap<>(); + addImportBundleClaims(claims, entry.importedBundles.getOrDefault(targetId, Map.of())); + if (entry.importedBundles.containsKey(targetId) || entry.importedTargets.containsKey(targetId)) { + addImportBundleClaims(claims, DatapackStructureImports.importBundleInventory(entry)); + } + return claims; + } + + static void addImportBundleClaims( + Map> claims, + Map inventory + ) { + for (Map.Entry bundle : inventory.entrySet()) { + claims.computeIfAbsent(bundle.getKey(), ignored -> new TreeSet<>()).add(bundle.getValue()); + } + } + + static boolean sourceClaimsContain(Set claims, StructureSource source) throws IOException { + for (String claimedKey : claims) { + try { + StructureKey sourceKey = StructureKey.parse(claimedKey); + StructureSource.Kind sourceKind = sourceKey.namespace().equals("minecraft") + ? StructureSource.Kind.VANILLA : StructureSource.Kind.DATAPACK; + if (source.kind() == sourceKind && source.key().equals(sourceKey)) { + return true; + } + } catch (RuntimeException e) { + throw new IOException("Invalid editable structure source key '" + claimedKey + "'", e); + } + } + return false; + } + + static DirectoryRemoval prepareOwnedDirectories(List targets) throws IOException { + List planned = new ArrayList<>(); + for (File target : targets) { + File parent = target.getParentFile(); + File backupRoot = new File(parent.getParentFile() == null ? parent : parent.getParentFile(), ".iris-datapack-remove"); + File backup = new File(backupRoot, target.getName() + "-" + UUID.randomUUID()); + DatapackSupport.ensureScratchDirectory(backupRoot, "datapack removal backup"); + DatapackInstall.validateInstallTree(target, parent, "Datapack removal target"); + planned.add(new DirectoryMove( + target, + backup, + DatapackOwnership.directoryHash(target), + DatapackOwnership.ownershipMarkerFingerprint(target), + DatapackSupport.directoryIdentity(target), + DatapackSupport.realDirectoryPath(parent, "datapack target root"), + DatapackSupport.realDirectoryPath(backupRoot, "datapack removal scratch root"), + DatapackSupport.directoryIdentity(parent), + DatapackSupport.directoryIdentity(backupRoot) + )); + } + return new DirectoryRemoval(planned); + } + + static boolean rollbackRemoval( + ManifestWrite manifestWrite, + DirectoryRemoval directoryRemoval, + EditableImportRemoval editableRemoval, + Throwable removalFailure + ) { + if (manifestWrite != null) { + try { + manifestWrite.discard(); + } catch (IOException discardFailure) { + removalFailure.addSuppressed(discardFailure); + } + } + if (directoryRemoval != null) { + try { + directoryRemoval.rollback(); + } catch (IOException rollbackFailure) { + removalFailure.addSuppressed(rollbackFailure); + } + } + if (editableRemoval != null) { + try { + editableRemoval.rollback(); + } catch (IOException rollbackFailure) { + removalFailure.addSuppressed(rollbackFailure); + } + } + return removalFailure.getSuppressed().length == 0; + } + + static void verifyOwnedDirectoryIfPresent(File directory, Entry entry) throws IOException { + if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + return; + } + if (Files.isSymbolicLink(directory.toPath()) + || !Files.isDirectory(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing non-directory or symbolic-link target " + directory.getPath()); + } + Ownership ownership = DatapackOwnership.readOwnership(directory); + if (!DatapackInstall.ownershipSourceMatches(ownership, entry)) { + throw new IOException("Ownership marker at " + directory.getPath() + " belongs to '" + ownership.id + "'"); + } + DatapackOwnership.removeFinderMetadata(directory); + if (!Objects.equals(ownership.contentHash, DatapackOwnership.directoryHash(directory))) { + throw new IOException("Refusing to remove modified or corrupt Iris-managed datapack " + directory.getPath()); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackScratchRecovery.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackScratchRecovery.java new file mode 100644 index 000000000..be8a88aad --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackScratchRecovery.java @@ -0,0 +1,436 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.File; +import java.io.IOException; +import java.nio.file.FileVisitResult; +import java.nio.file.FileStore; +import java.nio.file.FileSystems; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.SimpleFileVisitor; +import java.nio.file.attribute.BasicFileAttributes; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.TreeSet; +import java.util.TreeMap; +import java.util.UUID; +import java.util.stream.Stream; + +final class DatapackScratchRecovery { + static final int WINDOWS_LEGACY_PATH_LIMIT = 247; + + private DatapackScratchRecovery() { + } + + static boolean recoverTransactions(File root, List worldFolders) throws IOException { + boolean changed = recoverStagingScratch(new File(root, "staging")); + File transactionDirectory = new File(root, DatapackTransactions.TRANSACTION_DIRECTORY); + Path transactionPath = transactionDirectory.toPath(); + if (!Files.exists(transactionPath, LinkOption.NOFOLLOW_LINKS)) { + return recoverInstallScratch(root, worldFolders) | changed; + } + DatapackSupport.verifyDirectoryContainerIfPresent(transactionDirectory, "datapack transaction"); + Manifest committedManifest = DatapackManifestStore.readCommittedManifest(root); + List transactionRoots; + try (Stream paths = Files.list(transactionPath)) { + transactionRoots = paths.limit(DatapackTransactions.MAX_TRANSACTION_COUNT + 2L).sorted().toList(); + } + if (transactionRoots.size() == DatapackTransactions.MAX_TRANSACTION_COUNT + 2) { + throw new IOException("Datapack transaction directory contains too many entries"); + } + int transactionCount = 0; + for (Path transactionRoot : transactionRoots) { + if (isHarmlessRecoveryArtifact(transactionRoot)) { + continue; + } + transactionCount++; + if (transactionCount > DatapackTransactions.MAX_TRANSACTION_COUNT) { + throw new IOException("Datapack transaction count exceeds " + DatapackTransactions.MAX_TRANSACTION_COUNT); + } + } + for (Path transactionRoot : transactionRoots) { + if (isHarmlessRecoveryArtifact(transactionRoot)) { + changed |= Files.deleteIfExists(transactionRoot); + continue; + } + recoverTransaction(root, worldFolders, committedManifest, transactionPath, transactionRoot); + changed = true; + } + changed |= transactionDirectory.delete(); + return recoverInstallScratch(root, worldFolders) | changed; + } + + static boolean recoverInstallScratch(File root, List worldFolders) throws IOException { + Set scratchRoots = new TreeSet<>(); + scratchRoots.add(DatapackInstall.installScratchRoot(new File(root, "staging")).toPath().toAbsolutePath().normalize()); + for (File worldFolder : worldFolders) { + scratchRoots.add(DatapackInstall.installScratchRoot(worldFolder).toPath().toAbsolutePath().normalize()); + } + boolean changed = false; + for (Path scratchRoot : scratchRoots) { + changed |= recoverInstallScratchRoot(scratchRoot); + } + return changed; + } + + static boolean recoverInstallScratchRoot(Path scratchRoot) throws IOException { + if (!Files.exists(scratchRoot, LinkOption.NOFOLLOW_LINKS)) { + return false; + } + DatapackSupport.verifyDirectoryContainerIfPresent(scratchRoot.toFile(), "datapack install scratch"); + List children; + try (Stream paths = Files.list(scratchRoot)) { + children = paths.limit(DatapackOwnership.MAX_MANAGED_PATHS + 2L).sorted().toList(); + } + int managedEntries = 0; + for (Path child : children) { + if (!isHarmlessRecoveryArtifact(child)) { + managedEntries++; + } + if (managedEntries > DatapackOwnership.MAX_MANAGED_PATHS) { + throw new IOException("Datapack install scratch contains too many entries"); + } + } + + List pending = new ArrayList<>(); + List backups = new ArrayList<>(); + boolean changed = false; + for (Path child : children) { + if (isHarmlessRecoveryArtifact(child)) { + changed |= Files.deleteIfExists(child); + continue; + } + StagingScratch scratch = parseInstallScratch(scratchRoot, child); + if (scratch == null) { + throw new IOException("Unexpected datapack install scratch artifact " + child); + } + if (Files.isSymbolicLink(child) || !Files.isDirectory(child, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid datapack install scratch artifact " + child); + } + validateScratchTree(child); + if (scratch.kind() == StagingScratchKind.BACKUP) { + backups.add(scratch); + } else { + pending.add(scratch); + } + } + if (!backups.isEmpty()) { + throw new IOException("Preserving unjournaled datapack install backup " + + backups.getFirst().path()); + } + for (StagingScratch scratch : pending) { + DatapackInstall.deleteInstallScratch(scratch.path().toFile(), "orphan datapack install pending directory"); + changed = true; + } + changed |= scratchRoot.toFile().delete(); + return changed; + } + + static StagingScratch parseInstallScratch(Path scratchRoot, Path child) throws IOException { + Path normalized = child.toAbsolutePath().normalize(); + if (!Objects.equals(normalized.getParent(), scratchRoot)) { + throw new IOException("Datapack install scratch artifact escapes its root: " + child); + } + String name = normalized.getFileName().toString(); + int uuidStart = name.length() - 36; + if (uuidStart <= 1 || name.charAt(uuidStart - 1) != '-') { + return null; + } + try { + UUID.fromString(name.substring(uuidStart)); + } catch (IllegalArgumentException e) { + return null; + } + String stem = name.substring(0, uuidStart - 1); + StagingScratchKind kind = stem.endsWith("-backup") + ? StagingScratchKind.BACKUP : StagingScratchKind.PENDING; + String id = kind == StagingScratchKind.BACKUP + ? stem.substring(0, stem.length() - "-backup".length()) : stem; + if (id.isBlank() || !id.equals(DatapackArchive.sanitizeId(id)) || DatapackArchive.RESERVED_IDS.contains(id)) { + return null; + } + return new StagingScratch(kind, id, normalized); + } + + static boolean recoverStagingScratch(File stagingDirectory) throws IOException { + Path stagingRoot = stagingDirectory.toPath().toAbsolutePath().normalize(); + if (!Files.exists(stagingRoot, LinkOption.NOFOLLOW_LINKS)) { + return false; + } + DatapackSupport.verifyDirectoryContainerIfPresent(stagingDirectory, "datapack staging"); + List children; + try (Stream paths = Files.list(stagingRoot)) { + children = paths.limit(DatapackOwnership.MAX_MANAGED_PATHS + 1L).sorted().toList(); + } + if (children.size() > DatapackOwnership.MAX_MANAGED_PATHS) { + throw new IOException("Datapack staging contains too many entries"); + } + + List pending = new ArrayList<>(); + Map> backups = new TreeMap<>(); + for (Path child : children) { + StagingScratch scratch = parseStagingScratch(stagingRoot, child); + if (scratch == null) { + continue; + } + if (Files.isSymbolicLink(child) || !Files.isDirectory(child, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid datapack staging scratch artifact " + child); + } + if (scratch.kind() == StagingScratchKind.PENDING) { + validateScratchTree(child); + pending.add(scratch); + } else { + backups.computeIfAbsent(scratch.id(), ignored -> new ArrayList<>()).add(scratch); + } + } + + for (Map.Entry> entry : backups.entrySet()) { + if (entry.getValue().size() != 1) { + throw new IOException("Ambiguous datapack staging backups for '" + entry.getKey() + "'"); + } + StagingScratch backup = entry.getValue().getFirst(); + Ownership backupOwnership = verifyManagedScratchDirectory(backup.path().toFile(), backup.id()); + Path target = stagingRoot.resolve(backup.id()).normalize(); + if (!Objects.equals(target.getParent(), stagingRoot)) { + throw new IOException("Datapack staging backup target escapes its root"); + } + if (Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { + Ownership targetOwnership = verifyManagedScratchDirectory(target.toFile(), backup.id()); + if (!Objects.equals(backupOwnership.url, targetOwnership.url)) { + throw new IOException("Datapack staging backup source does not match its target: " + target); + } + } + } + + boolean changed = false; + for (List matches : backups.values()) { + StagingScratch backup = matches.getFirst(); + Path target = stagingRoot.resolve(backup.id()).normalize(); + if (Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { + DatapackCoordinatorResolution.deleteVerifiedDirectory(backup.path().toFile()); + } else { + DatapackSupport.moveNew(backup.path(), target); + } + changed = true; + } + for (StagingScratch scratch : pending) { + DatapackCoordinatorResolution.deleteVerifiedDirectory(scratch.path().toFile()); + changed = true; + } + DatapackSupport.forceDirectoryIfSupported(stagingRoot); + return changed; + } + + static StagingScratch parseStagingScratch(Path stagingRoot, Path child) throws IOException { + Path normalized = child.toAbsolutePath().normalize(); + if (!Objects.equals(normalized.getParent(), stagingRoot)) { + throw new IOException("Datapack staging artifact escapes its root: " + child); + } + String name = normalized.getFileName().toString(); + StagingScratchKind kind; + String prefix; + if (name.startsWith(".pending-")) { + kind = StagingScratchKind.PENDING; + prefix = ".pending-"; + } else if (name.startsWith(".backup-")) { + kind = StagingScratchKind.BACKUP; + prefix = ".backup-"; + } else { + return null; + } + int uuidStart = name.length() - 36; + if (uuidStart <= prefix.length() || name.charAt(uuidStart - 1) != '-') { + return null; + } + String id = name.substring(prefix.length(), uuidStart - 1); + if (!id.equals(DatapackArchive.sanitizeId(id)) || DatapackArchive.RESERVED_IDS.contains(id)) { + return null; + } + try { + UUID.fromString(name.substring(uuidStart)); + } catch (IllegalArgumentException e) { + return null; + } + return new StagingScratch(kind, id, normalized); + } + + static void validateScratchTree(Path root) throws IOException { + FileStore rootStore = Files.getFileStore(root); + int[] pathCount = new int[]{0}; + Files.walkFileTree(root, new SimpleFileVisitor<>() { + private FileVisitResult inspect(Path entry, BasicFileAttributes attributes) throws IOException { + pathCount[0]++; + if (pathCount[0] > DatapackOwnership.MAX_MANAGED_PATHS) { + throw new IOException("Datapack scratch contains too many paths: " + root); + } + if (attributes.isSymbolicLink() + || attributes.isOther() + || (!attributes.isDirectory() && !attributes.isRegularFile())) { + throw new IOException("Datapack scratch contains an unsupported file: " + entry); + } + if (!DatapackOwnership.sameDatapackVolume(root, rootStore, entry)) { + throw new IOException("Datapack scratch crosses a filesystem boundary: " + entry); + } + return FileVisitResult.CONTINUE; + } + + @Override + public FileVisitResult preVisitDirectory( + Path directory, + BasicFileAttributes attributes + ) throws IOException { + return inspect(directory, attributes); + } + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attributes) throws IOException { + return inspect(file, attributes); + } + + @Override + public FileVisitResult visitFileFailed(Path file, IOException failure) throws IOException { + throw new IOException("Unable to inspect datapack scratch entry: " + file, failure); + } + }); + } + + static boolean sameScratchVolume(Path first, Path second) throws IOException { + return sameScratchVolume(first, Files.getFileStore(first), second, Files.getFileStore(second)); + } + + static boolean sameScratchVolume( + Path first, + FileStore firstStore, + Path second, + FileStore secondStore + ) { + if (Objects.equals(firstStore, secondStore)) { + return true; + } + if (!isDefaultWindowsPath(first) || !isDefaultWindowsPath(second)) { + return false; + } + Path firstAbsolute = first.toAbsolutePath().normalize(); + Path secondAbsolute = second.toAbsolutePath().normalize(); + if ((firstAbsolute.toString().length() > WINDOWS_LEGACY_PATH_LIMIT) + == (secondAbsolute.toString().length() > WINDOWS_LEGACY_PATH_LIMIT)) { + return false; + } + Path firstRoot = firstAbsolute.getRoot(); + Path secondRoot = secondAbsolute.getRoot(); + if (firstRoot == null || secondRoot == null) { + return false; + } + return sameWindowsVolume( + firstStore, firstRoot.toString(), secondStore, secondRoot.toString()); + } + + static boolean sameWindowsVolume( + FileStore firstStore, + String firstRoot, + FileStore secondStore, + String secondRoot + ) { + if (firstRoot == null || secondRoot == null || !firstRoot.equalsIgnoreCase(secondRoot)) { + return false; + } + try { + Object firstSerial = firstStore.getAttribute("volume:vsn"); + Object secondSerial = secondStore.getAttribute("volume:vsn"); + return firstSerial != null && firstSerial.equals(secondSerial); + } catch (IOException | RuntimeException exception) { + return false; + } + } + + static boolean isSupportedScratchDirectory(BasicFileAttributes attributes) { + return attributes != null + && attributes.isDirectory() + && !attributes.isSymbolicLink() + && !attributes.isOther(); + } + + static boolean isDefaultWindowsPath(Path path) { + return File.separatorChar == '\\' + && path.getFileSystem().equals(FileSystems.getDefault()); + } + + static Ownership verifyManagedScratchDirectory(File directory, String id) throws IOException { + DatapackOwnership.validateManagedDirectory(directory, id); + Ownership ownership = DatapackOwnership.readOwnership(directory); + if (!Objects.equals(ownership.contentHash, DatapackOwnership.directoryHash(directory))) { + throw new IOException("Datapack staging backup is modified or corrupt: " + directory.getPath()); + } + return ownership; + } + + static boolean isHarmlessRecoveryArtifact(Path path) throws IOException { + if (!DatapackOwnership.isFinderMetadata(path)) { + return false; + } + if (Files.isSymbolicLink(path) || !Files.isRegularFile(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Suspicious datapack recovery artifact " + path); + } + return true; + } + + static void recoverTransaction( + File root, + List worldFolders, + Manifest committedManifest, + Path transactionDirectory, + Path transactionRoot + ) throws IOException { + Path normalizedRoot = transactionRoot.toAbsolutePath().normalize(); + if (!Objects.equals(normalizedRoot.getParent(), transactionDirectory.toAbsolutePath().normalize()) + || Files.isSymbolicLink(normalizedRoot) + || !Files.isDirectory(normalizedRoot, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid datapack transaction directory " + transactionRoot); + } + try { + UUID.fromString(normalizedRoot.getFileName().toString()); + } catch (IllegalArgumentException e) { + throw new IOException("Invalid datapack transaction directory name " + transactionRoot, e); + } + CoordinatorJournal journal = DatapackTransactions.readCoordinatorJournal(normalizedRoot); + if (journal == null) { + DatapackTransactions.deleteCoordinatorTransaction(normalizedRoot); + return; + } + DatapackTransactions.validateCoordinatorJournal(root, worldFolders, committedManifest, normalizedRoot, journal); + boolean commit = DatapackCoordinatorResolution.coordinatorCommitDecision(committedManifest, journal); + DatapackCoordinatorResolution.resolveCoordinatorDirectories(journal, commit); + DatapackCoordinatorResolution.resolveCoordinatorEditables(journal, normalizedRoot, commit); + DatapackTransactions.deleteCoordinatorTransaction(normalizedRoot); + } + + enum StagingScratchKind { + PENDING, + BACKUP + } + + record StagingScratch(StagingScratchKind kind, String id, Path path) { + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingGuard.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingGuard.java new file mode 100644 index 000000000..ac7033637 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingGuard.java @@ -0,0 +1,256 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Report; +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.plugin.VolmitSender; +import art.arcane.volmlib.util.collection.KList; + +import java.io.File; +import java.io.IOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; + +final class DatapackStagingGuard { + + private DatapackStagingGuard() { + } + + static VerifiedStagingInstall authorizeVerifiedStagingInstall( + File root, + File stagingRoot, + File verifiedSource, + Entry entry + ) throws IOException { + Path normalizedRoot = DatapackSupport.requireDirectoryIdentity(root, "datapack storage root"); + Path normalizedStagingRoot = DatapackSupport.requireDirectoryIdentity(stagingRoot, "datapack staging root"); + DatapackSupport.requireNoSymbolicLinkComponents(normalizedRoot, "datapack storage root"); + DatapackSupport.requireNoSymbolicLinkComponents(normalizedStagingRoot, "datapack staging root"); + Path expectedStagingRoot = normalizedRoot.resolve("staging").normalize(); + if (!normalizedStagingRoot.equals(expectedStagingRoot) + || !Files.isSameFile(normalizedStagingRoot, expectedStagingRoot)) { + throw new IOException("Verified datapack staging root is not Iris's canonical staging directory"); + } + Path normalizedSource = DatapackSupport.requireDirectoryIdentity(verifiedSource, "verified datapack extraction"); + DatapackSupport.requireNoSymbolicLinkComponents(normalizedSource, "verified datapack extraction"); + if (!Objects.equals(normalizedSource.getParent(), normalizedStagingRoot) + || !Files.isSameFile(normalizedSource.getParent(), normalizedStagingRoot)) { + throw new IOException("Verified datapack extraction is outside Iris's canonical staging directory"); + } + verifyPendingExtractionName(normalizedSource.getFileName().toString(), entry.id); + DatapackOwnership.validateManagedDirectory(verifiedSource, entry.id); + DatapackScratchRecovery.validateScratchTree(normalizedSource); + if (!DatapackScratchRecovery.sameScratchVolume(normalizedSource, normalizedStagingRoot)) { + throw new IOException("Verified datapack extraction crosses a filesystem boundary"); + } + String desiredHash = DatapackOwnership.directoryHash(verifiedSource); + Ownership ownership = DatapackOwnership.readOwnership(verifiedSource); + if (!DatapackInstall.ownershipMetadataMatches(ownership, entry, desiredHash)) { + throw new IOException("Verified datapack extraction does not match the resolved archive metadata"); + } + Manifest committedManifest = DatapackManifestStore.readCommittedManifest(root); + Entry committed = committedManifest.findById(entry.id); + boolean legacyReplacementAuthorized = committed != null + && Objects.equals(committed.id, entry.id) + && Objects.equals(committed.url, entry.url); + LegacyStagingSnapshot legacyStagingSnapshot = captureLegacyStagingSnapshot( + normalizedStagingRoot, entry.id, legacyReplacementAuthorized); + return new VerifiedStagingInstall( + normalizedRoot, + normalizedStagingRoot, + normalizedSource, + entry, + desiredHash, + committed, + legacyReplacementAuthorized, + legacyStagingSnapshot + ); + } + + static LegacyStagingSnapshot captureLegacyStagingSnapshot( + Path normalizedStagingRoot, + String id, + boolean legacyReplacementAuthorized + ) throws IOException { + if (!legacyReplacementAuthorized) { + return null; + } + Path target = normalizedStagingRoot.resolve(id).normalize(); + if (!DatapackSupport.pathExists(target, "legacy datapack staging target")) { + return null; + } + if (Files.isSymbolicLink(target) + || !Files.isDirectory(target, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid legacy datapack staging target " + target); + } + DatapackInstall.validateInstallTree(target.toFile(), normalizedStagingRoot.toFile(), "Legacy datapack staging"); + String markerHash = DatapackOwnership.ownershipMarkerFingerprint(target.toFile()); + if (!"absent".equals(markerHash)) { + return null; + } + return new LegacyStagingSnapshot( + target, + target.toRealPath(), + DatapackSupport.directoryIdentity(target.toFile()), + DatapackOwnership.directoryHash(target.toFile()), + markerHash + ); + } + + static void verifyPendingExtractionName(String name, String id) throws IOException { + String prefix = ".pending-" + id + "-"; + if (!name.startsWith(prefix)) { + throw new IOException("Verified datapack extraction has an invalid staging name " + name); + } + try { + UUID.fromString(name.substring(prefix.length())); + } catch (IllegalArgumentException e) { + throw new IOException("Verified datapack extraction has an invalid staging identity " + name, e); + } + } + + static void validateInstallParticipants( + List worldFolders, + VerifiedStagingInstall verifiedStagingInstall, + Entry entry + ) throws IOException { + List roots = new ArrayList<>(worldFolders); + if (verifiedStagingInstall != null) { + roots.add(verifiedStagingInstall.stagingRoot().toFile()); + } + Set normalizedTargets = new HashSet<>(); + Set realRoots = new HashSet<>(); + Set targetIdentities = new HashSet<>(); + List existingTargets = new ArrayList<>(); + for (File folder : roots) { + ensureInstallTargetRoot(folder); + Path normalizedRoot = folder.toPath().toAbsolutePath().normalize(); + Path realRoot = normalizedRoot.toRealPath(); + Path normalizedTarget = normalizedRoot.resolve(entry.id).normalize(); + if (!realRoots.add(realRoot) || !normalizedTargets.add(normalizedTarget)) { + throw new IOException("Duplicate datapack install target " + normalizedTarget); + } + Path targetIdentity = realRoot.resolve(entry.id).normalize(); + if (Files.exists(normalizedTarget, LinkOption.NOFOLLOW_LINKS)) { + if (Files.isSymbolicLink(normalizedTarget) + || !Files.isDirectory(normalizedTarget, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing invalid datapack install target " + normalizedTarget); + } + targetIdentity = normalizedTarget.toRealPath(); + for (Path existingTarget : existingTargets) { + if (Files.isSameFile(normalizedTarget, existingTarget)) { + throw new IOException("Aliased datapack install target " + normalizedTarget); + } + } + existingTargets.add(normalizedTarget); + } + if (!targetIdentities.add(targetIdentity)) { + throw new IOException("Aliased datapack install target " + normalizedTarget); + } + } + if (verifiedStagingInstall != null) { + verifiedStagingInstall.verifyStagingRoot(); + } + } + + static void ensureInstallTargetRoot(File directory) throws IOException { + if (!Files.exists(directory.toPath(), LinkOption.NOFOLLOW_LINKS)) { + Files.createDirectories(directory.toPath()); + } + DatapackSupport.requireDirectoryIdentity(directory, "datapack install root"); + } + + static void recordInstallResult( + VolmitSender sender, + Report report, + File stagedDir, + KList worldFolders, + Entry entry, + InstallResult result, + String versionNumber + ) { + DatapackStagingReapply.recordInstallMetadata(stagedDir, worldFolders, entry); + if (result.changed()) { + report.updated.add(entry.id + " (" + DatapackSupport.safe(versionNumber) + ")"); + report.requiresRestart = true; + DatapackSupport.message(sender, C.GREEN + " Repaired " + C.WHITE + entry.id + C.GREEN + " " + DatapackSupport.safe(versionNumber)); + return; + } + report.upToDate.add(entry.id + " (" + DatapackSupport.safe(versionNumber) + ")"); + DatapackSupport.message(sender, C.GRAY + " Up to date: " + C.WHITE + entry.id + C.GRAY + " " + DatapackSupport.safe(versionNumber)); + } + + static boolean isUsableStaging(File stagedDir, Entry entry) { + return inspectUsableStaging(stagedDir, entry).usable(); + } + + static StagingInspection inspectUsableStaging(File stagedDir, Entry entry) { + try { + DatapackOwnership.validateManagedDirectory(stagedDir, entry.id); + Ownership ownership = DatapackOwnership.readOwnership(stagedDir); + String contentHash = DatapackOwnership.directoryHash(stagedDir); + if (!DatapackInstall.ownershipSourceMatches(ownership, entry) + || !Objects.equals(ownership.versionId, entry.versionId) + || !Objects.equals(ownership.versionNumber, entry.versionNumber) + || !Objects.equals(ownership.sha1, entry.sha1) + || !Objects.equals(ownership.contentHash, contentHash)) { + return new StagingInspection(false, false, false); + } + PackResources resources = DatapackOwnership.scanPackResources(stagedDir); + List previousStructureKeys = DatapackManifestStore.copyList(entry.structureKeys); + List previousTemplateKeys = DatapackManifestStore.copyList(entry.templateKeys); + boolean ownershipCorrected = false; + if (!DatapackManifestStore.copyList(resources.structureKeys()).equals(DatapackManifestStore.copyList(ownership.structureKeys)) + || !DatapackManifestStore.copyList(resources.templateKeys()).equals(DatapackManifestStore.copyList(ownership.templateKeys))) { + Entry corrected = DatapackManifestStore.copyEntry(entry); + corrected.structureKeys = resources.structureKeys(); + corrected.templateKeys = resources.templateKeys(); + DatapackOwnership.writeOwnership(stagedDir, corrected); + ownershipCorrected = true; + } + entry.structureKeys = resources.structureKeys(); + entry.templateKeys = resources.templateKeys(); + boolean manifestChanged = !previousStructureKeys.equals(DatapackManifestStore.copyList(entry.structureKeys)) + || !previousTemplateKeys.equals(DatapackManifestStore.copyList(entry.templateKeys)); + return new StagingInspection(true, ownershipCorrected, manifestChanged); + } catch (IOException e) { + IrisLogging.warn("Ignoring unusable Iris datapack staging at " + stagedDir.getPath() + ": " + e.getMessage()); + return new StagingInspection(false, false, false); + } + } + + record LegacyStagingSnapshot( + Path normalizedTarget, + Path realTarget, + String targetIdentity, + String contentHash, + String markerHash + ) { + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingReapply.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingReapply.java new file mode 100644 index 000000000..df6404551 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStagingReapply.java @@ -0,0 +1,312 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.ReapplyOutcome; +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.volmlib.util.collection.KList; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.attribute.BasicFileAttributes; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.stream.Stream; + +final class DatapackStagingReapply { + + private DatapackStagingReapply() { + } + + static ReapplyOutcome reapplyFromStagingLocked(KList worldFolders) { + File root = IrisPlatforms.get().dataFolder("datapacks"); + ReapplyOutcome recovery = recoverBeforeReapplyOutcome(root, worldFolders); + if (!recovery.succeeded()) { + return reportReapplyFailure(recovery); + } + File stagingDir = IrisPlatforms.get().dataFolderNoCreate("datapacks", "staging"); + ReapplyOutcome repair = reapplyStagingRootOutcome( + root, + stagingDir, + worldFolders, + DatapackPackMetadata.resolveStripOverrides()); + if (!repair.succeeded()) { + return reportReapplyFailure(repair); + } + return ReapplyOutcome.success(recovery.recovered(), repair.repaired()); + } + + static boolean reapplyStagingRoot( + File root, + File stagingDir, + KList worldFolders, + boolean stripOverrides + ) { + return reportReapplyFailure(reapplyStagingRootOutcome( + root, + stagingDir, + worldFolders, + stripOverrides)).succeeded(); + } + + static ReapplyOutcome reapplyStagingRootOutcome( + File root, + File stagingDir, + KList worldFolders, + boolean stripOverrides + ) { + Manifest manifest = DatapackManifestStore.readManifest(root); + if (stagingDir == null + || !Files.exists(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { + if (manifest.entries.isEmpty()) { + return ReapplyOutcome.success(false, false); + } + File missing = stagingDir == null ? new File(root, "staging") : stagingDir; + return ReapplyOutcome.failed(new IOException( + "Managed datapack staging is missing at " + missing.getPath())); + } + if (Files.isSymbolicLink(stagingDir.toPath()) + || !Files.isDirectory(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { + return ReapplyOutcome.failed(new IOException( + "Managed datapack staging is not a safe directory at " + stagingDir.getPath())); + } + return reapplyStagedDirectoriesOutcome( + root, stagingDir, worldFolders, stripOverrides, manifest); + } + + static boolean reapplyStagedDirectories( + File root, + File stagingDir, + KList worldFolders, + boolean stripOverrides + ) { + if (Files.isSymbolicLink(stagingDir.toPath()) + || !Files.isDirectory(stagingDir.toPath(), LinkOption.NOFOLLOW_LINKS)) { + return reportReapplyFailure(ReapplyOutcome.failed(new IOException( + "Managed datapack staging is not a safe directory at " + + stagingDir.getPath()))).succeeded(); + } + return reportReapplyFailure(reapplyStagedDirectoriesOutcome( + root, + stagingDir, + worldFolders, + stripOverrides, + DatapackManifestStore.readManifest(root))).succeeded(); + } + + static ReapplyOutcome reapplyStagedDirectoriesOutcome( + File root, + File stagingDir, + KList worldFolders, + boolean stripOverrides, + Manifest manifest + ) { + File[] staged = stagingDir.listFiles(File::isDirectory); + if (staged == null) { + return ReapplyOutcome.failed(new IOException( + "Unable to enumerate managed datapack staging at " + stagingDir.getPath())); + } + boolean repaired = false; + IOException failure = null; + for (Entry entry : manifest.entries) { + File stagedDir = new File(stagingDir, entry.id); + if (isRecordedUnchangedInstall(stagedDir, worldFolders, entry, stripOverrides)) { + continue; + } + if (!DatapackStagingGuard.isUsableStaging(stagedDir, entry)) { + forgetInstallMetadata(entry); + failure = DatapackSupport.appendFailure(failure, new IOException( + "Managed datapack staging is unusable for '" + entry.id + + "' at " + stagedDir.getPath())); + continue; + } + try { + InstallResult result = DatapackInstall.install(stagedDir, worldFolders, entry, stripOverrides); + if (result.changed()) { + repaired = true; + IrisLogging.warn("Repaired installed datapack '" + entry.id + + "' from Iris staging before datapack compilation."); + } + recordInstallMetadata(stagedDir, worldFolders, entry); + } catch (IOException e) { + forgetInstallMetadata(entry); + failure = DatapackSupport.appendFailure(failure, e); + } + } + DatapackManifestStore.writeManifest(root, manifest); + return failure == null + ? ReapplyOutcome.success(false, repaired) + : ReapplyOutcome.failed(failure); + } + + static ReapplyOutcome reportReapplyFailure(ReapplyOutcome outcome) { + if (!outcome.succeeded()) { + IrisLogging.reportError( + "External datapack recovery or staging repair failed.", + outcome.failure().orElseThrow()); + } + return outcome; + } + + static boolean isRecordedUnchangedInstall( + File stagedDir, + KList worldFolders, + Entry entry, + boolean stripOverrides + ) { + if (entry.stagingMetadata == null || entry.stagingMetadata.isBlank() + || entry.installMetadata == null || entry.installMetadata.size() != worldFolders.size()) { + return false; + } + try { + if (!isRecordedManagedDirectory(stagedDir, entry) + || !entry.stagingMetadata.equals(metadataDigest(stagedDir))) { + return false; + } + for (File worldFolder : worldFolders) { + File target = new File(worldFolder, entry.id); + if (!isRecordedManagedDirectory(target, entry) + || new File(target, DatapackPackMetadata.OVERRIDES_STRIPPED_MARKER).isFile() != stripOverrides) { + return false; + } + String recorded = entry.installMetadata.get(installMetadataKey(target)); + if (recorded == null || !recorded.equals(metadataDigest(target))) { + return false; + } + } + return true; + } catch (IOException e) { + IrisLogging.reportError("Managed datapack '" + entry.id + + "' requires full verification", e); + return false; + } + } + + static boolean isRecordedManagedDirectory(File directory, Entry entry) throws IOException { + Path path = directory.toPath(); + if (!Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS) || Files.isSymbolicLink(path)) { + return false; + } + if (!new File(directory, "pack.mcmeta").isFile()) { + return false; + } + Ownership ownership = DatapackOwnership.readOwnershipOrNull(directory); + return ownership != null + && DatapackInstall.ownershipSourceMatches(ownership, entry) + && Objects.equals(ownership.versionId, entry.versionId) + && Objects.equals(ownership.versionNumber, entry.versionNumber) + && Objects.equals(ownership.sha1, entry.sha1); + } + + static void recordInstallMetadata(File stagedDir, KList worldFolders, Entry entry) { + try { + Map recorded = new HashMap<>(); + for (File worldFolder : worldFolders) { + File target = new File(worldFolder, entry.id); + recorded.put(installMetadataKey(target), metadataDigest(target)); + } + entry.stagingMetadata = metadataDigest(stagedDir); + entry.installMetadata = recorded; + } catch (IOException e) { + IrisLogging.reportError("Unable to record managed datapack metadata for '" + entry.id + "'", e); + forgetInstallMetadata(entry); + } + } + + static void forgetInstallMetadata(Entry entry) { + entry.stagingMetadata = ""; + entry.installMetadata = new HashMap<>(); + } + + static String installMetadataKey(File target) { + return target.toPath().toAbsolutePath().normalize().toString(); + } + + static String metadataDigest(File root) throws IOException { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + Path rootPath = root.toPath().toAbsolutePath().normalize(); + List entries = new ArrayList<>(); + try (Stream paths = Files.walk(rootPath)) { + Iterator iterator = paths.iterator(); + int pathCount = 0; + while (iterator.hasNext()) { + Path path = iterator.next(); + if (path.equals(rootPath) || DatapackOwnership.isFinderMetadata(path)) { + continue; + } + pathCount++; + if (pathCount > DatapackOwnership.MAX_MANAGED_PATHS) { + throw new IOException("Datapack contains more than " + DatapackOwnership.MAX_MANAGED_PATHS + " paths"); + } + if (Files.isSymbolicLink(path)) { + throw new IOException("Datapack contains a symbolic link: " + path); + } + String relativePath = rootPath.relativize(path).toString(); + entries.add(new MetadataEntry(path, relativePath)); + } + } + entries.sort(Comparator.comparing(MetadataEntry::relativePath)); + for (MetadataEntry entry : entries) { + String relative = entry.relativePath().replace(File.separatorChar, '/'); + byte[] relativeBytes = relative.getBytes(StandardCharsets.UTF_8); + BasicFileAttributes attributes = Files.readAttributes( + entry.path(), BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); + if (!attributes.isDirectory() && !attributes.isRegularFile()) { + throw new IOException("Datapack contains an unsupported filesystem entry: " + entry.path()); + } + digest.update((byte) (attributes.isDirectory() ? 1 : 2)); + DatapackSupport.updateDigestInt(digest, relativeBytes.length); + digest.update(relativeBytes); + if (!attributes.isDirectory()) { + DatapackSupport.updateDigestLong(digest, attributes.size()); + DatapackSupport.updateDigestLong(digest, attributes.lastModifiedTime().toMillis()); + } + } + return DatapackSupport.hex(digest.digest()); + } catch (NoSuchAlgorithmException e) { + throw new IOException("SHA-256 algorithm unavailable", e); + } + } + + static boolean recoverBeforeReapply(File root, List worldFolders) { + return reportReapplyFailure(recoverBeforeReapplyOutcome(root, worldFolders)).succeeded(); + } + + static ReapplyOutcome recoverBeforeReapplyOutcome(File root, List worldFolders) { + try { + return ReapplyOutcome.success(DatapackScratchRecovery.recoverTransactions(root, worldFolders), false); + } catch (IOException e) { + return ReapplyOutcome.failed(e); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java new file mode 100644 index 000000000..924a80fc0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java @@ -0,0 +1,385 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.core.IrisStartupValidation; +import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.core.ServerConfigurator; +import art.arcane.volmlib.util.collection.KList; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.net.URI; +import java.net.URISyntaxException; +import java.nio.charset.StandardCharsets; +import java.nio.file.AtomicMoveNotSupportedException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.StandardOpenOption; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashSet; +import java.util.List; +import java.util.Objects; + +final class DatapackStartupValidation { + static final String STARTUP_VALIDATION_CACHE = "startup-validation.json"; + + static final int STARTUP_VALIDATION_SCHEMA = 1; + + static volatile StartupValidationCache activeStartupValidation; + + private DatapackStartupValidation() { + } + + static StartupValidationCache cacheStartupValidation( + File root, + KList worldFolders, + Path cacheFile, + String mcVersion, + int irisVersion, + boolean autoIngest, + boolean stripOverrides, + List urls + ) { + try { + StartupValidationCache cache = createStartupValidationCache( + mcVersion, + irisVersion, + autoIngest, + stripOverrides, + urls, + startupValidationFingerprint(root, worldFolders, urls)); + writeStartupValidationCache(cacheFile, cache); + return cache; + } catch (IOException | RuntimeException exception) { + IrisLogging.warn("Could not persist external datapack startup validation: " + + DatapackSupport.failureMessage(exception)); + return null; + } + } + + static void refreshStartupValidationAfterMaintenance(boolean maintenanceChanged) { + if (!maintenanceChanged) { + return; + } + StartupValidationCache validated = activeStartupValidation; + if (validated == null || !IrisStartupValidation.isReady()) { + return; + } + KList configured = DatapackIngestService.collectConfiguredImports(); + List urls = configured.stream().sorted().toList(); + boolean autoIngest = IrisSettings.get().getGeneral().autoIngestDatapacks; + boolean stripOverrides = DatapackPackMetadata.resolveStripOverrides(); + String mcVersion = DatapackSupport.serverMcVersion(); + int irisVersion = IrisPlatforms.get().irisVersionNumber(); + if (!startupValidationContextMatches( + validated, mcVersion, irisVersion, autoIngest, stripOverrides, urls)) { + return; + } + File root = IrisPlatforms.get().dataFolder("datapacks"); + KList worldFolders = ServerConfigurator.getDatapacksFolder(); + Path cacheFile = new File(root, STARTUP_VALIDATION_CACHE).toPath(); + DatapackTransactions.TRANSACTION_LOCK.lock(); + try { + DatapackScratchRecovery.recoverTransactions(root, worldFolders); + StartupValidationCache refreshed = refreshStartupValidationCache( + validated, root, worldFolders); + writeStartupValidationCache(cacheFile, refreshed); + activeStartupValidation = refreshed; + } catch (IOException | RuntimeException exception) { + IrisLogging.warn("Could not refresh external datapack validation after startup maintenance: " + + DatapackSupport.failureMessage(exception)); + } finally { + DatapackTransactions.TRANSACTION_LOCK.unlock(); + } + } + + static StartupValidationCache refreshStartupValidationCache( + StartupValidationCache validated, + File root, + KList worldFolders + ) throws IOException { + Objects.requireNonNull(validated, "Validated external datapack startup state"); + return createStartupValidationCache( + validated.minecraftVersion, + validated.irisVersion, + validated.autoIngest, + validated.stripOverrides, + validated.urls, + startupValidationFingerprint(root, worldFolders, validated.urls)); + } + + static StartupValidationCache createStartupValidationCache( + String mcVersion, + int irisVersion, + boolean autoIngest, + boolean stripOverrides, + List urls, + String localFingerprint + ) { + StartupValidationCache cache = new StartupValidationCache(); + cache.schemaVersion = STARTUP_VALIDATION_SCHEMA; + cache.minecraftVersion = Objects.requireNonNullElse(mcVersion, ""); + cache.irisVersion = irisVersion; + cache.autoIngest = autoIngest; + cache.stripOverrides = stripOverrides; + cache.urls = List.copyOf(urls); + cache.localFingerprint = localFingerprint; + return cache; + } + + static boolean startupValidationContextMatches( + StartupValidationCache cache, + String mcVersion, + int irisVersion, + boolean autoIngest, + boolean stripOverrides, + List urls + ) { + return cache != null + && cache.schemaVersion == STARTUP_VALIDATION_SCHEMA + && Objects.equals(cache.minecraftVersion, Objects.requireNonNullElse(mcVersion, "")) + && cache.irisVersion == irisVersion + && cache.autoIngest == autoIngest + && cache.stripOverrides == stripOverrides + && Objects.equals(cache.urls, urls); + } + + static boolean startupValidationCacheMatches( + StartupValidationCache cache, + String mcVersion, + int irisVersion, + boolean autoIngest, + boolean stripOverrides, + List urls, + String localFingerprint + ) { + return startupValidationContextMatches( + cache, mcVersion, irisVersion, autoIngest, stripOverrides, urls) + && localFingerprint != null && !localFingerprint.isBlank() + && Objects.equals(cache.localFingerprint, localFingerprint); + } + + static StartupValidationCache readStartupValidationCache(Path cacheFile) { + if (cacheFile == null + || Files.isSymbolicLink(cacheFile) + || !Files.isRegularFile(cacheFile, LinkOption.NOFOLLOW_LINKS)) { + return null; + } + try { + if (Files.size(cacheFile) > DatapackPackMetadata.MAX_METADATA_BYTES) { + return null; + } + StartupValidationCache cache = DatapackSupport.GSON.fromJson( + DatapackSupport.readBoundedUtf8(cacheFile, DatapackPackMetadata.MAX_METADATA_BYTES, "External datapack startup validation"), + StartupValidationCache.class); + if (cache == null || cache.urls == null) { + return null; + } + List sortedUrls = cache.urls.stream() + .filter(Objects::nonNull) + .sorted() + .toList(); + if (sortedUrls.size() != cache.urls.size() + || new HashSet<>(sortedUrls).size() != sortedUrls.size() + || !sortedUrls.equals(cache.urls)) { + return null; + } + cache.urls = sortedUrls; + return cache; + } catch (IOException | RuntimeException exception) { + return null; + } + } + + static void writeStartupValidationCache(Path cacheFile, StartupValidationCache cache) throws IOException { + Path absolute = cacheFile.toAbsolutePath().normalize(); + Path parent = Objects.requireNonNull(absolute.getParent(), "External datapack startup validation parent"); + Files.createDirectories(parent); + Path staged = Files.createTempFile(parent, ".startup-validation-", ".tmp"); + try { + byte[] content = DatapackSupport.GSON.toJson(cache).getBytes(StandardCharsets.UTF_8); + if (content.length > DatapackPackMetadata.MAX_METADATA_BYTES) { + throw new IOException("External datapack startup validation exceeds " + DatapackPackMetadata.MAX_METADATA_BYTES + " bytes"); + } + Files.write(staged, content, StandardOpenOption.TRUNCATE_EXISTING); + DatapackSupport.forceFile(staged); + try { + Files.move(staged, absolute, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING); + } catch (AtomicMoveNotSupportedException exception) { + Files.move(staged, absolute, StandardCopyOption.REPLACE_EXISTING); + } + DatapackSupport.forceDirectoryIfSupported(parent); + } finally { + Files.deleteIfExists(staged); + } + } + + static String startupValidationFingerprint(File root, KList worldFolders) throws IOException { + return startupValidationFingerprint(root, worldFolders, List.of()); + } + + static String startupValidationFingerprint( + File root, + KList worldFolders, + Iterable sources + ) throws IOException { + try { + MessageDigest digest = MessageDigest.getInstance("SHA-256"); + Path manifestPath = new File(root, "manifest.json").toPath(); + updateFingerprintValue(digest, "manifest"); + if (Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + if (Files.isSymbolicLink(manifestPath) + || !Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid datapack manifest path " + manifestPath); + } + byte[] manifest = DatapackSupport.readBoundedBytes( + manifestPath, DatapackManifestStore.MAX_MANIFEST_BYTES, "Datapack manifest fingerprint"); + DatapackSupport.updateDigestLong(digest, manifest.length); + digest.update(manifest); + } else if (Files.notExists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + DatapackSupport.updateDigestLong(digest, -1L); + } else { + throw new IOException("Cannot determine datapack manifest state at " + manifestPath); + } + + Manifest manifest = DatapackManifestStore.readCommittedManifest(root); + updateDirectoryFingerprint(digest, "staging", new File(root, "staging")); + updateDirectoryFingerprint(digest, "transactions", new File(root, DatapackTransactions.TRANSACTION_DIRECTORY)); + updateDirectoryFingerprint( + digest, + "storage-install-scratch", + DatapackInstall.installScratchRoot(new File(root, "staging"))); + + List entries = new ArrayList<>(manifest.entries); + entries.sort(Comparator.comparing(entry -> entry.id)); + List targets = new ArrayList<>(worldFolders == null ? List.of() : worldFolders); + targets.sort(Comparator.comparing(file -> file.toPath().toAbsolutePath().normalize().toString())); + for (File worldFolder : targets) { + String worldIdentity = worldFolder.toPath().toAbsolutePath().normalize().toString(); + updateFingerprintValue(digest, "world:" + worldIdentity); + updateDirectoryFingerprint( + digest, + "world-install-scratch:" + worldIdentity, + DatapackInstall.installScratchRoot(worldFolder)); + for (Entry entry : entries) { + updateDirectoryFingerprint( + digest, + "world-pack:" + worldIdentity + ":" + entry.id, + new File(worldFolder, entry.id)); + } + } + updateLocalSourceFingerprint(digest, sources); + return DatapackSupport.hex(digest.digest()); + } catch (NoSuchAlgorithmException exception) { + throw new IOException("SHA-256 algorithm unavailable", exception); + } + } + + static void updateLocalSourceFingerprint( + MessageDigest digest, + Iterable sources + ) throws IOException { + if (sources == null) { + return; + } + List localSources = new ArrayList<>(); + for (String source : sources) { + URI uri = parseSourceUri(source); + if (uri != null && "file".equalsIgnoreCase(uri.getScheme())) { + localSources.add(uri.normalize().toASCIIString()); + } + } + localSources.sort(String::compareTo); + byte[] buffer = new byte[DatapackOwnership.HASH_BUFFER_BYTES]; + for (String source : localSources) { + Path path = DatapackArchive.requireLocalDatapackPath(parseSourceUri(source)); + updateFingerprintValue(digest, "local-source:" + source); + try (InputStream input = Files.newInputStream( + path, + StandardOpenOption.READ, + LinkOption.NOFOLLOW_LINKS)) { + long bytes = 0; + int length; + while ((length = input.read(buffer)) > 0) { + bytes += length; + if (bytes > DatapackArchive.MAX_DOWNLOAD_BYTES) { + throw new IOException("Local datapack exceeds " + DatapackArchive.MAX_DOWNLOAD_BYTES + " bytes: " + path); + } + digest.update(buffer, 0, length); + } + DatapackSupport.updateDigestLong(digest, bytes); + } + } + } + + static URI parseSourceUri(String source) throws IOException { + if (source == null || source.isBlank()) { + return null; + } + try { + return new URI(source.trim()); + } catch (URISyntaxException exception) { + throw new IOException("Invalid datapack URL " + source, exception); + } + } + + static void updateDirectoryFingerprint( + MessageDigest digest, + String identity, + File directory + ) throws IOException { + updateFingerprintValue(digest, identity); + Path path = directory.toPath(); + if (Files.notExists(path, LinkOption.NOFOLLOW_LINKS)) { + updateFingerprintValue(digest, "missing"); + return; + } + if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS) + || Files.isSymbolicLink(path) + || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid external datapack validation directory " + path); + } + updateFingerprintValue(digest, DatapackOwnership.directoryHash(directory)); + Path ownership = new File(directory, DatapackOwnership.OWNERSHIP_MARKER).toPath(); + if (Files.isRegularFile(ownership, LinkOption.NOFOLLOW_LINKS) && !Files.isSymbolicLink(ownership)) { + byte[] marker = DatapackSupport.readBoundedBytes( + ownership, DatapackOwnership.MAX_OWNERSHIP_BYTES, "External datapack ownership fingerprint"); + DatapackSupport.updateDigestLong(digest, marker.length); + digest.update(marker); + } else { + DatapackSupport.updateDigestLong(digest, -1L); + } + } + + static void updateFingerprintValue(MessageDigest digest, String value) { + byte[] bytes = Objects.requireNonNullElse(value, "").getBytes(StandardCharsets.UTF_8); + DatapackSupport.updateDigestInt(digest, bytes.length); + digest.update(bytes); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStructureImports.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStructureImports.java new file mode 100644 index 000000000..3e033cdc2 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStructureImports.java @@ -0,0 +1,489 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisPlatforms; +import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.core.IrisSettings; +import art.arcane.iris.core.ServerConfigurator; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.structure.BulkStructureImporter; +import art.arcane.iris.core.structure.StructureImporter; +import art.arcane.iris.core.structure.authoring.StructureKey; +import art.arcane.iris.core.structure.authoring.StructureSource; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; + +import java.io.File; +import java.io.IOException; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.TreeSet; +import java.util.TreeMap; +import java.util.stream.Stream; + +final class DatapackStructureImports { + static final int STRUCTURE_IMPORT_FORMAT_REVISION = 3; + + private DatapackStructureImports() { + } + + static boolean autoImportDatapackStructures() { + DatapackTransactions.TRANSACTION_LOCK.lock(); + try { + return autoImportDatapackStructuresLocked(); + } finally { + DatapackTransactions.TRANSACTION_LOCK.unlock(); + } + } + + static boolean autoImportDatapackStructuresLocked() { + boolean autoImportEnabled = IrisSettings.get().getGeneral().autoImportDatapackStructures; + File root = IrisPlatforms.get().dataFolder("datapacks"); + boolean recovered; + try { + recovered = DatapackScratchRecovery.recoverTransactions(root, ServerConfigurator.getDatapacksFolder()); + } catch (IOException e) { + IrisLogging.reportError("Automatic datapack structure import blocked by incomplete transaction recovery.", e); + return false; + } + Manifest manifest = DatapackManifestStore.readManifest(root); + if (manifest.entries.isEmpty()) { + return recovered; + } + Map manifestEntriesByUrl = new HashMap<>(); + for (Entry entry : manifest.entries) { + if (entry.url != null) { + manifestEntriesByUrl.put(entry.url, entry); + } + } + + List packs; + try (Stream stream = ServerConfigurator.allPacks()) { + packs = stream.filter(Objects::nonNull).toList(); + } + if (!autoImportEnabled && !hasRemovedImportState(packs, manifest.entries)) { + return recovered; + } + + Map entriesByUrl = new HashMap<>(); + File stagingRoot = new File(root, "staging"); + boolean stagingStateChanged = false; + boolean manifestStagingMetadataChanged = false; + for (Entry entry : manifest.entries) { + if (entry.url == null) { + continue; + } + StagingInspection inspection = DatapackStagingGuard.inspectUsableStaging(new File(stagingRoot, entry.id), entry); + stagingStateChanged |= inspection.ownershipCorrected(); + manifestStagingMetadataChanged |= inspection.manifestChanged(); + if (inspection.usable()) { + entriesByUrl.put(entry.url, entry); + } + } + + int attemptedPacks = 0; + int completedPacks = 0; + int cleanupTargets = 0; + Set completedUrls = new HashSet<>(); + Set failedUrls = new HashSet<>(); + for (IrisData data : packs) { + Set configured = DatapackImportSources.configuredImports(data); + String targetId = data.getDataFolder().toPath().toAbsolutePath().normalize().toString(); + for (Entry entry : manifest.entries) { + if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { + cleanupTargets++; + } + } + if (!cleanupRemovedImports(data, targetId, configured, manifest.entries, manifestEntriesByUrl)) { + for (Entry entry : manifest.entries) { + if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { + failedUrls.add(entry.url); + } + } + } + if (!autoImportEnabled) { + continue; + } + + Set pendingUrls = new HashSet<>(); + for (String url : configured) { + Entry entry = entriesByUrl.get(url); + if (entry != null && importPending(entry, targetId)) { + pendingUrls.add(url); + } + } + if (pendingUrls.isEmpty()) { + continue; + } + for (String pendingUrl : pendingUrls) { + Entry entry = entriesByUrl.get(pendingUrl); + prepareImportRecoveryInventory(entry, targetId); + } + try { + DatapackManifestStore.writeManifestChecked(root, manifest); + } catch (IOException e) { + failedUrls.addAll(pendingUrls); + IrisLogging.reportError("Datapack structure import for pack '" + + data.getDataFolder().getPath() + + "' was blocked because its recovery inventory could not be persisted.", e); + continue; + } + Set structureKeys = new TreeSet<>(); + Set templateKeys = new TreeSet<>(); + for (Entry entry : manifest.entries) { + if (!configured.contains(entry.url)) { + continue; + } + structureKeys.addAll(DatapackManifestStore.copyList(entry.structureKeys)); + templateKeys.addAll(DatapackManifestStore.copyList(entry.templateKeys)); + } + attemptedPacks++; + try { + BulkStructureImporter.Report report = BulkStructureImporter.importManagedDatapackStructures( + data, + StructureImporter.Mode.OVERWRITE, + BukkitPlatform.console(), + structureKeys, + templateKeys + ); + Set successfulPendingUrls = new HashSet<>(pendingUrls); + Set incompleteUrls = new HashSet<>(); + for (String pendingUrl : pendingUrls) { + Entry entry = entriesByUrl.get(pendingUrl); + Map desired = importBundleInventory(entry); + if (!report.successfulBundles().entrySet().containsAll(desired.entrySet())) { + successfulPendingUrls.remove(pendingUrl); + incompleteUrls.add(pendingUrl); + failedUrls.add(pendingUrl); + } + } + if (report.failed() > 0 && incompleteUrls.isEmpty()) { + successfulPendingUrls.clear(); + incompleteUrls.addAll(pendingUrls); + failedUrls.addAll(pendingUrls); + } + if (!incompleteUrls.isEmpty()) { + boolean reconciled = reconcileFailedImportInventories( + root, manifest, data, targetId, incompleteUrls, entriesByUrl); + if (report.retryRequired() || !reconciled) { + IrisLogging.error("Datapack structure import for pack '%s' reported %d incomplete source(s) and remains pending because a retryable runtime failure occurred.", + data.getDataFolder().getPath(), incompleteUrls.size()); + } else if (recordDeterministicImportAttempts( + root, manifest, targetId, incompleteUrls, entriesByUrl)) { + IrisLogging.warn("Datapack structure import for pack '" + + data.getDataFolder().getPath() + "' left " + incompleteUrls.size() + + " source(s) incomplete after deterministic validation failures. Iris will retain the partial editable imports without retrying until the datapack source, importer format, or target pack changes."); + } + } + Map sharedBundles = desiredBundles(configured, entriesByUrl); + boolean packCompleted = false; + for (String pendingUrl : successfulPendingUrls) { + Entry entry = entriesByUrl.get(pendingUrl); + Map desired = importBundleInventory(entry); + Map previous = entry.importedBundles.getOrDefault(targetId, Map.of()); + Map stale = new TreeMap<>(previous); + stale.keySet().removeAll(desired.keySet()); + stale.keySet().removeAll(sharedBundles.keySet()); + Map remaining = cleanupImportedBundles(data, stale); + if (!remaining.isEmpty()) { + failedUrls.add(pendingUrl); + continue; + } + entry.importedBundles.put(targetId, desired); + recordSuccessfulImport(entry, targetId); + completedUrls.add(pendingUrl); + packCompleted = true; + } + if (packCompleted) { + completedPacks++; + } + } catch (RuntimeException e) { + failedUrls.addAll(pendingUrls); + IrisLogging.reportError("Datapack structure import failed for pack '" + + data.getDataFolder().getPath() + "'; the manifest remains pending for retry.", e); + reconcileFailedImportInventories(root, manifest, data, targetId, pendingUrls, entriesByUrl); + } + } + + for (Entry entry : manifest.entries) { + if (failedUrls.contains(entry.url)) { + entry.structuresImported = false; + } else if (completedUrls.contains(entry.url)) { + entry.structuresImported = true; + } + } + if (attemptedPacks == 0 && cleanupTargets == 0) { + if (manifestStagingMetadataChanged) { + DatapackManifestStore.writeManifest(root, manifest); + } + return recovered || stagingStateChanged || manifestStagingMetadataChanged; + } + DatapackManifestStore.writeManifest(root, manifest); + if (attemptedPacks == 0) { + IrisLogging.info("Datapack editable-import cleanup reconciled " + cleanupTargets + " removed source target(s)."); + return true; + } + IrisLogging.info("Datapack structure import refreshed " + completedUrls.size() + " source(s) across " + + completedPacks + "/" + attemptedPacks + + " pack(s). Reference the imported keys from a 'structures' placement to position them manually."); + return true; + } + + static boolean hasRemovedImportState(List packs, List entries) { + for (IrisData data : packs) { + Set configured = DatapackImportSources.configuredImports(data); + String targetId = data.getDataFolder().toPath().toAbsolutePath().normalize().toString(); + for (Entry entry : entries) { + if (!configured.contains(entry.url) && hasImportState(entry, targetId)) { + return true; + } + } + } + return false; + } + + static String importRevision(Entry entry) { + return importRevision(entry, STRUCTURE_IMPORT_FORMAT_REVISION); + } + + static String importRevision(Entry entry, int importerFormatRevision) { + return "v" + importerFormatRevision + ":" + DatapackSupport.safe(entry.versionId) + ":" + DatapackSupport.safe(entry.sha1); + } + + static boolean importPending(Entry entry, String targetId) { + String revision = importRevision(entry); + return !revision.equals(entry.importedTargets.get(targetId)) + && !revision.equals(entry.importAttempts.get(targetId)); + } + + static void recordDeterministicImportAttempt(Entry entry, String targetId) { + entry.importedTargets.remove(targetId); + entry.importAttempts.put(targetId, importRevision(entry)); + entry.structuresImported = false; + } + + static void recordSuccessfulImport(Entry entry, String targetId) { + entry.importedTargets.put(targetId, importRevision(entry)); + entry.importAttempts.remove(targetId); + } + + static void prepareImportRecoveryInventory(Entry entry, String targetId) { + Map desired = importBundleInventory(entry); + Map recovery = new TreeMap<>(desired); + recovery.putAll(entry.importedBundles.getOrDefault(targetId, Map.of())); + entry.importedBundles.put(targetId, recovery); + entry.importedTargets.remove(targetId); + entry.importAttempts.remove(targetId); + entry.structuresImported = false; + } + + static boolean reconcileFailedImportInventories( + File root, + Manifest manifest, + IrisData data, + String targetId, + Set pendingUrls, + Map entriesByUrl + ) { + boolean reconciled = true; + for (String pendingUrl : pendingUrls) { + Entry entry = entriesByUrl.get(pendingUrl); + try { + reconcileFailedImportInventory(data, entry, targetId); + } catch (IOException | RuntimeException e) { + reconciled = false; + IrisLogging.reportError("Could not reconcile partial editable structure imports for '" + + pendingUrl + "' in pack '" + data.getDataFolder().getPath() + + "'; the conservative recovery inventory remains pending.", e); + } + } + try { + DatapackManifestStore.writeManifestChecked(root, manifest); + } catch (IOException e) { + reconciled = false; + IrisLogging.reportError("Could not persist reconciled partial editable structure imports for pack '" + + data.getDataFolder().getPath() + "'; the earlier recovery inventory remains durable.", e); + } + return reconciled; + } + + static boolean recordDeterministicImportAttempts( + File root, + Manifest manifest, + String targetId, + Set incompleteUrls, + Map entriesByUrl + ) { + for (String incompleteUrl : incompleteUrls) { + recordDeterministicImportAttempt(entriesByUrl.get(incompleteUrl), targetId); + } + try { + DatapackManifestStore.writeManifestChecked(root, manifest); + return true; + } catch (IOException e) { + for (String incompleteUrl : incompleteUrls) { + entriesByUrl.get(incompleteUrl).importAttempts.remove(targetId); + } + IrisLogging.reportError("Could not persist deterministic editable structure import attempts; the sources remain pending for retry.", e); + return false; + } + } + + static void reconcileFailedImportInventory( + IrisData data, + Entry entry, + String targetId + ) throws IOException { + Map> claims = DatapackRemoval.importBundleClaims(entry, targetId); + Map reconciled = new TreeMap<>(); + StructureTransactionWriter writer = new StructureTransactionWriter(data.getDataFolder().toPath()); + for (Map.Entry> bundle : claims.entrySet()) { + StructureKey targetKey; + try { + targetKey = StructureKey.parse(bundle.getKey()); + } catch (RuntimeException e) { + throw new IOException("Invalid editable structure target key '" + bundle.getKey() + "'", e); + } + Optional source = writer.ownedSource(targetKey); + if (source.isPresent() && DatapackRemoval.sourceClaimsContain(bundle.getValue(), source.get())) { + reconciled.put(bundle.getKey(), source.get().key().value()); + } + } + if (reconciled.isEmpty()) { + entry.importedBundles.remove(targetId); + } else { + entry.importedBundles.put(targetId, reconciled); + } + entry.importedTargets.remove(targetId); + entry.importAttempts.remove(targetId); + entry.structuresImported = false; + } + + static boolean cleanupRemovedImports( + IrisData data, + String targetId, + Set configured, + List entries, + Map entriesByUrl + ) { + boolean successful = true; + Map retainedBundles = desiredBundles(configured, entriesByUrl); + for (Entry entry : entries) { + if (configured.contains(entry.url)) { + continue; + } + Map inventory = entry.importedBundles.get(targetId); + if (inventory == null && !hasImportState(entry, targetId)) { + continue; + } + Map resolvedInventory = inventory == null ? Map.of() : inventory; + for (Entry retainedEntry : entries) { + if (configured.contains(retainedEntry.url)) { + retainedEntry.importedTargets.remove(targetId); + retainedEntry.importAttempts.remove(targetId); + retainedEntry.structuresImported = false; + } + } + Map removable = new TreeMap<>(resolvedInventory); + removable.keySet().removeAll(retainedBundles.keySet()); + Map remaining = cleanupImportedBundles(data, removable); + if (!remaining.isEmpty()) { + Map retained = new TreeMap<>(); + for (Map.Entry bundle : resolvedInventory.entrySet()) { + if (retainedBundles.containsKey(bundle.getKey()) || remaining.containsKey(bundle.getKey())) { + retained.put(bundle.getKey(), bundle.getValue()); + } + } + entry.importedBundles.put(targetId, retained); + entry.importedTargets.remove(targetId); + entry.importAttempts.remove(targetId); + entry.structuresImported = false; + successful = false; + continue; + } + entry.importedBundles.remove(targetId); + entry.importedTargets.remove(targetId); + entry.importAttempts.remove(targetId); + } + return successful; + } + + static boolean hasImportState(Entry entry, String targetId) { + return entry.importedBundles.containsKey(targetId) + || entry.importedTargets.containsKey(targetId) + || entry.importAttempts.containsKey(targetId); + } + + static Map cleanupImportedBundles(IrisData data, Map inventory) { + Map remaining = new TreeMap<>(); + StructureTransactionWriter writer = new StructureTransactionWriter(data.getDataFolder().toPath()); + boolean removed = false; + for (Map.Entry bundle : inventory.entrySet()) { + StructureKey sourceKey; + try { + sourceKey = StructureKey.parse(bundle.getValue()); + StructureSource.Kind sourceKind = sourceKey.namespace().equals("minecraft") + ? StructureSource.Kind.VANILLA : StructureSource.Kind.DATAPACK; + removed |= writer.removeManagedDatapackOwned( + StructureKey.parse(bundle.getKey()), + sourceKind, + sourceKey + ); + } catch (IOException | RuntimeException e) { + remaining.put(bundle.getKey(), bundle.getValue()); + IrisLogging.reportError("Preserving imported structure bundle '" + bundle.getKey() + + "' in pack '" + data.getDataFolder().getPath() + + "' because ownership-safe cleanup failed.", e); + } + } + if (removed) { + data.invalidateStructureResources(); + } + return remaining; + } + + static Map desiredBundles(Set configured, Map entriesByUrl) { + Map bundles = new TreeMap<>(); + for (String url : configured) { + Entry entry = entriesByUrl.get(url); + if (entry != null) { + bundles.putAll(importBundleInventory(entry)); + } + } + return bundles; + } + + static Map importBundleInventory(Entry entry) { + Map bundles = new TreeMap<>(); + for (String structureKey : DatapackManifestStore.copyList(entry.structureKeys)) { + bundles.put("iris:" + StructureImporter.deriveName(structureKey), structureKey); + } + for (String templateKey : DatapackManifestStore.copyList(entry.templateKeys)) { + bundles.put("iris:" + BulkStructureImporter.templateNameFor(templateKey), templateKey); + } + return bundles; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java new file mode 100644 index 000000000..52da21707 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java @@ -0,0 +1,277 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.core.nms.MinecraftVersion; +import art.arcane.iris.util.common.io.Durability; +import art.arcane.iris.util.common.plugin.VolmitSender; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import org.bukkit.Bukkit; +import org.bukkit.Server; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.nio.channels.FileChannel; +import java.nio.charset.StandardCharsets; +import java.nio.file.AtomicMoveNotSupportedException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.nio.file.StandardOpenOption; +import java.nio.file.attribute.BasicFileAttributes; +import java.security.MessageDigest; + +final class DatapackSupport { + static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); + + private DatapackSupport() { + } + + static String failureMessage(Throwable exception) { + if (exception == null) { + return "unknown failure"; + } + String message = exception.getMessage(); + return message == null || message.isBlank() ? exception.getClass().getSimpleName() : message; + } + + static IOException appendFailure(IOException current, IOException additional) { + if (current == null) { + return additional; + } + current.addSuppressed(additional); + return current; + } + + static IOException appendIOException(IOException current, Throwable failure) { + IOException next = failure instanceof IOException ioFailure + ? ioFailure : new IOException("Datapack transaction participant failed", failure); + if (current == null) { + return next; + } + current.addSuppressed(next); + return current; + } + + static Path requireDirectoryIdentity(File directory, String purpose) throws IOException { + Path normalized = directory.toPath().toAbsolutePath().normalize(); + BasicFileAttributes attributes = Files.readAttributes( + normalized, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); + if (!DatapackScratchRecovery.isSupportedScratchDirectory(attributes)) { + throw new IOException("Invalid " + purpose + " " + normalized); + } + normalized.toRealPath(); + return normalized; + } + + static void requireNoSymbolicLinkComponents(Path normalized, String purpose) throws IOException { + Path current = normalized.getRoot(); + for (Path component : normalized) { + current = current == null ? component : current.resolve(component); + BasicFileAttributes attributes = Files.readAttributes( + current, BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); + if (attributes.isSymbolicLink()) { + throw new IOException("Refusing symbolic-link component in " + purpose + " " + normalized); + } + if (attributes.isOther()) { + throw new IOException("Refusing special filesystem component in " + purpose + " " + normalized); + } + if (!DatapackScratchRecovery.isSupportedScratchDirectory(attributes)) { + throw new IOException("Refusing unsupported component in " + purpose + " " + normalized); + } + } + } + + static String directoryIdentity(File directory) throws IOException { + BasicFileAttributes attributes = Files.readAttributes( + directory.toPath(), BasicFileAttributes.class, LinkOption.NOFOLLOW_LINKS); + if (!attributes.isDirectory() || attributes.isSymbolicLink()) { + throw new IOException("Invalid datapack directory identity at " + directory.getPath()); + } + Object fileKey = attributes.fileKey(); + if (fileKey != null) { + return "key:" + fileKey; + } + // Windows exposes no inode-equivalent for a directory, and returning nothing here fails + // the identity gate closed, which disables legacy staging replacement on that platform + // outright. Creation time is the one stable discriminator the filesystem still offers: a + // directory swapped in at the same path brings its own, so a swap is still caught. It is + // a weaker guarantee than an inode, so it is only ever the fallback. + return "created:" + attributes.creationTime(); + } + + static boolean pathExists(Path path, String purpose) throws IOException { + if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + return true; + } + if (Files.notExists(path, LinkOption.NOFOLLOW_LINKS)) { + return false; + } + throw new IOException("Cannot determine " + purpose + " state at " + path); + } + + static String serverMcVersion() { + return serverMcVersion(Bukkit.getServer()); + } + + static String serverMcVersion(Server server) { + MinecraftVersion detected = MinecraftVersion.detect(server); + return detected == null ? null : detected.value(); + } + + static String safe(String value) { + return value == null || value.isBlank() ? "?" : value; + } + + static String safeFile(String value) { + return value == null || value.isBlank() ? "unknown" : value.replaceAll("[^a-zA-Z0-9._-]", "_"); + } + + static String hex(byte[] hash) { + StringBuilder builder = new StringBuilder(hash.length * 2); + for (byte value : hash) { + builder.append(String.format("%02x", value)); + } + return builder.toString(); + } + + static void updateDigestInt(MessageDigest digest, int value) { + digest.update((byte) (value >>> 24)); + digest.update((byte) (value >>> 16)); + digest.update((byte) (value >>> 8)); + digest.update((byte) value); + } + + static void updateDigestLong(MessageDigest digest, long value) { + digest.update((byte) (value >>> 56)); + digest.update((byte) (value >>> 48)); + digest.update((byte) (value >>> 40)); + digest.update((byte) (value >>> 32)); + digest.update((byte) (value >>> 24)); + digest.update((byte) (value >>> 16)); + digest.update((byte) (value >>> 8)); + digest.update((byte) value); + } + + static void message(VolmitSender sender, String text) { + if (sender != null) { + sender.sendMessage(text); + return; + } + IrisLogging.info(text); + } + + static void move(Path source, Path target) throws IOException { + try { + Files.move(source, target, StandardCopyOption.ATOMIC_MOVE, StandardCopyOption.REPLACE_EXISTING); + } catch (AtomicMoveNotSupportedException e) { + Files.move(source, target, StandardCopyOption.REPLACE_EXISTING); + } + } + + static void moveNew(Path source, Path target) throws IOException { + if (pathExists(target, "move target")) { + throw new IOException("Refusing to replace concurrently-created path " + target); + } + Files.move(source, target); + } + + static void ensureScratchDirectory(File directory, String purpose) throws IOException { + Path path = directory.toPath(); + if (Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing invalid " + purpose + " directory " + directory.getPath()); + } + return; + } + Files.createDirectories(path); + if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Could not create a safe " + purpose + " directory " + directory.getPath()); + } + } + + static void verifyDirectoryContainerIfPresent(File directory, String purpose) throws IOException { + Path path = directory.toPath(); + if (!Files.exists(path, LinkOption.NOFOLLOW_LINKS)) { + return; + } + if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Refusing invalid " + purpose + " directory " + directory.getPath()); + } + } + + static String normalizedPath(File file) { + return file.toPath().toAbsolutePath().normalize().toString(); + } + + static String realDirectoryPath(File directory, String purpose) throws IOException { + Path path = directory.toPath().toAbsolutePath().normalize(); + if (Files.isSymbolicLink(path) || !Files.isDirectory(path, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid " + purpose + " " + path); + } + return path.toRealPath().toString(); + } + + static String readBoundedUtf8(Path path, long maxBytes, String purpose) throws IOException { + return new String(readBoundedBytes(path, maxBytes, purpose), StandardCharsets.UTF_8); + } + + static byte[] readBoundedBytes(Path path, long maxBytes, String purpose) throws IOException { + int readLimit = Math.toIntExact(maxBytes + 1); + byte[] content; + try (InputStream input = Files.newInputStream( + path, + StandardOpenOption.READ, + LinkOption.NOFOLLOW_LINKS + )) { + content = input.readNBytes(readLimit); + } + if (content.length > maxBytes) { + throw new IOException(purpose + " exceeds " + maxBytes + " bytes"); + } + return content; + } + + static void forceFile(Path file) throws IOException { + if (!Durability.enabled()) { + return; + } + + try (FileChannel channel = FileChannel.open(file, StandardOpenOption.WRITE)) { + Durability.force(channel); + } + } + + static void forceDirectoryIfSupported(Path directory) throws IOException { + if (!Durability.enabled()) { + return; + } + + if (!Files.getFileStore(directory).supportsFileAttributeView("posix")) { + return; + } + try (FileChannel channel = FileChannel.open(directory, StandardOpenOption.READ)) { + Durability.force(channel); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackTransactions.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackTransactions.java new file mode 100644 index 000000000..714795e4d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackTransactions.java @@ -0,0 +1,342 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; + +import java.io.File; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardOpenOption; +import java.util.HashSet; +import java.util.List; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.locks.ReentrantLock; +import java.util.stream.Stream; + +final class DatapackTransactions { + static final String TRANSACTION_DIRECTORY = ".iris-datapack-transactions"; + + static final String TRANSACTION_JOURNAL = "journal.json"; + + static final String TRANSACTION_JOURNAL_NEXT = "journal.next.json"; + + static final int TRANSACTION_SCHEMA = 2; + + static final long MAX_TRANSACTION_JOURNAL_BYTES = 4L * 1024L * 1024L; + + static final int MAX_TRANSACTION_COUNT = 1_024; + + static final ReentrantLock TRANSACTION_LOCK = new ReentrantLock(); + + private DatapackTransactions() { + } + + static DatapackCoordinator createInstallCoordinator( + File root, + Entry entry, + List plans, + boolean manifestAlreadyMatched + ) throws IOException { + CoordinatorJournal journal = newCoordinatorJournal( + CoordinatorOperation.INSTALL, + entry, + manifestAlreadyMatched + ); + for (InstallPlan plan : plans) { + if (!plan.publishRequired()) { + continue; + } + CoordinatorDirectory directory = new CoordinatorDirectory(); + directory.target = DatapackSupport.normalizedPath(plan.target()); + directory.pending = DatapackSupport.normalizedPath(plan.pending()); + directory.backup = DatapackSupport.normalizedPath(plan.backup()); + directory.hadTarget = plan.hadTarget(); + directory.originalHash = plan.originalHash(); + directory.desiredHash = plan.desiredHash(); + directory.originalMarkerHash = plan.originalMarkerHash(); + directory.desiredMarkerHash = plan.desiredMarkerHash(); + directory.originalIdentity = plan.originalIdentity(); + directory.desiredIdentity = plan.desiredIdentity(); + directory.targetRoot = plan.targetRootIdentity(); + directory.scratchRoot = plan.scratchRootIdentity(); + directory.targetRootIdentity = plan.targetRootFileIdentity(); + directory.scratchRootIdentity = plan.scratchRootFileIdentity(); + journal.directories.add(directory); + } + return createCoordinator(root, journal); + } + + static DatapackCoordinator createRemovalCoordinator( + File root, + Entry entry, + DirectoryRemoval directoryRemoval, + EditableImportRemoval editableRemoval + ) throws IOException { + CoordinatorJournal journal = newCoordinatorJournal(CoordinatorOperation.REMOVE, entry, true); + for (DirectoryMove move : directoryRemoval.moves()) { + CoordinatorDirectory directory = new CoordinatorDirectory(); + directory.target = DatapackSupport.normalizedPath(move.target()); + directory.pending = ""; + directory.backup = DatapackSupport.normalizedPath(move.backup()); + directory.hadTarget = true; + directory.originalHash = move.originalHash(); + directory.desiredHash = ""; + directory.originalMarkerHash = move.originalMarkerHash(); + directory.desiredMarkerHash = ""; + directory.originalIdentity = move.originalIdentity(); + directory.desiredIdentity = ""; + directory.targetRoot = move.targetRootIdentity(); + directory.scratchRoot = move.scratchRootIdentity(); + directory.targetRootIdentity = move.targetRootFileIdentity(); + directory.scratchRootIdentity = move.scratchRootFileIdentity(); + journal.directories.add(directory); + } + for (StructureTransactionWriter.PreparedRemovalToken token : editableRemoval.recoveryTokens()) { + CoordinatorEditable editable = new CoordinatorEditable(); + editable.packRoot = token.packRoot().toString(); + editable.transactionId = token.transactionId().toString(); + editable.claimId = UUID.randomUUID().toString(); + journal.editables.add(editable); + } + Path transactionRoot = coordinatorTransactionRoot(root, journal); + try { + editableRemoval.claimRecoveryOwners(transactionRoot, journal); + writeCoordinatorJournal(transactionRoot, journal); + return new DatapackCoordinator(transactionRoot, journal); + } catch (IOException | RuntimeException creationFailure) { + try { + DatapackInstall.deleteInstallScratch(transactionRoot.toFile(), "incomplete datapack transaction"); + } catch (IOException cleanupFailure) { + creationFailure.addSuppressed(cleanupFailure); + } + if (creationFailure instanceof IOException ioFailure) { + throw ioFailure; + } + throw creationFailure; + } + } + + static CoordinatorJournal newCoordinatorJournal( + CoordinatorOperation operation, + Entry entry, + boolean manifestAlreadyMatched + ) { + CoordinatorJournal journal = new CoordinatorJournal(); + journal.schemaVersion = TRANSACTION_SCHEMA; + journal.transactionId = UUID.randomUUID().toString(); + journal.operation = operation; + journal.phase = CoordinatorPhase.PREPARED; + journal.id = entry.id; + journal.url = entry.url; + journal.versionId = entry.versionId; + journal.versionNumber = entry.versionNumber; + journal.sha1 = entry.sha1; + journal.manifestAlreadyMatched = manifestAlreadyMatched; + return journal; + } + + static DatapackCoordinator createCoordinator(File root, CoordinatorJournal journal) throws IOException { + Path transactionRoot = coordinatorTransactionRoot(root, journal); + writeCoordinatorJournal(transactionRoot, journal); + return new DatapackCoordinator(transactionRoot, journal); + } + + static Path coordinatorTransactionRoot(File root, CoordinatorJournal journal) throws IOException { + File transactionDirectory = new File(root, TRANSACTION_DIRECTORY); + DatapackSupport.ensureScratchDirectory(transactionDirectory, "datapack transaction"); + Path transactionRoot = new File(transactionDirectory, journal.transactionId).toPath().toAbsolutePath().normalize(); + if (Files.exists(transactionRoot, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Datapack transaction id already exists: " + journal.transactionId); + } + return transactionRoot; + } + + static CoordinatorJournal readCoordinatorJournal(Path transactionRoot) throws IOException { + Path committed = transactionRoot.resolve(TRANSACTION_JOURNAL); + Path next = transactionRoot.resolve(TRANSACTION_JOURNAL_NEXT); + if (Files.exists(committed, LinkOption.NOFOLLOW_LINKS)) { + return parseCoordinatorJournal(committed); + } + if (!Files.exists(next, LinkOption.NOFOLLOW_LINKS)) { + try (Stream entries = Files.list(transactionRoot)) { + if (entries.findAny().isEmpty()) { + return null; + } + } + throw new IOException("Missing datapack transaction journal " + committed); + } + try { + return parseCoordinatorJournal(next); + } catch (IOException firstWriteFailure) { + try (Stream entries = Files.list(transactionRoot)) { + List contents = entries.limit(2).toList(); + if (contents.size() == 1 && Objects.equals(contents.getFirst(), next) + && !Files.isSymbolicLink(next)) { + return null; + } + } + throw firstWriteFailure; + } + } + + static CoordinatorJournal parseCoordinatorJournal(Path journalPath) throws IOException { + if (Files.isSymbolicLink(journalPath) + || !Files.isRegularFile(journalPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Invalid datapack transaction journal " + journalPath); + } + try { + CoordinatorJournal journal = DatapackSupport.GSON.fromJson( + DatapackSupport.readBoundedUtf8( + journalPath, + MAX_TRANSACTION_JOURNAL_BYTES, + "Datapack transaction journal" + ), + CoordinatorJournal.class + ); + if (journal == null) { + throw new IOException("Empty datapack transaction journal " + journalPath); + } + return journal; + } catch (RuntimeException e) { + throw new IOException("Invalid datapack transaction journal " + journalPath, e); + } + } + + static void validateCoordinatorJournal( + File root, + List worldFolders, + Manifest committedManifest, + Path transactionRoot, + CoordinatorJournal journal + ) throws IOException { + if (journal.schemaVersion != TRANSACTION_SCHEMA || journal.transactionId == null + || journal.operation == null || journal.phase == null || journal.id == null + || journal.url == null || journal.directories == null || journal.editables == null) { + throw new IOException("Incomplete datapack transaction journal at " + transactionRoot); + } + UUID transactionId; + try { + transactionId = UUID.fromString(journal.transactionId); + } catch (IllegalArgumentException e) { + throw new IOException("Invalid datapack transaction id " + journal.transactionId, e); + } + if (!transactionId.toString().equals(transactionRoot.getFileName().toString())) { + throw new IOException("Datapack transaction id does not match its directory"); + } + if (!journal.id.equals(DatapackArchive.sanitizeId(journal.id)) || DatapackArchive.RESERVED_IDS.contains(journal.id)) { + throw new IOException("Invalid datapack transaction entry id " + journal.id); + } + if (journal.directories.size() > worldFolders.size() + 1 || journal.editables.size() > 10_000) { + throw new IOException("Datapack transaction journal contains too many participants"); + } + if (journal.operation == CoordinatorOperation.INSTALL && !journal.editables.isEmpty()) { + throw new IOException("Datapack install transaction unexpectedly contains editable participants"); + } + + Set allowedTargets = new HashSet<>(); + allowedTargets.add(new File(new File(root, "staging"), journal.id).toPath().toAbsolutePath().normalize()); + for (File worldFolder : worldFolders) { + allowedTargets.add(new File(worldFolder, journal.id).toPath().toAbsolutePath().normalize()); + } + Set seenTargets = new HashSet<>(); + Set seenTargetIdentities = new HashSet<>(); + for (CoordinatorDirectory directory : journal.directories) { + DatapackCoordinatorResolution.validateCoordinatorDirectory( + directory, journal.operation, allowedTargets, seenTargets, seenTargetIdentities); + } + Set seenEditables = new HashSet<>(); + Set allowedEditableRoots = journal.editables.isEmpty() + ? Set.of() : DatapackCoordinatorResolution.authoritativeEditableRoots(committedManifest, journal); + for (CoordinatorEditable editable : journal.editables) { + if (editable == null || editable.packRoot == null || editable.transactionId == null + || editable.claimId == null + || !seenEditables.add(editable.packRoot)) { + throw new IOException("Invalid duplicate editable participant in datapack transaction"); + } + Path packRoot = coordinatorPath(editable.packRoot, "editable pack root"); + Path realPackRoot = Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS) + ? packRoot.toRealPath() : packRoot; + if (Files.isSymbolicLink(packRoot) || !Files.isDirectory(packRoot, LinkOption.NOFOLLOW_LINKS) + || !packRoot.equals(realPackRoot) || !allowedEditableRoots.contains(realPackRoot)) { + throw new IOException("Invalid editable pack root in datapack transaction: " + packRoot); + } + try { + UUID.fromString(editable.transactionId); + UUID.fromString(editable.claimId); + } catch (IllegalArgumentException e) { + throw new IOException("Invalid editable transaction recovery identity", e); + } + StructureTransactionWriter writer = new StructureTransactionWriter(packRoot); + boolean recoveryDataPresent = writer.verifyRecoveryOwner( + new StructureTransactionWriter.PreparedRemovalToken( + packRoot, + UUID.fromString(editable.transactionId) + ), + new StructureTransactionWriter.RecoveryOwner( + transactionRoot, + UUID.fromString(journal.transactionId), + UUID.fromString(editable.claimId) + ), + committedManifest.findById(journal.id) == null + && journal.phase == CoordinatorPhase.PUBLISHED + ); + if (!recoveryDataPresent && journal.phase != CoordinatorPhase.COMMITTED) { + throw new IOException("Editable structure recovery data disappeared before commit"); + } + } + } + + static void deleteCoordinatorTransaction(Path transactionRoot) throws IOException { + DatapackInstall.deleteInstallScratch(transactionRoot.toFile(), "completed datapack transaction"); + DatapackSupport.forceDirectoryIfSupported(Objects.requireNonNull(transactionRoot.getParent(), "transaction parent")); + } + + static void writeCoordinatorJournal(Path transactionRoot, CoordinatorJournal journal) throws IOException { + byte[] content = DatapackSupport.GSON.toJson(journal).getBytes(StandardCharsets.UTF_8); + if (content.length > MAX_TRANSACTION_JOURNAL_BYTES) { + throw new IOException("Datapack transaction journal exceeds " + MAX_TRANSACTION_JOURNAL_BYTES + " bytes"); + } + Files.createDirectories(transactionRoot); + Path next = transactionRoot.resolve(TRANSACTION_JOURNAL_NEXT); + if (Files.isSymbolicLink(next)) { + throw new IOException("Datapack transaction journal cannot be a symbolic link: " + next); + } + Files.deleteIfExists(next); + Files.write(next, content, StandardOpenOption.CREATE_NEW, StandardOpenOption.WRITE); + DatapackSupport.forceFile(next); + DatapackSupport.move(next, transactionRoot.resolve(TRANSACTION_JOURNAL)); + DatapackSupport.forceDirectoryIfSupported(transactionRoot); + DatapackSupport.forceDirectoryIfSupported(Objects.requireNonNull(transactionRoot.getParent(), "transaction parent")); + } + + static Path coordinatorPath(String value, String purpose) throws IOException { + try { + return Path.of(value).toAbsolutePath().normalize(); + } catch (RuntimeException e) { + throw new IOException("Invalid datapack transaction " + purpose + " path", e); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DirectoryDeleter.java b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryDeleter.java new file mode 100644 index 000000000..c194879ea --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryDeleter.java @@ -0,0 +1,26 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.File; + +@FunctionalInterface +interface DirectoryDeleter { + void delete(File directory); +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DirectoryMove.java b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryMove.java new file mode 100644 index 000000000..e9c5f4261 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryMove.java @@ -0,0 +1,34 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.File; + +record DirectoryMove( + File target, + File backup, + String originalHash, + String originalMarkerHash, + String originalIdentity, + String targetRootIdentity, + String scratchRootIdentity, + String targetRootFileIdentity, + String scratchRootFileIdentity +) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DirectoryRemoval.java b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryRemoval.java new file mode 100644 index 000000000..55c74fcf1 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DirectoryRemoval.java @@ -0,0 +1,179 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.File; +import java.io.IOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.util.List; + +final class DirectoryRemoval { + private final List moved; + private int prepared; + private boolean closed; + + DirectoryRemoval(List moved) { + this.moved = List.copyOf(moved); + } + + List moves() { + return moved; + } + + void prepare() throws IOException { + if (closed || prepared > 0) { + throw new IllegalStateException("Datapack directory removal transaction is not new"); + } + try { + for (DirectoryMove directoryMove : moved) { + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + directoryMove.target().getParentFile(), + directoryMove.targetRootIdentity(), + directoryMove.targetRootFileIdentity(), + "datapack removal target root" + ); + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + directoryMove.backup().getParentFile(), + directoryMove.scratchRootIdentity(), + directoryMove.scratchRootFileIdentity(), + "datapack removal scratch root" + ); + DatapackInstallPlanner.verifyDirectorySnapshot( + directoryMove.target(), + new File(directoryMove.targetRootIdentity()), + directoryMove.originalHash(), + directoryMove.originalMarkerHash(), + directoryMove.originalIdentity(), + "datapack removal target" + ); + DatapackSupport.moveNew(directoryMove.target().toPath(), directoryMove.backup().toPath()); + prepared++; + DatapackSupport.forceDirectoryIfSupported(directoryMove.target().getParentFile().toPath()); + DatapackSupport.forceDirectoryIfSupported(directoryMove.backup().getParentFile().toPath()); + DatapackInstallPlanner.verifyDirectorySnapshot( + directoryMove.backup(), + new File(directoryMove.targetRootIdentity()), + directoryMove.originalHash(), + directoryMove.originalMarkerHash(), + directoryMove.originalIdentity(), + "datapack removal backup" + ); + } + } catch (IOException removalFailure) { + try { + rollback(); + } catch (IOException restoreFailure) { + removalFailure.addSuppressed(restoreFailure); + } + throw removalFailure; + } + } + + void rollback() throws IOException { + if (closed) { + return; + } + IOException failure = null; + for (int i = prepared - 1; i >= 0; i--) { + DirectoryMove directoryMove = moved.get(i); + if (!Files.exists(directoryMove.backup().toPath(), LinkOption.NOFOLLOW_LINKS)) { + continue; + } + try { + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + directoryMove.target().getParentFile(), + directoryMove.targetRootIdentity(), + directoryMove.targetRootFileIdentity(), + "datapack removal target root" + ); + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + directoryMove.backup().getParentFile(), + directoryMove.scratchRootIdentity(), + directoryMove.scratchRootFileIdentity(), + "datapack removal scratch root" + ); + DatapackInstallPlanner.verifyDirectorySnapshot( + directoryMove.backup(), + new File(directoryMove.targetRootIdentity()), + directoryMove.originalHash(), + directoryMove.originalMarkerHash(), + directoryMove.originalIdentity(), + "datapack removal backup" + ); + if (DatapackSupport.pathExists(directoryMove.target().toPath(), "datapack removal target")) { + throw new IOException("Datapack removal target was concurrently recreated at " + + directoryMove.target().getPath()); + } + DatapackSupport.moveNew( + directoryMove.backup().toPath(), + directoryMove.target().toPath() + ); + DatapackSupport.forceDirectoryIfSupported(directoryMove.target().getParentFile().toPath()); + DatapackSupport.forceDirectoryIfSupported(directoryMove.backup().getParentFile().toPath()); + } catch (IOException restoreFailure) { + if (failure == null) { + failure = restoreFailure; + } else { + failure.addSuppressed(restoreFailure); + } + } + } + for (int i = 0; i < prepared; i++) { + DirectoryMove directoryMove = moved.get(i); + directoryMove.backup().getParentFile().delete(); + } + closed = true; + if (failure != null) { + throw failure; + } + } + + void finishCommit() throws IOException { + if (closed) { + return; + } + IOException failure = null; + for (int i = 0; i < prepared; i++) { + DirectoryMove directoryMove = moved.get(i); + try { + DatapackInstallPlanner.verifyDirectoryContainerIdentity( + directoryMove.backup().getParentFile(), + directoryMove.scratchRootIdentity(), + directoryMove.scratchRootFileIdentity(), + "datapack removal scratch root" + ); + DatapackCoordinatorResolution.deleteOriginalBackupIfPresent( + directoryMove.backup(), + new File(directoryMove.targetRootIdentity()), + directoryMove.originalHash(), + directoryMove.originalMarkerHash(), + directoryMove.originalIdentity() + ); + } catch (IOException cleanupFailure) { + failure = DatapackSupport.appendIOException(failure, cleanupFailure); + } + directoryMove.backup().getParentFile().delete(); + } + closed = true; + if (failure != null) { + throw failure; + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DownloadResult.java b/core/src/main/java/art/arcane/iris/core/datapack/DownloadResult.java new file mode 100644 index 000000000..26b1428f7 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/DownloadResult.java @@ -0,0 +1,23 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +record DownloadResult(boolean notModified, String etag, String lastModified) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/EditableImportRemoval.java b/core/src/main/java/art/arcane/iris/core/datapack/EditableImportRemoval.java new file mode 100644 index 000000000..e87aa7f72 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/EditableImportRemoval.java @@ -0,0 +1,171 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; + +final class EditableImportRemoval { + private final List prepared; + private boolean closed; + + EditableImportRemoval(List prepared) { + this.prepared = List.copyOf(prepared); + } + + List recoveryTokens() { + List tokens = new ArrayList<>(); + for (PreparedEditableImport editableImport : prepared) { + editableImport.removal().recoveryToken().ifPresent(tokens::add); + } + return List.copyOf(tokens); + } + + void claimRecoveryOwners(Path transactionRoot, CoordinatorJournal journal) throws IOException { + int ownerIndex = 0; + for (PreparedEditableImport editableImport : prepared) { + Optional token = + editableImport.removal().recoveryToken(); + if (token.isEmpty()) { + continue; + } + if (ownerIndex >= journal.editables.size()) { + throw new IOException("Missing datapack coordinator claim for editable structure removal"); + } + CoordinatorEditable editable = journal.editables.get(ownerIndex++); + StructureTransactionWriter.PreparedRemovalToken recoveryToken = token.get(); + if (!Objects.equals(recoveryToken.packRoot().toString(), editable.packRoot) + || !Objects.equals(recoveryToken.transactionId().toString(), editable.transactionId)) { + throw new IOException("Datapack coordinator editable claim order changed during preparation"); + } + editableImport.removal().claimRecoveryOwner( + new StructureTransactionWriter.RecoveryOwner( + transactionRoot, + UUID.fromString(journal.transactionId), + UUID.fromString(editable.claimId) + ) + ); + } + if (ownerIndex != journal.editables.size()) { + throw new IOException("Unexpected datapack coordinator editable recovery claim"); + } + } + + void markCommitted() throws IOException { + if (closed) { + throw new IllegalStateException("Editable import removal transaction is closed"); + } + for (PreparedEditableImport editableImport : prepared) { + editableImport.removal().markCommitted(); + } + } + + void finishCommit() throws IOException { + if (closed) { + return; + } + IOException failure = null; + for (PreparedEditableImport editableImport : prepared) { + try { + editableImport.removal().finishCommit(); + } catch (IOException | RuntimeException cleanupFailure) { + IOException transactionFailure = cleanupFailure instanceof IOException ioFailure + ? ioFailure + : new IOException("Failed finalizing editable import removal", cleanupFailure); + if (failure == null) { + failure = transactionFailure; + } else { + failure.addSuppressed(transactionFailure); + } + } + if (editableImport.removal().changed()) { + try { + IrisData.getLoaded(editableImport.dataFolder()) + .ifPresent(IrisData::invalidateStructureResources); + } catch (RuntimeException invalidationFailure) { + IOException transactionFailure = new IOException( + "Failed invalidating editable import structure resources", + invalidationFailure + ); + if (failure == null) { + failure = transactionFailure; + } else { + failure.addSuppressed(transactionFailure); + } + } + } + } + closed = true; + if (failure != null) { + throw failure; + } + } + + void rollback() throws IOException { + if (closed) { + return; + } + IOException failure = null; + for (int i = prepared.size() - 1; i >= 0; i--) { + try { + prepared.get(i).removal().rollback(); + } catch (IOException rollbackFailure) { + if (failure == null) { + failure = rollbackFailure; + } else { + failure.addSuppressed(rollbackFailure); + } + } + } + closed = true; + if (failure != null) { + throw failure; + } + } + + void leaveForRecovery() throws IOException { + if (closed) { + return; + } + IOException failure = null; + for (PreparedEditableImport editableImport : prepared) { + try { + editableImport.removal().leaveForRecovery(); + } catch (IOException releaseFailure) { + if (failure == null) { + failure = releaseFailure; + } else { + failure.addSuppressed(releaseFailure); + } + } + } + closed = true; + if (failure != null) { + throw failure; + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/InstallExecution.java b/core/src/main/java/art/arcane/iris/core/datapack/InstallExecution.java new file mode 100644 index 000000000..b59960b29 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/InstallExecution.java @@ -0,0 +1,96 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; + +import java.io.File; +import java.util.List; + +final class InstallExecution { + private final InstallResult result; + private final DatapackCoordinator coordinator; + private final File stagedDir; + private final Entry entry; + private final String stagedHash; + private final boolean verifyStagedSource; + private final List publishedPlans; + private final List unchangedPlans; + private boolean verified; + + InstallExecution( + InstallResult result, + DatapackCoordinator coordinator, + File stagedDir, + Entry entry, + String stagedHash, + boolean verifyStagedSource, + List publishedPlans, + List unchangedPlans + ) { + this.result = result; + this.coordinator = coordinator; + this.stagedDir = stagedDir; + this.entry = DatapackManifestStore.copyEntry(entry); + this.stagedHash = stagedHash; + this.verifyStagedSource = verifyStagedSource; + this.publishedPlans = List.copyOf(publishedPlans); + this.unchangedPlans = List.copyOf(unchangedPlans); + } + + InstallResult result() { + return result; + } + + DatapackCoordinator coordinator() { + return coordinator; + } + + File stagedDir() { + return stagedDir; + } + + Entry entry() { + return entry; + } + + String stagedHash() { + return stagedHash; + } + + boolean verifyStagedSource() { + return verifyStagedSource; + } + + List publishedPlans() { + return publishedPlans; + } + + List unchangedPlans() { + return unchangedPlans; + } + + boolean verified() { + return verified; + } + + void markVerified() { + verified = true; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/InstallPlan.java b/core/src/main/java/art/arcane/iris/core/datapack/InstallPlan.java new file mode 100644 index 000000000..38071dfa9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/InstallPlan.java @@ -0,0 +1,45 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.File; + +record InstallPlan( + File target, + File pending, + File backup, + File pendingRoot, + boolean hadTarget, + boolean publishRequired, + boolean contentChanged, + String originalHash, + String desiredHash, + String originalMarkerHash, + String desiredMarkerHash, + String originalIdentity, + String desiredIdentity, + String targetRootIdentity, + String scratchRootIdentity, + String targetRootFileIdentity, + String scratchRootFileIdentity, + String id, + String url, + VerifiedStagingInstall legacyWorldAuthorization +) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/InstallResult.java b/core/src/main/java/art/arcane/iris/core/datapack/InstallResult.java new file mode 100644 index 000000000..9e59552dd --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/InstallResult.java @@ -0,0 +1,23 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +record InstallResult(boolean changed) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/Manifest.java b/core/src/main/java/art/arcane/iris/core/datapack/Manifest.java new file mode 100644 index 000000000..838c15977 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/Manifest.java @@ -0,0 +1,61 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; + +import java.util.ArrayList; +import java.util.List; + +final class Manifest { + List entries = new ArrayList<>(); + + Entry find(String url) { + for (Entry entry : entries) { + if (entry.url != null && entry.url.equals(url)) { + return entry; + } + } + return null; + } + + Entry findById(String id) { + for (Entry entry : entries) { + if (entry.id != null && entry.id.equals(id)) { + return entry; + } + } + return null; + } + + void put(Entry entry) { + for (int i = 0; i < entries.size(); i++) { + Entry current = entries.get(i); + if (current.url != null && current.url.equals(entry.url)) { + entries.set(i, entry); + return; + } + } + entries.add(entry); + } + + boolean removeById(String id) { + return entries.removeIf(entry -> id.equals(entry.id)); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/ManifestWrite.java b/core/src/main/java/art/arcane/iris/core/datapack/ManifestWrite.java new file mode 100644 index 000000000..faf904e59 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/ManifestWrite.java @@ -0,0 +1,96 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Objects; + +final class ManifestWrite implements AutoCloseable { + private final Path staged; + private final Path target; + private final Path rollback; + private boolean published; + + ManifestWrite(Path staged, Path target, Path rollback) { + this.staged = staged; + this.target = target; + this.rollback = rollback; + } + + void publish() throws IOException { + if (published) { + throw new IllegalStateException("Datapack manifest write was already published"); + } + try { + DatapackSupport.move(staged, target); + published = true; + } catch (IOException publishFailure) { + try { + restoreOriginal(); + } catch (IOException restoreFailure) { + publishFailure.addSuppressed(restoreFailure); + } + throw publishFailure; + } + DatapackSupport.forceDirectoryIfSupported(Objects.requireNonNull(target.getParent(), "manifest parent")); + } + + boolean published() { + return published; + } + + void discard() throws IOException { + IOException failure = null; + try { + Files.deleteIfExists(staged); + } catch (IOException cleanupFailure) { + failure = cleanupFailure; + } + if (rollback != null) { + try { + Files.deleteIfExists(rollback); + } catch (IOException cleanupFailure) { + if (failure == null) { + failure = cleanupFailure; + } else { + failure.addSuppressed(cleanupFailure); + } + } + } + if (failure != null) { + throw failure; + } + } + + @Override + public void close() throws IOException { + discard(); + } + + private void restoreOriginal() throws IOException { + if (rollback == null) { + Files.deleteIfExists(target); + } else { + DatapackSupport.move(rollback, target); + } + DatapackSupport.forceDirectoryIfSupported(Objects.requireNonNull(target.getParent(), "manifest parent")); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/MetadataEntry.java b/core/src/main/java/art/arcane/iris/core/datapack/MetadataEntry.java new file mode 100644 index 000000000..c71ebb518 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/MetadataEntry.java @@ -0,0 +1,24 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.nio.file.Path; + +record MetadataEntry(Path path, String relativePath) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/Ownership.java b/core/src/main/java/art/arcane/iris/core/datapack/Ownership.java new file mode 100644 index 000000000..fb52546fd --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/Ownership.java @@ -0,0 +1,69 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; + +import java.util.List; + +final class Ownership { + final int schemaVersion; + final String id; + final String url; + final String versionId; + final String versionNumber; + final String sha1; + final String contentHash; + final List structureKeys; + final List templateKeys; + + Ownership( + int schemaVersion, + String id, + String url, + String versionId, + String versionNumber, + String sha1, + String contentHash, + List structureKeys, + List templateKeys + ) { + this.schemaVersion = schemaVersion; + this.id = id; + this.url = url; + this.versionId = versionId; + this.versionNumber = versionNumber; + this.sha1 = sha1; + this.contentHash = contentHash; + this.structureKeys = List.copyOf(structureKeys); + this.templateKeys = List.copyOf(templateKeys); + } + + Entry toEntry() { + Entry entry = new Entry(); + entry.id = id; + entry.url = url; + entry.versionId = versionId; + entry.versionNumber = versionNumber; + entry.sha1 = sha1; + entry.structureKeys = DatapackManifestStore.normalizeKeys(structureKeys); + entry.templateKeys = DatapackManifestStore.normalizeKeys(templateKeys); + return entry; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/PackResources.java b/core/src/main/java/art/arcane/iris/core/datapack/PackResources.java new file mode 100644 index 000000000..88e81648f --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/PackResources.java @@ -0,0 +1,28 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.util.List; + +record PackResources( + List structureKeys, + List structureSetKeys, + List templateKeys +) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/PreparedEditableImport.java b/core/src/main/java/art/arcane/iris/core/datapack/PreparedEditableImport.java new file mode 100644 index 000000000..64e553de9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/PreparedEditableImport.java @@ -0,0 +1,29 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; + +import java.io.File; + +record PreparedEditableImport( + File dataFolder, + StructureTransactionWriter.PreparedRemoval removal +) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/RemoveOutcome.java b/core/src/main/java/art/arcane/iris/core/datapack/RemoveOutcome.java new file mode 100644 index 000000000..9400549d5 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/RemoveOutcome.java @@ -0,0 +1,26 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +enum RemoveOutcome { + REMOVED, + REJECTED, + FAILED_AFTER_MUTATION +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/StagingInspection.java b/core/src/main/java/art/arcane/iris/core/datapack/StagingInspection.java new file mode 100644 index 000000000..aebfd1775 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/StagingInspection.java @@ -0,0 +1,27 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + + +record StagingInspection( + boolean usable, + boolean ownershipCorrected, + boolean manifestChanged +) { +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/StartupValidationCache.java b/core/src/main/java/art/arcane/iris/core/datapack/StartupValidationCache.java new file mode 100644 index 000000000..295dd3d53 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/StartupValidationCache.java @@ -0,0 +1,31 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import java.util.List; + +final class StartupValidationCache { + int schemaVersion; + String minecraftVersion; + int irisVersion; + boolean autoIngest; + boolean stripOverrides; + List urls; + String localFingerprint; +} diff --git a/core/src/main/java/art/arcane/iris/core/datapack/VerifiedStagingInstall.java b/core/src/main/java/art/arcane/iris/core/datapack/VerifiedStagingInstall.java new file mode 100644 index 000000000..ec768d594 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/datapack/VerifiedStagingInstall.java @@ -0,0 +1,248 @@ +/* + * Iris is a World Generator for Minecraft Bukkit Servers + * Copyright (c) 2022 Arcane Arts (Volmit Software) + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package art.arcane.iris.core.datapack; + +import art.arcane.iris.core.datapack.DatapackIngestService.Entry; + +import java.io.File; +import java.io.IOException; +import java.nio.file.LinkOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Objects; + +final class VerifiedStagingInstall { + private final Path normalizedRoot; + private final Path realRoot; + private final String rootIdentity; + private final Path normalizedStagingRoot; + private final Path realStagingRoot; + private final String stagingRootIdentity; + private final Path normalizedSource; + private final Path realSource; + private final String sourceIdentity; + private final String id; + private final String url; + private final String versionId; + private final String versionNumber; + private final String sha1; + private final String desiredHash; + private final Entry committedEntrySnapshot; + private final boolean legacyReplacementAuthorized; + private final DatapackStagingGuard.LegacyStagingSnapshot legacyStagingSnapshot; + private boolean consumed; + + VerifiedStagingInstall( + Path normalizedRoot, + Path normalizedStagingRoot, + Path normalizedSource, + Entry entry, + String desiredHash, + Entry committedEntrySnapshot, + boolean legacyReplacementAuthorized, + DatapackStagingGuard.LegacyStagingSnapshot legacyStagingSnapshot + ) throws IOException { + this.normalizedRoot = normalizedRoot; + this.realRoot = normalizedRoot.toRealPath(); + this.rootIdentity = DatapackSupport.directoryIdentity(normalizedRoot.toFile()); + this.normalizedStagingRoot = normalizedStagingRoot; + this.realStagingRoot = normalizedStagingRoot.toRealPath(); + this.stagingRootIdentity = DatapackSupport.directoryIdentity(normalizedStagingRoot.toFile()); + this.normalizedSource = normalizedSource; + this.realSource = normalizedSource.toRealPath(); + this.sourceIdentity = DatapackSupport.directoryIdentity(normalizedSource.toFile()); + this.id = entry.id; + this.url = entry.url; + this.versionId = entry.versionId; + this.versionNumber = entry.versionNumber; + this.sha1 = entry.sha1; + this.desiredHash = desiredHash; + this.committedEntrySnapshot = committedEntrySnapshot == null ? null : DatapackManifestStore.copyEntry(committedEntrySnapshot); + this.legacyReplacementAuthorized = legacyReplacementAuthorized; + this.legacyStagingSnapshot = legacyStagingSnapshot; + } + + Path stagingRoot() { + return normalizedStagingRoot; + } + + boolean hasStablePathIdentities() { + return !rootIdentity.isEmpty() + && !stagingRootIdentity.isEmpty() + && !sourceIdentity.isEmpty(); + } + + boolean isCanonicalInstall(File installRoot, File target) { + Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); + Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); + return suppliedRoot.equals(normalizedStagingRoot) + && suppliedTarget.equals(normalizedStagingRoot.resolve(id).normalize()); + } + + void verifyStagingRoot() throws IOException { + verifyPathIdentity(normalizedRoot, realRoot, rootIdentity, "datapack storage root"); + verifyPathIdentity( + normalizedStagingRoot, realStagingRoot, stagingRootIdentity, "datapack staging root"); + if (!Objects.equals(normalizedStagingRoot.getParent(), normalizedRoot) + || !Files.isSameFile(normalizedStagingRoot.getParent(), normalizedRoot)) { + throw new IOException("Verified datapack staging root changed identity"); + } + } + + boolean consume( + File source, + File installRoot, + File target, + Entry entry, + String stagedHash + ) throws IOException { + if (consumed) { + throw new IOException("Verified datapack staging authorization was already consumed"); + } + consumed = true; + Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); + Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); + if (!suppliedRoot.equals(normalizedStagingRoot) + || !suppliedTarget.equals(normalizedStagingRoot.resolve(id).normalize())) { + throw new IOException("Verified datapack staging authorization was paired with a different path"); + } + verifyAuthority(source, entry, stagedHash); + return legacyReplacementAuthorized; + } + + boolean authorizeLegacyWorldReplacement( + File source, + File installRoot, + File target, + Entry entry, + String stagedHash, + String currentHash, + String currentMarkerHash + ) throws IOException { + if (legacyStagingSnapshot == null + || !"absent".equals(currentMarkerHash) + || !Objects.equals(currentHash, legacyStagingSnapshot.contentHash()) + || legacyStagingSnapshot.targetIdentity().isEmpty()) { + return false; + } + Path suppliedRoot = installRoot.toPath().toAbsolutePath().normalize(); + Path suppliedTarget = target.toPath().toAbsolutePath().normalize(); + if (!Objects.equals(suppliedTarget.getParent(), suppliedRoot) + || !Objects.equals(suppliedTarget.getFileName().toString(), id) + || Files.isSameFile(suppliedRoot, normalizedStagingRoot) + || Files.isSameFile(suppliedTarget, legacyStagingSnapshot.normalizedTarget())) { + return false; + } + verifyAuthority(source, entry, stagedHash); + verifyLegacyWorldSnapshot(); + return true; + } + + private void verifyAuthority(File source, Entry entry, String stagedHash) throws IOException { + verifyAuthorityState(); + Path suppliedSource = source.toPath().toAbsolutePath().normalize(); + if (!suppliedSource.equals(normalizedSource)) { + throw new IOException("Verified datapack staging authorization was paired with a different path"); + } + if (!Objects.equals(entry.id, id) + || !Objects.equals(entry.url, url) + || !Objects.equals(entry.versionId, versionId) + || !Objects.equals(entry.versionNumber, versionNumber) + || !Objects.equals(entry.sha1, sha1) + || !Objects.equals(stagedHash, desiredHash)) { + throw new IOException("Verified datapack staging authorization was paired with different metadata"); + } + } + + private void verifyAuthorityState() throws IOException { + verifyStagingRoot(); + verifyPathIdentity(normalizedSource, realSource, sourceIdentity, "verified datapack extraction"); + Manifest committedManifest = DatapackManifestStore.readCommittedManifest(normalizedRoot.toFile()); + Entry committed = committedManifest.findById(id); + if (!manifestEntrySnapshotMatches(committed, committedEntrySnapshot)) { + throw new IOException("Committed datapack staging authority changed before installation"); + } + if (committedEntrySnapshot != null && !legacyReplacementAuthorized) { + throw new IOException("Committed datapack staging authority conflicts with " + id); + } + } + + private static boolean manifestEntrySnapshotMatches(Entry current, Entry expected) { + if (current == null || expected == null) { + return current == expected; + } + return Objects.equals(current.id, expected.id) + && Objects.equals(current.url, expected.url) + && Objects.equals(current.versionId, expected.versionId) + && Objects.equals(current.versionNumber, expected.versionNumber) + && Objects.equals(current.sha1, expected.sha1) + && Objects.equals(current.filename, expected.filename) + && Objects.equals(current.etag, expected.etag) + && Objects.equals(current.lastModified, expected.lastModified) + && current.installedEpoch == expected.installedEpoch + && current.structuresImported == expected.structuresImported + && DatapackManifestStore.copyList(current.structureKeys).equals(DatapackManifestStore.copyList(expected.structureKeys)) + && DatapackManifestStore.copyList(current.templateKeys).equals(DatapackManifestStore.copyList(expected.templateKeys)) + && Objects.equals(current.importedTargets, expected.importedTargets) + && Objects.equals(current.importAttempts, expected.importAttempts) + && Objects.equals(current.importedBundles, expected.importedBundles); + } + + void verifyLegacyWorldSnapshot() throws IOException { + verifyAuthorityState(); + if (legacyStagingSnapshot == null || legacyStagingSnapshot.targetIdentity().isEmpty()) { + throw new IOException("Missing stable canonical legacy datapack staging snapshot for " + id); + } + if (!Objects.equals(legacyStagingSnapshot.normalizedTarget().getParent(), normalizedStagingRoot) + || !Files.isSameFile( + legacyStagingSnapshot.normalizedTarget().getParent(), normalizedStagingRoot) + || !DatapackScratchRecovery.sameScratchVolume( + legacyStagingSnapshot.normalizedTarget(), normalizedStagingRoot)) { + throw new IOException("Changed or unsafe canonical legacy datapack staging target for " + id); + } + DatapackInstallPlanner.verifyDirectorySnapshot( + legacyStagingSnapshot.normalizedTarget().toFile(), + normalizedStagingRoot.toFile(), + legacyStagingSnapshot.contentHash(), + legacyStagingSnapshot.markerHash(), + legacyStagingSnapshot.targetIdentity(), + "canonical legacy datapack staging target" + ); + if (!Objects.equals( + legacyStagingSnapshot.normalizedTarget().toRealPath(), + legacyStagingSnapshot.realTarget())) { + throw new IOException("Changed canonical legacy datapack staging target identity for " + id); + } + } + + private static void verifyPathIdentity( + Path normalized, + Path expectedReal, + String expectedIdentity, + String purpose + ) throws IOException { + if (Files.isSymbolicLink(normalized) + || !Files.isDirectory(normalized, LinkOption.NOFOLLOW_LINKS) + || !Objects.equals(normalized.toRealPath(), expectedReal) + || (!expectedIdentity.isEmpty() + && !Objects.equals(DatapackSupport.directoryIdentity(normalized.toFile()), expectedIdentity))) { + throw new IOException("Changed or unsafe " + purpose + " " + normalized); + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java index 7db24b0dc..a61082737 100644 --- a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java +++ b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java @@ -72,7 +72,7 @@ public class DatapackIngestServiceTest { doReturn("26.2").when(server).getMinecraftVersion(); doReturn("26.2.build.33").when(server).getBukkitVersion(); - assertEquals("26.2", DatapackIngestService.serverMcVersion(server)); + assertEquals("26.2", DatapackSupport.serverMcVersion(server)); } @Test @@ -80,7 +80,7 @@ public class DatapackIngestServiceTest { Server server = mock(Server.class); doReturn("1.21.4-R0.1-SNAPSHOT").when(server).getBukkitVersion(); - assertEquals("1.21.4", DatapackIngestService.serverMcVersion(server)); + assertEquals("1.21.4", DatapackSupport.serverMcVersion(server)); } @Test @@ -90,7 +90,7 @@ public class DatapackIngestServiceTest { when(shortPathStore.getAttribute("volume:vsn")).thenReturn(41234L); when(longPathStore.getAttribute("volume:vsn")).thenReturn(41234L); - assertTrue(DatapackIngestService.sameWindowsVolume( + assertTrue(DatapackScratchRecovery.sameWindowsVolume( shortPathStore, "C:\\", longPathStore, "c:\\")); } @@ -101,11 +101,11 @@ public class DatapackIngestServiceTest { when(firstStore.getAttribute("volume:vsn")).thenReturn(1L); when(secondStore.getAttribute("volume:vsn")).thenReturn(2L); - assertFalse(DatapackIngestService.sameWindowsVolume( + assertFalse(DatapackScratchRecovery.sameWindowsVolume( firstStore, "C:\\", secondStore, "C:\\")); when(secondStore.getAttribute("volume:vsn")).thenReturn(1L); - assertFalse(DatapackIngestService.sameWindowsVolume( + assertFalse(DatapackScratchRecovery.sameWindowsVolume( firstStore, "C:\\", secondStore, "D:\\")); } @@ -115,15 +115,15 @@ public class DatapackIngestServiceTest { when(attributes.isDirectory()).thenReturn(true); when(attributes.isOther()).thenReturn(true); - assertFalse(DatapackIngestService.isSupportedScratchDirectory(attributes)); + assertFalse(DatapackScratchRecovery.isSupportedScratchDirectory(attributes)); when(attributes.isOther()).thenReturn(false); - assertTrue(DatapackIngestService.isSupportedScratchDirectory(attributes)); + assertTrue(DatapackScratchRecovery.isSupportedScratchDirectory(attributes)); } @Test public void startupValidationCacheRequiresEveryInputAndLocalFingerprint() { - DatapackIngestService.StartupValidationCache cache = new DatapackIngestService.StartupValidationCache(); + StartupValidationCache cache = new StartupValidationCache(); cache.schemaVersion = 1; cache.minecraftVersion = "26.2"; cache.irisVersion = 4000; @@ -132,7 +132,7 @@ public class DatapackIngestServiceTest { cache.urls = List.of("https://modrinth.com/datapack/example"); cache.localFingerprint = "fingerprint"; - assertTrue(DatapackIngestService.startupValidationCacheMatches( + assertTrue(DatapackStartupValidation.startupValidationCacheMatches( cache, "26.2", 4000, @@ -140,7 +140,7 @@ public class DatapackIngestServiceTest { false, List.of("https://modrinth.com/datapack/example"), "fingerprint")); - assertFalse(DatapackIngestService.startupValidationCacheMatches( + assertFalse(DatapackStartupValidation.startupValidationCacheMatches( cache, "26.3", 4000, @@ -148,7 +148,7 @@ public class DatapackIngestServiceTest { false, cache.urls, "fingerprint")); - assertFalse(DatapackIngestService.startupValidationCacheMatches( + assertFalse(DatapackStartupValidation.startupValidationCacheMatches( cache, "26.2", 4000, @@ -156,7 +156,7 @@ public class DatapackIngestServiceTest { true, cache.urls, "fingerprint")); - assertFalse(DatapackIngestService.startupValidationCacheMatches( + assertFalse(DatapackStartupValidation.startupValidationCacheMatches( cache, "26.2", 4000, @@ -164,7 +164,7 @@ public class DatapackIngestServiceTest { false, List.of("https://modrinth.com/datapack/changed"), "fingerprint")); - assertFalse(DatapackIngestService.startupValidationCacheMatches( + assertFalse(DatapackStartupValidation.startupValidationCacheMatches( cache, "26.2", 4000, @@ -182,10 +182,10 @@ public class DatapackIngestServiceTest { Path content = new File(staged, "value.txt").toPath(); Files.writeString(content, "alpha", StandardCharsets.UTF_8); KList worldFolders = new KList<>(); - String before = DatapackIngestService.startupValidationFingerprint(root, worldFolders); + String before = DatapackStartupValidation.startupValidationFingerprint(root, worldFolders); Files.writeString(content, "bravo", StandardCharsets.UTF_8); - String after = DatapackIngestService.startupValidationFingerprint(root, worldFolders); + String after = DatapackStartupValidation.startupValidationFingerprint(root, worldFolders); assertFalse(before.equals(after)); } @@ -199,42 +199,42 @@ public class DatapackIngestServiceTest { Files.writeString(content, "before", StandardCharsets.UTF_8); KList worldFolders = new KList<>(); - DatapackIngestService.StartupValidationCache validated = new DatapackIngestService.StartupValidationCache(); + StartupValidationCache validated = new StartupValidationCache(); validated.schemaVersion = 1; validated.minecraftVersion = "26.2"; validated.irisVersion = 4000; validated.autoIngest = true; validated.stripOverrides = false; validated.urls = List.of("https://modrinth.com/datapack/example"); - validated.localFingerprint = DatapackIngestService.startupValidationFingerprint(root, worldFolders); + validated.localFingerprint = DatapackStartupValidation.startupValidationFingerprint(root, worldFolders); Files.writeString(content, "after", StandardCharsets.UTF_8); - assertFalse(DatapackIngestService.startupValidationCacheMatches( + assertFalse(DatapackStartupValidation.startupValidationCacheMatches( validated, "26.2", 4000, true, false, validated.urls, - DatapackIngestService.startupValidationFingerprint(root, worldFolders))); + DatapackStartupValidation.startupValidationFingerprint(root, worldFolders))); - DatapackIngestService.StartupValidationCache refreshed = - DatapackIngestService.refreshStartupValidationCache(validated, root, worldFolders); + StartupValidationCache refreshed = + DatapackStartupValidation.refreshStartupValidationCache(validated, root, worldFolders); - assertTrue(DatapackIngestService.startupValidationCacheMatches( + assertTrue(DatapackStartupValidation.startupValidationCacheMatches( refreshed, "26.2", 4000, true, false, validated.urls, - DatapackIngestService.startupValidationFingerprint(root, worldFolders))); + DatapackStartupValidation.startupValidationFingerprint(root, worldFolders))); assertEquals(validated.urls, refreshed.urls); } @Test public void startupMaintenanceDoesNotAuthorizeChangedValidationInputs() { - DatapackIngestService.StartupValidationCache validated = new DatapackIngestService.StartupValidationCache(); + StartupValidationCache validated = new StartupValidationCache(); validated.schemaVersion = 1; validated.minecraftVersion = "26.2"; validated.irisVersion = 4000; @@ -242,12 +242,12 @@ public class DatapackIngestServiceTest { validated.stripOverrides = false; validated.urls = List.of("https://modrinth.com/datapack/example"); - assertTrue(DatapackIngestService.startupValidationContextMatches( + assertTrue(DatapackStartupValidation.startupValidationContextMatches( validated, "26.2", 4000, true, false, validated.urls)); - assertFalse(DatapackIngestService.startupValidationContextMatches( + assertFalse(DatapackStartupValidation.startupValidationContextMatches( validated, "26.2", 4000, true, false, List.of("https://modrinth.com/datapack/changed"))); - assertFalse(DatapackIngestService.startupValidationContextMatches( + assertFalse(DatapackStartupValidation.startupValidationContextMatches( validated, "26.2", 4000, true, true, validated.urls)); } @@ -258,12 +258,12 @@ public class DatapackIngestServiceTest { {"pack":{"description":"test","pack_format":88}} """, StandardCharsets.UTF_8); - DatapackIngestService.validatePackMetadata(valid); + DatapackPackMetadata.validatePackMetadata(valid); File invalid = temporaryFolder.newFolder("invalid"); Files.writeString(new File(invalid, "pack.mcmeta").toPath(), "{}", StandardCharsets.UTF_8); try { - DatapackIngestService.validatePackMetadata(invalid); + DatapackPackMetadata.validatePackMetadata(invalid); fail("Expected invalid metadata to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("pack object")); @@ -287,7 +287,7 @@ public class DatapackIngestServiceTest { server.start(); try { File destination = new File(temporaryFolder.newFolder("download"), "pack.zip"); - DatapackIngestService.DownloadResult result = DatapackIngestService.download( + DownloadResult result = DatapackArchive.download( "http://127.0.0.1:" + server.getAddress().getPort() + "/start", destination, null, @@ -314,7 +314,7 @@ public class DatapackIngestServiceTest { server.start(); try { File destination = new File(temporaryFolder.newFolder("conditional"), "pack.zip"); - DatapackIngestService.DownloadResult result = DatapackIngestService.download( + DownloadResult result = DatapackArchive.download( "http://127.0.0.1:" + server.getAddress().getPort() + "/pack.zip", destination, "\"v1\"", @@ -335,7 +335,7 @@ public class DatapackIngestServiceTest { Files.writeString(source, "local-archive", StandardCharsets.UTF_8); File destination = new File(temporaryFolder.newFolder("local-download"), "pack.zip"); - DatapackIngestService.DownloadResult result = DatapackIngestService.download( + DownloadResult result = DatapackArchive.download( source.toUri().toASCIIString(), destination, null, @@ -353,7 +353,7 @@ public class DatapackIngestServiceTest { Files.writeString(destination.toPath(), "existing", StandardCharsets.UTF_8); try { - DatapackIngestService.download( + DatapackArchive.download( missing.toUri().toASCIIString(), destination, null, @@ -379,7 +379,7 @@ public class DatapackIngestServiceTest { Files.createDirectories(nested.getParent()); Files.writeString(nested, "nested", StandardCharsets.UTF_8); - List discovered = DatapackIngestService.discoverLocalDatapackImports(imports); + List discovered = DatapackImportSources.discoverLocalDatapackImports(imports); assertEquals(List.of( first.toAbsolutePath().normalize().toUri().toASCIIString(), @@ -393,10 +393,10 @@ public class DatapackIngestServiceTest { String discovered = source.toAbsolutePath().normalize().toUri().toASCIIString(); String alternate = discovered.replace("file:///", "file:/"); - assertEquals(discovered, DatapackIngestService.normalizeConfiguredSource(alternate)); + assertEquals(discovered, DatapackImportSources.normalizeConfiguredSource(alternate)); assertEquals( Set.of("https://example.test/dimension.zip", discovered), - DatapackIngestService.mergeConfiguredImports( + DatapackImportSources.mergeConfiguredImports( List.of("https://example.test/dimension.zip", alternate), List.of(discovered))); } @@ -408,13 +408,13 @@ public class DatapackIngestServiceTest { KList worldFolders = new KList<>(); String sourceUrl = source.toUri().toASCIIString(); Files.writeString(source, "alpha", StandardCharsets.UTF_8); - String before = DatapackIngestService.startupValidationFingerprint( + String before = DatapackStartupValidation.startupValidationFingerprint( root, worldFolders, List.of(sourceUrl)); FileTime originalTime = Files.getLastModifiedTime(source); Files.writeString(source, "bravo", StandardCharsets.UTF_8); Files.setLastModifiedTime(source, originalTime); - String after = DatapackIngestService.startupValidationFingerprint( + String after = DatapackStartupValidation.startupValidationFingerprint( root, worldFolders, List.of(sourceUrl)); assertFalse(before.equals(after)); @@ -424,7 +424,7 @@ public class DatapackIngestServiceTest { public void removalRequiresMatchingIrisOwnership() throws Exception { File unmanaged = datapackDirectory("unmanaged"); try { - DatapackIngestService.deleteOwnedDirectory(unmanaged, "unmanaged"); + DatapackOwnership.deleteOwnedDirectory(unmanaged, "unmanaged"); fail("Expected unmanaged datapack removal to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("ownership marker")); @@ -438,9 +438,9 @@ public class DatapackIngestServiceTest { entry.versionId = "version"; entry.versionNumber = "1"; entry.sha1 = "hash"; - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); - assertTrue(DatapackIngestService.deleteOwnedDirectory(managed, "managed")); + assertTrue(DatapackOwnership.deleteOwnedDirectory(managed, "managed")); assertFalse(managed.exists()); } @@ -451,7 +451,7 @@ public class DatapackIngestServiceTest { Files.createSymbolicLink(link.toPath(), outside.toPath()); try { - DatapackIngestService.deleteOwnedDirectory(link, "outside"); + DatapackOwnership.deleteOwnedDirectory(link, "outside"); fail("Expected symbolic-link removal to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("symbolic-link")); @@ -465,11 +465,11 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = new DatapackIngestService.Entry(); entry.id = "modified-managed"; entry.url = "https://example.test/modified.zip"; - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); Files.writeString(new File(managed, "user-edit.txt").toPath(), "preserve", StandardCharsets.UTF_8); try { - DatapackIngestService.deleteOwnedDirectory(managed, entry.id); + DatapackOwnership.deleteOwnedDirectory(managed, entry.id); fail("Expected modified managed datapack removal to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("modified or corrupt")); @@ -489,7 +489,7 @@ public class DatapackIngestServiceTest { File staging = new File(new File(root, "staging"), entry.id); writeManagedDatapack(staging, entry); - assertFalse(DatapackIngestService.removeLocked(null, "!!!", root, List.of())); + assertFalse(DatapackRemoval.removeLocked(null, "!!!", root, List.of())); assertTrue(staging.isDirectory()); assertTrue(Files.readString(new File(root, "manifest.json").toPath()).contains("datapack")); } @@ -504,7 +504,7 @@ public class DatapackIngestServiceTest { File staging = new File(new File(root, "staging"), entry.id); writeManagedDatapack(staging, entry); - assertFalse(DatapackIngestService.removeLocked(null, entry.id, root, List.of())); + assertFalse(DatapackRemoval.removeLocked(null, entry.id, root, List.of())); assertTrue(staging.isDirectory()); } @@ -516,7 +516,7 @@ public class DatapackIngestServiceTest { entry.id = "../managed"; try { - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); fail("Expected unsafe ownership id to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("ownership identity")); @@ -539,7 +539,7 @@ public class DatapackIngestServiceTest { File linkedContainer = new File(temporaryFolder.getRoot(), "linked-datapacks-container"); Files.createSymbolicLink(linkedContainer.toPath(), outside.toPath()); - assertFalse(DatapackIngestService.removeLocked(null, entry.id, root, List.of(linkedContainer))); + assertFalse(DatapackRemoval.removeLocked(null, entry.id, root, List.of(linkedContainer))); assertTrue(outsideTarget.isDirectory()); } @@ -563,7 +563,7 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(worldDatapacks); - assertFalse(DatapackIngestService.removeLocked(null, "managed", root, worlds)); + assertFalse(DatapackRemoval.removeLocked(null, "managed", root, worlds)); assertEquals(manifestJson, Files.readString(manifest.toPath(), StandardCharsets.UTF_8)); assertTrue(unmanagedTarget.isDirectory()); } @@ -611,7 +611,7 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(worldDatapacks); - assertFalse(DatapackIngestService.removeLocked(null, entry.id, root, worlds)); + assertFalse(DatapackRemoval.removeLocked(null, entry.id, root, worlds)); assertEquals(manifestJson, Files.readString(manifest.toPath(), StandardCharsets.UTF_8)); assertEquals("alpha", Files.readString(new File(editablePack, "objects/alpha.iob").toPath())); assertEquals("zeta", Files.readString(new File(editablePack, "objects/zeta.iob").toPath())); @@ -653,7 +653,7 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(worldDatapacks); - assertTrue(DatapackIngestService.removeLocked(null, entry.id, root, worlds)); + assertTrue(DatapackRemoval.removeLocked(null, entry.id, root, worlds)); assertFalse(Files.exists(new File(editablePack, "objects/owned.iob").toPath())); assertFalse(Files.exists(writer.ownershipManifestPath(targetKey))); assertFalse(stagingTarget.exists()); @@ -678,7 +678,7 @@ public class DatapackIngestServiceTest { entry.importedBundles.put(targetId, Map.of(targetKey.value(), sourceKey.value())); writeManifest(root, entry); - assertTrue(DatapackIngestService.removeLocked(null, entry.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, entry.id, root, List.of())); assertEquals("ordinary", Files.readString(new File(editablePack, "objects/owned.iob").toPath())); assertTrue(Files.exists(writer.ownershipManifestPath(targetKey))); @@ -691,7 +691,7 @@ public class DatapackIngestServiceTest { entry.id = "legacy-staging"; entry.url = "https://example.test/legacy.zip"; - assertFalse(DatapackIngestService.isUsableStaging(staging, entry)); + assertFalse(DatapackStagingGuard.isUsableStaging(staging, entry)); assertFalse(new File(staging, ".iris-managed.json").exists()); } @@ -703,7 +703,7 @@ public class DatapackIngestServiceTest { File staging = new File(new File(root, "staging"), candidate.id); writeManagedDatapack(staging, candidate); - assertFalse(DatapackIngestService.removeLocked(null, candidate.id, root, List.of())); + assertFalse(DatapackRemoval.removeLocked(null, candidate.id, root, List.of())); assertTrue(staging.isDirectory()); assertFalse(Files.readString(new File(root, "manifest.json").toPath(), StandardCharsets.UTF_8) @@ -718,7 +718,7 @@ public class DatapackIngestServiceTest { File staging = new File(new File(root, "staging"), candidate.id); writeManagedDatapack(staging, candidate); - assertTrue(DatapackIngestService.removeLocked(null, candidate.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, candidate.id, root, List.of())); assertFalse(staging.exists()); assertFalse(Files.readString(new File(root, "manifest.json").toPath(), StandardCharsets.UTF_8) @@ -733,10 +733,10 @@ public class DatapackIngestServiceTest { entry.url = "https://example.test/mutated.zip"; entry.structureKeys = List.of("original:structure"); entry.templateKeys = List.of("original:template"); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); Files.writeString(new File(staging, "unexpected.txt").toPath(), "changed", StandardCharsets.UTF_8); - assertFalse(DatapackIngestService.isUsableStaging(staging, entry)); + assertFalse(DatapackStagingGuard.isUsableStaging(staging, entry)); assertEquals(List.of("original:structure"), entry.structureKeys); assertEquals(List.of("original:template"), entry.templateKeys); } @@ -747,13 +747,13 @@ public class DatapackIngestServiceTest { File nested = new File(staging, "data/example"); assertTrue(nested.mkdirs()); DatapackIngestService.Entry entry = entry("finder-metadata-staging", "v1", "1", "sha"); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File rootMetadata = new File(staging, ".DS_Store"); File nestedMetadata = new File(nested, ".DS_Store"); Files.writeString(rootMetadata.toPath(), "finder", StandardCharsets.UTF_8); Files.writeString(nestedMetadata.toPath(), "finder", StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.isUsableStaging(staging, entry)); + assertTrue(DatapackStagingGuard.isUsableStaging(staging, entry)); assertFalse(rootMetadata.exists()); assertFalse(nestedMetadata.exists()); } @@ -765,7 +765,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("finder-metadata-directory", "v1", "1", "sha"); try { - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); fail("Expected suspicious Finder metadata to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Suspicious Finder metadata")); @@ -782,14 +782,14 @@ public class DatapackIngestServiceTest { assertTrue(nestedMarker.getParentFile().mkdirs()); Files.writeString(nestedMarker.toPath(), "original", StandardCharsets.UTF_8); DatapackIngestService.Entry entry = entry("nested-ownership-resource", "v1", "1", "sha"); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); - assertTrue(DatapackIngestService.isUsableStaging(staging, entry)); + assertTrue(DatapackStagingGuard.isUsableStaging(staging, entry)); Files.writeString(nestedMarker.toPath(), "changed", StandardCharsets.UTF_8); - assertFalse(DatapackIngestService.isUsableStaging(staging, entry)); + assertFalse(DatapackStagingGuard.isUsableStaging(staging, entry)); try { - DatapackIngestService.deleteOwnedDirectory(staging, entry.id); + DatapackOwnership.deleteOwnedDirectory(staging, entry.id); fail("Expected nested managed resource mutation to block deletion"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("modified or corrupt")); @@ -807,8 +807,8 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry compactEntry = entry("compact", "v1", "1", "sha"); DatapackIngestService.Entry expandedEntry = entry("expanded", "v1", "1", "sha"); - DatapackIngestService.writeOwnership(compact, compactEntry); - DatapackIngestService.writeOwnership(expanded, expandedEntry); + DatapackOwnership.writeOwnership(compact, compactEntry); + DatapackOwnership.writeOwnership(expanded, expandedEntry); assertFalse(ownershipHash(compact).equals(ownershipHash(expanded))); } @@ -817,11 +817,11 @@ public class DatapackIngestServiceTest { public void ownershipHashIncludesEmptyDirectories() throws Exception { File managed = datapackDirectory("hash-empty-directory"); DatapackIngestService.Entry entry = entry("managed", "v1", "1", "sha"); - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); assertTrue(new File(managed, "user-directory").mkdir()); try { - DatapackIngestService.deleteOwnedDirectory(managed, entry.id); + DatapackOwnership.deleteOwnedDirectory(managed, entry.id); fail("Expected an added empty directory to invalidate ownership"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("modified or corrupt")); @@ -850,7 +850,7 @@ public class DatapackIngestServiceTest { Files.writeString(data.resolve(".DS_Store"), "ignored nested metadata"); DatapackIngestService.Entry entry = entry("golden", "v1", "1", "sha"); - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); String expected = "aa62ee4ed00f0393e637411686082f253ec65ff788839b12c30fc175e5b501fb"; assertEquals(expected, ownershipHash(managed)); @@ -861,7 +861,7 @@ public class DatapackIngestServiceTest { StandardCharsets.UTF_8); Files.writeString(managed.toPath().resolve(".DS_Store"), "different root metadata"); Files.writeString(data.resolve(".DS_Store"), "different nested metadata"); - DatapackIngestService.writeOwnership(managed, entry); + DatapackOwnership.writeOwnership(managed, entry); assertEquals(expected, ownershipHash(managed)); } @@ -876,7 +876,7 @@ public class DatapackIngestServiceTest { candidate.versionNumber = "2"; candidate.sha1 = "new"; candidate.structureKeys = List.of("candidate:new"); - DatapackIngestService.writeOwnership(staging, candidate); + DatapackOwnership.writeOwnership(staging, candidate); DatapackIngestService.Entry committed = new DatapackIngestService.Entry(); committed.id = candidate.id; @@ -886,7 +886,7 @@ public class DatapackIngestServiceTest { committed.sha1 = "old"; committed.structureKeys = new ArrayList<>(List.of("committed:old")); - assertFalse(DatapackIngestService.isUsableStaging(staging, committed)); + assertFalse(DatapackStagingGuard.isUsableStaging(staging, committed)); assertEquals(List.of("committed:old"), committed.structureKeys); assertTrue(Files.readString(new File(staging, ".iris-managed.json").toPath()).contains("v2")); } @@ -897,13 +897,13 @@ public class DatapackIngestServiceTest { entry.id = "changed-source"; entry.url = "https://example.test/changed.zip"; File staging = datapackDirectory("changed-source"); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); Files.writeString(new File(staging, "late-change.txt").toPath(), "changed", StandardCharsets.UTF_8); KList worlds = new KList<>(); worlds.add(temporaryFolder.newFolder("changed-source-world")); try { - DatapackIngestService.install(staging, worlds, entry, false); + DatapackInstall.install(staging, worlds, entry, false); fail("Expected modified staging to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("committed manifest entry")); @@ -919,7 +919,7 @@ public class DatapackIngestServiceTest { Files.writeString(override.toPath(), "{}", StandardCharsets.UTF_8); try { - DatapackIngestService.stripVanillaStructureOverrides(datapack, ignored -> { + DatapackPackMetadata.stripVanillaStructureOverrides(datapack, ignored -> { }); fail("Expected a retained vanilla structure override to block installation"); } catch (IOException expected) { @@ -938,14 +938,14 @@ public class DatapackIngestServiceTest { File staging = datapackDirectory("source"); Files.writeString(new File(staging, "value.txt").toPath(), "new", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File firstWorld = temporaryFolder.newFolder("first-world-datapacks"); File firstTarget = new File(firstWorld, entry.id); assertTrue(firstTarget.mkdirs()); Files.copy(new File(staging, "pack.mcmeta").toPath(), new File(firstTarget, "pack.mcmeta").toPath()); Files.writeString(new File(firstTarget, "value.txt").toPath(), "old", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(firstTarget, entry); + DatapackOwnership.writeOwnership(firstTarget, entry); File secondWorld = temporaryFolder.newFolder("second-world-datapacks"); File unmanagedTarget = new File(secondWorld, entry.id); @@ -957,7 +957,7 @@ public class DatapackIngestServiceTest { worlds.add(firstWorld); worlds.add(secondWorld); try { - DatapackIngestService.install(staging, worlds, entry, false); + DatapackInstall.install(staging, worlds, entry, false); fail("Expected unmanaged second target to abort the transaction"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("unmanaged datapack")); @@ -971,7 +971,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("exact-managed", "v1", "1", "sha"); File staging = datapackDirectory("exact-managed-source"); Files.writeString(new File(staging, "value.txt").toPath(), "same", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File targetRoot = temporaryFolder.newFolder("exact-managed-target-root"); File worldFolder = new File(targetRoot, "datapacks"); @@ -980,7 +980,7 @@ public class DatapackIngestServiceTest { writeManagedDatapack(target, entry, "same"); File scratch = new File(targetRoot, ".iris-datapack-install"); - DatapackIngestService.InstallPlan plan = DatapackIngestService.prepareInstall( + InstallPlan plan = DatapackInstallPlanner.prepareInstall( staging, worldFolder, entry, @@ -1004,11 +1004,11 @@ public class DatapackIngestServiceTest { Files.setLastModifiedTime(stagedValue, originalTime); try { - DatapackIngestService.verifyInstallExecution(fixture.execution()); + DatapackInstall.verifyInstallExecution(fixture.execution()); fail("Expected changed staging to block the prepared install"); } catch (IOException expected) { assertTrue(expected.getMessage(), expected.getMessage().contains("staging changed")); - DatapackIngestService.rollbackInstallExecutions(List.of(fixture.execution()), expected); + DatapackInstall.rollbackInstallExecutions(List.of(fixture.execution()), expected); assertEquals(0, expected.getSuppressed().length); } @@ -1027,11 +1027,11 @@ public class DatapackIngestServiceTest { Files.setLastModifiedTime(unchangedValue, originalTime); try { - DatapackIngestService.verifyInstallExecution(fixture.execution()); + DatapackInstall.verifyInstallExecution(fixture.execution()); fail("Expected changed unchanged-target snapshot to block the prepared install"); } catch (IOException expected) { assertTrue(expected.getMessage(), expected.getMessage().contains("unchanged datapack target")); - DatapackIngestService.rollbackInstallExecutions(List.of(fixture.execution()), expected); + DatapackInstall.rollbackInstallExecutions(List.of(fixture.execution()), expected); assertEquals(0, expected.getSuppressed().length); } @@ -1044,18 +1044,18 @@ public class DatapackIngestServiceTest { public void verifiedFreshInstallCommitsAfterExtractedDirectoryIsDeleted() throws Exception { PreparedVerifiedFreshInstall fixture = preparedVerifiedFreshInstall( "verified-fresh-deleted-extraction"); - DatapackIngestService.deleteInstallScratch( + DatapackInstall.deleteInstallScratch( fixture.extractedDir(), "verified fresh datapack extraction"); assertFalse(fixture.extractedDir().exists()); - DatapackIngestService.verifyInstallExecution(fixture.execution()); + DatapackInstall.verifyInstallExecution(fixture.execution()); writeManifest(fixture.root(), fixture.entry()); - DatapackIngestService.finishInstallExecution(fixture.execution()); + DatapackInstall.finishInstallExecution(fixture.execution()); for (File target : List.of(fixture.worldTarget(), fixture.canonicalTarget())) { assertEquals("new", Files.readString( new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); - assertTrue(DatapackIngestService.isUsableStaging(target, fixture.entry())); + assertTrue(DatapackStagingGuard.isUsableStaging(target, fixture.entry())); } } @@ -1069,11 +1069,11 @@ public class DatapackIngestServiceTest { Files.setLastModifiedTime(publishedValue, originalTime); try { - DatapackIngestService.verifyInstallExecution(fixture.execution()); + DatapackInstall.verifyInstallExecution(fixture.execution()); fail("Expected changed published target to block the prepared install"); } catch (IOException expected) { assertTrue(expected.getMessage(), expected.getMessage().contains("published datapack target")); - DatapackIngestService.rollbackInstallExecutions(List.of(fixture.execution()), expected); + DatapackInstall.rollbackInstallExecutions(List.of(fixture.execution()), expected); assertEquals(1, expected.getSuppressed().length); } @@ -1089,14 +1089,14 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("changed-managed", "v1", "1", "sha"); File staging = datapackDirectory("changed-managed-source"); Files.writeString(new File(staging, "value.txt").toPath(), "new", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File targetRoot = temporaryFolder.newFolder("changed-managed-target-root"); File worldFolder = new File(targetRoot, "datapacks"); assertTrue(worldFolder.mkdir()); writeManagedDatapack(new File(worldFolder, entry.id), entry, "old"); - DatapackIngestService.InstallPlan plan = DatapackIngestService.prepareInstall( + InstallPlan plan = DatapackInstallPlanner.prepareInstall( staging, worldFolder, entry, @@ -1116,7 +1116,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("changed-ownership", "v2", "2", "new-sha"); File staging = datapackDirectory("changed-ownership-source"); Files.writeString(new File(staging, "value.txt").toPath(), "same", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File targetRoot = temporaryFolder.newFolder("changed-ownership-target-root"); File worldFolder = new File(targetRoot, "datapacks"); @@ -1125,7 +1125,7 @@ public class DatapackIngestServiceTest { File target = new File(worldFolder, entry.id); writeManagedDatapack(target, prior, "same"); - DatapackIngestService.InstallPlan plan = DatapackIngestService.prepareInstall( + InstallPlan plan = DatapackInstallPlanner.prepareInstall( staging, worldFolder, entry, @@ -1144,14 +1144,14 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("strip-managed", "v1", "1", "sha"); File staging = datapackDirectory("strip-managed-source"); Files.writeString(new File(staging, "value.txt").toPath(), "same", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File targetRoot = temporaryFolder.newFolder("strip-managed-target-root"); File worldFolder = new File(targetRoot, "datapacks"); assertTrue(worldFolder.mkdir()); writeManagedDatapack(new File(worldFolder, entry.id), entry, "same"); - DatapackIngestService.InstallPlan plan = DatapackIngestService.prepareInstall( + InstallPlan plan = DatapackInstallPlanner.prepareInstall( staging, worldFolder, entry, @@ -1170,7 +1170,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha"); File staging = datapackDirectory("legacy-ownership-source"); Files.writeString(new File(staging, "value.txt").toPath(), "same", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File world = temporaryFolder.newFolder("legacy-ownership-world"); File target = new File(world, entry.id); assertTrue(target.mkdirs()); @@ -1179,12 +1179,12 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(world); - DatapackIngestService.InstallResult result = - DatapackIngestService.install(staging, worlds, entry, false); + InstallResult result = + DatapackInstall.install(staging, worlds, entry, false); assertFalse(result.changed()); assertTrue(new File(target, ".iris-managed.json").isFile()); - assertTrue(DatapackIngestService.isUsableStaging(target, entry)); + assertTrue(DatapackStagingGuard.isUsableStaging(target, entry)); } @Test @@ -1192,7 +1192,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha"); File staging = datapackDirectory("modified-legacy-source"); Files.writeString(new File(staging, "value.txt").toPath(), "desired", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, entry); + DatapackOwnership.writeOwnership(staging, entry); File world = temporaryFolder.newFolder("modified-legacy-world"); File target = new File(world, entry.id); assertTrue(target.mkdirs()); @@ -1202,7 +1202,7 @@ public class DatapackIngestServiceTest { worlds.add(world); try { - DatapackIngestService.install(staging, worlds, entry, false); + DatapackInstall.install(staging, worlds, entry, false); fail("Expected modified unmanaged datapack adoption to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("unmanaged datapack")); @@ -1217,8 +1217,8 @@ public class DatapackIngestServiceTest { public void verifiedFreshInstallPublishesCanonicalManagedStaging() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("verified-first-install", false, true, false); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); - DatapackIngestService.publishInstallPlan(plan); + InstallPlan plan = prepareLegacyStagingPlan(fixture); + DatapackInstallPlanner.publishInstallPlan(plan); assertEquals("new", Files.readString( new File(fixture.target(), "value.txt").toPath(), StandardCharsets.UTF_8)); @@ -1229,13 +1229,13 @@ public class DatapackIngestServiceTest { public void verifiedLegacyStagingUpgradeReplacesDifferingUnmarkedTree() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("verified-legacy-upgrade", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); - DatapackIngestService.publishInstallPlan(plan); + InstallPlan plan = prepareLegacyStagingPlan(fixture); + DatapackInstallPlanner.publishInstallPlan(plan); assertEquals("new", Files.readString( new File(fixture.target(), "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(new File(fixture.target(), ".DS_Store").exists()); - assertTrue(DatapackIngestService.isUsableStaging(fixture.target(), fixture.desired())); + assertTrue(DatapackStagingGuard.isUsableStaging(fixture.target(), fixture.desired())); assertEquals("old", Files.readString( new File(plan.backup(), "value.txt").toPath(), StandardCharsets.UTF_8)); } @@ -1257,8 +1257,8 @@ public class DatapackIngestServiceTest { Assume.assumeTrue(Files.exists(caseVariantRoot.toPath())); Assume.assumeTrue(Files.isSameFile(root.toPath(), caseVariantRoot.toPath())); - DatapackIngestService.VerifiedStagingInstall authorization = - DatapackIngestService.authorizeVerifiedStagingInstall( + VerifiedStagingInstall authorization = + DatapackStagingGuard.authorizeVerifiedStagingInstall( caseVariantRoot, caseVariantStagingRoot, caseVariantSource, entry); assertTrue(authorization != null); @@ -1288,7 +1288,7 @@ public class DatapackIngestServiceTest { File aliasedSource = new File(aliasedStagingRoot, source.getName()); try { - DatapackIngestService.authorizeVerifiedStagingInstall( + DatapackStagingGuard.authorizeVerifiedStagingInstall( aliasedRoot, aliasedStagingRoot, aliasedSource, entry); fail("Expected symbolic-link staging authority to be rejected"); } catch (IOException expected) { @@ -1301,15 +1301,15 @@ public class DatapackIngestServiceTest { LegacyStagingFixture fixture = legacyStagingFixture( "same-version-legacy-restage", true, true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); - DatapackIngestService.publishInstallPlan(plan); + InstallPlan plan = prepareLegacyStagingPlan(fixture); + DatapackInstallPlanner.publishInstallPlan(plan); assertFalse(plan.contentChanged()); assertTrue(DatapackIngestService.freshInstallRequiresRestart(plan.contentChanged(), true)); assertEquals("same", Files.readString( new File(fixture.target(), "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(new File(fixture.target(), ".DS_Store").exists()); - assertTrue(DatapackIngestService.isUsableStaging(fixture.target(), fixture.desired())); + assertTrue(DatapackStagingGuard.isUsableStaging(fixture.target(), fixture.desired())); } @Test @@ -1365,7 +1365,7 @@ public class DatapackIngestServiceTest { public void validWrongOwnerMarkerCannotMasqueradeAsLegacyStaging() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("wrong-owner-legacy-marker", true, true, true); DatapackIngestService.Entry other = entry("other", "v1", "1", "other-sha"); - DatapackIngestService.writeOwnership(fixture.target(), other); + DatapackOwnership.writeOwnership(fixture.target(), other); assertLegacyStagingPreparationRejected(fixture, "ownership mismatch"); } @@ -1379,7 +1379,7 @@ public class DatapackIngestServiceTest { writeLegacyDatapack(worldTarget, "world"); try { - DatapackIngestService.prepareInstall( + DatapackInstallPlanner.prepareInstall( fixture.source(), world, fixture.desired(), fixture.sourceHash(), false, fixture.authorization()); fail("Expected verified staging authority to reject a world target"); @@ -1397,12 +1397,12 @@ public class DatapackIngestServiceTest { File worldTarget = new File(world, fixture.desired().id); IO.copyDirectory(fixture.target().toPath(), worldTarget.toPath()); - DatapackIngestService.InstallPlan worldPlan = DatapackIngestService.prepareInstall( + InstallPlan worldPlan = DatapackInstallPlanner.prepareInstall( fixture.source(), world, fixture.desired(), fixture.sourceHash(), false, fixture.authorization()); - DatapackIngestService.publishInstallPlan(worldPlan); - DatapackIngestService.InstallPlan stagingPlan = prepareLegacyStagingPlan(fixture); - DatapackIngestService.publishInstallPlan(stagingPlan); + DatapackInstallPlanner.publishInstallPlan(worldPlan); + InstallPlan stagingPlan = prepareLegacyStagingPlan(fixture); + DatapackInstallPlanner.publishInstallPlan(stagingPlan); assertEquals("new", Files.readString( new File(worldTarget, "value.txt").toPath(), StandardCharsets.UTF_8)); @@ -1425,17 +1425,17 @@ public class DatapackIngestServiceTest { worlds.add(firstWorld); worlds.add(secondWorld); - DatapackIngestService.InstallExecution execution = - DatapackIngestService.prepareInstallExecution( + InstallExecution execution = + DatapackInstall.prepareInstallExecution( fixture.source(), worlds, fixture.desired(), false, fixture.root(), fixture.authorization()); - DatapackIngestService.verifyInstallExecution(execution); + DatapackInstall.verifyInstallExecution(execution); writeManifest(fixture.root(), fixture.desired()); - DatapackIngestService.finishInstallExecution(execution); + DatapackInstall.finishInstallExecution(execution); for (File target : List.of(firstTarget, secondTarget, fixture.target())) { assertEquals("new", Files.readString( @@ -1459,7 +1459,7 @@ public class DatapackIngestServiceTest { worlds.add(secondWorld); try { - DatapackIngestService.prepareInstallExecution( + DatapackInstall.prepareInstallExecution( fixture.source(), worlds, fixture.desired(), @@ -1494,8 +1494,8 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(firstWorld); worlds.add(secondWorld); - DatapackIngestService.InstallExecution execution = - DatapackIngestService.prepareInstallExecution( + InstallExecution execution = + DatapackInstall.prepareInstallExecution( fixture.source(), worlds, fixture.desired(), @@ -1504,7 +1504,7 @@ public class DatapackIngestServiceTest { fixture.authorization()); IOException failure = new IOException("manifest publication failed"); - DatapackIngestService.rollbackInstallExecutions(List.of(execution), failure); + DatapackInstall.rollbackInstallExecutions(List.of(execution), failure); assertEquals(0, failure.getSuppressed().length); for (File target : List.of(firstTarget, secondTarget, fixture.target())) { @@ -1521,13 +1521,13 @@ public class DatapackIngestServiceTest { File world = temporaryFolder.newFolder("changed-canonical-world-proof-target"); File worldTarget = new File(world, fixture.desired().id); IO.copyDirectory(fixture.target().toPath(), worldTarget.toPath()); - DatapackIngestService.InstallPlan worldPlan = DatapackIngestService.prepareInstall( + InstallPlan worldPlan = DatapackInstallPlanner.prepareInstall( fixture.source(), world, fixture.desired(), fixture.sourceHash(), false, fixture.authorization()); Files.writeString(new File(fixture.target(), "value.txt").toPath(), "changed", StandardCharsets.UTF_8); try { - DatapackIngestService.publishInstallPlan(worldPlan); + DatapackInstallPlanner.publishInstallPlan(worldPlan); fail("Expected changed canonical legacy staging to block world migration"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("canonical legacy datapack staging target")); @@ -1543,7 +1543,7 @@ public class DatapackIngestServiceTest { File world = temporaryFolder.newFolder("swapped-canonical-world-proof-target"); File worldTarget = new File(world, fixture.desired().id); IO.copyDirectory(fixture.target().toPath(), worldTarget.toPath()); - DatapackIngestService.InstallPlan worldPlan = DatapackIngestService.prepareInstall( + InstallPlan worldPlan = DatapackInstallPlanner.prepareInstall( fixture.source(), world, fixture.desired(), fixture.sourceHash(), false, fixture.authorization()); File displaced = new File(fixture.stagingRoot(), "displaced-managed"); @@ -1551,7 +1551,7 @@ public class DatapackIngestServiceTest { IO.copyDirectory(displaced.toPath(), fixture.target().toPath()); try { - DatapackIngestService.publishInstallPlan(worldPlan); + DatapackInstallPlanner.publishInstallPlan(worldPlan); fail("Expected swapped canonical legacy staging to block world migration"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("identity changed")); @@ -1575,14 +1575,14 @@ public class DatapackIngestServiceTest { File world = temporaryFolder.newFolder("changed-world-manifest-metadata-target"); File worldTarget = new File(world, fixture.desired().id); IO.copyDirectory(fixture.target().toPath(), worldTarget.toPath()); - DatapackIngestService.InstallPlan worldPlan = DatapackIngestService.prepareInstall( + InstallPlan worldPlan = DatapackInstallPlanner.prepareInstall( fixture.source(), world, fixture.desired(), fixture.sourceHash(), false, fixture.authorization()); DatapackIngestService.Entry changed = entry("managed", "other-version", "other", "other-sha"); writeManifest(fixture.root(), changed); try { - DatapackIngestService.publishInstallPlan(worldPlan); + DatapackInstallPlanner.publishInstallPlan(worldPlan); fail("Expected changed manifest metadata to block world migration"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("authority changed")); @@ -1606,14 +1606,14 @@ public class DatapackIngestServiceTest { public void duplicateWorldParticipantsAreRejectedBeforePublication() throws Exception { DatapackIngestService.Entry entry = entry("duplicate-world", "v1", "1", "sha"); File source = datapackDirectory("duplicate-world-source"); - DatapackIngestService.writeOwnership(source, entry); + DatapackOwnership.writeOwnership(source, entry); File world = temporaryFolder.newFolder("duplicate-world-target"); KList worlds = new KList<>(); worlds.add(world); worlds.add(world); try { - DatapackIngestService.install(source, worlds, entry, false); + DatapackInstall.install(source, worlds, entry, false); fail("Expected duplicate world install participants to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Duplicate datapack install target")); @@ -1625,7 +1625,7 @@ public class DatapackIngestServiceTest { public void symbolicLinkWorldParticipantIsRejectedBeforePublication() throws Exception { DatapackIngestService.Entry entry = entry("aliased-world", "v1", "1", "sha"); File source = datapackDirectory("aliased-world-source"); - DatapackIngestService.writeOwnership(source, entry); + DatapackOwnership.writeOwnership(source, entry); File world = temporaryFolder.newFolder("aliased-world-target"); Path alias = new File(temporaryFolder.getRoot(), "aliased-world-link").toPath(); try { @@ -1638,7 +1638,7 @@ public class DatapackIngestServiceTest { worlds.add(alias.toFile()); try { - DatapackIngestService.install(source, worlds, entry, false); + DatapackInstall.install(source, worlds, entry, false); fail("Expected symbolic-link world participant to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Invalid datapack install root")); @@ -1650,7 +1650,7 @@ public class DatapackIngestServiceTest { public void worldParticipantAliasThroughASymbolicParentIsRejected() throws Exception { DatapackIngestService.Entry entry = entry("parent-aliased-world", "v1", "1", "sha"); File source = datapackDirectory("parent-aliased-world-source"); - DatapackIngestService.writeOwnership(source, entry); + DatapackOwnership.writeOwnership(source, entry); File realParent = temporaryFolder.newFolder("parent-aliased-world-root"); File realWorld = new File(realParent, "datapacks"); assertTrue(realWorld.mkdir()); @@ -1666,7 +1666,7 @@ public class DatapackIngestServiceTest { worlds.add(aliasedWorld); try { - DatapackIngestService.install(source, worlds, entry, false); + DatapackInstall.install(source, worlds, entry, false); fail("Expected real-path world participant alias to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Duplicate datapack install target")); @@ -1677,7 +1677,7 @@ public class DatapackIngestServiceTest { @Test public void changedLegacyTargetIsRejectedImmediatelyBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("changed-target-publication", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Files.writeString(new File(plan.target(), "value.txt").toPath(), "changed", StandardCharsets.UTF_8); assertInstallPublicationRejected(plan, "content changed"); @@ -1688,7 +1688,7 @@ public class DatapackIngestServiceTest { @Test public void changedLegacyMarkerIsRejectedImmediatelyBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("changed-marker-publication", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Files.writeString(new File(plan.target(), ".iris-managed.json").toPath(), "{}", StandardCharsets.UTF_8); assertInstallPublicationRejected(plan, "content changed"); @@ -1698,7 +1698,7 @@ public class DatapackIngestServiceTest { @Test public void byteIdenticalLegacyTargetSwapIsRejectedBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("swapped-target-publication", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); File displaced = new File(fixture.stagingRoot(), "displaced-target"); Files.move(plan.target().toPath(), displaced.toPath()); writeLegacyDatapack(plan.target(), "old"); @@ -1710,7 +1710,7 @@ public class DatapackIngestServiceTest { @Test public void changedPreparedContentIsRejectedBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("changed-pending-publication", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Files.writeString(new File(plan.pending(), "value.txt").toPath(), "changed", StandardCharsets.UTF_8); assertInstallPublicationRejected(plan, "content changed"); @@ -1721,7 +1721,7 @@ public class DatapackIngestServiceTest { @Test public void changedPreparedMarkerIsRejectedBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("changed-pending-marker", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Files.writeString(new File(plan.pending(), ".iris-managed.json").toPath(), "{}", StandardCharsets.UTF_8); assertInstallPublicationRejected(plan, "content changed"); @@ -1732,7 +1732,7 @@ public class DatapackIngestServiceTest { @Test public void swappedTargetRootIsRejectedBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("swapped-target-root", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Path displaced = new File(fixture.root(), "displaced-target-root").toPath(); Files.move(fixture.stagingRoot().toPath(), displaced); assertTrue(fixture.stagingRoot().mkdir()); @@ -1745,7 +1745,7 @@ public class DatapackIngestServiceTest { @Test public void swappedInstallScratchRootIsRejectedBeforePublication() throws Exception { LegacyStagingFixture fixture = legacyStagingFixture("swapped-install-scratch", true, true, true); - DatapackIngestService.InstallPlan plan = prepareLegacyStagingPlan(fixture); + InstallPlan plan = prepareLegacyStagingPlan(fixture); Path displaced = new File(fixture.root(), "displaced-install-scratch").toPath(); Files.move(plan.pendingRoot().toPath(), displaced); assertTrue(plan.pendingRoot().mkdir()); @@ -1770,7 +1770,7 @@ public class DatapackIngestServiceTest { "data/nova_structures/worldgen/structure_set/illager_barracks.json").toPath(); Files.createDirectories(set.getParent()); Files.writeString(set, "{}", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(installed, entry); + DatapackOwnership.writeOwnership(installed, entry); DatapackIngestService.StructureScopeResources resources = DatapackIngestService.scanInstalledStructureScope(installed, entry); @@ -1789,7 +1789,7 @@ public class DatapackIngestServiceTest { Files.createDirectories(retained.getParent()); Files.writeString(retained, "{}", StandardCharsets.UTF_8); Files.writeString(new File(installed, ".iris-overrides-stripped").toPath(), "", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(installed, entry); + DatapackOwnership.writeOwnership(installed, entry); DatapackIngestService.StructureScopeResources resources = DatapackIngestService.scanInstalledStructureScope(installed, entry); @@ -1810,7 +1810,7 @@ public class DatapackIngestServiceTest { File staging = datapackDirectory("metadata-source"); Files.writeString(new File(staging, "value.txt").toPath(), "same", StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(staging, current); + DatapackOwnership.writeOwnership(staging, current); File world = temporaryFolder.newFolder("metadata-world-datapacks"); File target = new File(world, current.id); @@ -1823,11 +1823,11 @@ public class DatapackIngestServiceTest { old.versionId = "v1"; old.versionNumber = "1"; old.sha1 = "old-hash"; - DatapackIngestService.writeOwnership(target, old); + DatapackOwnership.writeOwnership(target, old); KList worlds = new KList<>(); worlds.add(world); - DatapackIngestService.InstallResult result = DatapackIngestService.install(staging, worlds, current, false); + InstallResult result = DatapackInstall.install(staging, worlds, current, false); String marker = Files.readString(new File(target, ".iris-managed.json").toPath(), StandardCharsets.UTF_8); assertFalse(result.changed()); @@ -1842,7 +1842,7 @@ public class DatapackIngestServiceTest { entry.structureKeys = List.of("nova_structures:tavern/oak"); entry.templateKeys = List.of("nova_structures:building/house"); - Map inventory = DatapackIngestService.importBundleInventory(entry); + Map inventory = DatapackStructureImports.importBundleInventory(entry); assertEquals("nova_structures:tavern/oak", inventory.get("iris:nova_structures_tavern_oak")); assertEquals("nova_structures:building/house", inventory.get("iris:nova_structures/building/house")); @@ -1860,7 +1860,7 @@ public class DatapackIngestServiceTest { )); entry.structuresImported = true; - DatapackIngestService.prepareImportRecoveryInventory(entry, "pack"); + DatapackStructureImports.prepareImportRecoveryInventory(entry, "pack"); assertEquals(Map.of( "iris:test_castle", "old:castle", @@ -1876,9 +1876,9 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); entry.importedBundles.put("pack", Map.of("iris:test_castle", "test:castle")); - DatapackIngestService.recordDeterministicImportAttempt(entry, "pack"); + DatapackStructureImports.recordDeterministicImportAttempt(entry, "pack"); - assertFalse(DatapackIngestService.importPending(entry, "pack")); + assertFalse(DatapackStructureImports.importPending(entry, "pack")); assertEquals(Map.of("iris:test_castle", "test:castle"), entry.importedBundles.get("pack")); assertFalse(entry.importedTargets.containsKey("pack")); } @@ -1886,57 +1886,57 @@ public class DatapackIngestServiceTest { @Test public void changedSourceRevisionRetriesDeterministicImportAttempt() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - DatapackIngestService.recordDeterministicImportAttempt(entry, "pack"); + DatapackStructureImports.recordDeterministicImportAttempt(entry, "pack"); entry.sha1 = "sha-three"; - assertTrue(DatapackIngestService.importPending(entry, "pack")); + assertTrue(DatapackStructureImports.importPending(entry, "pack")); } @Test public void changedImporterFormatRetriesDeterministicImportAttempt() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - entry.importAttempts.put("pack", DatapackIngestService.importRevision(entry, 1)); + entry.importAttempts.put("pack", DatapackStructureImports.importRevision(entry, 1)); - assertTrue(DatapackIngestService.importPending(entry, "pack")); + assertTrue(DatapackStructureImports.importPending(entry, "pack")); } @Test public void provenanceImportFormatRetriesVersionTwoEditableImports() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - entry.importedTargets.put("pack", DatapackIngestService.importRevision(entry, 2)); + entry.importedTargets.put("pack", DatapackStructureImports.importRevision(entry, 2)); - assertTrue(DatapackIngestService.importPending(entry, "pack")); + assertTrue(DatapackStructureImports.importPending(entry, "pack")); } @Test public void newTargetRetriesDeterministicImportAttempt() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - DatapackIngestService.recordDeterministicImportAttempt(entry, "pack-one"); + DatapackStructureImports.recordDeterministicImportAttempt(entry, "pack-one"); - assertTrue(DatapackIngestService.importPending(entry, "pack-two")); + assertTrue(DatapackStructureImports.importPending(entry, "pack-two")); } @Test public void retryableImportPreparationClearsPriorAttempt() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - DatapackIngestService.recordDeterministicImportAttempt(entry, "pack"); + DatapackStructureImports.recordDeterministicImportAttempt(entry, "pack"); - DatapackIngestService.prepareImportRecoveryInventory(entry, "pack"); + DatapackStructureImports.prepareImportRecoveryInventory(entry, "pack"); - assertTrue(DatapackIngestService.importPending(entry, "pack")); + assertTrue(DatapackStructureImports.importPending(entry, "pack")); assertFalse(entry.importAttempts.containsKey("pack")); } @Test public void successfulImportReplacesDeterministicAttempt() { DatapackIngestService.Entry entry = entry("managed", "v2", "2", "sha-two"); - DatapackIngestService.recordDeterministicImportAttempt(entry, "pack"); + DatapackStructureImports.recordDeterministicImportAttempt(entry, "pack"); - DatapackIngestService.recordSuccessfulImport(entry, "pack"); + DatapackStructureImports.recordSuccessfulImport(entry, "pack"); - assertFalse(DatapackIngestService.importPending(entry, "pack")); - assertEquals(DatapackIngestService.importRevision(entry), entry.importedTargets.get("pack")); + assertFalse(DatapackStructureImports.importPending(entry, "pack")); + assertEquals(DatapackStructureImports.importRevision(entry), entry.importedTargets.get("pack")); assertFalse(entry.importAttempts.containsKey("pack")); } @@ -1964,7 +1964,7 @@ public class DatapackIngestServiceTest { new Gson().toJson(Map.of("entries", List.of(removed, retained))), StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.removeLocked(null, removed.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, removed.id, root, List.of())); assertEquals("owned", Files.readString(new File(editablePack, "objects/owned.iob").toPath())); assertTrue(Files.exists(writer.ownershipManifestPath(targetKey))); @@ -2000,7 +2000,7 @@ public class DatapackIngestServiceTest { new Gson().toJson(Map.of("entries", List.of(removed, retained))), StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.removeLocked(null, removed.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, removed.id, root, List.of())); assertEquals("current", Files.readString(new File(editablePack, "objects/foo_a_b.iob").toPath())); JsonObject retainedJson = JsonParser.parseString(Files.readString( @@ -2048,7 +2048,7 @@ public class DatapackIngestServiceTest { IrisData data = mock(IrisData.class); when(data.getDataFolder()).thenReturn(editablePack); - boolean cleaned = DatapackIngestService.cleanupRemovedImports( + boolean cleaned = DatapackStructureImports.cleanupRemovedImports( data, targetId, Set.of(retained.url), @@ -2086,7 +2086,7 @@ public class DatapackIngestServiceTest { new Gson().toJson(Map.of("entries", List.of(removed, unrelated))), StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.removeLocked(null, removed.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, removed.id, root, List.of())); assertFalse(Files.exists(new File(editablePack, "objects/foo_a_b.iob").toPath())); assertFalse(Files.exists(writer.ownershipManifestPath(targetKey))); @@ -2118,7 +2118,7 @@ public class DatapackIngestServiceTest { new Gson().toJson(Map.of("entries", List.of(removed, retained))), StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.removeLocked(null, removed.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, removed.id, root, List.of())); assertEquals("other", Files.readString(new File(editablePack, "objects/owned.iob").toPath())); assertTrue(Files.exists(writer.ownershipManifestPath(targetKey))); @@ -2145,7 +2145,7 @@ public class DatapackIngestServiceTest { new Gson().toJson(Map.of("entries", List.of(removed, retained))), StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.removeLocked(null, removed.id, root, List.of())); + assertTrue(DatapackRemoval.removeLocked(null, removed.id, root, List.of())); assertFalse(missing.exists()); JsonObject retainedJson = JsonParser.parseString(Files.readString( @@ -2164,7 +2164,7 @@ public class DatapackIngestServiceTest { committed.importAttempts.put("pack", "old-attempt"); committed.importedBundles.put("pack", new HashMap<>(Map.of("iris:old", "test:old"))); - DatapackIngestService.Entry candidate = DatapackIngestService.copyEntry(committed); + DatapackIngestService.Entry candidate = DatapackManifestStore.copyEntry(committed); candidate.versionId = "v2"; candidate.structureKeys.add("test:new"); candidate.importedTargets.put("pack", "new"); @@ -2201,7 +2201,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHING", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); assertEquals("old", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(backup.exists()); @@ -2231,7 +2231,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHED", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); assertEquals("new", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(backup.exists()); @@ -2254,7 +2254,7 @@ public class DatapackIngestServiceTest { File backup = new File(scratch, "managed-backup-finder"); writeManagedDatapack(pending, entry, "new"); assertTrue(new File(pending, "data/nova_structures").mkdirs()); - DatapackIngestService.writeOwnership(pending, entry); + DatapackOwnership.writeOwnership(pending, entry); String desiredHash = ownershipHash(pending); Files.move(target.toPath(), backup.toPath()); Files.move(pending.toPath(), target.toPath()); @@ -2267,7 +2267,7 @@ public class DatapackIngestServiceTest { Files.writeString(new File(target, "data/nova_structures/.DS_Store").toPath(), "finder", StandardCharsets.UTF_8); - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); assertEquals("old", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(new File(target, ".DS_Store").exists()); @@ -2300,7 +2300,7 @@ public class DatapackIngestServiceTest { Files.writeString(new File(target, "value.txt").toPath(), "changed", StandardCharsets.UTF_8); try { - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); fail("Expected authored datapack mutation to block recovery"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("content changed")); @@ -2337,7 +2337,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHING", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("old", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(backup.exists()); @@ -2369,7 +2369,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHED", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("new", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(backup.exists()); @@ -2386,7 +2386,7 @@ public class DatapackIngestServiceTest { assertTrue(staging.mkdirs()); File target = new File(staging, desired.id); writeLegacyDatapack(target, "old"); - DatapackIngestService.writeOwnership(target, original); + DatapackOwnership.writeOwnership(target, original); String originalHash = ownershipHash(target); assertTrue(new File(target, ".iris-managed.json").delete()); File scratch = new File(root, ".iris-datapack-install"); @@ -2402,7 +2402,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHING", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("old", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertTrue(new File(target, ".DS_Store").isFile()); @@ -2421,7 +2421,7 @@ public class DatapackIngestServiceTest { assertTrue(staging.mkdirs()); File target = new File(staging, desired.id); writeLegacyDatapack(target, "old"); - DatapackIngestService.writeOwnership(target, original); + DatapackOwnership.writeOwnership(target, original); String originalHash = ownershipHash(target); assertTrue(new File(target, ".iris-managed.json").delete()); File scratch = new File(root, ".iris-datapack-install"); @@ -2437,7 +2437,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "INSTALL", "PUBLISHED", desired, false, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("new", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertTrue(new File(target, ".iris-managed.json").isFile()); @@ -2454,7 +2454,7 @@ public class DatapackIngestServiceTest { assertTrue(pending.mkdirs()); Files.writeString(new File(pending, "partial.dat").toPath(), "partial", StandardCharsets.UTF_8); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertFalse(pending.exists()); assertFalse(scratch.exists()); @@ -2471,7 +2471,7 @@ public class DatapackIngestServiceTest { File metadata = new File(scratch, ".DS_Store"); Files.writeString(metadata.toPath(), "finder", StandardCharsets.UTF_8); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertFalse(metadata.exists()); assertFalse(pending.exists()); @@ -2486,7 +2486,7 @@ public class DatapackIngestServiceTest { assertTrue(scratch.mkdir()); Files.writeString(new File(scratch, ".DS_Store").toPath(), "finder", StandardCharsets.UTF_8); - DatapackIngestService.deleteInstallScratch(scratch, "test datapack install scratch"); + DatapackInstall.deleteInstallScratch(scratch, "test datapack install scratch"); assertFalse(scratch.exists()); assertEquals(2, scratch.deleteAttempts()); @@ -2500,7 +2500,7 @@ public class DatapackIngestServiceTest { assertTrue(scratch.mkdir()); try { - DatapackIngestService.deleteInstallScratch(scratch, "test datapack install scratch"); + DatapackInstall.deleteInstallScratch(scratch, "test datapack install scratch"); fail("Expected persistent scratch deletion failure"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Could not remove test datapack install scratch")); @@ -2519,7 +2519,7 @@ public class DatapackIngestServiceTest { assertTrue(metadata.mkdirs()); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected suspicious Finder metadata to block recovery"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Suspicious datapack recovery artifact")); @@ -2537,7 +2537,7 @@ public class DatapackIngestServiceTest { Files.writeString(new File(backup, "prior.dat").toPath(), "prior", StandardCharsets.UTF_8); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected an unjournaled backup to block recovery"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("unjournaled datapack install backup")); @@ -2555,7 +2555,7 @@ public class DatapackIngestServiceTest { File evidence = new File(backup, "prior.dat"); Files.writeString(evidence.toPath(), "prior", StandardCharsets.UTF_8); - assertFalse(DatapackIngestService.recoverBeforeReapply(root, List.of())); + assertFalse(DatapackStagingReapply.recoverBeforeReapply(root, List.of())); assertEquals("prior", Files.readString(evidence.toPath(), StandardCharsets.UTF_8)); assertTrue(backup.isDirectory()); @@ -2580,7 +2580,7 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(world); - assertFalse(DatapackIngestService.reapplyStagedDirectories( + assertFalse(DatapackStagingReapply.reapplyStagedDirectories( root, stagingRoot, worlds, false)); assertEquals("preserve", Files.readString(userFile.toPath(), StandardCharsets.UTF_8)); @@ -2604,7 +2604,7 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(world); - assertFalse(DatapackIngestService.reapplyStagedDirectories( + assertFalse(DatapackStagingReapply.reapplyStagedDirectories( root, stagingRoot, worlds, false)); assertFalse(new File(world, entry.id).exists()); @@ -2628,7 +2628,7 @@ public class DatapackIngestServiceTest { worlds.add(absentWorld); worlds.add(staleWorld); - assertFalse(DatapackIngestService.reapplyStagedDirectories( + assertFalse(DatapackStagingReapply.reapplyStagedDirectories( root, stagingRoot, worlds, false)); assertFalse(new File(absentWorld, entry.id).exists()); @@ -2645,7 +2645,7 @@ public class DatapackIngestServiceTest { File stagingRoot = new File(root, "staging"); DatapackIngestService.ReapplyOutcome outcome = - DatapackIngestService.reapplyStagingRootOutcome( + DatapackStagingReapply.reapplyStagingRootOutcome( root, stagingRoot, new KList<>(), @@ -2662,7 +2662,7 @@ public class DatapackIngestServiceTest { writeManifest(root, null); File stagingRoot = new File(root, "staging"); - assertTrue(DatapackIngestService.reapplyStagingRoot( + assertTrue(DatapackStagingReapply.reapplyStagingRoot( root, stagingRoot, new KList<>(), false)); } @@ -2672,7 +2672,7 @@ public class DatapackIngestServiceTest { writeManifest(root, null); File regularFile = new File(root, "staging-file"); Files.writeString(regularFile.toPath(), "unsafe", StandardCharsets.UTF_8); - assertFalse(DatapackIngestService.reapplyStagingRoot( + assertFalse(DatapackStagingReapply.reapplyStagingRoot( root, regularFile, new KList<>(), false)); File linkTarget = temporaryFolder.newFolder("unsafe-staging-link-target"); @@ -2682,7 +2682,7 @@ public class DatapackIngestServiceTest { } catch (IOException | UnsupportedOperationException unavailable) { Assume.assumeNoException(unavailable); } - assertFalse(DatapackIngestService.reapplyStagingRoot( + assertFalse(DatapackStagingReapply.reapplyStagingRoot( root, symbolicLink.toFile(), new KList<>(), false)); } @@ -2703,7 +2703,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "REMOVE", "PUBLISHING", entry, true, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); assertEquals("owned", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); assertFalse(backup.exists()); @@ -2727,7 +2727,7 @@ public class DatapackIngestServiceTest { File transaction = writeCoordinator(root, "REMOVE", "PUBLISHED", entry, true, List.of(directory), List.of()); - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); assertFalse(target.exists()); assertFalse(backup.exists()); @@ -2743,7 +2743,7 @@ public class DatapackIngestServiceTest { List.of(), List.of()); Files.writeString(new File(transaction, "journal.next.json").toPath(), "{torn", StandardCharsets.UTF_8); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertFalse(transaction.exists()); } @@ -2755,7 +2755,7 @@ public class DatapackIngestServiceTest { assertTrue(transactionRoot.mkdirs()); Files.writeString(new File(transactionRoot, "journal.next.json").toPath(), "{torn", StandardCharsets.UTF_8); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertFalse(transactionRoot.exists()); } @@ -2777,7 +2777,7 @@ public class DatapackIngestServiceTest { List.of(), List.of(editable)); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected an arbitrary editable pack root to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("editable pack root")); @@ -2813,7 +2813,7 @@ public class DatapackIngestServiceTest { } try { - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); fail("Expected a replaced scratch root to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("scratch root")); @@ -2858,7 +2858,7 @@ public class DatapackIngestServiceTest { List.of(directory), List.of()); try { - DatapackIngestService.recoverTransactions(root, List.of(world)); + DatapackScratchRecovery.recoverTransactions(root, List.of(world)); fail("Expected malformed " + field + " path to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("path")); @@ -2885,7 +2885,7 @@ public class DatapackIngestServiceTest { List.of(), List.of(editable)); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected malformed editable pack root to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("editable pack root path")); @@ -2933,7 +2933,7 @@ public class DatapackIngestServiceTest { assertFalse(genericRecovery.successful()); assertFalse(Files.exists(new File(editablePack, "objects/owned.iob").toPath())); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("owned", Files.readString(new File(editablePack, "objects/owned.iob").toPath(), StandardCharsets.UTF_8)); assertFalse(transaction.exists()); @@ -2974,7 +2974,7 @@ public class DatapackIngestServiceTest { transaction.toPath(), coordinatorId, claimId)); removal.leaveForRecovery(); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); StructureRecoveryResult genericRecovery = new StructureTransactionWriter(editablePack.toPath()) .recoverIncompleteTransactions(); @@ -2995,7 +2995,7 @@ public class DatapackIngestServiceTest { true ); - DatapackIngestService.recoverTransactions(fixture.root(), List.of()); + DatapackScratchRecovery.recoverTransactions(fixture.root(), List.of()); assertFalse(fixture.coordinator().exists()); assertFalse(Files.exists(new File(fixture.editablePack(), "objects/owned.iob").toPath())); @@ -3089,7 +3089,7 @@ public class DatapackIngestServiceTest { } try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected excessive transaction count to be rejected"); } catch (Exception expected) { assertTrue(expected.getMessage().contains("transaction count")); @@ -3105,7 +3105,7 @@ public class DatapackIngestServiceTest { File metadata = new File(transactions, ".DS_Store"); Files.writeString(metadata.toPath(), "finder", StandardCharsets.UTF_8); - assertTrue(DatapackIngestService.recoverTransactions(root, List.of())); + assertTrue(DatapackScratchRecovery.recoverTransactions(root, List.of())); assertFalse(metadata.exists()); } @@ -3114,7 +3114,7 @@ public class DatapackIngestServiceTest { public void recoveryReportsUnchangedWhenNoRecoveryArtifactsExist() throws Exception { File root = temporaryFolder.newFolder("unchanged-recovery-root"); - assertFalse(DatapackIngestService.recoverTransactions(root, List.of())); + assertFalse(DatapackScratchRecovery.recoverTransactions(root, List.of())); } @Test @@ -3129,7 +3129,7 @@ public class DatapackIngestServiceTest { File lookalike = new File(staging, ".pending-managed-not-a-uuid"); assertTrue(lookalike.mkdirs()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertFalse(pending.exists()); assertTrue(lookalike.isDirectory()); @@ -3149,7 +3149,7 @@ public class DatapackIngestServiceTest { } try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected symbolic-link staging scratch to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("staging scratch artifact")); @@ -3172,7 +3172,7 @@ public class DatapackIngestServiceTest { try (ServerSocketChannel channel = ServerSocketChannel.open(StandardProtocolFamily.UNIX)) { channel.bind(UnixDomainSocketAddress.of(socket)); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected special staging scratch file to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("unsupported file")); @@ -3200,7 +3200,7 @@ public class DatapackIngestServiceTest { File backup = new File(staging, ".backup-managed-" + UUID.randomUUID()); Files.move(target.toPath(), backup.toPath()); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("old", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); @@ -3218,7 +3218,7 @@ public class DatapackIngestServiceTest { writeManagedDatapack(target, entry, "new"); writeManagedDatapack(backup, entry, "old"); - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); assertEquals("new", Files.readString(new File(target, "value.txt").toPath(), StandardCharsets.UTF_8)); @@ -3237,7 +3237,7 @@ public class DatapackIngestServiceTest { writeManagedDatapack(second, entry, "second"); try { - DatapackIngestService.recoverTransactions(root, List.of()); + DatapackScratchRecovery.recoverTransactions(root, List.of()); fail("Expected ambiguous staging backups to be preserved"); } catch (IOException expected) { assertTrue(expected.getMessage().contains("Ambiguous")); @@ -3251,7 +3251,7 @@ public class DatapackIngestServiceTest { public void reapplyRecordsStagingAndInstallMetadataForTheNextPass() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-record"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); assertTrue(new File(fixture.target(), ".iris-managed.json").isFile()); @@ -3264,31 +3264,31 @@ public class DatapackIngestServiceTest { @Test public void successfulUnchangedIngestKeepsStartupFingerprintStableAcrossNextReapply() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-ingest-cache"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); DatapackIngestService.Entry entry = new Gson().fromJson( manifestEntry(fixture.root()), DatapackIngestService.Entry.class); DatapackIngestService.Report report = new DatapackIngestService.Report(); - DatapackIngestService.recordInstallResult( + DatapackStagingGuard.recordInstallResult( null, report, fixture.staging(), fixture.worlds(), entry, - new DatapackIngestService.InstallResult(false), + new InstallResult(false), entry.versionNumber ); writePrettyManifest(fixture.root(), entry); - String cachedFingerprint = DatapackIngestService.startupValidationFingerprint( + String cachedFingerprint = DatapackStartupValidation.startupValidationFingerprint( fixture.root(), fixture.worlds()); assertFalse(entry.stagingMetadata.isBlank()); assertEquals(1, entry.installMetadata.size()); assertEquals(1, report.getUpToDate().size()); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); - assertEquals(cachedFingerprint, DatapackIngestService.startupValidationFingerprint( + assertEquals(cachedFingerprint, DatapackStartupValidation.startupValidationFingerprint( fixture.root(), fixture.worlds())); } @@ -3297,13 +3297,13 @@ public class DatapackIngestServiceTest { ReapplyFixture fixture = reapplyFixture("reapply-outcome"); DatapackIngestService.ReapplyOutcome repaired = - DatapackIngestService.reapplyStagingRootOutcome( + DatapackStagingReapply.reapplyStagingRootOutcome( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false); DatapackIngestService.ReapplyOutcome unchanged = - DatapackIngestService.reapplyStagingRootOutcome( + DatapackStagingReapply.reapplyStagingRootOutcome( fixture.root(), fixture.stagingRoot(), fixture.worlds(), @@ -3320,7 +3320,7 @@ public class DatapackIngestServiceTest { @Test public void unchangedStagingAndTargetSkipContentHashingOnReapply() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-shortcircuit"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); Path staged = fixture.staging().toPath().resolve("value.txt"); @@ -3328,7 +3328,7 @@ public class DatapackIngestServiceTest { Files.writeString(staged, "wxyz", StandardCharsets.UTF_8); Files.setLastModifiedTime(staged, stamp); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); assertEquals("abcd", Files.readString( @@ -3338,7 +3338,7 @@ public class DatapackIngestServiceTest { @Test public void changedStagingMetadataForcesFullReapplyVerification() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-staging-change"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); Path staged = fixture.staging().toPath().resolve("value.txt"); @@ -3346,14 +3346,14 @@ public class DatapackIngestServiceTest { Files.writeString(staged, "wxyz", StandardCharsets.UTF_8); Files.setLastModifiedTime(staged, FileTime.fromMillis(stamp.toMillis() + 5000L)); - assertFalse(DatapackIngestService.reapplyStagedDirectories( + assertFalse(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); } @Test public void changedInstallTargetIsRepairedDespiteRecordedMetadata() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-target-change"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); Path installed = fixture.target().toPath().resolve("value.txt"); @@ -3361,7 +3361,7 @@ public class DatapackIngestServiceTest { Files.setLastModifiedTime(installed, FileTime.fromMillis( Files.getLastModifiedTime(installed).toMillis() + 5000L)); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); assertEquals("abcd", Files.readString(installed, StandardCharsets.UTF_8)); @@ -3370,11 +3370,11 @@ public class DatapackIngestServiceTest { @Test public void flippedOverrideStrippingForcesFullReapplyVerification() throws Exception { ReapplyFixture fixture = reapplyFixture("reapply-strip-change"); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), false)); assertFalse(new File(fixture.target(), ".iris-overrides-stripped").exists()); - assertTrue(DatapackIngestService.reapplyStagedDirectories( + assertTrue(DatapackStagingReapply.reapplyStagedDirectories( fixture.root(), fixture.stagingRoot(), fixture.worlds(), true)); assertTrue(new File(fixture.target(), ".iris-overrides-stripped").isFile()); @@ -3415,8 +3415,8 @@ public class DatapackIngestServiceTest { KList worlds = new KList<>(); worlds.add(unchangedWorld); worlds.add(changedWorld); - DatapackIngestService.InstallExecution execution = - DatapackIngestService.prepareInstallExecution(staging, worlds, entry, false, root); + InstallExecution execution = + DatapackInstall.prepareInstallExecution(staging, worlds, entry, false, root); assertTrue(execution.result().changed()); assertEquals("new", Files.readString( @@ -3429,8 +3429,8 @@ public class DatapackIngestServiceTest { File world = temporaryFolder.newFolder(name + "-world"); KList worlds = new KList<>(); worlds.add(world); - DatapackIngestService.InstallExecution execution = - DatapackIngestService.prepareInstallExecution( + InstallExecution execution = + DatapackInstall.prepareInstallExecution( fixture.source(), worlds, fixture.desired(), @@ -3473,7 +3473,7 @@ public class DatapackIngestServiceTest { File staging, File unchangedTarget, File changedTarget, - DatapackIngestService.InstallExecution execution + InstallExecution execution ) { } @@ -3483,7 +3483,7 @@ public class DatapackIngestServiceTest { DatapackIngestService.Entry entry, File canonicalTarget, File worldTarget, - DatapackIngestService.InstallExecution execution + InstallExecution execution ) { } @@ -3524,8 +3524,8 @@ public class DatapackIngestServiceTest { } File source = new File(stagingRoot, ".pending-" + desired.id + "-" + UUID.randomUUID()); writeManagedDatapack(source, desired, sameMetadata ? "same" : "new"); - DatapackIngestService.VerifiedStagingInstall authorization = - DatapackIngestService.authorizeVerifiedStagingInstall(root, stagingRoot, source, desired); + VerifiedStagingInstall authorization = + DatapackStagingGuard.authorizeVerifiedStagingInstall(root, stagingRoot, source, desired); return new LegacyStagingFixture( root, stagingRoot, target, source, desired, ownershipHash(source), authorization); } @@ -3539,10 +3539,10 @@ public class DatapackIngestServiceTest { Files.writeString(new File(directory, ".DS_Store").toPath(), "legacy", StandardCharsets.UTF_8); } - private DatapackIngestService.InstallPlan prepareLegacyStagingPlan( + private InstallPlan prepareLegacyStagingPlan( LegacyStagingFixture fixture ) throws Exception { - return DatapackIngestService.prepareInstall( + return DatapackInstallPlanner.prepareInstall( fixture.source(), fixture.stagingRoot(), fixture.desired(), @@ -3565,11 +3565,11 @@ public class DatapackIngestServiceTest { } private void assertInstallPublicationRejected( - DatapackIngestService.InstallPlan plan, + InstallPlan plan, String expectedMessage ) throws Exception { try { - DatapackIngestService.publishInstallPlan(plan); + DatapackInstallPlanner.publishInstallPlan(plan); fail("Expected changed install participant to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage(), expected.getMessage().contains(expectedMessage)); @@ -3589,7 +3589,7 @@ public class DatapackIngestServiceTest { Files.writeString(new File(directory, "pack.mcmeta").toPath(), """ {"pack":{"description":"test","pack_format":88}} """, StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(directory, entry); + DatapackOwnership.writeOwnership(directory, entry); } private void writeManagedDatapack( @@ -3602,7 +3602,7 @@ public class DatapackIngestServiceTest { {"pack":{"description":"test","pack_format":88}} """, StandardCharsets.UTF_8); Files.writeString(new File(directory, "value.txt").toPath(), value, StandardCharsets.UTF_8); - DatapackIngestService.writeOwnership(directory, entry); + DatapackOwnership.writeOwnership(directory, entry); } private DatapackIngestService.Entry entry( @@ -3660,15 +3660,15 @@ public class DatapackIngestServiceTest { File original = backup.isDirectory() ? backup : target; File desired = pending.isDirectory() ? pending : target; directory.put("originalMarkerHash", hadTarget - ? DatapackIngestService.ownershipMarkerFingerprint(original) : "absent"); - directory.put("desiredMarkerHash", DatapackIngestService.ownershipMarkerFingerprint(desired)); + ? DatapackOwnership.ownershipMarkerFingerprint(original) : "absent"); + directory.put("desiredMarkerHash", DatapackOwnership.ownershipMarkerFingerprint(desired)); directory.put("originalIdentity", hadTarget - ? DatapackIngestService.directoryIdentity(original) : ""); - directory.put("desiredIdentity", DatapackIngestService.directoryIdentity(desired)); + ? DatapackSupport.directoryIdentity(original) : ""); + directory.put("desiredIdentity", DatapackSupport.directoryIdentity(desired)); directory.put("targetRoot", target.getParentFile().toPath().toRealPath().toString()); directory.put("scratchRoot", backup.getParentFile().toPath().toRealPath().toString()); - directory.put("targetRootIdentity", DatapackIngestService.directoryIdentity(target.getParentFile())); - directory.put("scratchRootIdentity", DatapackIngestService.directoryIdentity(backup.getParentFile())); + directory.put("targetRootIdentity", DatapackSupport.directoryIdentity(target.getParentFile())); + directory.put("scratchRootIdentity", DatapackSupport.directoryIdentity(backup.getParentFile())); return directory; } @@ -3681,14 +3681,14 @@ public class DatapackIngestServiceTest { directory.put("originalHash", originalHash); directory.put("desiredHash", ""); File original = backup.isDirectory() ? backup : target; - directory.put("originalMarkerHash", DatapackIngestService.ownershipMarkerFingerprint(original)); + directory.put("originalMarkerHash", DatapackOwnership.ownershipMarkerFingerprint(original)); directory.put("desiredMarkerHash", ""); - directory.put("originalIdentity", DatapackIngestService.directoryIdentity(original)); + directory.put("originalIdentity", DatapackSupport.directoryIdentity(original)); directory.put("desiredIdentity", ""); directory.put("targetRoot", target.getParentFile().toPath().toRealPath().toString()); directory.put("scratchRoot", backup.getParentFile().toPath().toRealPath().toString()); - directory.put("targetRootIdentity", DatapackIngestService.directoryIdentity(target.getParentFile())); - directory.put("scratchRootIdentity", DatapackIngestService.directoryIdentity(backup.getParentFile())); + directory.put("targetRootIdentity", DatapackSupport.directoryIdentity(target.getParentFile())); + directory.put("scratchRootIdentity", DatapackSupport.directoryIdentity(backup.getParentFile())); return directory; } @@ -3801,7 +3801,7 @@ public class DatapackIngestServiceTest { private void assertRecoveryRejected(EditableRecoveryFixture fixture, String expectedMessage) throws Exception { try { - DatapackIngestService.recoverTransactions(fixture.root(), List.of()); + DatapackScratchRecovery.recoverTransactions(fixture.root(), List.of()); fail("Expected editable recovery to be rejected"); } catch (IOException expected) { assertTrue(expected.getMessage().contains(expectedMessage)); @@ -3826,7 +3826,7 @@ public class DatapackIngestServiceTest { File source, DatapackIngestService.Entry desired, String sourceHash, - DatapackIngestService.VerifiedStagingInstall authorization + VerifiedStagingInstall authorization ) { } From a31d494f45c54f0681e12b6c7489e2fc4c6d66f6 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:32:06 -0400 Subject: [PATCH 23/35] Split hydrology tile planner - Keep planner state, caches, cross-tile entry points and terrain sampling in HydrologyPlanner and move tile planning into ten collaborators for cross-tile resolution, outlets, sources, route geometry, route paths, surface courses, tributaries, underground courses, hydraulic segments and feature sites - Promote the shared planning records to top level so the collaborators address routes, grids, drafts and course paths directly - Pin a full four-tile plan digest for two seeds in HydrologyPlanHashTest - Requalify the reflective and package-private planner call sites in the hydrology tests onto the new owners --- .../iris/engine/hydrology/CompiledGraph.java | 12 + .../iris/engine/hydrology/CourseEdgeKey.java | 9 + .../engine/hydrology/CrossTileBlockers.java | 14 + .../hydrology/CrossTileDraftAdmission.java | 7 + .../CrossTilePublicationAdmission.java | 15 + .../hydrology/CrossTileRejectedCourse.java | 9 + .../hydrology/CrossTileRejectionKey.java | 4 + .../engine/hydrology/CrossTileResolution.java | 17 + .../hydrology/CrossTileResolutionContext.java | 72 + .../hydrology/CrossTileResolvedOwner.java | 21 + .../iris/engine/hydrology/DraftPhase.java | 8 + .../iris/engine/hydrology/DraftProfile.java | 60 + .../engine/hydrology/HydrologyCoursePath.java | 18 + .../hydrology/HydrologyCrossTileResolver.java | 913 ++ .../HydrologyFeatureSitePlanner.java | 767 ++ .../engine/hydrology/HydrologyGridNode.java | 15 + .../engine/hydrology/HydrologyGridOffset.java | 4 + .../hydrology/HydrologyOutletPlanner.java | 669 ++ .../engine/hydrology/HydrologyOwnerDraft.java | 17 + .../engine/hydrology/HydrologyPlanner.java | 8289 +---------------- .../hydrology/HydrologyRouteGeometry.java | 1112 +++ .../engine/hydrology/HydrologyRoutePath.java | 312 + .../hydrology/HydrologyRoutingPlan.java | 13 + .../hydrology/HydrologySampledGrid.java | 44 + .../hydrology/HydrologySegmentBuilder.java | 781 ++ .../hydrology/HydrologySourcePlanner.java | 913 ++ .../HydrologySurfaceCoursePlanner.java | 937 ++ .../hydrology/HydrologyTributaryPlanner.java | 674 ++ .../HydrologyUndergroundCoursePlanner.java | 546 ++ .../hydrology/MinimumLandHeightKey.java | 4 + .../engine/hydrology/OutletCandidate.java | 4 + .../engine/hydrology/OutletCourseKey.java | 4 + .../iris/engine/hydrology/RefinedEdgeKey.java | 14 + .../iris/engine/hydrology/RouteCandidate.java | 11 + .../iris/engine/hydrology/RouteDirection.java | 4 + .../iris/engine/hydrology/RoutePosition.java | 4 + .../hydrology/RouteTerrainEstimate.java | 4 + .../engine/hydrology/RoutingContextLoad.java | 6 + .../engine/hydrology/RoutingQueueEntry.java | 18 + .../hydrology/SourceAdmissionSelection.java | 73 + .../engine/hydrology/SourceCandidate.java | 9 + .../hydrology/SourceRoutingContext.java | 14 + .../engine/hydrology/SourceSelection.java | 192 + .../engine/hydrology/SurfaceCourseDraft.java | 9 + .../engine/hydrology/SurfaceRouteKey.java | 6 + .../hydrology/UndergroundCourseDraft.java | 4 + .../hydrology/UndergroundSegmentCapKey.java | 14 + .../hydrology/HydrologyPlanHashTest.java | 227 + .../HydrologyPlannerGlobalInvariantTest.java | 4 +- .../HydrologyPlannerSettingsTest.java | 12 +- .../hydrology/HydrologyPlannerTest.java | 30 +- .../HydrologyPlannerTributaryTest.java | 4 +- .../hydrology/HydrologyRouteLengthsTest.java | 12 +- .../HydrologyRouteTurnCacheTest.java | 10 +- 54 files changed, 8734 insertions(+), 8231 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CompiledGraph.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CourseEdgeKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileBlockers.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileDraftAdmission.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTilePublicationAdmission.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectedCourse.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectionKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolution.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolvedOwner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/DraftPhase.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCoursePath.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCrossTileResolver.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFeatureSitePlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridNode.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridOffset.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOutletPlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOwnerDraft.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRouteGeometry.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutePath.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutingPlan.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySampledGrid.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySegmentBuilder.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySourcePlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySurfaceCoursePlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyTributaryPlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyUndergroundCoursePlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/MinimumLandHeightKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/OutletCandidate.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/OutletCourseKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RefinedEdgeKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RouteCandidate.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RouteDirection.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RoutePosition.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RouteTerrainEstimate.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RoutingContextLoad.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/RoutingQueueEntry.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SourceAdmissionSelection.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SourceCandidate.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SourceRoutingContext.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceCourseDraft.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceRouteKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundCourseDraft.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundSegmentCapKey.java create mode 100644 core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlanHashTest.java diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CompiledGraph.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CompiledGraph.java new file mode 100644 index 000000000..7761417b9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CompiledGraph.java @@ -0,0 +1,12 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.Map; + +record CompiledGraph( + List nodes, + List edges, + List outlets, + Map edgeByUpstream +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CourseEdgeKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CourseEdgeKey.java new file mode 100644 index 000000000..d91216498 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CourseEdgeKey.java @@ -0,0 +1,9 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.Objects; + +record CourseEdgeKey(RiverCourseType type, long edgeId) { + CourseEdgeKey { + Objects.requireNonNull(type, "type"); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileBlockers.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileBlockers.java new file mode 100644 index 000000000..596d05afb --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileBlockers.java @@ -0,0 +1,14 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.Objects; + +record CrossTileBlockers( + List caveClaims, + List surfaceClaims +) { + CrossTileBlockers { + caveClaims = List.copyOf(Objects.requireNonNull(caveClaims, "caveClaims")); + surfaceClaims = List.copyOf(Objects.requireNonNull(surfaceClaims, "surfaceClaims")); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileDraftAdmission.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileDraftAdmission.java new file mode 100644 index 000000000..939255f42 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileDraftAdmission.java @@ -0,0 +1,7 @@ +package art.arcane.iris.engine.hydrology; + +interface CrossTileDraftAdmission { + void prepare(); + + CrossTilePublicationAdmission admit(HydrologyCaveCourseFilter.Result result); +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTilePublicationAdmission.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTilePublicationAdmission.java new file mode 100644 index 000000000..a90072559 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTilePublicationAdmission.java @@ -0,0 +1,15 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.Objects; + +record CrossTilePublicationAdmission( + HydrologyCaveCourseFilter.Result result, + List diagnostics, + boolean rejectedCourses +) { + CrossTilePublicationAdmission { + Objects.requireNonNull(result, "result"); + diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics")); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectedCourse.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectedCourse.java new file mode 100644 index 000000000..a91d054a9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectedCourse.java @@ -0,0 +1,9 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.Objects; + +record CrossTileRejectedCourse(RiverCourse course, long winnerSourceId) { + CrossTileRejectedCourse { + Objects.requireNonNull(course, "course"); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectionKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectionKey.java new file mode 100644 index 000000000..a4474e167 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileRejectionKey.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record CrossTileRejectionKey(long courseId, long winnerCourseId) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolution.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolution.java new file mode 100644 index 000000000..94e95eda2 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolution.java @@ -0,0 +1,17 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.Objects; + +record CrossTileResolution( + HydrologyOwnerDraft draft, + List observedRejections, + int iterations, + int ownerCount, + long resolutionNanos +) { + CrossTileResolution { + Objects.requireNonNull(draft, "draft"); + observedRejections = List.copyOf(Objects.requireNonNull(observedRejections, "observedRejections")); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java new file mode 100644 index 000000000..079fc56f5 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java @@ -0,0 +1,72 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +final class CrossTileResolutionContext { + final Map resolved; + final Set resolving; + final HydrologyTileKey root; + final long maximumTileOffset; + final int maximumOwners; + int iterations; + + CrossTileResolutionContext( + HydrologyTileKey root, + long maximumTileOffset, + int maximumOwners + ) { + this.resolved = new HashMap<>(); + this.resolving = new HashSet<>(); + this.root = Objects.requireNonNull(root, "root"); + this.maximumTileOffset = maximumTileOffset; + this.maximumOwners = maximumOwners; + } + + CrossTileResolvedOwner resolved(HydrologyTileKey key) { + return resolved.get(key); + } + + void remember(HydrologyTileKey key, CrossTileResolvedOwner owner) { + long offsetX = Math.abs((long) key.tileX() - root.tileX()); + long offsetZ = Math.abs((long) key.tileZ() - root.tileZ()); + if (offsetX > maximumTileOffset || offsetZ > maximumTileOffset) { + throw new IllegalStateException("Cross-tile owner dependency exceeded its color-ranked geometry bound."); + } + CrossTileResolvedOwner existing = resolved.putIfAbsent(key, owner); + if (existing != null + && !existing.withoutFootprintCompiler().equals(owner.withoutFootprintCompiler())) { + throw new IllegalStateException("Cross-tile owner resolution produced inconsistent cached results."); + } + if (resolved.size() > maximumOwners) { + throw new IllegalStateException("Cross-tile owner dependencies exceeded their color-ranked count bound."); + } + } + + boolean begin(HydrologyTileKey key) { + return resolving.add(key); + } + + void end(HydrologyTileKey key) { + resolving.remove(key); + } + + void recordIteration() { + iterations++; + } + + int iterations() { + return iterations; + } + + int ownerCount() { + return resolved.size(); + } + + HydrologyTileKey root() { + return root; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolvedOwner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolvedOwner.java new file mode 100644 index 000000000..5e6186f62 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolvedOwner.java @@ -0,0 +1,21 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.Objects; + +record CrossTileResolvedOwner( + HydrologyOwnerDraft draft, + List observedRejections +) { + CrossTileResolvedOwner { + Objects.requireNonNull(draft, "draft"); + observedRejections = List.copyOf(Objects.requireNonNull(observedRejections, "observedRejections")); + } + + CrossTileResolvedOwner withoutFootprintCompiler() { + HydrologyOwnerDraft uncachedDraft = draft.withoutFootprintCompiler(); + return uncachedDraft == draft + ? this + : new CrossTileResolvedOwner(uncachedDraft, observedRejections); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/DraftPhase.java b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftPhase.java new file mode 100644 index 000000000..a680cc68c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftPhase.java @@ -0,0 +1,8 @@ +package art.arcane.iris.engine.hydrology; + +enum DraftPhase { + CONTEXT, + SELECT, + SETTLE, + PUBLISH +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java new file mode 100644 index 000000000..adb15612e --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java @@ -0,0 +1,60 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.spi.IrisLogging; + +/** + * Wall-clock breakdown of one owner draft for the debug log: sampling and routing context, source + * selection, settling, publication passes, and the time spent waiting on lower-rank neighbour drafts. + */ +final class DraftProfile { + final long[] phaseNanos = new long[DraftPhase.values().length]; + long dependencyNanos; + int dependencies; + int admissions; + int earlyOwners; + int routeCalls; + int routeSolves; + long routeSolveNanos; + int rasterCalls; + long rasterNanos; + int filterCalls; + long filterNanos; + + long record(DraftPhase phase, long started) { + long now = System.nanoTime(); + phaseNanos[phase.ordinal()] += now - started; + return now; + } + + void recordDependencies(int count, long started) { + dependencyNanos += System.nanoTime() - started; + dependencies += count; + admissions++; + } + + void log(HydrologyTileKey key, int rank, long totalNanos) { + IrisLogging.debug( + "Hydrology owner %d,%d rank=%d drafted in %dms: context=%dms select=%dms settle=%dms publish=%dms deps=%d wait=%dms admissions=%d earlyOwners=%d routes=%d reuses=%d routeSolve=%dms rasters=%d raster=%dms filters=%d filter=%dms on %s", + key.tileX(), + key.tileZ(), + rank, + totalNanos / 1_000_000L, + phaseNanos[DraftPhase.CONTEXT.ordinal()] / 1_000_000L, + phaseNanos[DraftPhase.SELECT.ordinal()] / 1_000_000L, + phaseNanos[DraftPhase.SETTLE.ordinal()] / 1_000_000L, + phaseNanos[DraftPhase.PUBLISH.ordinal()] / 1_000_000L, + dependencies, + dependencyNanos / 1_000_000L, + admissions, + earlyOwners, + routeCalls, + routeCalls - routeSolves, + routeSolveNanos / 1_000_000L, + rasterCalls, + rasterNanos / 1_000_000L, + filterCalls, + filterNanos / 1_000_000L, + Thread.currentThread().getName() + ); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCoursePath.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCoursePath.java new file mode 100644 index 000000000..4b5b9a7ca --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCoursePath.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +/** + * A routed source-to-outlet path, or, when {@code junction} is set, the cut prefix of one that ends + * on the stem it joins: the path then owns only the drainage edges upstream of the junction. + */ +record HydrologyCoursePath( + List points, + List pairEdges, + List edges, + RiverOutlet outlet, + boolean reachesOutlet, + boolean organicSurfaceRequired, + HydrologyPoint junction +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCrossTileResolver.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCrossTileResolver.java new file mode 100644 index 000000000..04db49fa4 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCrossTileResolver.java @@ -0,0 +1,913 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.CavePosition; +import art.arcane.iris.engine.hydrology.cave.CaveVoxelView; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCandidate; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveContainmentPlanner; +import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlan; +import it.unimi.dsi.fastutil.longs.LongIterator; +import it.unimi.dsi.fastutil.longs.LongOpenHashSet; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; + +final class HydrologyCrossTileResolver { + private final HydrologyPlanner planner; + + HydrologyCrossTileResolver(HydrologyPlanner planner) { + this.planner = planner; + } + + HydrologyOwnerDraft compileOwnerDraft( + HydrologyTileKey key, + CrossTileDraftAdmission crossTileAdmission, + boolean retainFootprintCompiler + ) { + HydrologyPlanner.PlanningSamples previous = planner.planningSamples.get(); + if (previous == null) { + planner.planningSamples.set(new HydrologyPlanner.PlanningSamples()); + } + DraftProfile previousProfile = planner.draftProfiles.get(); + DraftProfile profile = new DraftProfile(); + planner.draftProfiles.set(profile); + long started = System.nanoTime(); + try { + HydrologyOwnerDraft draft = compileScopedOwnerDraft( + key, + crossTileAdmission, + retainFootprintCompiler + ); + profile.log(key, ownerColorRank(key), System.nanoTime() - started); + return draft; + } finally { + if (previous == null) { + planner.planningSamples.remove(); + } + if (previousProfile == null) { + planner.draftProfiles.remove(); + } else { + planner.draftProfiles.set(previousProfile); + } + } + } + + HydrologyOwnerDraft compileScopedOwnerDraft( + HydrologyTileKey key, + CrossTileDraftAdmission crossTileAdmission, + boolean retainFootprintCompiler + ) { + Objects.requireNonNull(key, "key"); + ArrayList diagnostics = new ArrayList<>(); + HydrologySampledGrid grid = null; + HydrologyRoutingPlan surfaceRouting = null; + HydrologyRoutingPlan undergroundRouting = null; + SourceSelection surfaceSelection = SourceSelection.empty(true); + SourceSelection undergroundSelection = SourceSelection.empty(false); + DraftProfile profile = planner.currentDraftProfile(); + long phaseStarted = System.nanoTime(); + if (planner.sourcePlanner.hasRoutedSourceSearch()) { + SourceRoutingContext primaryContext = planner.sourceRoutingContext(key); + phaseStarted = profile.record(DraftPhase.CONTEXT, phaseStarted); + grid = primaryContext.grid(); + surfaceRouting = primaryContext.surfaceRouting(); + undergroundRouting = primaryContext.undergroundRouting(); + diagnostics.addAll(primaryContext.diagnostics()); + HashMap sourceRoutingContexts = new HashMap<>(); + sourceRoutingContexts.put(key, primaryContext); + surfaceSelection = planner.sourcePlanner.selectSources( + key, + grid, + surfaceRouting, + true, + true, + diagnostics, + sourceRoutingContexts + ); + undergroundSelection = planner.sourcePlanner.selectSources( + key, + grid, + undergroundRouting, + false, + true, + diagnostics, + sourceRoutingContexts + ); + phaseStarted = profile.record(DraftPhase.SELECT, phaseStarted); + if (crossTileAdmission != null && (!surfaceSelection.selectedCandidateIndices.isEmpty() + || !undergroundSelection.selectedCandidateIndices.isEmpty())) { + crossTileAdmission.prepare(); + } + } + HydrologyFootprintCompiler footprintCompiler = new HydrologyFootprintCompiler( + planner.settings, + new HydrologyFootprintCompiler.Sampling( + planner.sampler, + planner.geometrySampler, + planner.naturalSampler + ) + ); + HashMap> refinedEdges = new HashMap<>(); + HashMap sourceCompilations = new HashMap<>(); + settleSelection( + key, + grid, + surfaceRouting, + undergroundRouting, + surfaceSelection, + true, + footprintCompiler, + refinedEdges, + sourceCompilations, + diagnostics + ); + settleSelection( + key, + grid, + surfaceRouting, + undergroundRouting, + undergroundSelection, + false, + footprintCompiler, + refinedEdges, + sourceCompilations, + diagnostics + ); + phaseStarted = profile.record(DraftPhase.SETTLE, phaseStarted); + PublicationAttempt publication = null; + List fallbackOutlets = grid == null || surfaceRouting == null + ? List.of() + : planner.outletPlanner.resolveSurfaceFallbackOutlets(grid); + int fallbackOutletIndex = 0; + while (true) { + int maximumPublicationPasses = Math.addExact( + 1, + Math.addExact( + surfaceSelection.candidateCount(), + undergroundSelection.candidateCount() + ) + ); + for (int publicationPass = 0; publicationPass < maximumPublicationPasses; publicationPass++) { + publication = compilePublication( + key, + grid, + surfaceRouting, + undergroundRouting, + surfaceSelection, + undergroundSelection, + footprintCompiler, + refinedEdges, + sourceCompilations, + true + ); + diagnostics.addAll(publication.diagnostics()); + if (crossTileAdmission != null) { + CrossTilePublicationAdmission admitted = crossTileAdmission.admit(publication.result()); + publication = new PublicationAttempt(admitted.result(), publication.diagnostics()); + diagnostics.addAll(admitted.diagnostics()); + } + if (grid == null) { + break; + } + boolean surfaceChanged = surfaceSelection.advanceAfterPublication( + publication.result().courses(), + grid + ); + boolean undergroundChanged = undergroundSelection.advanceAfterPublication( + publication.result().courses(), + grid + ); + if (!surfaceChanged && !undergroundChanged) { + break; + } + if (surfaceChanged) { + settleSelection( + key, + grid, + surfaceRouting, + undergroundRouting, + surfaceSelection, + true, + footprintCompiler, + refinedEdges, + sourceCompilations, + diagnostics + ); + } + if (undergroundChanged) { + settleSelection( + key, + grid, + surfaceRouting, + undergroundRouting, + undergroundSelection, + false, + footprintCompiler, + refinedEdges, + sourceCompilations, + diagnostics + ); + } + if (publicationPass + 1 >= maximumPublicationPasses) { + throw new IllegalStateException("Hydrology source publication exceeded its candidate bound."); + } + } + if (grid == null || !surfaceSelection.needsSurfaceFallback()) { + break; + } + boolean fallbackSelected = false; + while (fallbackOutletIndex < fallbackOutlets.size()) { + OutletCandidate fallbackOutlet = fallbackOutlets.get(fallbackOutletIndex++); + HydrologyRoutingPlan fallbackRouting = planner.sourcePlanner.requireOrganicSurface(planner.sourcePlanner.buildRouting(grid, List.of(fallbackOutlet), true)); + HashMap fallbackContexts = new HashMap<>(); + fallbackContexts.put(key, new SourceRoutingContext( + grid, + fallbackRouting, + undergroundRouting, + List.of() + )); + SourceSelection fallbackSelection = planner.sourcePlanner.selectSources( + key, + grid, + fallbackRouting, + true, + false, + diagnostics, + fallbackContexts + ); + settleSelection( + key, + grid, + fallbackRouting, + undergroundRouting, + fallbackSelection, + true, + footprintCompiler, + refinedEdges, + sourceCompilations, + diagnostics + ); + if (!fallbackSelection.hasAcceptedSelection()) { + continue; + } + surfaceRouting = fallbackRouting; + surfaceSelection = fallbackSelection; + fallbackSelected = true; + break; + } + if (!fallbackSelected) { + break; + } + } + profile.record(DraftPhase.PUBLISH, phaseStarted); + if (publication == null) { + throw new IllegalStateException("Hydrology publication did not execute."); + } + if (grid != null) { + surfaceSelection.addFinalAdmissionDiagnostics(grid, diagnostics); + undergroundSelection.addFinalAdmissionDiagnostics(grid, diagnostics); + } + HydrologyCaveCourseFilter.Result result = publication.result(); + List uniqueDiagnostics = planner.sourcePlanner.uniqueDiagnostics(diagnostics); + HydrologyOwnerDraft draft = new HydrologyOwnerDraft( + key, + result, + uniqueDiagnostics, + retainFootprintCompiler ? footprintCompiler : null + ); + validateOwnerDraftReach(draft); + return draft; + } + + HydrologyTile materializeAcceptedTile(CrossTileResolution resolution) { + HydrologyCaveCourseFilter.Result result = resolution.draft().result(); + ArrayList diagnostics = new ArrayList<>(resolution.draft().diagnostics()); + for (CrossTileRejectedCourse rejection : resolution.observedRejections()) { + diagnostics.add(rejection.course().type() == RiverCourseType.SURFACE + ? surfaceConflictDiagnostic(rejection.course(), rejection.winnerSourceId()) + : HydrologyCaveCourseFilter.overlapDiagnostic( + rejection.course(), + rejection.winnerSourceId() + )); + } + HydrologyFootprintCompiler footprintCompiler = resolution.draft().footprintCompiler(); + if (footprintCompiler == null) { + footprintCompiler = new HydrologyFootprintCompiler( + planner.settings, + new HydrologyFootprintCompiler.Sampling( + planner.sampler, + planner.geometrySampler, + planner.naturalSampler + ) + ); + } + MaterializedHydrology materialized = materializeFinalHydrology( + result, + diagnostics, + footprintCompiler, + !resolution.observedRejections().isEmpty() + ); + result = materialized.result(); + RiverFootprint footprint = materialized.footprint(); + if (footprintCompiler.fullMaterializationCount() < 1) { + throw new IllegalStateException("Hydrology publication did not materialize its full footprint."); + } + return new HydrologyTile( + resolution.draft().key(), + planner.worldSeed, + planner.settings.fingerprint(), + planner.settings.routing().tileSize(), + result.nodes(), + result.edges(), + result.outlets(), + result.courses(), + result.cavePlans(), + planner.sourcePlanner.uniqueDiagnostics(diagnostics), + footprint + ); + } + + MaterializedHydrology materializeFinalHydrology( + HydrologyCaveCourseFilter.Result initial, + List diagnostics, + HydrologyFootprintCompiler footprintCompiler, + boolean revalidationRequired + ) { + HydrologyCaveCourseFilter.Result current = initial; + int maximumPasses = Math.addExact(initial.courses().size(), 1); + for (int pass = 0; pass < maximumPasses; pass++) { + RiverFootprint footprint = footprintCompiler.compile(current.courses()); + if (current.cavePlans().isEmpty()) { + return new MaterializedHydrology(current, footprint); + } + HydrologyFootprintCompiler.ValidationRaster compactValidation = footprintCompiler.compileValidation( + current.courses() + ); + if (!revalidationRequired + && compactSurfaceMatchesMaterializedPlans(current, compactValidation, footprint)) { + return new MaterializedHydrology(current, footprint); + } + HydrologyFootprintCompiler.ValidationRaster validation = compactValidation.withMaterializedSurface( + footprint + ); + HydrologyObservedPlannedSurface plannedSurface = new HydrologyObservedPlannedSurface( + validation.plannedSurface() + ); + CaveVoxelView caveView = Objects.requireNonNull( + planner.caveViewFactory.create(plannedSurface), + "Hydrology cave view factory returned null" + ); + HydrologyCaveCourseFilter.Result revalidated = new HydrologyCaveCourseFilter( + caveView, + new HydrologyCaveCourseFilter.Options( + planner.settings.underground().connectToExistingCaves(), + planner.settings.outlets().coastalGrotto().maximumVolume(), + planner.settings.outlets().inlandGrotto().maximumVolume() + ), + null, + null, + plannedSurface + ).filter( + current.nodes(), + current.edges(), + current.outlets(), + current.courses(), + validation, + diagnostics + ); + if (revalidated.courses().equals(current.courses())) { + return new MaterializedHydrology(revalidated, footprint); + } + current = revalidated; + revalidationRequired = true; + } + throw new IllegalStateException("Final hydrology cave publication exceeded its course bound."); + } + + boolean compactSurfaceMatchesMaterializedPlans( + HydrologyCaveCourseFilter.Result result, + HydrologyFootprintCompiler.ValidationRaster validation, + RiverFootprint footprint + ) { + HashSet visitedColumns = new HashSet<>(); + for (HydrologyCavePlan plan : result.cavePlans()) { + for (CavePosition position : plan.baselinePreconditions().keySet()) { + long packed = RiverFootprint.pack(position.x(), position.z()); + if (!visitedColumns.add(packed)) { + continue; + } + HydrologyColumnSample sample = footprint.sample(position.x(), position.z()).orElse(null); + HydrologyTerrainSample terrain = sample == null + ? Objects.requireNonNull(planner.sampler.sample(position.x(), position.z())) + : null; + int naturalHeight = sample == null ? terrain.naturalHeight() : sample.naturalHeight(); + int materializedHeight = sample == null ? naturalHeight : sample.terrainHeight(); + int compactHeight = validation.plannedSurface().resolve( + position.x(), + position.z(), + naturalHeight + ); + if (compactHeight != materializedHeight) { + return false; + } + } + } + return true; + } + + CrossTileBlockers lowerRankBlockers( + HydrologyTileKey ownerKey, + HydrologyCaveCourseFilter.Result result, + int ownerRank, + CrossTileResolutionContext context, + Map> preparedOwners + ) { + ArrayList blockers = new ArrayList<>(); + ArrayList surfaceBlockers = new ArrayList<>(); + ArrayList candidateKeys = new ArrayList<>(); + for (HydrologyTileKey candidateKey : conflictOwnerKeys(ownerKey, result)) { + if (candidateKey.equals(ownerKey)) { + continue; + } + int candidateRank = ownerColorRank(candidateKey); + if (candidateRank == ownerRank) { + throw new IllegalStateException("Equal owner colors cannot share a cave-action conflict envelope."); + } + if (candidateRank > ownerRank) { + continue; + } + candidateKeys.add(candidateKey); + } + long dependenciesStarted = System.nanoTime(); + List resolvedCandidates = planner.resolveLowerRankOwners(candidateKeys, context, preparedOwners); + planner.currentDraftProfile().recordDependencies(candidateKeys.size(), dependenciesStarted); + for (int index = 0; index < candidateKeys.size(); index++) { + HydrologyTileKey candidateKey = candidateKeys.get(index); + int candidateRank = ownerColorRank(candidateKey); + CrossTileResolvedOwner resolved = resolvedCandidates.get(index); + for (HydrologyCrossTileCaveAdmission.Claim claim : caveClaims(resolved.draft())) { + blockers.add(new HydrologyCrossTileCaveAdmission.RankedClaim( + candidateKey, + candidateRank, + claim + )); + } + for (HydrologyCrossTileSurfaceAdmission.Claim claim : surfaceClaims(resolved.draft())) { + surfaceBlockers.add(new HydrologyCrossTileSurfaceAdmission.RankedClaim( + candidateKey, + candidateRank, + claim + )); + } + } + return new CrossTileBlockers(List.copyOf(blockers), List.copyOf(surfaceBlockers)); + } + + List conflictOwnerKeys(HydrologyOwnerDraft target) { + return conflictOwnerKeys(target.key(), target.result()); + } + + List conflictOwnerKeys( + HydrologyTileKey ownerKey, + HydrologyCaveCourseFilter.Result result + ) { + int tileSize = planner.settings.routing().tileSize(); + int reach = Math.addExact(planner.settings.publicationRadius(), 1); + int colorPeriod = planner.settings.crossTileColorPeriod(); + LongOpenHashSet columns = new LongOpenHashSet(); + for (HydrologyCavePlan plan : result.cavePlans()) { + for (CavePosition position : plan.actions().keySet()) { + columns.add(RiverFootprint.pack(position.x(), position.z())); + } + } + for (RiverCourse course : result.courses()) { + if (course.type() != RiverCourseType.SURFACE) { + continue; + } + for (HydraulicSegment segment : course.segments()) { + for (HydrologyPoint point : segment.centerline()) { + columns.add(RiverFootprint.pack(point.x(), point.z())); + } + } + } + LinkedHashSet owners = new LinkedHashSet<>(); + owners.add(ownerKey); + LongIterator iterator = columns.iterator(); + while (iterator.hasNext()) { + long column = iterator.nextLong(); + int x = RiverFootprint.unpackX(column); + int z = RiverFootprint.unpackZ(column); + int minimumTileX = ownerCoordinate((long) x - reach, tileSize); + int maximumTileX = ownerCoordinate((long) x + reach, tileSize); + int minimumTileZ = ownerCoordinate((long) z - reach, tileSize); + int maximumTileZ = ownerCoordinate((long) z + reach, tileSize); + long ownerWidth = Math.addExact((long) maximumTileX - minimumTileX, 1L); + long ownerDepth = Math.addExact((long) maximumTileZ - minimumTileZ, 1L); + if (ownerWidth > colorPeriod || ownerDepth > colorPeriod) { + throw new IllegalStateException("A cave action exceeds its bounded owner color neighborhood."); + } + for (int tileZ = minimumTileZ; tileZ <= maximumTileZ; tileZ++) { + for (int tileX = minimumTileX; tileX <= maximumTileX; tileX++) { + owners.add(new HydrologyTileKey(tileX, tileZ)); + } + } + } + int sourceReach = Math.max(0, planner.settings.surface().sources().minimumSpacing() - 1); + for (HydrologyCrossTileSurfaceAdmission.Claim claim : surfaceClaims(result)) { + HydrologyPoint source = claim.centerline().getFirst(); + int minimumTileX = ownerCoordinate((long) source.x() - sourceReach, tileSize); + int maximumTileX = ownerCoordinate((long) source.x() + sourceReach, tileSize); + int minimumTileZ = ownerCoordinate((long) source.z() - sourceReach, tileSize); + int maximumTileZ = ownerCoordinate((long) source.z() + sourceReach, tileSize); + for (int tileZ = minimumTileZ; tileZ <= maximumTileZ; tileZ++) { + for (int tileX = minimumTileX; tileX <= maximumTileX; tileX++) { + owners.add(new HydrologyTileKey(tileX, tileZ)); + } + } + } + ArrayList ordered = new ArrayList<>(owners); + ordered.sort(HydrologyTileKey::compareTo); + return List.copyOf(ordered); + } + + int ownerColorRank(HydrologyTileKey key) { + int colorPeriod = planner.settings.crossTileColorPeriod(); + int colorX = Math.floorMod(key.tileX(), colorPeriod); + int colorZ = Math.floorMod(key.tileZ(), colorPeriod); + return Math.addExact(Math.multiplyExact(colorZ, colorPeriod), colorX); + } + + List caveClaims(HydrologyOwnerDraft draft) { + return caveClaims(draft.result()); + } + + List caveClaims( + HydrologyCaveCourseFilter.Result result + ) { + if (result.cavePlans().isEmpty()) { + return List.of(); + } + Map coursesById = coursesById(result.courses()); + ArrayList claims = + new ArrayList<>(result.cavePlans().size()); + for (HydrologyCavePlan plan : result.cavePlans()) { + RiverCourse course = coursesById.get(plan.source().sourceId()); + if (course == null) { + throw new IllegalStateException("Accepted cave plan has no owner course."); + } + claims.add(new HydrologyCrossTileCaveAdmission.Claim(course.profileKey(), plan)); + } + return List.copyOf(claims); + } + + List surfaceClaims(HydrologyOwnerDraft draft) { + return surfaceClaims(draft.result()); + } + + List surfaceClaims( + HydrologyCaveCourseFilter.Result result + ) { + ArrayList claims = new ArrayList<>(); + for (RiverCourse course : result.courses()) { + if (course.type() != RiverCourseType.SURFACE || course.outletId().isEmpty()) { + continue; + } + ArrayList centerline = new ArrayList<>(); + int maximumWidth = 1; + for (HydraulicSegment segment : course.segments()) { + maximumWidth = Math.max(maximumWidth, segment.width()); + for (HydrologyPoint point : segment.centerline()) { + if (centerline.isEmpty() + || point.x() != centerline.getLast().x() + || point.z() != centerline.getLast().z()) { + centerline.add(point); + } + } + } + if (centerline.size() < 2) { + continue; + } + HydrologyFeatureType terminalType = course.segments().getLast().type(); + boolean reachesOutlet = terminalType == HydrologyFeatureType.MOUTH + || terminalType == HydrologyFeatureType.COASTAL_GROTTO + || terminalType == HydrologyFeatureType.INLAND_GROTTO; + if (!reachesOutlet) { + continue; + } + claims.add(new HydrologyCrossTileSurfaceAdmission.Claim( + course.id(), + course.outletId().getAsLong(), + centerline.getLast(), + reachesOutlet, + maximumWidth, + centerline + )); + } + return List.copyOf(claims); + } + + Map coursesById(List courses) { + LinkedHashMap indexed = new LinkedHashMap<>(courses.size()); + for (RiverCourse course : courses) { + RiverCourse existing = indexed.putIfAbsent(course.id(), course); + if (existing != null && !existing.equals(course)) { + throw new IllegalStateException("Hydrology course id collision."); + } + } + return Map.copyOf(indexed); + } + + void validateOwnerDraftReach(HydrologyOwnerDraft draft) { + int tileSize = planner.settings.routing().tileSize(); + int reach = Math.addExact(planner.settings.publicationRadius(), 1); + long minimumX = (long) draft.key().minimumBlockX(tileSize) - reach; + long minimumZ = (long) draft.key().minimumBlockZ(tileSize) - reach; + long maximumX = (long) draft.key().minimumBlockX(tileSize) + tileSize - 1L + reach; + long maximumZ = (long) draft.key().minimumBlockZ(tileSize) + tileSize - 1L + reach; + for (HydrologyCavePlan plan : draft.result().cavePlans()) { + for (CavePosition position : plan.actions().keySet()) { + if (position.x() < minimumX || position.x() > maximumX + || position.z() < minimumZ || position.z() > maximumZ) { + throw new IllegalStateException("Hydrology cave plan exceeds its bounded owner reach."); + } + } + } + } + + static int ownerCoordinate(long blockCoordinate, int tileSize) { + return Math.toIntExact(Math.floorDiv(blockCoordinate, tileSize)); + } + + void settleSelection( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan surfaceRouting, + HydrologyRoutingPlan undergroundRouting, + SourceSelection selection, + boolean surface, + HydrologyFootprintCompiler footprintCompiler, + Map> refinedEdges, + Map sourceCompilations, + List diagnostics + ) { + HydrologyRoutingPlan selectedRouting = surface ? surfaceRouting : undergroundRouting; + if (grid == null + || selectedRouting == null + || selection.selectedCandidateIndices.isEmpty()) { + return; + } + SourceSelection emptySelection = SourceSelection.empty(!surface); + int maximumPasses = Math.addExact(1, selection.candidateCount()); + for (int pass = 0; pass < maximumPasses; pass++) { + PublicationAttempt attempt = compilePublication( + key, + grid, + surfaceRouting, + undergroundRouting, + surface ? selection : emptySelection, + surface ? emptySelection : selection, + footprintCompiler, + refinedEdges, + sourceCompilations, + false + ); + diagnostics.addAll(attempt.diagnostics()); + if (!selection.advanceAfterPublication(attempt.result().courses(), grid)) { + return; + } + } + throw new IllegalStateException("Hydrology source trial exceeded its candidate bound."); + } + + PublicationAttempt compilePublication( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan surfaceRouting, + HydrologyRoutingPlan undergroundRouting, + SourceSelection surfaceSelection, + SourceSelection undergroundSelection, + HydrologyFootprintCompiler footprintCompiler, + Map> refinedEdges, + Map sourceCompilations, + boolean includeDeepFluids + ) { + ArrayList diagnostics = new ArrayList<>(); + ArrayList courses = new ArrayList<>(); + CompiledGraph graph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); + if (grid != null) { + List surfaceSources = surfaceSelection.selectedNodeIndices(); + List undergroundSources = undergroundSelection.selectedNodeIndices(); + if (surfaceRouting != null && surfaceRouting == undergroundRouting) { + int[] surfaceContributions = planner.sourcePlanner.countContributions(surfaceSources, surfaceRouting); + int[] undergroundContributions = planner.sourcePlanner.countContributions(undergroundSources, surfaceRouting); + graph = planner.sourcePlanner.compileGraph( + key, + grid, + surfaceRouting, + surfaceContributions, + undergroundContributions, + refinedEdges + ); + if (planner.settings.surface().enabled()) { + planner.surfaceCourses.compileSurfaceCourses( + key, + grid, + surfaceRouting, + graph, + surfaceSources, + courses, + diagnostics + ); + } + if (planner.settings.underground().enabled()) { + planner.undergroundCourses.compileUndergroundCourses( + key, + grid, + surfaceRouting, + graph, + undergroundSources, + courses, + diagnostics + ); + } + } else { + CompiledGraph surfaceGraph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); + CompiledGraph undergroundGraph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); + if (surfaceRouting != null && !surfaceSources.isEmpty()) { + SourceCompilation surfaceCompilation = compileSourceSelection( + true, + key, + grid, + surfaceRouting, + surfaceSources, + refinedEdges, + sourceCompilations + ); + surfaceGraph = surfaceCompilation.graph(); + courses.addAll(surfaceCompilation.courses()); + diagnostics.addAll(surfaceCompilation.diagnostics()); + } + if (undergroundRouting != null && !undergroundSources.isEmpty()) { + SourceCompilation undergroundCompilation = compileSourceSelection( + false, + key, + grid, + undergroundRouting, + undergroundSources, + refinedEdges, + sourceCompilations + ); + undergroundGraph = undergroundCompilation.graph(); + courses.addAll(undergroundCompilation.courses()); + diagnostics.addAll(undergroundCompilation.diagnostics()); + } + graph = planner.sourcePlanner.mergeGraphs(surfaceGraph, undergroundGraph); + } + } + List normalizedTrunkCourses = planner.tributaries.normalizeSharedTrunks(courses, diagnostics); + List normalizedOutletCourses = planner.tributaries.normalizeOutletContinuations(normalizedTrunkCourses); + courses.clear(); + courses.addAll(normalizedOutletCourses); + if (includeDeepFluids) { + planner.featureSites.compileDeepFluidCourses(key, courses, diagnostics); + } + planner.featureSites.compileSurfacePools(key, courses, diagnostics); + if (includeDeepFluids && grid != null) { + planner.featureSites.compileSeaCaves(grid, courses, diagnostics); + } + DraftProfile profile = planner.currentDraftProfile(); + long rasterStarted = System.nanoTime(); + HydrologyFootprintCompiler.ValidationRaster validation = footprintCompiler.compileValidation(courses); + profile.rasterNanos += System.nanoTime() - rasterStarted; + profile.rasterCalls++; + HydrologyObservedPlannedSurface plannedSurface = new HydrologyObservedPlannedSurface( + validation.plannedSurface() + ); + CaveVoxelView caveView = Objects.requireNonNull( + planner.caveViewFactory.create(plannedSurface), + "Hydrology cave view factory returned null" + ); + HydrologyPlanner.PlanningSamples samples = planner.planningSamples.get(); + if (samples != null && caveView instanceof HydrologyTerrainCaveVoxelView terrainCaveView) { + caveView = terrainCaveView.withSampleCache(samples.detailed); + } + Map candidateCache = + samples == null ? null : samples.caveCandidates; + HydrologyCaveContainmentPlanner.ValidationCache validationCache = + samples == null ? null : samples.caveValidations; + long filterStarted = System.nanoTime(); + HydrologyCaveCourseFilter.Result containment = new HydrologyCaveCourseFilter( + caveView, + new HydrologyCaveCourseFilter.Options( + planner.settings.underground().connectToExistingCaves(), + planner.settings.outlets().coastalGrotto().maximumVolume(), + planner.settings.outlets().inlandGrotto().maximumVolume() + ), + candidateCache, + validationCache, + plannedSurface + ).filter( + graph.nodes(), + graph.edges(), + graph.outlets(), + courses, + validation, + diagnostics + ); + profile.filterNanos += System.nanoTime() - filterStarted; + profile.filterCalls++; + return new PublicationAttempt(containment, diagnostics); + } + + SourceCompilation compileSourceSelection( + boolean surface, + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + List sources, + Map> refinedEdges, + Map sourceCompilations + ) { + SourceCompilationKey compilationKey = new SourceCompilationKey(surface, routing, sources); + SourceCompilation cached = sourceCompilations.get(compilationKey); + if (cached != null) { + return cached; + } + int[] contributions = planner.sourcePlanner.countContributions(sources, routing); + CompiledGraph graph = planner.sourcePlanner.compileGraph( + key, + grid, + routing, + surface ? contributions : new int[contributions.length], + surface ? new int[contributions.length] : contributions, + refinedEdges + ); + ArrayList courses = new ArrayList<>(); + ArrayList diagnostics = new ArrayList<>(); + if (surface && planner.settings.surface().enabled()) { + planner.surfaceCourses.compileSurfaceCourses(key, grid, routing, graph, sources, courses, diagnostics); + } else if (!surface && planner.settings.underground().enabled()) { + planner.undergroundCourses.compileUndergroundCourses(key, grid, routing, graph, sources, courses, diagnostics); + } + SourceCompilation compiled = new SourceCompilation( + graph, + List.copyOf(courses), + List.copyOf(diagnostics) + ); + sourceCompilations.put(compilationKey, compiled); + return compiled; + } + + record SourceCompilationKey( + boolean surface, + HydrologyRoutingPlan routing, + List sources + ) { + SourceCompilationKey { + Objects.requireNonNull(routing, "routing"); + sources = List.copyOf(sources); + } + } + + record SourceCompilation( + CompiledGraph graph, + List courses, + List diagnostics + ) { + } + + record PublicationAttempt( + HydrologyCaveCourseFilter.Result result, + List diagnostics + ) { + } + + record MaterializedHydrology( + HydrologyCaveCourseFilter.Result result, + RiverFootprint footprint + ) { + MaterializedHydrology { + Objects.requireNonNull(result); + Objects.requireNonNull(footprint); + } + } + + HydrologyDiagnosticCandidate surfaceConflictDiagnostic( + RiverCourse course, + long winnerCourseId + ) { + HydraulicSegment representative = course.segments().getFirst(); + return new HydrologyDiagnosticCandidate( + HydrologyHash.mix(course.id(), HydrologySourcePlanner.DIAGNOSTIC_SALT, winnerCourseId), + HydrologyCandidateKind.SOURCE, + HydrologyFeatureType.SURFACE_POOL, + representative.start(), + HydrologyCandidateRejection.SOURCE_SPACING, 0 + ); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFeatureSitePlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFeatureSitePlanner.java new file mode 100644 index 000000000..161c0923a --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFeatureSitePlanner.java @@ -0,0 +1,767 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.surface.ChannelProfile; +import art.arcane.iris.engine.hydrology.surface.ValleyProfile; +import art.arcane.iris.engine.hydrology.surface.ValleyProfileSolver; +import art.arcane.iris.engine.hydrology.surface.SurfaceCenterline; +import art.arcane.iris.engine.hydrology.surface.SurfaceTerminal; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; +import java.util.List; +import java.util.OptionalLong; + +final class HydrologyFeatureSitePlanner { + private final HydrologyPlanner planner; + + HydrologyFeatureSitePlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + static final long DEEP_FLUID_SALT = 0x44454550464cL; + static final long SURFACE_POOL_SALT = 0x504f4f4cL; + static final long SEA_CAVE_SALT = 0x534541434156L; + static final long DEEP_FLUID_X_OFFSET_SALT = 0x44454550584fL; + static final long DEEP_FLUID_Z_OFFSET_SALT = 0x444545505a4fL; + static final long DEEP_CHANNEL_HEADING_SALT = 0x44454550484447L; + static final long DEEP_CHANNEL_FIRST_BEND_SALT = 0x444545504231L; + static final long DEEP_CHANNEL_SECOND_BEND_SALT = 0x444545504232L; + + /** + * Standing surface pools: a jittered lattice of candidate sites per pool profile, admitted where the + * policy lists the pool, the ground is open land clear of every accepted course, and the bowl fits + * the incision cap. Each accepted pool is an independent course with one STANDING_POOL segment. + */ + void compileSurfacePools( + HydrologyTileKey key, + List courses, + List diagnostics + ) { + int tileSize = planner.settings.routing().tileSize(); + for (HydrologyPlannerSettings.SurfacePool pool : planner.settings.surfacePools()) { + if (!pool.enabled() || pool.maximumPerTile() == 0) { + continue; + } + long profileSeed = HydrologyHash.mix(planner.worldSeed, SURFACE_POOL_SALT, HydrologyHash.text(pool.id())); + int target = Math.min(pool.maximumPerTile(), planner.sourcePlanner.expectedCount(pool.density(), HydrologyHash.mix( + profileSeed, key.tileX(), key.tileZ()))); + int accepted = 0; + for (DeepSite site : poolSites(key, pool, profileSeed, tileSize)) { + if (accepted >= target) { + addPoolDiagnostic(site, HydrologyCandidateRejection.SOURCE_QUOTA, diagnostics); + continue; + } + HydrologyCandidateRejection rejection = poolAdmission(pool, site, courses); + if (rejection != null) { + addPoolDiagnostic(site, rejection, diagnostics); + continue; + } + RiverCourse course = buildSurfacePoolCourse(pool, site); + if (course == null) { + addPoolDiagnostic(site, HydrologyCandidateRejection.SURFACE_CORRIDOR_UNSUPPORTED, diagnostics); + continue; + } + courses.add(course); + accepted++; + } + } + } + + ArrayList poolSites( + HydrologyTileKey key, + HydrologyPlannerSettings.SurfacePool pool, + long profileSeed, + int tileSize + ) { + int minimumX = key.minimumBlockX(tileSize); + int minimumZ = key.minimumBlockZ(tileSize); + int spacing = pool.spacing(); + int xOffset = HydrologyHash.between(HydrologyHash.mix(profileSeed, DEEP_FLUID_X_OFFSET_SALT), 0, spacing - 1); + int zOffset = HydrologyHash.between(HydrologyHash.mix(profileSeed, DEEP_FLUID_Z_OFFSET_SALT), 0, spacing - 1); + long firstCellX = ceilDiv((long) minimumX - xOffset, spacing); + long firstCellZ = ceilDiv((long) minimumZ - zOffset, spacing); + long lastCellX = Math.floorDiv((long) minimumX + tileSize - 1L - xOffset, spacing); + long lastCellZ = Math.floorDiv((long) minimumZ + tileSize - 1L - zOffset, spacing); + ArrayList sites = new ArrayList<>(); + for (long cellZ = firstCellZ; cellZ <= lastCellZ; cellZ++) { + for (long cellX = firstCellX; cellX <= lastCellX; cellX++) { + long stable = HydrologyHash.mix(profileSeed, cellX, cellZ); + // Jitter inside the cell keeps pools off a visible grid. + int jitter = Math.max(1, spacing / 3); + int x = Math.toIntExact(xOffset + cellX * spacing + HydrologyHash.between(HydrologyHash.mix(stable, 11), -jitter, jitter)); + int z = Math.toIntExact(zOffset + cellZ * spacing + HydrologyHash.between(HydrologyHash.mix(stable, 12), -jitter, jitter)); + HydrologyTerrainSample terrain = planner.sampleLandBasis(x, z); + sites.add(new DeepSite(x, z, terrain == null ? 0 : terrain.naturalHeight(), stable)); + } + } + sites.sort(Comparator.comparingLong(DeepSite::stableId)); + return sites; + } + + HydrologyCandidateRejection poolAdmission( + HydrologyPlannerSettings.SurfacePool pool, + DeepSite site, + List courses + ) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(site.x(), site.z()); + if (terrain == null || terrain.ocean() || terrain.naturalHeight() <= planner.settings.seaLevel() + 1) { + return HydrologyCandidateRejection.SURFACE_EXPOSURE; + } + if (!terrain.transitAllowed() || !terrain.surfacePoolKeys().contains(pool.id())) { + return HydrologyCandidateRejection.POLICY_EXCLUDED; + } + long clearance = pool.maximumRadius() + (long) StrictMath.ceil(planner.settings.surface().shoreWidth()) + + planner.settings.surface().banks().maximumBlendWidth() + planner.settings.surface().maximumWidth(); + long clearanceSquared = clearance * clearance; + for (RiverCourse course : courses) { + for (HydraulicSegment segment : course.segments()) { + for (HydrologyPoint point : segment.centerline()) { + long deltaX = (long) point.x() - site.x(); + long deltaZ = (long) point.z() - site.z(); + if (deltaX * deltaX + deltaZ * deltaZ < clearanceSquared) { + return HydrologyCandidateRejection.SOURCE_SPACING; + } + } + } + } + return null; + } + + RiverCourse buildSurfacePoolCourse(HydrologyPlannerSettings.SurfacePool pool, DeepSite site) { + int radius = HydrologyHash.between(HydrologyHash.mix(site.stableId(), 3), pool.minimumRadius(), pool.maximumRadius()); + HydrologyTerrainSample terrain = planner.sampleLandBasis(site.x(), site.z()); + List points = List.of( + new HydrologyPoint(site.x() - 1, site.head(), site.z()), + new HydrologyPoint(site.x(), site.head(), site.z()), + new HydrologyPoint(site.x() + 1, site.head(), site.z()) + ); + SurfaceCenterline centerline = SurfaceCenterline.densify(points); + int count = centerline.size(); + double[] halfWidth = new double[count]; + double[] depth = new double[count]; + double[] bank = new double[count]; + Arrays.fill(halfWidth, radius); + Arrays.fill(depth, pool.depth()); + Arrays.fill(bank, terrain == null ? 1D : terrain.bankMultiplier()); + ChannelProfile profile = new ChannelProfile(halfWidth, depth, bank); + ValleyProfile valley = new ValleyProfileSolver(planner.settings.surface(), planner::sampleBasis, planner.settings.seaLevel(), 0) + .solve(centerline, profile, SurfaceTerminal.SINKHOLE, Integer.MIN_VALUE); + if (!valley.accepted()) { + return null; + } + int center = Math.min(1, valley.exposedStations() - 1); + int head = valley.head()[center]; + // A pool belongs in a hollow or on level ground: the whole rim must sit within a few blocks of the + // water, or the bowl becomes a scar dug into a slope. + int rimAllowance = pool.depth() + planner.settings.surface().banks().sink() + 2; + for (int station = 0; station < valley.exposedStations(); station++) { + if (valley.crossMax()[station] - valley.head()[station] > rimAllowance) { + return null; + } + } + long courseId = HydrologyHash.mix(planner.worldSeed, SURFACE_POOL_SALT, HydrologyHash.text(pool.id()), site.stableId()); + long segmentId = HydrologyHash.mix(courseId, HydrologySegmentBuilder.SEGMENT_SALT, HydrologyFeatureType.STANDING_POOL.ordinal()); + ArrayList centerlinePoints = new ArrayList<>(points.size()); + for (HydrologyPoint point : points) { + centerlinePoints.add(new HydrologyPoint(point.x(), head, point.z())); + } + HydraulicSegment segment = new HydraulicSegment( + segmentId, + courseId, + HydrologyFeatureType.STANDING_POOL, + head, + head, + radius * 2, + pool.depth(), + false, + false, + centerlinePoints + ); + return new RiverCourse( + courseId, + RiverCourseType.SURFACE_POOL, + OptionalLong.empty(), + OptionalLong.empty(), + pool.id(), + 1, + List.of(), + List.of(segment) + ); + } + + void addPoolDiagnostic( + DeepSite site, + HydrologyCandidateRejection rejection, + List diagnostics + ) { + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(site.stableId(), HydrologySourcePlanner.DIAGNOSTIC_SALT, rejection.ordinal()), + HydrologyCandidateKind.POOL, + HydrologyFeatureType.STANDING_POOL, + new HydrologyPoint(site.x(), site.head(), site.z()), + rejection, + 0 + )); + } + + /** + * Sea caves: coastal grottos the sea opens into without a river. Every owned land node with a proven + * ocean boundary is a site, ranked by how high the coast stands over the sea; each accepted site is an + * independent course whose chamber is swept inland from the shoreline and opens only through its ocean + * face. Rivers keep their outlets: sea caves stay clear of every mouth and grotto already planned. + */ + void compileSeaCaves( + HydrologySampledGrid grid, + List courses, + List diagnostics + ) { + HydrologyPlannerSettings.SeaCaves seaCaves = planner.settings.seaCaves(); + if (!seaCaves.enabled() || seaCaves.maximumPerTile() == 0) { + return; + } + HydrologyPlannerSettings.Grotto grotto = planner.settings.outlets().coastalGrotto(); + boolean fits = sweptGrottoVolume(grotto, seaCaves.depth()) <= grotto.maximumVolume(); + ArrayList accepted = new ArrayList<>(); + for (SeaCaveSite site : seaCaveSites(grid)) { + if (accepted.size() >= seaCaves.maximumPerTile()) { + addSeaCaveDiagnostic(site, HydrologyCandidateRejection.SOURCE_QUOTA, diagnostics); + continue; + } + if (!fits) { + addSeaCaveDiagnostic(site, HydrologyCandidateRejection.VOLUME_LIMIT, diagnostics); + continue; + } + HydrologyCandidateRejection rejection = seaCaveAdmission(site, accepted, courses); + if (rejection != null) { + addSeaCaveDiagnostic(site, rejection, diagnostics); + continue; + } + courses.add(buildSeaCaveCourse(site)); + accepted.add(site); + } + } + + ArrayList seaCaveSites(HydrologySampledGrid grid) { + int depth = planner.settings.seaCaves().depth(); + ArrayList sites = new ArrayList<>(); + for (HydrologyGridNode land : grid.nodes()) { + HydrologyTerrainSample terrain = land.terrain(); + if (!grid.owns(land.x(), land.z()) + || terrain.ocean() + || !terrain.transitAllowed() + || !terrain.outletAllowed()) { + continue; + } + HydrologyGridNode ocean = planner.outletPlanner.firstOceanNeighbor(grid, land); + if (ocean == null) { + continue; + } + HydrologyOceanBoundaryRefiner.Result boundary = planner.outletPlanner.refineOceanBoundary(land, ocean); + if (boundary == null + || !boundary.landwardTerrain().transitAllowed() + || !boundary.landwardTerrain().outletAllowed()) { + continue; + } + long stableId = HydrologyHash.mix(planner.worldSeed, SEA_CAVE_SALT, land.id(), ocean.id()); + HydrologyPoint inner = seaCaveInnerPoint(land, ocean, boundary.landwardPoint(), stableId, depth); + int seaLevel = planner.settingsSeaLevel(ocean.terrain()); + int coastHeight = seaCaveCoastHeight(boundary, inner, seaLevel); + sites.add(new SeaCaveSite(land, ocean, boundary, inner, coastHeight, stableId)); + } + sites.sort(Comparator.comparingInt(SeaCaveSite::coastHeight).reversed() + .thenComparingLong(SeaCaveSite::stableId)); + return sites; + } + + /** + * How high the coast stands over the sea across the chamber: the lowest land at the shoreline, at the + * back of the chamber and at both flanks of each. Flanks in the sea are ignored (the chamber opens + * there like its face); a back in the sea leaves no coast at all. + */ + int seaCaveCoastHeight(HydrologyOceanBoundaryRefiner.Result boundary, HydrologyPoint inner, int seaLevel) { + HydrologyTerrainSample innerTerrain = planner.sampleLandBasis(inner.x(), inner.z()); + if (innerTerrain == null) { + return 0; + } + HydrologyPoint landward = boundary.landwardPoint(); + int lowest = Math.min(boundary.landwardTerrain().naturalHeight(), innerTerrain.naturalHeight()); + int radius = planner.settings.outlets().coastalGrotto().horizontalRadius(); + // Flanks lie along the shore, across the crossing from the landward point to the sea. + int spanX = boundary.oceanPoint().x() - landward.x(); + int spanZ = boundary.oceanPoint().z() - landward.z(); + double length = StrictMath.hypot(spanX, spanZ); + int flankX = (int) StrictMath.round(-spanZ / length * radius); + int flankZ = (int) StrictMath.round(spanX / length * radius); + int[][] flanks = { + {landward.x() + flankX, landward.z() + flankZ}, + {landward.x() - flankX, landward.z() - flankZ}, + {inner.x() + flankX, inner.z() + flankZ}, + {inner.x() - flankX, inner.z() - flankZ} + }; + for (int[] flank : flanks) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(flank[0], flank[1]); + if (terrain != null) { + lowest = Math.min(lowest, terrain.naturalHeight()); + } + } + return lowest - seaLevel; + } + + // The chamber runs inland along the coast normal, turned by a stable jitter so caves do not all + // face the same way along a straight shore. + HydrologyPoint seaCaveInnerPoint( + HydrologyGridNode land, + HydrologyGridNode ocean, + HydrologyPoint landward, + long stableId, + int depth + ) { + double normalX = land.x() - ocean.x(); + double normalZ = land.z() - ocean.z(); + double length = StrictMath.hypot(normalX, normalZ); + double jitter = StrictMath.toRadians( + (HydrologyHash.unit(HydrologyHash.mix(stableId, 7)) * 2D - 1D) + * planner.settings.seaCaves().sweepJitterDegrees() + ); + double cos = StrictMath.cos(jitter); + double sin = StrictMath.sin(jitter); + double unitX = normalX / length; + double unitZ = normalZ / length; + double inlandX = unitX * cos - unitZ * sin; + double inlandZ = unitX * sin + unitZ * cos; + return new HydrologyPoint( + (int) StrictMath.round(landward.x() + inlandX * depth), + landward.y(), + (int) StrictMath.round(landward.z() + inlandZ * depth) + ); + } + + HydrologyCandidateRejection seaCaveAdmission( + SeaCaveSite site, + List accepted, + List courses + ) { + HydrologyPlannerSettings.SeaCaves seaCaves = planner.settings.seaCaves(); + if (site.coastHeight() < seaCaves.minimumCoastHeight()) { + return HydrologyCandidateRejection.SURFACE_HEAD_RANGE; + } + HydrologyPoint landward = site.boundary().landwardPoint(); + long spacingSquared = (long) seaCaves.minimumSpacing() * seaCaves.minimumSpacing(); + for (SeaCaveSite other : accepted) { + if (landward.distanceSquared2D(other.boundary().landwardPoint()) < spacingSquared) { + return HydrologyCandidateRejection.SOURCE_SPACING; + } + } + long clearance = 2L * planner.settings.outlets().coastalGrotto().horizontalRadius() + seaCaves.depth(); + long clearanceSquared = clearance * clearance; + for (RiverCourse course : courses) { + if (course.type() == RiverCourseType.SEA_CAVE) { + continue; + } + for (HydraulicSegment segment : course.segments()) { + if (segment.type() != HydrologyFeatureType.MOUTH + && segment.type() != HydrologyFeatureType.COASTAL_GROTTO + && segment.type() != HydrologyFeatureType.INLAND_GROTTO) { + continue; + } + for (HydrologyPoint point : segment.centerline()) { + if (landward.distanceSquared2D(point) < clearanceSquared) { + return HydrologyCandidateRejection.SOURCE_SPACING; + } + } + } + } + return null; + } + + RiverCourse buildSeaCaveCourse(SeaCaveSite site) { + HydrologyPlannerSettings.Grotto grotto = planner.settings.outlets().coastalGrotto(); + long courseId = HydrologyHash.mix(planner.worldSeed, HydrologySurfaceCoursePlanner.COURSE_SALT, SEA_CAVE_SALT, site.stableId()); + String profileKey = planner.segments.chooseProfile(site.boundary().landwardTerrain(), courseId); + int seaLevel = planner.settingsSeaLevel(site.ocean().terrain()); + // The last point is the ocean connection: the footprint opens the chamber there and nowhere else. + List centerline = planner.segments.line( + HydrologyPlanner.withY(site.inner(), seaLevel), + HydrologyPlanner.withY(site.boundary().oceanPoint(), seaLevel), + planner.settings.routing().refinementSpacing() + ); + ArrayList segments = new ArrayList<>(1); + planner.segments.addFlatSegment( + courseId, + HydrologyFeatureType.COASTAL_GROTTO, + seaLevel, + grotto.horizontalRadius() * 2, + grotto.verticalRadius(), + centerline, + segments + ); + return new RiverCourse( + courseId, + RiverCourseType.SEA_CAVE, + OptionalLong.empty(), + OptionalLong.empty(), + profileKey, + 1, + List.of(), + segments + ); + } + + void addSeaCaveDiagnostic( + SeaCaveSite site, + HydrologyCandidateRejection rejection, + List diagnostics + ) { + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(site.stableId(), HydrologySourcePlanner.DIAGNOSTIC_SALT, rejection.ordinal()), + HydrologyCandidateKind.OUTLET, + HydrologyFeatureType.COASTAL_GROTTO, + site.boundary().landwardPoint(), + rejection, + 0 + )); + } + + /** + * The raster a swept grotto occupies: one ellipsoid plus its central cross-section extruded over the + * sweep. The containment filter measures the real carve; this only refuses chambers that cannot fit. + */ + static long sweptGrottoVolume(HydrologyPlannerSettings.Grotto grotto, int depth) { + int radius = grotto.horizontalRadius(); + long section = 0L; + for (int deltaX = -radius; deltaX <= radius; deltaX++) { + double normalized = Math.min(1D, Math.abs(deltaX) / Math.max(1D, radius)); + double scale = StrictMath.sqrt(Math.max(0D, 1D - normalized * normalized)); + section += (long) StrictMath.ceil(grotto.verticalRadius() * scale) + + (long) StrictMath.floor(grotto.headroom() * scale) + + 1L; + } + return HydrologyPlannerSettings.ellipsoidVolume(radius, grotto.verticalRadius(), grotto.headroom()) + + section * depth; + } + + record SeaCaveSite( + HydrologyGridNode land, + HydrologyGridNode ocean, + HydrologyOceanBoundaryRefiner.Result boundary, + HydrologyPoint inner, + int coastHeight, + long stableId + ) { + } + + void compileDeepFluidCourses( + HydrologyTileKey key, + List courses, + List diagnostics + ) { + for (HydrologyPlannerSettings.DeepFluid deepFluid : planner.settings.deepFluids()) { + if (!deepFluid.enabled() || deepFluid.maximumPerTile() == 0) { + continue; + } + ArrayList sites = deepSites(key, deepFluid, diagnostics); + int target = Math.min( + deepFluid.maximumPerTile(), + planner.sourcePlanner.expectedCount(deepFluid.density(), HydrologyHash.mix( + planner.worldSeed, + DEEP_FLUID_SALT, + HydrologyHash.text(deepFluid.id()), + key.tileX(), + key.tileZ() + )) + ); + for (int index = 0; index < sites.size(); index++) { + DeepSite site = sites.get(index); + if (index >= target) { + addDeepDiagnostic( + deepFluid, + site, + HydrologyCandidateRejection.SOURCE_QUOTA, + diagnostics + ); + continue; + } + RiverCourse course = buildDeepFluidCourse(deepFluid, site, index); + if (course != null) { + courses.add(course); + } else { + addDeepDiagnostic( + deepFluid, + site, + HydrologyCandidateRejection.VOLUME_LIMIT, + diagnostics + ); + } + } + } + } + + ArrayList deepSites( + HydrologyTileKey key, + HydrologyPlannerSettings.DeepFluid deepFluid, + List diagnostics + ) { + int tileSize = planner.settings.routing().tileSize(); + int minimumX = key.minimumBlockX(tileSize); + int minimumZ = key.minimumBlockZ(tileSize); + int spacing = deepFluid.spacing(); + long profileSeed = HydrologyHash.mix(planner.worldSeed, DEEP_FLUID_SALT, HydrologyHash.text(deepFluid.id())); + int xOffset = HydrologyHash.between( + HydrologyHash.mix(profileSeed, DEEP_FLUID_X_OFFSET_SALT), + 0, + spacing - 1 + ); + int zOffset = HydrologyHash.between( + HydrologyHash.mix(profileSeed, DEEP_FLUID_Z_OFFSET_SALT), + 0, + spacing - 1 + ); + long firstCellX = ceilDiv((long) minimumX - xOffset, spacing); + long firstCellZ = ceilDiv((long) minimumZ - zOffset, spacing); + long lastCellX = Math.floorDiv((long) minimumX + tileSize - 1L - xOffset, spacing); + long lastCellZ = Math.floorDiv((long) minimumZ + tileSize - 1L - zOffset, spacing); + ArrayList sites = new ArrayList<>(); + for (long cellZ = firstCellZ; cellZ <= lastCellZ; cellZ++) { + for (long cellX = firstCellX; cellX <= lastCellX; cellX++) { + long stable = HydrologyHash.mix( + planner.worldSeed, + DEEP_FLUID_SALT, + HydrologyHash.text(deepFluid.id()), + cellX, + cellZ + ); + int x = Math.toIntExact(xOffset + cellX * spacing); + int z = Math.toIntExact(zOffset + cellZ * spacing); + int head = planner.sampleGeometry( + HydrologyGeometrySampler.Field.DEEP_FLUID_HEIGHT, + deepFluid.id(), + x, + z, + stable, + deepFluid.minimumY(), + deepFluid.maximumY() + ); + DeepSite site = new DeepSite(x, z, head, stable); + HydrologyTerrainSample terrain = planner.sampleLandBasis(x, z); + int verticalRadius = HydrologyHash.between( + HydrologyHash.mix(stable, 3), + deepFluid.minimumVerticalRadius(), + deepFluid.maximumVerticalRadius() + ); + if (!deepSiteFits(terrain, deepFluid, head, verticalRadius, planner.minimumY)) { + if (terrain != null && !terrain.ocean()) { + addDeepDiagnostic( + deepFluid, + site, + HydrologyCandidateRejection.CAVE_CONTAINMENT, + diagnostics + ); + } + continue; + } + sites.add(site); + } + } + sites.sort(Comparator.comparingLong(DeepSite::stableId)); + return sites; + } + + long ceilDiv(long value, int divisor) { + long quotient = Math.floorDiv(value, divisor); + return quotient * divisor == value ? quotient : quotient + 1L; + } + + static boolean deepSiteFits( + HydrologyTerrainSample terrain, + HydrologyPlannerSettings.DeepFluid deepFluid, + int head, + int verticalRadius, + int minimumY + ) { + if (terrain == null || terrain.ocean()) { + return false; + } + int lowerEnvelope = deepFluid.containedPools() + ? Math.max(deepFluid.channelDepth(), verticalRadius) + : deepFluid.channelDepth(); + return (long) head - lowerEnvelope > minimumY + && head + deepFluid.headroom() < terrain.naturalHeight(); + } + + void addDeepDiagnostic( + HydrologyPlannerSettings.DeepFluid deepFluid, + DeepSite site, + HydrologyCandidateRejection rejection, + List diagnostics + ) { + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(site.stableId(), HydrologySourcePlanner.DIAGNOSTIC_SALT, rejection.ordinal()), + HydrologyCandidateKind.DEEP_FLUID, + deepFluid.containedPools() ? HydrologyFeatureType.DEEP_POOL : HydrologyFeatureType.DEEP_CHANNEL, + new HydrologyPoint(site.x(), site.head(), site.z()), + rejection, 0 + )); + } + + RiverCourse buildDeepFluidCourse( + HydrologyPlannerSettings.DeepFluid deepFluid, + DeepSite site, + int siteIndex + ) { + long courseId = HydrologyHash.mix( + planner.worldSeed, + HydrologySurfaceCoursePlanner.COURSE_SALT, + DEEP_FLUID_SALT, + HydrologyHash.text(deepFluid.id()), + site.stableId(), + siteIndex + ); + int horizontalRadius = HydrologyHash.between( + HydrologyHash.mix(site.stableId(), 2), + deepFluid.minimumHorizontalRadius(), + deepFluid.maximumHorizontalRadius() + ); + int verticalRadius = HydrologyHash.between( + HydrologyHash.mix(site.stableId(), 3), + deepFluid.minimumVerticalRadius(), + deepFluid.maximumVerticalRadius() + ); + ArrayList segments = new ArrayList<>(); + HydrologyPoint center = new HydrologyPoint(site.x(), site.head(), site.z()); + long usedVolume = 0L; + if (deepFluid.containedPools()) { + long poolVolume = HydrologyPlannerSettings.ellipsoidVolume( + horizontalRadius, + Math.max(deepFluid.channelDepth(), verticalRadius), + deepFluid.headroom() + ); + if (poolVolume > deepFluid.maximumVolume()) { + return null; + } + usedVolume = poolVolume; + long poolId = HydrologyHash.mix(planner.worldSeed, HydrologySegmentBuilder.SEGMENT_SALT, courseId, HydrologyFeatureType.DEEP_POOL.ordinal()); + segments.add(new HydraulicSegment( + poolId, + courseId, + HydrologyFeatureType.DEEP_POOL, + site.head(), + site.head(), + horizontalRadius * 2 + 1, + Math.max(deepFluid.channelDepth(), verticalRadius), + false, + false, + List.of(center) + )); + } + if (deepFluid.shortChannels() && deepFluid.maximumChannelLength() > 0) { + int volumeBoundedMaximum = deepFluid.maximumChannelLength(); + while (volumeBoundedMaximum >= deepFluid.minimumChannelLength() + && usedVolume + deepChannelVolumeBound(deepFluid, volumeBoundedMaximum) + > deepFluid.maximumVolume()) { + volumeBoundedMaximum--; + } + if (volumeBoundedMaximum >= deepFluid.minimumChannelLength()) { + int length = HydrologyHash.between( + HydrologyHash.mix(site.stableId(), 4), + deepFluid.minimumChannelLength(), + volumeBoundedMaximum + ); + long channelId = HydrologyHash.mix(planner.worldSeed, HydrologySegmentBuilder.SEGMENT_SALT, courseId, HydrologyFeatureType.DEEP_CHANNEL.ordinal()); + segments.add(new HydraulicSegment( + channelId, + courseId, + HydrologyFeatureType.DEEP_CHANNEL, + site.head(), + site.head(), + deepFluid.channelWidth(), + deepFluid.channelDepth(), + false, + false, + organicDeepChannelCenterline( + center, + length, + planner.settings.routing().refinementSpacing(), + site.stableId() + ) + )); + } + } + if (segments.isEmpty()) { + return null; + } + return new RiverCourse( + courseId, + RiverCourseType.DEEP_FLUID, + OptionalLong.empty(), + OptionalLong.empty(), + deepFluid.id(), + 1, + List.of(), + segments + ); + } + + long deepChannelVolumeBound(HydrologyPlannerSettings.DeepFluid deepFluid, int length) { + int radius = Math.max(1, deepFluid.channelWidth() / 2); + int points = (int) StrictMath.ceil( + length * StrictMath.sqrt(2D) / planner.settings.routing().refinementSpacing() + ) + 1; + long horizontalEnvelope = (long) (radius * 2 + 1) * (radius * 2 + 1); + long verticalEnvelope = deepFluid.channelDepth() + deepFluid.headroom() + 1L; + return horizontalEnvelope * verticalEnvelope * points; + } + + List organicDeepChannelCenterline( + HydrologyPoint start, + int length, + int spacing, + long stableId + ) { + double heading = HydrologyHash.unit(HydrologyHash.mix(stableId, DEEP_CHANNEL_HEADING_SALT)) + * StrictMath.PI * 2D; + double forwardX = StrictMath.cos(heading); + double forwardZ = StrictMath.sin(heading); + double lateralX = -forwardZ; + double lateralZ = forwardX; + double bendEnvelope = Math.max(1.5D, Math.min(8D, length * 0.3D)); + double firstBend = planner.segments.signedOrganicOffset(stableId, DEEP_CHANNEL_FIRST_BEND_SALT, bendEnvelope); + double secondBend = planner.segments.signedOrganicOffset(stableId, DEEP_CHANNEL_SECOND_BEND_SALT, bendEnvelope); + if (StrictMath.signum(firstBend) == StrictMath.signum(secondBend)) { + secondBend = -secondBend; + } + + double endX = start.x() + forwardX * length; + double endZ = start.z() + forwardZ * length; + double firstControlX = start.x() + forwardX * length / 3D + lateralX * firstBend; + double firstControlZ = start.z() + forwardZ * length / 3D + lateralZ * firstBend; + double secondControlX = start.x() + forwardX * length * 2D / 3D + lateralX * secondBend; + double secondControlZ = start.z() + forwardZ * length * 2D / 3D + lateralZ * secondBend; + int steps = Math.max(4, (int) StrictMath.ceil(length / (double) Math.max(2, spacing)) * 2); + ArrayList points = new ArrayList<>(steps + 1); + for (int step = 0; step <= steps; step++) { + double progress = step / (double) steps; + double inverse = 1D - progress; + double x = inverse * inverse * inverse * start.x() + + 3D * inverse * inverse * progress * firstControlX + + 3D * inverse * progress * progress * secondControlX + + progress * progress * progress * endX; + double z = inverse * inverse * inverse * start.z() + + 3D * inverse * inverse * progress * firstControlZ + + 3D * inverse * progress * progress * secondControlZ + + progress * progress * progress * endZ; + HydrologyPoint point = new HydrologyPoint( + (int) StrictMath.round(x), + start.y(), + (int) StrictMath.round(z) + ); + if (points.isEmpty() || point.x() != points.getLast().x() || point.z() != points.getLast().z()) { + points.add(point); + } + } + return List.copyOf(points); + } + + record DeepSite(int x, int z, int head, long stableId) { + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridNode.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridNode.java new file mode 100644 index 000000000..bc7b741b5 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridNode.java @@ -0,0 +1,15 @@ +package art.arcane.iris.engine.hydrology; + +record HydrologyGridNode( + int index, + int gridX, + int gridZ, + int x, + int z, + long id, + HydrologyTerrainSample terrain +) { + HydrologyPoint naturalPoint() { + return new HydrologyPoint(x, terrain.naturalHeight(), z); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridOffset.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridOffset.java new file mode 100644 index 000000000..fe0882653 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyGridOffset.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record HydrologyGridOffset(int x, int z) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOutletPlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOutletPlanner.java new file mode 100644 index 000000000..d7a454af0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOutletPlanner.java @@ -0,0 +1,669 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; +import java.util.HashMap; +import java.util.List; +import java.util.Objects; + +final class HydrologyOutletPlanner { + private final HydrologyPlanner planner; + + HydrologyOutletPlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + static final long NODE_SALT = 0x4e4f4445L; + static final long OUTLET_SALT = 0x4f55544c4554L; + + /** Sea outlet types in the order the coastal budget takes them, one of each type per turn. */ + static final List COASTAL_OUTLET_TYPES = List.of( + HydrologyFeatureType.MOUTH, + HydrologyFeatureType.COASTAL_GROTTO + ); + + static final List CARDINAL_OFFSETS = List.of( + new HydrologyGridOffset(-1, 0), + new HydrologyGridOffset(1, 0), + new HydrologyGridOffset(0, -1), + new HydrologyGridOffset(0, 1) + ); + + HydrologySampledGrid sample(HydrologyTileKey key) { + HydrologyPlannerSettings.Routing routing = planner.settings.routing(); + int ownerMinimumX = key.minimumBlockX(routing.tileSize()); + int ownerMinimumZ = key.minimumBlockZ(routing.tileSize()); + int halo = Math.min( + routing.maximumRouteLength(), + Math.multiplyExact(routing.sampleSpacing(), 2) + ); + int alignedHalo = Math.floorDiv(halo, routing.sampleSpacing()) * routing.sampleSpacing(); + int minimumX = ownerMinimumX - alignedHalo; + int minimumZ = ownerMinimumZ - alignedHalo; + int width = (routing.tileSize() + alignedHalo * 2) / routing.sampleSpacing() + 1; + int nodeCount = Math.multiplyExact(width, width); + HydrologyRoutingTerrainSampler.GridRequest gridRequest = new HydrologyRoutingTerrainSampler.GridRequest( + minimumX, + minimumZ, + width, + routing.sampleSpacing() + ); + HydrologyTerrainSample[] terrainSamples = Objects.requireNonNull( + planner.routingSampler.sampleGrid(gridRequest), + "Hydrology routing terrain sampler returned null" + ); + if (terrainSamples.length != nodeCount) { + throw new IllegalStateException( + "Hydrology routing terrain sampler returned " + terrainSamples.length + + " samples for a " + width + " by " + width + " grid" + ); + } + ArrayList nodes = new ArrayList<>(nodeCount); + for (int gridZ = 0; gridZ < width; gridZ++) { + int z = minimumZ + gridZ * routing.sampleSpacing(); + for (int gridX = 0; gridX < width; gridX++) { + int x = minimumX + gridX * routing.sampleSpacing(); + int index = gridZ * width + gridX; + HydrologyTerrainSample terrain = Objects.requireNonNull( + terrainSamples[index], + "Hydrology routing terrain sampler returned null at " + x + "," + z + ); + long id = HydrologyHash.mix(planner.worldSeed, NODE_SALT, x, z); + nodes.add(new HydrologyGridNode(index, gridX, gridZ, x, z, id, terrain)); + } + } + return new HydrologySampledGrid( + minimumX, + minimumZ, + ownerMinimumX, + ownerMinimumZ, + routing.tileSize(), + width, + routing.sampleSpacing(), + List.copyOf(nodes) + ); + } + + List resolveOutlets( + HydrologyTileKey key, + HydrologySampledGrid grid, + boolean surface, + List diagnostics + ) { + ArrayList oceanCandidates = oceanOutletCandidates(grid, surface); + if (!surface && planner.settings.outlets().inlandGrotto().enabled()) { + addOutletLevelDiagnostics(oceanCandidates, diagnostics); + } + sortOutletCandidates(key, grid, surface, oceanCandidates); + // Sea outlets and inland outlets are budgeted separately: a coast never starves the + // sinkholes behind it and a sinkhole never displaces a mouth. + List selectedOcean = limitOutletsByType( + oceanCandidates, + planner.settings.outlets().maximumCoastalPerTile() + ); + addRejectedOutlets(oceanCandidates, selectedOcean, diagnostics); + if (!planner.settings.outlets().inlandGrotto().enabled()) { + return selectedOcean; + } + boolean[] oceanReachable = outletReachable(grid, oceanCandidates, surface); + ArrayList inlandCandidates = inlandOutletCandidates(grid, oceanReachable); + sortInlandOutletCandidates(grid, inlandCandidates); + List selectedInland = styledInlandOutlets( + grid, + limitOutlets(inlandCandidates, planner.settings.outlets().maximumPerTile()), + surface + ); + addRejectedOutlets(inlandCandidates, selectedInland, diagnostics); + ArrayList selected = new ArrayList<>(selectedOcean.size() + selectedInland.size()); + selected.addAll(selectedOcean); + selected.addAll(selectedInland); + return List.copyOf(selected); + } + + ArrayList oceanOutletCandidates(HydrologySampledGrid grid, boolean surface) { + ArrayList oceanCandidates = new ArrayList<>(); + for (HydrologyGridNode land : grid.nodes()) { + if (land.terrain().ocean() || !land.terrain().transitAllowed() || !land.terrain().outletAllowed()) { + continue; + } + HydrologyGridNode ocean = firstOceanNeighbor(grid, land); + if (ocean == null || !land.terrain().drainsInto(ocean.terrain())) { + // A confined shore only reaches a sea that belongs to its own area. + continue; + } + HydrologyOceanBoundaryRefiner.Result boundary = refineOceanBoundary(land, ocean); + if (boundary == null + || !boundary.landwardTerrain().transitAllowed() + || !boundary.landwardTerrain().outletAllowed()) { + continue; + } + HydrologyFeatureType type = coastalOutletType(boundary.landwardTerrain()); + if (type == null) { + continue; + } + long outletId = HydrologyHash.mix(planner.worldSeed, OUTLET_SALT, land.id(), ocean.id(), type.ordinal()); + int seaLevel = planner.settingsSeaLevel(ocean.terrain()); + RiverOutlet outlet = new RiverOutlet( + outletId, + type, + land.id(), + HydrologyPlanner.withY(boundary.landwardPoint(), seaLevel), + HydrologyPlanner.withY(boundary.oceanPoint(), seaLevel), + seaLevel, + true + ); + oceanCandidates.add(new OutletCandidate(land.index(), ocean.index(), outlet)); + } + return oceanCandidates; + } + + List resolveSurfaceFallbackOutlets(HydrologySampledGrid grid) { + ArrayList oceanCandidates = oceanOutletCandidates(grid, true); + ArrayList inlandCandidates = new ArrayList<>(); + if (planner.settings.outlets().surfaceSinkholesEnabled() + && planner.settings.outlets().inlandGrotto().enabled()) { + inlandCandidates.addAll(styledInlandOutlets( + grid, + inlandOutletCandidates(grid, new boolean[grid.nodes().size()]), + true + )); + } + if (oceanCandidates.isEmpty() && inlandCandidates.isEmpty()) { + return List.of(); + } + sortSurfaceFallbackOutletCandidates(grid, oceanCandidates); + sortSurfaceFallbackOutletCandidates(grid, inlandCandidates); + // Trials alternate sea and inland outlets, sea first: a coast with more mouths than trials + // still gives a sinkhole its turn, and a rejected mouth is retried at the next coast. + ArrayList candidates = new ArrayList<>(oceanCandidates.size() + inlandCandidates.size()); + for (int index = 0; index < Math.max(oceanCandidates.size(), inlandCandidates.size()); index++) { + if (index < oceanCandidates.size()) { + candidates.add(oceanCandidates.get(index)); + } + if (index < inlandCandidates.size()) { + candidates.add(inlandCandidates.get(index)); + } + } + int maximumTrials = Math.max( + HydrologySourcePlanner.OPTIONAL_SOURCE_REJECTIONS_PER_TARGET, + Math.multiplyExact( + Math.max(planner.settings.outlets().maximumPerTile(), planner.settings.outlets().maximumCoastalPerTile()), + 16 + ) + ); + maximumTrials = Math.min(16, maximumTrials); + return limitOutlets(candidates, maximumTrials); + } + + ArrayList inlandOutletCandidates( + HydrologySampledGrid grid, + boolean[] oceanReachable + ) { + ArrayList inlandCandidates = new ArrayList<>(); + for (HydrologyGridNode node : grid.nodes()) { + if (!grid.owns(node.x(), node.z()) + || node.terrain().ocean() || !node.terrain().caveAvailable() + || !node.terrain().transitAllowed() || !node.terrain().outletAllowed() + || oceanReachable[node.index()]) { + continue; + } + InlandConnection connection = inlandConnection(node); + int poolY = HydrologyPlanner.clamp( + connection.terrain().caveFluidY(), + planner.settings.underground().minimumFluidY(), + planner.settings.underground().maximumFluidY() + ); + if (planner.settings.outlets().surfaceSinkholesEnabled() + && node.terrain().naturalHeight() - planner.settings.surface().banks().sink() <= poolY) { + continue; + } + long outletId = HydrologyHash.mix( + planner.worldSeed, + OUTLET_SALT, + node.id(), + connection.point().x(), + connection.point().z(), + HydrologyFeatureType.INLAND_GROTTO.ordinal() + ); + RiverOutlet outlet = new RiverOutlet( + outletId, + HydrologyFeatureType.INLAND_GROTTO, + node.id(), + new HydrologyPoint(node.x(), node.terrain().naturalHeight(), node.z()), + HydrologyPlanner.withY(connection.point(), poolY), + planner.settingsSeaLevel(node.terrain()), + false + ); + inlandCandidates.add(new OutletCandidate(node.index(), -1, outlet)); + } + return inlandCandidates; + } + + void sortInlandOutletCandidates( + HydrologySampledGrid grid, + List inlandCandidates + ) { + inlandCandidates.sort(Comparator + .comparing((OutletCandidate candidate) -> !isDrainageBasin(grid, candidate.landIndex())) + .thenComparingInt((OutletCandidate candidate) -> grid.node(candidate.landIndex()).terrain().naturalHeight()) + .thenComparingLong((OutletCandidate candidate) -> candidate.outlet().id())); + } + + void sortSurfaceFallbackOutletCandidates( + HydrologySampledGrid grid, + List candidates + ) { + HashMap capacities = new HashMap<>(candidates.size()); + for (OutletCandidate candidate : candidates) { + capacities.put(candidate.landIndex(), surfaceOutletCapacity(grid, candidate.landIndex())); + } + candidates.sort(Comparator + .comparing((OutletCandidate candidate) -> !isDrainageBasin(grid, candidate.landIndex())) + .thenComparingInt((OutletCandidate candidate) -> + capacities.get(candidate.landIndex()) > 0L ? 0 : 1) + .thenComparingInt((OutletCandidate candidate) -> ownedOutletRank(grid, candidate)) + .thenComparing(Comparator + .comparingLong((OutletCandidate candidate) -> capacities.get(candidate.landIndex())) + .reversed()) + .thenComparingInt((OutletCandidate candidate) -> + grid.node(candidate.landIndex()).terrain().naturalHeight()) + .thenComparingLong((OutletCandidate candidate) -> candidate.outlet().id())); + } + + boolean isDrainageBasin(HydrologySampledGrid grid, int nodeIndex) { + HydrologyGridNode node = grid.node(nodeIndex); + int height = node.terrain().naturalHeight(); + for (HydrologyGridOffset offset : HydrologySourcePlanner.ROUTING_OFFSETS) { + HydrologyGridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); + if (neighbor != null + && !neighbor.terrain().ocean() + && neighbor.terrain().transitAllowed() + && neighbor.terrain().naturalHeight() < height) { + return false; + } + } + return true; + } + + boolean[] outletReachable(HydrologySampledGrid grid, List outlets, boolean surface) { + int maximumRise = surface ? planner.sourcePlanner.maximumSurfaceEdgeRise() : Integer.MAX_VALUE; + boolean[] reachable = new boolean[grid.nodes().size()]; + int[] queue = new int[reachable.length]; + int readIndex = 0; + int writeIndex = 0; + for (OutletCandidate outlet : outlets) { + if (reachable[outlet.landIndex()]) { + continue; + } + reachable[outlet.landIndex()] = true; + queue[writeIndex++] = outlet.landIndex(); + } + while (readIndex < writeIndex) { + HydrologyGridNode node = grid.node(queue[readIndex++]); + for (HydrologyGridOffset offset : HydrologySourcePlanner.ROUTING_OFFSETS) { + HydrologyGridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); + if (neighbor == null || reachable[neighbor.index()] || neighbor.terrain().ocean() + || !neighbor.terrain().transitAllowed() + || node.terrain().naturalHeight() - neighbor.terrain().naturalHeight() > maximumRise) { + continue; + } + reachable[neighbor.index()] = true; + queue[writeIndex++] = neighbor.index(); + } + } + return reachable; + } + + List styledInlandOutlets( + HydrologySampledGrid grid, + List candidates, + boolean surface + ) { + ArrayList styled = new ArrayList<>(candidates.size()); + for (OutletCandidate candidate : candidates) { + HydrologyGridNode node = grid.node(candidate.landIndex()); + RiverOutlet outlet = candidate.outlet(); + HydrologyPoint landward = planner.routeGeometry.routeAnchor(node); + HydrologyTerrainSample landwardTerrain = Objects.requireNonNull( + planner.sampleDetailed(landward.x(), landward.z()), + "Hydrology inland outlet anchor left sampled terrain" + ); + int connectionOffsetX = Integer.compare(outlet.connectionPoint().x(), outlet.landwardPoint().x()); + int connectionOffsetZ = Integer.compare(outlet.connectionPoint().z(), outlet.landwardPoint().z()); + HydrologyPoint connection = new HydrologyPoint( + landward.x() + connectionOffsetX, + outlet.connectionPoint().y(), + landward.z() + connectionOffsetZ + ); + int poolY = planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, + "", + connection.x(), + connection.z(), + 0L, + planner.settings.underground().minimumFluidY(), + planner.settings.underground().maximumFluidY() + ); + if (surface && planner.settings.outlets().surfaceSinkholesEnabled()) { + poolY = Math.min( + poolY, + landwardTerrain.naturalHeight() - planner.settings.surface().banks().sink() - 1 + ); + poolY = Math.max( + poolY, + landwardTerrain.naturalHeight() - planner.settings.routing().sampleSpacing() + ); + } + styled.add(new OutletCandidate( + candidate.landIndex(), + candidate.oceanIndex(), + new RiverOutlet( + outlet.id(), + outlet.type(), + outlet.drainageNodeId(), + HydrologyPlanner.withY(landward, landwardTerrain.naturalHeight()), + HydrologyPlanner.withY(connection, poolY), + outlet.seaLevel(), + outlet.directOcean() + ) + )); + } + return List.copyOf(styled); + } + + InlandConnection inlandConnection(HydrologyGridNode node) { + HydrologyGridOffset offset = CARDINAL_OFFSETS.getFirst(); + long selectedTie = inlandConnectionTie(node, offset); + for (int index = 1; index < CARDINAL_OFFSETS.size(); index++) { + HydrologyGridOffset candidate = CARDINAL_OFFSETS.get(index); + long candidateTie = inlandConnectionTie(node, candidate); + if (candidateTie < selectedTie) { + offset = candidate; + selectedTie = candidateTie; + } + } + HydrologyTerrainSample terrain = node.terrain(); + return new InlandConnection( + new HydrologyPoint( + node.x() + offset.x(), + terrain.caveFluidY(), + node.z() + offset.z() + ), + terrain + ); + } + + long inlandConnectionTie(HydrologyGridNode node, HydrologyGridOffset offset) { + return HydrologyHash.mix( + planner.worldSeed, + OUTLET_SALT, + node.id(), + node.x() + offset.x(), + node.z() + offset.z() + ); + } + + HydrologyGridNode firstOceanNeighbor(HydrologySampledGrid grid, HydrologyGridNode land) { + ArrayList oceans = new ArrayList<>(); + for (HydrologyGridOffset offset : CARDINAL_OFFSETS) { + HydrologyGridNode neighbor = grid.nodeAt(land.gridX() + offset.x(), land.gridZ() + offset.z()); + if (neighbor != null && neighbor.terrain().ocean()) { + oceans.add(neighbor); + } + } + oceans.sort(Comparator.comparingLong(HydrologyGridNode::id)); + return oceans.isEmpty() ? null : oceans.getFirst(); + } + + HydrologyOceanBoundaryRefiner.Result refineOceanBoundary(HydrologyGridNode land, HydrologyGridNode ocean) { + List crossing = planner.segments.line(land.naturalPoint(), ocean.naturalPoint(), 1); + return HydrologyOceanBoundaryRefiner.refine(crossing, planner.sampler, planner.routingSampler); + } + + HydrologyFeatureType coastalOutletType(HydrologyTerrainSample land) { + HydrologyPlannerSettings.Outlets outlets = planner.settings.outlets(); + // A zero slope factor turns the slope rule off, so only the coast's height over the sea decides. + boolean cliff = land.naturalHeight() - planner.settingsSeaLevel(land) + >= outlets.coastalCliffMinimumHeight() + || outlets.coastalCliffSlopeFactor() > 0D + && land.slope() >= outlets.coastalCliffMinimumHeight() * outlets.coastalCliffSlopeFactor(); + if (cliff && outlets.coastalGrotto().enabled()) { + return HydrologyFeatureType.COASTAL_GROTTO; + } + return outlets.oceanEnabled() ? HydrologyFeatureType.MOUTH : null; + } + + Comparator outletComparator(HydrologyTileKey key) { + long tileHash = HydrologyHash.mix(planner.worldSeed, key.tileX(), key.tileZ(), OUTLET_SALT); + return Comparator.comparingLong((OutletCandidate candidate) -> HydrologyHash.mix(tileHash, candidate.outlet().id())); + } + + void sortOutletCandidates( + HydrologyTileKey key, + HydrologySampledGrid grid, + boolean surface, + List candidates + ) { + // An owned coast outranks a neighbour's: a halo mouth only takes a slot when no owned + // coast can serve the tile's sources. + Comparator owned = Comparator.comparingInt( + (OutletCandidate candidate) -> ownedOutletRank(grid, candidate)); + if (!surface) { + candidates.sort(owned.thenComparing(outletComparator(key))); + return; + } + HashMap capacities = new HashMap<>(candidates.size()); + for (OutletCandidate candidate : candidates) { + capacities.put(candidate.landIndex(), surfaceOutletCapacity(grid, candidate.landIndex())); + } + Comparator stable = outletComparator(key); + candidates.sort(Comparator + .comparingInt((OutletCandidate candidate) -> + capacities.get(candidate.landIndex()) > 0L ? 0 : 1) + .thenComparing(owned) + .thenComparingInt(this::surfaceOutletPriority) + .thenComparing(Comparator + .comparingLong((OutletCandidate candidate) -> capacities.get(candidate.landIndex())) + .reversed()) + .thenComparing(stable)); + } + + int ownedOutletRank(HydrologySampledGrid grid, OutletCandidate candidate) { + HydrologyGridNode land = grid.node(candidate.landIndex()); + return grid.owns(land.x(), land.z()) ? 0 : 1; + } + + int surfaceOutletPriority(OutletCandidate candidate) { + return switch (candidate.outlet().type()) { + case MOUTH -> 0; + case COASTAL_GROTTO -> 1; + case INLAND_GROTTO -> 2; + default -> 3; + }; + } + + long surfaceOutletCapacity(HydrologySampledGrid grid, int outletNodeIndex) { + boolean[] visited = new boolean[grid.nodes().size()]; + int[] distances = new int[grid.nodes().size()]; + Arrays.fill(distances, -1); + int[] queue = new int[visited.length]; + int readIndex = 0; + int writeIndex = 0; + visited[outletNodeIndex] = true; + distances[outletNodeIndex] = 0; + queue[writeIndex++] = outletNodeIndex; + long capacity = 0L; + while (readIndex < writeIndex) { + HydrologyGridNode downstream = grid.node(queue[readIndex++]); + if (grid.owns(downstream.x(), downstream.z()) + && downstream.terrain().surfaceSourceAllowed() + && downstream.terrain().naturalHeight() >= planner.settings.surface().sources().minimumElevation() + && distances[downstream.index()] + >= planner.settings.routing().minimumSurfaceCourseLength()) { + capacity = Math.addExact( + capacity, + 1_000_000L + + distances[downstream.index()] + + Math.max(0, downstream.terrain().naturalHeight() - planner.settings.seaLevel()) + ); + } + for (HydrologyGridOffset offset : HydrologySourcePlanner.ROUTING_OFFSETS) { + HydrologyGridNode upstream = grid.nodeAt( + downstream.gridX() + offset.x(), + downstream.gridZ() + offset.z() + ); + if (upstream == null + || visited[upstream.index()] + || upstream.terrain().ocean() + || !upstream.terrain().transitAllowed()) { + continue; + } + visited[upstream.index()] = true; + distances[upstream.index()] = Math.addExact( + distances[downstream.index()], + planner.settings.routing().sampleSpacing() + ); + queue[writeIndex++] = upstream.index(); + } + } + return capacity; + } + + List limitOutlets(List candidates, int maximum) { + if (maximum <= 0 || candidates.isEmpty()) { + return List.of(); + } + ArrayList selected = new ArrayList<>(Math.min(maximum, candidates.size())); + long minimumSpacingSquared = outletSpacingSquared(); + for (OutletCandidate candidate : candidates) { + if (!withinOutletSpacing(candidate, selected, minimumSpacingSquared)) { + selected.add(candidate); + if (selected.size() == maximum) { + break; + } + } + } + if (selected.isEmpty() && !candidates.isEmpty()) { + selected.add(candidates.getFirst()); + } + return List.copyOf(selected); + } + + /** + * Takes sea outlets in turns by type (the best mouth, the best coastal grotto, the next mouth, ...) + * from a sorted candidate list until the budget is spent or no type has a candidate left that + * keeps the outlet spacing. A coast with both cliffs and beaches gets both kinds of opening. + */ + List limitOutletsByType(List candidates, int maximum) { + if (maximum <= 0 || candidates.isEmpty()) { + return List.of(); + } + ArrayList selected = new ArrayList<>(Math.min(maximum, candidates.size())); + long minimumSpacingSquared = outletSpacingSquared(); + boolean[] consumed = new boolean[candidates.size()]; + boolean progressed = true; + while (selected.size() < maximum && progressed) { + progressed = false; + for (HydrologyFeatureType type : COASTAL_OUTLET_TYPES) { + for (int index = 0; index < candidates.size(); index++) { + OutletCandidate candidate = candidates.get(index); + if (consumed[index] || candidate.outlet().type() != type) { + continue; + } + consumed[index] = true; + if (withinOutletSpacing(candidate, selected, minimumSpacingSquared)) { + continue; + } + selected.add(candidate); + progressed = true; + break; + } + if (selected.size() == maximum) { + break; + } + } + } + return List.copyOf(selected); + } + + long outletSpacingSquared() { + int minimumSpacing = planner.settings.routing().sampleSpacing() * 2; + return (long) minimumSpacing * minimumSpacing; + } + + boolean withinOutletSpacing( + OutletCandidate candidate, + List selected, + long minimumSpacingSquared + ) { + for (OutletCandidate existing : selected) { + if (candidate.outlet().landwardPoint().distanceSquared2D(existing.outlet().landwardPoint()) + < minimumSpacingSquared) { + return true; + } + } + return false; + } + + void addRejectedOutlets( + List candidates, + List selected, + List diagnostics + ) { + for (OutletCandidate candidate : candidates) { + boolean accepted = false; + for (OutletCandidate acceptedCandidate : selected) { + if (candidate.outlet().id() == acceptedCandidate.outlet().id()) { + accepted = true; + break; + } + } + if (!accepted) { + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(candidate.outlet().id(), HydrologySourcePlanner.DIAGNOSTIC_SALT), + HydrologyCandidateKind.OUTLET, + candidate.outlet().type(), + candidate.outlet().landwardPoint(), + HydrologyCandidateRejection.OUTLET_LIMIT, 0 + )); + } + } + } + + /** + * Drops the sea outlets an underground river cannot reach because the sea sits above the + * underground fluid ceiling, reporting each as OUTLET_LEVEL with the shortfall as the detail. + */ + void addOutletLevelDiagnostics( + List candidates, + List diagnostics + ) { + int maximumFluidY = planner.settings.underground().maximumFluidY(); + ArrayList retained = new ArrayList<>(candidates.size()); + for (OutletCandidate candidate : candidates) { + int seaY = candidate.outlet().connectionPoint().y(); + if (seaY <= maximumFluidY) { + retained.add(candidate); + continue; + } + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix( + candidate.outlet().id(), + HydrologySourcePlanner.DIAGNOSTIC_SALT, + HydrologyCandidateRejection.OUTLET_LEVEL.ordinal() + ), + HydrologyCandidateKind.OUTLET, + candidate.outlet().type(), + candidate.outlet().landwardPoint(), + HydrologyCandidateRejection.OUTLET_LEVEL, + seaY - maximumFluidY + )); + } + candidates.clear(); + candidates.addAll(retained); + } + + record InlandConnection(HydrologyPoint point, HydrologyTerrainSample terrain) { + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOwnerDraft.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOwnerDraft.java new file mode 100644 index 000000000..0d6efa9ce --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyOwnerDraft.java @@ -0,0 +1,17 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record HydrologyOwnerDraft( + HydrologyTileKey key, + HydrologyCaveCourseFilter.Result result, + List diagnostics, + HydrologyFootprintCompiler footprintCompiler +) { + HydrologyOwnerDraft withoutFootprintCompiler() { + if (footprintCompiler == null) { + return this; + } + return new HydrologyOwnerDraft(key, result, diagnostics, null); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyPlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyPlanner.java index 238a5186e..d26be25b7 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyPlanner.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyPlanner.java @@ -1,17 +1,8 @@ package art.arcane.iris.engine.hydrology; -import art.arcane.iris.engine.hydrology.cave.CavePosition; import art.arcane.iris.engine.hydrology.cave.CaveVoxelView; -import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCandidate; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveContainmentPlanner; -import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlan; -import art.arcane.iris.engine.hydrology.surface.ChannelProfile; -import art.arcane.iris.engine.hydrology.surface.ValleyProfile; -import art.arcane.iris.engine.hydrology.surface.ValleyProfileSolver; -import art.arcane.iris.engine.hydrology.surface.SurfaceCenterline; import art.arcane.iris.engine.hydrology.surface.SurfaceCourseBuilder; -import art.arcane.iris.engine.hydrology.surface.SurfaceCourseResult; -import art.arcane.iris.engine.hydrology.surface.SurfaceTerminal; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.util.common.parallel.MultiBurst; @@ -19,125 +10,58 @@ import art.arcane.iris.util.project.noise.SimplexNoise; import com.github.benmanes.caffeine.cache.Cache; import com.github.benmanes.caffeine.cache.Caffeine; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; -import it.unimi.dsi.fastutil.longs.LongIterator; -import it.unimi.dsi.fastutil.longs.LongOpenHashSet; import java.util.ArrayList; -import java.util.Arrays; import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.IdentityHashMap; import java.util.LinkedHashMap; -import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Objects; -import java.util.OptionalLong; -import java.util.PriorityQueue; import java.util.Set; import java.util.concurrent.Callable; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionException; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ForkJoinWorkerThread; -import java.util.function.IntPredicate; public final class HydrologyPlanner { - private static final long NODE_SALT = 0x4e4f4445L; - private static final double CROSS_DROP_WEIGHT = 3D; - private static final long OUTLET_SALT = 0x4f55544c4554L; - /** Sea outlet types in the order the coastal budget takes them, one of each type per turn. */ - private static final List COASTAL_OUTLET_TYPES = List.of( - HydrologyFeatureType.MOUTH, - HydrologyFeatureType.COASTAL_GROTTO - ); - private static final long EDGE_SALT = 0x45444745L; - private static final long SURFACE_SOURCE_SALT = 0x53555246414345L; - private static final long UNDERGROUND_SOURCE_SALT = 0x554e444552L; - private static final long COURSE_SALT = 0x434f55525345L; - private static final long SEGMENT_SALT = 0x5345474d454e54L; - private static final int TRIBUTARY_JUNCTION_ATTEMPTS = 4; - private static final int TRIBUTARY_BACKWATER_LIMIT = 3; - private static final int TRIBUTARY_JUNCTION_FLAT_STATIONS = 6; - private static final int TRIBUTARY_JUNCTION_PAIR_INDEX = 0x4a4f494e; - private static final long DEEP_FLUID_SALT = 0x44454550464cL; - private static final long SURFACE_POOL_SALT = 0x504f4f4cL; - private static final long SEA_CAVE_SALT = 0x534541434156L; - private static final long DEEP_FLUID_X_OFFSET_SALT = 0x44454550584fL; - private static final long DEEP_FLUID_Z_OFFSET_SALT = 0x444545505a4fL; - private static final long DEEP_CHANNEL_HEADING_SALT = 0x44454550484447L; - private static final long DEEP_CHANNEL_FIRST_BEND_SALT = 0x444545504231L; - private static final long DEEP_CHANNEL_SECOND_BEND_SALT = 0x444545504232L; - private static final long GRADED_DROP_APPROACH_SALT = 0x474441505052L; - private static final long GRADED_DROP_RUN_SALT = 0x474452554eL; - private static final long GRADED_DROP_OUTFLOW_SALT = 0x47444f5554L; - private static final long DIAGNOSTIC_SALT = 0x444941474e4f5354L; - private static final long ROUTE_ANCHOR_X_SALT = 0x52414e434858L; - private static final long ROUTE_ANCHOR_Z_SALT = 0x52414e43485aL; - private static final long ROUTE_WORM_PRIMARY_SALT = 0x52575052494dL; - private static final long ROUTE_WORM_DETAIL_SALT = 0x525744455441L; - private static final int ROUTING_CONTEXT_CACHE_SIZE = 64; - private static final int RESOLVED_OWNER_CACHE_SIZE = 64; - private static final int REFINED_EDGE_CACHE_SIZE = 4096; - private static final double ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO = 0.32D; - private static final double ROUTE_TANGENT_SCALE = 0.68D; - private static final int ROUTE_TRANSVERSE_CANDIDATES = 2; - private static final int ROUTE_FALLBACK_TRANSVERSE_CANDIDATES = 4; - private static final int SURFACE_COURSE_TRANSVERSE_CANDIDATES = 2; - private static final int OPTIONAL_SOURCE_REJECTIONS_PER_TARGET = 4; - private static final int SURFACE_OPTIONAL_SOURCE_REJECTIONS_PER_TARGET = 8; - private static final double SURFACE_MAXIMUM_RENDERED_TURN_DEGREES = 50D; - private static final double SURFACE_MAXIMUM_ISOLATED_TURN_DEGREES = 35D; - private static final double SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES = 10D; - private static final double SURFACE_MAXIMUM_P95_TURN_DEGREES = 35D; - private static final double SURFACE_MAXIMUM_SINUOSITY = 1.45D; - private static final double SURFACE_GRID_LOCK_TOLERANCE_DEGREES = 5D; - private static final double SURFACE_MAXIMUM_GRID_LOCKED_FRACTION = 0.5D; - private static final double SURFACE_MAXIMUM_GRID_LOCKED_RUN = 64D; - private static final double SURFACE_COURSE_MAXIMUM_TURN_DEGREES = 50D; - private static final double SURFACE_COURSE_TURN_COST = 2.5D; - private static final double SURFACE_MAXIMUM_WIDTH_SCALE = 1.18D; - private static final int SURFACE_MINIMUM_NATURAL_BANK_RISE = 1; - private static final int MAXIMUM_SURFACE_BORE_STEP = 4; - private static final List CARDINAL_OFFSETS = List.of( - new GridOffset(-1, 0), - new GridOffset(1, 0), - new GridOffset(0, -1), - new GridOffset(0, 1) - ); - private static final List ROUTING_OFFSETS = List.of( - new GridOffset(-1, 0), - new GridOffset(1, 0), - new GridOffset(0, -1), - new GridOffset(0, 1), - new GridOffset(-1, -1), - new GridOffset(-1, 1), - new GridOffset(1, -1), - new GridOffset(1, 1) - ); - - private final long worldSeed; - private final HydrologyPlannerSettings settings; - private final HydrologyTerrainSampler sampler; - private final HydrologyRoutingTerrainSampler routingSampler; - private final HydrologyNaturalTerrainSampler naturalSampler; - private final HydrologyGeometrySampler geometrySampler; - private final int minimumY; - private final HydrologyCaveVoxelViewFactory caveViewFactory; - private final Cache routingContexts; - private final ConcurrentHashMap resolvingRoutingContexts; - private final Cache resolvedOwners; - private final Cache> refinedEdgeCache; - private final ConcurrentHashMap> resolvingOwners; - private final ThreadLocal planningSamples; - private final ThreadLocal draftProfiles; - private final SimplexNoise routeAnchorX; - private final SimplexNoise routeAnchorZ; - private final SimplexNoise routeWormPrimary; - private final SimplexNoise routeWormDetail; - private final SurfaceCourseBuilder surfaceCourseBuilder; - private final SurfaceCourseBuilder tributaryCourseBuilder; + static final int ROUTING_CONTEXT_CACHE_SIZE = 64; + static final int RESOLVED_OWNER_CACHE_SIZE = 64; + static final int REFINED_EDGE_CACHE_SIZE = 4096; + final long worldSeed; + final HydrologyPlannerSettings settings; + final HydrologyTerrainSampler sampler; + final HydrologyRoutingTerrainSampler routingSampler; + final HydrologyNaturalTerrainSampler naturalSampler; + final HydrologyGeometrySampler geometrySampler; + final int minimumY; + final HydrologyCaveVoxelViewFactory caveViewFactory; + final Cache routingContexts; + final ConcurrentHashMap resolvingRoutingContexts; + final Cache resolvedOwners; + final Cache> refinedEdgeCache; + final ConcurrentHashMap> resolvingOwners; + final ThreadLocal planningSamples; + final ThreadLocal draftProfiles; + final SimplexNoise routeAnchorX; + final SimplexNoise routeAnchorZ; + final SimplexNoise routeWormPrimary; + final SimplexNoise routeWormDetail; + final SurfaceCourseBuilder surfaceCourseBuilder; + final SurfaceCourseBuilder tributaryCourseBuilder; + final HydrologyCrossTileResolver crossTile; + final HydrologyOutletPlanner outletPlanner; + final HydrologySourcePlanner sourcePlanner; + final HydrologyRouteGeometry routeGeometry; + final HydrologyRoutePath routePaths; + final HydrologySurfaceCoursePlanner surfaceCourses; + final HydrologyTributaryPlanner tributaries; + final HydrologyUndergroundCoursePlanner undergroundCourses; + final HydrologySegmentBuilder segments; + final HydrologyFeatureSitePlanner featureSites; public HydrologyPlanner(long worldSeed, HydrologyPlannerSettings settings, HydrologyTerrainSampler sampler) { this( @@ -250,10 +174,10 @@ public final class HydrologyPlanner { this.resolvingOwners = new ConcurrentHashMap<>(); this.planningSamples = new ThreadLocal<>(); this.draftProfiles = new ThreadLocal<>(); - this.routeAnchorX = new SimplexNoise(HydrologyHash.mix(worldSeed, ROUTE_ANCHOR_X_SALT)); - this.routeAnchorZ = new SimplexNoise(HydrologyHash.mix(worldSeed, ROUTE_ANCHOR_Z_SALT)); - this.routeWormPrimary = new SimplexNoise(HydrologyHash.mix(worldSeed, ROUTE_WORM_PRIMARY_SALT)); - this.routeWormDetail = new SimplexNoise(HydrologyHash.mix(worldSeed, ROUTE_WORM_DETAIL_SALT)); + this.routeAnchorX = new SimplexNoise(HydrologyHash.mix(worldSeed, HydrologyRouteGeometry.ROUTE_ANCHOR_X_SALT)); + this.routeAnchorZ = new SimplexNoise(HydrologyHash.mix(worldSeed, HydrologyRouteGeometry.ROUTE_ANCHOR_Z_SALT)); + this.routeWormPrimary = new SimplexNoise(HydrologyHash.mix(worldSeed, HydrologyRouteGeometry.ROUTE_WORM_PRIMARY_SALT)); + this.routeWormDetail = new SimplexNoise(HydrologyHash.mix(worldSeed, HydrologyRouteGeometry.ROUTE_WORM_DETAIL_SALT)); this.surfaceCourseBuilder = new SurfaceCourseBuilder( settings.surface(), this::sampleBasisWithoutSlope, @@ -268,7 +192,16 @@ public final class HydrologyPlanner { geometrySampler, settings.seaLevel(), settings.routing().minimumSurfaceCourseLength() / 2 - ); + ); this.crossTile = new HydrologyCrossTileResolver(this); + this.outletPlanner = new HydrologyOutletPlanner(this); + this.sourcePlanner = new HydrologySourcePlanner(this); + this.routeGeometry = new HydrologyRouteGeometry(this); + this.routePaths = new HydrologyRoutePath(this); + this.surfaceCourses = new HydrologySurfaceCoursePlanner(this); + this.tributaries = new HydrologyTributaryPlanner(this); + this.undergroundCourses = new HydrologyUndergroundCoursePlanner(this); + this.segments = new HydrologySegmentBuilder(this); + this.featureSites = new HydrologyFeatureSitePlanner(this); } public long worldSeed() { @@ -304,7 +237,7 @@ public final class HydrologyPlanner { long started = System.nanoTime(); CrossTileResolution resolution = resolveCrossTileOwner(key); long materializeStarted = System.nanoTime(); - HydrologyTile tile = materializeAcceptedTile(resolution); + HydrologyTile tile = crossTile.materializeAcceptedTile(resolution); long finished = System.nanoTime(); IrisLogging.debug( "Hydrology tile %d,%d planned in %dms: owners=%d resolve=%dms materialize=%dms courses=%d on %s", @@ -347,404 +280,7 @@ public final class HydrologyPlanner { resolvedOwners.put(tile.key(), new CrossTileResolvedOwner(draft, List.of())); } - private HydrologyOwnerDraft compileOwnerDraft( - HydrologyTileKey key, - CrossTileDraftAdmission crossTileAdmission, - boolean retainFootprintCompiler - ) { - PlanningSamples previous = planningSamples.get(); - if (previous == null) { - planningSamples.set(new PlanningSamples()); - } - DraftProfile previousProfile = draftProfiles.get(); - DraftProfile profile = new DraftProfile(); - draftProfiles.set(profile); - long started = System.nanoTime(); - try { - HydrologyOwnerDraft draft = compileScopedOwnerDraft( - key, - crossTileAdmission, - retainFootprintCompiler - ); - profile.log(key, ownerColorRank(key), System.nanoTime() - started); - return draft; - } finally { - if (previous == null) { - planningSamples.remove(); - } - if (previousProfile == null) { - draftProfiles.remove(); - } else { - draftProfiles.set(previousProfile); - } - } - } - - private HydrologyOwnerDraft compileScopedOwnerDraft( - HydrologyTileKey key, - CrossTileDraftAdmission crossTileAdmission, - boolean retainFootprintCompiler - ) { - Objects.requireNonNull(key, "key"); - ArrayList diagnostics = new ArrayList<>(); - SampledGrid grid = null; - RoutingPlan surfaceRouting = null; - RoutingPlan undergroundRouting = null; - SourceSelection surfaceSelection = SourceSelection.empty(true); - SourceSelection undergroundSelection = SourceSelection.empty(false); - DraftProfile profile = currentDraftProfile(); - long phaseStarted = System.nanoTime(); - if (hasRoutedSourceSearch()) { - SourceRoutingContext primaryContext = sourceRoutingContext(key); - phaseStarted = profile.record(DraftPhase.CONTEXT, phaseStarted); - grid = primaryContext.grid(); - surfaceRouting = primaryContext.surfaceRouting(); - undergroundRouting = primaryContext.undergroundRouting(); - diagnostics.addAll(primaryContext.diagnostics()); - HashMap sourceRoutingContexts = new HashMap<>(); - sourceRoutingContexts.put(key, primaryContext); - surfaceSelection = selectSources( - key, - grid, - surfaceRouting, - true, - true, - diagnostics, - sourceRoutingContexts - ); - undergroundSelection = selectSources( - key, - grid, - undergroundRouting, - false, - true, - diagnostics, - sourceRoutingContexts - ); - phaseStarted = profile.record(DraftPhase.SELECT, phaseStarted); - if (crossTileAdmission != null && (!surfaceSelection.selectedCandidateIndices.isEmpty() - || !undergroundSelection.selectedCandidateIndices.isEmpty())) { - crossTileAdmission.prepare(); - } - } - HydrologyFootprintCompiler footprintCompiler = new HydrologyFootprintCompiler( - settings, - new HydrologyFootprintCompiler.Sampling( - sampler, - geometrySampler, - naturalSampler - ) - ); - HashMap> refinedEdges = new HashMap<>(); - HashMap sourceCompilations = new HashMap<>(); - settleSelection( - key, - grid, - surfaceRouting, - undergroundRouting, - surfaceSelection, - true, - footprintCompiler, - refinedEdges, - sourceCompilations, - diagnostics - ); - settleSelection( - key, - grid, - surfaceRouting, - undergroundRouting, - undergroundSelection, - false, - footprintCompiler, - refinedEdges, - sourceCompilations, - diagnostics - ); - phaseStarted = profile.record(DraftPhase.SETTLE, phaseStarted); - PublicationAttempt publication = null; - List fallbackOutlets = grid == null || surfaceRouting == null - ? List.of() - : resolveSurfaceFallbackOutlets(grid); - int fallbackOutletIndex = 0; - while (true) { - int maximumPublicationPasses = Math.addExact( - 1, - Math.addExact( - surfaceSelection.candidateCount(), - undergroundSelection.candidateCount() - ) - ); - for (int publicationPass = 0; publicationPass < maximumPublicationPasses; publicationPass++) { - publication = compilePublication( - key, - grid, - surfaceRouting, - undergroundRouting, - surfaceSelection, - undergroundSelection, - footprintCompiler, - refinedEdges, - sourceCompilations, - true - ); - diagnostics.addAll(publication.diagnostics()); - if (crossTileAdmission != null) { - CrossTilePublicationAdmission admitted = crossTileAdmission.admit(publication.result()); - publication = new PublicationAttempt(admitted.result(), publication.diagnostics()); - diagnostics.addAll(admitted.diagnostics()); - } - if (grid == null) { - break; - } - boolean surfaceChanged = surfaceSelection.advanceAfterPublication( - publication.result().courses(), - grid - ); - boolean undergroundChanged = undergroundSelection.advanceAfterPublication( - publication.result().courses(), - grid - ); - if (!surfaceChanged && !undergroundChanged) { - break; - } - if (surfaceChanged) { - settleSelection( - key, - grid, - surfaceRouting, - undergroundRouting, - surfaceSelection, - true, - footprintCompiler, - refinedEdges, - sourceCompilations, - diagnostics - ); - } - if (undergroundChanged) { - settleSelection( - key, - grid, - surfaceRouting, - undergroundRouting, - undergroundSelection, - false, - footprintCompiler, - refinedEdges, - sourceCompilations, - diagnostics - ); - } - if (publicationPass + 1 >= maximumPublicationPasses) { - throw new IllegalStateException("Hydrology source publication exceeded its candidate bound."); - } - } - if (grid == null || !surfaceSelection.needsSurfaceFallback()) { - break; - } - boolean fallbackSelected = false; - while (fallbackOutletIndex < fallbackOutlets.size()) { - OutletCandidate fallbackOutlet = fallbackOutlets.get(fallbackOutletIndex++); - RoutingPlan fallbackRouting = requireOrganicSurface(buildRouting(grid, List.of(fallbackOutlet), true)); - HashMap fallbackContexts = new HashMap<>(); - fallbackContexts.put(key, new SourceRoutingContext( - grid, - fallbackRouting, - undergroundRouting, - List.of() - )); - SourceSelection fallbackSelection = selectSources( - key, - grid, - fallbackRouting, - true, - false, - diagnostics, - fallbackContexts - ); - settleSelection( - key, - grid, - fallbackRouting, - undergroundRouting, - fallbackSelection, - true, - footprintCompiler, - refinedEdges, - sourceCompilations, - diagnostics - ); - if (!fallbackSelection.hasAcceptedSelection()) { - continue; - } - surfaceRouting = fallbackRouting; - surfaceSelection = fallbackSelection; - fallbackSelected = true; - break; - } - if (!fallbackSelected) { - break; - } - } - profile.record(DraftPhase.PUBLISH, phaseStarted); - if (publication == null) { - throw new IllegalStateException("Hydrology publication did not execute."); - } - if (grid != null) { - surfaceSelection.addFinalAdmissionDiagnostics(grid, diagnostics); - undergroundSelection.addFinalAdmissionDiagnostics(grid, diagnostics); - } - HydrologyCaveCourseFilter.Result result = publication.result(); - List uniqueDiagnostics = uniqueDiagnostics(diagnostics); - HydrologyOwnerDraft draft = new HydrologyOwnerDraft( - key, - result, - uniqueDiagnostics, - retainFootprintCompiler ? footprintCompiler : null - ); - validateOwnerDraftReach(draft); - return draft; - } - - private HydrologyTile materializeAcceptedTile(CrossTileResolution resolution) { - HydrologyCaveCourseFilter.Result result = resolution.draft().result(); - ArrayList diagnostics = new ArrayList<>(resolution.draft().diagnostics()); - for (CrossTileRejectedCourse rejection : resolution.observedRejections()) { - diagnostics.add(rejection.course().type() == RiverCourseType.SURFACE - ? surfaceConflictDiagnostic(rejection.course(), rejection.winnerSourceId()) - : HydrologyCaveCourseFilter.overlapDiagnostic( - rejection.course(), - rejection.winnerSourceId() - )); - } - HydrologyFootprintCompiler footprintCompiler = resolution.draft().footprintCompiler(); - if (footprintCompiler == null) { - footprintCompiler = new HydrologyFootprintCompiler( - settings, - new HydrologyFootprintCompiler.Sampling( - sampler, - geometrySampler, - naturalSampler - ) - ); - } - MaterializedHydrology materialized = materializeFinalHydrology( - result, - diagnostics, - footprintCompiler, - !resolution.observedRejections().isEmpty() - ); - result = materialized.result(); - RiverFootprint footprint = materialized.footprint(); - if (footprintCompiler.fullMaterializationCount() < 1) { - throw new IllegalStateException("Hydrology publication did not materialize its full footprint."); - } - return new HydrologyTile( - resolution.draft().key(), - worldSeed, - settings.fingerprint(), - settings.routing().tileSize(), - result.nodes(), - result.edges(), - result.outlets(), - result.courses(), - result.cavePlans(), - uniqueDiagnostics(diagnostics), - footprint - ); - } - - private MaterializedHydrology materializeFinalHydrology( - HydrologyCaveCourseFilter.Result initial, - List diagnostics, - HydrologyFootprintCompiler footprintCompiler, - boolean revalidationRequired - ) { - HydrologyCaveCourseFilter.Result current = initial; - int maximumPasses = Math.addExact(initial.courses().size(), 1); - for (int pass = 0; pass < maximumPasses; pass++) { - RiverFootprint footprint = footprintCompiler.compile(current.courses()); - if (current.cavePlans().isEmpty()) { - return new MaterializedHydrology(current, footprint); - } - HydrologyFootprintCompiler.ValidationRaster compactValidation = footprintCompiler.compileValidation( - current.courses() - ); - if (!revalidationRequired - && compactSurfaceMatchesMaterializedPlans(current, compactValidation, footprint)) { - return new MaterializedHydrology(current, footprint); - } - HydrologyFootprintCompiler.ValidationRaster validation = compactValidation.withMaterializedSurface( - footprint - ); - HydrologyObservedPlannedSurface plannedSurface = new HydrologyObservedPlannedSurface( - validation.plannedSurface() - ); - CaveVoxelView caveView = Objects.requireNonNull( - caveViewFactory.create(plannedSurface), - "Hydrology cave view factory returned null" - ); - HydrologyCaveCourseFilter.Result revalidated = new HydrologyCaveCourseFilter( - caveView, - new HydrologyCaveCourseFilter.Options( - settings.underground().connectToExistingCaves(), - settings.outlets().coastalGrotto().maximumVolume(), - settings.outlets().inlandGrotto().maximumVolume() - ), - null, - null, - plannedSurface - ).filter( - current.nodes(), - current.edges(), - current.outlets(), - current.courses(), - validation, - diagnostics - ); - if (revalidated.courses().equals(current.courses())) { - return new MaterializedHydrology(revalidated, footprint); - } - current = revalidated; - revalidationRequired = true; - } - throw new IllegalStateException("Final hydrology cave publication exceeded its course bound."); - } - - - private boolean compactSurfaceMatchesMaterializedPlans( - HydrologyCaveCourseFilter.Result result, - HydrologyFootprintCompiler.ValidationRaster validation, - RiverFootprint footprint - ) { - HashSet visitedColumns = new HashSet<>(); - for (HydrologyCavePlan plan : result.cavePlans()) { - for (CavePosition position : plan.baselinePreconditions().keySet()) { - long packed = RiverFootprint.pack(position.x(), position.z()); - if (!visitedColumns.add(packed)) { - continue; - } - HydrologyColumnSample sample = footprint.sample(position.x(), position.z()).orElse(null); - HydrologyTerrainSample terrain = sample == null - ? Objects.requireNonNull(sampler.sample(position.x(), position.z())) - : null; - int naturalHeight = sample == null ? terrain.naturalHeight() : sample.naturalHeight(); - int materializedHeight = sample == null ? naturalHeight : sample.terrainHeight(); - int compactHeight = validation.plannedSurface().resolve( - position.x(), - position.z(), - naturalHeight - ); - if (compactHeight != materializedHeight) { - return false; - } - } - } - return true; - } - - private CrossTileResolution resolveCrossTileOwner(HydrologyTileKey key) { + CrossTileResolution resolveCrossTileOwner(HydrologyTileKey key) { long started = System.nanoTime(); CrossTileResolutionContext context = new CrossTileResolutionContext( key, @@ -761,7 +297,7 @@ public final class HydrologyPlanner { ); } - private CrossTileResolvedOwner resolveCrossTileOwner( + CrossTileResolvedOwner resolveCrossTileOwner( HydrologyTileKey key, CrossTileResolutionContext context ) { @@ -786,12 +322,12 @@ public final class HydrologyPlanner { throw new IllegalStateException("Cross-tile owner color dependencies must be acyclic."); } try { - int ownerRank = ownerColorRank(key); + int ownerRank = crossTile.ownerColorRank(key); ColorRankedDraftAdmission admission = new ColorRankedDraftAdmission(key, ownerRank, context); HydrologyOwnerDraft draft; try (admission) { try { - draft = compileOwnerDraft( + draft = crossTile.compileOwnerDraft( key, admission, key.equals(context.root()) @@ -816,55 +352,7 @@ public final class HydrologyPlanner { } } - private CrossTileBlockers lowerRankBlockers( - HydrologyTileKey ownerKey, - HydrologyCaveCourseFilter.Result result, - int ownerRank, - CrossTileResolutionContext context, - Map> preparedOwners - ) { - ArrayList blockers = new ArrayList<>(); - ArrayList surfaceBlockers = new ArrayList<>(); - ArrayList candidateKeys = new ArrayList<>(); - for (HydrologyTileKey candidateKey : conflictOwnerKeys(ownerKey, result)) { - if (candidateKey.equals(ownerKey)) { - continue; - } - int candidateRank = ownerColorRank(candidateKey); - if (candidateRank == ownerRank) { - throw new IllegalStateException("Equal owner colors cannot share a cave-action conflict envelope."); - } - if (candidateRank > ownerRank) { - continue; - } - candidateKeys.add(candidateKey); - } - long dependenciesStarted = System.nanoTime(); - List resolvedCandidates = resolveLowerRankOwners(candidateKeys, context, preparedOwners); - currentDraftProfile().recordDependencies(candidateKeys.size(), dependenciesStarted); - for (int index = 0; index < candidateKeys.size(); index++) { - HydrologyTileKey candidateKey = candidateKeys.get(index); - int candidateRank = ownerColorRank(candidateKey); - CrossTileResolvedOwner resolved = resolvedCandidates.get(index); - for (HydrologyCrossTileCaveAdmission.Claim claim : caveClaims(resolved.draft())) { - blockers.add(new HydrologyCrossTileCaveAdmission.RankedClaim( - candidateKey, - candidateRank, - claim - )); - } - for (HydrologyCrossTileSurfaceAdmission.Claim claim : surfaceClaims(resolved.draft())) { - surfaceBlockers.add(new HydrologyCrossTileSurfaceAdmission.RankedClaim( - candidateKey, - candidateRank, - claim - )); - } - } - return new CrossTileBlockers(List.copyOf(blockers), List.copyOf(surfaceBlockers)); - } - - private List resolveLowerRankOwners( + List resolveLowerRankOwners( List candidateKeys, CrossTileResolutionContext context, Map> preparedOwners @@ -897,7 +385,7 @@ public final class HydrologyPlanner { return List.copyOf(resolved); } - private CrossTileResolvedOwner resolveIndependentOwner(HydrologyTileKey key) { + CrossTileResolvedOwner resolveIndependentOwner(HydrologyTileKey key) { CrossTileResolutionContext context = new CrossTileResolutionContext( key, maximumCrossTileDependencyOffset(key), @@ -906,7 +394,7 @@ public final class HydrologyPlanner { return resolveCrossTileOwner(key, context); } - private static CrossTileResolvedOwner awaitResolvedOwner( + static CrossTileResolvedOwner awaitResolvedOwner( CompletableFuture future ) { try { @@ -916,7 +404,7 @@ public final class HydrologyPlanner { } } - private static RuntimeException propagateOwnerFailure(Throwable failure) { + static RuntimeException propagateOwnerFailure(Throwable failure) { if (failure instanceof RuntimeException runtimeException) { return runtimeException; } @@ -926,2142 +414,20 @@ public final class HydrologyPlanner { return new IllegalStateException("Hydrology owner planning failed.", failure); } - private List conflictOwnerKeys(HydrologyOwnerDraft target) { - return conflictOwnerKeys(target.key(), target.result()); - } - - private List conflictOwnerKeys( - HydrologyTileKey ownerKey, - HydrologyCaveCourseFilter.Result result - ) { - int tileSize = settings.routing().tileSize(); - int reach = Math.addExact(settings.publicationRadius(), 1); - int colorPeriod = settings.crossTileColorPeriod(); - LongOpenHashSet columns = new LongOpenHashSet(); - for (HydrologyCavePlan plan : result.cavePlans()) { - for (CavePosition position : plan.actions().keySet()) { - columns.add(RiverFootprint.pack(position.x(), position.z())); - } - } - for (RiverCourse course : result.courses()) { - if (course.type() != RiverCourseType.SURFACE) { - continue; - } - for (HydraulicSegment segment : course.segments()) { - for (HydrologyPoint point : segment.centerline()) { - columns.add(RiverFootprint.pack(point.x(), point.z())); - } - } - } - LinkedHashSet owners = new LinkedHashSet<>(); - owners.add(ownerKey); - LongIterator iterator = columns.iterator(); - while (iterator.hasNext()) { - long column = iterator.nextLong(); - int x = RiverFootprint.unpackX(column); - int z = RiverFootprint.unpackZ(column); - int minimumTileX = ownerCoordinate((long) x - reach, tileSize); - int maximumTileX = ownerCoordinate((long) x + reach, tileSize); - int minimumTileZ = ownerCoordinate((long) z - reach, tileSize); - int maximumTileZ = ownerCoordinate((long) z + reach, tileSize); - long ownerWidth = Math.addExact((long) maximumTileX - minimumTileX, 1L); - long ownerDepth = Math.addExact((long) maximumTileZ - minimumTileZ, 1L); - if (ownerWidth > colorPeriod || ownerDepth > colorPeriod) { - throw new IllegalStateException("A cave action exceeds its bounded owner color neighborhood."); - } - for (int tileZ = minimumTileZ; tileZ <= maximumTileZ; tileZ++) { - for (int tileX = minimumTileX; tileX <= maximumTileX; tileX++) { - owners.add(new HydrologyTileKey(tileX, tileZ)); - } - } - } - int sourceReach = Math.max(0, settings.surface().sources().minimumSpacing() - 1); - for (HydrologyCrossTileSurfaceAdmission.Claim claim : surfaceClaims(result)) { - HydrologyPoint source = claim.centerline().getFirst(); - int minimumTileX = ownerCoordinate((long) source.x() - sourceReach, tileSize); - int maximumTileX = ownerCoordinate((long) source.x() + sourceReach, tileSize); - int minimumTileZ = ownerCoordinate((long) source.z() - sourceReach, tileSize); - int maximumTileZ = ownerCoordinate((long) source.z() + sourceReach, tileSize); - for (int tileZ = minimumTileZ; tileZ <= maximumTileZ; tileZ++) { - for (int tileX = minimumTileX; tileX <= maximumTileX; tileX++) { - owners.add(new HydrologyTileKey(tileX, tileZ)); - } - } - } - ArrayList ordered = new ArrayList<>(owners); - ordered.sort(HydrologyTileKey::compareTo); - return List.copyOf(ordered); - } - - private int ownerColorRank(HydrologyTileKey key) { - int colorPeriod = settings.crossTileColorPeriod(); - int colorX = Math.floorMod(key.tileX(), colorPeriod); - int colorZ = Math.floorMod(key.tileZ(), colorPeriod); - return Math.addExact(Math.multiplyExact(colorZ, colorPeriod), colorX); - } - int maximumCrossTileDependencyOwners(HydrologyTileKey key) { long offset = maximumCrossTileDependencyOffset(key); long width = Math.addExact(Math.multiplyExact(2L, offset), 1L); return Math.toIntExact(Math.multiplyExact(width, width)); } - private long maximumCrossTileDependencyOffset(HydrologyTileKey key) { + long maximumCrossTileDependencyOffset(HydrologyTileKey key) { return Math.multiplyExact( - (long) ownerColorRank(key), + (long) crossTile.ownerColorRank(key), settings.crossTileColorPeriod() - 1L ); } - private List caveClaims(HydrologyOwnerDraft draft) { - return caveClaims(draft.result()); - } - - private List caveClaims( - HydrologyCaveCourseFilter.Result result - ) { - if (result.cavePlans().isEmpty()) { - return List.of(); - } - Map coursesById = coursesById(result.courses()); - ArrayList claims = - new ArrayList<>(result.cavePlans().size()); - for (HydrologyCavePlan plan : result.cavePlans()) { - RiverCourse course = coursesById.get(plan.source().sourceId()); - if (course == null) { - throw new IllegalStateException("Accepted cave plan has no owner course."); - } - claims.add(new HydrologyCrossTileCaveAdmission.Claim(course.profileKey(), plan)); - } - return List.copyOf(claims); - } - - private List surfaceClaims(HydrologyOwnerDraft draft) { - return surfaceClaims(draft.result()); - } - - private List surfaceClaims( - HydrologyCaveCourseFilter.Result result - ) { - ArrayList claims = new ArrayList<>(); - for (RiverCourse course : result.courses()) { - if (course.type() != RiverCourseType.SURFACE || course.outletId().isEmpty()) { - continue; - } - ArrayList centerline = new ArrayList<>(); - int maximumWidth = 1; - for (HydraulicSegment segment : course.segments()) { - maximumWidth = Math.max(maximumWidth, segment.width()); - for (HydrologyPoint point : segment.centerline()) { - if (centerline.isEmpty() - || point.x() != centerline.getLast().x() - || point.z() != centerline.getLast().z()) { - centerline.add(point); - } - } - } - if (centerline.size() < 2) { - continue; - } - HydrologyFeatureType terminalType = course.segments().getLast().type(); - boolean reachesOutlet = terminalType == HydrologyFeatureType.MOUTH - || terminalType == HydrologyFeatureType.COASTAL_GROTTO - || terminalType == HydrologyFeatureType.INLAND_GROTTO; - if (!reachesOutlet) { - continue; - } - claims.add(new HydrologyCrossTileSurfaceAdmission.Claim( - course.id(), - course.outletId().getAsLong(), - centerline.getLast(), - reachesOutlet, - maximumWidth, - centerline - )); - } - return List.copyOf(claims); - } - - private Map coursesById(List courses) { - LinkedHashMap indexed = new LinkedHashMap<>(courses.size()); - for (RiverCourse course : courses) { - RiverCourse existing = indexed.putIfAbsent(course.id(), course); - if (existing != null && !existing.equals(course)) { - throw new IllegalStateException("Hydrology course id collision."); - } - } - return Map.copyOf(indexed); - } - - private void validateOwnerDraftReach(HydrologyOwnerDraft draft) { - int tileSize = settings.routing().tileSize(); - int reach = Math.addExact(settings.publicationRadius(), 1); - long minimumX = (long) draft.key().minimumBlockX(tileSize) - reach; - long minimumZ = (long) draft.key().minimumBlockZ(tileSize) - reach; - long maximumX = (long) draft.key().minimumBlockX(tileSize) + tileSize - 1L + reach; - long maximumZ = (long) draft.key().minimumBlockZ(tileSize) + tileSize - 1L + reach; - for (HydrologyCavePlan plan : draft.result().cavePlans()) { - for (CavePosition position : plan.actions().keySet()) { - if (position.x() < minimumX || position.x() > maximumX - || position.z() < minimumZ || position.z() > maximumZ) { - throw new IllegalStateException("Hydrology cave plan exceeds its bounded owner reach."); - } - } - } - } - - private static int ownerCoordinate(long blockCoordinate, int tileSize) { - return Math.toIntExact(Math.floorDiv(blockCoordinate, tileSize)); - } - - private void settleSelection( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan surfaceRouting, - RoutingPlan undergroundRouting, - SourceSelection selection, - boolean surface, - HydrologyFootprintCompiler footprintCompiler, - Map> refinedEdges, - Map sourceCompilations, - List diagnostics - ) { - RoutingPlan selectedRouting = surface ? surfaceRouting : undergroundRouting; - if (grid == null - || selectedRouting == null - || selection.selectedCandidateIndices.isEmpty()) { - return; - } - SourceSelection emptySelection = SourceSelection.empty(!surface); - int maximumPasses = Math.addExact(1, selection.candidateCount()); - for (int pass = 0; pass < maximumPasses; pass++) { - PublicationAttempt attempt = compilePublication( - key, - grid, - surfaceRouting, - undergroundRouting, - surface ? selection : emptySelection, - surface ? emptySelection : selection, - footprintCompiler, - refinedEdges, - sourceCompilations, - false - ); - diagnostics.addAll(attempt.diagnostics()); - if (!selection.advanceAfterPublication(attempt.result().courses(), grid)) { - return; - } - } - throw new IllegalStateException("Hydrology source trial exceeded its candidate bound."); - } - - private PublicationAttempt compilePublication( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan surfaceRouting, - RoutingPlan undergroundRouting, - SourceSelection surfaceSelection, - SourceSelection undergroundSelection, - HydrologyFootprintCompiler footprintCompiler, - Map> refinedEdges, - Map sourceCompilations, - boolean includeDeepFluids - ) { - ArrayList diagnostics = new ArrayList<>(); - ArrayList courses = new ArrayList<>(); - CompiledGraph graph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); - if (grid != null) { - List surfaceSources = surfaceSelection.selectedNodeIndices(); - List undergroundSources = undergroundSelection.selectedNodeIndices(); - if (surfaceRouting != null && surfaceRouting == undergroundRouting) { - int[] surfaceContributions = countContributions(surfaceSources, surfaceRouting); - int[] undergroundContributions = countContributions(undergroundSources, surfaceRouting); - graph = compileGraph( - key, - grid, - surfaceRouting, - surfaceContributions, - undergroundContributions, - refinedEdges - ); - if (settings.surface().enabled()) { - compileSurfaceCourses( - key, - grid, - surfaceRouting, - graph, - surfaceSources, - courses, - diagnostics - ); - } - if (settings.underground().enabled()) { - compileUndergroundCourses( - key, - grid, - surfaceRouting, - graph, - undergroundSources, - courses, - diagnostics - ); - } - } else { - CompiledGraph surfaceGraph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); - CompiledGraph undergroundGraph = new CompiledGraph(List.of(), List.of(), List.of(), Map.of()); - if (surfaceRouting != null && !surfaceSources.isEmpty()) { - SourceCompilation surfaceCompilation = compileSourceSelection( - true, - key, - grid, - surfaceRouting, - surfaceSources, - refinedEdges, - sourceCompilations - ); - surfaceGraph = surfaceCompilation.graph(); - courses.addAll(surfaceCompilation.courses()); - diagnostics.addAll(surfaceCompilation.diagnostics()); - } - if (undergroundRouting != null && !undergroundSources.isEmpty()) { - SourceCompilation undergroundCompilation = compileSourceSelection( - false, - key, - grid, - undergroundRouting, - undergroundSources, - refinedEdges, - sourceCompilations - ); - undergroundGraph = undergroundCompilation.graph(); - courses.addAll(undergroundCompilation.courses()); - diagnostics.addAll(undergroundCompilation.diagnostics()); - } - graph = mergeGraphs(surfaceGraph, undergroundGraph); - } - } - List normalizedTrunkCourses = normalizeSharedTrunks(courses, diagnostics); - List normalizedOutletCourses = normalizeOutletContinuations(normalizedTrunkCourses); - courses.clear(); - courses.addAll(normalizedOutletCourses); - if (includeDeepFluids) { - compileDeepFluidCourses(key, courses, diagnostics); - } - compileSurfacePools(key, courses, diagnostics); - if (includeDeepFluids && grid != null) { - compileSeaCaves(grid, courses, diagnostics); - } - DraftProfile profile = currentDraftProfile(); - long rasterStarted = System.nanoTime(); - HydrologyFootprintCompiler.ValidationRaster validation = footprintCompiler.compileValidation(courses); - profile.rasterNanos += System.nanoTime() - rasterStarted; - profile.rasterCalls++; - HydrologyObservedPlannedSurface plannedSurface = new HydrologyObservedPlannedSurface( - validation.plannedSurface() - ); - CaveVoxelView caveView = Objects.requireNonNull( - caveViewFactory.create(plannedSurface), - "Hydrology cave view factory returned null" - ); - PlanningSamples samples = planningSamples.get(); - if (samples != null && caveView instanceof HydrologyTerrainCaveVoxelView terrainCaveView) { - caveView = terrainCaveView.withSampleCache(samples.detailed); - } - Map candidateCache = - samples == null ? null : samples.caveCandidates; - HydrologyCaveContainmentPlanner.ValidationCache validationCache = - samples == null ? null : samples.caveValidations; - long filterStarted = System.nanoTime(); - HydrologyCaveCourseFilter.Result containment = new HydrologyCaveCourseFilter( - caveView, - new HydrologyCaveCourseFilter.Options( - settings.underground().connectToExistingCaves(), - settings.outlets().coastalGrotto().maximumVolume(), - settings.outlets().inlandGrotto().maximumVolume() - ), - candidateCache, - validationCache, - plannedSurface - ).filter( - graph.nodes(), - graph.edges(), - graph.outlets(), - courses, - validation, - diagnostics - ); - profile.filterNanos += System.nanoTime() - filterStarted; - profile.filterCalls++; - return new PublicationAttempt(containment, diagnostics); - } - - - private SourceCompilation compileSourceSelection( - boolean surface, - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan routing, - List sources, - Map> refinedEdges, - Map sourceCompilations - ) { - SourceCompilationKey compilationKey = new SourceCompilationKey(surface, routing, sources); - SourceCompilation cached = sourceCompilations.get(compilationKey); - if (cached != null) { - return cached; - } - int[] contributions = countContributions(sources, routing); - CompiledGraph graph = compileGraph( - key, - grid, - routing, - surface ? contributions : new int[contributions.length], - surface ? new int[contributions.length] : contributions, - refinedEdges - ); - ArrayList courses = new ArrayList<>(); - ArrayList diagnostics = new ArrayList<>(); - if (surface && settings.surface().enabled()) { - compileSurfaceCourses(key, grid, routing, graph, sources, courses, diagnostics); - } else if (!surface && settings.underground().enabled()) { - compileUndergroundCourses(key, grid, routing, graph, sources, courses, diagnostics); - } - SourceCompilation compiled = new SourceCompilation( - graph, - List.copyOf(courses), - List.copyOf(diagnostics) - ); - sourceCompilations.put(compilationKey, compiled); - return compiled; - } - - private List normalizeOutletContinuations(List courses) { - HashMap canonicalCourses = new HashMap<>(); - for (RiverCourse course : courses) { - if (!hasInlandOutletContinuation(course) || course.outletId().isEmpty()) { - continue; - } - OutletCourseKey key = new OutletCourseKey(course.outletId().getAsLong()); - canonicalCourses.merge( - key, - course, - this::preferredOutletContinuation - ); - } - ArrayList normalized = new ArrayList<>(courses.size()); - for (RiverCourse course : courses) { - if (course.outletId().isEmpty()) { - normalized.add(course); - continue; - } - OutletCourseKey key = new OutletCourseKey(course.outletId().getAsLong()); - RiverCourse canonicalCourse = canonicalCourses.get(key); - if (canonicalCourse == null || canonicalCourse.id() == course.id()) { - normalized.add(course); - continue; - } - List segments = course.segments(); - int retainedSize = course.surfaceSinkholeContinuation() - ? segments.size() - 2 - : segments.getLast().type() == HydrologyFeatureType.INLAND_GROTTO - ? segments.size() - 1 - : segments.size(); - retainedSize = trimCanonicalOutletOverlap(course, canonicalCourse, retainedSize); - if (retainedSize < 1) { - continue; - } - normalized.add(new RiverCourse( - course.id(), - course.type(), - course.sourceNodeId(), - course.outletId(), - course.profileKey(), - course.discharge(), - course.drainageEdges(), - segments.subList(0, retainedSize) - )); - } - return List.copyOf(normalized); - } - - private int trimCanonicalOutletOverlap( - RiverCourse course, - RiverCourse canonicalCourse, - int retainedSize - ) { - if (!canonicalCourse.surfaceSinkholeContinuation() - || canonicalCourse.segments().isEmpty() - || retainedSize < 1) { - return retainedSize; - } - HydraulicSegment canonicalGrotto = canonicalCourse.segments().getLast(); - if (canonicalGrotto.type() != HydrologyFeatureType.INLAND_GROTTO) { - return retainedSize; - } - int exclusionRadius = Math.addExact( - settings.outlets().inlandGrotto().horizontalRadius(), - Math.addExact((int) StrictMath.ceil(settings.underground().maximumWidth() / 2D), 2) - ); - long exclusionRadiusSquared = (long) exclusionRadius * exclusionRadius; - while (retainedSize > 0 && segmentOverlapsOutlet( - course.segments().get(retainedSize - 1), - canonicalGrotto, - exclusionRadiusSquared - )) { - retainedSize--; - } - return retainedSize; - } - - private boolean segmentOverlapsOutlet( - HydraulicSegment segment, - HydraulicSegment outlet, - long exclusionRadiusSquared - ) { - for (HydrologyPoint point : segment.centerline()) { - for (HydrologyPoint outletPoint : outlet.centerline()) { - if (point.distanceSquared2D(outletPoint) <= exclusionRadiusSquared) { - return true; - } - } - } - return false; - } - - private List normalizeSharedTrunks(List courses, List diagnostics) { - HashMap edgeOwners = new HashMap<>(); - for (RiverCourse course : courses) { - if (course.sourceNodeId().isEmpty()) { - continue; - } - for (DrainageEdge edge : course.drainageEdges()) { - CourseEdgeKey key = new CourseEdgeKey(course.type(), edge.id()); - edgeOwners.merge( - key, - course, - this::preferredTrunkCourse - ); - } - } - ArrayList normalized = new ArrayList<>(courses.size()); - for (RiverCourse course : courses) { - if (course.sourceNodeId().isEmpty() || course.drainageEdges().isEmpty()) { - normalized.add(course); - continue; - } - int ownedEdgeCount = 0; - for (DrainageEdge edge : course.drainageEdges()) { - RiverCourse owner = edgeOwners.get(new CourseEdgeKey(course.type(), edge.id())); - if (owner == null || owner.id() != course.id()) { - break; - } - ownedEdgeCount++; - } - if (ownedEdgeCount == course.drainageEdges().size()) { - normalized.add(course); - continue; - } - if (ownedEdgeCount < 1) { - continue; - } - HydrologyPoint boundary = course.drainageEdges() - .get(ownedEdgeCount - 1) - .centerline() - .getLast(); - if (course.type() == RiverCourseType.SURFACE) { - // Surface tributaries are cut at their junction before they are built, so a surface - // course still sharing drainage with a longer trunk has no junction to keep it. - addTributaryDiagnostic(course.id(), course.segments().getFirst().start(), - HydrologyCandidateRejection.NO_DRAINAGE_PATH, ownedEdgeCount, diagnostics); - continue; - } - int retainedSegmentCount = retainedSegmentCount(course.segments(), boundary); - if (retainedSegmentCount < 1) { - normalized.add(course); - continue; - } - normalized.add(new RiverCourse( - course.id(), - course.type(), - course.sourceNodeId(), - course.outletId(), - course.profileKey(), - course.discharge(), - course.drainageEdges().subList(0, ownedEdgeCount), - course.segments().subList(0, retainedSegmentCount) - )); - } - return List.copyOf(normalized); - } - - /** - * Builds a later draft to the stem's outlet as a tributary. The draft's path is cut where it first - * comes within a stem width of the stem or first enters drainage the stem already owns, and it is - * shaped with the stem's water level at that station as its terminal, so it arrives at or above the - * stem and steps down into it. When the tributary would arrive below the stem's water there, the - * junction slides downstream along the stem to the first station whose water is low enough and the - * course is shaped again. The tributary owns only the drainage edges upstream of the junction. - */ - private RiverCourse buildSurfaceTributary( - SurfaceCourseDraft draft, - RiverCourse stem, - List diagnostics - ) { - CoursePath path = draft.path(); - HydrologyPoint sourcePoint = path.points().getFirst(); - HashSet stemEdges = new HashSet<>(); - for (DrainageEdge edge : stem.drainageEdges()) { - stemEdges.add(edge.id()); - } - ArrayList stemStations = new ArrayList<>(); - ArrayList stemWidths = new ArrayList<>(); - for (HydraulicSegment segment : stem.segments()) { - for (HydrologyPoint point : segment.centerline()) { - stemStations.add(point); - stemWidths.add(segment.width()); - } - } - int minimumStemIndex = 0; - HydrologyCandidateRejection rejection = HydrologyCandidateRejection.NO_DRAINAGE_PATH; - int rejectionDetail = 0; - for (int attempt = 0; attempt < TRIBUTARY_JUNCTION_ATTEMPTS; attempt++) { - int[] junction = tributaryJunction(path, stemStations, stemWidths, stemEdges, minimumStemIndex); - if (junction == null) { - break; - } - int joinIndex = junction[0]; - int stemIndex = junction[1]; - HydrologyPoint joinStation = stemStations.get(stemIndex); - if (joinIndex < 1) { - rejection = HydrologyCandidateRejection.COURSE_TOO_SHORT; - rejectionDetail = 0; - break; - } - TributaryBuild build = buildSurfaceTributaryAt(draft, joinIndex, stemIndex, stemStations, stemWidths, stemEdges); - if (build.course() != null) { - return build.course(); - } - rejection = build.rejection(); - rejectionDetail = build.rejectionDetail(); - if (rejection != HydrologyCandidateRejection.SURFACE_HEAD_RANGE) { - break; - } - // The tributary arrives rejectionDetail blocks below the stem's water: slide the junction - // downstream to the first stem station whose water is that much lower. - int target = joinStation.y() - rejectionDetail; - int nextStemIndex = -1; - for (int index = stemIndex + 1; index < stemStations.size(); index++) { - if (stemStations.get(index).y() <= target) { - nextStemIndex = index; - break; - } - } - if (nextStemIndex < 0) { - break; - } - minimumStemIndex = nextStemIndex; - } - addTributaryDiagnostic(draft.courseId(), sourcePoint, rejection, rejectionDetail, diagnostics); - return null; - } - - /** - * The first draft point, in path order, that lies within a stem width of a stem station at or past - * {@code minimumStemIndex} or that enters drainage the stem owns, as {draft point index, stem station - * index}; null when the draft never meets the stem there. Among the stations the point can reach the - * lowest water wins, then the flattest stretch, so the tributary's mouth sits at the river's level - * where the two channels touch and never above the stem's shore. - */ - private static int[] tributaryJunction( - CoursePath path, - List stemStations, - List stemWidths, - Set stemEdges, - int minimumStemIndex - ) { - for (int index = 0; index < path.points().size(); index++) { - HydrologyPoint point = path.points().get(index); - boolean sharedEdge = index > 0 && stemEdges.contains(path.pairEdges().get(index - 1).id()); - int best = -1; - int bestFlatness = -1; - double bestDistance = Double.POSITIVE_INFINITY; - for (int stemIndex = minimumStemIndex; stemIndex < stemStations.size(); stemIndex++) { - double distance = point.distanceSquared2D(stemStations.get(stemIndex)); - double reach = stemWidths.get(stemIndex) + 1D; - boolean reachable = distance <= reach * reach; - if (!reachable && !(sharedEdge && best < 0 && distance < bestDistance)) { - continue; - } - int flatness = reachable ? stemFlatness(stemStations, stemIndex) : -1; - int level = stemStations.get(stemIndex).y(); - int bestLevel = best < 0 ? Integer.MAX_VALUE : stemStations.get(best).y(); - if (level < bestLevel - || level == bestLevel && (flatness > bestFlatness || flatness == bestFlatness && distance < bestDistance)) { - best = stemIndex; - bestFlatness = flatness; - bestDistance = distance; - } - } - if (best >= 0) { - return new int[] {index, best}; - } - } - return null; - } - - /** How many of the stem stations around {@code stemIndex} share its water level. */ - private static int stemFlatness(List stemStations, int stemIndex) { - int level = stemStations.get(stemIndex).y(); - int flat = 0; - for (int offset = -TRIBUTARY_JUNCTION_FLAT_STATIONS; offset <= TRIBUTARY_JUNCTION_FLAT_STATIONS; offset++) { - int index = stemIndex + offset; - if (index >= 0 && index < stemStations.size() && stemStations.get(index).y() == level) { - flat++; - } - } - return flat; - } - - /** Raises every trailing station below {@code level} to it, so the tail is a flat pool at the stem's water. */ - private static void backwater(List segments, int level) { - for (int index = segments.size() - 1; index >= 0; index--) { - HydraulicSegment segment = segments.get(index); - if (segment.upstreamHeadY() >= level && segment.downstreamHeadY() >= level) { - break; - } - ArrayList centerline = new ArrayList<>(segment.centerline().size()); - for (HydrologyPoint point : segment.centerline()) { - centerline.add(point.y() < level ? new HydrologyPoint(point.x(), level, point.z()) : point); - } - int upstream = Math.max(segment.upstreamHeadY(), level); - int downstream = Math.max(segment.downstreamHeadY(), level); - segments.set(index, new HydraulicSegment( - segment.id(), - segment.courseId(), - upstream == downstream ? HydrologyFeatureType.SURFACE_POOL : segment.type(), - upstream, - downstream, - segment.width(), - segment.depth(), - segment.fallingFluid(), - segment.receivingPool(), - List.copyOf(centerline) - )); - if (segment.upstreamHeadY() >= level) { - break; - } - } - } - - /** - * Lowers the trailing stations of a tributary towards {@code level}, one block per cascade run of - * centerline distance from the junction and never deeper than the channel may cut, so the reach - * grades down into the stem instead of hanging above it. Where the ground holds a station up, the - * stations upstream of it are held with it, so the graded reach still descends into the stem. - */ - void levelApproach(List segments, int level) { - int run = Math.max(1, settings.surface().banks().cascadeRun()); - int maximumIncision = settings.surface().maximumIncision(); - double distance = 0D; - HydrologyPoint previous = null; - int downstreamHead = Integer.MIN_VALUE; - for (int index = segments.size() - 1; index >= 0; index--) { - HydraulicSegment segment = segments.get(index); - ArrayList centerline = new ArrayList<>(segment.centerline()); - boolean changed = false; - boolean settled = false; - for (int pointIndex = centerline.size() - 1; pointIndex >= 0; pointIndex--) { - HydrologyPoint point = centerline.get(pointIndex); - if (previous != null) { - distance += StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); - } - previous = point; - int allowed = level + (int) StrictMath.floor(distance / run); - if (point.y() <= allowed) { - settled = true; - break; - } - int floor = sampleBasisWithoutSlope(point.x(), point.z()).naturalHeight() - maximumIncision; - int lowered = Math.min(point.y(), Math.max(Math.max(allowed, floor), downstreamHead)); - if (lowered < point.y()) { - centerline.set(pointIndex, new HydrologyPoint(point.x(), lowered, point.z())); - changed = true; - } - downstreamHead = lowered; - } - if (changed) { - // A level reach may carry a bump above its heads (a pool's centerline is not graded); - // once its tail is cut down the reach becomes a graded transition, which must never rise - // downstream, so every station is held at or below the one before it. - int ceiling = centerline.getFirst().y(); - for (int pointIndex = 1; pointIndex < centerline.size(); pointIndex++) { - HydrologyPoint point = centerline.get(pointIndex); - if (point.y() > ceiling) { - centerline.set(pointIndex, new HydrologyPoint(point.x(), ceiling, point.z())); - } else { - ceiling = point.y(); - } - } - int upstream = centerline.getFirst().y(); - int downstream = centerline.getLast().y(); - HydrologyFeatureType type = segment.type(); - if (upstream > downstream && !type.isDrop()) { - type = upstream - downstream >= settings.hydraulics().waterfallMinimumDrop() - ? HydrologyFeatureType.WATERFALL - : upstream - downstream == 1 ? HydrologyFeatureType.RIFFLE : HydrologyFeatureType.CASCADE; - } else if (upstream == downstream && type.isDrop()) { - type = HydrologyFeatureType.SURFACE_POOL; - } - segments.set(index, new HydraulicSegment( - segment.id(), - segment.courseId(), - type, - upstream, - downstream, - segment.width(), - segment.depth(), - segment.fallingFluid(), - segment.receivingPool(), - List.copyOf(centerline) - )); - } - if (settled) { - break; - } - } - } - - private static int lastWidth(SurfaceCourseResult result) { - return Math.max(1, result.lastWidth()); - } - - private record TributaryBuild(RiverCourse course, HydrologyCandidateRejection rejection, int rejectionDetail) { - private static TributaryBuild rejected(HydrologyCandidateRejection rejection, int detail) { - return new TributaryBuild(null, rejection, detail); - } - } - - private TributaryBuild buildSurfaceTributaryAt( - SurfaceCourseDraft draft, - int joinIndex, - int stemIndex, - List stemStations, - List stemWidths, - Set stemEdges - ) { - CoursePath path = draft.path(); - HydrologyPoint joinStation = stemStations.get(stemIndex); - ArrayList points = new ArrayList<>(path.points().subList(0, joinIndex + 1)); - HydrologyPoint last = points.getLast(); - if (last.x() != joinStation.x() || last.z() != joinStation.z()) { - points.add(new HydrologyPoint(joinStation.x(), last.y(), joinStation.z())); - } - LinkedHashSet ownedEdges = new LinkedHashSet<>(); - for (DrainageEdge edge : path.pairEdges().subList(0, joinIndex)) { - if (!stemEdges.contains(edge.id())) { - ownedEdges.add(edge); - } - } - if (ownedEdges.isEmpty()) { - return TributaryBuild.rejected(HydrologyCandidateRejection.COURSE_TOO_SHORT, joinIndex); - } - int stemHead = joinStation.y(); - SurfaceCourseResult result = tributaryCourseBuilder.build( - worldSeed, - draft.courseId(), - draft.profileKey(), - List.copyOf(points), - SurfaceTerminal.TRIBUTARY, - stemHead - ); - if (!result.accepted()) { - return TributaryBuild.rejected(result.rejection(), result.rejectionDetail()); - } - if (path.organicSurfaceRequired()) { - // The reach is judged without its approach into the stem: the turn a tributary makes to - // enter its river is junction geometry, not a bend in the river itself. - double approachRadius = 3D * lastWidth(result) + 8D; - int judged = joinIndex; - while (judged > 0 && path.points().get(judged).distanceSquared2D(joinStation) <= approachRadius * approachRadius) { - judged--; - } - int shapeRejection = judged >= 2 ? surfaceShapeRejection(path.points().subList(0, judged + 1), true) : 0; - if (shapeRejection != 0) { - return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_SHAPE_UNSUPPORTED, shapeRejection); - } - } - ArrayList segments = new ArrayList<>(result.segments()); - // Where the two channels touch, the tributary must sit at the lowest stem water it reaches. - double touch = stemWidths.get(stemIndex) + lastWidth(result) + 1D; - for (int index = 0; index < stemStations.size(); index++) { - HydrologyPoint station = stemStations.get(index); - if (station.distanceSquared2D(joinStation) <= touch * touch) { - stemHead = Math.min(stemHead, station.y()); - } - } - if (segments.getLast().downstreamHeadY() < stemHead) { - int shortfall = stemHead - segments.getLast().downstreamHeadY(); - if (shortfall > TRIBUTARY_BACKWATER_LIMIT) { - return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_HEAD_RANGE, shortfall); - } - // The stem's water stands a little above the tributary's floor at the junction: the tail of - // the tributary backs up to the stem's level, a short still reach the bank lip contains. - backwater(segments, stemHead); - } else if (segments.getLast().downstreamHeadY() > stemHead) { - // The tributary hangs above its river: its last stretch is cut down to the stem's water, - // a block per cascade run, so the channel meets the river at its level and not above - // the stem's shore. - levelApproach(segments, stemHead); - } - HydraulicSegment lastSegment = segments.getLast(); - HydrologyPoint end = lastSegment.end(); - if (end.x() != joinStation.x() || end.z() != joinStation.z() || lastSegment.downstreamHeadY() != stemHead) { - // The hop onto the stem is graded like any in-course drop, so the water steps down block - // by block into the river instead of standing above the stem's shore. - int drop = lastSegment.downstreamHeadY() - stemHead; - HydrologyFeatureType type = drop == 0 - ? HydrologyFeatureType.SURFACE_POOL - : drop >= settings.hydraulics().waterfallMinimumDrop() - ? HydrologyFeatureType.WATERFALL - : drop == 1 ? HydrologyFeatureType.RIFFLE : HydrologyFeatureType.CASCADE; - boolean graded = addHydraulicSegments( - draft.courseId(), - TRIBUTARY_JUNCTION_PAIR_INDEX, - type, - lastSegment.downstreamHeadY(), - stemHead, - lastSegment.width(), - lastSegment.depth(), - List.of(end, new HydrologyPoint(joinStation.x(), stemHead, joinStation.z())), - true, - segments - ); - if (!graded) { - return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_DROP_UNSUPPORTED, drop); - } - } - List edges = List.copyOf(ownedEdges); - return new TributaryBuild(new RiverCourse( - draft.courseId(), - RiverCourseType.SURFACE, - OptionalLong.of(draft.source().id()), - OptionalLong.of(path.outlet().id()), - draft.profileKey(), - maximumSurfaceDischarge(edges), - edges, - segments - ), null, 0); - } - - private void addTributaryDiagnostic( - long courseId, - HydrologyPoint sourcePoint, - HydrologyCandidateRejection rejection, - int detail, - List diagnostics - ) { - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(courseId, DIAGNOSTIC_SALT, rejection.ordinal(), 0x5452494255544152L), - HydrologyCandidateKind.TRIBUTARY, - HydrologyFeatureType.SURFACE_POOL, - sourcePoint, - rejection, - detail - )); - } - - private RiverCourse preferredTrunkCourse(RiverCourse first, RiverCourse second) { - double firstLength = edgeLength(first.drainageEdges(), first.drainageEdges().size()); - double secondLength = edgeLength(second.drainageEdges(), second.drainageEdges().size()); - if (firstLength != secondLength) { - return firstLength > secondLength ? first : second; - } - if (first.discharge() != second.discharge()) { - return first.discharge() > second.discharge() ? first : second; - } - return Long.compareUnsigned(first.id(), second.id()) <= 0 ? first : second; - } - - private double edgeLength(List edges, int edgeCount) { - double length = 0D; - for (int edgeIndex = 0; edgeIndex < edgeCount; edgeIndex++) { - List centerline = edges.get(edgeIndex).centerline(); - for (int pointIndex = 1; pointIndex < centerline.size(); pointIndex++) { - HydrologyPoint previous = centerline.get(pointIndex - 1); - HydrologyPoint current = centerline.get(pointIndex); - length += StrictMath.hypot(current.x() - previous.x(), current.z() - previous.z()); - } - } - return length; - } - - private int retainedSegmentCount(List segments, HydrologyPoint boundary) { - for (int segmentIndex = 0; segmentIndex < segments.size(); segmentIndex++) { - HydrologyPoint end = segments.get(segmentIndex).centerline().getLast(); - if (end.x() == boundary.x() && end.z() == boundary.z()) { - return segmentIndex + 1; - } - } - return 0; - } - - private RiverCourse preferredOutletContinuation(RiverCourse first, RiverCourse second) { - boolean firstSurfaceSinkhole = first.surfaceSinkholeContinuation(); - boolean secondSurfaceSinkhole = second.surfaceSinkholeContinuation(); - if (firstSurfaceSinkhole != secondSurfaceSinkhole) { - return firstSurfaceSinkhole ? first : second; - } - return Long.compareUnsigned(first.id(), second.id()) <= 0 ? first : second; - } - - private boolean hasInlandOutletContinuation(RiverCourse course) { - return course.surfaceSinkholeContinuation() - || course.segments().getLast().type() == HydrologyFeatureType.INLAND_GROTTO; - } - - private boolean hasRoutedSourceSearch() { - HydrologyPlannerSettings.Source surface = settings.surface().sources(); - if (settings.surface().enabled() && surface.enabled()) { - return true; - } - HydrologyPlannerSettings.Source underground = settings.underground().sources(); - return settings.underground().enabled() - && underground.enabled(); - } - - private List uniqueDiagnostics( - List diagnostics - ) { - LinkedHashMap unique = new LinkedHashMap<>(); - for (HydrologyDiagnosticCandidate diagnostic : diagnostics) { - unique.putIfAbsent(diagnostic.id(), diagnostic); - } - return List.copyOf(unique.values()); - } - - private SampledGrid sample(HydrologyTileKey key) { - HydrologyPlannerSettings.Routing routing = settings.routing(); - int ownerMinimumX = key.minimumBlockX(routing.tileSize()); - int ownerMinimumZ = key.minimumBlockZ(routing.tileSize()); - int halo = Math.min( - routing.maximumRouteLength(), - Math.multiplyExact(routing.sampleSpacing(), 2) - ); - int alignedHalo = Math.floorDiv(halo, routing.sampleSpacing()) * routing.sampleSpacing(); - int minimumX = ownerMinimumX - alignedHalo; - int minimumZ = ownerMinimumZ - alignedHalo; - int width = (routing.tileSize() + alignedHalo * 2) / routing.sampleSpacing() + 1; - int nodeCount = Math.multiplyExact(width, width); - HydrologyRoutingTerrainSampler.GridRequest gridRequest = new HydrologyRoutingTerrainSampler.GridRequest( - minimumX, - minimumZ, - width, - routing.sampleSpacing() - ); - HydrologyTerrainSample[] terrainSamples = Objects.requireNonNull( - routingSampler.sampleGrid(gridRequest), - "Hydrology routing terrain sampler returned null" - ); - if (terrainSamples.length != nodeCount) { - throw new IllegalStateException( - "Hydrology routing terrain sampler returned " + terrainSamples.length - + " samples for a " + width + " by " + width + " grid" - ); - } - ArrayList nodes = new ArrayList<>(nodeCount); - for (int gridZ = 0; gridZ < width; gridZ++) { - int z = minimumZ + gridZ * routing.sampleSpacing(); - for (int gridX = 0; gridX < width; gridX++) { - int x = minimumX + gridX * routing.sampleSpacing(); - int index = gridZ * width + gridX; - HydrologyTerrainSample terrain = Objects.requireNonNull( - terrainSamples[index], - "Hydrology routing terrain sampler returned null at " + x + "," + z - ); - long id = HydrologyHash.mix(worldSeed, NODE_SALT, x, z); - nodes.add(new GridNode(index, gridX, gridZ, x, z, id, terrain)); - } - } - return new SampledGrid( - minimumX, - minimumZ, - ownerMinimumX, - ownerMinimumZ, - routing.tileSize(), - width, - routing.sampleSpacing(), - List.copyOf(nodes) - ); - } - - private List resolveOutlets( - HydrologyTileKey key, - SampledGrid grid, - boolean surface, - List diagnostics - ) { - ArrayList oceanCandidates = oceanOutletCandidates(grid, surface); - if (!surface && settings.outlets().inlandGrotto().enabled()) { - addOutletLevelDiagnostics(oceanCandidates, diagnostics); - } - sortOutletCandidates(key, grid, surface, oceanCandidates); - // Sea outlets and inland outlets are budgeted separately: a coast never starves the - // sinkholes behind it and a sinkhole never displaces a mouth. - List selectedOcean = limitOutletsByType( - oceanCandidates, - settings.outlets().maximumCoastalPerTile() - ); - addRejectedOutlets(oceanCandidates, selectedOcean, diagnostics); - if (!settings.outlets().inlandGrotto().enabled()) { - return selectedOcean; - } - boolean[] oceanReachable = outletReachable(grid, oceanCandidates, surface); - ArrayList inlandCandidates = inlandOutletCandidates(grid, oceanReachable); - sortInlandOutletCandidates(grid, inlandCandidates); - List selectedInland = styledInlandOutlets( - grid, - limitOutlets(inlandCandidates, settings.outlets().maximumPerTile()), - surface - ); - addRejectedOutlets(inlandCandidates, selectedInland, diagnostics); - ArrayList selected = new ArrayList<>(selectedOcean.size() + selectedInland.size()); - selected.addAll(selectedOcean); - selected.addAll(selectedInland); - return List.copyOf(selected); - } - - private ArrayList oceanOutletCandidates(SampledGrid grid, boolean surface) { - ArrayList oceanCandidates = new ArrayList<>(); - for (GridNode land : grid.nodes()) { - if (land.terrain().ocean() || !land.terrain().transitAllowed() || !land.terrain().outletAllowed()) { - continue; - } - GridNode ocean = firstOceanNeighbor(grid, land); - if (ocean == null || !land.terrain().drainsInto(ocean.terrain())) { - // A confined shore only reaches a sea that belongs to its own area. - continue; - } - HydrologyOceanBoundaryRefiner.Result boundary = refineOceanBoundary(land, ocean); - if (boundary == null - || !boundary.landwardTerrain().transitAllowed() - || !boundary.landwardTerrain().outletAllowed()) { - continue; - } - HydrologyFeatureType type = coastalOutletType(boundary.landwardTerrain()); - if (type == null) { - continue; - } - long outletId = HydrologyHash.mix(worldSeed, OUTLET_SALT, land.id(), ocean.id(), type.ordinal()); - int seaLevel = settingsSeaLevel(ocean.terrain()); - RiverOutlet outlet = new RiverOutlet( - outletId, - type, - land.id(), - withY(boundary.landwardPoint(), seaLevel), - withY(boundary.oceanPoint(), seaLevel), - seaLevel, - true - ); - oceanCandidates.add(new OutletCandidate(land.index(), ocean.index(), outlet)); - } - return oceanCandidates; - } - - private List resolveSurfaceFallbackOutlets(SampledGrid grid) { - ArrayList oceanCandidates = oceanOutletCandidates(grid, true); - ArrayList inlandCandidates = new ArrayList<>(); - if (settings.outlets().surfaceSinkholesEnabled() - && settings.outlets().inlandGrotto().enabled()) { - inlandCandidates.addAll(styledInlandOutlets( - grid, - inlandOutletCandidates(grid, new boolean[grid.nodes().size()]), - true - )); - } - if (oceanCandidates.isEmpty() && inlandCandidates.isEmpty()) { - return List.of(); - } - sortSurfaceFallbackOutletCandidates(grid, oceanCandidates); - sortSurfaceFallbackOutletCandidates(grid, inlandCandidates); - // Trials alternate sea and inland outlets, sea first: a coast with more mouths than trials - // still gives a sinkhole its turn, and a rejected mouth is retried at the next coast. - ArrayList candidates = new ArrayList<>(oceanCandidates.size() + inlandCandidates.size()); - for (int index = 0; index < Math.max(oceanCandidates.size(), inlandCandidates.size()); index++) { - if (index < oceanCandidates.size()) { - candidates.add(oceanCandidates.get(index)); - } - if (index < inlandCandidates.size()) { - candidates.add(inlandCandidates.get(index)); - } - } - int maximumTrials = Math.max( - OPTIONAL_SOURCE_REJECTIONS_PER_TARGET, - Math.multiplyExact( - Math.max(settings.outlets().maximumPerTile(), settings.outlets().maximumCoastalPerTile()), - 16 - ) - ); - maximumTrials = Math.min(16, maximumTrials); - return limitOutlets(candidates, maximumTrials); - } - - private ArrayList inlandOutletCandidates( - SampledGrid grid, - boolean[] oceanReachable - ) { - ArrayList inlandCandidates = new ArrayList<>(); - for (GridNode node : grid.nodes()) { - if (!grid.owns(node.x(), node.z()) - || node.terrain().ocean() || !node.terrain().caveAvailable() - || !node.terrain().transitAllowed() || !node.terrain().outletAllowed() - || oceanReachable[node.index()]) { - continue; - } - InlandConnection connection = inlandConnection(node); - int poolY = clamp( - connection.terrain().caveFluidY(), - settings.underground().minimumFluidY(), - settings.underground().maximumFluidY() - ); - if (settings.outlets().surfaceSinkholesEnabled() - && node.terrain().naturalHeight() - settings.surface().banks().sink() <= poolY) { - continue; - } - long outletId = HydrologyHash.mix( - worldSeed, - OUTLET_SALT, - node.id(), - connection.point().x(), - connection.point().z(), - HydrologyFeatureType.INLAND_GROTTO.ordinal() - ); - RiverOutlet outlet = new RiverOutlet( - outletId, - HydrologyFeatureType.INLAND_GROTTO, - node.id(), - new HydrologyPoint(node.x(), node.terrain().naturalHeight(), node.z()), - withY(connection.point(), poolY), - settingsSeaLevel(node.terrain()), - false - ); - inlandCandidates.add(new OutletCandidate(node.index(), -1, outlet)); - } - return inlandCandidates; - } - - private void sortInlandOutletCandidates( - SampledGrid grid, - List inlandCandidates - ) { - inlandCandidates.sort(Comparator - .comparing((OutletCandidate candidate) -> !isDrainageBasin(grid, candidate.landIndex())) - .thenComparingInt((OutletCandidate candidate) -> grid.node(candidate.landIndex()).terrain().naturalHeight()) - .thenComparingLong((OutletCandidate candidate) -> candidate.outlet().id())); - } - - private void sortSurfaceFallbackOutletCandidates( - SampledGrid grid, - List candidates - ) { - HashMap capacities = new HashMap<>(candidates.size()); - for (OutletCandidate candidate : candidates) { - capacities.put(candidate.landIndex(), surfaceOutletCapacity(grid, candidate.landIndex())); - } - candidates.sort(Comparator - .comparing((OutletCandidate candidate) -> !isDrainageBasin(grid, candidate.landIndex())) - .thenComparingInt((OutletCandidate candidate) -> - capacities.get(candidate.landIndex()) > 0L ? 0 : 1) - .thenComparingInt((OutletCandidate candidate) -> ownedOutletRank(grid, candidate)) - .thenComparing(Comparator - .comparingLong((OutletCandidate candidate) -> capacities.get(candidate.landIndex())) - .reversed()) - .thenComparingInt((OutletCandidate candidate) -> - grid.node(candidate.landIndex()).terrain().naturalHeight()) - .thenComparingLong((OutletCandidate candidate) -> candidate.outlet().id())); - } - - private boolean isDrainageBasin(SampledGrid grid, int nodeIndex) { - GridNode node = grid.node(nodeIndex); - int height = node.terrain().naturalHeight(); - for (GridOffset offset : ROUTING_OFFSETS) { - GridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); - if (neighbor != null - && !neighbor.terrain().ocean() - && neighbor.terrain().transitAllowed() - && neighbor.terrain().naturalHeight() < height) { - return false; - } - } - return true; - } - - private boolean[] outletReachable(SampledGrid grid, List outlets, boolean surface) { - int maximumRise = surface ? maximumSurfaceEdgeRise() : Integer.MAX_VALUE; - boolean[] reachable = new boolean[grid.nodes().size()]; - int[] queue = new int[reachable.length]; - int readIndex = 0; - int writeIndex = 0; - for (OutletCandidate outlet : outlets) { - if (reachable[outlet.landIndex()]) { - continue; - } - reachable[outlet.landIndex()] = true; - queue[writeIndex++] = outlet.landIndex(); - } - while (readIndex < writeIndex) { - GridNode node = grid.node(queue[readIndex++]); - for (GridOffset offset : ROUTING_OFFSETS) { - GridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); - if (neighbor == null || reachable[neighbor.index()] || neighbor.terrain().ocean() - || !neighbor.terrain().transitAllowed() - || node.terrain().naturalHeight() - neighbor.terrain().naturalHeight() > maximumRise) { - continue; - } - reachable[neighbor.index()] = true; - queue[writeIndex++] = neighbor.index(); - } - } - return reachable; - } - - private List styledInlandOutlets( - SampledGrid grid, - List candidates, - boolean surface - ) { - ArrayList styled = new ArrayList<>(candidates.size()); - for (OutletCandidate candidate : candidates) { - GridNode node = grid.node(candidate.landIndex()); - RiverOutlet outlet = candidate.outlet(); - HydrologyPoint landward = routeAnchor(node); - HydrologyTerrainSample landwardTerrain = Objects.requireNonNull( - sampleDetailed(landward.x(), landward.z()), - "Hydrology inland outlet anchor left sampled terrain" - ); - int connectionOffsetX = Integer.compare(outlet.connectionPoint().x(), outlet.landwardPoint().x()); - int connectionOffsetZ = Integer.compare(outlet.connectionPoint().z(), outlet.landwardPoint().z()); - HydrologyPoint connection = new HydrologyPoint( - landward.x() + connectionOffsetX, - outlet.connectionPoint().y(), - landward.z() + connectionOffsetZ - ); - int poolY = sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, - "", - connection.x(), - connection.z(), - 0L, - settings.underground().minimumFluidY(), - settings.underground().maximumFluidY() - ); - if (surface && settings.outlets().surfaceSinkholesEnabled()) { - poolY = Math.min( - poolY, - landwardTerrain.naturalHeight() - settings.surface().banks().sink() - 1 - ); - poolY = Math.max( - poolY, - landwardTerrain.naturalHeight() - settings.routing().sampleSpacing() - ); - } - styled.add(new OutletCandidate( - candidate.landIndex(), - candidate.oceanIndex(), - new RiverOutlet( - outlet.id(), - outlet.type(), - outlet.drainageNodeId(), - withY(landward, landwardTerrain.naturalHeight()), - withY(connection, poolY), - outlet.seaLevel(), - outlet.directOcean() - ) - )); - } - return List.copyOf(styled); - } - - private InlandConnection inlandConnection(GridNode node) { - GridOffset offset = CARDINAL_OFFSETS.getFirst(); - long selectedTie = inlandConnectionTie(node, offset); - for (int index = 1; index < CARDINAL_OFFSETS.size(); index++) { - GridOffset candidate = CARDINAL_OFFSETS.get(index); - long candidateTie = inlandConnectionTie(node, candidate); - if (candidateTie < selectedTie) { - offset = candidate; - selectedTie = candidateTie; - } - } - HydrologyTerrainSample terrain = node.terrain(); - return new InlandConnection( - new HydrologyPoint( - node.x() + offset.x(), - terrain.caveFluidY(), - node.z() + offset.z() - ), - terrain - ); - } - - private long inlandConnectionTie(GridNode node, GridOffset offset) { - return HydrologyHash.mix( - worldSeed, - OUTLET_SALT, - node.id(), - node.x() + offset.x(), - node.z() + offset.z() - ); - } - - private GridNode firstOceanNeighbor(SampledGrid grid, GridNode land) { - ArrayList oceans = new ArrayList<>(); - for (GridOffset offset : CARDINAL_OFFSETS) { - GridNode neighbor = grid.nodeAt(land.gridX() + offset.x(), land.gridZ() + offset.z()); - if (neighbor != null && neighbor.terrain().ocean()) { - oceans.add(neighbor); - } - } - oceans.sort(Comparator.comparingLong(GridNode::id)); - return oceans.isEmpty() ? null : oceans.getFirst(); - } - - private HydrologyOceanBoundaryRefiner.Result refineOceanBoundary(GridNode land, GridNode ocean) { - List crossing = line(land.naturalPoint(), ocean.naturalPoint(), 1); - return HydrologyOceanBoundaryRefiner.refine(crossing, sampler, routingSampler); - } - - private HydrologyFeatureType coastalOutletType(HydrologyTerrainSample land) { - HydrologyPlannerSettings.Outlets outlets = settings.outlets(); - // A zero slope factor turns the slope rule off, so only the coast's height over the sea decides. - boolean cliff = land.naturalHeight() - settingsSeaLevel(land) - >= outlets.coastalCliffMinimumHeight() - || outlets.coastalCliffSlopeFactor() > 0D - && land.slope() >= outlets.coastalCliffMinimumHeight() * outlets.coastalCliffSlopeFactor(); - if (cliff && outlets.coastalGrotto().enabled()) { - return HydrologyFeatureType.COASTAL_GROTTO; - } - return outlets.oceanEnabled() ? HydrologyFeatureType.MOUTH : null; - } - - private Comparator outletComparator(HydrologyTileKey key) { - long tileHash = HydrologyHash.mix(worldSeed, key.tileX(), key.tileZ(), OUTLET_SALT); - return Comparator.comparingLong((OutletCandidate candidate) -> HydrologyHash.mix(tileHash, candidate.outlet().id())); - } - - private void sortOutletCandidates( - HydrologyTileKey key, - SampledGrid grid, - boolean surface, - List candidates - ) { - // An owned coast outranks a neighbour's: a halo mouth only takes a slot when no owned - // coast can serve the tile's sources. - Comparator owned = Comparator.comparingInt( - (OutletCandidate candidate) -> ownedOutletRank(grid, candidate)); - if (!surface) { - candidates.sort(owned.thenComparing(outletComparator(key))); - return; - } - HashMap capacities = new HashMap<>(candidates.size()); - for (OutletCandidate candidate : candidates) { - capacities.put(candidate.landIndex(), surfaceOutletCapacity(grid, candidate.landIndex())); - } - Comparator stable = outletComparator(key); - candidates.sort(Comparator - .comparingInt((OutletCandidate candidate) -> - capacities.get(candidate.landIndex()) > 0L ? 0 : 1) - .thenComparing(owned) - .thenComparingInt(this::surfaceOutletPriority) - .thenComparing(Comparator - .comparingLong((OutletCandidate candidate) -> capacities.get(candidate.landIndex())) - .reversed()) - .thenComparing(stable)); - } - - private int ownedOutletRank(SampledGrid grid, OutletCandidate candidate) { - GridNode land = grid.node(candidate.landIndex()); - return grid.owns(land.x(), land.z()) ? 0 : 1; - } - - private int surfaceOutletPriority(OutletCandidate candidate) { - return switch (candidate.outlet().type()) { - case MOUTH -> 0; - case COASTAL_GROTTO -> 1; - case INLAND_GROTTO -> 2; - default -> 3; - }; - } - - private long surfaceOutletCapacity(SampledGrid grid, int outletNodeIndex) { - boolean[] visited = new boolean[grid.nodes().size()]; - int[] distances = new int[grid.nodes().size()]; - Arrays.fill(distances, -1); - int[] queue = new int[visited.length]; - int readIndex = 0; - int writeIndex = 0; - visited[outletNodeIndex] = true; - distances[outletNodeIndex] = 0; - queue[writeIndex++] = outletNodeIndex; - long capacity = 0L; - while (readIndex < writeIndex) { - GridNode downstream = grid.node(queue[readIndex++]); - if (grid.owns(downstream.x(), downstream.z()) - && downstream.terrain().surfaceSourceAllowed() - && downstream.terrain().naturalHeight() >= settings.surface().sources().minimumElevation() - && distances[downstream.index()] - >= settings.routing().minimumSurfaceCourseLength()) { - capacity = Math.addExact( - capacity, - 1_000_000L - + distances[downstream.index()] - + Math.max(0, downstream.terrain().naturalHeight() - settings.seaLevel()) - ); - } - for (GridOffset offset : ROUTING_OFFSETS) { - GridNode upstream = grid.nodeAt( - downstream.gridX() + offset.x(), - downstream.gridZ() + offset.z() - ); - if (upstream == null - || visited[upstream.index()] - || upstream.terrain().ocean() - || !upstream.terrain().transitAllowed()) { - continue; - } - visited[upstream.index()] = true; - distances[upstream.index()] = Math.addExact( - distances[downstream.index()], - settings.routing().sampleSpacing() - ); - queue[writeIndex++] = upstream.index(); - } - } - return capacity; - } - - private List limitOutlets(List candidates, int maximum) { - if (maximum <= 0 || candidates.isEmpty()) { - return List.of(); - } - ArrayList selected = new ArrayList<>(Math.min(maximum, candidates.size())); - long minimumSpacingSquared = outletSpacingSquared(); - for (OutletCandidate candidate : candidates) { - if (!withinOutletSpacing(candidate, selected, minimumSpacingSquared)) { - selected.add(candidate); - if (selected.size() == maximum) { - break; - } - } - } - if (selected.isEmpty() && !candidates.isEmpty()) { - selected.add(candidates.getFirst()); - } - return List.copyOf(selected); - } - - /** - * Takes sea outlets in turns by type (the best mouth, the best coastal grotto, the next mouth, ...) - * from a sorted candidate list until the budget is spent or no type has a candidate left that - * keeps the outlet spacing. A coast with both cliffs and beaches gets both kinds of opening. - */ - private List limitOutletsByType(List candidates, int maximum) { - if (maximum <= 0 || candidates.isEmpty()) { - return List.of(); - } - ArrayList selected = new ArrayList<>(Math.min(maximum, candidates.size())); - long minimumSpacingSquared = outletSpacingSquared(); - boolean[] consumed = new boolean[candidates.size()]; - boolean progressed = true; - while (selected.size() < maximum && progressed) { - progressed = false; - for (HydrologyFeatureType type : COASTAL_OUTLET_TYPES) { - for (int index = 0; index < candidates.size(); index++) { - OutletCandidate candidate = candidates.get(index); - if (consumed[index] || candidate.outlet().type() != type) { - continue; - } - consumed[index] = true; - if (withinOutletSpacing(candidate, selected, minimumSpacingSquared)) { - continue; - } - selected.add(candidate); - progressed = true; - break; - } - if (selected.size() == maximum) { - break; - } - } - } - return List.copyOf(selected); - } - - private long outletSpacingSquared() { - int minimumSpacing = settings.routing().sampleSpacing() * 2; - return (long) minimumSpacing * minimumSpacing; - } - - private boolean withinOutletSpacing( - OutletCandidate candidate, - List selected, - long minimumSpacingSquared - ) { - for (OutletCandidate existing : selected) { - if (candidate.outlet().landwardPoint().distanceSquared2D(existing.outlet().landwardPoint()) - < minimumSpacingSquared) { - return true; - } - } - return false; - } - - private void addRejectedOutlets( - List candidates, - List selected, - List diagnostics - ) { - for (OutletCandidate candidate : candidates) { - boolean accepted = false; - for (OutletCandidate acceptedCandidate : selected) { - if (candidate.outlet().id() == acceptedCandidate.outlet().id()) { - accepted = true; - break; - } - } - if (!accepted) { - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(candidate.outlet().id(), DIAGNOSTIC_SALT), - HydrologyCandidateKind.OUTLET, - candidate.outlet().type(), - candidate.outlet().landwardPoint(), - HydrologyCandidateRejection.OUTLET_LIMIT, 0 - )); - } - } - } - - /** - * Drops the sea outlets an underground river cannot reach because the sea sits above the - * underground fluid ceiling, reporting each as OUTLET_LEVEL with the shortfall as the detail. - */ - private void addOutletLevelDiagnostics( - List candidates, - List diagnostics - ) { - int maximumFluidY = settings.underground().maximumFluidY(); - ArrayList retained = new ArrayList<>(candidates.size()); - for (OutletCandidate candidate : candidates) { - int seaY = candidate.outlet().connectionPoint().y(); - if (seaY <= maximumFluidY) { - retained.add(candidate); - continue; - } - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix( - candidate.outlet().id(), - DIAGNOSTIC_SALT, - HydrologyCandidateRejection.OUTLET_LEVEL.ordinal() - ), - HydrologyCandidateKind.OUTLET, - candidate.outlet().type(), - candidate.outlet().landwardPoint(), - HydrologyCandidateRejection.OUTLET_LEVEL, - seaY - maximumFluidY - )); - } - candidates.clear(); - candidates.addAll(retained); - } - - private RoutingPlan buildRouting( - SampledGrid grid, - List outlets, - boolean surface - ) { - // A surface river never climbs: any rise along its route becomes a cut of at least that rise, - // so lattice edges that rise more than a small saddle are not drainage at all. - int maximumRise = surface ? maximumSurfaceEdgeRise() : Integer.MAX_VALUE; - int nodeCount = grid.nodes().size(); - double[] potential = new double[nodeCount]; - int[] parent = new int[nodeCount]; - int[] outletIndex = new int[nodeCount]; - int[] minimumNeighborHeights = new int[nodeCount]; - for (GridNode node : grid.nodes()) { - minimumNeighborHeights[node.index()] = minimumNeighborHeight(grid, node); - } - Arrays.fill(potential, Double.POSITIVE_INFINITY); - Arrays.fill(parent, -1); - Arrays.fill(outletIndex, -1); - PriorityQueue queue = new PriorityQueue<>(); - for (int index = 0; index < outlets.size(); index++) { - OutletCandidate outlet = outlets.get(index); - potential[outlet.landIndex()] = 0D; - outletIndex[outlet.landIndex()] = index; - queue.add(new RoutingQueueEntry(outlet.landIndex(), 0D, index)); - } - while (!queue.isEmpty()) { - RoutingQueueEntry currentEntry = queue.poll(); - if (currentEntry.potential() != potential[currentEntry.nodeIndex()] - || currentEntry.outletIndex() != outletIndex[currentEntry.nodeIndex()]) { - continue; - } - GridNode downstream = grid.node(currentEntry.nodeIndex()); - for (GridOffset offset : ROUTING_OFFSETS) { - GridNode upstream = grid.nodeAt(downstream.gridX() + offset.x(), downstream.gridZ() + offset.z()); - if (upstream == null || upstream.terrain().ocean() || !upstream.terrain().transitAllowed() - || !upstream.terrain().drainsInto(downstream.terrain())) { - // Confined ground only drains into its own area, so every course that starts or - // arrives there keeps to that area up to and including its outlet. - continue; - } - if (downstream.terrain().naturalHeight() - upstream.terrain().naturalHeight() > maximumRise) { - continue; - } - double edgeCost = routeCost( - upstream, - downstream, - offset, - minimumNeighborHeights[downstream.index()] - ); - double candidatePotential = currentEntry.potential() + edgeCost; - int existingParent = parent[upstream.index()]; - boolean replace = candidatePotential < potential[upstream.index()] - 1.0E-9D; - if (!replace && StrictMath.abs(candidatePotential - potential[upstream.index()]) <= 1.0E-9D) { - replace = existingParent < 0 || downstream.id() < grid.node(existingParent).id(); - } - if (!replace) { - continue; - } - potential[upstream.index()] = candidatePotential; - parent[upstream.index()] = downstream.index(); - outletIndex[upstream.index()] = currentEntry.outletIndex(); - queue.add(new RoutingQueueEntry( - upstream.index(), - candidatePotential, - currentEntry.outletIndex() - )); - } - } - return new RoutingPlan( - potential, - parent, - outletIndex, - routeLengths(parent, grid.width(), settings.routing()), - List.copyOf(outlets), - false - ); - } - - /** - * Largest rise a surface drainage edge may take. Heads only fall, so a rise along a route becomes a cut - * of at least that rise; the lattice may climb no more than the cut the valley solver still accepts. - */ - private int maximumSurfaceEdgeRise() { - int permitted = settings.surface().maximumIncision() - settings.surface().banks().sink() - settings.surface().minimumDepth(); - return Math.max(1, permitted); - } - - private RoutingPlan requireOrganicSurface(RoutingPlan routing) { - return new RoutingPlan( - routing.potential(), - routing.parent(), - routing.outletIndex(), - routing.routeLengths(), - routing.outlets(), - true - ); - } - - private int permittedSurfaceIncision(HydrologyTerrainSample terrain) { - return permittedSurfaceIncision( - settings.surface().maximumIncision(), - terrain.incisionMultiplier() - ); - } - - static int permittedSurfaceIncision(int maximumIncision, double incisionMultiplier) { - return Math.min( - maximumIncision, - (int) StrictMath.floor(maximumIncision * incisionMultiplier) - ); - } - - private double routeCost( - GridNode upstream, - GridNode downstream, - GridOffset offset, - int valleyFloor - ) { - HydrologyPlannerSettings.Routing routing = settings.routing(); - double baseDistance = routing.sampleSpacing() * (offset.x() != 0 && offset.z() != 0 ? StrictMath.sqrt(2D) : 1D); - double downstreamRise = Math.max(0D, downstream.terrain().naturalHeight() - upstream.terrain().naturalHeight()); - double valleyCost = Math.max(0D, downstream.terrain().naturalHeight() - valleyFloor) * routing.valleyPreference(); - double policyCost = upstream.terrain().routingCost() + downstream.terrain().routingCost(); - double policyMultiplier = Math.max(0.01D, - (upstream.terrain().routingMultiplier() + downstream.terrain().routingMultiplier()) * 0.5D); - double slopeCost = (upstream.terrain().slope() + downstream.terrain().slope()) - * 0.5D * routing.slopePenalty(); - double attractionDiscount = routing.confluenceAttraction() - * Math.max(0D, upstream.terrain().naturalHeight() - downstream.terrain().naturalHeight()); - return Math.max(0.001D, - (baseDistance + downstreamRise * routing.uphillPenalty() + valleyCost + slopeCost + policyCost) - * policyMultiplier - attractionDiscount); - } - - private int minimumNeighborHeight(SampledGrid grid, GridNode node) { - int minimum = node.terrain().naturalHeight(); - for (GridOffset offset : ROUTING_OFFSETS) { - GridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); - if (neighbor != null && !neighbor.terrain().ocean()) { - minimum = Math.min(minimum, neighbor.terrain().naturalHeight()); - } - } - return minimum; - } - - private SourceSelection selectSources( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan routing, - boolean surface, - boolean enforceGlobalSpacing, - List diagnostics, - Map routingContexts - ) { - HydrologyPlannerSettings.Source sourceSettings = surface - ? settings.surface().sources() - : settings.underground().sources(); - if (!sourceSettings.enabled()) { - return SourceSelection.empty(surface); - } - long sourceSalt = surface ? SURFACE_SOURCE_SALT : UNDERGROUND_SOURCE_SALT; - ArrayList candidates = new ArrayList<>(); - boolean hasRequiredCandidate = false; - for (GridNode node : grid.nodes()) { - if (!grid.owns(node.x(), node.z())) { - continue; - } - HydrologyTerrainSample terrain = node.terrain(); - boolean allowed = surface ? terrain.surfaceSourceAllowed() : terrain.undergroundSourceAllowed(); - boolean required = surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(); - if (!allowed || surface && terrain.naturalHeight() < sourceSettings.minimumElevation()) { - continue; - } - double weight = surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(); - if (weight <= 0D && !required) { - continue; - } - long stable = sourceStableId(sourceSalt, node.x(), node.z()); - if (routing.outlets().isEmpty()) { - addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.NO_LEGAL_OUTLET, diagnostics); - continue; - } - if (!Double.isFinite(routing.potential()[node.index()]) || routing.parent()[node.index()] < 0) { - addSourceDiagnostic(node, surface, stable, terrain.confinesKey() != null - ? HydrologyCandidateRejection.CONFINED_NO_OUTLET - : HydrologyCandidateRejection.NO_DRAINAGE_PATH, diagnostics); - continue; - } - if (!sourceOutletAllowed(node, routing, surface)) { - addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.NO_LEGAL_OUTLET, diagnostics); - continue; - } - if (!surface && settings.underground().connectToExistingCaves() && !terrain.caveAvailable()) { - addSourceDiagnostic(node, false, stable, HydrologyCandidateRejection.CAVE_CONTAINMENT, diagnostics); - continue; - } - int routeLength = routing.routeLengths()[node.index()]; - if (routeLength <= 0 || routeLength > settings.routing().maximumRouteLength()) { - addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.ROUTE_LIMIT, diagnostics); - continue; - } - if (routeLength < settings.routing().minimumCourseLength(surface)) { - addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.COURSE_TOO_SHORT, diagnostics); - continue; - } - // Elevation and route length share the same scale: 1000 route blocks count as 100 blocks of height. - double score = (required ? 1.0E15D : 0D) - + weight * 1.0E9D - + (terrain.naturalHeight() + routeLength * 0.1D * settings.routing().lengthPreference()) * 1.0E5D - + routing.potential()[node.index()] - + HydrologyHash.unit(stable); - candidates.add(new SourceCandidate(node.index(), stable, score, required)); - hasRequiredCandidate |= required; - } - int target = expectedCount(sourceSettings.density(), HydrologyHash.mix( - worldSeed, - sourceSalt, - key.tileX(), - key.tileZ() - )); - int requiredMinimum = hasRequiredCandidate - ? Math.max(1, sourceSettings.minimumPerTile()) - : 0; - target = Math.max(requiredMinimum, target); - int maximum = hasRequiredCandidate - ? Math.max(1, sourceSettings.maximumPerTile()) - : sourceSettings.maximumPerTile(); - target = Math.min(maximum, target); - int tributaries = surface ? settings.routing().tributaries() : settings.underground().tributaries(); - int coursesPerOutlet = 1 + tributaries; - // Tributaries are budgeted on top of the source density: every outlet may draw its extra courses - // beyond the tile's expected count, or no junction would ever fit inside a one-source budget. - int tributaryBudget = Math.multiplyExact(routing.outlets().size(), tributaries); - target = Math.min(Math.addExact(maximum, tributaryBudget), Math.addExact(target, tributaryBudget)); - target = effectiveSourceTarget(surface && !enforceGlobalSpacing, target, routing.outlets().size(), coursesPerOutlet); - Comparator candidateOrder = Comparator - .comparing(SourceCandidate::required) - .reversed(); - candidates.sort(candidateOrder - .thenComparing(Comparator.comparingDouble(SourceCandidate::score).reversed()) - .thenComparingLong(SourceCandidate::stableId)); - prioritizeInlandSource(candidates, routing); - int guaranteed = Math.min(target, requiredMinimum); - int maximumCoursesPerOutlet = coursesPerOutlet; - SourceAdmissionSelection admission = selectSourceAdmissionsByOutlet( - candidates, - routing, - target, - guaranteed, - maximumCoursesPerOutlet, - (int candidateIndex) -> { - if (!enforceGlobalSpacing) { - return true; - } - SourceCandidate candidate = candidates.get(candidateIndex); - return globallyAdmittedSource( - grid.node(candidate.nodeIndex()), - sourceSettings, - sourceSalt, - surface, - routingContexts - ); - } - ); - int rejectionsPerTarget = surface - ? SURFACE_OPTIONAL_SOURCE_REJECTIONS_PER_TARGET - : OPTIONAL_SOURCE_REJECTIONS_PER_TARGET; - int maximumOptionalRejections = Math.max( - rejectionsPerTarget, - target * rejectionsPerTarget - ); - int admittedGuaranteed = Math.min(guaranteed, admission.selectedCandidateIndices().size()); - return new SourceSelection( - surface, - candidates, - admission, - admittedGuaranteed, - maximumOptionalRejections - ); - } - - static int effectiveSourceTarget(boolean outletBounded, int requestedTarget, int outletCount) { - return effectiveSourceTarget(outletBounded, requestedTarget, outletCount, 1); - } - - static int effectiveSourceTarget(boolean outletBounded, int requestedTarget, int outletCount, int coursesPerOutlet) { - if (requestedTarget < 0 || outletCount < 0 || coursesPerOutlet < 1) { - throw new IllegalArgumentException("Source target bounds cannot be negative."); - } - long bound = (long) outletCount * coursesPerOutlet; - return outletBounded ? (int) Math.min(requestedTarget, bound) : requestedTarget; - } - - private SourceAdmissionSelection selectSourceAdmissionsByOutlet( - List candidates, - RoutingPlan routing, - int target, - int guaranteed, - int maximumCoursesPerOutlet, - IntPredicate globallyAdmitted - ) { - int candidateCount = candidates.size(); - ArrayList selected = new ArrayList<>(Math.min(candidateCount, target)); - boolean[] selectedCandidates = new boolean[candidateCount]; - boolean[] spacingRejectedCandidates = new boolean[candidateCount]; - boolean[] evaluatedCandidates = new boolean[candidateCount]; - int[] outletIndices = new int[candidateCount]; - HashMap selectedByOutlet = new HashMap<>(); - for (int candidateIndex = 0; candidateIndex < candidateCount; candidateIndex++) { - outletIndices[candidateIndex] = routing.outletIndex()[candidates.get(candidateIndex).nodeIndex()]; - } - for (int candidateIndex = 0; - candidateIndex < candidateCount && selected.size() < target; - candidateIndex++) { - int outletIndex = outletIndices[candidateIndex]; - if (selectedByOutlet.getOrDefault(outletIndex, 0) >= maximumCoursesPerOutlet) { - continue; - } - evaluatedCandidates[candidateIndex] = true; - if (!globallyAdmitted.test(candidateIndex)) { - spacingRejectedCandidates[candidateIndex] = true; - continue; - } - selected.add(candidateIndex); - selectedCandidates[candidateIndex] = true; - selectedByOutlet.merge(outletIndex, 1, Math::addExact); - } - for (int candidateIndex = 0; - candidateIndex < candidateCount && selected.size() < guaranteed; - candidateIndex++) { - if (selectedCandidates[candidateIndex]) { - continue; - } - int outletIndex = outletIndices[candidateIndex]; - if (selectedByOutlet.getOrDefault(outletIndex, 0) >= maximumCoursesPerOutlet) { - continue; - } - selected.add(candidateIndex); - selectedCandidates[candidateIndex] = true; - spacingRejectedCandidates[candidateIndex] = false; - selectedByOutlet.merge(outletIndex, 1, Math::addExact); - } - return new SourceAdmissionSelection( - target, - selected, - selectedCandidates, - spacingRejectedCandidates, - evaluatedCandidates, - globallyAdmitted, - outletIndices, - maximumCoursesPerOutlet - ); - } - - private void prioritizeInlandSource(List candidates, RoutingPlan routing) { - if (candidates.size() < 2) { - return; - } - boolean required = candidates.getFirst().required(); - for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { - SourceCandidate candidate = candidates.get(candidateIndex); - if (candidate.required() != required) { - break; - } - if (!isInlandSource(candidate, routing)) { - continue; - } - if (candidateIndex > 0) { - candidates.addFirst(candidates.remove(candidateIndex)); - } - return; - } - } - - private boolean isInlandSource(SourceCandidate candidate, RoutingPlan routing) { - if (candidate == null) { - return false; - } - int outletIndex = routing.outletIndex()[candidate.nodeIndex()]; - return outletIndex >= 0 - && routing.outlets().get(outletIndex).outlet().type() == HydrologyFeatureType.INLAND_GROTTO; - } - - static SourceAdmissionSelection selectSourceAdmissions( - int candidateCount, - int target, - int guaranteed, - IntPredicate globallyAdmitted - ) { - if (candidateCount < 0 || target < 0 || guaranteed < 0 || guaranteed > target) { - throw new IllegalArgumentException("Source admission bounds are invalid."); - } - Objects.requireNonNull(globallyAdmitted, "globallyAdmitted"); - ArrayList selected = new ArrayList<>(Math.min(candidateCount, target)); - boolean[] selectedCandidates = new boolean[candidateCount]; - boolean[] spacingRejectedCandidates = new boolean[candidateCount]; - boolean[] evaluatedCandidates = new boolean[candidateCount]; - for (int candidateIndex = 0; - candidateIndex < candidateCount && selected.size() < target; - candidateIndex++) { - evaluatedCandidates[candidateIndex] = true; - if (!globallyAdmitted.test(candidateIndex)) { - spacingRejectedCandidates[candidateIndex] = true; - continue; - } - selected.add(candidateIndex); - selectedCandidates[candidateIndex] = true; - } - for (int candidateIndex = 0; - candidateIndex < candidateCount && selected.size() < guaranteed; - candidateIndex++) { - if (selectedCandidates[candidateIndex]) { - continue; - } - selected.add(candidateIndex); - selectedCandidates[candidateIndex] = true; - spacingRejectedCandidates[candidateIndex] = false; - } - return new SourceAdmissionSelection( - target, - selected, - selectedCandidates, - spacingRejectedCandidates, - evaluatedCandidates, - globallyAdmitted, - new int[candidateCount], - Integer.MAX_VALUE - ); - } - - private boolean globallyAdmittedSource( - GridNode candidate, - HydrologyPlannerSettings.Source sourceSettings, - long sourceSalt, - boolean surface, - Map routingContexts - ) { - int minimumSpacing = sourceSettings.minimumSpacing(); - boolean required = surface - ? candidate.terrain().surfaceSourceRequired() - : candidate.terrain().undergroundSourceRequired(); - if (minimumSpacing <= 0 || required) { - return true; - } - SourcePriority candidatePriority = sourcePriority(candidate.x(), candidate.z(), candidate.terrain(), sourceSalt, surface); - int sampleSpacing = settings.routing().sampleSpacing(); - int latticeRadius = (int) StrictMath.ceil(minimumSpacing / (double) sampleSpacing); - for (int offsetZ = -latticeRadius; offsetZ <= latticeRadius; offsetZ++) { - for (int offsetX = -latticeRadius; offsetX <= latticeRadius; offsetX++) { - if (offsetX == 0 && offsetZ == 0) { - continue; - } - long deltaX = (long) offsetX * sampleSpacing; - long deltaZ = (long) offsetZ * sampleSpacing; - if (StrictMath.hypot(deltaX, deltaZ) >= minimumSpacing) { - continue; - } - long neighborX = (long) candidate.x() + deltaX; - long neighborZ = (long) candidate.z() + deltaZ; - if (neighborX < Integer.MIN_VALUE || neighborX > Integer.MAX_VALUE - || neighborZ < Integer.MIN_VALUE || neighborZ > Integer.MAX_VALUE) { - continue; - } - int x = (int) neighborX; - int z = (int) neighborZ; - HydrologyTileKey owner = HydrologyTileKey.fromBlock(x, z, settings.routing().tileSize()); - SourceRoutingContext context = routingContexts.computeIfAbsent(owner, this::sourceRoutingContext); - GridNode neighbor = context.grid().nodeAtWorld(x, z); - if (neighbor == null) { - throw new IllegalStateException("Source coordinate is absent from its owner routing lattice."); - } - HydrologyTerrainSample terrain = neighbor.terrain(); - if (!rawSourceEligible(terrain, sourceSettings, surface)) { - continue; - } - if (!routeViable(neighbor, context, surface)) { - continue; - } - SourcePriority neighborPriority = sourcePriority(x, z, terrain, sourceSalt, surface); - if (compareSourcePriority(neighborPriority, candidatePriority) > 0) { - return false; - } - } - } - return true; - } - - private SourceRoutingContext sourceRoutingContext(HydrologyTileKey key) { + SourceRoutingContext sourceRoutingContext(HydrologyTileKey key) { SourceRoutingContext cached = routingContexts.getIfPresent(key); if (cached != null) { return cached; @@ -3081,7 +447,7 @@ public final class HydrologyPlanner { try { SourceRoutingContext resolved = routingContexts.getIfPresent(key); if (resolved == null) { - resolved = compileSourceRoutingContext(key); + resolved = sourcePlanner.compileSourceRoutingContext(key); routingContexts.put(key, resolved); } owned.future().complete(resolved); @@ -3094,4725 +460,19 @@ public final class HydrologyPlanner { } } - private SourceRoutingContext compileSourceRoutingContext(HydrologyTileKey key) { - SampledGrid grid = sample(key); - ArrayList diagnostics = new ArrayList<>(); - List surfaceOutlets = resolveOutlets(key, grid, true, diagnostics); - RoutingPlan surfaceRouting = buildRouting(grid, surfaceOutlets, true); - List undergroundOutlets = settings.underground().enabled() - ? resolveOutlets(key, grid, false, diagnostics) - : surfaceOutlets; - RoutingPlan undergroundRouting = settings.underground().enabled() - ? buildRouting(grid, undergroundOutlets, false) - : surfaceRouting; - return new SourceRoutingContext( - grid, - surfaceRouting, - undergroundRouting, - List.copyOf(diagnostics) - ); - } - - private boolean routeViable(GridNode node, SourceRoutingContext context, boolean surface) { - RoutingPlan routing = context.routing(surface); - if (routing.outlets().isEmpty() - || !Double.isFinite(routing.potential()[node.index()]) - || routing.parent()[node.index()] < 0 - || !sourceOutletAllowed(node, routing, surface)) { - return false; - } - int routeLength = routing.routeLengths()[node.index()]; - return routeLength >= settings.routing().minimumCourseLength(surface) - && routeLength <= settings.routing().maximumRouteLength(); - } - - private boolean sourceOutletAllowed(GridNode node, RoutingPlan routing, boolean surface) { - int outletIndex = routing.outletIndex()[node.index()]; - if (outletIndex < 0 || outletIndex >= routing.outlets().size()) { - return false; - } - RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); - return !surface - || outlet.type() != HydrologyFeatureType.INLAND_GROTTO - || settings.outlets().surfaceSinkholesEnabled(); - } - - private boolean rawSourceEligible( - HydrologyTerrainSample terrain, - HydrologyPlannerSettings.Source sourceSettings, - boolean surface - ) { - if (terrain.ocean() || !terrain.transitAllowed()) { - return false; - } - boolean allowed = surface ? terrain.surfaceSourceAllowed() : terrain.undergroundSourceAllowed(); - boolean required = surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(); - if (!allowed || surface && terrain.naturalHeight() < sourceSettings.minimumElevation()) { - return false; - } - if (!surface && settings.underground().connectToExistingCaves() && !terrain.caveAvailable()) { - return false; - } - double weight = surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(); - return required || weight > 0D; - } - - private SourcePriority sourcePriority( - int x, - int z, - HydrologyTerrainSample terrain, - long sourceSalt, - boolean surface - ) { - return new SourcePriority( - surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(), - surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(), - terrain.naturalHeight(), - sourceStableId(sourceSalt, x, z), - x, - z - ); - } - - private long sourceStableId(long sourceSalt, int x, int z) { - return HydrologyHash.mix(worldSeed, sourceSalt, x, z); - } - - private int compareSourcePriority(SourcePriority first, SourcePriority second) { - int requiredComparison = Boolean.compare(first.required(), second.required()); - if (requiredComparison != 0) { - return requiredComparison; - } - int weightComparison = Double.compare(first.weight(), second.weight()); - if (weightComparison != 0) { - return weightComparison; - } - int stableComparison = Long.compareUnsigned(first.stableId(), second.stableId()); - if (stableComparison != 0) { - return stableComparison; - } - int heightComparison = Integer.compare(first.naturalHeight(), second.naturalHeight()); - if (heightComparison != 0) { - return heightComparison; - } - int xComparison = Integer.compare(first.x(), second.x()); - return xComparison != 0 ? xComparison : Integer.compare(first.z(), second.z()); - } - - private static void addSourceDiagnostic( - GridNode node, - boolean surface, - long stableId, - HydrologyCandidateRejection rejection, - List diagnostics - ) { - int y = surface ? node.terrain().naturalHeight() : node.terrain().caveFluidY(); - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(stableId, DIAGNOSTIC_SALT, rejection.ordinal()), - HydrologyCandidateKind.SOURCE, - surface ? HydrologyFeatureType.SURFACE_POOL : HydrologyFeatureType.UNDERGROUND_POOL, - new HydrologyPoint(node.x(), y, node.z()), - rejection, 0 - )); - } - - private int expectedCount(double density, long stable) { - int count = (int) StrictMath.floor(density); - double remainder = density - count; - return count + (HydrologyHash.unit(stable) < remainder ? 1 : 0); - } - - static int[] routeLengths(int[] parent, int width, HydrologyPlannerSettings.Routing routing) { - int[] lengths = new int[parent.length]; - int[] pending = new int[parent.length]; - double[] distances = new double[parent.length]; - Arrays.fill(distances, Double.NaN); - double diagonalDistance = StrictMath.hypot(routing.sampleSpacing(), routing.sampleSpacing()); - for (int sourceIndex = 0; sourceIndex < parent.length; sourceIndex++) { - if (!Double.isNaN(distances[sourceIndex])) { - continue; - } - int current = sourceIndex; - int pendingCount = 0; - while (current >= 0 && Double.isNaN(distances[current])) { - pending[pendingCount++] = current; - distances[current] = -1D; - current = parent[current]; - } - if (current >= 0 && distances[current] < 0D) { - throw new IllegalStateException("Hydrology drainage routing contains a cycle."); - } - double distance = current < 0 ? 0D : distances[current]; - while (pendingCount > 0) { - int node = pending[--pendingCount]; - int next = parent[node]; - if (next >= 0) { - boolean cardinal = node / width == next / width || node % width == next % width; - distance += cardinal ? routing.sampleSpacing() : diagonalDistance; - } - distances[node] = distance; - lengths[node] = distance > routing.maximumRouteLength() - ? Integer.MAX_VALUE - : (int) StrictMath.ceil(distance); - } - } - return lengths; - } - - private int[] countContributions(List sources, RoutingPlan routing) { - int[] counts = new int[routing.parent().length]; - for (int source : sources) { - int current = source; - int steps = 0; - while (routing.parent()[current] >= 0 && steps++ < settings.routing().maximumRouteNodes()) { - counts[current]++; - current = routing.parent()[current]; - } - } - return counts; - } - - private CompiledGraph compileGraph( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan routing, - int[] surfaceContributions, - int[] undergroundContributions, - Map> refinedEdges - ) { - HashSet includedNodeIndices = new HashSet<>(); - ArrayList edges = new ArrayList<>(); - HashMap edgeByUpstream = new HashMap<>(); - for (GridNode upstream : grid.nodes()) { - int downstreamIndex = routing.parent()[upstream.index()]; - if (downstreamIndex < 0 || !Double.isFinite(routing.potential()[upstream.index()])) { - continue; - } - boolean acceptedCourseEdge = surfaceContributions[upstream.index()] > 0 - || undergroundContributions[upstream.index()] > 0; - if (!acceptedCourseEdge) { - continue; - } - GridNode downstream = grid.node(downstreamIndex); - RiverOutlet outlet = routing.outlets().get(routing.outletIndex()[upstream.index()]).outlet(); - long edgeId = HydrologyHash.mix(worldSeed, EDGE_SALT, upstream.id(), downstream.id(), outlet.id()); - List centerline = refinedEdges.get(edgeId); - int transverseCandidates = ROUTE_TRANSVERSE_CANDIDATES; - if (centerline == null) { - HydrologyPoint upstreamAnchor = routeAnchor(upstream); - HydrologyPoint downstreamAnchor = routeAnchor(downstream); - HydrologyPoint continuation = edgeContinuation(grid, routing, downstream, outlet); - RefinedEdgeKey refinedEdgeKey = new RefinedEdgeKey( - upstream.id(), - downstream.id(), - upstreamAnchor.x(), - upstreamAnchor.z(), - downstreamAnchor.x(), - downstreamAnchor.z(), - continuation.x(), - continuation.z(), - transverseCandidates - ); - centerline = refinedEdgeCache.get( - refinedEdgeKey, - ignored -> refineEdge( - upstream.id(), - downstream.id(), - upstreamAnchor, - downstreamAnchor, - continuation, - transverseCandidates - ) - ); - refinedEdges.put(edgeId, centerline); - } - if (centerline.isEmpty()) { - HydrologyPoint upstreamAnchor = routeAnchor(upstream); - HydrologyPoint downstreamAnchor = routeAnchor(downstream); - HydrologyPoint continuation = edgeContinuation(grid, routing, downstream, outlet); - RefinedEdgeKey refinedEdgeKey = new RefinedEdgeKey( - upstream.id(), - downstream.id(), - upstreamAnchor.x(), - upstreamAnchor.z(), - downstreamAnchor.x(), - downstreamAnchor.z(), - continuation.x(), - continuation.z(), - ROUTE_FALLBACK_TRANSVERSE_CANDIDATES - ); - centerline = refinedEdgeCache.get( - refinedEdgeKey, - ignored -> refineEdge( - upstream.id(), - downstream.id(), - upstreamAnchor, - downstreamAnchor, - continuation, - ROUTE_FALLBACK_TRANSVERSE_CANDIDATES - ) - ); - refinedEdges.put(edgeId, centerline); - } - if (centerline.isEmpty()) { - centerline = constrainedTerrainFallbackEdge( - routeAnchor(upstream), - routeAnchor(downstream) - ); - refinedEdges.put(edgeId, centerline); - } - if (centerline.isEmpty()) { - continue; - } - double cost = routing.potential()[upstream.index()] - routing.potential()[downstreamIndex]; - DrainageEdge edge = new DrainageEdge( - edgeId, - upstream.id(), - downstream.id(), - outlet.id(), - cost, - surfaceContributions[upstream.index()], - undergroundContributions[upstream.index()], - centerline - ); - edges.add(edge); - edgeByUpstream.put(upstream.index(), edge); - includedNodeIndices.add(upstream.index()); - includedNodeIndices.add(downstream.index()); - } - ArrayList nodes = new ArrayList<>(includedNodeIndices.size()); - for (GridNode node : grid.nodes()) { - if (!includedNodeIndices.contains(node.index())) { - continue; - } - int outletIndex = routing.outletIndex()[node.index()]; - RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); - HydrologyPoint anchor = routeAnchor(node); - HydrologyTerrainSample terrain = Objects.requireNonNull( - sampleLandBasis(anchor.x(), anchor.z()), - "Hydrology route anchor left natural land" - ); - nodes.add(new DrainageNode( - node.id(), - anchor.x(), - anchor.z(), - terrain, - routing.potential()[node.index()], - outlet.id() - )); - } - ArrayList outlets = new ArrayList<>(routing.outlets().size()); - for (OutletCandidate outletCandidate : routing.outlets()) { - outlets.add(outletCandidate.outlet()); - } - return new CompiledGraph(List.copyOf(nodes), List.copyOf(edges), List.copyOf(outlets), Map.copyOf(edgeByUpstream)); - } - - private CompiledGraph mergeGraphs(CompiledGraph first, CompiledGraph second) { - LinkedHashMap nodes = new LinkedHashMap<>(); - for (DrainageNode node : first.nodes()) { - nodes.put(node.id(), node); - } - for (DrainageNode node : second.nodes()) { - nodes.putIfAbsent(node.id(), node); - } - LinkedHashMap edges = new LinkedHashMap<>(); - for (DrainageEdge edge : first.edges()) { - edges.put(edge.id(), edge); - } - for (DrainageEdge edge : second.edges()) { - DrainageNode upstream = nodes.get(edge.upstreamNodeId()); - DrainageNode downstream = nodes.get(edge.downstreamNodeId()); - if (upstream != null - && downstream != null - && downstream.potential() < upstream.potential()) { - edges.putIfAbsent(edge.id(), edge); - } - } - LinkedHashMap outlets = new LinkedHashMap<>(); - for (RiverOutlet outlet : first.outlets()) { - outlets.put(outlet.id(), outlet); - } - for (RiverOutlet outlet : second.outlets()) { - outlets.putIfAbsent(outlet.id(), outlet); - } - HashMap edgeByUpstream = new HashMap<>(first.edgeByUpstream()); - for (Map.Entry entry : second.edgeByUpstream().entrySet()) { - if (entry.getValue().equals(edges.get(entry.getValue().id()))) { - edgeByUpstream.putIfAbsent(entry.getKey(), entry.getValue()); - } - } - return new CompiledGraph( - List.copyOf(nodes.values()), - List.copyOf(edges.values()), - List.copyOf(outlets.values()), - Map.copyOf(edgeByUpstream) - ); - } - - private HydrologyPoint edgeContinuation( - SampledGrid grid, - RoutingPlan routing, - GridNode downstream, - RiverOutlet outlet - ) { - int continuationIndex = routing.parent()[downstream.index()]; - if (continuationIndex >= 0) { - return routeAnchor(grid.node(continuationIndex)); - } - HydrologyPoint landward = outlet.landwardPoint(); - if (landward.x() != downstream.x() || landward.z() != downstream.z()) { - return landward; - } - return outlet.connectionPoint(); - } - - private HydrologyPoint routeAnchor(GridNode node) { - PlanningSamples samples = planningSamples.get(); - if (samples != null) { - HydrologyPoint cached = samples.routeAnchors.get(node.id()); - if (cached != null) { - return cached; - } - } - int spacing = settings.routing().sampleSpacing(); - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - double maximumOffsetRatio = Math.min( - ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO, - meanders.maximumOffsetRatio() * 0.625D - ); - if (maximumOffsetRatio <= 0D) { - return node.naturalPoint(); - } - double primaryWavelength = meanders.primaryWavelength() * 5D; - double detailWavelength = meanders.detailWavelength() * 8D; - double primaryX = routeAnchorX.noiseSigned( - node.x() / primaryWavelength, - node.z() / primaryWavelength - ); - double primaryZ = routeAnchorZ.noiseSigned( - node.x() / primaryWavelength, - node.z() / primaryWavelength - ); - double detailX = routeAnchorX.noiseSigned( - node.x() / detailWavelength + 31.75D, - node.z() / detailWavelength - 19.25D - ); - double detailZ = routeAnchorZ.noiseSigned( - node.x() / detailWavelength - 27.5D, - node.z() / detailWavelength + 43.5D - ); - double vectorX = primaryX * 0.72D + detailX * 0.28D; - double vectorZ = primaryZ * 0.72D + detailZ * 0.28D; - double vectorLength = StrictMath.hypot(vectorX, vectorZ); - if (vectorLength < 0.1D) { - double angle = HydrologyHash.unit(HydrologyHash.mix(worldSeed, node.id(), ROUTE_ANCHOR_X_SALT)) - * StrictMath.PI * 2D; - vectorX = StrictMath.cos(angle); - vectorZ = StrictMath.sin(angle); - vectorLength = 1D; - } - double maximumOffset = spacing * maximumOffsetRatio; - double displacement = maximumOffset * (0.62D + Math.min(1D, vectorLength) * 0.38D); - int desiredX = (int) StrictMath.round(node.x() + vectorX / vectorLength * displacement); - int desiredZ = (int) StrictMath.round(node.z() + vectorZ / vectorLength * displacement); - int searchRadius = Math.max(settings.routing().refinementSpacing(), spacing / 5); - int innerRadius = Math.max(1, searchRadius / 2); - int[][] offsets = { - {0, 0}, - {innerRadius, 0}, {-innerRadius, 0}, {0, innerRadius}, {0, -innerRadius}, - {innerRadius, innerRadius}, {innerRadius, -innerRadius}, - {-innerRadius, innerRadius}, {-innerRadius, -innerRadius}, - {searchRadius, 0}, {-searchRadius, 0}, {0, searchRadius}, {0, -searchRadius}, - {node.x() - desiredX, node.z() - desiredZ} - }; - HydrologyPoint selected = node.naturalPoint(); - double selectedScore = anchorScore( - node, - selected.x(), - selected.z(), - desiredX, - desiredZ, - maximumOffsetRatio - ); - for (int[] offset : offsets) { - int x = desiredX + offset[0]; - int z = desiredZ + offset[1]; - double score = anchorScore(node, x, z, desiredX, desiredZ, maximumOffsetRatio); - if (score < selectedScore) { - HydrologyTerrainSample terrain = sampleLandBasis(x, z); - selected = new HydrologyPoint(x, terrain.naturalHeight(), z); - selectedScore = score; - } - } - if (samples != null) { - samples.routeAnchors.put(node.id(), selected); - } - return selected; - } - - private double anchorScore( - GridNode node, - int x, - int z, - int desiredX, - int desiredZ, - double maximumOffsetRatio - ) { - double distanceFromNode = StrictMath.hypot(x - node.x(), z - node.z()); - if (distanceFromNode > settings.routing().sampleSpacing() * maximumOffsetRatio) { - return Double.POSITIVE_INFINITY; - } - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(x, z); - if (terrain == null || !terrain.transitAllowed() || !withinConfines(terrain, node.terrain().confinesKey())) { - return Double.POSITIVE_INFINITY; - } - if (!traversableHop(node.naturalPoint(), new HydrologyPoint(x, terrain.naturalHeight(), z))) { - return Double.POSITIVE_INFINITY; - } - terrain = sampleLandBasis(x, z); - double distanceFromDesired = StrictMath.hypot(x - desiredX, z - desiredZ); - double score = terrain.naturalHeight() * settings.routing().valleyPreference() - + terrain.slope() * settings.routing().slopePenalty() - + terrain.routingCost() * terrain.routingMultiplier() - + distanceFromDesired * 2.4D - + distanceFromNode * 0.08D; - long tie = HydrologyHash.mix(worldSeed, node.id(), x, z); - return score + HydrologyHash.unit(tie) * 1.0E-6D; - } - - private List refineEdge( - long upstreamId, - long downstreamId, - HydrologyPoint upstream, - HydrologyPoint downstream, - HydrologyPoint continuation, - int transverseCandidates - ) { - int refinement = settings.routing().refinementSpacing(); - int effectiveTransverseCandidates = transverseCandidates; - double deltaX = downstream.x() - upstream.x(); - double deltaZ = downstream.z() - upstream.z(); - double distance = StrictMath.hypot(deltaX, deltaZ); - int steps = Math.max(1, (int) StrictMath.ceil(distance / refinement)); - Direction directTangent = direction(upstream.x(), upstream.z(), downstream.x(), downstream.z()); - Direction startTangent = directTangent; - Direction endTangent = direction(downstream.x(), downstream.z(), continuation.x(), continuation.z()); - if (endTangent.x() == 0D && endTangent.z() == 0D) { - endTangent = startTangent; - } - HydrologyTerrainSample upstreamTerrain = sampleLandBasis(upstream.x(), upstream.z()); - HydrologyTerrainSample downstreamTerrain = sampleLandBasis(downstream.x(), downstream.z()); - int transitionThreshold = settings.hydraulics().waterfallMinimumDrop(); - boolean elevationTransition = Math.abs(upstream.y() - downstream.y()) >= transitionThreshold - || upstreamTerrain != null && upstreamTerrain.slope() >= transitionThreshold - || downstreamTerrain != null && downstreamTerrain.slope() >= transitionThreshold; - if (elevationTransition) { - endTangent = directTangent; - } - double wormBlend = elevationTransition ? 0D : routeWormBlend(); - double tangentMagnitude = distance * (ROUTE_TANGENT_SCALE + wormBlend * 0.42D); - if (wormBlend > 0D) { - startTangent = routeWormDirection(upstream, startTangent, wormBlend); - endTangent = routeWormDirection(downstream, endTangent, wormBlend); - } - ArrayList> layers = new ArrayList<>(steps + 1); - for (int step = 0; step <= steps; step++) { - if (step == 0) { - layers.add(List.of(routeEndpoint(upstream, startTangent))); - continue; - } - if (step == steps) { - layers.add(List.of(routeEndpoint(downstream, endTangent))); - continue; - } - double progress = step / (double) steps; - RoutePosition nominal = routePosition( - upstream, - downstream, - startTangent, - endTangent, - tangentMagnitude, - distance, - progress, - elevationTransition ? 0D : 1D - ); - List candidates = routeCandidates( - upstreamId, - downstreamId, - nominal, - progress, - refinement, - elevationTransition ? 0 : effectiveTransverseCandidates, - upstreamTerrain == null ? null : upstreamTerrain.confinesKey() - ); - if (candidates.isEmpty()) { - return List.of(); - } - layers.add(candidates); - } - return solveTerrainRoute(layers, distance / steps); - } - - private double routeWormBlend() { - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - double strength = meanders.primaryStrength() + meanders.detailStrength() * 0.35D; - if (strength <= 0D || meanders.maximumOffsetRatio() <= 0D) { - return 0D; - } - return Math.min(0.18D, meanders.maximumOffsetRatio() * (0.08D + strength * 0.05D)); - } - - private Direction routeWormDirection(HydrologyPoint point, Direction fallback, double blend) { - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - double wavelength = Math.max( - settings.routing().sampleSpacing() * 2D, - meanders.primaryWavelength() * 2.5D - ); - double fieldX = routeWormPrimary.noiseSigned(point.x() / wavelength, point.z() / wavelength); - double fieldZ = routeWormDetail.noiseSigned( - point.x() / wavelength + 37.25D, - point.z() / wavelength - 21.75D - ); - double fieldLength = StrictMath.hypot(fieldX, fieldZ); - if (fieldLength < 0.05D) { - return fallback; - } - fieldX /= fieldLength; - fieldZ /= fieldLength; - if (fieldX * fallback.x() + fieldZ * fallback.z() < 0D) { - fieldX = -fieldX; - fieldZ = -fieldZ; - } - double blendedX = fallback.x() * (1D - blend) + fieldX * blend; - double blendedZ = fallback.z() * (1D - blend) + fieldZ * blend; - double blendedLength = StrictMath.hypot(blendedX, blendedZ); - return blendedLength <= 0D - ? fallback - : new Direction(blendedX / blendedLength, blendedZ / blendedLength); - } - - private List constrainedTerrainFallbackEdge( - HydrologyPoint upstream, - HydrologyPoint downstream - ) { - if (crossesTerrainCrevasse(upstream, downstream)) { - return List.of(); - } - double deltaX = downstream.x() - upstream.x(); - double deltaZ = downstream.z() - upstream.z(); - double distance = StrictMath.hypot(deltaX, deltaZ); - if (distance <= 0D) { - return List.of(); - } - int refinement = settings.routing().refinementSpacing(); - double perpendicularX = -deltaZ / distance; - double perpendicularZ = deltaX / distance; - List direct = line(upstream, downstream, refinement); - ArrayList points = new ArrayList<>(direct.size()); - for (int index = 0; index < direct.size(); index++) { - HydrologyPoint point = direct.get(index); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(point.x(), point.z()); - if (terrain == null || !terrain.transitAllowed()) { - return List.of(); - } - if (index > 0 && index < direct.size() - 1 - && hasLateralRouteFreedom(point, perpendicularX, perpendicularZ, refinement)) { - return List.of(); - } - points.add(new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z())); - } - return traversableRoute(points) && !containsTerrainPit(points) - ? List.copyOf(points) - : List.of(); - } - - private boolean hasLateralRouteFreedom( - HydrologyPoint point, - double perpendicularX, - double perpendicularZ, - int refinement - ) { - for (int direction : List.of(-1, 1)) { - int x = (int) StrictMath.round(point.x() + perpendicularX * refinement * direction); - int z = (int) StrictMath.round(point.z() + perpendicularZ * refinement * direction); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(x, z); - if (terrain != null && terrain.transitAllowed()) { - return true; - } - } - return false; - } - - private boolean containsTerrainPit(List route) { - int threshold = settings.hydraulics().waterfallMinimumDrop(); - for (int pointIndex = 1; pointIndex < route.size() - 1; pointIndex++) { - HydrologyPoint previous = route.get(pointIndex - 1); - HydrologyPoint point = route.get(pointIndex); - HydrologyPoint next = route.get(pointIndex + 1); - if (previous.y() - point.y() >= threshold && next.y() - point.y() >= threshold) { - return true; - } - } - return false; - } - - private RouteCandidate routeEndpoint( - HydrologyPoint point, - Direction tangent - ) { - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - if (terrain == null || !terrain.transitAllowed()) { - return new RouteCandidate( - point, - 0D, - Double.POSITIVE_INFINITY, - Double.POSITIVE_INFINITY, - tangent, - true - ); - } - double terrainScore = routeTerrainScore(terrain); - return new RouteCandidate( - new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z()), - 0D, - terrainScore, - terrainScore, - tangent, - true - ); - } - - private RoutePosition routePosition( - HydrologyPoint upstream, - HydrologyPoint downstream, - Direction startTangent, - Direction endTangent, - double tangentMagnitude, - double distance, - double progress, - double meanderScale - ) { - double tangentX = hermiteDerivative( - upstream.x(), - downstream.x(), - startTangent.x() * tangentMagnitude, - endTangent.x() * tangentMagnitude, - progress - ); - double tangentZ = hermiteDerivative( - upstream.z(), - downstream.z(), - startTangent.z() * tangentMagnitude, - endTangent.z() * tangentMagnitude, - progress - ); - double tangentLength = StrictMath.hypot(tangentX, tangentZ); - Direction tangent = tangentLength <= 0D - ? startTangent - : new Direction(tangentX / tangentLength, tangentZ / tangentLength); - double baseX = hermite( - upstream.x(), - downstream.x(), - startTangent.x() * tangentMagnitude, - endTangent.x() * tangentMagnitude, - progress - ); - double baseZ = hermite( - upstream.z(), - downstream.z(), - startTangent.z() * tangentMagnitude, - endTangent.z() * tangentMagnitude, - progress - ); - double envelope = StrictMath.pow(StrictMath.sin(StrictMath.PI * progress), 2D); - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - double primary = routeWormPrimary.noiseSigned( - baseX / meanders.primaryWavelength(), - baseZ / meanders.primaryWavelength() - ); - double detail = routeWormDetail.noiseSigned( - baseX / meanders.detailWavelength(), - baseZ / meanders.detailWavelength() - ); - double worm = distance * meanders.maximumOffsetRatio() * envelope * meanderScale * ( - primary * meanders.primaryStrength() - + detail * meanders.detailStrength() - ); - double anchorRatio = Math.min( - ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO, - meanders.maximumOffsetRatio() * 0.625D - ); - double transverseRatio = settings.routing().refinementSpacing() - / (double) settings.routing().sampleSpacing(); - double maximumWorm = distance * Math.max(0D, 0.5D - anchorRatio - transverseRatio); - worm = Math.max(-maximumWorm, Math.min(maximumWorm, worm)); - return new RoutePosition( - baseX - tangent.z() * worm, - baseZ + tangent.x() * worm, - baseX, - baseZ, - tangent - ); - } - - /** - * {@code confines} is the area the edge's upstream end is confined to, or null: candidates outside it - * are not offered, so a refined route between two confined lattice nodes stays inside their area. - */ - private static boolean withinConfines(HydrologyTerrainSample terrain, String confines) { - return confines == null || confines.equals(terrain.confinesKey()); - } - - private List routeCandidates( - long upstreamId, - long downstreamId, - RoutePosition nominal, - double progress, - int refinement, - int transverseCandidates, - String confines - ) { - double searchEnvelope = StrictMath.sin(StrictMath.PI * progress); - LinkedHashMap candidates = new LinkedHashMap<>(); - for (int offsetIndex = -transverseCandidates; - offsetIndex <= transverseCandidates; - offsetIndex++) { - double offset = offsetIndex * refinement * searchEnvelope; - int x = (int) StrictMath.round(nominal.x() - nominal.tangent().z() * offset); - int z = (int) StrictMath.round(nominal.z() + nominal.tangent().x() * offset); - HydrologyTerrainSample terrain = sampleLandBasis(x, z); - if (terrain == null || !terrain.transitAllowed() || !withinConfines(terrain, confines)) { - continue; - } - long packed = RiverFootprint.pack(x, z); - double localScore = routeTerrainScore(terrain) - + StrictMath.abs(offset) * 0.18D - + HydrologyHash.unit(HydrologyHash.mix(worldSeed, upstreamId, downstreamId, x, z)) * 1.0E-6D; - RouteCandidate candidate = new RouteCandidate( - new HydrologyPoint(x, terrain.naturalHeight(), z), - offset, - localScore, - routeTerrainScore(terrain), - nominal.tangent(), - true - ); - RouteCandidate current = candidates.get(packed); - if (current == null || candidate.localScore() < current.localScore()) { - candidates.put(packed, candidate); - } - } - if (!candidates.isEmpty()) { - return List.copyOf(candidates.values()); - } - int fallbackX = (int) StrictMath.round(nominal.baseX()); - int fallbackZ = (int) StrictMath.round(nominal.baseZ()); - HydrologyTerrainSample fallbackTerrain = sampleLandBasis(fallbackX, fallbackZ); - if (fallbackTerrain != null - && fallbackTerrain.transitAllowed() - && withinConfines(fallbackTerrain, confines)) { - long packed = RiverFootprint.pack(fallbackX, fallbackZ); - double fallbackOffset = (nominal.baseX() - nominal.x()) * -nominal.tangent().z() - + (nominal.baseZ() - nominal.z()) * nominal.tangent().x(); - double localScore = routeTerrainScore(fallbackTerrain) - + StrictMath.abs(fallbackOffset) * 0.18D - + HydrologyHash.unit(HydrologyHash.mix( - worldSeed, - upstreamId, - downstreamId, - fallbackX, - fallbackZ - )) * 1.0E-6D; - RouteCandidate fallback = new RouteCandidate( - new HydrologyPoint(fallbackX, fallbackTerrain.naturalHeight(), fallbackZ), - fallbackOffset, - localScore, - routeTerrainScore(fallbackTerrain), - nominal.tangent(), - true - ); - RouteCandidate current = candidates.get(packed); - if (current == null || fallback.localScore() < current.localScore()) { - candidates.put(packed, fallback); - } - } - return List.copyOf(candidates.values()); - } - - private List unresolvedSurfaceRouteCandidates( - SampledGrid grid, - long upstreamId, - long downstreamId, - RoutePosition nominal, - double progress, - int refinement, - int transverseCandidates - ) { - double searchEnvelope = StrictMath.sin(StrictMath.PI * progress); - LinkedHashMap candidates = new LinkedHashMap<>(); - for (int offsetIndex = -transverseCandidates; - offsetIndex <= transverseCandidates; - offsetIndex++) { - double offset = offsetIndex * refinement * searchEnvelope; - int x = (int) StrictMath.round(nominal.x() - nominal.tangent().z() * offset); - int z = (int) StrictMath.round(nominal.z() + nominal.tangent().x() * offset); - long packed = RiverFootprint.pack(x, z); - RouteTerrainEstimate estimate = routeTerrainEstimate(grid, x, z); - double localScore = estimate.terrainScore() - + StrictMath.abs(offset) * 0.18D - + HydrologyHash.unit(HydrologyHash.mix( - worldSeed, - upstreamId, - downstreamId, - x, - z - )) * 1.0E-6D; - RouteCandidate candidate = new RouteCandidate( - new HydrologyPoint(x, estimate.height(), z), - offset, - localScore, - estimate.terrainScore(), - nominal.tangent(), - false - ); - RouteCandidate current = candidates.get(packed); - if (current == null || candidate.localScore() < current.localScore()) { - candidates.put(packed, candidate); - } - } - return List.copyOf(candidates.values()); - } - - private RouteTerrainEstimate routeTerrainEstimate(SampledGrid grid, int x, int z) { - double gridX = (x - grid.minimumX()) / (double) grid.spacing(); - double gridZ = (z - grid.minimumZ()) / (double) grid.spacing(); - int minimumGridX = Math.max(0, Math.min(grid.width() - 1, (int) StrictMath.floor(gridX))); - int minimumGridZ = Math.max(0, Math.min(grid.width() - 1, (int) StrictMath.floor(gridZ))); - int maximumGridX = Math.min(grid.width() - 1, minimumGridX + 1); - int maximumGridZ = Math.min(grid.width() - 1, minimumGridZ + 1); - double progressX = Math.max(0D, Math.min(1D, gridX - minimumGridX)); - double progressZ = Math.max(0D, Math.min(1D, gridZ - minimumGridZ)); - HydrologyTerrainSample northwest = grid.nodeAt(minimumGridX, minimumGridZ).terrain(); - HydrologyTerrainSample northeast = grid.nodeAt(maximumGridX, minimumGridZ).terrain(); - HydrologyTerrainSample southwest = grid.nodeAt(minimumGridX, maximumGridZ).terrain(); - HydrologyTerrainSample southeast = grid.nodeAt(maximumGridX, maximumGridZ).terrain(); - double height = bilinear( - northwest.naturalHeight(), - northeast.naturalHeight(), - southwest.naturalHeight(), - southeast.naturalHeight(), - progressX, - progressZ - ); - double terrainScore = bilinear( - routeTerrainScore(northwest), - routeTerrainScore(northeast), - routeTerrainScore(southwest), - routeTerrainScore(southeast), - progressX, - progressZ - ); - return new RouteTerrainEstimate((int) StrictMath.round(height), terrainScore); - } - - private double bilinear( - double northwest, - double northeast, - double southwest, - double southeast, - double progressX, - double progressZ - ) { - double north = northwest + (northeast - northwest) * progressX; - double south = southwest + (southeast - southwest) * progressX; - return north + (south - north) * progressZ; - } - - private RouteCandidate resolveRouteCandidate(RouteCandidate candidate) { - if (candidate.terrainResolved()) { - return candidate; - } - HydrologyPoint point = candidate.point(); - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - if (terrain == null || !terrain.transitAllowed()) { - return new RouteCandidate( - point, - candidate.offset(), - Double.POSITIVE_INFINITY, - Double.POSITIVE_INFINITY, - candidate.tangent(), - true - ); - } - double terrainScore = routeTerrainScore(terrain) + crossDropPenalty(point, candidate.tangent(), terrain); - double exactLocalScore = candidate.localScore() - candidate.terrainScore() + terrainScore; - return new RouteCandidate( - new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z()), - candidate.offset(), - exactLocalScore, - terrainScore, - candidate.tangent(), - true - ); - } - - /** - * Ground that falls away beside a candidate forces the valley solver to cut the channel down to the - * lower bank; costing that drop keeps refined routes on valley floors and contour lines instead of - * traversing hillsides that the incision cap would later reject. - */ - private double crossDropPenalty(HydrologyPoint point, Direction tangent, HydrologyTerrainSample center) { - double length = StrictMath.hypot(tangent.x(), tangent.z()); - if (length <= 0D) { - return 0D; - } - double normalX = -tangent.z() / length; - double normalZ = tangent.x() / length; - double reach = settings.surface().maximumWidth() / 2D + settings.surface().shoreWidth() + 2D; - int lowest = center.naturalHeight(); - for (double distance = reach / 2D; distance <= reach; distance += reach / 2D) { - for (double direction = -1D; direction <= 1D; direction += 2D) { - HydrologyTerrainSample side = sampleLandBasisWithoutSlope( - (int) StrictMath.round(point.x() + normalX * distance * direction), - (int) StrictMath.round(point.z() + normalZ * distance * direction)); - if (side != null) { - lowest = Math.min(lowest, side.naturalHeight()); - } - } - } - double drop = center.naturalHeight() - lowest; - return drop * settings.routing().valleyPreference() * CROSS_DROP_WEIGHT; - } - - private double routeTerrainScore(HydrologyTerrainSample terrain) { - return terrain.naturalHeight() * settings.routing().valleyPreference() - + terrain.slope() * settings.routing().slopePenalty() - + terrain.routingCost() * terrain.routingMultiplier(); - } - - private List solveTerrainRoute( - List> layers, - double targetStepLength - ) { - ArrayList> availableLayers = new ArrayList<>(layers); - HashSet rejectedTransitions = new HashSet<>(); - while (true) { - RouteCandidate[] route = selectTerrainRoute( - availableLayers, - targetStepLength, - rejectedTransitions - ); - if (route.length == 0) { - return List.of(); - } - TerrainTransitionKey unsupportedTransition = unsupportedTerrainTransition(route); - if (unsupportedTransition != null) { - rejectedTransitions.add(unsupportedTransition); - continue; - } - int pitRemoval = removeTerrainPits(availableLayers, route); - if (pitRemoval < 0) { - return List.of(); - } - if (pitRemoval > 0) { - continue; - } - ArrayList points = new ArrayList<>(route.length); - for (RouteCandidate candidate : route) { - HydrologyPoint point = candidate.point(); - if (points.isEmpty() - || point.x() != points.getLast().x() - || point.z() != points.getLast().z()) { - points.add(point); - } - } - if (points.size() < 2) { - return List.of(); - } - return smoothTerrainRoute(points); - } - } - - private RouteCandidate[] selectTerrainRoute( - List> layers, - double targetStepLength, - Set rejectedTransitions - ) { - int layerCount = layers.size(); - double[][] costs = new double[layerCount][]; - int[][] predecessors = new int[layerCount][]; - costs[0] = new double[]{layers.getFirst().getFirst().localScore()}; - predecessors[0] = new int[]{-1}; - for (int layerIndex = 1; layerIndex < layerCount; layerIndex++) { - List currentLayer = layers.get(layerIndex); - List previousLayer = layers.get(layerIndex - 1); - costs[layerIndex] = new double[currentLayer.size()]; - predecessors[layerIndex] = new int[currentLayer.size()]; - Arrays.fill(costs[layerIndex], Double.POSITIVE_INFINITY); - Arrays.fill(predecessors[layerIndex], -1); - for (int currentIndex = 0; currentIndex < currentLayer.size(); currentIndex++) { - RouteCandidate current = currentLayer.get(currentIndex); - for (int previousIndex = 0; previousIndex < previousLayer.size(); previousIndex++) { - if (!Double.isFinite(costs[layerIndex - 1][previousIndex])) { - continue; - } - RouteCandidate previous = previousLayer.get(previousIndex); - TerrainTransitionKey transitionKey = new TerrainTransitionKey( - previous.point(), - current.point() - ); - if (rejectedTransitions.contains(transitionKey)) { - continue; - } - double transition = routeTransitionGeometryCost(previous, current, targetStepLength); - if (!Double.isFinite(transition)) { - continue; - } - double cost = costs[layerIndex - 1][previousIndex] + current.localScore() + transition; - if (cost < costs[layerIndex][currentIndex]) { - costs[layerIndex][currentIndex] = cost; - predecessors[layerIndex][currentIndex] = previousIndex; - } - } - } - } - int selectedIndex = 0; - double selectedCost = costs[layerCount - 1][0]; - for (int candidateIndex = 1; candidateIndex < costs[layerCount - 1].length; candidateIndex++) { - if (costs[layerCount - 1][candidateIndex] < selectedCost) { - selectedIndex = candidateIndex; - selectedCost = costs[layerCount - 1][candidateIndex]; - } - } - if (!Double.isFinite(selectedCost)) { - return new RouteCandidate[0]; - } - RouteCandidate[] route = new RouteCandidate[layerCount]; - for (int layerIndex = layerCount - 1; layerIndex >= 0; layerIndex--) { - route[layerIndex] = layers.get(layerIndex).get(selectedIndex); - selectedIndex = predecessors[layerIndex][selectedIndex]; - } - return route; - } - - private TerrainTransitionKey unsupportedTerrainTransition(RouteCandidate[] route) { - for (int routeIndex = 0; routeIndex < route.length - 1; routeIndex++) { - RouteCandidate start = route[routeIndex]; - RouteCandidate end = route[routeIndex + 1]; - if (!traversableTerrainTransition(start.point(), end.point())) { - return new TerrainTransitionKey(start.point(), end.point()); - } - } - return null; - } - - private RouteCandidate[] selectCurvatureAwareTerrainRoute( - List> layers, - double targetStepLength, - double maximumTurn, - double turnCost - ) { - int layerCount = layers.size(); - if (layerCount < 2) { - return new RouteCandidate[0]; - } - double[][] localPenalties = new double[layerCount][]; - double[][][] transitionCosts = new double[layerCount][][]; - double[][][][] turnCosts = new double[layerCount][][][]; - for (int layerIndex = 0; layerIndex < layerCount; layerIndex++) { - int layerSize = layers.get(layerIndex).size(); - localPenalties[layerIndex] = new double[layerSize]; - if (layerIndex > 0 && layerIndex < layerCount - 1) { - Arrays.fill(localPenalties[layerIndex], Double.NaN); - } - if (layerIndex == 0) { - continue; - } - int previousSize = layers.get(layerIndex - 1).size(); - transitionCosts[layerIndex] = new double[previousSize][layerSize]; - for (double[] row : transitionCosts[layerIndex]) { - Arrays.fill(row, Double.NaN); - } - } - while (true) { - CurvatureRouteSelection selection = selectCurvatureAwareTerrainRoute( - layers, - targetStepLength, - maximumTurn, - turnCost, - localPenalties, - transitionCosts, - turnCosts - ); - if (selection.route().length == 0) { - return selection.route(); - } - boolean evaluated = evaluateSelectedSurfaceCosts( - selection, - layers, - localPenalties, - transitionCosts, - targetStepLength - ); - if (!evaluated) { - return selection.route(); - } - } - } - - private CurvatureRouteSelection selectCurvatureAwareTerrainRoute( - List> layers, - double targetStepLength, - double maximumTurn, - double turnCost, - double[][] localPenalties, - double[][][] transitionCosts, - double[][][][] turnCosts - ) { - int layerCount = layers.size(); - double[][][] costs = new double[layerCount][][]; - int[][][] predecessors = new int[layerCount][][]; - List firstLayer = layers.getFirst(); - List secondLayer = layers.get(1); - costs[1] = new double[firstLayer.size()][secondLayer.size()]; - predecessors[1] = new int[firstLayer.size()][secondLayer.size()]; - for (int firstIndex = 0; firstIndex < firstLayer.size(); firstIndex++) { - Arrays.fill(costs[1][firstIndex], Double.POSITIVE_INFINITY); - Arrays.fill(predecessors[1][firstIndex], -1); - for (int secondIndex = 0; secondIndex < secondLayer.size(); secondIndex++) { - RouteCandidate first = firstLayer.get(firstIndex); - RouteCandidate second = secondLayer.get(secondIndex); - double transition = resolvedTransitionCost( - first, - second, - targetStepLength, - transitionCosts[1][firstIndex][secondIndex] - ); - if (Double.isFinite(transition)) { - costs[1][firstIndex][secondIndex] = first.localScore() - + second.localScore() - + resolvedLocalPenalty(localPenalties[1][secondIndex]) - + transition; - } - } - } - for (int layerIndex = 2; layerIndex < layerCount; layerIndex++) { - List beforeLayer = layers.get(layerIndex - 2); - List previousLayer = layers.get(layerIndex - 1); - List currentLayer = layers.get(layerIndex); - costs[layerIndex] = new double[previousLayer.size()][currentLayer.size()]; - predecessors[layerIndex] = new int[previousLayer.size()][currentLayer.size()]; - if (turnCosts[layerIndex] == null) { - turnCosts[layerIndex] = new double[previousLayer.size()][currentLayer.size()][]; - } - for (int previousIndex = 0; previousIndex < previousLayer.size(); previousIndex++) { - Arrays.fill(costs[layerIndex][previousIndex], Double.POSITIVE_INFINITY); - Arrays.fill(predecessors[layerIndex][previousIndex], -1); - RouteCandidate previous = previousLayer.get(previousIndex); - for (int currentIndex = 0; currentIndex < currentLayer.size(); currentIndex++) { - RouteCandidate current = currentLayer.get(currentIndex); - double transition = resolvedTransitionCost( - previous, - current, - targetStepLength, - transitionCosts[layerIndex][previousIndex][currentIndex] - ); - if (!Double.isFinite(transition)) { - continue; - } - double localPenalty = resolvedLocalPenalty(localPenalties[layerIndex][currentIndex]); - for (int beforeIndex = 0; beforeIndex < beforeLayer.size(); beforeIndex++) { - double previousCost = costs[layerIndex - 1][beforeIndex][previousIndex]; - if (!Double.isFinite(previousCost)) { - continue; - } - double[] candidateTurns = turnCosts[layerIndex][previousIndex][currentIndex]; - if (candidateTurns == null) { - candidateTurns = new double[beforeLayer.size()]; - Arrays.fill(candidateTurns, Double.NaN); - turnCosts[layerIndex][previousIndex][currentIndex] = candidateTurns; - } - double turnPenalty = candidateTurns[beforeIndex]; - if (Double.isNaN(turnPenalty)) { - double turn = routeTurnDegrees( - beforeLayer.get(beforeIndex).point(), - previous.point(), - current.point() - ); - turnPenalty = turn > maximumTurn - ? Double.POSITIVE_INFINITY - : curvatureCost(turn, maximumTurn, turnCost); - candidateTurns[beforeIndex] = turnPenalty; - } - if (turnPenalty == Double.POSITIVE_INFINITY) { - continue; - } - double cost = previousCost - + current.localScore() - + localPenalty - + transition - + turnPenalty; - if (cost < costs[layerIndex][previousIndex][currentIndex]) { - costs[layerIndex][previousIndex][currentIndex] = cost; - predecessors[layerIndex][previousIndex][currentIndex] = beforeIndex; - } - } - } - } - } - int lastLayerIndex = layerCount - 1; - int selectedPreviousIndex = -1; - int selectedCurrentIndex = -1; - double selectedCost = Double.POSITIVE_INFINITY; - for (int previousIndex = 0; previousIndex < costs[lastLayerIndex].length; previousIndex++) { - for (int currentIndex = 0; - currentIndex < costs[lastLayerIndex][previousIndex].length; - currentIndex++) { - if (costs[lastLayerIndex][previousIndex][currentIndex] < selectedCost) { - selectedCost = costs[lastLayerIndex][previousIndex][currentIndex]; - selectedPreviousIndex = previousIndex; - selectedCurrentIndex = currentIndex; - } - } - } - if (!Double.isFinite(selectedCost)) { - return CurvatureRouteSelection.empty(); - } - RouteCandidate[] route = new RouteCandidate[layerCount]; - int[] indices = new int[layerCount]; - route[lastLayerIndex] = layers.get(lastLayerIndex).get(selectedCurrentIndex); - route[lastLayerIndex - 1] = layers.get(lastLayerIndex - 1).get(selectedPreviousIndex); - indices[lastLayerIndex] = selectedCurrentIndex; - indices[lastLayerIndex - 1] = selectedPreviousIndex; - for (int layerIndex = lastLayerIndex; layerIndex >= 2; layerIndex--) { - int beforeIndex = predecessors[layerIndex][selectedPreviousIndex][selectedCurrentIndex]; - if (beforeIndex < 0) { - return CurvatureRouteSelection.empty(); - } - route[layerIndex - 2] = layers.get(layerIndex - 2).get(beforeIndex); - indices[layerIndex - 2] = beforeIndex; - selectedCurrentIndex = selectedPreviousIndex; - selectedPreviousIndex = beforeIndex; - } - return new CurvatureRouteSelection(route, indices); - } - - private boolean evaluateSelectedSurfaceCosts( - CurvatureRouteSelection selection, - List> layers, - double[][] localPenalties, - double[][][] transitionCosts, - double targetStepLength - ) { - boolean evaluated = false; - RouteCandidate[] route = selection.route(); - int[] indices = selection.indices(); - for (int layerIndex = 1; layerIndex < route.length - 1; layerIndex++) { - RouteCandidate candidate = route[layerIndex]; - if (candidate.terrainResolved()) { - continue; - } - RouteCandidate resolved = resolveRouteCandidate(candidate); - ArrayList updatedLayer = new ArrayList<>(layers.get(layerIndex)); - updatedLayer.set(indices[layerIndex], resolved); - layers.set(layerIndex, List.copyOf(updatedLayer)); - route[layerIndex] = resolved; - evaluated = true; - } - for (int layerIndex = 1; layerIndex < route.length - 1; layerIndex++) { - int candidateIndex = indices[layerIndex]; - if (!Double.isNaN(localPenalties[layerIndex][candidateIndex])) { - continue; - } - if (!Double.isFinite(route[layerIndex].localScore())) { - localPenalties[layerIndex][candidateIndex] = 0D; - continue; - } - localPenalties[layerIndex][candidateIndex] = surfaceRouteCandidateBankPenalty( - route[layerIndex] - ); - evaluated = true; - } - for (int layerIndex = 1; layerIndex < route.length; layerIndex++) { - int previousIndex = indices[layerIndex - 1]; - int currentIndex = indices[layerIndex]; - if (!Double.isNaN(transitionCosts[layerIndex][previousIndex][currentIndex])) { - continue; - } - RouteCandidate previous = route[layerIndex - 1]; - RouteCandidate current = route[layerIndex]; - if (!Double.isFinite(previous.localScore()) || !Double.isFinite(current.localScore())) { - transitionCosts[layerIndex][previousIndex][currentIndex] = Double.POSITIVE_INFINITY; - continue; - } - double transition = routeTransitionCost(previous, current, targetStepLength); - if (Double.isFinite(transition)) { - transition += surfaceRouteTransitionPenalty(previous, current); - } - transitionCosts[layerIndex][previousIndex][currentIndex] = transition; - evaluated = true; - } - return evaluated; - } - - private double resolvedLocalPenalty(double penalty) { - return Double.isNaN(penalty) ? 0D : penalty; - } - - private double resolvedTransitionCost( - RouteCandidate previous, - RouteCandidate current, - double targetStepLength, - double exactCost - ) { - return Double.isNaN(exactCost) - ? routeTransitionGeometryCost(previous, current, targetStepLength) - : exactCost; - } - - private double curvatureCost(double turn, double maximumTurn, double turnCost) { - double excess = Math.max(0D, turn - 8D); - return excess * excess * turnCost / maximumTurn; - } - - private double surfaceRouteTransitionPenalty( - RouteCandidate start, - RouteCandidate end - ) { - int minimumBankDistance = surfaceBankDistance(settings.surface().minimumWidth()); - int maximumBankDistance = surfaceBankDistance(settings.surface().maximumWidth()); - int maximumBankRise = Math.addExact( - settings.surface().maximumIncision(), - (int) StrictMath.ceil(settings.surface().banks().minimumBlendWidth() * 0.5D) - ); - Direction tangent = direction(start.point().x(), start.point().z(), end.point().x(), end.point().z()); - int endpointCeiling = Math.max(start.point().y(), end.point().y()); - double penalty = 0D; - List raster = rasterLine(start.point(), end.point()); - int sampleStride = Math.max(1, settings.routing().refinementSpacing() / 4); - for (int pointIndex = 0; pointIndex < raster.size(); pointIndex += sampleStride) { - HydrologyPoint point = raster.get(pointIndex); - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - if (terrain == null) { - return 1.0E12D; - } - int permittedIncision = permittedSurfaceIncision(terrain); - int ridgeExcess = Math.max( - 0, - terrain.naturalHeight() - endpointCeiling - permittedIncision - ); - penalty += (double) ridgeExcess * ridgeExcess * 65536D; - if (terrain.slope() >= settings.hydraulics().waterfallMinimumDrop()) { - continue; - } - int head = Math.subtractExact( - terrain.naturalHeight(), - settings.surface().banks().sink() - ); - penalty += surfaceRouteBankPenalty( - point, - tangent, - minimumBankDistance, - maximumBankDistance, - head, - maximumBankRise - ); - } - if ((raster.size() - 1) % sampleStride != 0) { - HydrologyPoint point = raster.getLast(); - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - if (terrain == null) { - return 1.0E12D; - } - int permittedIncision = permittedSurfaceIncision(terrain); - int ridgeExcess = Math.max( - 0, - terrain.naturalHeight() - endpointCeiling - permittedIncision - ); - penalty += (double) ridgeExcess * ridgeExcess * 65536D; - if (terrain.slope() < settings.hydraulics().waterfallMinimumDrop()) { - int head = Math.subtractExact( - terrain.naturalHeight(), - settings.surface().banks().sink() - ); - penalty += surfaceRouteBankPenalty( - point, - tangent, - minimumBankDistance, - maximumBankDistance, - head, - maximumBankRise - ); - } - } - return penalty; - } - - private int removeTerrainPits(List> layers, RouteCandidate[] route) { - int removed = 0; - for (int routeIndex = 1; routeIndex < route.length - 1; routeIndex++) { - RouteCandidate candidate = route[routeIndex]; - if (!isTerrainPit(candidate)) { - continue; - } - ArrayList candidates = new ArrayList<>(layers.get(routeIndex)); - candidates.remove(candidate); - if (candidates.isEmpty()) { - return -1; - } - layers.set(routeIndex, List.copyOf(candidates)); - removed++; - } - return removed; - } - - private boolean isTerrainPit(RouteCandidate candidate) { - HydrologyPoint point = candidate.point(); - Direction tangent = candidate.tangent(); - int refinement = settings.routing().refinementSpacing(); - int offsetX = (int) StrictMath.round(tangent.x() * refinement); - int offsetZ = (int) StrictMath.round(tangent.z() * refinement); - if (offsetX == 0 && offsetZ == 0) { - return false; - } - HydrologyTerrainSample before = sampleLandBasisWithoutSlope(point.x() - offsetX, point.z() - offsetZ); - HydrologyTerrainSample after = sampleLandBasisWithoutSlope(point.x() + offsetX, point.z() + offsetZ); - int threshold = settings.hydraulics().waterfallMinimumDrop(); - return before != null - && after != null - && before.naturalHeight() - point.y() >= threshold - && after.naturalHeight() - point.y() >= threshold; - } - - private List smoothTerrainRoute(List route) { - List current = List.copyOf(route); - List best = current; - double bestTurnScore = routeTurnScore(current); - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - int maximumPasses = Math.max(8, meanders.smoothingPasses() * 4); - for (int pass = 0; pass < maximumPasses; pass++) { - ArrayList smoothed = new ArrayList<>(current.size()); - smoothed.add(current.getFirst()); - for (int pointIndex = 1; pointIndex < current.size() - 1; pointIndex++) { - HydrologyPoint previous = current.get(pointIndex - 1); - HydrologyPoint point = current.get(pointIndex); - HydrologyPoint next = current.get(pointIndex + 1); - int x = (int) StrictMath.round(previous.x() * 0.25D + point.x() * 0.5D + next.x() * 0.25D); - int z = (int) StrictMath.round(previous.z() * 0.25D + point.z() * 0.5D + next.z() * 0.25D); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(x, z); - smoothed.add(terrain == null || !terrain.transitAllowed() - ? point - : new HydrologyPoint(x, terrain.naturalHeight(), z)); - } - smoothed.add(current.getLast()); - List candidate = withoutDuplicateRoutePoints(smoothed); - if (candidate.size() < 2 || !traversableRoute(candidate)) { - break; - } - current = candidate; - double candidateTurnScore = routeTurnScore(candidate); - if (candidateTurnScore < bestTurnScore) { - best = candidate; - bestTurnScore = candidateTurnScore; - } - } - List smoothed = removeRouteHairpins(best, meanders.maximumTurnDegrees()); - return containsTerrainPit(smoothed) ? List.of() : smoothed; - } - - private List removeRouteHairpins(List route, double maximumTurnDegrees) { - ArrayList points = new ArrayList<>(route); - while (points.size() > 2) { - int sharpestIndex = sharpestRoutePoint(points); - if (sharpestIndex < 1 || routeTurnDegrees( - points.get(sharpestIndex - 1), - points.get(sharpestIndex), - points.get(sharpestIndex + 1) - ) <= maximumTurnDegrees) { - break; - } - HydrologyPoint previous = points.get(sharpestIndex - 1); - HydrologyPoint next = points.get(sharpestIndex + 1); - if (!traversableHop(previous, next) || crossesTerrainCrevasse(previous, next)) { - break; - } - points.remove(sharpestIndex); - } - return List.copyOf(points); - } - - private int sharpestRoutePoint(List route) { - int selectedIndex = -1; - double selectedTurn = 0D; - for (int pointIndex = 1; pointIndex < route.size() - 1; pointIndex++) { - double turn = routeTurnDegrees( - route.get(pointIndex - 1), - route.get(pointIndex), - route.get(pointIndex + 1) - ); - if (turn > selectedTurn) { - selectedIndex = pointIndex; - selectedTurn = turn; - } - } - return selectedIndex; - } - - private double routeTurnDegrees(HydrologyPoint previous, HydrologyPoint point, HydrologyPoint next) { - double incomingX = point.x() - previous.x(); - double incomingZ = point.z() - previous.z(); - double outgoingX = next.x() - point.x(); - double outgoingZ = next.z() - point.z(); - double incomingLength = StrictMath.hypot(incomingX, incomingZ); - double outgoingLength = StrictMath.hypot(outgoingX, outgoingZ); - if (incomingLength == 0D || outgoingLength == 0D) { - return 0D; - } - double cosine = (incomingX * outgoingX + incomingZ * outgoingZ) - / (incomingLength * outgoingLength); - return StrictMath.toDegrees(StrictMath.acos(Math.max(-1D, Math.min(1D, cosine)))); - } - - private List withoutDuplicateRoutePoints(List points) { - ArrayList unique = new ArrayList<>(points.size()); - for (HydrologyPoint point : points) { - if (unique.isEmpty() - || point.x() != unique.getLast().x() - || point.z() != unique.getLast().z()) { - unique.add(point); - } - } - return List.copyOf(unique); - } - - private boolean traversableRoute(List route) { - for (int pointIndex = 0; pointIndex < route.size() - 1; pointIndex++) { - HydrologyPoint start = route.get(pointIndex); - HydrologyPoint end = route.get(pointIndex + 1); - if (!traversableHop(start, end) || crossesTerrainCrevasse(start, end)) { - return false; - } - } - return true; - } - - private double routeTransitionCost( - RouteCandidate previous, - RouteCandidate current, - double targetStepLength - ) { - if (!traversableTerrainTransition(previous.point(), current.point())) { - return Double.POSITIVE_INFINITY; - } - return routeTransitionGeometryCost(previous, current, targetStepLength); - } - - private double routeTransitionGeometryCost( - RouteCandidate previous, - RouteCandidate current, - double targetStepLength - ) { - double deltaX = current.point().x() - previous.point().x(); - double deltaZ = current.point().z() - previous.point().z(); - double length = StrictMath.hypot(deltaX, deltaZ); - if (length <= 0D || length > targetStepLength * 5D + 8D) { - return Double.POSITIVE_INFINITY; - } - double transverseChange = StrictMath.abs(current.offset() - previous.offset()); - double alignment = (deltaX * current.tangent().x() + deltaZ * current.tangent().z()) / length; - if (alignment < -0.5D) { - return Double.POSITIVE_INFINITY; - } - int rise = Math.max(0, current.point().y() - previous.point().y()); - return StrictMath.abs(length - targetStepLength) * 1.4D - + transverseChange * 5D - + (1D - alignment) * 32D - + rise * settings.routing().uphillPenalty(); - } - - private boolean traversableTerrainTransition(HydrologyPoint start, HydrologyPoint end) { - List crossing = rasterLine(start, end); - HydrologyTerrainSample startTerrain = sampleLandBasisWithoutSlope(start.x(), start.z()); - HydrologyTerrainSample endTerrain = sampleLandBasisWithoutSlope(end.x(), end.z()); - if (startTerrain == null || endTerrain == null) { - return false; - } - int boundaryHeight = Math.min(startTerrain.naturalHeight(), endTerrain.naturalHeight()); - int threshold = settings.hydraulics().waterfallMinimumDrop(); - for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { - HydrologyPoint point = crossing.get(pointIndex); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(point.x(), point.z()); - if (terrain == null - || !terrain.transitAllowed() - || boundaryHeight - terrain.naturalHeight() >= threshold) { - return false; - } - } - return true; - } - - private boolean crossesTerrainCrevasse(HydrologyPoint start, HydrologyPoint end) { - List crossing = rasterLine(start, end); - if (crossing.size() < 3) { - return false; - } - HydrologyTerrainSample startTerrain = sampleLandBasisWithoutSlope(start.x(), start.z()); - HydrologyTerrainSample endTerrain = sampleLandBasisWithoutSlope(end.x(), end.z()); - if (startTerrain == null || endTerrain == null) { - return true; - } - int boundaryHeight = Math.min(startTerrain.naturalHeight(), endTerrain.naturalHeight()); - int threshold = settings.hydraulics().waterfallMinimumDrop(); - for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { - HydrologyPoint point = crossing.get(pointIndex); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(point.x(), point.z()); - if (terrain == null || boundaryHeight - terrain.naturalHeight() >= threshold) { - return true; - } - } - return false; - } - - private Direction direction(int startX, int startZ, int endX, int endZ) { - double x = endX - startX; - double z = endZ - startZ; - double length = StrictMath.hypot(x, z); - if (length <= 0D) { - return new Direction(0D, 0D); - } - return new Direction(x / length, z / length); - } - - private double hermite(double start, double end, double startTangent, double endTangent, double progress) { - double squared = progress * progress; - double cubed = squared * progress; - double startBasis = 2D * cubed - 3D * squared + 1D; - double startTangentBasis = cubed - 2D * squared + progress; - double endBasis = -2D * cubed + 3D * squared; - double endTangentBasis = cubed - squared; - return startBasis * start - + startTangentBasis * startTangent - + endBasis * end - + endTangentBasis * endTangent; - } - - private double hermiteDerivative( - double start, - double end, - double startTangent, - double endTangent, - double progress - ) { - double squared = progress * progress; - return (6D * squared - 6D * progress) * start - + (3D * squared - 4D * progress + 1D) * startTangent - + (-6D * squared + 6D * progress) * end - + (3D * squared - 2D * progress) * endTangent; - } - - private boolean traversableHop(HydrologyPoint start, HydrologyPoint end) { - List crossing = rasterLine(start, end); - for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { - HydrologyPoint point = crossing.get(pointIndex); - HydrologyTerrainSample terrain = sampleLandBasisWithoutSlope(point.x(), point.z()); - if (terrain == null || terrain.ocean() || !terrain.transitAllowed()) { - return false; - } - } - return true; - } - - private void compileSurfaceCourses( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan routing, - CompiledGraph graph, - List sources, - List courses, - List diagnostics - ) { - LinkedHashMap> draftsByOutlet = new LinkedHashMap<>(); - for (int source : sources) { - GridNode sourceNode = grid.node(source); - long sourceCourseId = HydrologyHash.mix( - worldSeed, - COURSE_SALT, - SURFACE_SOURCE_SALT, - sourceNode.id() - ); - CoursePath path = coursePath(grid, routing, graph, source, true); - if (path == null) { - addCompiledSourceDiagnostic( - sourceNode, - true, - sourceCourseId, - HydrologyCandidateRejection.NO_DRAINAGE_PATH, - diagnostics - ); - continue; - } - long courseId = HydrologyHash.mix(sourceCourseId, path.outlet().id()); - HydrologyPoint trunkPoint = path.points().getFirst(); - HydrologyTerrainSample trunkTerrain = Objects.requireNonNull( - sampleDetailed(trunkPoint.x(), trunkPoint.z()), - "Hydrology surface trunk left sampled terrain" - ); - String profileKey = chooseProfile(trunkTerrain, path.outlet().id()); - draftsByOutlet.computeIfAbsent(path.outlet().id(), (Long ignored) -> new ArrayList<>()) - .add(new SurfaceCourseDraft(sourceNode, courseId, profileKey, path)); - } - for (ArrayList outletDrafts : draftsByOutlet.values()) { - outletDrafts.sort(Comparator - .comparingDouble((SurfaceCourseDraft draft) -> edgeLength( - draft.path().edges(), - draft.path().edges().size() - )) - .reversed() - .thenComparingLong(SurfaceCourseDraft::courseId)); - RiverCourse mainCourse = null; - HashMap mainRejections = new HashMap<>(); - int tributaries = 0; - for (SurfaceCourseDraft draft : outletDrafts) { - if (mainCourse != null && tributaries >= settings.routing().tributaries()) { - break; - } - if (mainCourse == null) { - SurfaceCourseBuild candidate = buildSurfaceCourse( - draft.courseId(), - draft.profileKey(), - draft.source(), - draft.path() - ); - if (candidate.course() == null) { - mainRejections.put(draft.courseId(), candidate); - continue; - } - mainCourse = candidate.course(); - courses.add(mainCourse); - continue; - } - RiverCourse tributary = buildSurfaceTributary(draft, mainCourse, diagnostics); - if (tributary != null) { - courses.add(tributary); - tributaries++; - } - } - if (mainCourse == null) { - for (SurfaceCourseDraft draft : outletDrafts) { - SurfaceCourseBuild rejected = mainRejections.get(draft.courseId()); - addCompiledSourceDiagnostic( - draft.source(), - true, - draft.courseId(), - rejected.rejection(), - rejected.rejectionDetail(), - diagnostics - ); - } - } - } - } - - private SurfaceCourseBuild buildSurfaceCourse( - long courseId, - String profileKey, - GridNode source, - CoursePath initialPath - ) { - return buildSurfaceCourseAtPath(courseId, profileKey, source, initialPath); - } - - private SurfaceCourseBuild buildSurfaceCourseAtPath( - long courseId, - String profileKey, - GridNode source, - CoursePath path - ) { - if (path.points().size() < 2) { - return SurfaceCourseBuild.rejected(HydrologyCandidateRejection.COURSE_TOO_SHORT, 0); - } - RiverOutlet outlet = path.outlet(); - boolean surfaceSinkhole = path.reachesOutlet() && surfaceSinkhole(outlet); - SurfaceTerminal terminal; - if (!path.reachesOutlet() || outlet.type() == HydrologyFeatureType.INLAND_GROTTO) { - terminal = SurfaceTerminal.SINKHOLE; - } else if (outlet.type() == HydrologyFeatureType.COASTAL_GROTTO) { - terminal = SurfaceTerminal.COASTAL_GROTTO; - } else { - terminal = SurfaceTerminal.OCEAN_MOUTH; - } - int outletHead = outletHead(outlet); - int terminalHead = surfaceSinkhole ? Math.addExact(outletHead, 1) : outletHead; - SurfaceCourseResult result = surfaceCourseBuilder.build( - worldSeed, - courseId, - profileKey, - path.points(), - terminal, - terminalHead - ); - if (!result.accepted()) { - return SurfaceCourseBuild.rejected(result.rejection(), result.rejectionDetail()); - } - ArrayList segments = new ArrayList<>(result.segments()); - if (path.reachesOutlet()) { - CoursePath terminalPath = new CoursePath( - List.of(result.pathEnd()), - path.pairEdges(), - path.edges(), - outlet, - true, - path.organicSurfaceRequired(), - null - ); - appendOutletSegments( - RiverCourseType.SURFACE, - courseId, - terminalPath, - result.lastHead(), - new int[] {result.lastWidth()}, - new int[] {result.lastDepth()}, - segments - ); - } - if (path.organicSurfaceRequired()) { - int shapeRejection = surfaceShapeRejection(path.points()); - if (shapeRejection != 0) { - return SurfaceCourseBuild.rejected(HydrologyCandidateRejection.SURFACE_SHAPE_UNSUPPORTED, shapeRejection); - } - } - int discharge = maximumSurfaceDischarge(path.edges()); - return SurfaceCourseBuild.accepted(new RiverCourse( - courseId, - RiverCourseType.SURFACE, - OptionalLong.of(source.id()), - OptionalLong.of(outlet.id()), - profileKey, - discharge, - path.edges(), - segments - )); - } - - /** 0 when the shape is organic; otherwise 1 too short, 2 too sinuous, 3 grid-locked, 4 sharp turns. */ - private int surfaceShapeRejection(List routedCenterline) { - return surfaceShapeRejection(routedCenterline, false); - } - - /** - * As above; a tributary reach keeps the hard turn cap and the overall turn budget but may bend - * once where it leaves its own valley for the stem's, which a main river is not allowed to do. - */ - private int surfaceShapeRejection(List routedCenterline, boolean tributary) { - List centerline = withoutDuplicateRoutePoints(routedCenterline); - if (centerline.size() < 3) { - return 1; - } - double routedLength = centerlineLength(centerline); - HydrologyPoint start = centerline.getFirst(); - HydrologyPoint end = centerline.getLast(); - double directLength = StrictMath.hypot(end.x() - start.x(), end.z() - start.z()); - if (directLength <= 0D - || routedLength / directLength > SURFACE_MAXIMUM_SINUOSITY) { - return 2; - } - List sampled = resampleRouteCenterline( - centerline, - Math.max(16D, settings.routing().refinementSpacing() * 4D) - ); - double lockedLength = 0D; - double currentLockedRun = 0D; - double longestLockedRun = 0D; - for (int pointIndex = 1; pointIndex < sampled.size(); pointIndex++) { - HydrologyPoint previous = sampled.get(pointIndex - 1); - HydrologyPoint point = sampled.get(pointIndex); - double deltaX = point.x() - previous.x(); - double deltaZ = point.z() - previous.z(); - double length = StrictMath.hypot(deltaX, deltaZ); - if (length <= 0D) { - continue; - } - double angle = StrictMath.toDegrees(StrictMath.atan2(deltaZ, deltaX)); - double remainder = Math.floorMod( - (int) StrictMath.round(angle * 1_000_000D), - 45_000_000 - ) / 1_000_000D; - double gridDistance = Math.min(remainder, 45D - remainder); - if (gridDistance <= SURFACE_GRID_LOCK_TOLERANCE_DEGREES) { - lockedLength += length; - currentLockedRun += length; - longestLockedRun = Math.max(longestLockedRun, currentLockedRun); - } else { - currentLockedRun = 0D; - } - } - if (routedLength >= 96D - && (lockedLength / routedLength > SURFACE_MAXIMUM_GRID_LOCKED_FRACTION - || longestLockedRun > SURFACE_MAXIMUM_GRID_LOCKED_RUN)) { - return 3; - } - ArrayList turnAngles = new ArrayList<>(); - for (int pointIndex = 1; pointIndex < sampled.size() - 1; pointIndex++) { - double turn = routeTurnDegrees( - sampled.get(pointIndex - 1), - sampled.get(pointIndex), - sampled.get(pointIndex + 1) - ); - if (turn > SURFACE_MAXIMUM_RENDERED_TURN_DEGREES) { - return 4; - } - turnAngles.add(turn); - } - if (turnAngles.isEmpty()) { - return 1; - } - for (int turnIndex = 0; turnIndex < turnAngles.size() && !tributary; turnIndex++) { - double turn = turnAngles.get(turnIndex); - double previous = turnIndex == 0 ? 0D : turnAngles.get(turnIndex - 1); - double next = turnIndex + 1 == turnAngles.size() ? 0D : turnAngles.get(turnIndex + 1); - if (turn > SURFACE_MAXIMUM_ISOLATED_TURN_DEGREES - && previous <= SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES - && next <= SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES) { - return 4; - } - } - turnAngles.sort(Double::compare); - int percentileIndex = (int) StrictMath.ceil(0.95D * turnAngles.size()) - 1; - double percentile = turnAngles.get( - Math.max(0, Math.min(percentileIndex, turnAngles.size() - 1)) - ); - if (percentile > (tributary ? SURFACE_MAXIMUM_RENDERED_TURN_DEGREES : SURFACE_MAXIMUM_P95_TURN_DEGREES)) { - return 4; - } - return 0; - } - - private double centerlineLength(List points) { - double length = 0D; - for (int pointIndex = 1; pointIndex < points.size(); pointIndex++) { - HydrologyPoint previous = points.get(pointIndex - 1); - HydrologyPoint current = points.get(pointIndex); - length += StrictMath.hypot(current.x() - previous.x(), current.z() - previous.z()); - } - return length; - } - - private List resampleRouteCenterline( - List points, - double spacing - ) { - double[] cumulative = new double[points.size()]; - for (int pointIndex = 1; pointIndex < points.size(); pointIndex++) { - HydrologyPoint previous = points.get(pointIndex - 1); - HydrologyPoint point = points.get(pointIndex); - cumulative[pointIndex] = cumulative[pointIndex - 1] - + StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); - } - double totalLength = cumulative[cumulative.length - 1]; - if (totalLength <= spacing) { - return points; - } - int samples = Math.max(2, (int) StrictMath.floor(totalLength / spacing)); - ArrayList sampled = new ArrayList<>(samples + 2); - int segmentIndex = 0; - for (double distance = 0D; distance < totalLength; distance += spacing) { - while (segmentIndex < points.size() - 2 - && cumulative[segmentIndex + 1] < distance) { - segmentIndex++; - } - HydrologyPoint start = points.get(segmentIndex); - HydrologyPoint end = points.get(segmentIndex + 1); - double segmentLength = cumulative[segmentIndex + 1] - cumulative[segmentIndex]; - double progress = segmentLength <= 0D - ? 0D - : (distance - cumulative[segmentIndex]) / segmentLength; - HydrologyPoint point = new HydrologyPoint( - (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress), - (int) StrictMath.round(start.y() + (end.y() - start.y()) * progress), - (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress) - ); - if (sampled.isEmpty() - || point.x() != sampled.getLast().x() - || point.z() != sampled.getLast().z()) { - sampled.add(point); - } - } - HydrologyPoint last = points.getLast(); - HydrologyPoint sampledLast = sampled.isEmpty() ? null : sampled.getLast(); - double remaining = sampledLast == null - ? Double.POSITIVE_INFINITY - : StrictMath.hypot(last.x() - sampledLast.x(), last.z() - sampledLast.z()); - if (remaining >= spacing * 0.5D) { - sampled.add(last); - } - return List.copyOf(sampled); - } - - private void compileUndergroundCourses( - HydrologyTileKey key, - SampledGrid grid, - RoutingPlan routing, - CompiledGraph graph, - List sources, - List courses, - List diagnostics - ) { - LinkedHashMap> draftsByOutlet = new LinkedHashMap<>(); - for (int sourceIndex : sources) { - GridNode source = grid.node(sourceIndex); - long courseId = HydrologyHash.mix(worldSeed, COURSE_SALT, UNDERGROUND_SOURCE_SALT, source.id()); - CoursePath path = coursePath(null, routing, graph, sourceIndex, false); - if (path == null) { - addCompiledSourceDiagnostic( - source, - false, - courseId, - HydrologyCandidateRejection.NO_DRAINAGE_PATH, - diagnostics - ); - continue; - } - draftsByOutlet.computeIfAbsent(path.outlet().id(), (Long ignored) -> new ArrayList<>()) - .add(new UndergroundCourseDraft(source, courseId, path)); - } - for (ArrayList outletDrafts : draftsByOutlet.values()) { - outletDrafts.sort(Comparator - .comparingDouble((UndergroundCourseDraft draft) -> edgeLength( - draft.path().edges(), - draft.path().edges().size() - )) - .reversed() - .thenComparingLong(UndergroundCourseDraft::courseId)); - RiverCourse mainCourse = null; - int tributaries = 0; - for (UndergroundCourseDraft draft : outletDrafts) { - if (mainCourse != null && tributaries >= settings.underground().tributaries()) { - break; - } - if (mainCourse == null) { - RiverCourse course = buildUndergroundCourse(draft, draft.path(), outletHead(draft.path().outlet()), diagnostics); - if (course != null) { - mainCourse = course; - courses.add(course); - } - continue; - } - RiverCourse tributary = buildUndergroundTributary(draft, mainCourse, diagnostics); - if (tributary != null) { - courses.add(tributary); - tributaries++; - } - } - } - } - - private record UndergroundCourseDraft(GridNode source, long courseId, CoursePath path) { - } - - /** - * Builds a later underground draft to the stem's outlet as a tributary: the path is cut at the first - * point the stem's passage already runs through, and the passage is solved with the stem's fluid - * level there as its outlet level, so it joins the stem at or above its water. - */ - private RiverCourse buildUndergroundTributary( - UndergroundCourseDraft draft, - RiverCourse stem, - List diagnostics - ) { - CoursePath path = draft.path(); - HashSet stemEdges = new HashSet<>(); - for (DrainageEdge edge : stem.drainageEdges()) { - stemEdges.add(edge.id()); - } - HashMap stemHeads = new HashMap<>(); - for (HydraulicSegment segment : stem.segments()) { - for (HydrologyPoint point : segment.centerline()) { - stemHeads.putIfAbsent(RiverFootprint.pack(point.x(), point.z()), point.y()); - } - } - int joinIndex = -1; - for (int index = 0; index < path.points().size(); index++) { - HydrologyPoint point = path.points().get(index); - boolean sharedEdge = index > 0 && stemEdges.contains(path.pairEdges().get(index - 1).id()); - if (sharedEdge || stemHeads.containsKey(RiverFootprint.pack(point.x(), point.z()))) { - joinIndex = index; - break; - } - } - if (joinIndex < 1 || !stemHeads.containsKey(RiverFootprint.pack( - path.points().get(joinIndex).x(), path.points().get(joinIndex).z()))) { - addCompiledSourceDiagnostic(draft.source(), false, draft.courseId(), - joinIndex < 0 ? HydrologyCandidateRejection.NO_DRAINAGE_PATH : HydrologyCandidateRejection.COURSE_TOO_SHORT, - diagnostics); - return null; - } - List points = path.points().subList(0, joinIndex + 1); - List pairEdges = path.pairEdges().subList(0, joinIndex); - LinkedHashSet ownedEdges = new LinkedHashSet<>(); - for (DrainageEdge edge : pairEdges) { - if (!stemEdges.contains(edge.id())) { - ownedEdges.add(edge); - } - } - if (ownedEdges.isEmpty() - || centerlineLength(points) < settings.routing().minimumUndergroundCourseLength() / 2D) { - addCompiledSourceDiagnostic(draft.source(), false, draft.courseId(), - HydrologyCandidateRejection.COURSE_TOO_SHORT, joinIndex, diagnostics); - return null; - } - HydrologyPoint junction = points.getLast(); - CoursePath junctionPath = new CoursePath( - List.copyOf(points), - List.copyOf(pairEdges), - List.copyOf(ownedEdges), - path.outlet(), - false, - false, - junction - ); - int junctionHead = stemHeads.get(RiverFootprint.pack(junction.x(), junction.z())); - return buildUndergroundCourse(draft, junctionPath, junctionHead, diagnostics); - } - - private RiverCourse buildUndergroundCourse( - UndergroundCourseDraft draft, - CoursePath path, - int outletHead, - List diagnostics - ) { - GridNode source = draft.source(); - long courseId = draft.courseId(); - HydrologyPoint sourcePoint = path.points().getFirst(); - HydrologyPoint trunkPoint = path.points().getLast(); - HydrologyTerrainSample trunkTerrain = Objects.requireNonNull( - sampleDetailed(trunkPoint.x(), trunkPoint.z()), - "Hydrology underground trunk left sampled terrain" - ); - String profileKey = chooseProfile(trunkTerrain, path.outlet().id()); - int styledHead = sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, - profileKey, - sourcePoint.x(), - sourcePoint.z(), - 0L, - settings.underground().minimumFluidY(), - settings.underground().maximumFluidY() - ); - if (outletHead > settings.underground().maximumFluidY()) { - addCompiledSourceDiagnostic( - source, - false, - courseId, - HydrologyCandidateRejection.OUTLET_LEVEL, - diagnostics - ); - return null; - } - int initialHead = Math.max(styledHead, outletHead); - RiverCourse course = buildUndergroundCourse(courseId, profileKey, source, path, initialHead, outletHead); - if (course == null) { - addCompiledSourceDiagnostic( - source, - false, - courseId, - HydrologyCandidateRejection.CAVE_CONTAINMENT, - diagnostics - ); - } - return course; - } - - private void addCompiledSourceDiagnostic( - GridNode source, - boolean surface, - long courseId, - HydrologyCandidateRejection rejection, - List diagnostics - ) { - addCompiledSourceDiagnostic(source, surface, courseId, rejection, 0, diagnostics); - } - - private void addCompiledSourceDiagnostic( - GridNode source, - boolean surface, - long courseId, - HydrologyCandidateRejection rejection, - int detail, - List diagnostics - ) { - int y = surface ? source.terrain().naturalHeight() : source.terrain().caveFluidY(); - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(courseId, DIAGNOSTIC_SALT, rejection.ordinal()), - HydrologyCandidateKind.SOURCE, - surface ? HydrologyFeatureType.SURFACE_POOL : HydrologyFeatureType.UNDERGROUND_POOL, - new HydrologyPoint(source.x(), y, source.z()), - rejection, - detail - )); - } - - private RiverCourse buildUndergroundCourse( - long courseId, - String profileKey, - GridNode source, - CoursePath path, - int initialHead, - int outletHead - ) { - int pairCount = path.points().size() - 1; - if (pairCount < 1) { - return null; - } - int[] heads = new int[path.points().size()]; - int[] preferredHeads = new int[path.points().size()]; - int[] widths = new int[pairCount]; - int[] depths = new int[pairCount]; - preferredHeads[0] = initialHead; - for (int index = 0; index < pairCount; index++) { - HydrologyPoint point = path.points().get(index); - HydrologyTerrainSample terrain = sampleBasisWithoutSlope(point.x(), point.z()); - int discharge = Math.max(1, path.pairEdges().get(index).contributingUndergroundSources()); - widths[index] = scaledDimension( - sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_WIDTH, - profileKey, - point.x(), - point.z(), - 0L, - settings.underground().minimumWidth(), - settings.underground().maximumWidth() - ), - settings.underground().minimumWidth(), - settings.underground().maximumWidth(), - discharge, - terrain.widthMultiplier() - ); - depths[index] = scaledDimension( - sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_DEPTH, - profileKey, - point.x(), - point.z(), - 0L, - settings.underground().minimumDepth(), - settings.underground().maximumDepth() - ), - settings.underground().minimumDepth(), - settings.underground().maximumDepth(), - discharge, - terrain.depthMultiplier() - ); - HydrologyPoint downstreamPoint = path.points().get(index + 1); - int caveHead = sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, - profileKey, - downstreamPoint.x(), - downstreamPoint.z(), - 0L, - settings.underground().minimumFluidY(), - settings.underground().maximumFluidY() - ); - preferredHeads[index + 1] = caveHead; - } - int[] minimumHeads = undergroundMinimumHeads(path, depths, outletHead); - int[] optimisticMaximumHeads = undergroundOptimisticMaximumHeads(path); - if (!undergroundHeadsFeasible(minimumHeads, optimisticMaximumHeads, outletHead)) { - return null; - } - int[] maximumHeads = undergroundMaximumHeads(courseId, profileKey, path, widths); - if (!solveUndergroundHeads(preferredHeads, minimumHeads, maximumHeads, outletHead, heads)) { - return null; - } - levelUndergroundMouth(path, heads, outletHead); - ArrayList segments = new ArrayList<>(pairCount + 1); - for (int index = 0; index < pairCount; index++) { - int drop = heads[index] - heads[index + 1]; - HydrologyFeatureType type = drop > 0 - ? HydrologyFeatureType.UNDERGROUND_DROP - : HydrologyFeatureType.UNDERGROUND_POOL; - if (!addHydraulicSegments( - courseId, - index, - type, - heads[index], - heads[index + 1], - widths[index], - depths[index], - List.of( - withY(path.points().get(index), heads[index]), - withY(path.points().get(index + 1), heads[index + 1]) - ), - false, - segments - )) { - return null; - } - } - appendOutletSegments( - RiverCourseType.UNDERGROUND, - courseId, - path, - heads[heads.length - 1], - widths, - depths, - segments - ); - int discharge = maximumUndergroundDischarge(path.edges()); - return new RiverCourse( - courseId, - RiverCourseType.UNDERGROUND, - OptionalLong.of(source.id()), - OptionalLong.of(path.outlet().id()), - profileKey, - discharge, - path.edges(), - segments - ); - } - - private int[] undergroundMaximumHeads( - long courseId, - String profileKey, - CoursePath path, - int[] widths - ) { - int[] segmentCaps = new int[widths.length]; - for (int index = 0; index < widths.length; index++) { - int radius = Math.max(1, widths[index] / 2); - segmentCaps[index] = undergroundSegmentCap( - courseId, - profileKey, - path.points().get(index), - path.points().get(index + 1), - radius - ); - } - return nodeMaximumHeads(segmentCaps); - } - - private int[] undergroundOptimisticMaximumHeads(CoursePath path) { - int segmentCount = path.points().size() - 1; - int[] segmentCaps = new int[segmentCount]; - Arrays.fill(segmentCaps, Integer.MAX_VALUE); - int minimumHeadroom = settings.underground().minimumHeadroom(); - for (int index = 0; index < segmentCount; index++) { - HydrologyPoint start = path.points().get(index); - HydrologyPoint end = path.points().get(index + 1); - segmentCaps[index] = Math.min( - optimisticUndergroundSegmentCap(start, minimumHeadroom), - optimisticUndergroundSegmentCap(end, minimumHeadroom) - ); - } - return nodeMaximumHeads(segmentCaps); - } - - private int optimisticUndergroundSegmentCap(HydrologyPoint point, int minimumHeadroom) { - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - return terrain == null || terrain.ocean() - ? Integer.MAX_VALUE - : terrain.naturalHeight() - minimumHeadroom - settings.underground().minimumRockCover(); - } - - private int undergroundSegmentCap( - long courseId, - String profileKey, - HydrologyPoint start, - HydrologyPoint end, - int radius - ) { - int minimumHeadroom = settings.underground().minimumHeadroom(); - int maximumHeadroom = settings.underground().maximumHeadroom(); - UndergroundSegmentCapKey key = new UndergroundSegmentCapKey( - courseId, - profileKey, - start.x(), - start.z(), - end.x(), - end.z(), - radius, - minimumHeadroom, - maximumHeadroom - ); - PlanningSamples samples = planningSamples.get(); - if (samples != null) { - Integer cached = samples.undergroundSegmentCaps.get(key); - if (cached != null) { - return cached; - } - } - int segmentCap = Integer.MAX_VALUE; - List centerline = line(start, end, 1); - for (HydrologyPoint point : centerline) { - int headroom = sampleGeometry( - HydrologyGeometrySampler.Field.UNDERGROUND_HEADROOM, - profileKey, - point.x(), - point.z(), - courseId, - minimumHeadroom, - maximumHeadroom - ); - int minimumLandHeight = minimumLandHeightWithinRadius(point.x(), point.z(), radius); - if (minimumLandHeight != Integer.MAX_VALUE) { - segmentCap = Math.min(segmentCap, minimumLandHeight - headroom - settings.underground().minimumRockCover()); - } - } - if (samples != null) { - samples.undergroundSegmentCaps.put(key, segmentCap); - } - return segmentCap; - } - - private int[] nodeMaximumHeads(int[] segmentCaps) { - int[] maximumHeads = new int[segmentCaps.length + 1]; - maximumHeads[0] = segmentCaps[0]; - for (int index = 1; index < maximumHeads.length - 1; index++) { - maximumHeads[index] = Math.min(segmentCaps[index - 1], segmentCaps[index]); - } - maximumHeads[maximumHeads.length - 1] = segmentCaps[segmentCaps.length - 1]; - return maximumHeads; - } - - private int minimumLandHeightWithinRadius(int x, int z, int radius) { - PlanningSamples samples = planningSamples.get(); - MinimumLandHeightKey key = new MinimumLandHeightKey(x, z, radius); - if (samples != null) { - Integer cached = samples.minimumLandHeights.get(key); - if (cached != null) { - return cached; - } - } - - List offsets = samples == null - ? radialOffsets(radius) - : samples.radialOffsets.computeIfAbsent(radius, this::radialOffsets); - int minimumHeight = Integer.MAX_VALUE; - for (GridOffset offset : offsets) { - HydrologyTerrainSample terrain = sampleLandBasis(x + offset.x(), z + offset.z()); - if (terrain == null || terrain.ocean()) { - continue; - } - minimumHeight = Math.min(minimumHeight, terrain.naturalHeight()); - } - if (samples != null) { - samples.minimumLandHeights.put(key, minimumHeight); - } - return minimumHeight; - } - - private List radialOffsets(int radius) { - int blockRadius = (int) StrictMath.ceil(radius + 0.25D); - ArrayList offsets = new ArrayList<>(); - for (int deltaZ = -blockRadius; deltaZ <= blockRadius; deltaZ++) { - for (int deltaX = -blockRadius; deltaX <= blockRadius; deltaX++) { - if (StrictMath.hypot(deltaX, deltaZ) <= radius + 0.25D) { - offsets.add(new GridOffset(deltaX, deltaZ)); - } - } - } - return List.copyOf(offsets); - } - - private int[] undergroundMinimumHeads(CoursePath path, int[] depths, int outletHead) { - int[] minimumHeads = new int[path.points().size()]; - for (int index = 0; index < minimumHeads.length; index++) { - int depth = index == 0 - ? depths[0] - : index == depths.length ? depths[depths.length - 1] : Math.max(depths[index - 1], depths[index]); - depth = Math.max(depth, settings.geometry().drops().maximumBasinDepth()); - long worldFloorHead = (long) minimumY + depth + settings.underground().minimumFloorCover(); - int boundedWorldFloor = worldFloorHead < Integer.MIN_VALUE - ? Integer.MIN_VALUE - : worldFloorHead > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) worldFloorHead; - int configuredMinimum = index == minimumHeads.length - 1 - ? outletHead - : settings.underground().minimumFluidY(); - minimumHeads[index] = Math.max(outletHead, Math.max(configuredMinimum, boundedWorldFloor)); - } - return minimumHeads; - } - - private static boolean undergroundHeadsFeasible( - int[] minimumHeads, - int[] maximumHeads, - int outletHead - ) { - if (minimumHeads.length == 0 || minimumHeads.length != maximumHeads.length) { - throw new IllegalArgumentException("Underground head arrays must have the same positive length."); - } - int index = minimumHeads.length - 1; - int requiredHead = Math.max(minimumHeads[index], outletHead); - if (requiredHead > maximumHeads[index]) { - return false; - } - for (index--; index >= 0; index--) { - requiredHead = Math.max(minimumHeads[index], requiredHead); - if (requiredHead > maximumHeads[index]) { - return false; - } - } - return true; - } - - static boolean solveUndergroundHeads( - int[] preferredHeads, - int[] minimumHeads, - int[] maximumHeads, - int outletHead, - int[] solvedHeads - ) { - int length = preferredHeads.length; - if (length == 0 - || minimumHeads.length != length - || maximumHeads.length != length - || solvedHeads.length != length) { - throw new IllegalArgumentException("Underground head arrays must have the same positive length."); - } - int[] requiredHeads = new int[length]; - requiredHeads[length - 1] = Math.max(minimumHeads[length - 1], outletHead); - if (requiredHeads[length - 1] > maximumHeads[length - 1]) { - return false; - } - for (int index = length - 2; index >= 0; index--) { - requiredHeads[index] = Math.max(minimumHeads[index], requiredHeads[index + 1]); - if (requiredHeads[index] > maximumHeads[index]) { - return false; - } - } - solvedHeads[0] = clamp(preferredHeads[0], requiredHeads[0], maximumHeads[0]); - for (int index = 1; index < length; index++) { - int maximum = Math.min(maximumHeads[index], solvedHeads[index - 1]); - if (requiredHeads[index] > maximum) { - return false; - } - solvedHeads[index] = clamp(preferredHeads[index], requiredHeads[index], maximum); - } - solvedHeads[length - 1] = outletHead; - return outletHead >= minimumHeads[length - 1] - && outletHead <= maximumHeads[length - 1] - && (length == 1 || solvedHeads[length - 2] >= outletHead); - } - - private boolean addHydraulicSegments( - long courseId, - int pairIndex, - HydrologyFeatureType type, - int upstreamHead, - int downstreamHead, - int width, - int depth, - List centerline, - boolean surfaceCourse, - List segments - ) { - int drop = upstreamHead - downstreamHead; - if (drop <= 0 || centerline.size() < 2) { - long segmentId = HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, pairIndex, type.ordinal()); - segments.add(new HydraulicSegment( - segmentId, - courseId, - type, - upstreamHead, - downstreamHead, - width, - depth, - false, - false, - centerline - )); - return true; - } - if (type == HydrologyFeatureType.WATERFALL) { - return addFallingDropSegments( - courseId, - pairIndex, - upstreamHead, - downstreamHead, - width, - depth, - centerline, - surfaceCourse, - segments - ); - } - return addGradedDropSegments( - courseId, - pairIndex, - type, - upstreamHead, - downstreamHead, - width, - depth, - centerline, - surfaceCourse, - segments - ); - } - - private boolean addFallingDropSegments( - long courseId, - int pairIndex, - int upstreamHead, - int downstreamHead, - int width, - int depth, - List centerline, - boolean surfaceCourse, - List segments - ) { - List raster = rasterCenterline(centerline); - if (raster.size() < 2) { - return false; - } - int lipIndex = Math.min(waterfallLipIndex(raster), raster.size() - 2); - int receiverIndex = lipIndex + 1; - addGradedTransitionSegment( - courseId, - pairIndex, - GRADED_DROP_APPROACH_SALT, - HydrologyFeatureType.SURFACE_POOL, - upstreamHead, - width, - depth, - levelSlice(raster, 0, lipIndex, upstreamHead), - segments - ); - HydrologyPlannerSettings.Drops drops = settings.geometry().drops(); - int flowWidth = hydraulicDropWidth(width, surfaceCourse); - int flowDepth = drops.flowDepth(depth); - HydrologyPoint lip = withY(raster.get(lipIndex), upstreamHead); - HydrologyPoint receiver = withY(raster.get(receiverIndex), downstreamHead); - segments.add(new HydraulicSegment( - HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, pairIndex, GRADED_DROP_RUN_SALT), - courseId, - HydrologyFeatureType.WATERFALL, - upstreamHead, - downstreamHead, - flowWidth, - flowDepth, - true, - true, - List.of(lip, receiver) - )); - addGradedTransitionSegment( - courseId, - pairIndex, - GRADED_DROP_OUTFLOW_SALT, - HydrologyFeatureType.SURFACE_POOL, - downstreamHead, - width, - depth, - levelSlice(raster, receiverIndex, raster.size() - 1, downstreamHead), - segments - ); - return true; - } - - private boolean addGradedDropSegments( - long courseId, - int pairIndex, - HydrologyFeatureType type, - int upstreamHead, - int downstreamHead, - int width, - int depth, - List centerline, - boolean surfaceCourse, - List segments - ) { - int drop = upstreamHead - downstreamHead; - HydrologyPlannerSettings.Drops drops = settings.geometry().drops(); - boolean continuousSurfaceBore = surfaceCourse && type == HydrologyFeatureType.UNDERGROUND_DROP; - List directRaster = continuousSurfaceBore - ? rasterCenterline(centerline) - : List.of(); - int maximumStep = drops.stepLimit(type); - if (continuousSurfaceBore) { - if (directRaster.size() < 2) { - return false; - } - int requiredStep = Math.floorDiv(drop + directRaster.size() - 2, directRaster.size() - 1); - if (requiredStep > MAXIMUM_SURFACE_BORE_STEP) { - return false; - } - maximumStep = Math.max(maximumStep, requiredStep); - } - int minimumRun = Math.floorDiv(drop + maximumStep - 1, maximumStep) + 1; - int maximumGeneratedRun = Math.addExact(settings.routing().maximumRouteLength(), 1); - if (minimumRun > maximumGeneratedRun) { - return false; - } - int preferredRun = Math.addExact(Math.multiplyExact(drop, drops.cascadeRunPerBlock()), 1); - int undergroundRun = drops.undergroundCascadeRunPerBlock(); - int desiredRun = type.isUnderground() - ? (undergroundRun == 0 - ? minimumRun - : Math.min( - Math.max(minimumRun, Math.addExact(Math.multiplyExact(drop, undergroundRun), 1)), - maximumGeneratedRun - )) - : Math.min(preferredRun, maximumGeneratedRun); - List raster = continuousSurfaceBore - ? directRaster - : type.isUnderground() - ? organicDropRaster(courseId, pairIndex, centerline, desiredRun) - : rasterCenterline(centerline); - if (raster.size() < minimumRun) { - return false; - } - int runLength = Math.min(raster.size(), Math.max(minimumRun, desiredRun)); - int lipIndex = waterfallLipIndex(raster); - int runStart = continuousSurfaceBore - ? 0 - : type.isUnderground() - ? clamp(lipIndex - runLength / 3, 0, raster.size() - runLength) - : 0; - int runEnd = continuousSurfaceBore - ? raster.size() - 1 - : type.isUnderground() ? runStart + runLength - 1 : raster.size() - 1; - HydrologyFeatureType flatType = type.isUnderground() - ? HydrologyFeatureType.UNDERGROUND_POOL - : HydrologyFeatureType.SURFACE_POOL; - if (!continuousSurfaceBore) { - addGradedTransitionSegment( - courseId, - pairIndex, - GRADED_DROP_APPROACH_SALT, - flatType, - upstreamHead, - width, - depth, - levelSlice(raster, 0, runStart, upstreamHead), - segments - ); - } - List graded = gradedDropCenterline( - raster.subList(runStart, runEnd + 1), - upstreamHead, - downstreamHead, - drops, - maximumStep - ); - int dropWidth = hydraulicDropWidth(width, surfaceCourse); - int dropDepth = drops.flowDepth(depth); - segments.add(new HydraulicSegment( - HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, pairIndex, GRADED_DROP_RUN_SALT), - courseId, - type, - upstreamHead, - downstreamHead, - dropWidth, - dropDepth, - false, - !continuousSurfaceBore, - graded - )); - if (!continuousSurfaceBore) { - addGradedTransitionSegment( - courseId, - pairIndex, - GRADED_DROP_OUTFLOW_SALT, - flatType, - downstreamHead, - width, - depth, - levelSlice(raster, runEnd, raster.size() - 1, downstreamHead), - segments - ); - } - return true; - } - - private int hydraulicDropWidth(int channelWidth, boolean surfaceCourse) { - int dropWidth = settings.geometry().drops().flowWidth(channelWidth); - return surfaceCourse ? Math.max(settings.surface().minimumWidth(), dropWidth) : dropWidth; - } - - private List organicDropRaster( - long courseId, - int pairIndex, - List centerline, - int desiredRun - ) { - List base = rasterCenterline(centerline); - if (base.size() >= desiredRun) { - return base; - } - int wavelength = settings.geometry().meanders().detailWavelength(); - double phase = HydrologyHash.unit(HydrologyHash.mix(worldSeed, courseId, pairIndex, GRADED_DROP_RUN_SALT)) - * StrictMath.PI * 2D; - int maximumAmplitude = Math.max(3, settings.routing().sampleSpacing() / 2); - List longest = base; - for (int amplitude = 3; amplitude <= maximumAmplitude; amplitude += 2) { - int cycles = Math.max(1, (int) StrictMath.ceil( - Math.max(0, desiredRun - base.size()) / (2D * amplitude) - )); - int samples = Math.max(base.size(), desiredRun * 3); - ArrayList worm = new ArrayList<>(samples); - for (int sampleIndex = 0; sampleIndex < samples; sampleIndex++) { - double progress = sampleIndex / (double) (samples - 1); - double baseIndex = progress * (base.size() - 1); - int lowerIndex = Math.min(base.size() - 2, (int) StrictMath.floor(baseIndex)); - int upperIndex = lowerIndex + 1; - double localProgress = baseIndex - lowerIndex; - HydrologyPoint lower = base.get(lowerIndex); - HydrologyPoint upper = base.get(upperIndex); - double baseX = lower.x() + (upper.x() - lower.x()) * localProgress; - double baseZ = lower.z() + (upper.z() - lower.z()) * localProgress; - double tangentX = upper.x() - lower.x(); - double tangentZ = upper.z() - lower.z(); - double tangentLength = StrictMath.hypot(tangentX, tangentZ); - if (tangentLength <= 0D) { - continue; - } - double envelope = StrictMath.pow(StrictMath.sin(StrictMath.PI * progress), 2D); - double displacement = StrictMath.sin( - progress * StrictMath.PI * 2D * cycles - + baseIndex * StrictMath.PI * 2D / wavelength - + phase - ) * amplitude * envelope; - int x = (int) StrictMath.round(baseX - tangentZ / tangentLength * displacement); - int z = (int) StrictMath.round(baseZ + tangentX / tangentLength * displacement); - if (worm.isEmpty() || worm.getLast().x() != x || worm.getLast().z() != z) { - worm.add(new HydrologyPoint(x, lower.y(), z)); - } - } - List raster = rasterCenterline(worm); - if (raster.size() > longest.size()) { - longest = raster; - } - if (raster.size() >= desiredRun) { - return raster; - } - } - return longest; - } - - private void addGradedTransitionSegment( - long courseId, - int pairIndex, - long salt, - HydrologyFeatureType type, - int head, - int width, - int depth, - List centerline, - List segments - ) { - if (centerline.size() < 2) { - return; - } - segments.add(new HydraulicSegment( - HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, pairIndex, salt), - courseId, - type, - head, - head, - width, - depth, - false, - false, - List.copyOf(centerline) - )); - } - - private List gradedDropCenterline( - List points, - int upstreamHead, - int downstreamHead, - HydrologyPlannerSettings.Drops drops, - int maximumStep - ) { - int pointCount = points.size(); - int drop = upstreamHead - downstreamHead; - if ((long) (pointCount - 1) * maximumStep < drop) { - throw new IllegalArgumentException("Graded drop centerline cannot contain its configured head loss."); - } - ArrayList graded = new ArrayList<>(pointCount); - int previousHead = upstreamHead; - for (int pointIndex = 0; pointIndex < pointCount; pointIndex++) { - double progress = pointIndex / (double) (pointCount - 1); - int idealHead = upstreamHead - (int) StrictMath.round( - drop * StrictMath.pow(progress, drops.cascadeExponent()) - ); - int remainingSteps = pointCount - pointIndex - 1; - int latestReachableHead = downstreamHead + remainingSteps * maximumStep; - int head = Math.min(previousHead, Math.min(idealHead, latestReachableHead)); - head = Math.max(downstreamHead, Math.max(previousHead - maximumStep, head)); - if (pointIndex == pointCount - 1) { - head = downstreamHead; - } - HydrologyPoint point = points.get(pointIndex); - graded.add(new HydrologyPoint(point.x(), head, point.z())); - previousHead = head; - } - return List.copyOf(graded); - } - - private List levelSlice( - List points, - int startIndex, - int endIndex, - int head - ) { - ArrayList leveled = new ArrayList<>(Math.max(0, endIndex - startIndex + 1)); - for (int pointIndex = startIndex; pointIndex <= endIndex; pointIndex++) { - leveled.add(withY(points.get(pointIndex), head)); - } - return List.copyOf(leveled); - } - - private int waterfallLipIndex(List raster) { - return waterfallLipIndex(raster, 0); - } - - private int waterfallLipIndex(List raster, int requiredDecline) { - int fallback = Math.max(0, raster.size() / 2 - 1); - int selected = fallback; - long strongestDecline = Long.MIN_VALUE; - for (int pointIndex = 0; pointIndex < raster.size() - 1; pointIndex++) { - HydrologyPoint current = raster.get(pointIndex); - HydrologyPoint downstream = raster.get(pointIndex + 1); - HydrologyTerrainSample currentTerrain = sampleBasisWithoutSlope(current.x(), current.z()); - HydrologyTerrainSample downstreamTerrain = sampleBasisWithoutSlope(downstream.x(), downstream.z()); - long decline = (long) currentTerrain.naturalHeight() - downstreamTerrain.naturalHeight(); - if (decline > strongestDecline) { - strongestDecline = decline; - selected = pointIndex; - } - } - return requiredDecline <= 0 || strongestDecline >= requiredDecline ? selected : -1; - } - - private List rasterCenterline(List centerline) { - ArrayList raster = new ArrayList<>(); - for (int pointIndex = 0; pointIndex < centerline.size() - 1; pointIndex++) { - List span = rasterLine(centerline.get(pointIndex), centerline.get(pointIndex + 1)); - int first = raster.isEmpty() ? 0 : 1; - for (int spanIndex = first; spanIndex < span.size(); spanIndex++) { - raster.add(span.get(spanIndex)); - } - } - return List.copyOf(raster); - } - - private List rasterLine(HydrologyPoint start, HydrologyPoint end) { - int steps = Math.max(Math.abs(end.x() - start.x()), Math.abs(end.z() - start.z())); - if (steps == 0) { - return List.of(start); - } - ArrayList points = new ArrayList<>(steps + 1); - for (int step = 0; step <= steps; step++) { - double progress = step / (double) steps; - int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); - int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); - points.add(new HydrologyPoint(x, start.y(), z)); - } - return List.copyOf(points); - } - - private CoursePath coursePath( - SampledGrid grid, - RoutingPlan routing, - CompiledGraph graph, - int sourceIndex, - boolean surface - ) { - ArrayList edges = new ArrayList<>(); - ArrayList guide = new ArrayList<>(); - ArrayList guideEdges = new ArrayList<>(); - int current = sourceIndex; - int steps = 0; - while (routing.parent()[current] >= 0) { - DrainageEdge edge = graph.edgeByUpstream().get(current); - if (edge == null) { - return null; - } - edges.add(edge); - int downstream = routing.parent()[current]; - if (surface) { - for (HydrologyPoint point : edge.centerline()) { - if (guide.isEmpty()) { - guide.add(point); - } else if (point.x() != guide.getLast().x() || point.z() != guide.getLast().z()) { - guide.add(point); - guideEdges.add(edge); - } - } - } - current = downstream; - if (++steps > settings.routing().maximumRouteNodes()) { - return null; - } - } - int outletIndex = routing.outletIndex()[sourceIndex]; - if (outletIndex < 0 || edges.isEmpty()) { - return null; - } - RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); - if (!surface) { - return undergroundCoursePath(edges, outlet); - } - if (guide.size() < 2 || guideEdges.size() != guide.size() - 1) { - return null; - } - ArrayList routedGuide = new ArrayList<>(guide); - ArrayList routedGuideEdges = new ArrayList<>(guideEdges); - HydrologyPoint landward = outlet.landwardPoint(); - HydrologyPoint guideEnd = routedGuide.getLast(); - boolean terminateAtSinkhole = surfaceSinkhole(outlet) - && (guideEnd.x() != landward.x() || guideEnd.z() != landward.z()); - if (terminateAtSinkhole) { - routedGuide.set(routedGuide.size() - 1, landward); - } - List surfaceGuide = withoutDuplicateRoutePoints(routedGuide); - long geometryId = HydrologyHash.mix( - worldSeed, - COURSE_SALT, - SURFACE_SOURCE_SALT, - edges.getFirst().upstreamNodeId(), - outlet.id() - ); - Objects.requireNonNull(grid, "Surface course routing grid is required"); - PlanningSamples samples = planningSamples.get(); - DraftProfile profile = currentDraftProfile(); - profile.routeCalls++; - List points; - if (samples == null) { - profile.routeSolves++; - long solveStarted = System.nanoTime(); - points = surfaceCourseCenterline(grid, surfaceGuide, geometryId); - profile.routeSolveNanos += System.nanoTime() - solveStarted; - } else { - HashMap> routes = samples.surfaceRoutes.computeIfAbsent( - grid, ignored -> new HashMap<>() - ); - SurfaceRouteKey routeKey = new SurfaceRouteKey(surfaceGuide, geometryId); - points = routes.computeIfAbsent(routeKey, ignored -> { - profile.routeSolves++; - long solveStarted = System.nanoTime(); - List solved = surfaceCourseCenterline(grid, surfaceGuide, geometryId); - profile.routeSolveNanos += System.nanoTime() - solveStarted; - return solved; - }); - } - if (points.size() < 2) { - return null; - } - List pairEdges = mapCoursePairs(points, routedGuide, routedGuideEdges); - if (pairEdges.size() != points.size() - 1) { - return null; - } - return new CoursePath( - points, - pairEdges, - List.copyOf(edges), - outlet, - true, - routing.organicSurfaceRequired(), - null - ); - } - - private List surfaceCourseCenterline( - SampledGrid grid, - List guide, - long geometryId - ) { - if (guide.size() < 2) { - return List.of(); - } - int refinement = settings.routing().refinementSpacing(); - List base = smoothSurfaceGuide(resampleSurfaceGuide(guide, refinement)); - List nominal = meanderSurfaceGuide(base, geometryId, refinement); - if (nominal.size() < 2) { - return List.of(); - } - ArrayList> layers = new ArrayList<>(nominal.size()); - int transverseCandidates = SURFACE_COURSE_TRANSVERSE_CANDIDATES; - for (int pointIndex = 0; pointIndex < nominal.size(); pointIndex++) { - SurfaceCurvePoint point = nominal.get(pointIndex); - Direction tangent = surfaceCurveTangent(nominal, pointIndex); - if (pointIndex == 0 || pointIndex == nominal.size() - 1) { - HydrologyPoint endpoint = pointIndex == 0 ? guide.getFirst() : guide.getLast(); - layers.add(List.of(routeEndpoint(endpoint, tangent))); - continue; - } - double progress = pointIndex / (double) (nominal.size() - 1); - SurfaceCurvePoint basePoint = base.get(pointIndex); - RoutePosition position = new RoutePosition( - point.x(), - point.z(), - basePoint.x(), - basePoint.z(), - tangent - ); - long candidateId = HydrologyHash.mix(geometryId, pointIndex); - List candidates = unresolvedSurfaceRouteCandidates( - grid, - geometryId, - candidateId, - position, - progress, - refinement, - transverseCandidates - ); - if (candidates.isEmpty()) { - return List.of(); - } - layers.add(candidates); - } - ArrayList> availableLayers = new ArrayList<>(layers); - double maximumTurn = Math.min( - SURFACE_COURSE_MAXIMUM_TURN_DEGREES, - settings.geometry().meanders().maximumTurnDegrees() - ); - while (true) { - RouteCandidate[] route = selectCurvatureAwareTerrainRoute( - availableLayers, - refinement, - maximumTurn, - SURFACE_COURSE_TURN_COST - ); - if (route.length == 0) { - if (addExhaustedSurfaceRouteFallbacks( - grid, - availableLayers, - nominal, - base, - geometryId - )) { - continue; - } - return List.of(); - } - int pitRemoval = removeTerrainPits(availableLayers, route); - if (pitRemoval < 0) { - return List.of(); - } - if (pitRemoval > 0) { - continue; - } - ArrayList points = new ArrayList<>(route.length); - for (RouteCandidate candidate : route) { - HydrologyPoint point = candidate.point(); - if (points.isEmpty() - || point.x() != points.getLast().x() - || point.z() != points.getLast().z()) { - points.add(point); - } - } - if (points.size() < 2 || !traversableRoute(points)) { - return List.of(); - } - return smoothTerrainRoute(points); - } - } - - private boolean addExhaustedSurfaceRouteFallbacks( - SampledGrid grid, - List> layers, - List nominal, - List base, - long geometryId - ) { - boolean added = false; - for (int layerIndex = 1; layerIndex < layers.size() - 1; layerIndex++) { - List layer = layers.get(layerIndex); - if (!exhaustedSurfaceRouteLayer(layer)) { - continue; - } - SurfaceCurvePoint nominalPoint = nominal.get(layerIndex); - SurfaceCurvePoint basePoint = base.get(layerIndex); - Direction tangent = surfaceCurveTangent(nominal, layerIndex); - int fallbackX = (int) StrictMath.round(basePoint.x()); - int fallbackZ = (int) StrictMath.round(basePoint.z()); - long packed = RiverFootprint.pack(fallbackX, fallbackZ); - boolean present = false; - for (RouteCandidate candidate : layer) { - if (RiverFootprint.pack(candidate.point().x(), candidate.point().z()) == packed) { - present = true; - break; - } - } - if (present) { - continue; - } - RouteTerrainEstimate estimate = routeTerrainEstimate(grid, fallbackX, fallbackZ); - double offset = (basePoint.x() - nominalPoint.x()) * -tangent.z() - + (basePoint.z() - nominalPoint.z()) * tangent.x(); - double localScore = estimate.terrainScore() - + StrictMath.abs(offset) * 0.18D - + HydrologyHash.unit(HydrologyHash.mix( - worldSeed, - geometryId, - HydrologyHash.mix(geometryId, layerIndex), - fallbackX, - fallbackZ - )) * 1.0E-6D; - ArrayList expanded = new ArrayList<>(layer); - expanded.add(new RouteCandidate( - new HydrologyPoint(fallbackX, estimate.height(), fallbackZ), - offset, - localScore, - estimate.terrainScore(), - tangent, - false - )); - layers.set(layerIndex, List.copyOf(expanded)); - added = true; - } - return added; - } - - private boolean exhaustedSurfaceRouteLayer(List layer) { - for (RouteCandidate candidate : layer) { - if (!candidate.terrainResolved() || Double.isFinite(candidate.localScore())) { - return false; - } - } - return true; - } - - private double routeTurnScore(List route) { - List sampled = resampleRouteCenterline( - route, - Math.max(16D, settings.routing().refinementSpacing() * 4D) - ); - if (sampled.size() < 3) { - return Double.POSITIVE_INFINITY; - } - ArrayList turns = new ArrayList<>(sampled.size() - 2); - double maximum = 0D; - for (int pointIndex = 1; pointIndex < sampled.size() - 1; pointIndex++) { - double turn = routeTurnDegrees( - sampled.get(pointIndex - 1), - sampled.get(pointIndex), - sampled.get(pointIndex + 1) - ); - turns.add(turn); - maximum = Math.max(maximum, turn); - } - turns.sort(Double::compare); - int percentileIndex = (int) StrictMath.ceil(0.95D * turns.size()) - 1; - double percentile = turns.get(Math.max(0, Math.min(percentileIndex, turns.size() - 1))); - return percentile + maximum * 0.05D; - } - - private double surfaceRouteCandidateBankPenalty(RouteCandidate candidate) { - int minimumBankDistance = surfaceBankDistance(settings.surface().minimumWidth()); - int maximumBankDistance = surfaceBankDistance(settings.surface().maximumWidth()); - int maximumBankRise = Math.addExact( - settings.surface().maximumIncision(), - (int) StrictMath.ceil(settings.surface().banks().minimumBlendWidth() * 0.5D) - ); - HydrologyPoint point = candidate.point(); - HydrologyTerrainSample terrain = sampleLandBasis(point.x(), point.z()); - if (terrain == null) { - return Double.POSITIVE_INFINITY; - } - if (terrain.slope() >= settings.hydraulics().waterfallMinimumDrop()) { - return 0D; - } - int head = Math.subtractExact( - terrain.naturalHeight(), - settings.surface().banks().sink() - ); - return surfaceRouteBankPenalty( - point, - candidate.tangent(), - minimumBankDistance, - maximumBankDistance, - head, - maximumBankRise - ); - } - - private double surfaceRouteBankPenalty( - HydrologyPoint point, - Direction tangent, - int minimumDistance, - int maximumDistance, - int head, - int maximumBankRise - ) { - double penalty = 0D; - for (int distance = minimumDistance; distance <= maximumDistance; distance++) { - penalty += surfaceRouteBankPenalty(point, tangent, distance, head, maximumBankRise); - penalty += surfaceRouteBankPenalty(point, tangent, -distance, head, maximumBankRise); - } - return penalty; - } - - private double surfaceRouteBankPenalty( - HydrologyPoint point, - Direction tangent, - int signedDistance, - int head, - int maximumBankRise - ) { - HydrologyTerrainSample bank = surfaceBankTerrain(point, tangent, signedDistance); - if (bank == null) { - return 1.0E12D; - } - int rise = bank.naturalHeight() - head; - int shortfall = SURFACE_MINIMUM_NATURAL_BANK_RISE - rise; - if (shortfall > 0) { - return (double) shortfall * shortfall * 4096D; - } - int excess = Math.max(0, rise - maximumBankRise); - return (double) excess * excess * 128D; - } - - private int surfaceBankDistance(int width) { - int channelRadius = (int) StrictMath.ceil(width / 2D); - return Math.max( - channelRadius + 1, - (int) StrictMath.ceil( - channelRadius * SURFACE_MAXIMUM_WIDTH_SCALE + settings.surface().shoreWidth() - ) + 1 - ); - } - - private List resampleSurfaceGuide(List guide, int spacing) { - double[] cumulative = new double[guide.size()]; - for (int pointIndex = 1; pointIndex < guide.size(); pointIndex++) { - HydrologyPoint previous = guide.get(pointIndex - 1); - HydrologyPoint point = guide.get(pointIndex); - cumulative[pointIndex] = cumulative[pointIndex - 1] - + StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); - } - double totalLength = cumulative[cumulative.length - 1]; - if (totalLength <= 0D) { - return List.of(); - } - int capacity = Math.addExact(2, (int) StrictMath.ceil(totalLength / spacing)); - ArrayList sampled = new ArrayList<>(capacity); - int segmentIndex = 0; - for (double distance = 0D; distance < totalLength; distance += spacing) { - while (segmentIndex < guide.size() - 2 - && cumulative[segmentIndex + 1] < distance) { - segmentIndex++; - } - HydrologyPoint start = guide.get(segmentIndex); - HydrologyPoint end = guide.get(segmentIndex + 1); - double segmentLength = cumulative[segmentIndex + 1] - cumulative[segmentIndex]; - double progress = segmentLength <= 0D - ? 0D - : (distance - cumulative[segmentIndex]) / segmentLength; - sampled.add(new SurfaceCurvePoint( - start.x() + (end.x() - start.x()) * progress, - start.z() + (end.z() - start.z()) * progress, - distance - )); - } - HydrologyPoint end = guide.getLast(); - sampled.add(new SurfaceCurvePoint(end.x(), end.z(), totalLength)); - return List.copyOf(sampled); - } - - private List smoothSurfaceGuide(List guide) { - if (guide.size() < 3) { - return guide; - } - List current = guide; - int passes = Math.max(2, settings.geometry().meanders().smoothingPasses() + 1); - for (int pass = 0; pass < passes; pass++) { - ArrayList smoothed = new ArrayList<>(current.size()); - smoothed.add(current.getFirst()); - for (int pointIndex = 1; pointIndex < current.size() - 1; pointIndex++) { - SurfaceCurvePoint previous = current.get(pointIndex - 1); - SurfaceCurvePoint point = current.get(pointIndex); - SurfaceCurvePoint next = current.get(pointIndex + 1); - smoothed.add(new SurfaceCurvePoint( - previous.x() * 0.25D + point.x() * 0.5D + next.x() * 0.25D, - previous.z() * 0.25D + point.z() * 0.5D + next.z() * 0.25D, - point.distance() - )); - } - smoothed.add(current.getLast()); - current = List.copyOf(smoothed); - } - return current; - } - - private List meanderSurfaceGuide( - List guide, - long geometryId, - int refinement - ) { - HydrologyPlannerSettings.Meanders meanders = settings.geometry().meanders(); - double detailWeight = meanders.detailStrength() * 0.08D; - double totalWeight = meanders.primaryStrength() + detailWeight; - if (guide.size() < 3 || totalWeight <= 0D || meanders.maximumOffsetRatio() <= 0D) { - return guide; - } - double maximumOffset = settings.routing().sampleSpacing() * Math.min( - 0.16D, - meanders.maximumOffsetRatio() * 0.32D - ); - double primaryPhase = HydrologyHash.unit(HydrologyHash.mix(geometryId, ROUTE_WORM_PRIMARY_SALT)) - * StrictMath.PI * 2D; - double detailPhase = HydrologyHash.unit(HydrologyHash.mix(geometryId, ROUTE_WORM_DETAIL_SALT)) - * StrictMath.PI * 2D; - double totalLength = guide.getLast().distance(); - double taperLength = Math.max( - refinement * 8D, - Math.min(settings.routing().sampleSpacing() * 0.75D, meanders.primaryWavelength() * 0.35D) - ); - ArrayList meandered = new ArrayList<>(guide.size()); - for (int pointIndex = 0; pointIndex < guide.size(); pointIndex++) { - SurfaceCurvePoint point = guide.get(pointIndex); - Direction tangent = surfaceCurveTangent(guide, pointIndex); - double endpointDistance = Math.min(point.distance(), totalLength - point.distance()); - double taperProgress = Math.min(1D, endpointDistance / taperLength); - double taper = StrictMath.pow(StrictMath.sin(taperProgress * StrictMath.PI * 0.5D), 2D); - double primary = StrictMath.sin( - point.distance() * StrictMath.PI * 2D / meanders.primaryWavelength() + primaryPhase - ) * meanders.primaryStrength(); - double detail = StrictMath.sin( - point.distance() * StrictMath.PI * 2D / meanders.detailWavelength() + detailPhase - ) * detailWeight; - double offset = maximumOffset * taper * (primary + detail) / totalWeight; - meandered.add(new SurfaceCurvePoint( - point.x() - tangent.z() * offset, - point.z() + tangent.x() * offset, - point.distance() - )); - } - return List.copyOf(meandered); - } - - private Direction surfaceCurveTangent(List points, int pointIndex) { - SurfaceCurvePoint start = points.get(Math.max(0, pointIndex - 2)); - SurfaceCurvePoint end = points.get(Math.min(points.size() - 1, pointIndex + 2)); - double deltaX = end.x() - start.x(); - double deltaZ = end.z() - start.z(); - double length = StrictMath.hypot(deltaX, deltaZ); - return length <= 0D - ? new Direction(1D, 0D) - : new Direction(deltaX / length, deltaZ / length); - } - - private CoursePath undergroundCoursePath(List edges, RiverOutlet outlet) { - ArrayList points = new ArrayList<>(); - ArrayList pairEdges = new ArrayList<>(); - for (DrainageEdge edge : edges) { - for (int pointIndex = 0; pointIndex < edge.centerline().size(); pointIndex++) { - HydrologyPoint point = edge.centerline().get(pointIndex); - if (points.isEmpty()) { - points.add(point); - } else if (pointIndex > 0) { - points.add(point); - pairEdges.add(edge); - } - } - } - return points.size() >= 2 && pairEdges.size() == points.size() - 1 - ? new CoursePath( - List.copyOf(points), - List.copyOf(pairEdges), - List.copyOf(edges), - outlet, - true, - false, - null - ) - : null; - } - - private List mapCoursePairs( - List points, - List guide, - List guideEdges - ) { - ArrayList mapped = new ArrayList<>(points.size() - 1); - int minimumGuideIndex = 0; - for (int pointIndex = 0; pointIndex < points.size() - 1; pointIndex++) { - HydrologyPoint first = points.get(pointIndex); - HydrologyPoint second = points.get(pointIndex + 1); - double x = (first.x() + second.x()) * 0.5D; - double z = (first.z() + second.z()) * 0.5D; - int selectedIndex = minimumGuideIndex; - double selectedDistance = Double.POSITIVE_INFINITY; - for (int guideIndex = minimumGuideIndex; guideIndex < guideEdges.size(); guideIndex++) { - double distance = pointToSegmentDistanceSquared( - x, - z, - guide.get(guideIndex), - guide.get(guideIndex + 1) - ); - if (distance < selectedDistance) { - selectedIndex = guideIndex; - selectedDistance = distance; - } - } - minimumGuideIndex = selectedIndex; - mapped.add(guideEdges.get(selectedIndex)); - } - return List.copyOf(mapped); - } - - private double pointToSegmentDistanceSquared( - double x, - double z, - HydrologyPoint start, - HydrologyPoint end - ) { - double deltaX = end.x() - start.x(); - double deltaZ = end.z() - start.z(); - double lengthSquared = deltaX * deltaX + deltaZ * deltaZ; - if (lengthSquared == 0D) { - double pointX = x - start.x(); - double pointZ = z - start.z(); - return pointX * pointX + pointZ * pointZ; - } - double progress = ((x - start.x()) * deltaX + (z - start.z()) * deltaZ) / lengthSquared; - progress = Math.max(0D, Math.min(1D, progress)); - double nearestX = start.x() + deltaX * progress; - double nearestZ = start.z() + deltaZ * progress; - double pointX = x - nearestX; - double pointZ = z - nearestZ; - return pointX * pointX + pointZ * pointZ; - } - - private HydrologyTerrainSample surfaceBankTerrain( - HydrologyPoint point, - Direction tangent, - int signedDistance - ) { - HydrologyPoint bankPoint = surfaceBankPoint(point, tangent, signedDistance); - int bankX = bankPoint.x(); - int bankZ = bankPoint.z(); - return sampleLandBasisWithoutSlope(bankX, bankZ); - } - - private HydrologyPoint surfaceBankPoint(HydrologyPoint point, Direction tangent, int signedDistance) { - return new HydrologyPoint( - (int) StrictMath.round(point.x() - tangent.z() * signedDistance), - point.y(), - (int) StrictMath.round(point.z() + tangent.x() * signedDistance) - ); - } - - private void levelUndergroundMouth(CoursePath path, int[] heads, int outletHead) { - heads[heads.length - 1] = outletHead; - int levelingDistance = settings.outlets().mouthLevelingDistance(); - if (levelingDistance == 0) { - return; - } - double remaining = 0D; - int initialHead = heads[0]; - for (int index = path.points().size() - 2; index >= 0; index--) { - HydrologyPoint current = path.points().get(index); - HydrologyPoint downstream = path.points().get(index + 1); - remaining += StrictMath.hypot(downstream.x() - current.x(), downstream.z() - current.z()); - if (remaining > levelingDistance) { - break; - } - double ratio = remaining / levelingDistance; - int cap = outletHead + (int) StrictMath.ceil((initialHead - outletHead) * ratio); - heads[index] = Math.min(heads[index], cap); - } - for (int index = 1; index < heads.length; index++) { - heads[index] = Math.min(heads[index - 1], heads[index]); - } - heads[heads.length - 1] = outletHead; - } - - private void appendOutletSegments( - RiverCourseType courseType, - long courseId, - CoursePath path, - int head, - int[] widths, - int[] depths, - List segments - ) { - RiverOutlet outlet = path.outlet(); - int width = widths.length == 0 ? 1 : widths[widths.length - 1]; - int depth = depths.length == 0 ? 1 : depths[depths.length - 1]; - if (courseType != RiverCourseType.SURFACE - && outlet.type() == HydrologyFeatureType.INLAND_GROTTO) { - width = settings.underground().minimumWidth(); - depth = settings.underground().minimumDepth(); - } - HydrologyPoint pathEnd = withY(path.points().getLast(), head); - HydrologyPoint landward = withY(outlet.landwardPoint(), head); - if (courseType == RiverCourseType.SURFACE - && outlet.type() == HydrologyFeatureType.COASTAL_GROTTO) { - appendSurfaceCoastalGrotto( - courseId, - outlet, - head, - width, - depth, - pathEnd, - landward, - segments - ); - return; - } - if (outlet.type() == HydrologyFeatureType.MOUTH) { - if (courseType == RiverCourseType.SURFACE) { - appendSurfaceMouth(courseId, outlet, head, width, depth, pathEnd, segments); - return; - } - HydrologyPoint connection = withY(outlet.connectionPoint(), head); - addFlatSegment( - courseId, - HydrologyFeatureType.MOUTH, - head, - width, - depth, - line(pathEnd, connection, settings.routing().refinementSpacing()), - segments - ); - return; - } - if (courseType == RiverCourseType.SURFACE && surfaceSinkhole(outlet)) { - appendSurfaceSinkhole(courseId, outlet, head, width, depth, pathEnd, landward, segments); - return; - } - HydrologyPoint connection = withY(outlet.connectionPoint(), head); - if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { - HydrologyFeatureType connectorType = courseType == RiverCourseType.SURFACE - ? HydrologyFeatureType.MOUTH - : HydrologyFeatureType.UNDERGROUND_POOL; - addFlatSegment( - courseId, - connectorType, - head, - width, - depth, - line(pathEnd, landward, settings.routing().refinementSpacing()), - segments - ); - } - List centerline = landward.x() == connection.x() && landward.z() == connection.z() - ? List.of(landward) - : List.of(landward, connection); - addFlatSegment(courseId, outlet.type(), head, width, depth, centerline, segments); - } - - private void appendSurfaceMouth( - long courseId, - RiverOutlet outlet, - int surfaceHead, - int width, - int depth, - HydrologyPoint pathEnd, - List segments - ) { - int seaLevel = outletHead(outlet); - HydrologyPoint connection = withY(outlet.connectionPoint(), seaLevel); - if (surfaceHead != seaLevel) { - throw new IllegalStateException("A surface mouth reached the coastal crossing above sea level."); - } - addFlatSegment( - courseId, - HydrologyFeatureType.MOUTH, - seaLevel, - width, - depth, - line(pathEnd, connection, settings.routing().refinementSpacing()), - segments - ); - } - - private void appendSurfaceCoastalGrotto( - long courseId, - RiverOutlet outlet, - int surfaceHead, - int width, - int depth, - HydrologyPoint pathEnd, - HydrologyPoint landward, - List segments - ) { - if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { - addFlatSegment( - courseId, - HydrologyFeatureType.SURFACE_POOL, - surfaceHead, - width, - depth, - line(pathEnd, landward, settings.routing().refinementSpacing()), - segments - ); - } - int seaLevel = outletHead(outlet); - HydrologyPoint connection = withY(outlet.connectionPoint(), seaLevel); - if (surfaceHead > seaLevel) { - addFallingDropSegments( - courseId, - segments.size(), - surfaceHead, - seaLevel, - width, - depth, - List.of(landward, connection), - true, - segments - ); - } - addFlatSegment( - courseId, - HydrologyFeatureType.COASTAL_GROTTO, - seaLevel, - width, - depth, - List.of(withY(outlet.landwardPoint(), seaLevel), connection), - segments - ); - } - - private void appendSurfaceSinkhole( - long courseId, - RiverOutlet outlet, - int surfaceHead, - int surfaceWidth, - int surfaceDepth, - HydrologyPoint pathEnd, - HydrologyPoint landward, - List segments - ) { - if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { - addFlatSegment( - courseId, - HydrologyFeatureType.SURFACE_POOL, - surfaceHead, - surfaceWidth, - surfaceDepth, - line(pathEnd, landward, settings.routing().refinementSpacing()), - segments - ); - } - int undergroundHead = outletHead(outlet); - int throatWidth = Math.max(settings.underground().minimumWidth(), surfaceWidth - 1); - int throatDepth = settings.underground().minimumDepth(); - HydrologyPoint receiving = withY(outlet.connectionPoint(), undergroundHead); - List descent = sinkholeDescent( - courseId, - landward, - receiving, - surfaceHead - undergroundHead - ); - List gradedDescent = gradedDropCenterline( - rasterCenterline(descent), - surfaceHead, - undergroundHead, - settings.geometry().drops(), - settings.geometry().drops().stepLimit(HydrologyFeatureType.SINKHOLE) - ); - int descentWidth = Math.max(throatWidth, hydraulicDropWidth(throatWidth, true)); - segments.add(new HydraulicSegment( - HydrologyHash.mix( - worldSeed, - SEGMENT_SALT, - courseId, - segments.size(), - HydrologyFeatureType.SINKHOLE.ordinal() - ), - courseId, - HydrologyFeatureType.SINKHOLE, - surfaceHead, - undergroundHead, - descentWidth, - throatDepth, - false, - true, - gradedDescent - )); - addFlatSegment( - courseId, - HydrologyFeatureType.INLAND_GROTTO, - undergroundHead, - throatWidth, - throatDepth, - List.of(receiving), - segments - ); - } - - private List sinkholeDescent( - long courseId, - HydrologyPoint landward, - HydrologyPoint receiving, - int drop - ) { - int desiredRun = Math.max( - 4, - (int) StrictMath.ceil(drop / (double) settings.geometry().drops().maximumCascadeStep()) + 1 - ); - double startX = landward.x() - receiving.x(); - double startZ = landward.z() - receiving.z(); - double startRadius = StrictMath.hypot(startX, startZ); - double startAngle = startRadius <= 0D - ? HydrologyHash.unit(HydrologyHash.mix(worldSeed, courseId, SEGMENT_SALT)) * StrictMath.PI * 2D - : StrictMath.atan2(startZ, startX); - double maximumRadius = Math.max(2D, settings.outlets().inlandGrotto().horizontalRadius() - 1D); - int turns = Math.max(1, (int) StrictMath.ceil(desiredRun / (StrictMath.PI * maximumRadius))); - ArrayList points = new ArrayList<>(desiredRun * 4 + 1); - int samples = desiredRun * 4; - for (int sample = 0; sample <= samples; sample++) { - double progress = sample / (double) samples; - double radius = Math.min( - maximumRadius, - startRadius * (1D - progress) + maximumRadius * StrictMath.sin(StrictMath.PI * progress) - ); - double angle = startAngle + turns * StrictMath.PI * 2D * progress; - int x = (int) StrictMath.round(receiving.x() + StrictMath.cos(angle) * radius); - int z = (int) StrictMath.round(receiving.z() + StrictMath.sin(angle) * radius); - if (points.isEmpty() || points.getLast().x() != x || points.getLast().z() != z) { - points.add(new HydrologyPoint(x, landward.y(), z)); - } - } - if (points.getLast().x() != receiving.x() || points.getLast().z() != receiving.z()) { - points.add(receiving); - } - return List.copyOf(points); - } - - private boolean surfaceSinkhole(RiverOutlet outlet) { - return outlet.type() == HydrologyFeatureType.INLAND_GROTTO - && settings.outlets().surfaceSinkholesEnabled(); - } - - private void addFlatSegment( - long courseId, - HydrologyFeatureType type, - int head, - int width, - int depth, - List centerline, - List segments - ) { - long segmentId = HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, segments.size(), type.ordinal()); - segments.add(new HydraulicSegment( - segmentId, - courseId, - type, - head, - head, - width, - depth, - false, - false, - centerline - )); - } - - /** - * Standing surface pools: a jittered lattice of candidate sites per pool profile, admitted where the - * policy lists the pool, the ground is open land clear of every accepted course, and the bowl fits - * the incision cap. Each accepted pool is an independent course with one STANDING_POOL segment. - */ - private void compileSurfacePools( - HydrologyTileKey key, - List courses, - List diagnostics - ) { - int tileSize = settings.routing().tileSize(); - for (HydrologyPlannerSettings.SurfacePool pool : settings.surfacePools()) { - if (!pool.enabled() || pool.maximumPerTile() == 0) { - continue; - } - long profileSeed = HydrologyHash.mix(worldSeed, SURFACE_POOL_SALT, HydrologyHash.text(pool.id())); - int target = Math.min(pool.maximumPerTile(), expectedCount(pool.density(), HydrologyHash.mix( - profileSeed, key.tileX(), key.tileZ()))); - int accepted = 0; - for (DeepSite site : poolSites(key, pool, profileSeed, tileSize)) { - if (accepted >= target) { - addPoolDiagnostic(site, HydrologyCandidateRejection.SOURCE_QUOTA, diagnostics); - continue; - } - HydrologyCandidateRejection rejection = poolAdmission(pool, site, courses); - if (rejection != null) { - addPoolDiagnostic(site, rejection, diagnostics); - continue; - } - RiverCourse course = buildSurfacePoolCourse(pool, site); - if (course == null) { - addPoolDiagnostic(site, HydrologyCandidateRejection.SURFACE_CORRIDOR_UNSUPPORTED, diagnostics); - continue; - } - courses.add(course); - accepted++; - } - } - } - - private ArrayList poolSites( - HydrologyTileKey key, - HydrologyPlannerSettings.SurfacePool pool, - long profileSeed, - int tileSize - ) { - int minimumX = key.minimumBlockX(tileSize); - int minimumZ = key.minimumBlockZ(tileSize); - int spacing = pool.spacing(); - int xOffset = HydrologyHash.between(HydrologyHash.mix(profileSeed, DEEP_FLUID_X_OFFSET_SALT), 0, spacing - 1); - int zOffset = HydrologyHash.between(HydrologyHash.mix(profileSeed, DEEP_FLUID_Z_OFFSET_SALT), 0, spacing - 1); - long firstCellX = ceilDiv((long) minimumX - xOffset, spacing); - long firstCellZ = ceilDiv((long) minimumZ - zOffset, spacing); - long lastCellX = Math.floorDiv((long) minimumX + tileSize - 1L - xOffset, spacing); - long lastCellZ = Math.floorDiv((long) minimumZ + tileSize - 1L - zOffset, spacing); - ArrayList sites = new ArrayList<>(); - for (long cellZ = firstCellZ; cellZ <= lastCellZ; cellZ++) { - for (long cellX = firstCellX; cellX <= lastCellX; cellX++) { - long stable = HydrologyHash.mix(profileSeed, cellX, cellZ); - // Jitter inside the cell keeps pools off a visible grid. - int jitter = Math.max(1, spacing / 3); - int x = Math.toIntExact(xOffset + cellX * spacing + HydrologyHash.between(HydrologyHash.mix(stable, 11), -jitter, jitter)); - int z = Math.toIntExact(zOffset + cellZ * spacing + HydrologyHash.between(HydrologyHash.mix(stable, 12), -jitter, jitter)); - HydrologyTerrainSample terrain = sampleLandBasis(x, z); - sites.add(new DeepSite(x, z, terrain == null ? 0 : terrain.naturalHeight(), stable)); - } - } - sites.sort(Comparator.comparingLong(DeepSite::stableId)); - return sites; - } - - private HydrologyCandidateRejection poolAdmission( - HydrologyPlannerSettings.SurfacePool pool, - DeepSite site, - List courses - ) { - HydrologyTerrainSample terrain = sampleLandBasis(site.x(), site.z()); - if (terrain == null || terrain.ocean() || terrain.naturalHeight() <= settings.seaLevel() + 1) { - return HydrologyCandidateRejection.SURFACE_EXPOSURE; - } - if (!terrain.transitAllowed() || !terrain.surfacePoolKeys().contains(pool.id())) { - return HydrologyCandidateRejection.POLICY_EXCLUDED; - } - long clearance = pool.maximumRadius() + (long) StrictMath.ceil(settings.surface().shoreWidth()) - + settings.surface().banks().maximumBlendWidth() + settings.surface().maximumWidth(); - long clearanceSquared = clearance * clearance; - for (RiverCourse course : courses) { - for (HydraulicSegment segment : course.segments()) { - for (HydrologyPoint point : segment.centerline()) { - long deltaX = (long) point.x() - site.x(); - long deltaZ = (long) point.z() - site.z(); - if (deltaX * deltaX + deltaZ * deltaZ < clearanceSquared) { - return HydrologyCandidateRejection.SOURCE_SPACING; - } - } - } - } - return null; - } - - private RiverCourse buildSurfacePoolCourse(HydrologyPlannerSettings.SurfacePool pool, DeepSite site) { - int radius = HydrologyHash.between(HydrologyHash.mix(site.stableId(), 3), pool.minimumRadius(), pool.maximumRadius()); - HydrologyTerrainSample terrain = sampleLandBasis(site.x(), site.z()); - List points = List.of( - new HydrologyPoint(site.x() - 1, site.head(), site.z()), - new HydrologyPoint(site.x(), site.head(), site.z()), - new HydrologyPoint(site.x() + 1, site.head(), site.z()) - ); - SurfaceCenterline centerline = SurfaceCenterline.densify(points); - int count = centerline.size(); - double[] halfWidth = new double[count]; - double[] depth = new double[count]; - double[] bank = new double[count]; - Arrays.fill(halfWidth, radius); - Arrays.fill(depth, pool.depth()); - Arrays.fill(bank, terrain == null ? 1D : terrain.bankMultiplier()); - ChannelProfile profile = new ChannelProfile(halfWidth, depth, bank); - ValleyProfile valley = new ValleyProfileSolver(settings.surface(), this::sampleBasis, settings.seaLevel(), 0) - .solve(centerline, profile, SurfaceTerminal.SINKHOLE, Integer.MIN_VALUE); - if (!valley.accepted()) { - return null; - } - int center = Math.min(1, valley.exposedStations() - 1); - int head = valley.head()[center]; - // A pool belongs in a hollow or on level ground: the whole rim must sit within a few blocks of the - // water, or the bowl becomes a scar dug into a slope. - int rimAllowance = pool.depth() + settings.surface().banks().sink() + 2; - for (int station = 0; station < valley.exposedStations(); station++) { - if (valley.crossMax()[station] - valley.head()[station] > rimAllowance) { - return null; - } - } - long courseId = HydrologyHash.mix(worldSeed, SURFACE_POOL_SALT, HydrologyHash.text(pool.id()), site.stableId()); - long segmentId = HydrologyHash.mix(courseId, SEGMENT_SALT, HydrologyFeatureType.STANDING_POOL.ordinal()); - ArrayList centerlinePoints = new ArrayList<>(points.size()); - for (HydrologyPoint point : points) { - centerlinePoints.add(new HydrologyPoint(point.x(), head, point.z())); - } - HydraulicSegment segment = new HydraulicSegment( - segmentId, - courseId, - HydrologyFeatureType.STANDING_POOL, - head, - head, - radius * 2, - pool.depth(), - false, - false, - centerlinePoints - ); - return new RiverCourse( - courseId, - RiverCourseType.SURFACE_POOL, - OptionalLong.empty(), - OptionalLong.empty(), - pool.id(), - 1, - List.of(), - List.of(segment) - ); - } - - private void addPoolDiagnostic( - DeepSite site, - HydrologyCandidateRejection rejection, - List diagnostics - ) { - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(site.stableId(), DIAGNOSTIC_SALT, rejection.ordinal()), - HydrologyCandidateKind.POOL, - HydrologyFeatureType.STANDING_POOL, - new HydrologyPoint(site.x(), site.head(), site.z()), - rejection, - 0 - )); - } - - /** - * Sea caves: coastal grottos the sea opens into without a river. Every owned land node with a proven - * ocean boundary is a site, ranked by how high the coast stands over the sea; each accepted site is an - * independent course whose chamber is swept inland from the shoreline and opens only through its ocean - * face. Rivers keep their outlets: sea caves stay clear of every mouth and grotto already planned. - */ - private void compileSeaCaves( - SampledGrid grid, - List courses, - List diagnostics - ) { - HydrologyPlannerSettings.SeaCaves seaCaves = settings.seaCaves(); - if (!seaCaves.enabled() || seaCaves.maximumPerTile() == 0) { - return; - } - HydrologyPlannerSettings.Grotto grotto = settings.outlets().coastalGrotto(); - boolean fits = sweptGrottoVolume(grotto, seaCaves.depth()) <= grotto.maximumVolume(); - ArrayList accepted = new ArrayList<>(); - for (SeaCaveSite site : seaCaveSites(grid)) { - if (accepted.size() >= seaCaves.maximumPerTile()) { - addSeaCaveDiagnostic(site, HydrologyCandidateRejection.SOURCE_QUOTA, diagnostics); - continue; - } - if (!fits) { - addSeaCaveDiagnostic(site, HydrologyCandidateRejection.VOLUME_LIMIT, diagnostics); - continue; - } - HydrologyCandidateRejection rejection = seaCaveAdmission(site, accepted, courses); - if (rejection != null) { - addSeaCaveDiagnostic(site, rejection, diagnostics); - continue; - } - courses.add(buildSeaCaveCourse(site)); - accepted.add(site); - } - } - - private ArrayList seaCaveSites(SampledGrid grid) { - int depth = settings.seaCaves().depth(); - ArrayList sites = new ArrayList<>(); - for (GridNode land : grid.nodes()) { - HydrologyTerrainSample terrain = land.terrain(); - if (!grid.owns(land.x(), land.z()) - || terrain.ocean() - || !terrain.transitAllowed() - || !terrain.outletAllowed()) { - continue; - } - GridNode ocean = firstOceanNeighbor(grid, land); - if (ocean == null) { - continue; - } - HydrologyOceanBoundaryRefiner.Result boundary = refineOceanBoundary(land, ocean); - if (boundary == null - || !boundary.landwardTerrain().transitAllowed() - || !boundary.landwardTerrain().outletAllowed()) { - continue; - } - long stableId = HydrologyHash.mix(worldSeed, SEA_CAVE_SALT, land.id(), ocean.id()); - HydrologyPoint inner = seaCaveInnerPoint(land, ocean, boundary.landwardPoint(), stableId, depth); - int seaLevel = settingsSeaLevel(ocean.terrain()); - int coastHeight = seaCaveCoastHeight(boundary, inner, seaLevel); - sites.add(new SeaCaveSite(land, ocean, boundary, inner, coastHeight, stableId)); - } - sites.sort(Comparator.comparingInt(SeaCaveSite::coastHeight).reversed() - .thenComparingLong(SeaCaveSite::stableId)); - return sites; - } - - /** - * How high the coast stands over the sea across the chamber: the lowest land at the shoreline, at the - * back of the chamber and at both flanks of each. Flanks in the sea are ignored (the chamber opens - * there like its face); a back in the sea leaves no coast at all. - */ - private int seaCaveCoastHeight(HydrologyOceanBoundaryRefiner.Result boundary, HydrologyPoint inner, int seaLevel) { - HydrologyTerrainSample innerTerrain = sampleLandBasis(inner.x(), inner.z()); - if (innerTerrain == null) { - return 0; - } - HydrologyPoint landward = boundary.landwardPoint(); - int lowest = Math.min(boundary.landwardTerrain().naturalHeight(), innerTerrain.naturalHeight()); - int radius = settings.outlets().coastalGrotto().horizontalRadius(); - // Flanks lie along the shore, across the crossing from the landward point to the sea. - int spanX = boundary.oceanPoint().x() - landward.x(); - int spanZ = boundary.oceanPoint().z() - landward.z(); - double length = StrictMath.hypot(spanX, spanZ); - int flankX = (int) StrictMath.round(-spanZ / length * radius); - int flankZ = (int) StrictMath.round(spanX / length * radius); - int[][] flanks = { - {landward.x() + flankX, landward.z() + flankZ}, - {landward.x() - flankX, landward.z() - flankZ}, - {inner.x() + flankX, inner.z() + flankZ}, - {inner.x() - flankX, inner.z() - flankZ} - }; - for (int[] flank : flanks) { - HydrologyTerrainSample terrain = sampleLandBasis(flank[0], flank[1]); - if (terrain != null) { - lowest = Math.min(lowest, terrain.naturalHeight()); - } - } - return lowest - seaLevel; - } - - // The chamber runs inland along the coast normal, turned by a stable jitter so caves do not all - // face the same way along a straight shore. - private HydrologyPoint seaCaveInnerPoint( - GridNode land, - GridNode ocean, - HydrologyPoint landward, - long stableId, - int depth - ) { - double normalX = land.x() - ocean.x(); - double normalZ = land.z() - ocean.z(); - double length = StrictMath.hypot(normalX, normalZ); - double jitter = StrictMath.toRadians( - (HydrologyHash.unit(HydrologyHash.mix(stableId, 7)) * 2D - 1D) - * settings.seaCaves().sweepJitterDegrees() - ); - double cos = StrictMath.cos(jitter); - double sin = StrictMath.sin(jitter); - double unitX = normalX / length; - double unitZ = normalZ / length; - double inlandX = unitX * cos - unitZ * sin; - double inlandZ = unitX * sin + unitZ * cos; - return new HydrologyPoint( - (int) StrictMath.round(landward.x() + inlandX * depth), - landward.y(), - (int) StrictMath.round(landward.z() + inlandZ * depth) - ); - } - - private HydrologyCandidateRejection seaCaveAdmission( - SeaCaveSite site, - List accepted, - List courses - ) { - HydrologyPlannerSettings.SeaCaves seaCaves = settings.seaCaves(); - if (site.coastHeight() < seaCaves.minimumCoastHeight()) { - return HydrologyCandidateRejection.SURFACE_HEAD_RANGE; - } - HydrologyPoint landward = site.boundary().landwardPoint(); - long spacingSquared = (long) seaCaves.minimumSpacing() * seaCaves.minimumSpacing(); - for (SeaCaveSite other : accepted) { - if (landward.distanceSquared2D(other.boundary().landwardPoint()) < spacingSquared) { - return HydrologyCandidateRejection.SOURCE_SPACING; - } - } - long clearance = 2L * settings.outlets().coastalGrotto().horizontalRadius() + seaCaves.depth(); - long clearanceSquared = clearance * clearance; - for (RiverCourse course : courses) { - if (course.type() == RiverCourseType.SEA_CAVE) { - continue; - } - for (HydraulicSegment segment : course.segments()) { - if (segment.type() != HydrologyFeatureType.MOUTH - && segment.type() != HydrologyFeatureType.COASTAL_GROTTO - && segment.type() != HydrologyFeatureType.INLAND_GROTTO) { - continue; - } - for (HydrologyPoint point : segment.centerline()) { - if (landward.distanceSquared2D(point) < clearanceSquared) { - return HydrologyCandidateRejection.SOURCE_SPACING; - } - } - } - } - return null; - } - - private RiverCourse buildSeaCaveCourse(SeaCaveSite site) { - HydrologyPlannerSettings.Grotto grotto = settings.outlets().coastalGrotto(); - long courseId = HydrologyHash.mix(worldSeed, COURSE_SALT, SEA_CAVE_SALT, site.stableId()); - String profileKey = chooseProfile(site.boundary().landwardTerrain(), courseId); - int seaLevel = settingsSeaLevel(site.ocean().terrain()); - // The last point is the ocean connection: the footprint opens the chamber there and nowhere else. - List centerline = line( - withY(site.inner(), seaLevel), - withY(site.boundary().oceanPoint(), seaLevel), - settings.routing().refinementSpacing() - ); - ArrayList segments = new ArrayList<>(1); - addFlatSegment( - courseId, - HydrologyFeatureType.COASTAL_GROTTO, - seaLevel, - grotto.horizontalRadius() * 2, - grotto.verticalRadius(), - centerline, - segments - ); - return new RiverCourse( - courseId, - RiverCourseType.SEA_CAVE, - OptionalLong.empty(), - OptionalLong.empty(), - profileKey, - 1, - List.of(), - segments - ); - } - - private void addSeaCaveDiagnostic( - SeaCaveSite site, - HydrologyCandidateRejection rejection, - List diagnostics - ) { - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(site.stableId(), DIAGNOSTIC_SALT, rejection.ordinal()), - HydrologyCandidateKind.OUTLET, - HydrologyFeatureType.COASTAL_GROTTO, - site.boundary().landwardPoint(), - rejection, - 0 - )); - } - - /** - * The raster a swept grotto occupies: one ellipsoid plus its central cross-section extruded over the - * sweep. The containment filter measures the real carve; this only refuses chambers that cannot fit. - */ - static long sweptGrottoVolume(HydrologyPlannerSettings.Grotto grotto, int depth) { - int radius = grotto.horizontalRadius(); - long section = 0L; - for (int deltaX = -radius; deltaX <= radius; deltaX++) { - double normalized = Math.min(1D, Math.abs(deltaX) / Math.max(1D, radius)); - double scale = StrictMath.sqrt(Math.max(0D, 1D - normalized * normalized)); - section += (long) StrictMath.ceil(grotto.verticalRadius() * scale) - + (long) StrictMath.floor(grotto.headroom() * scale) - + 1L; - } - return HydrologyPlannerSettings.ellipsoidVolume(radius, grotto.verticalRadius(), grotto.headroom()) - + section * depth; - } - - private record SeaCaveSite( - GridNode land, - GridNode ocean, - HydrologyOceanBoundaryRefiner.Result boundary, - HydrologyPoint inner, - int coastHeight, - long stableId - ) { - } - - private void compileDeepFluidCourses( - HydrologyTileKey key, - List courses, - List diagnostics - ) { - for (HydrologyPlannerSettings.DeepFluid deepFluid : settings.deepFluids()) { - if (!deepFluid.enabled() || deepFluid.maximumPerTile() == 0) { - continue; - } - ArrayList sites = deepSites(key, deepFluid, diagnostics); - int target = Math.min( - deepFluid.maximumPerTile(), - expectedCount(deepFluid.density(), HydrologyHash.mix( - worldSeed, - DEEP_FLUID_SALT, - HydrologyHash.text(deepFluid.id()), - key.tileX(), - key.tileZ() - )) - ); - for (int index = 0; index < sites.size(); index++) { - DeepSite site = sites.get(index); - if (index >= target) { - addDeepDiagnostic( - deepFluid, - site, - HydrologyCandidateRejection.SOURCE_QUOTA, - diagnostics - ); - continue; - } - RiverCourse course = buildDeepFluidCourse(deepFluid, site, index); - if (course != null) { - courses.add(course); - } else { - addDeepDiagnostic( - deepFluid, - site, - HydrologyCandidateRejection.VOLUME_LIMIT, - diagnostics - ); - } - } - } - } - - private ArrayList deepSites( - HydrologyTileKey key, - HydrologyPlannerSettings.DeepFluid deepFluid, - List diagnostics - ) { - int tileSize = settings.routing().tileSize(); - int minimumX = key.minimumBlockX(tileSize); - int minimumZ = key.minimumBlockZ(tileSize); - int spacing = deepFluid.spacing(); - long profileSeed = HydrologyHash.mix(worldSeed, DEEP_FLUID_SALT, HydrologyHash.text(deepFluid.id())); - int xOffset = HydrologyHash.between( - HydrologyHash.mix(profileSeed, DEEP_FLUID_X_OFFSET_SALT), - 0, - spacing - 1 - ); - int zOffset = HydrologyHash.between( - HydrologyHash.mix(profileSeed, DEEP_FLUID_Z_OFFSET_SALT), - 0, - spacing - 1 - ); - long firstCellX = ceilDiv((long) minimumX - xOffset, spacing); - long firstCellZ = ceilDiv((long) minimumZ - zOffset, spacing); - long lastCellX = Math.floorDiv((long) minimumX + tileSize - 1L - xOffset, spacing); - long lastCellZ = Math.floorDiv((long) minimumZ + tileSize - 1L - zOffset, spacing); - ArrayList sites = new ArrayList<>(); - for (long cellZ = firstCellZ; cellZ <= lastCellZ; cellZ++) { - for (long cellX = firstCellX; cellX <= lastCellX; cellX++) { - long stable = HydrologyHash.mix( - worldSeed, - DEEP_FLUID_SALT, - HydrologyHash.text(deepFluid.id()), - cellX, - cellZ - ); - int x = Math.toIntExact(xOffset + cellX * spacing); - int z = Math.toIntExact(zOffset + cellZ * spacing); - int head = sampleGeometry( - HydrologyGeometrySampler.Field.DEEP_FLUID_HEIGHT, - deepFluid.id(), - x, - z, - stable, - deepFluid.minimumY(), - deepFluid.maximumY() - ); - DeepSite site = new DeepSite(x, z, head, stable); - HydrologyTerrainSample terrain = sampleLandBasis(x, z); - int verticalRadius = HydrologyHash.between( - HydrologyHash.mix(stable, 3), - deepFluid.minimumVerticalRadius(), - deepFluid.maximumVerticalRadius() - ); - if (!deepSiteFits(terrain, deepFluid, head, verticalRadius, minimumY)) { - if (terrain != null && !terrain.ocean()) { - addDeepDiagnostic( - deepFluid, - site, - HydrologyCandidateRejection.CAVE_CONTAINMENT, - diagnostics - ); - } - continue; - } - sites.add(site); - } - } - sites.sort(Comparator.comparingLong(DeepSite::stableId)); - return sites; - } - - private long ceilDiv(long value, int divisor) { - long quotient = Math.floorDiv(value, divisor); - return quotient * divisor == value ? quotient : quotient + 1L; - } - - static boolean deepSiteFits( - HydrologyTerrainSample terrain, - HydrologyPlannerSettings.DeepFluid deepFluid, - int head, - int verticalRadius, - int minimumY - ) { - if (terrain == null || terrain.ocean()) { - return false; - } - int lowerEnvelope = deepFluid.containedPools() - ? Math.max(deepFluid.channelDepth(), verticalRadius) - : deepFluid.channelDepth(); - return (long) head - lowerEnvelope > minimumY - && head + deepFluid.headroom() < terrain.naturalHeight(); - } - - private void addDeepDiagnostic( - HydrologyPlannerSettings.DeepFluid deepFluid, - DeepSite site, - HydrologyCandidateRejection rejection, - List diagnostics - ) { - diagnostics.add(new HydrologyDiagnosticCandidate( - HydrologyHash.mix(site.stableId(), DIAGNOSTIC_SALT, rejection.ordinal()), - HydrologyCandidateKind.DEEP_FLUID, - deepFluid.containedPools() ? HydrologyFeatureType.DEEP_POOL : HydrologyFeatureType.DEEP_CHANNEL, - new HydrologyPoint(site.x(), site.head(), site.z()), - rejection, 0 - )); - } - - private RiverCourse buildDeepFluidCourse( - HydrologyPlannerSettings.DeepFluid deepFluid, - DeepSite site, - int siteIndex - ) { - long courseId = HydrologyHash.mix( - worldSeed, - COURSE_SALT, - DEEP_FLUID_SALT, - HydrologyHash.text(deepFluid.id()), - site.stableId(), - siteIndex - ); - int horizontalRadius = HydrologyHash.between( - HydrologyHash.mix(site.stableId(), 2), - deepFluid.minimumHorizontalRadius(), - deepFluid.maximumHorizontalRadius() - ); - int verticalRadius = HydrologyHash.between( - HydrologyHash.mix(site.stableId(), 3), - deepFluid.minimumVerticalRadius(), - deepFluid.maximumVerticalRadius() - ); - ArrayList segments = new ArrayList<>(); - HydrologyPoint center = new HydrologyPoint(site.x(), site.head(), site.z()); - long usedVolume = 0L; - if (deepFluid.containedPools()) { - long poolVolume = HydrologyPlannerSettings.ellipsoidVolume( - horizontalRadius, - Math.max(deepFluid.channelDepth(), verticalRadius), - deepFluid.headroom() - ); - if (poolVolume > deepFluid.maximumVolume()) { - return null; - } - usedVolume = poolVolume; - long poolId = HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, HydrologyFeatureType.DEEP_POOL.ordinal()); - segments.add(new HydraulicSegment( - poolId, - courseId, - HydrologyFeatureType.DEEP_POOL, - site.head(), - site.head(), - horizontalRadius * 2 + 1, - Math.max(deepFluid.channelDepth(), verticalRadius), - false, - false, - List.of(center) - )); - } - if (deepFluid.shortChannels() && deepFluid.maximumChannelLength() > 0) { - int volumeBoundedMaximum = deepFluid.maximumChannelLength(); - while (volumeBoundedMaximum >= deepFluid.minimumChannelLength() - && usedVolume + deepChannelVolumeBound(deepFluid, volumeBoundedMaximum) - > deepFluid.maximumVolume()) { - volumeBoundedMaximum--; - } - if (volumeBoundedMaximum >= deepFluid.minimumChannelLength()) { - int length = HydrologyHash.between( - HydrologyHash.mix(site.stableId(), 4), - deepFluid.minimumChannelLength(), - volumeBoundedMaximum - ); - long channelId = HydrologyHash.mix(worldSeed, SEGMENT_SALT, courseId, HydrologyFeatureType.DEEP_CHANNEL.ordinal()); - segments.add(new HydraulicSegment( - channelId, - courseId, - HydrologyFeatureType.DEEP_CHANNEL, - site.head(), - site.head(), - deepFluid.channelWidth(), - deepFluid.channelDepth(), - false, - false, - organicDeepChannelCenterline( - center, - length, - settings.routing().refinementSpacing(), - site.stableId() - ) - )); - } - } - if (segments.isEmpty()) { - return null; - } - return new RiverCourse( - courseId, - RiverCourseType.DEEP_FLUID, - OptionalLong.empty(), - OptionalLong.empty(), - deepFluid.id(), - 1, - List.of(), - segments - ); - } - - private long deepChannelVolumeBound(HydrologyPlannerSettings.DeepFluid deepFluid, int length) { - int radius = Math.max(1, deepFluid.channelWidth() / 2); - int points = (int) StrictMath.ceil( - length * StrictMath.sqrt(2D) / settings.routing().refinementSpacing() - ) + 1; - long horizontalEnvelope = (long) (radius * 2 + 1) * (radius * 2 + 1); - long verticalEnvelope = deepFluid.channelDepth() + deepFluid.headroom() + 1L; - return horizontalEnvelope * verticalEnvelope * points; - } - - private List organicDeepChannelCenterline( - HydrologyPoint start, - int length, - int spacing, - long stableId - ) { - double heading = HydrologyHash.unit(HydrologyHash.mix(stableId, DEEP_CHANNEL_HEADING_SALT)) - * StrictMath.PI * 2D; - double forwardX = StrictMath.cos(heading); - double forwardZ = StrictMath.sin(heading); - double lateralX = -forwardZ; - double lateralZ = forwardX; - double bendEnvelope = Math.max(1.5D, Math.min(8D, length * 0.3D)); - double firstBend = signedOrganicOffset(stableId, DEEP_CHANNEL_FIRST_BEND_SALT, bendEnvelope); - double secondBend = signedOrganicOffset(stableId, DEEP_CHANNEL_SECOND_BEND_SALT, bendEnvelope); - if (StrictMath.signum(firstBend) == StrictMath.signum(secondBend)) { - secondBend = -secondBend; - } - - double endX = start.x() + forwardX * length; - double endZ = start.z() + forwardZ * length; - double firstControlX = start.x() + forwardX * length / 3D + lateralX * firstBend; - double firstControlZ = start.z() + forwardZ * length / 3D + lateralZ * firstBend; - double secondControlX = start.x() + forwardX * length * 2D / 3D + lateralX * secondBend; - double secondControlZ = start.z() + forwardZ * length * 2D / 3D + lateralZ * secondBend; - int steps = Math.max(4, (int) StrictMath.ceil(length / (double) Math.max(2, spacing)) * 2); - ArrayList points = new ArrayList<>(steps + 1); - for (int step = 0; step <= steps; step++) { - double progress = step / (double) steps; - double inverse = 1D - progress; - double x = inverse * inverse * inverse * start.x() - + 3D * inverse * inverse * progress * firstControlX - + 3D * inverse * progress * progress * secondControlX - + progress * progress * progress * endX; - double z = inverse * inverse * inverse * start.z() - + 3D * inverse * inverse * progress * firstControlZ - + 3D * inverse * progress * progress * secondControlZ - + progress * progress * progress * endZ; - HydrologyPoint point = new HydrologyPoint( - (int) StrictMath.round(x), - start.y(), - (int) StrictMath.round(z) - ); - if (points.isEmpty() || point.x() != points.getLast().x() || point.z() != points.getLast().z()) { - points.add(point); - } - } - return List.copyOf(points); - } - - private double signedOrganicOffset(long stableId, long salt, double envelope) { - double unit = HydrologyHash.unit(HydrologyHash.mix(stableId, salt)); - double magnitude = envelope * (0.55D + unit * 0.45D); - return (HydrologyHash.mix(stableId, salt, 1L) & 1L) == 0L ? magnitude : -magnitude; - } - - private List line(HydrologyPoint start, HydrologyPoint end, int spacing) { - double distance = StrictMath.hypot(end.x() - start.x(), end.z() - start.z()); - int steps = Math.max(1, (int) StrictMath.ceil(distance / spacing)); - ArrayList points = new ArrayList<>(steps + 1); - for (int step = 0; step <= steps; step++) { - double progress = step / (double) steps; - int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); - int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); - HydrologyPoint point = new HydrologyPoint(x, start.y(), z); - if (points.isEmpty() || point.x() != points.getLast().x() || point.z() != points.getLast().z()) { - points.add(point); - } - } - return List.copyOf(points); - } - - private int scaledDimension( - int styledBase, - int minimum, - int maximum, - int discharge, - double multiplier - ) { - double flowScale = Math.min( - 1D, - StrictMath.log(discharge + 1D) / StrictMath.log(settings.underground().wideningSources() + 1D) - ); - int base = styledBase + (int) StrictMath.round((maximum - styledBase) * flowScale); - return clamp((int) StrictMath.round(base * multiplier), minimum, maximum); - } - - private int maximumSurfaceDischarge(List edges) { - int maximum = 1; - for (DrainageEdge edge : edges) { - maximum = Math.max(maximum, edge.contributingSurfaceSources()); - } - return maximum; - } - - private int maximumUndergroundDischarge(List edges) { - int maximum = 1; - for (DrainageEdge edge : edges) { - maximum = Math.max(maximum, edge.contributingUndergroundSources()); - } - return maximum; - } - - private String chooseProfile(HydrologyTerrainSample terrain, long courseId) { - List profiles = terrain.preferredProfileKeys(); - int index = HydrologyHash.between(HydrologyHash.mix(worldSeed, courseId, HydrologyHash.text("profile")), 0, profiles.size() - 1); - return profiles.get(index); - } - - private int outletHead(RiverOutlet outlet) { - return outlet.directOcean() ? outlet.seaLevel() : outlet.connectionPoint().y(); - } - - private int settingsSeaLevel(HydrologyTerrainSample terrain) { + int settingsSeaLevel(HydrologyTerrainSample terrain) { return settings.seaLevel(); } - private static HydrologyPoint withY(HydrologyPoint point, int y) { + static HydrologyPoint withY(HydrologyPoint point, int y) { return new HydrologyPoint(point.x(), y, point.z()); } - private static int clamp(int value, int minimum, int maximum) { + static int clamp(int value, int minimum, int maximum) { return Math.max(minimum, Math.min(maximum, value)); } - private int sampleGeometry( + int sampleGeometry( HydrologyGeometrySampler.Field field, String profileKey, int x, @@ -7850,7 +510,7 @@ public final class HydrologyPlanner { return sampled; } - private HydrologyTerrainSample sampleBasis(int blockX, int blockZ) { + HydrologyTerrainSample sampleBasis(int blockX, int blockZ) { PlanningSamples samples = planningSamples.get(); if (samples == null) { return naturalSampler == null @@ -7869,12 +529,12 @@ public final class HydrologyPlanner { return sampled; } - private HydrologyTerrainSample sampleLandBasis(int blockX, int blockZ) { + HydrologyTerrainSample sampleLandBasis(int blockX, int blockZ) { HydrologyTerrainSample terrain = sampleBasis(blockX, blockZ); return terrain == null || terrain.ocean() ? null : terrain; } - private HydrologyTerrainSample sampleBasisWithoutSlope(int blockX, int blockZ) { + HydrologyTerrainSample sampleBasisWithoutSlope(int blockX, int blockZ) { if (naturalSampler == null) { return sampleBasis(blockX, blockZ); } @@ -7896,12 +556,12 @@ public final class HydrologyPlanner { return sampled; } - private HydrologyTerrainSample sampleLandBasisWithoutSlope(int blockX, int blockZ) { + HydrologyTerrainSample sampleLandBasisWithoutSlope(int blockX, int blockZ) { HydrologyTerrainSample terrain = sampleBasisWithoutSlope(blockX, blockZ); return terrain == null || terrain.ocean() ? null : terrain; } - private HydrologyTerrainSample sampleDetailed(int blockX, int blockZ) { + HydrologyTerrainSample sampleDetailed(int blockX, int blockZ) { PlanningSamples samples = planningSamples.get(); if (samples == null) { return sampler.sample(blockX, blockZ); @@ -7916,7 +576,7 @@ public final class HydrologyPlanner { return sampled; } - private HydrologyRoutingTerrainSampler.NaturalClassification classifyNatural(int blockX, int blockZ) { + HydrologyRoutingTerrainSampler.NaturalClassification classifyNatural(int blockX, int blockZ) { PlanningSamples samples = planningSamples.get(); if (samples == null) { return naturalSampler.classifyNatural(blockX, blockZ); @@ -7934,7 +594,7 @@ public final class HydrologyPlanner { return sampled; } - private static final class PointRoutingTerrainSampler implements HydrologyRoutingTerrainSampler { + static final class PointRoutingTerrainSampler implements HydrologyRoutingTerrainSampler { private final HydrologyTerrainSampler sampler; private PointRoutingTerrainSampler(HydrologyTerrainSampler sampler) { @@ -7968,21 +628,21 @@ public final class HydrologyPlanner { } } - private static final class PlanningSamples { + static final class PlanningSamples { private final Long2ObjectOpenHashMap basis; private final Long2ObjectOpenHashMap basisWithoutSlope; - private final Long2ObjectOpenHashMap detailed; + final Long2ObjectOpenHashMap detailed; private final Long2ObjectOpenHashMap classifications; private final HashMap geometry; - private final HashMap minimumLandHeights; - private final HashMap> radialOffsets; - private final HashMap undergroundSegmentCaps; - private final HashMap routeAnchors; - private final IdentityHashMap>> surfaceRoutes; - private final HydrologyCaveCourseFilter.CandidateCache caveCandidates; - private final HydrologyCaveContainmentPlanner.ValidationCache caveValidations; + final HashMap minimumLandHeights; + final HashMap> radialOffsets; + final HashMap undergroundSegmentCaps; + final HashMap routeAnchors; + final IdentityHashMap>> surfaceRoutes; + final HydrologyCaveCourseFilter.CandidateCache caveCandidates; + final HydrologyCaveContainmentPlanner.ValidationCache caveValidations; - private PlanningSamples() { + PlanningSamples() { this.basis = new Long2ObjectOpenHashMap<>(); this.basisWithoutSlope = new Long2ObjectOpenHashMap<>(); this.detailed = new Long2ObjectOpenHashMap<>(); @@ -7998,521 +658,7 @@ public final class HydrologyPlanner { } } - private record GridOffset(int x, int z) { - } - - private record MinimumLandHeightKey(int x, int z, int radius) { - } - - private record UndergroundSegmentCapKey( - long courseId, - String profileKey, - int startX, - int startZ, - int endX, - int endZ, - int radius, - int minimumHeadroom, - int maximumHeadroom - ) { - } - - private record RefinedEdgeKey( - long upstreamId, - long downstreamId, - int upstreamX, - int upstreamZ, - int downstreamX, - int downstreamZ, - int continuationX, - int continuationZ, - int transverseCandidates - ) { - } - - private record Direction(double x, double z) { - } - - private record SurfaceCurvePoint(double x, double z, double distance) { - } - - private record RoutePosition(double x, double z, double baseX, double baseZ, Direction tangent) { - } - - private record SurfaceRouteKey(List guide, long geometryId) { - } - - private record RouteCandidate( - HydrologyPoint point, - double offset, - double localScore, - double terrainScore, - Direction tangent, - boolean terrainResolved - ) { - } - - private record RouteTerrainEstimate(int height, double terrainScore) { - } - - private record CurvatureRouteSelection(RouteCandidate[] route, int[] indices) { - private static CurvatureRouteSelection empty() { - return new CurvatureRouteSelection(new RouteCandidate[0], new int[0]); - } - } - - private record TerrainTransitionKey(HydrologyPoint start, HydrologyPoint end) { - } - - private record GridNode( - int index, - int gridX, - int gridZ, - int x, - int z, - long id, - HydrologyTerrainSample terrain - ) { - HydrologyPoint naturalPoint() { - return new HydrologyPoint(x, terrain.naturalHeight(), z); - } - } - - private record SampledGrid( - int minimumX, - int minimumZ, - int ownerMinimumX, - int ownerMinimumZ, - int ownerSize, - int width, - int spacing, - List nodes - ) { - GridNode node(int index) { - return nodes.get(index); - } - - GridNode nodeAt(int gridX, int gridZ) { - if (gridX < 0 || gridZ < 0 || gridX >= width || gridZ >= width) { - return null; - } - return nodes.get(gridZ * width + gridX); - } - - GridNode nodeAtWorld(int x, int z) { - long deltaX = (long) x - minimumX; - long deltaZ = (long) z - minimumZ; - if (deltaX < 0L || deltaZ < 0L || deltaX % spacing != 0L || deltaZ % spacing != 0L) { - return null; - } - long gridX = deltaX / spacing; - long gridZ = deltaZ / spacing; - if (gridX >= width || gridZ >= width) { - return null; - } - return nodeAt((int) gridX, (int) gridZ); - } - - boolean owns(int x, int z) { - return x >= ownerMinimumX && x < ownerMinimumX + ownerSize - && z >= ownerMinimumZ && z < ownerMinimumZ + ownerSize; - } - } - - private record OutletCandidate(int landIndex, int oceanIndex, RiverOutlet outlet) { - } - - private record InlandConnection(HydrologyPoint point, HydrologyTerrainSample terrain) { - } - - private record RoutingQueueEntry( - int nodeIndex, - double potential, - int outletIndex - ) - implements Comparable { - @Override - public int compareTo(RoutingQueueEntry other) { - int potentialComparison = Double.compare(potential, other.potential); - if (potentialComparison != 0) { - return potentialComparison; - } - int nodeComparison = Integer.compare(nodeIndex, other.nodeIndex); - return nodeComparison != 0 ? nodeComparison : Integer.compare(outletIndex, other.outletIndex); - } - } - - private record RoutingPlan( - double[] potential, - int[] parent, - int[] outletIndex, - int[] routeLengths, - List outlets, - boolean organicSurfaceRequired - ) { - } - - private record SourceCandidate( - int nodeIndex, - long stableId, - double score, - boolean required - ) { - } - - private static final class SourceSelection { - private final boolean surface; - private final List candidates; - private final SourceAdmissionSelection admission; - private final int guaranteedMinimum; - private final int maximumOptionalRejections; - private final int targetCount; - private final ArrayList selectedCandidateIndices; - private final boolean[] selectedCandidates; - private final boolean[] attemptedCandidates; - private int rejectedOptionalCandidates; - - private SourceSelection( - boolean surface, - List candidates, - SourceAdmissionSelection admission, - int guaranteedMinimum, - int maximumOptionalRejections - ) { - if (guaranteedMinimum < 0 || guaranteedMinimum > admission.selectedCandidateIndices().size()) { - throw new IllegalArgumentException("Guaranteed source minimum is outside the admission bounds."); - } - if (maximumOptionalRejections < 0) { - throw new IllegalArgumentException("Maximum optional source rejections cannot be negative."); - } - this.surface = surface; - this.candidates = List.copyOf(candidates); - this.admission = admission; - this.guaranteedMinimum = guaranteedMinimum; - this.maximumOptionalRejections = maximumOptionalRejections; - this.selectedCandidateIndices = new ArrayList<>(admission.selectedCandidateIndices()); - this.targetCount = admission.targetCount(); - this.selectedCandidates = new boolean[candidates.size()]; - this.attemptedCandidates = new boolean[candidates.size()]; - for (int candidateIndex : selectedCandidateIndices) { - selectedCandidates[candidateIndex] = true; - } - } - - private static SourceSelection empty(boolean surface) { - return new SourceSelection( - surface, - List.of(), - new SourceAdmissionSelection( - 0, - List.of(), - new boolean[0], - new boolean[0], - new boolean[0], - (int candidateIndex) -> false, - new int[0], - Integer.MAX_VALUE - ), - 0, - 0 - ); - } - - private List selectedNodeIndices() { - ArrayList selectedNodes = new ArrayList<>(selectedCandidateIndices.size()); - for (int candidateIndex : selectedCandidateIndices) { - selectedNodes.add(candidates.get(candidateIndex).nodeIndex()); - } - return List.copyOf(selectedNodes); - } - - private int candidateCount() { - return candidates.size(); - } - - private boolean needsSurfaceFallback() { - return surface && targetCount > 0 && selectedCandidateIndices.isEmpty(); - } - - private boolean hasAcceptedSelection() { - return !selectedCandidateIndices.isEmpty(); - } - - private boolean advanceAfterPublication(List acceptedCourses, SampledGrid grid) { - Set acceptedSourceNodeIds = acceptedSourceNodeIds(acceptedCourses); - int acceptedRequired = 0; - boolean changed = false; - int selectedPosition = 0; - while (selectedPosition < selectedCandidateIndices.size()) { - int candidateIndex = selectedCandidateIndices.get(selectedPosition); - SourceCandidate candidate = candidates.get(candidateIndex); - long sourceNodeId = grid.node(candidate.nodeIndex()).id(); - if (acceptedSourceNodeIds.contains(sourceNodeId)) { - if (candidate.required()) { - attemptedCandidates[candidateIndex] = true; - acceptedRequired++; - } - selectedPosition++; - continue; - } - attemptedCandidates[candidateIndex] = true; - if (!candidate.required()) { - rejectedOptionalCandidates++; - } - selectedCandidateIndices.remove(selectedPosition); - selectedCandidates[candidateIndex] = false; - changed = true; - } - int requiredVacancies = Math.max(0, guaranteedMinimum - acceptedRequired); - for (int vacancy = 0; vacancy < requiredVacancies; vacancy++) { - int replacement = nextRequiredCandidate(); - if (replacement < 0) { - break; - } - selectedCandidateIndices.add(replacement); - selectedCandidates[replacement] = true; - changed = true; - } - while (selectedCandidateIndices.size() < targetCount) { - int replacement = nextAdmittedCandidate(); - if (replacement < 0) { - break; - } - selectedCandidateIndices.add(replacement); - selectedCandidates[replacement] = true; - changed = true; - } - return changed; - } - - private Set acceptedSourceNodeIds(List acceptedCourses) { - RiverCourseType expectedType = surface ? RiverCourseType.SURFACE : RiverCourseType.UNDERGROUND; - HashSet accepted = new HashSet<>(); - for (RiverCourse course : acceptedCourses) { - if (course.type() == expectedType && course.sourceNodeId().isPresent()) { - accepted.add(course.sourceNodeId().getAsLong()); - } - } - return accepted; - } - - private int nextRequiredCandidate() { - for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { - SourceCandidate candidate = candidates.get(candidateIndex); - if (candidate.required() - && !selectedCandidates[candidateIndex] - && !attemptedCandidates[candidateIndex] - && admission.outletQuotaAvailable(candidateIndex, selectedCandidateIndices)) { - return candidateIndex; - } - } - return -1; - } - - private int nextAdmittedCandidate() { - if (rejectedOptionalCandidates >= maximumOptionalRejections) { - return -1; - } - for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { - if (!selectedCandidates[candidateIndex] - && !attemptedCandidates[candidateIndex] - && admission.outletQuotaAvailable(candidateIndex, selectedCandidateIndices) - && admission.admitted(candidateIndex)) { - return candidateIndex; - } - } - return -1; - } - - private void addFinalAdmissionDiagnostics( - SampledGrid grid, - List diagnostics - ) { - for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { - if (selectedCandidates[candidateIndex] || attemptedCandidates[candidateIndex]) { - continue; - } - SourceCandidate candidate = candidates.get(candidateIndex); - addSourceDiagnostic( - grid.node(candidate.nodeIndex()), - surface, - candidate.stableId(), - admission.rejectedBySpacing(candidateIndex) - ? HydrologyCandidateRejection.SOURCE_SPACING - : HydrologyCandidateRejection.SOURCE_QUOTA, - diagnostics - ); - } - } - } - - static final class SourceAdmissionSelection { - private final int targetCount; - private final List selectedCandidateIndices; - private final boolean[] selectedCandidates; - private final boolean[] spacingRejectedCandidates; - private final boolean[] evaluatedCandidates; - private final IntPredicate globallyAdmitted; - private final int[] outletIndices; - private final int maximumCoursesPerOutlet; - - private SourceAdmissionSelection( - int targetCount, - List selectedCandidateIndices, - boolean[] selectedCandidates, - boolean[] spacingRejectedCandidates, - boolean[] evaluatedCandidates, - IntPredicate globallyAdmitted, - int[] outletIndices, - int maximumCoursesPerOutlet - ) { - if (outletIndices.length != selectedCandidates.length || maximumCoursesPerOutlet < 1) { - throw new IllegalArgumentException("Source outlet admission bounds are invalid."); - } - this.targetCount = targetCount; - this.selectedCandidateIndices = List.copyOf(selectedCandidateIndices); - this.selectedCandidates = selectedCandidates; - this.spacingRejectedCandidates = spacingRejectedCandidates; - this.evaluatedCandidates = evaluatedCandidates; - this.globallyAdmitted = globallyAdmitted; - this.outletIndices = outletIndices; - this.maximumCoursesPerOutlet = maximumCoursesPerOutlet; - } - - List selectedCandidateIndices() { - return selectedCandidateIndices; - } - - int targetCount() { - return targetCount; - } - - boolean selected(int candidateIndex) { - return selectedCandidates[candidateIndex]; - } - - boolean rejectedBySpacing(int candidateIndex) { - return spacingRejectedCandidates[candidateIndex]; - } - - boolean admitted(int candidateIndex) { - if (!evaluatedCandidates[candidateIndex]) { - evaluatedCandidates[candidateIndex] = true; - spacingRejectedCandidates[candidateIndex] = !globallyAdmitted.test(candidateIndex); - } - return !spacingRejectedCandidates[candidateIndex]; - } - - boolean outletQuotaAvailable(int candidateIndex, List selectedIndices) { - int outletIndex = outletIndices[candidateIndex]; - int selectedForOutlet = 0; - for (int selectedIndex : selectedIndices) { - if (outletIndices[selectedIndex] == outletIndex) { - selectedForOutlet++; - } - } - return selectedForOutlet < maximumCoursesPerOutlet; - } - } - - private record SourcePriority( - boolean required, - double weight, - int naturalHeight, - long stableId, - int x, - int z - ) { - } - - private record RoutingContextLoad(Thread owner, CompletableFuture future) { - } - - private record SourceRoutingContext( - SampledGrid grid, - RoutingPlan surfaceRouting, - RoutingPlan undergroundRouting, - List diagnostics - ) { - private RoutingPlan routing(boolean surface) { - return surface ? surfaceRouting : undergroundRouting; - } - } - - private record SourceCompilationKey( - boolean surface, - RoutingPlan routing, - List sources - ) { - private SourceCompilationKey { - Objects.requireNonNull(routing, "routing"); - sources = List.copyOf(sources); - } - } - - private record SourceCompilation( - CompiledGraph graph, - List courses, - List diagnostics - ) { - } - - private record CompiledGraph( - List nodes, - List edges, - List outlets, - Map edgeByUpstream - ) { - } - - private record PublicationAttempt( - HydrologyCaveCourseFilter.Result result, - List diagnostics - ) { - } - - private record CrossTilePublicationAdmission( - HydrologyCaveCourseFilter.Result result, - List diagnostics, - boolean rejectedCourses - ) { - private CrossTilePublicationAdmission { - Objects.requireNonNull(result, "result"); - diagnostics = List.copyOf(Objects.requireNonNull(diagnostics, "diagnostics")); - } - } - - private record HydrologyOwnerDraft( - HydrologyTileKey key, - HydrologyCaveCourseFilter.Result result, - List diagnostics, - HydrologyFootprintCompiler footprintCompiler - ) { - private HydrologyOwnerDraft withoutFootprintCompiler() { - if (footprintCompiler == null) { - return this; - } - return new HydrologyOwnerDraft(key, result, diagnostics, null); - } - } - - private record MaterializedHydrology( - HydrologyCaveCourseFilter.Result result, - RiverFootprint footprint - ) { - private MaterializedHydrology { - Objects.requireNonNull(result); - Objects.requireNonNull(footprint); - } - } - - private interface CrossTileDraftAdmission { - void prepare(); - - CrossTilePublicationAdmission admit(HydrologyCaveCourseFilter.Result result); - } - - private final class ColorRankedDraftAdmission implements CrossTileDraftAdmission, AutoCloseable { + final class ColorRankedDraftAdmission implements CrossTileDraftAdmission, AutoCloseable { private final HydrologyTileKey ownerKey; private final int ownerRank; private final CrossTileResolutionContext context; @@ -8536,7 +682,7 @@ public final class HydrologyPlanner { @Override public void prepare() { - if (ownerRank == 0 || settings.crossTileColorPeriod() != 2 || !hasRoutedSourceSearch() + if (ownerRank == 0 || settings.crossTileColorPeriod() != 2 || !sourcePlanner.hasRoutedSourceSearch() || !(Thread.currentThread() instanceof ForkJoinWorkerThread worker)) { return; } @@ -8549,14 +695,14 @@ public final class HydrologyPlanner { continue; } HydrologyTileKey key = new HydrologyTileKey((int) tileX, (int) tileZ); - if (ownerColorRank(key) >= ownerRank || preparedOwners.containsKey(key) + if (crossTile.ownerColorRank(key) >= ownerRank || preparedOwners.containsKey(key) || resolvedOwners.getIfPresent(key) != null || resolvingOwners.containsKey(key)) { continue; } candidates.add(key); } } - candidates.sort(Comparator.comparingInt(HydrologyPlanner.this::ownerColorRank).reversed() + candidates.sort(Comparator.comparingInt(crossTile::ownerColorRank).reversed() .thenComparing(HydrologyTileKey::compareTo)); for (HydrologyTileKey key : candidates) { if (resolvedOwners.getIfPresent(key) != null || resolvingOwners.containsKey(key)) { @@ -8612,8 +758,8 @@ public final class HydrologyPlanner { result, rejectedCourseIds ); - demandedOwners.addAll(conflictOwnerKeys(ownerKey, current)); - CrossTileBlockers blockers = lowerRankBlockers( + demandedOwners.addAll(crossTile.conflictOwnerKeys(ownerKey, current)); + CrossTileBlockers blockers = crossTile.lowerRankBlockers( ownerKey, current, ownerRank, @@ -8622,11 +768,11 @@ public final class HydrologyPlanner { ); HydrologyCrossTileSurfaceAdmission.Result surfaceAdmission = HydrologyCrossTileSurfaceAdmission.admit( - surfaceClaims(current), + crossTile.surfaceClaims(current), blockers.surfaceClaims(), settings.surface().sources().minimumSpacing() ); - Map currentCourses = coursesById(current.courses()); + Map currentCourses = crossTile.coursesById(current.courses()); HashSet rejectedSurfaceOutlets = new HashSet<>(); HashMap surfaceWinners = new HashMap<>(); for (HydrologyCrossTileSurfaceAdmission.Rejection rejection : surfaceAdmission.rejections()) { @@ -8654,13 +800,13 @@ public final class HydrologyPlanner { ); HydrologyCrossTileCaveAdmission.Result caveAdmission = HydrologyCrossTileCaveAdmission.admit( ownerRank, - caveClaims(surfaceAccepted), + crossTile.caveClaims(surfaceAccepted), blockers.caveClaims() ); if (newRejectedCourseIds.isEmpty() && caveAdmission.rejections().isEmpty()) { return new CrossTilePublicationAdmission(current, List.of(), false); } - Map surfaceAcceptedCourses = coursesById(surfaceAccepted.courses()); + Map surfaceAcceptedCourses = crossTile.coursesById(surfaceAccepted.courses()); for (HydrologyCrossTileCaveAdmission.Rejection rejection : caveAdmission.rejections()) { HydrologyCrossTileCaveAdmission.Claim claim = rejection.loser(); RiverCourse course = surfaceAcceptedCourses.get(claim.courseId()); @@ -8695,7 +841,7 @@ public final class HydrologyPlanner { new CrossTileRejectedCourse(course, winnerCourseId) ); diagnostics.add(course.type() == RiverCourseType.SURFACE - ? surfaceConflictDiagnostic(course, winnerCourseId) + ? crossTile.surfaceConflictDiagnostic(course, winnerCourseId) : HydrologyCaveCourseFilter.overlapDiagnostic(course, winnerCourseId)); } @@ -8704,255 +850,8 @@ public final class HydrologyPlanner { } } - private HydrologyDiagnosticCandidate surfaceConflictDiagnostic( - RiverCourse course, - long winnerCourseId - ) { - HydraulicSegment representative = course.segments().getFirst(); - return new HydrologyDiagnosticCandidate( - HydrologyHash.mix(course.id(), DIAGNOSTIC_SALT, winnerCourseId), - HydrologyCandidateKind.SOURCE, - HydrologyFeatureType.SURFACE_POOL, - representative.start(), - HydrologyCandidateRejection.SOURCE_SPACING, 0 - ); - } - - private enum DraftPhase { - CONTEXT, - SELECT, - SETTLE, - PUBLISH - } - - /** - * Wall-clock breakdown of one owner draft for the debug log: sampling and routing context, source - * selection, settling, publication passes, and the time spent waiting on lower-rank neighbour drafts. - */ - private static final class DraftProfile { - private final long[] phaseNanos = new long[DraftPhase.values().length]; - private long dependencyNanos; - private int dependencies; - private int admissions; - private int earlyOwners; - private int routeCalls; - private int routeSolves; - private long routeSolveNanos; - private int rasterCalls; - private long rasterNanos; - private int filterCalls; - private long filterNanos; - - private long record(DraftPhase phase, long started) { - long now = System.nanoTime(); - phaseNanos[phase.ordinal()] += now - started; - return now; - } - - private void recordDependencies(int count, long started) { - dependencyNanos += System.nanoTime() - started; - dependencies += count; - admissions++; - } - - private void log(HydrologyTileKey key, int rank, long totalNanos) { - IrisLogging.debug( - "Hydrology owner %d,%d rank=%d drafted in %dms: context=%dms select=%dms settle=%dms publish=%dms deps=%d wait=%dms admissions=%d earlyOwners=%d routes=%d reuses=%d routeSolve=%dms rasters=%d raster=%dms filters=%d filter=%dms on %s", - key.tileX(), - key.tileZ(), - rank, - totalNanos / 1_000_000L, - phaseNanos[DraftPhase.CONTEXT.ordinal()] / 1_000_000L, - phaseNanos[DraftPhase.SELECT.ordinal()] / 1_000_000L, - phaseNanos[DraftPhase.SETTLE.ordinal()] / 1_000_000L, - phaseNanos[DraftPhase.PUBLISH.ordinal()] / 1_000_000L, - dependencies, - dependencyNanos / 1_000_000L, - admissions, - earlyOwners, - routeCalls, - routeCalls - routeSolves, - routeSolveNanos / 1_000_000L, - rasterCalls, - rasterNanos / 1_000_000L, - filterCalls, - filterNanos / 1_000_000L, - Thread.currentThread().getName() - ); - } - } - - private DraftProfile currentDraftProfile() { + DraftProfile currentDraftProfile() { DraftProfile profile = draftProfiles.get(); return profile == null ? new DraftProfile() : profile; } - - private static final class CrossTileResolutionContext { - private final Map resolved; - private final Set resolving; - private final HydrologyTileKey root; - private final long maximumTileOffset; - private final int maximumOwners; - private int iterations; - - private CrossTileResolutionContext( - HydrologyTileKey root, - long maximumTileOffset, - int maximumOwners - ) { - this.resolved = new HashMap<>(); - this.resolving = new HashSet<>(); - this.root = Objects.requireNonNull(root, "root"); - this.maximumTileOffset = maximumTileOffset; - this.maximumOwners = maximumOwners; - } - - private CrossTileResolvedOwner resolved(HydrologyTileKey key) { - return resolved.get(key); - } - - private void remember(HydrologyTileKey key, CrossTileResolvedOwner owner) { - long offsetX = Math.abs((long) key.tileX() - root.tileX()); - long offsetZ = Math.abs((long) key.tileZ() - root.tileZ()); - if (offsetX > maximumTileOffset || offsetZ > maximumTileOffset) { - throw new IllegalStateException("Cross-tile owner dependency exceeded its color-ranked geometry bound."); - } - CrossTileResolvedOwner existing = resolved.putIfAbsent(key, owner); - if (existing != null - && !existing.withoutFootprintCompiler().equals(owner.withoutFootprintCompiler())) { - throw new IllegalStateException("Cross-tile owner resolution produced inconsistent cached results."); - } - if (resolved.size() > maximumOwners) { - throw new IllegalStateException("Cross-tile owner dependencies exceeded their color-ranked count bound."); - } - } - - private boolean begin(HydrologyTileKey key) { - return resolving.add(key); - } - - private void end(HydrologyTileKey key) { - resolving.remove(key); - } - - private void recordIteration() { - iterations++; - } - - private int iterations() { - return iterations; - } - - private int ownerCount() { - return resolved.size(); - } - - private HydrologyTileKey root() { - return root; - } - } - - private record CrossTileResolvedOwner( - HydrologyOwnerDraft draft, - List observedRejections - ) { - private CrossTileResolvedOwner { - Objects.requireNonNull(draft, "draft"); - observedRejections = List.copyOf(Objects.requireNonNull(observedRejections, "observedRejections")); - } - - private CrossTileResolvedOwner withoutFootprintCompiler() { - HydrologyOwnerDraft uncachedDraft = draft.withoutFootprintCompiler(); - return uncachedDraft == draft - ? this - : new CrossTileResolvedOwner(uncachedDraft, observedRejections); - } - } - - private record CrossTileRejectionKey(long courseId, long winnerCourseId) { - } - - private record CrossTileBlockers( - List caveClaims, - List surfaceClaims - ) { - private CrossTileBlockers { - caveClaims = List.copyOf(Objects.requireNonNull(caveClaims, "caveClaims")); - surfaceClaims = List.copyOf(Objects.requireNonNull(surfaceClaims, "surfaceClaims")); - } - } - - private record CrossTileRejectedCourse(RiverCourse course, long winnerSourceId) { - private CrossTileRejectedCourse { - Objects.requireNonNull(course, "course"); - } - } - - private record CrossTileResolution( - HydrologyOwnerDraft draft, - List observedRejections, - int iterations, - int ownerCount, - long resolutionNanos - ) { - private CrossTileResolution { - Objects.requireNonNull(draft, "draft"); - observedRejections = List.copyOf(Objects.requireNonNull(observedRejections, "observedRejections")); - } - } - - /** - * A routed source-to-outlet path, or, when {@code junction} is set, the cut prefix of one that ends - * on the stem it joins: the path then owns only the drainage edges upstream of the junction. - */ - private record CoursePath( - List points, - List pairEdges, - List edges, - RiverOutlet outlet, - boolean reachesOutlet, - boolean organicSurfaceRequired, - HydrologyPoint junction - ) { - } - - private record SurfaceCourseDraft( - GridNode source, - long courseId, - String profileKey, - CoursePath path - ) { - } - - private record SurfaceCourseBuild( - RiverCourse course, - HydrologyCandidateRejection rejection, - int rejectionDetail - ) { - private SurfaceCourseBuild { - if ((course == null) == (rejection == null)) { - throw new IllegalArgumentException("Surface course builds require exactly one result."); - } - } - - private static SurfaceCourseBuild accepted(RiverCourse course) { - return new SurfaceCourseBuild(Objects.requireNonNull(course, "course"), null, 0); - } - - private static SurfaceCourseBuild rejected(HydrologyCandidateRejection rejection, int detail) { - return new SurfaceCourseBuild(null, Objects.requireNonNull(rejection, "rejection"), detail); - } - } - - private record OutletCourseKey(long outletId) { - } - - private record CourseEdgeKey(RiverCourseType type, long edgeId) { - private CourseEdgeKey { - Objects.requireNonNull(type, "type"); - } - } - - private record DeepSite(int x, int z, int head, long stableId) { - } } diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRouteGeometry.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRouteGeometry.java new file mode 100644 index 000000000..71b75b944 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRouteGeometry.java @@ -0,0 +1,1112 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Set; + +final class HydrologyRouteGeometry { + private final HydrologyPlanner planner; + + HydrologyRouteGeometry(HydrologyPlanner planner) { + this.planner = planner; + } + + static final double CROSS_DROP_WEIGHT = 3D; + static final long ROUTE_ANCHOR_X_SALT = 0x52414e434858L; + static final long ROUTE_ANCHOR_Z_SALT = 0x52414e43485aL; + static final long ROUTE_WORM_PRIMARY_SALT = 0x52575052494dL; + static final long ROUTE_WORM_DETAIL_SALT = 0x525744455441L; + static final double ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO = 0.32D; + static final double ROUTE_TANGENT_SCALE = 0.68D; + static final int ROUTE_TRANSVERSE_CANDIDATES = 2; + static final int ROUTE_FALLBACK_TRANSVERSE_CANDIDATES = 4; + static final int SURFACE_COURSE_TRANSVERSE_CANDIDATES = 2; + static final double SURFACE_COURSE_MAXIMUM_TURN_DEGREES = 50D; + static final double SURFACE_COURSE_TURN_COST = 2.5D; + static final int SURFACE_MINIMUM_NATURAL_BANK_RISE = 1; + static final int MAXIMUM_SURFACE_BORE_STEP = 4; + + HydrologyPoint edgeContinuation( + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + HydrologyGridNode downstream, + RiverOutlet outlet + ) { + int continuationIndex = routing.parent()[downstream.index()]; + if (continuationIndex >= 0) { + return routeAnchor(grid.node(continuationIndex)); + } + HydrologyPoint landward = outlet.landwardPoint(); + if (landward.x() != downstream.x() || landward.z() != downstream.z()) { + return landward; + } + return outlet.connectionPoint(); + } + + HydrologyPoint routeAnchor(HydrologyGridNode node) { + HydrologyPlanner.PlanningSamples samples = planner.planningSamples.get(); + if (samples != null) { + HydrologyPoint cached = samples.routeAnchors.get(node.id()); + if (cached != null) { + return cached; + } + } + int spacing = planner.settings.routing().sampleSpacing(); + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + double maximumOffsetRatio = Math.min( + ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO, + meanders.maximumOffsetRatio() * 0.625D + ); + if (maximumOffsetRatio <= 0D) { + return node.naturalPoint(); + } + double primaryWavelength = meanders.primaryWavelength() * 5D; + double detailWavelength = meanders.detailWavelength() * 8D; + double primaryX = planner.routeAnchorX.noiseSigned( + node.x() / primaryWavelength, + node.z() / primaryWavelength + ); + double primaryZ = planner.routeAnchorZ.noiseSigned( + node.x() / primaryWavelength, + node.z() / primaryWavelength + ); + double detailX = planner.routeAnchorX.noiseSigned( + node.x() / detailWavelength + 31.75D, + node.z() / detailWavelength - 19.25D + ); + double detailZ = planner.routeAnchorZ.noiseSigned( + node.x() / detailWavelength - 27.5D, + node.z() / detailWavelength + 43.5D + ); + double vectorX = primaryX * 0.72D + detailX * 0.28D; + double vectorZ = primaryZ * 0.72D + detailZ * 0.28D; + double vectorLength = StrictMath.hypot(vectorX, vectorZ); + if (vectorLength < 0.1D) { + double angle = HydrologyHash.unit(HydrologyHash.mix(planner.worldSeed, node.id(), ROUTE_ANCHOR_X_SALT)) + * StrictMath.PI * 2D; + vectorX = StrictMath.cos(angle); + vectorZ = StrictMath.sin(angle); + vectorLength = 1D; + } + double maximumOffset = spacing * maximumOffsetRatio; + double displacement = maximumOffset * (0.62D + Math.min(1D, vectorLength) * 0.38D); + int desiredX = (int) StrictMath.round(node.x() + vectorX / vectorLength * displacement); + int desiredZ = (int) StrictMath.round(node.z() + vectorZ / vectorLength * displacement); + int searchRadius = Math.max(planner.settings.routing().refinementSpacing(), spacing / 5); + int innerRadius = Math.max(1, searchRadius / 2); + int[][] offsets = { + {0, 0}, + {innerRadius, 0}, {-innerRadius, 0}, {0, innerRadius}, {0, -innerRadius}, + {innerRadius, innerRadius}, {innerRadius, -innerRadius}, + {-innerRadius, innerRadius}, {-innerRadius, -innerRadius}, + {searchRadius, 0}, {-searchRadius, 0}, {0, searchRadius}, {0, -searchRadius}, + {node.x() - desiredX, node.z() - desiredZ} + }; + HydrologyPoint selected = node.naturalPoint(); + double selectedScore = anchorScore( + node, + selected.x(), + selected.z(), + desiredX, + desiredZ, + maximumOffsetRatio + ); + for (int[] offset : offsets) { + int x = desiredX + offset[0]; + int z = desiredZ + offset[1]; + double score = anchorScore(node, x, z, desiredX, desiredZ, maximumOffsetRatio); + if (score < selectedScore) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(x, z); + selected = new HydrologyPoint(x, terrain.naturalHeight(), z); + selectedScore = score; + } + } + if (samples != null) { + samples.routeAnchors.put(node.id(), selected); + } + return selected; + } + + double anchorScore( + HydrologyGridNode node, + int x, + int z, + int desiredX, + int desiredZ, + double maximumOffsetRatio + ) { + double distanceFromNode = StrictMath.hypot(x - node.x(), z - node.z()); + if (distanceFromNode > planner.settings.routing().sampleSpacing() * maximumOffsetRatio) { + return Double.POSITIVE_INFINITY; + } + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(x, z); + if (terrain == null || !terrain.transitAllowed() || !withinConfines(terrain, node.terrain().confinesKey())) { + return Double.POSITIVE_INFINITY; + } + if (!planner.routePaths.traversableHop(node.naturalPoint(), new HydrologyPoint(x, terrain.naturalHeight(), z))) { + return Double.POSITIVE_INFINITY; + } + terrain = planner.sampleLandBasis(x, z); + double distanceFromDesired = StrictMath.hypot(x - desiredX, z - desiredZ); + double score = terrain.naturalHeight() * planner.settings.routing().valleyPreference() + + terrain.slope() * planner.settings.routing().slopePenalty() + + terrain.routingCost() * terrain.routingMultiplier() + + distanceFromDesired * 2.4D + + distanceFromNode * 0.08D; + long tie = HydrologyHash.mix(planner.worldSeed, node.id(), x, z); + return score + HydrologyHash.unit(tie) * 1.0E-6D; + } + + List refineEdge( + long upstreamId, + long downstreamId, + HydrologyPoint upstream, + HydrologyPoint downstream, + HydrologyPoint continuation, + int transverseCandidates + ) { + int refinement = planner.settings.routing().refinementSpacing(); + int effectiveTransverseCandidates = transverseCandidates; + double deltaX = downstream.x() - upstream.x(); + double deltaZ = downstream.z() - upstream.z(); + double distance = StrictMath.hypot(deltaX, deltaZ); + int steps = Math.max(1, (int) StrictMath.ceil(distance / refinement)); + RouteDirection directTangent = planner.routePaths.direction(upstream.x(), upstream.z(), downstream.x(), downstream.z()); + RouteDirection startTangent = directTangent; + RouteDirection endTangent = planner.routePaths.direction(downstream.x(), downstream.z(), continuation.x(), continuation.z()); + if (endTangent.x() == 0D && endTangent.z() == 0D) { + endTangent = startTangent; + } + HydrologyTerrainSample upstreamTerrain = planner.sampleLandBasis(upstream.x(), upstream.z()); + HydrologyTerrainSample downstreamTerrain = planner.sampleLandBasis(downstream.x(), downstream.z()); + int transitionThreshold = planner.settings.hydraulics().waterfallMinimumDrop(); + boolean elevationTransition = Math.abs(upstream.y() - downstream.y()) >= transitionThreshold + || upstreamTerrain != null && upstreamTerrain.slope() >= transitionThreshold + || downstreamTerrain != null && downstreamTerrain.slope() >= transitionThreshold; + if (elevationTransition) { + endTangent = directTangent; + } + double wormBlend = elevationTransition ? 0D : routeWormBlend(); + double tangentMagnitude = distance * (ROUTE_TANGENT_SCALE + wormBlend * 0.42D); + if (wormBlend > 0D) { + startTangent = routeWormDirection(upstream, startTangent, wormBlend); + endTangent = routeWormDirection(downstream, endTangent, wormBlend); + } + ArrayList> layers = new ArrayList<>(steps + 1); + for (int step = 0; step <= steps; step++) { + if (step == 0) { + layers.add(List.of(routeEndpoint(upstream, startTangent))); + continue; + } + if (step == steps) { + layers.add(List.of(routeEndpoint(downstream, endTangent))); + continue; + } + double progress = step / (double) steps; + RoutePosition nominal = routePosition( + upstream, + downstream, + startTangent, + endTangent, + tangentMagnitude, + distance, + progress, + elevationTransition ? 0D : 1D + ); + List candidates = routeCandidates( + upstreamId, + downstreamId, + nominal, + progress, + refinement, + elevationTransition ? 0 : effectiveTransverseCandidates, + upstreamTerrain == null ? null : upstreamTerrain.confinesKey() + ); + if (candidates.isEmpty()) { + return List.of(); + } + layers.add(candidates); + } + return solveTerrainRoute(layers, distance / steps); + } + + double routeWormBlend() { + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + double strength = meanders.primaryStrength() + meanders.detailStrength() * 0.35D; + if (strength <= 0D || meanders.maximumOffsetRatio() <= 0D) { + return 0D; + } + return Math.min(0.18D, meanders.maximumOffsetRatio() * (0.08D + strength * 0.05D)); + } + + RouteDirection routeWormDirection(HydrologyPoint point, RouteDirection fallback, double blend) { + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + double wavelength = Math.max( + planner.settings.routing().sampleSpacing() * 2D, + meanders.primaryWavelength() * 2.5D + ); + double fieldX = planner.routeWormPrimary.noiseSigned(point.x() / wavelength, point.z() / wavelength); + double fieldZ = planner.routeWormDetail.noiseSigned( + point.x() / wavelength + 37.25D, + point.z() / wavelength - 21.75D + ); + double fieldLength = StrictMath.hypot(fieldX, fieldZ); + if (fieldLength < 0.05D) { + return fallback; + } + fieldX /= fieldLength; + fieldZ /= fieldLength; + if (fieldX * fallback.x() + fieldZ * fallback.z() < 0D) { + fieldX = -fieldX; + fieldZ = -fieldZ; + } + double blendedX = fallback.x() * (1D - blend) + fieldX * blend; + double blendedZ = fallback.z() * (1D - blend) + fieldZ * blend; + double blendedLength = StrictMath.hypot(blendedX, blendedZ); + return blendedLength <= 0D + ? fallback + : new RouteDirection(blendedX / blendedLength, blendedZ / blendedLength); + } + + List constrainedTerrainFallbackEdge( + HydrologyPoint upstream, + HydrologyPoint downstream + ) { + if (planner.routePaths.crossesTerrainCrevasse(upstream, downstream)) { + return List.of(); + } + double deltaX = downstream.x() - upstream.x(); + double deltaZ = downstream.z() - upstream.z(); + double distance = StrictMath.hypot(deltaX, deltaZ); + if (distance <= 0D) { + return List.of(); + } + int refinement = planner.settings.routing().refinementSpacing(); + double perpendicularX = -deltaZ / distance; + double perpendicularZ = deltaX / distance; + List direct = planner.segments.line(upstream, downstream, refinement); + ArrayList points = new ArrayList<>(direct.size()); + for (int index = 0; index < direct.size(); index++) { + HydrologyPoint point = direct.get(index); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(point.x(), point.z()); + if (terrain == null || !terrain.transitAllowed()) { + return List.of(); + } + if (index > 0 && index < direct.size() - 1 + && hasLateralRouteFreedom(point, perpendicularX, perpendicularZ, refinement)) { + return List.of(); + } + points.add(new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z())); + } + return planner.routePaths.traversableRoute(points) && !planner.routePaths.containsTerrainPit(points) + ? List.copyOf(points) + : List.of(); + } + + boolean hasLateralRouteFreedom( + HydrologyPoint point, + double perpendicularX, + double perpendicularZ, + int refinement + ) { + for (int direction : List.of(-1, 1)) { + int x = (int) StrictMath.round(point.x() + perpendicularX * refinement * direction); + int z = (int) StrictMath.round(point.z() + perpendicularZ * refinement * direction); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(x, z); + if (terrain != null && terrain.transitAllowed()) { + return true; + } + } + return false; + } + + RouteCandidate routeEndpoint( + HydrologyPoint point, + RouteDirection tangent + ) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + if (terrain == null || !terrain.transitAllowed()) { + return new RouteCandidate( + point, + 0D, + Double.POSITIVE_INFINITY, + Double.POSITIVE_INFINITY, + tangent, + true + ); + } + double terrainScore = routeTerrainScore(terrain); + return new RouteCandidate( + new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z()), + 0D, + terrainScore, + terrainScore, + tangent, + true + ); + } + + RoutePosition routePosition( + HydrologyPoint upstream, + HydrologyPoint downstream, + RouteDirection startTangent, + RouteDirection endTangent, + double tangentMagnitude, + double distance, + double progress, + double meanderScale + ) { + double tangentX = planner.routePaths.hermiteDerivative( + upstream.x(), + downstream.x(), + startTangent.x() * tangentMagnitude, + endTangent.x() * tangentMagnitude, + progress + ); + double tangentZ = planner.routePaths.hermiteDerivative( + upstream.z(), + downstream.z(), + startTangent.z() * tangentMagnitude, + endTangent.z() * tangentMagnitude, + progress + ); + double tangentLength = StrictMath.hypot(tangentX, tangentZ); + RouteDirection tangent = tangentLength <= 0D + ? startTangent + : new RouteDirection(tangentX / tangentLength, tangentZ / tangentLength); + double baseX = planner.routePaths.hermite( + upstream.x(), + downstream.x(), + startTangent.x() * tangentMagnitude, + endTangent.x() * tangentMagnitude, + progress + ); + double baseZ = planner.routePaths.hermite( + upstream.z(), + downstream.z(), + startTangent.z() * tangentMagnitude, + endTangent.z() * tangentMagnitude, + progress + ); + double envelope = StrictMath.pow(StrictMath.sin(StrictMath.PI * progress), 2D); + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + double primary = planner.routeWormPrimary.noiseSigned( + baseX / meanders.primaryWavelength(), + baseZ / meanders.primaryWavelength() + ); + double detail = planner.routeWormDetail.noiseSigned( + baseX / meanders.detailWavelength(), + baseZ / meanders.detailWavelength() + ); + double worm = distance * meanders.maximumOffsetRatio() * envelope * meanderScale * ( + primary * meanders.primaryStrength() + + detail * meanders.detailStrength() + ); + double anchorRatio = Math.min( + ROUTE_ANCHOR_MAXIMUM_OFFSET_RATIO, + meanders.maximumOffsetRatio() * 0.625D + ); + double transverseRatio = planner.settings.routing().refinementSpacing() + / (double) planner.settings.routing().sampleSpacing(); + double maximumWorm = distance * Math.max(0D, 0.5D - anchorRatio - transverseRatio); + worm = Math.max(-maximumWorm, Math.min(maximumWorm, worm)); + return new RoutePosition( + baseX - tangent.z() * worm, + baseZ + tangent.x() * worm, + baseX, + baseZ, + tangent + ); + } + + /** + * {@code confines} is the area the edge's upstream end is confined to, or null: candidates outside it + * are not offered, so a refined route between two confined lattice nodes stays inside their area. + */ + static boolean withinConfines(HydrologyTerrainSample terrain, String confines) { + return confines == null || confines.equals(terrain.confinesKey()); + } + + List routeCandidates( + long upstreamId, + long downstreamId, + RoutePosition nominal, + double progress, + int refinement, + int transverseCandidates, + String confines + ) { + double searchEnvelope = StrictMath.sin(StrictMath.PI * progress); + LinkedHashMap candidates = new LinkedHashMap<>(); + for (int offsetIndex = -transverseCandidates; + offsetIndex <= transverseCandidates; + offsetIndex++) { + double offset = offsetIndex * refinement * searchEnvelope; + int x = (int) StrictMath.round(nominal.x() - nominal.tangent().z() * offset); + int z = (int) StrictMath.round(nominal.z() + nominal.tangent().x() * offset); + HydrologyTerrainSample terrain = planner.sampleLandBasis(x, z); + if (terrain == null || !terrain.transitAllowed() || !withinConfines(terrain, confines)) { + continue; + } + long packed = RiverFootprint.pack(x, z); + double localScore = routeTerrainScore(terrain) + + StrictMath.abs(offset) * 0.18D + + HydrologyHash.unit(HydrologyHash.mix(planner.worldSeed, upstreamId, downstreamId, x, z)) * 1.0E-6D; + RouteCandidate candidate = new RouteCandidate( + new HydrologyPoint(x, terrain.naturalHeight(), z), + offset, + localScore, + routeTerrainScore(terrain), + nominal.tangent(), + true + ); + RouteCandidate current = candidates.get(packed); + if (current == null || candidate.localScore() < current.localScore()) { + candidates.put(packed, candidate); + } + } + if (!candidates.isEmpty()) { + return List.copyOf(candidates.values()); + } + int fallbackX = (int) StrictMath.round(nominal.baseX()); + int fallbackZ = (int) StrictMath.round(nominal.baseZ()); + HydrologyTerrainSample fallbackTerrain = planner.sampleLandBasis(fallbackX, fallbackZ); + if (fallbackTerrain != null + && fallbackTerrain.transitAllowed() + && withinConfines(fallbackTerrain, confines)) { + long packed = RiverFootprint.pack(fallbackX, fallbackZ); + double fallbackOffset = (nominal.baseX() - nominal.x()) * -nominal.tangent().z() + + (nominal.baseZ() - nominal.z()) * nominal.tangent().x(); + double localScore = routeTerrainScore(fallbackTerrain) + + StrictMath.abs(fallbackOffset) * 0.18D + + HydrologyHash.unit(HydrologyHash.mix( + planner.worldSeed, + upstreamId, + downstreamId, + fallbackX, + fallbackZ + )) * 1.0E-6D; + RouteCandidate fallback = new RouteCandidate( + new HydrologyPoint(fallbackX, fallbackTerrain.naturalHeight(), fallbackZ), + fallbackOffset, + localScore, + routeTerrainScore(fallbackTerrain), + nominal.tangent(), + true + ); + RouteCandidate current = candidates.get(packed); + if (current == null || fallback.localScore() < current.localScore()) { + candidates.put(packed, fallback); + } + } + return List.copyOf(candidates.values()); + } + + List unresolvedSurfaceRouteCandidates( + HydrologySampledGrid grid, + long upstreamId, + long downstreamId, + RoutePosition nominal, + double progress, + int refinement, + int transverseCandidates + ) { + double searchEnvelope = StrictMath.sin(StrictMath.PI * progress); + LinkedHashMap candidates = new LinkedHashMap<>(); + for (int offsetIndex = -transverseCandidates; + offsetIndex <= transverseCandidates; + offsetIndex++) { + double offset = offsetIndex * refinement * searchEnvelope; + int x = (int) StrictMath.round(nominal.x() - nominal.tangent().z() * offset); + int z = (int) StrictMath.round(nominal.z() + nominal.tangent().x() * offset); + long packed = RiverFootprint.pack(x, z); + RouteTerrainEstimate estimate = routeTerrainEstimate(grid, x, z); + double localScore = estimate.terrainScore() + + StrictMath.abs(offset) * 0.18D + + HydrologyHash.unit(HydrologyHash.mix( + planner.worldSeed, + upstreamId, + downstreamId, + x, + z + )) * 1.0E-6D; + RouteCandidate candidate = new RouteCandidate( + new HydrologyPoint(x, estimate.height(), z), + offset, + localScore, + estimate.terrainScore(), + nominal.tangent(), + false + ); + RouteCandidate current = candidates.get(packed); + if (current == null || candidate.localScore() < current.localScore()) { + candidates.put(packed, candidate); + } + } + return List.copyOf(candidates.values()); + } + + RouteTerrainEstimate routeTerrainEstimate(HydrologySampledGrid grid, int x, int z) { + double gridX = (x - grid.minimumX()) / (double) grid.spacing(); + double gridZ = (z - grid.minimumZ()) / (double) grid.spacing(); + int minimumGridX = Math.max(0, Math.min(grid.width() - 1, (int) StrictMath.floor(gridX))); + int minimumGridZ = Math.max(0, Math.min(grid.width() - 1, (int) StrictMath.floor(gridZ))); + int maximumGridX = Math.min(grid.width() - 1, minimumGridX + 1); + int maximumGridZ = Math.min(grid.width() - 1, minimumGridZ + 1); + double progressX = Math.max(0D, Math.min(1D, gridX - minimumGridX)); + double progressZ = Math.max(0D, Math.min(1D, gridZ - minimumGridZ)); + HydrologyTerrainSample northwest = grid.nodeAt(minimumGridX, minimumGridZ).terrain(); + HydrologyTerrainSample northeast = grid.nodeAt(maximumGridX, minimumGridZ).terrain(); + HydrologyTerrainSample southwest = grid.nodeAt(minimumGridX, maximumGridZ).terrain(); + HydrologyTerrainSample southeast = grid.nodeAt(maximumGridX, maximumGridZ).terrain(); + double height = planner.routePaths.bilinear( + northwest.naturalHeight(), + northeast.naturalHeight(), + southwest.naturalHeight(), + southeast.naturalHeight(), + progressX, + progressZ + ); + double terrainScore = planner.routePaths.bilinear( + routeTerrainScore(northwest), + routeTerrainScore(northeast), + routeTerrainScore(southwest), + routeTerrainScore(southeast), + progressX, + progressZ + ); + return new RouteTerrainEstimate((int) StrictMath.round(height), terrainScore); + } + + RouteCandidate resolveRouteCandidate(RouteCandidate candidate) { + if (candidate.terrainResolved()) { + return candidate; + } + HydrologyPoint point = candidate.point(); + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + if (terrain == null || !terrain.transitAllowed()) { + return new RouteCandidate( + point, + candidate.offset(), + Double.POSITIVE_INFINITY, + Double.POSITIVE_INFINITY, + candidate.tangent(), + true + ); + } + double terrainScore = routeTerrainScore(terrain) + crossDropPenalty(point, candidate.tangent(), terrain); + double exactLocalScore = candidate.localScore() - candidate.terrainScore() + terrainScore; + return new RouteCandidate( + new HydrologyPoint(point.x(), terrain.naturalHeight(), point.z()), + candidate.offset(), + exactLocalScore, + terrainScore, + candidate.tangent(), + true + ); + } + + /** + * Ground that falls away beside a candidate forces the valley solver to cut the channel down to the + * lower bank; costing that drop keeps refined routes on valley floors and contour lines instead of + * traversing hillsides that the incision cap would later reject. + */ + double crossDropPenalty(HydrologyPoint point, RouteDirection tangent, HydrologyTerrainSample center) { + double length = StrictMath.hypot(tangent.x(), tangent.z()); + if (length <= 0D) { + return 0D; + } + double normalX = -tangent.z() / length; + double normalZ = tangent.x() / length; + double reach = planner.settings.surface().maximumWidth() / 2D + planner.settings.surface().shoreWidth() + 2D; + int lowest = center.naturalHeight(); + for (double distance = reach / 2D; distance <= reach; distance += reach / 2D) { + for (double direction = -1D; direction <= 1D; direction += 2D) { + HydrologyTerrainSample side = planner.sampleLandBasisWithoutSlope( + (int) StrictMath.round(point.x() + normalX * distance * direction), + (int) StrictMath.round(point.z() + normalZ * distance * direction)); + if (side != null) { + lowest = Math.min(lowest, side.naturalHeight()); + } + } + } + double drop = center.naturalHeight() - lowest; + return drop * planner.settings.routing().valleyPreference() * CROSS_DROP_WEIGHT; + } + + double routeTerrainScore(HydrologyTerrainSample terrain) { + return terrain.naturalHeight() * planner.settings.routing().valleyPreference() + + terrain.slope() * planner.settings.routing().slopePenalty() + + terrain.routingCost() * terrain.routingMultiplier(); + } + + List solveTerrainRoute( + List> layers, + double targetStepLength + ) { + ArrayList> availableLayers = new ArrayList<>(layers); + HashSet rejectedTransitions = new HashSet<>(); + while (true) { + RouteCandidate[] route = selectTerrainRoute( + availableLayers, + targetStepLength, + rejectedTransitions + ); + if (route.length == 0) { + return List.of(); + } + TerrainTransitionKey unsupportedTransition = unsupportedTerrainTransition(route); + if (unsupportedTransition != null) { + rejectedTransitions.add(unsupportedTransition); + continue; + } + int pitRemoval = planner.routePaths.removeTerrainPits(availableLayers, route); + if (pitRemoval < 0) { + return List.of(); + } + if (pitRemoval > 0) { + continue; + } + ArrayList points = new ArrayList<>(route.length); + for (RouteCandidate candidate : route) { + HydrologyPoint point = candidate.point(); + if (points.isEmpty() + || point.x() != points.getLast().x() + || point.z() != points.getLast().z()) { + points.add(point); + } + } + if (points.size() < 2) { + return List.of(); + } + return planner.routePaths.smoothTerrainRoute(points); + } + } + + RouteCandidate[] selectTerrainRoute( + List> layers, + double targetStepLength, + Set rejectedTransitions + ) { + int layerCount = layers.size(); + double[][] costs = new double[layerCount][]; + int[][] predecessors = new int[layerCount][]; + costs[0] = new double[]{layers.getFirst().getFirst().localScore()}; + predecessors[0] = new int[]{-1}; + for (int layerIndex = 1; layerIndex < layerCount; layerIndex++) { + List currentLayer = layers.get(layerIndex); + List previousLayer = layers.get(layerIndex - 1); + costs[layerIndex] = new double[currentLayer.size()]; + predecessors[layerIndex] = new int[currentLayer.size()]; + Arrays.fill(costs[layerIndex], Double.POSITIVE_INFINITY); + Arrays.fill(predecessors[layerIndex], -1); + for (int currentIndex = 0; currentIndex < currentLayer.size(); currentIndex++) { + RouteCandidate current = currentLayer.get(currentIndex); + for (int previousIndex = 0; previousIndex < previousLayer.size(); previousIndex++) { + if (!Double.isFinite(costs[layerIndex - 1][previousIndex])) { + continue; + } + RouteCandidate previous = previousLayer.get(previousIndex); + TerrainTransitionKey transitionKey = new TerrainTransitionKey( + previous.point(), + current.point() + ); + if (rejectedTransitions.contains(transitionKey)) { + continue; + } + double transition = planner.routePaths.routeTransitionGeometryCost(previous, current, targetStepLength); + if (!Double.isFinite(transition)) { + continue; + } + double cost = costs[layerIndex - 1][previousIndex] + current.localScore() + transition; + if (cost < costs[layerIndex][currentIndex]) { + costs[layerIndex][currentIndex] = cost; + predecessors[layerIndex][currentIndex] = previousIndex; + } + } + } + } + int selectedIndex = 0; + double selectedCost = costs[layerCount - 1][0]; + for (int candidateIndex = 1; candidateIndex < costs[layerCount - 1].length; candidateIndex++) { + if (costs[layerCount - 1][candidateIndex] < selectedCost) { + selectedIndex = candidateIndex; + selectedCost = costs[layerCount - 1][candidateIndex]; + } + } + if (!Double.isFinite(selectedCost)) { + return new RouteCandidate[0]; + } + RouteCandidate[] route = new RouteCandidate[layerCount]; + for (int layerIndex = layerCount - 1; layerIndex >= 0; layerIndex--) { + route[layerIndex] = layers.get(layerIndex).get(selectedIndex); + selectedIndex = predecessors[layerIndex][selectedIndex]; + } + return route; + } + + TerrainTransitionKey unsupportedTerrainTransition(RouteCandidate[] route) { + for (int routeIndex = 0; routeIndex < route.length - 1; routeIndex++) { + RouteCandidate start = route[routeIndex]; + RouteCandidate end = route[routeIndex + 1]; + if (!planner.routePaths.traversableTerrainTransition(start.point(), end.point())) { + return new TerrainTransitionKey(start.point(), end.point()); + } + } + return null; + } + + RouteCandidate[] selectCurvatureAwareTerrainRoute( + List> layers, + double targetStepLength, + double maximumTurn, + double turnCost + ) { + int layerCount = layers.size(); + if (layerCount < 2) { + return new RouteCandidate[0]; + } + double[][] localPenalties = new double[layerCount][]; + double[][][] transitionCosts = new double[layerCount][][]; + double[][][][] turnCosts = new double[layerCount][][][]; + for (int layerIndex = 0; layerIndex < layerCount; layerIndex++) { + int layerSize = layers.get(layerIndex).size(); + localPenalties[layerIndex] = new double[layerSize]; + if (layerIndex > 0 && layerIndex < layerCount - 1) { + Arrays.fill(localPenalties[layerIndex], Double.NaN); + } + if (layerIndex == 0) { + continue; + } + int previousSize = layers.get(layerIndex - 1).size(); + transitionCosts[layerIndex] = new double[previousSize][layerSize]; + for (double[] row : transitionCosts[layerIndex]) { + Arrays.fill(row, Double.NaN); + } + } + while (true) { + CurvatureRouteSelection selection = selectCurvatureAwareTerrainRoute( + layers, + targetStepLength, + maximumTurn, + turnCost, + localPenalties, + transitionCosts, + turnCosts + ); + if (selection.route().length == 0) { + return selection.route(); + } + boolean evaluated = evaluateSelectedSurfaceCosts( + selection, + layers, + localPenalties, + transitionCosts, + targetStepLength + ); + if (!evaluated) { + return selection.route(); + } + } + } + + CurvatureRouteSelection selectCurvatureAwareTerrainRoute( + List> layers, + double targetStepLength, + double maximumTurn, + double turnCost, + double[][] localPenalties, + double[][][] transitionCosts, + double[][][][] turnCosts + ) { + int layerCount = layers.size(); + double[][][] costs = new double[layerCount][][]; + int[][][] predecessors = new int[layerCount][][]; + List firstLayer = layers.getFirst(); + List secondLayer = layers.get(1); + costs[1] = new double[firstLayer.size()][secondLayer.size()]; + predecessors[1] = new int[firstLayer.size()][secondLayer.size()]; + for (int firstIndex = 0; firstIndex < firstLayer.size(); firstIndex++) { + Arrays.fill(costs[1][firstIndex], Double.POSITIVE_INFINITY); + Arrays.fill(predecessors[1][firstIndex], -1); + for (int secondIndex = 0; secondIndex < secondLayer.size(); secondIndex++) { + RouteCandidate first = firstLayer.get(firstIndex); + RouteCandidate second = secondLayer.get(secondIndex); + double transition = resolvedTransitionCost( + first, + second, + targetStepLength, + transitionCosts[1][firstIndex][secondIndex] + ); + if (Double.isFinite(transition)) { + costs[1][firstIndex][secondIndex] = first.localScore() + + second.localScore() + + resolvedLocalPenalty(localPenalties[1][secondIndex]) + + transition; + } + } + } + for (int layerIndex = 2; layerIndex < layerCount; layerIndex++) { + List beforeLayer = layers.get(layerIndex - 2); + List previousLayer = layers.get(layerIndex - 1); + List currentLayer = layers.get(layerIndex); + costs[layerIndex] = new double[previousLayer.size()][currentLayer.size()]; + predecessors[layerIndex] = new int[previousLayer.size()][currentLayer.size()]; + if (turnCosts[layerIndex] == null) { + turnCosts[layerIndex] = new double[previousLayer.size()][currentLayer.size()][]; + } + for (int previousIndex = 0; previousIndex < previousLayer.size(); previousIndex++) { + Arrays.fill(costs[layerIndex][previousIndex], Double.POSITIVE_INFINITY); + Arrays.fill(predecessors[layerIndex][previousIndex], -1); + RouteCandidate previous = previousLayer.get(previousIndex); + for (int currentIndex = 0; currentIndex < currentLayer.size(); currentIndex++) { + RouteCandidate current = currentLayer.get(currentIndex); + double transition = resolvedTransitionCost( + previous, + current, + targetStepLength, + transitionCosts[layerIndex][previousIndex][currentIndex] + ); + if (!Double.isFinite(transition)) { + continue; + } + double localPenalty = resolvedLocalPenalty(localPenalties[layerIndex][currentIndex]); + for (int beforeIndex = 0; beforeIndex < beforeLayer.size(); beforeIndex++) { + double previousCost = costs[layerIndex - 1][beforeIndex][previousIndex]; + if (!Double.isFinite(previousCost)) { + continue; + } + double[] candidateTurns = turnCosts[layerIndex][previousIndex][currentIndex]; + if (candidateTurns == null) { + candidateTurns = new double[beforeLayer.size()]; + Arrays.fill(candidateTurns, Double.NaN); + turnCosts[layerIndex][previousIndex][currentIndex] = candidateTurns; + } + double turnPenalty = candidateTurns[beforeIndex]; + if (Double.isNaN(turnPenalty)) { + double turn = HydrologyRoutePath.routeTurnDegrees( + beforeLayer.get(beforeIndex).point(), + previous.point(), + current.point() + ); + turnPenalty = turn > maximumTurn + ? Double.POSITIVE_INFINITY + : curvatureCost(turn, maximumTurn, turnCost); + candidateTurns[beforeIndex] = turnPenalty; + } + if (turnPenalty == Double.POSITIVE_INFINITY) { + continue; + } + double cost = previousCost + + current.localScore() + + localPenalty + + transition + + turnPenalty; + if (cost < costs[layerIndex][previousIndex][currentIndex]) { + costs[layerIndex][previousIndex][currentIndex] = cost; + predecessors[layerIndex][previousIndex][currentIndex] = beforeIndex; + } + } + } + } + } + int lastLayerIndex = layerCount - 1; + int selectedPreviousIndex = -1; + int selectedCurrentIndex = -1; + double selectedCost = Double.POSITIVE_INFINITY; + for (int previousIndex = 0; previousIndex < costs[lastLayerIndex].length; previousIndex++) { + for (int currentIndex = 0; + currentIndex < costs[lastLayerIndex][previousIndex].length; + currentIndex++) { + if (costs[lastLayerIndex][previousIndex][currentIndex] < selectedCost) { + selectedCost = costs[lastLayerIndex][previousIndex][currentIndex]; + selectedPreviousIndex = previousIndex; + selectedCurrentIndex = currentIndex; + } + } + } + if (!Double.isFinite(selectedCost)) { + return CurvatureRouteSelection.empty(); + } + RouteCandidate[] route = new RouteCandidate[layerCount]; + int[] indices = new int[layerCount]; + route[lastLayerIndex] = layers.get(lastLayerIndex).get(selectedCurrentIndex); + route[lastLayerIndex - 1] = layers.get(lastLayerIndex - 1).get(selectedPreviousIndex); + indices[lastLayerIndex] = selectedCurrentIndex; + indices[lastLayerIndex - 1] = selectedPreviousIndex; + for (int layerIndex = lastLayerIndex; layerIndex >= 2; layerIndex--) { + int beforeIndex = predecessors[layerIndex][selectedPreviousIndex][selectedCurrentIndex]; + if (beforeIndex < 0) { + return CurvatureRouteSelection.empty(); + } + route[layerIndex - 2] = layers.get(layerIndex - 2).get(beforeIndex); + indices[layerIndex - 2] = beforeIndex; + selectedCurrentIndex = selectedPreviousIndex; + selectedPreviousIndex = beforeIndex; + } + return new CurvatureRouteSelection(route, indices); + } + + boolean evaluateSelectedSurfaceCosts( + CurvatureRouteSelection selection, + List> layers, + double[][] localPenalties, + double[][][] transitionCosts, + double targetStepLength + ) { + boolean evaluated = false; + RouteCandidate[] route = selection.route(); + int[] indices = selection.indices(); + for (int layerIndex = 1; layerIndex < route.length - 1; layerIndex++) { + RouteCandidate candidate = route[layerIndex]; + if (candidate.terrainResolved()) { + continue; + } + RouteCandidate resolved = resolveRouteCandidate(candidate); + ArrayList updatedLayer = new ArrayList<>(layers.get(layerIndex)); + updatedLayer.set(indices[layerIndex], resolved); + layers.set(layerIndex, List.copyOf(updatedLayer)); + route[layerIndex] = resolved; + evaluated = true; + } + for (int layerIndex = 1; layerIndex < route.length - 1; layerIndex++) { + int candidateIndex = indices[layerIndex]; + if (!Double.isNaN(localPenalties[layerIndex][candidateIndex])) { + continue; + } + if (!Double.isFinite(route[layerIndex].localScore())) { + localPenalties[layerIndex][candidateIndex] = 0D; + continue; + } + localPenalties[layerIndex][candidateIndex] = planner.surfaceCourses.surfaceRouteCandidateBankPenalty( + route[layerIndex] + ); + evaluated = true; + } + for (int layerIndex = 1; layerIndex < route.length; layerIndex++) { + int previousIndex = indices[layerIndex - 1]; + int currentIndex = indices[layerIndex]; + if (!Double.isNaN(transitionCosts[layerIndex][previousIndex][currentIndex])) { + continue; + } + RouteCandidate previous = route[layerIndex - 1]; + RouteCandidate current = route[layerIndex]; + if (!Double.isFinite(previous.localScore()) || !Double.isFinite(current.localScore())) { + transitionCosts[layerIndex][previousIndex][currentIndex] = Double.POSITIVE_INFINITY; + continue; + } + double transition = planner.routePaths.routeTransitionCost(previous, current, targetStepLength); + if (Double.isFinite(transition)) { + transition += surfaceRouteTransitionPenalty(previous, current); + } + transitionCosts[layerIndex][previousIndex][currentIndex] = transition; + evaluated = true; + } + return evaluated; + } + + double resolvedLocalPenalty(double penalty) { + return Double.isNaN(penalty) ? 0D : penalty; + } + + double resolvedTransitionCost( + RouteCandidate previous, + RouteCandidate current, + double targetStepLength, + double exactCost + ) { + return Double.isNaN(exactCost) + ? planner.routePaths.routeTransitionGeometryCost(previous, current, targetStepLength) + : exactCost; + } + + double curvatureCost(double turn, double maximumTurn, double turnCost) { + double excess = Math.max(0D, turn - 8D); + return excess * excess * turnCost / maximumTurn; + } + + double surfaceRouteTransitionPenalty( + RouteCandidate start, + RouteCandidate end + ) { + int minimumBankDistance = planner.surfaceCourses.surfaceBankDistance(planner.settings.surface().minimumWidth()); + int maximumBankDistance = planner.surfaceCourses.surfaceBankDistance(planner.settings.surface().maximumWidth()); + int maximumBankRise = Math.addExact( + planner.settings.surface().maximumIncision(), + (int) StrictMath.ceil(planner.settings.surface().banks().minimumBlendWidth() * 0.5D) + ); + RouteDirection tangent = planner.routePaths.direction(start.point().x(), start.point().z(), end.point().x(), end.point().z()); + int endpointCeiling = Math.max(start.point().y(), end.point().y()); + double penalty = 0D; + List raster = planner.segments.rasterLine(start.point(), end.point()); + int sampleStride = Math.max(1, planner.settings.routing().refinementSpacing() / 4); + for (int pointIndex = 0; pointIndex < raster.size(); pointIndex += sampleStride) { + HydrologyPoint point = raster.get(pointIndex); + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + if (terrain == null) { + return 1.0E12D; + } + int permittedIncision = planner.sourcePlanner.permittedSurfaceIncision(terrain); + int ridgeExcess = Math.max( + 0, + terrain.naturalHeight() - endpointCeiling - permittedIncision + ); + penalty += (double) ridgeExcess * ridgeExcess * 65536D; + if (terrain.slope() >= planner.settings.hydraulics().waterfallMinimumDrop()) { + continue; + } + int head = Math.subtractExact( + terrain.naturalHeight(), + planner.settings.surface().banks().sink() + ); + penalty += planner.surfaceCourses.surfaceRouteBankPenalty( + point, + tangent, + minimumBankDistance, + maximumBankDistance, + head, + maximumBankRise + ); + } + if ((raster.size() - 1) % sampleStride != 0) { + HydrologyPoint point = raster.getLast(); + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + if (terrain == null) { + return 1.0E12D; + } + int permittedIncision = planner.sourcePlanner.permittedSurfaceIncision(terrain); + int ridgeExcess = Math.max( + 0, + terrain.naturalHeight() - endpointCeiling - permittedIncision + ); + penalty += (double) ridgeExcess * ridgeExcess * 65536D; + if (terrain.slope() < planner.settings.hydraulics().waterfallMinimumDrop()) { + int head = Math.subtractExact( + terrain.naturalHeight(), + planner.settings.surface().banks().sink() + ); + penalty += planner.surfaceCourses.surfaceRouteBankPenalty( + point, + tangent, + minimumBankDistance, + maximumBankDistance, + head, + maximumBankRise + ); + } + } + return penalty; + } + + record CurvatureRouteSelection(RouteCandidate[] route, int[] indices) { + private static CurvatureRouteSelection empty() { + return new CurvatureRouteSelection(new RouteCandidate[0], new int[0]); + } + } + + record TerrainTransitionKey(HydrologyPoint start, HydrologyPoint end) { + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutePath.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutePath.java new file mode 100644 index 000000000..274fe12b7 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutePath.java @@ -0,0 +1,312 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.List; + +final class HydrologyRoutePath { + private final HydrologyPlanner planner; + + HydrologyRoutePath(HydrologyPlanner planner) { + this.planner = planner; + } + + boolean containsTerrainPit(List route) { + int threshold = planner.settings.hydraulics().waterfallMinimumDrop(); + for (int pointIndex = 1; pointIndex < route.size() - 1; pointIndex++) { + HydrologyPoint previous = route.get(pointIndex - 1); + HydrologyPoint point = route.get(pointIndex); + HydrologyPoint next = route.get(pointIndex + 1); + if (previous.y() - point.y() >= threshold && next.y() - point.y() >= threshold) { + return true; + } + } + return false; + } + + double bilinear( + double northwest, + double northeast, + double southwest, + double southeast, + double progressX, + double progressZ + ) { + double north = northwest + (northeast - northwest) * progressX; + double south = southwest + (southeast - southwest) * progressX; + return north + (south - north) * progressZ; + } + + int removeTerrainPits(List> layers, RouteCandidate[] route) { + int removed = 0; + for (int routeIndex = 1; routeIndex < route.length - 1; routeIndex++) { + RouteCandidate candidate = route[routeIndex]; + if (!isTerrainPit(candidate)) { + continue; + } + ArrayList candidates = new ArrayList<>(layers.get(routeIndex)); + candidates.remove(candidate); + if (candidates.isEmpty()) { + return -1; + } + layers.set(routeIndex, List.copyOf(candidates)); + removed++; + } + return removed; + } + + boolean isTerrainPit(RouteCandidate candidate) { + HydrologyPoint point = candidate.point(); + RouteDirection tangent = candidate.tangent(); + int refinement = planner.settings.routing().refinementSpacing(); + int offsetX = (int) StrictMath.round(tangent.x() * refinement); + int offsetZ = (int) StrictMath.round(tangent.z() * refinement); + if (offsetX == 0 && offsetZ == 0) { + return false; + } + HydrologyTerrainSample before = planner.sampleLandBasisWithoutSlope(point.x() - offsetX, point.z() - offsetZ); + HydrologyTerrainSample after = planner.sampleLandBasisWithoutSlope(point.x() + offsetX, point.z() + offsetZ); + int threshold = planner.settings.hydraulics().waterfallMinimumDrop(); + return before != null + && after != null + && before.naturalHeight() - point.y() >= threshold + && after.naturalHeight() - point.y() >= threshold; + } + + List smoothTerrainRoute(List route) { + List current = List.copyOf(route); + List best = current; + double bestTurnScore = planner.surfaceCourses.routeTurnScore(current); + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + int maximumPasses = Math.max(8, meanders.smoothingPasses() * 4); + for (int pass = 0; pass < maximumPasses; pass++) { + ArrayList smoothed = new ArrayList<>(current.size()); + smoothed.add(current.getFirst()); + for (int pointIndex = 1; pointIndex < current.size() - 1; pointIndex++) { + HydrologyPoint previous = current.get(pointIndex - 1); + HydrologyPoint point = current.get(pointIndex); + HydrologyPoint next = current.get(pointIndex + 1); + int x = (int) StrictMath.round(previous.x() * 0.25D + point.x() * 0.5D + next.x() * 0.25D); + int z = (int) StrictMath.round(previous.z() * 0.25D + point.z() * 0.5D + next.z() * 0.25D); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(x, z); + smoothed.add(terrain == null || !terrain.transitAllowed() + ? point + : new HydrologyPoint(x, terrain.naturalHeight(), z)); + } + smoothed.add(current.getLast()); + List candidate = withoutDuplicateRoutePoints(smoothed); + if (candidate.size() < 2 || !traversableRoute(candidate)) { + break; + } + current = candidate; + double candidateTurnScore = planner.surfaceCourses.routeTurnScore(candidate); + if (candidateTurnScore < bestTurnScore) { + best = candidate; + bestTurnScore = candidateTurnScore; + } + } + List smoothed = removeRouteHairpins(best, meanders.maximumTurnDegrees()); + return containsTerrainPit(smoothed) ? List.of() : smoothed; + } + + List removeRouteHairpins(List route, double maximumTurnDegrees) { + ArrayList points = new ArrayList<>(route); + while (points.size() > 2) { + int sharpestIndex = sharpestRoutePoint(points); + if (sharpestIndex < 1 || routeTurnDegrees( + points.get(sharpestIndex - 1), + points.get(sharpestIndex), + points.get(sharpestIndex + 1) + ) <= maximumTurnDegrees) { + break; + } + HydrologyPoint previous = points.get(sharpestIndex - 1); + HydrologyPoint next = points.get(sharpestIndex + 1); + if (!traversableHop(previous, next) || crossesTerrainCrevasse(previous, next)) { + break; + } + points.remove(sharpestIndex); + } + return List.copyOf(points); + } + + int sharpestRoutePoint(List route) { + int selectedIndex = -1; + double selectedTurn = 0D; + for (int pointIndex = 1; pointIndex < route.size() - 1; pointIndex++) { + double turn = routeTurnDegrees( + route.get(pointIndex - 1), + route.get(pointIndex), + route.get(pointIndex + 1) + ); + if (turn > selectedTurn) { + selectedIndex = pointIndex; + selectedTurn = turn; + } + } + return selectedIndex; + } + + static double routeTurnDegrees(HydrologyPoint previous, HydrologyPoint point, HydrologyPoint next) { + double incomingX = point.x() - previous.x(); + double incomingZ = point.z() - previous.z(); + double outgoingX = next.x() - point.x(); + double outgoingZ = next.z() - point.z(); + double incomingLength = StrictMath.hypot(incomingX, incomingZ); + double outgoingLength = StrictMath.hypot(outgoingX, outgoingZ); + if (incomingLength == 0D || outgoingLength == 0D) { + return 0D; + } + double cosine = (incomingX * outgoingX + incomingZ * outgoingZ) + / (incomingLength * outgoingLength); + return StrictMath.toDegrees(StrictMath.acos(Math.max(-1D, Math.min(1D, cosine)))); + } + + List withoutDuplicateRoutePoints(List points) { + ArrayList unique = new ArrayList<>(points.size()); + for (HydrologyPoint point : points) { + if (unique.isEmpty() + || point.x() != unique.getLast().x() + || point.z() != unique.getLast().z()) { + unique.add(point); + } + } + return List.copyOf(unique); + } + + boolean traversableRoute(List route) { + for (int pointIndex = 0; pointIndex < route.size() - 1; pointIndex++) { + HydrologyPoint start = route.get(pointIndex); + HydrologyPoint end = route.get(pointIndex + 1); + if (!traversableHop(start, end) || crossesTerrainCrevasse(start, end)) { + return false; + } + } + return true; + } + + double routeTransitionCost( + RouteCandidate previous, + RouteCandidate current, + double targetStepLength + ) { + if (!traversableTerrainTransition(previous.point(), current.point())) { + return Double.POSITIVE_INFINITY; + } + return routeTransitionGeometryCost(previous, current, targetStepLength); + } + + double routeTransitionGeometryCost( + RouteCandidate previous, + RouteCandidate current, + double targetStepLength + ) { + double deltaX = current.point().x() - previous.point().x(); + double deltaZ = current.point().z() - previous.point().z(); + double length = StrictMath.hypot(deltaX, deltaZ); + if (length <= 0D || length > targetStepLength * 5D + 8D) { + return Double.POSITIVE_INFINITY; + } + double transverseChange = StrictMath.abs(current.offset() - previous.offset()); + double alignment = (deltaX * current.tangent().x() + deltaZ * current.tangent().z()) / length; + if (alignment < -0.5D) { + return Double.POSITIVE_INFINITY; + } + int rise = Math.max(0, current.point().y() - previous.point().y()); + return StrictMath.abs(length - targetStepLength) * 1.4D + + transverseChange * 5D + + (1D - alignment) * 32D + + rise * planner.settings.routing().uphillPenalty(); + } + + boolean traversableTerrainTransition(HydrologyPoint start, HydrologyPoint end) { + List crossing = planner.segments.rasterLine(start, end); + HydrologyTerrainSample startTerrain = planner.sampleLandBasisWithoutSlope(start.x(), start.z()); + HydrologyTerrainSample endTerrain = planner.sampleLandBasisWithoutSlope(end.x(), end.z()); + if (startTerrain == null || endTerrain == null) { + return false; + } + int boundaryHeight = Math.min(startTerrain.naturalHeight(), endTerrain.naturalHeight()); + int threshold = planner.settings.hydraulics().waterfallMinimumDrop(); + for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { + HydrologyPoint point = crossing.get(pointIndex); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(point.x(), point.z()); + if (terrain == null + || !terrain.transitAllowed() + || boundaryHeight - terrain.naturalHeight() >= threshold) { + return false; + } + } + return true; + } + + boolean crossesTerrainCrevasse(HydrologyPoint start, HydrologyPoint end) { + List crossing = planner.segments.rasterLine(start, end); + if (crossing.size() < 3) { + return false; + } + HydrologyTerrainSample startTerrain = planner.sampleLandBasisWithoutSlope(start.x(), start.z()); + HydrologyTerrainSample endTerrain = planner.sampleLandBasisWithoutSlope(end.x(), end.z()); + if (startTerrain == null || endTerrain == null) { + return true; + } + int boundaryHeight = Math.min(startTerrain.naturalHeight(), endTerrain.naturalHeight()); + int threshold = planner.settings.hydraulics().waterfallMinimumDrop(); + for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { + HydrologyPoint point = crossing.get(pointIndex); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(point.x(), point.z()); + if (terrain == null || boundaryHeight - terrain.naturalHeight() >= threshold) { + return true; + } + } + return false; + } + + RouteDirection direction(int startX, int startZ, int endX, int endZ) { + double x = endX - startX; + double z = endZ - startZ; + double length = StrictMath.hypot(x, z); + if (length <= 0D) { + return new RouteDirection(0D, 0D); + } + return new RouteDirection(x / length, z / length); + } + + double hermite(double start, double end, double startTangent, double endTangent, double progress) { + double squared = progress * progress; + double cubed = squared * progress; + double startBasis = 2D * cubed - 3D * squared + 1D; + double startTangentBasis = cubed - 2D * squared + progress; + double endBasis = -2D * cubed + 3D * squared; + double endTangentBasis = cubed - squared; + return startBasis * start + + startTangentBasis * startTangent + + endBasis * end + + endTangentBasis * endTangent; + } + + double hermiteDerivative( + double start, + double end, + double startTangent, + double endTangent, + double progress + ) { + double squared = progress * progress; + return (6D * squared - 6D * progress) * start + + (3D * squared - 4D * progress + 1D) * startTangent + + (-6D * squared + 6D * progress) * end + + (3D * squared - 2D * progress) * endTangent; + } + + boolean traversableHop(HydrologyPoint start, HydrologyPoint end) { + List crossing = planner.segments.rasterLine(start, end); + for (int pointIndex = 1; pointIndex < crossing.size() - 1; pointIndex++) { + HydrologyPoint point = crossing.get(pointIndex); + HydrologyTerrainSample terrain = planner.sampleLandBasisWithoutSlope(point.x(), point.z()); + if (terrain == null || terrain.ocean() || !terrain.transitAllowed()) { + return false; + } + } + return true; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutingPlan.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutingPlan.java new file mode 100644 index 000000000..14e77a4ea --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyRoutingPlan.java @@ -0,0 +1,13 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record HydrologyRoutingPlan( + double[] potential, + int[] parent, + int[] outletIndex, + int[] routeLengths, + List outlets, + boolean organicSurfaceRequired +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySampledGrid.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySampledGrid.java new file mode 100644 index 000000000..ea38ed94e --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySampledGrid.java @@ -0,0 +1,44 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record HydrologySampledGrid( + int minimumX, + int minimumZ, + int ownerMinimumX, + int ownerMinimumZ, + int ownerSize, + int width, + int spacing, + List nodes +) { + HydrologyGridNode node(int index) { + return nodes.get(index); + } + + HydrologyGridNode nodeAt(int gridX, int gridZ) { + if (gridX < 0 || gridZ < 0 || gridX >= width || gridZ >= width) { + return null; + } + return nodes.get(gridZ * width + gridX); + } + + HydrologyGridNode nodeAtWorld(int x, int z) { + long deltaX = (long) x - minimumX; + long deltaZ = (long) z - minimumZ; + if (deltaX < 0L || deltaZ < 0L || deltaX % spacing != 0L || deltaZ % spacing != 0L) { + return null; + } + long gridX = deltaX / spacing; + long gridZ = deltaZ / spacing; + if (gridX >= width || gridZ >= width) { + return null; + } + return nodeAt((int) gridX, (int) gridZ); + } + + boolean owns(int x, int z) { + return x >= ownerMinimumX && x < ownerMinimumX + ownerSize + && z >= ownerMinimumZ && z < ownerMinimumZ + ownerSize; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySegmentBuilder.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySegmentBuilder.java new file mode 100644 index 000000000..9ae1613aa --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySegmentBuilder.java @@ -0,0 +1,781 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.List; + +final class HydrologySegmentBuilder { + private final HydrologyPlanner planner; + + HydrologySegmentBuilder(HydrologyPlanner planner) { + this.planner = planner; + } + + static final long SEGMENT_SALT = 0x5345474d454e54L; + static final long GRADED_DROP_APPROACH_SALT = 0x474441505052L; + static final long GRADED_DROP_RUN_SALT = 0x474452554eL; + static final long GRADED_DROP_OUTFLOW_SALT = 0x47444f5554L; + + boolean addHydraulicSegments( + long courseId, + int pairIndex, + HydrologyFeatureType type, + int upstreamHead, + int downstreamHead, + int width, + int depth, + List centerline, + boolean surfaceCourse, + List segments + ) { + int drop = upstreamHead - downstreamHead; + if (drop <= 0 || centerline.size() < 2) { + long segmentId = HydrologyHash.mix(planner.worldSeed, SEGMENT_SALT, courseId, pairIndex, type.ordinal()); + segments.add(new HydraulicSegment( + segmentId, + courseId, + type, + upstreamHead, + downstreamHead, + width, + depth, + false, + false, + centerline + )); + return true; + } + if (type == HydrologyFeatureType.WATERFALL) { + return addFallingDropSegments( + courseId, + pairIndex, + upstreamHead, + downstreamHead, + width, + depth, + centerline, + surfaceCourse, + segments + ); + } + return addGradedDropSegments( + courseId, + pairIndex, + type, + upstreamHead, + downstreamHead, + width, + depth, + centerline, + surfaceCourse, + segments + ); + } + + boolean addFallingDropSegments( + long courseId, + int pairIndex, + int upstreamHead, + int downstreamHead, + int width, + int depth, + List centerline, + boolean surfaceCourse, + List segments + ) { + List raster = rasterCenterline(centerline); + if (raster.size() < 2) { + return false; + } + int lipIndex = Math.min(waterfallLipIndex(raster), raster.size() - 2); + int receiverIndex = lipIndex + 1; + addGradedTransitionSegment( + courseId, + pairIndex, + GRADED_DROP_APPROACH_SALT, + HydrologyFeatureType.SURFACE_POOL, + upstreamHead, + width, + depth, + levelSlice(raster, 0, lipIndex, upstreamHead), + segments + ); + HydrologyPlannerSettings.Drops drops = planner.settings.geometry().drops(); + int flowWidth = hydraulicDropWidth(width, surfaceCourse); + int flowDepth = drops.flowDepth(depth); + HydrologyPoint lip = HydrologyPlanner.withY(raster.get(lipIndex), upstreamHead); + HydrologyPoint receiver = HydrologyPlanner.withY(raster.get(receiverIndex), downstreamHead); + segments.add(new HydraulicSegment( + HydrologyHash.mix(planner.worldSeed, SEGMENT_SALT, courseId, pairIndex, GRADED_DROP_RUN_SALT), + courseId, + HydrologyFeatureType.WATERFALL, + upstreamHead, + downstreamHead, + flowWidth, + flowDepth, + true, + true, + List.of(lip, receiver) + )); + addGradedTransitionSegment( + courseId, + pairIndex, + GRADED_DROP_OUTFLOW_SALT, + HydrologyFeatureType.SURFACE_POOL, + downstreamHead, + width, + depth, + levelSlice(raster, receiverIndex, raster.size() - 1, downstreamHead), + segments + ); + return true; + } + + boolean addGradedDropSegments( + long courseId, + int pairIndex, + HydrologyFeatureType type, + int upstreamHead, + int downstreamHead, + int width, + int depth, + List centerline, + boolean surfaceCourse, + List segments + ) { + int drop = upstreamHead - downstreamHead; + HydrologyPlannerSettings.Drops drops = planner.settings.geometry().drops(); + boolean continuousSurfaceBore = surfaceCourse && type == HydrologyFeatureType.UNDERGROUND_DROP; + List directRaster = continuousSurfaceBore + ? rasterCenterline(centerline) + : List.of(); + int maximumStep = drops.stepLimit(type); + if (continuousSurfaceBore) { + if (directRaster.size() < 2) { + return false; + } + int requiredStep = Math.floorDiv(drop + directRaster.size() - 2, directRaster.size() - 1); + if (requiredStep > HydrologyRouteGeometry.MAXIMUM_SURFACE_BORE_STEP) { + return false; + } + maximumStep = Math.max(maximumStep, requiredStep); + } + int minimumRun = Math.floorDiv(drop + maximumStep - 1, maximumStep) + 1; + int maximumGeneratedRun = Math.addExact(planner.settings.routing().maximumRouteLength(), 1); + if (minimumRun > maximumGeneratedRun) { + return false; + } + int preferredRun = Math.addExact(Math.multiplyExact(drop, drops.cascadeRunPerBlock()), 1); + int undergroundRun = drops.undergroundCascadeRunPerBlock(); + int desiredRun = type.isUnderground() + ? (undergroundRun == 0 + ? minimumRun + : Math.min( + Math.max(minimumRun, Math.addExact(Math.multiplyExact(drop, undergroundRun), 1)), + maximumGeneratedRun + )) + : Math.min(preferredRun, maximumGeneratedRun); + List raster = continuousSurfaceBore + ? directRaster + : type.isUnderground() + ? organicDropRaster(courseId, pairIndex, centerline, desiredRun) + : rasterCenterline(centerline); + if (raster.size() < minimumRun) { + return false; + } + int runLength = Math.min(raster.size(), Math.max(minimumRun, desiredRun)); + int lipIndex = waterfallLipIndex(raster); + int runStart = continuousSurfaceBore + ? 0 + : type.isUnderground() + ? HydrologyPlanner.clamp(lipIndex - runLength / 3, 0, raster.size() - runLength) + : 0; + int runEnd = continuousSurfaceBore + ? raster.size() - 1 + : type.isUnderground() ? runStart + runLength - 1 : raster.size() - 1; + HydrologyFeatureType flatType = type.isUnderground() + ? HydrologyFeatureType.UNDERGROUND_POOL + : HydrologyFeatureType.SURFACE_POOL; + if (!continuousSurfaceBore) { + addGradedTransitionSegment( + courseId, + pairIndex, + GRADED_DROP_APPROACH_SALT, + flatType, + upstreamHead, + width, + depth, + levelSlice(raster, 0, runStart, upstreamHead), + segments + ); + } + List graded = gradedDropCenterline( + raster.subList(runStart, runEnd + 1), + upstreamHead, + downstreamHead, + drops, + maximumStep + ); + int dropWidth = hydraulicDropWidth(width, surfaceCourse); + int dropDepth = drops.flowDepth(depth); + segments.add(new HydraulicSegment( + HydrologyHash.mix(planner.worldSeed, SEGMENT_SALT, courseId, pairIndex, GRADED_DROP_RUN_SALT), + courseId, + type, + upstreamHead, + downstreamHead, + dropWidth, + dropDepth, + false, + !continuousSurfaceBore, + graded + )); + if (!continuousSurfaceBore) { + addGradedTransitionSegment( + courseId, + pairIndex, + GRADED_DROP_OUTFLOW_SALT, + flatType, + downstreamHead, + width, + depth, + levelSlice(raster, runEnd, raster.size() - 1, downstreamHead), + segments + ); + } + return true; + } + + int hydraulicDropWidth(int channelWidth, boolean surfaceCourse) { + int dropWidth = planner.settings.geometry().drops().flowWidth(channelWidth); + return surfaceCourse ? Math.max(planner.settings.surface().minimumWidth(), dropWidth) : dropWidth; + } + + List organicDropRaster( + long courseId, + int pairIndex, + List centerline, + int desiredRun + ) { + List base = rasterCenterline(centerline); + if (base.size() >= desiredRun) { + return base; + } + int wavelength = planner.settings.geometry().meanders().detailWavelength(); + double phase = HydrologyHash.unit(HydrologyHash.mix(planner.worldSeed, courseId, pairIndex, GRADED_DROP_RUN_SALT)) + * StrictMath.PI * 2D; + int maximumAmplitude = Math.max(3, planner.settings.routing().sampleSpacing() / 2); + List longest = base; + for (int amplitude = 3; amplitude <= maximumAmplitude; amplitude += 2) { + int cycles = Math.max(1, (int) StrictMath.ceil( + Math.max(0, desiredRun - base.size()) / (2D * amplitude) + )); + int samples = Math.max(base.size(), desiredRun * 3); + ArrayList worm = new ArrayList<>(samples); + for (int sampleIndex = 0; sampleIndex < samples; sampleIndex++) { + double progress = sampleIndex / (double) (samples - 1); + double baseIndex = progress * (base.size() - 1); + int lowerIndex = Math.min(base.size() - 2, (int) StrictMath.floor(baseIndex)); + int upperIndex = lowerIndex + 1; + double localProgress = baseIndex - lowerIndex; + HydrologyPoint lower = base.get(lowerIndex); + HydrologyPoint upper = base.get(upperIndex); + double baseX = lower.x() + (upper.x() - lower.x()) * localProgress; + double baseZ = lower.z() + (upper.z() - lower.z()) * localProgress; + double tangentX = upper.x() - lower.x(); + double tangentZ = upper.z() - lower.z(); + double tangentLength = StrictMath.hypot(tangentX, tangentZ); + if (tangentLength <= 0D) { + continue; + } + double envelope = StrictMath.pow(StrictMath.sin(StrictMath.PI * progress), 2D); + double displacement = StrictMath.sin( + progress * StrictMath.PI * 2D * cycles + + baseIndex * StrictMath.PI * 2D / wavelength + + phase + ) * amplitude * envelope; + int x = (int) StrictMath.round(baseX - tangentZ / tangentLength * displacement); + int z = (int) StrictMath.round(baseZ + tangentX / tangentLength * displacement); + if (worm.isEmpty() || worm.getLast().x() != x || worm.getLast().z() != z) { + worm.add(new HydrologyPoint(x, lower.y(), z)); + } + } + List raster = rasterCenterline(worm); + if (raster.size() > longest.size()) { + longest = raster; + } + if (raster.size() >= desiredRun) { + return raster; + } + } + return longest; + } + + void addGradedTransitionSegment( + long courseId, + int pairIndex, + long salt, + HydrologyFeatureType type, + int head, + int width, + int depth, + List centerline, + List segments + ) { + if (centerline.size() < 2) { + return; + } + segments.add(new HydraulicSegment( + HydrologyHash.mix(planner.worldSeed, SEGMENT_SALT, courseId, pairIndex, salt), + courseId, + type, + head, + head, + width, + depth, + false, + false, + List.copyOf(centerline) + )); + } + + List gradedDropCenterline( + List points, + int upstreamHead, + int downstreamHead, + HydrologyPlannerSettings.Drops drops, + int maximumStep + ) { + int pointCount = points.size(); + int drop = upstreamHead - downstreamHead; + if ((long) (pointCount - 1) * maximumStep < drop) { + throw new IllegalArgumentException("Graded drop centerline cannot contain its configured head loss."); + } + ArrayList graded = new ArrayList<>(pointCount); + int previousHead = upstreamHead; + for (int pointIndex = 0; pointIndex < pointCount; pointIndex++) { + double progress = pointIndex / (double) (pointCount - 1); + int idealHead = upstreamHead - (int) StrictMath.round( + drop * StrictMath.pow(progress, drops.cascadeExponent()) + ); + int remainingSteps = pointCount - pointIndex - 1; + int latestReachableHead = downstreamHead + remainingSteps * maximumStep; + int head = Math.min(previousHead, Math.min(idealHead, latestReachableHead)); + head = Math.max(downstreamHead, Math.max(previousHead - maximumStep, head)); + if (pointIndex == pointCount - 1) { + head = downstreamHead; + } + HydrologyPoint point = points.get(pointIndex); + graded.add(new HydrologyPoint(point.x(), head, point.z())); + previousHead = head; + } + return List.copyOf(graded); + } + + List levelSlice( + List points, + int startIndex, + int endIndex, + int head + ) { + ArrayList leveled = new ArrayList<>(Math.max(0, endIndex - startIndex + 1)); + for (int pointIndex = startIndex; pointIndex <= endIndex; pointIndex++) { + leveled.add(HydrologyPlanner.withY(points.get(pointIndex), head)); + } + return List.copyOf(leveled); + } + + int waterfallLipIndex(List raster) { + return waterfallLipIndex(raster, 0); + } + + int waterfallLipIndex(List raster, int requiredDecline) { + int fallback = Math.max(0, raster.size() / 2 - 1); + int selected = fallback; + long strongestDecline = Long.MIN_VALUE; + for (int pointIndex = 0; pointIndex < raster.size() - 1; pointIndex++) { + HydrologyPoint current = raster.get(pointIndex); + HydrologyPoint downstream = raster.get(pointIndex + 1); + HydrologyTerrainSample currentTerrain = planner.sampleBasisWithoutSlope(current.x(), current.z()); + HydrologyTerrainSample downstreamTerrain = planner.sampleBasisWithoutSlope(downstream.x(), downstream.z()); + long decline = (long) currentTerrain.naturalHeight() - downstreamTerrain.naturalHeight(); + if (decline > strongestDecline) { + strongestDecline = decline; + selected = pointIndex; + } + } + return requiredDecline <= 0 || strongestDecline >= requiredDecline ? selected : -1; + } + + List rasterCenterline(List centerline) { + ArrayList raster = new ArrayList<>(); + for (int pointIndex = 0; pointIndex < centerline.size() - 1; pointIndex++) { + List span = rasterLine(centerline.get(pointIndex), centerline.get(pointIndex + 1)); + int first = raster.isEmpty() ? 0 : 1; + for (int spanIndex = first; spanIndex < span.size(); spanIndex++) { + raster.add(span.get(spanIndex)); + } + } + return List.copyOf(raster); + } + + List rasterLine(HydrologyPoint start, HydrologyPoint end) { + int steps = Math.max(Math.abs(end.x() - start.x()), Math.abs(end.z() - start.z())); + if (steps == 0) { + return List.of(start); + } + ArrayList points = new ArrayList<>(steps + 1); + for (int step = 0; step <= steps; step++) { + double progress = step / (double) steps; + int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); + int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); + points.add(new HydrologyPoint(x, start.y(), z)); + } + return List.copyOf(points); + } + + void appendOutletSegments( + RiverCourseType courseType, + long courseId, + HydrologyCoursePath path, + int head, + int[] widths, + int[] depths, + List segments + ) { + RiverOutlet outlet = path.outlet(); + int width = widths.length == 0 ? 1 : widths[widths.length - 1]; + int depth = depths.length == 0 ? 1 : depths[depths.length - 1]; + if (courseType != RiverCourseType.SURFACE + && outlet.type() == HydrologyFeatureType.INLAND_GROTTO) { + width = planner.settings.underground().minimumWidth(); + depth = planner.settings.underground().minimumDepth(); + } + HydrologyPoint pathEnd = HydrologyPlanner.withY(path.points().getLast(), head); + HydrologyPoint landward = HydrologyPlanner.withY(outlet.landwardPoint(), head); + if (courseType == RiverCourseType.SURFACE + && outlet.type() == HydrologyFeatureType.COASTAL_GROTTO) { + appendSurfaceCoastalGrotto( + courseId, + outlet, + head, + width, + depth, + pathEnd, + landward, + segments + ); + return; + } + if (outlet.type() == HydrologyFeatureType.MOUTH) { + if (courseType == RiverCourseType.SURFACE) { + appendSurfaceMouth(courseId, outlet, head, width, depth, pathEnd, segments); + return; + } + HydrologyPoint connection = HydrologyPlanner.withY(outlet.connectionPoint(), head); + addFlatSegment( + courseId, + HydrologyFeatureType.MOUTH, + head, + width, + depth, + line(pathEnd, connection, planner.settings.routing().refinementSpacing()), + segments + ); + return; + } + if (courseType == RiverCourseType.SURFACE && surfaceSinkhole(outlet)) { + appendSurfaceSinkhole(courseId, outlet, head, width, depth, pathEnd, landward, segments); + return; + } + HydrologyPoint connection = HydrologyPlanner.withY(outlet.connectionPoint(), head); + if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { + HydrologyFeatureType connectorType = courseType == RiverCourseType.SURFACE + ? HydrologyFeatureType.MOUTH + : HydrologyFeatureType.UNDERGROUND_POOL; + addFlatSegment( + courseId, + connectorType, + head, + width, + depth, + line(pathEnd, landward, planner.settings.routing().refinementSpacing()), + segments + ); + } + List centerline = landward.x() == connection.x() && landward.z() == connection.z() + ? List.of(landward) + : List.of(landward, connection); + addFlatSegment(courseId, outlet.type(), head, width, depth, centerline, segments); + } + + void appendSurfaceMouth( + long courseId, + RiverOutlet outlet, + int surfaceHead, + int width, + int depth, + HydrologyPoint pathEnd, + List segments + ) { + int seaLevel = outletHead(outlet); + HydrologyPoint connection = HydrologyPlanner.withY(outlet.connectionPoint(), seaLevel); + if (surfaceHead != seaLevel) { + throw new IllegalStateException("A surface mouth reached the coastal crossing above sea level."); + } + addFlatSegment( + courseId, + HydrologyFeatureType.MOUTH, + seaLevel, + width, + depth, + line(pathEnd, connection, planner.settings.routing().refinementSpacing()), + segments + ); + } + + void appendSurfaceCoastalGrotto( + long courseId, + RiverOutlet outlet, + int surfaceHead, + int width, + int depth, + HydrologyPoint pathEnd, + HydrologyPoint landward, + List segments + ) { + if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { + addFlatSegment( + courseId, + HydrologyFeatureType.SURFACE_POOL, + surfaceHead, + width, + depth, + line(pathEnd, landward, planner.settings.routing().refinementSpacing()), + segments + ); + } + int seaLevel = outletHead(outlet); + HydrologyPoint connection = HydrologyPlanner.withY(outlet.connectionPoint(), seaLevel); + if (surfaceHead > seaLevel) { + addFallingDropSegments( + courseId, + segments.size(), + surfaceHead, + seaLevel, + width, + depth, + List.of(landward, connection), + true, + segments + ); + } + addFlatSegment( + courseId, + HydrologyFeatureType.COASTAL_GROTTO, + seaLevel, + width, + depth, + List.of(HydrologyPlanner.withY(outlet.landwardPoint(), seaLevel), connection), + segments + ); + } + + void appendSurfaceSinkhole( + long courseId, + RiverOutlet outlet, + int surfaceHead, + int surfaceWidth, + int surfaceDepth, + HydrologyPoint pathEnd, + HydrologyPoint landward, + List segments + ) { + if (pathEnd.x() != landward.x() || pathEnd.z() != landward.z()) { + addFlatSegment( + courseId, + HydrologyFeatureType.SURFACE_POOL, + surfaceHead, + surfaceWidth, + surfaceDepth, + line(pathEnd, landward, planner.settings.routing().refinementSpacing()), + segments + ); + } + int undergroundHead = outletHead(outlet); + int throatWidth = Math.max(planner.settings.underground().minimumWidth(), surfaceWidth - 1); + int throatDepth = planner.settings.underground().minimumDepth(); + HydrologyPoint receiving = HydrologyPlanner.withY(outlet.connectionPoint(), undergroundHead); + List descent = sinkholeDescent( + courseId, + landward, + receiving, + surfaceHead - undergroundHead + ); + List gradedDescent = gradedDropCenterline( + rasterCenterline(descent), + surfaceHead, + undergroundHead, + planner.settings.geometry().drops(), + planner.settings.geometry().drops().stepLimit(HydrologyFeatureType.SINKHOLE) + ); + int descentWidth = Math.max(throatWidth, hydraulicDropWidth(throatWidth, true)); + segments.add(new HydraulicSegment( + HydrologyHash.mix( + planner.worldSeed, + SEGMENT_SALT, + courseId, + segments.size(), + HydrologyFeatureType.SINKHOLE.ordinal() + ), + courseId, + HydrologyFeatureType.SINKHOLE, + surfaceHead, + undergroundHead, + descentWidth, + throatDepth, + false, + true, + gradedDescent + )); + addFlatSegment( + courseId, + HydrologyFeatureType.INLAND_GROTTO, + undergroundHead, + throatWidth, + throatDepth, + List.of(receiving), + segments + ); + } + + List sinkholeDescent( + long courseId, + HydrologyPoint landward, + HydrologyPoint receiving, + int drop + ) { + int desiredRun = Math.max( + 4, + (int) StrictMath.ceil(drop / (double) planner.settings.geometry().drops().maximumCascadeStep()) + 1 + ); + double startX = landward.x() - receiving.x(); + double startZ = landward.z() - receiving.z(); + double startRadius = StrictMath.hypot(startX, startZ); + double startAngle = startRadius <= 0D + ? HydrologyHash.unit(HydrologyHash.mix(planner.worldSeed, courseId, SEGMENT_SALT)) * StrictMath.PI * 2D + : StrictMath.atan2(startZ, startX); + double maximumRadius = Math.max(2D, planner.settings.outlets().inlandGrotto().horizontalRadius() - 1D); + int turns = Math.max(1, (int) StrictMath.ceil(desiredRun / (StrictMath.PI * maximumRadius))); + ArrayList points = new ArrayList<>(desiredRun * 4 + 1); + int samples = desiredRun * 4; + for (int sample = 0; sample <= samples; sample++) { + double progress = sample / (double) samples; + double radius = Math.min( + maximumRadius, + startRadius * (1D - progress) + maximumRadius * StrictMath.sin(StrictMath.PI * progress) + ); + double angle = startAngle + turns * StrictMath.PI * 2D * progress; + int x = (int) StrictMath.round(receiving.x() + StrictMath.cos(angle) * radius); + int z = (int) StrictMath.round(receiving.z() + StrictMath.sin(angle) * radius); + if (points.isEmpty() || points.getLast().x() != x || points.getLast().z() != z) { + points.add(new HydrologyPoint(x, landward.y(), z)); + } + } + if (points.getLast().x() != receiving.x() || points.getLast().z() != receiving.z()) { + points.add(receiving); + } + return List.copyOf(points); + } + + boolean surfaceSinkhole(RiverOutlet outlet) { + return outlet.type() == HydrologyFeatureType.INLAND_GROTTO + && planner.settings.outlets().surfaceSinkholesEnabled(); + } + + void addFlatSegment( + long courseId, + HydrologyFeatureType type, + int head, + int width, + int depth, + List centerline, + List segments + ) { + long segmentId = HydrologyHash.mix(planner.worldSeed, SEGMENT_SALT, courseId, segments.size(), type.ordinal()); + segments.add(new HydraulicSegment( + segmentId, + courseId, + type, + head, + head, + width, + depth, + false, + false, + centerline + )); + } + + double signedOrganicOffset(long stableId, long salt, double envelope) { + double unit = HydrologyHash.unit(HydrologyHash.mix(stableId, salt)); + double magnitude = envelope * (0.55D + unit * 0.45D); + return (HydrologyHash.mix(stableId, salt, 1L) & 1L) == 0L ? magnitude : -magnitude; + } + + List line(HydrologyPoint start, HydrologyPoint end, int spacing) { + double distance = StrictMath.hypot(end.x() - start.x(), end.z() - start.z()); + int steps = Math.max(1, (int) StrictMath.ceil(distance / spacing)); + ArrayList points = new ArrayList<>(steps + 1); + for (int step = 0; step <= steps; step++) { + double progress = step / (double) steps; + int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); + int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); + HydrologyPoint point = new HydrologyPoint(x, start.y(), z); + if (points.isEmpty() || point.x() != points.getLast().x() || point.z() != points.getLast().z()) { + points.add(point); + } + } + return List.copyOf(points); + } + + int scaledDimension( + int styledBase, + int minimum, + int maximum, + int discharge, + double multiplier + ) { + double flowScale = Math.min( + 1D, + StrictMath.log(discharge + 1D) / StrictMath.log(planner.settings.underground().wideningSources() + 1D) + ); + int base = styledBase + (int) StrictMath.round((maximum - styledBase) * flowScale); + return HydrologyPlanner.clamp((int) StrictMath.round(base * multiplier), minimum, maximum); + } + + int maximumSurfaceDischarge(List edges) { + int maximum = 1; + for (DrainageEdge edge : edges) { + maximum = Math.max(maximum, edge.contributingSurfaceSources()); + } + return maximum; + } + + int maximumUndergroundDischarge(List edges) { + int maximum = 1; + for (DrainageEdge edge : edges) { + maximum = Math.max(maximum, edge.contributingUndergroundSources()); + } + return maximum; + } + + String chooseProfile(HydrologyTerrainSample terrain, long courseId) { + List profiles = terrain.preferredProfileKeys(); + int index = HydrologyHash.between(HydrologyHash.mix(planner.worldSeed, courseId, HydrologyHash.text("profile")), 0, profiles.size() - 1); + return profiles.get(index); + } + + int outletHead(RiverOutlet outlet) { + return outlet.directOcean() ? outlet.seaLevel() : outlet.connectionPoint().y(); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySourcePlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySourcePlanner.java new file mode 100644 index 000000000..ef52cdaa0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySourcePlanner.java @@ -0,0 +1,913 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.PriorityQueue; +import java.util.function.IntPredicate; + +final class HydrologySourcePlanner { + private final HydrologyPlanner planner; + + HydrologySourcePlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + static final long EDGE_SALT = 0x45444745L; + static final long SURFACE_SOURCE_SALT = 0x53555246414345L; + static final long UNDERGROUND_SOURCE_SALT = 0x554e444552L; + static final long DIAGNOSTIC_SALT = 0x444941474e4f5354L; + static final int OPTIONAL_SOURCE_REJECTIONS_PER_TARGET = 4; + static final int SURFACE_OPTIONAL_SOURCE_REJECTIONS_PER_TARGET = 8; + + static final List ROUTING_OFFSETS = List.of( + new HydrologyGridOffset(-1, 0), + new HydrologyGridOffset(1, 0), + new HydrologyGridOffset(0, -1), + new HydrologyGridOffset(0, 1), + new HydrologyGridOffset(-1, -1), + new HydrologyGridOffset(-1, 1), + new HydrologyGridOffset(1, -1), + new HydrologyGridOffset(1, 1) + ); + + boolean hasRoutedSourceSearch() { + HydrologyPlannerSettings.Source surface = planner.settings.surface().sources(); + if (planner.settings.surface().enabled() && surface.enabled()) { + return true; + } + HydrologyPlannerSettings.Source underground = planner.settings.underground().sources(); + return planner.settings.underground().enabled() + && underground.enabled(); + } + + List uniqueDiagnostics( + List diagnostics + ) { + LinkedHashMap unique = new LinkedHashMap<>(); + for (HydrologyDiagnosticCandidate diagnostic : diagnostics) { + unique.putIfAbsent(diagnostic.id(), diagnostic); + } + return List.copyOf(unique.values()); + } + + HydrologyRoutingPlan buildRouting( + HydrologySampledGrid grid, + List outlets, + boolean surface + ) { + // A surface river never climbs: any rise along its route becomes a cut of at least that rise, + // so lattice edges that rise more than a small saddle are not drainage at all. + int maximumRise = surface ? maximumSurfaceEdgeRise() : Integer.MAX_VALUE; + int nodeCount = grid.nodes().size(); + double[] potential = new double[nodeCount]; + int[] parent = new int[nodeCount]; + int[] outletIndex = new int[nodeCount]; + int[] minimumNeighborHeights = new int[nodeCount]; + for (HydrologyGridNode node : grid.nodes()) { + minimumNeighborHeights[node.index()] = minimumNeighborHeight(grid, node); + } + Arrays.fill(potential, Double.POSITIVE_INFINITY); + Arrays.fill(parent, -1); + Arrays.fill(outletIndex, -1); + PriorityQueue queue = new PriorityQueue<>(); + for (int index = 0; index < outlets.size(); index++) { + OutletCandidate outlet = outlets.get(index); + potential[outlet.landIndex()] = 0D; + outletIndex[outlet.landIndex()] = index; + queue.add(new RoutingQueueEntry(outlet.landIndex(), 0D, index)); + } + while (!queue.isEmpty()) { + RoutingQueueEntry currentEntry = queue.poll(); + if (currentEntry.potential() != potential[currentEntry.nodeIndex()] + || currentEntry.outletIndex() != outletIndex[currentEntry.nodeIndex()]) { + continue; + } + HydrologyGridNode downstream = grid.node(currentEntry.nodeIndex()); + for (HydrologyGridOffset offset : ROUTING_OFFSETS) { + HydrologyGridNode upstream = grid.nodeAt(downstream.gridX() + offset.x(), downstream.gridZ() + offset.z()); + if (upstream == null || upstream.terrain().ocean() || !upstream.terrain().transitAllowed() + || !upstream.terrain().drainsInto(downstream.terrain())) { + // Confined ground only drains into its own area, so every course that starts or + // arrives there keeps to that area up to and including its outlet. + continue; + } + if (downstream.terrain().naturalHeight() - upstream.terrain().naturalHeight() > maximumRise) { + continue; + } + double edgeCost = routeCost( + upstream, + downstream, + offset, + minimumNeighborHeights[downstream.index()] + ); + double candidatePotential = currentEntry.potential() + edgeCost; + int existingParent = parent[upstream.index()]; + boolean replace = candidatePotential < potential[upstream.index()] - 1.0E-9D; + if (!replace && StrictMath.abs(candidatePotential - potential[upstream.index()]) <= 1.0E-9D) { + replace = existingParent < 0 || downstream.id() < grid.node(existingParent).id(); + } + if (!replace) { + continue; + } + potential[upstream.index()] = candidatePotential; + parent[upstream.index()] = downstream.index(); + outletIndex[upstream.index()] = currentEntry.outletIndex(); + queue.add(new RoutingQueueEntry( + upstream.index(), + candidatePotential, + currentEntry.outletIndex() + )); + } + } + return new HydrologyRoutingPlan( + potential, + parent, + outletIndex, + routeLengths(parent, grid.width(), planner.settings.routing()), + List.copyOf(outlets), + false + ); + } + + /** + * Largest rise a surface drainage edge may take. Heads only fall, so a rise along a route becomes a cut + * of at least that rise; the lattice may climb no more than the cut the valley solver still accepts. + */ + int maximumSurfaceEdgeRise() { + int permitted = planner.settings.surface().maximumIncision() - planner.settings.surface().banks().sink() - planner.settings.surface().minimumDepth(); + return Math.max(1, permitted); + } + + HydrologyRoutingPlan requireOrganicSurface(HydrologyRoutingPlan routing) { + return new HydrologyRoutingPlan( + routing.potential(), + routing.parent(), + routing.outletIndex(), + routing.routeLengths(), + routing.outlets(), + true + ); + } + + int permittedSurfaceIncision(HydrologyTerrainSample terrain) { + return permittedSurfaceIncision( + planner.settings.surface().maximumIncision(), + terrain.incisionMultiplier() + ); + } + + static int permittedSurfaceIncision(int maximumIncision, double incisionMultiplier) { + return Math.min( + maximumIncision, + (int) StrictMath.floor(maximumIncision * incisionMultiplier) + ); + } + + double routeCost( + HydrologyGridNode upstream, + HydrologyGridNode downstream, + HydrologyGridOffset offset, + int valleyFloor + ) { + HydrologyPlannerSettings.Routing routing = planner.settings.routing(); + double baseDistance = routing.sampleSpacing() * (offset.x() != 0 && offset.z() != 0 ? StrictMath.sqrt(2D) : 1D); + double downstreamRise = Math.max(0D, downstream.terrain().naturalHeight() - upstream.terrain().naturalHeight()); + double valleyCost = Math.max(0D, downstream.terrain().naturalHeight() - valleyFloor) * routing.valleyPreference(); + double policyCost = upstream.terrain().routingCost() + downstream.terrain().routingCost(); + double policyMultiplier = Math.max(0.01D, + (upstream.terrain().routingMultiplier() + downstream.terrain().routingMultiplier()) * 0.5D); + double slopeCost = (upstream.terrain().slope() + downstream.terrain().slope()) + * 0.5D * routing.slopePenalty(); + double attractionDiscount = routing.confluenceAttraction() + * Math.max(0D, upstream.terrain().naturalHeight() - downstream.terrain().naturalHeight()); + return Math.max(0.001D, + (baseDistance + downstreamRise * routing.uphillPenalty() + valleyCost + slopeCost + policyCost) + * policyMultiplier - attractionDiscount); + } + + int minimumNeighborHeight(HydrologySampledGrid grid, HydrologyGridNode node) { + int minimum = node.terrain().naturalHeight(); + for (HydrologyGridOffset offset : ROUTING_OFFSETS) { + HydrologyGridNode neighbor = grid.nodeAt(node.gridX() + offset.x(), node.gridZ() + offset.z()); + if (neighbor != null && !neighbor.terrain().ocean()) { + minimum = Math.min(minimum, neighbor.terrain().naturalHeight()); + } + } + return minimum; + } + + SourceSelection selectSources( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + boolean surface, + boolean enforceGlobalSpacing, + List diagnostics, + Map routingContexts + ) { + HydrologyPlannerSettings.Source sourceSettings = surface + ? planner.settings.surface().sources() + : planner.settings.underground().sources(); + if (!sourceSettings.enabled()) { + return SourceSelection.empty(surface); + } + long sourceSalt = surface ? SURFACE_SOURCE_SALT : UNDERGROUND_SOURCE_SALT; + ArrayList candidates = new ArrayList<>(); + boolean hasRequiredCandidate = false; + for (HydrologyGridNode node : grid.nodes()) { + if (!grid.owns(node.x(), node.z())) { + continue; + } + HydrologyTerrainSample terrain = node.terrain(); + boolean allowed = surface ? terrain.surfaceSourceAllowed() : terrain.undergroundSourceAllowed(); + boolean required = surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(); + if (!allowed || surface && terrain.naturalHeight() < sourceSettings.minimumElevation()) { + continue; + } + double weight = surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(); + if (weight <= 0D && !required) { + continue; + } + long stable = sourceStableId(sourceSalt, node.x(), node.z()); + if (routing.outlets().isEmpty()) { + addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.NO_LEGAL_OUTLET, diagnostics); + continue; + } + if (!Double.isFinite(routing.potential()[node.index()]) || routing.parent()[node.index()] < 0) { + addSourceDiagnostic(node, surface, stable, terrain.confinesKey() != null + ? HydrologyCandidateRejection.CONFINED_NO_OUTLET + : HydrologyCandidateRejection.NO_DRAINAGE_PATH, diagnostics); + continue; + } + if (!sourceOutletAllowed(node, routing, surface)) { + addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.NO_LEGAL_OUTLET, diagnostics); + continue; + } + if (!surface && planner.settings.underground().connectToExistingCaves() && !terrain.caveAvailable()) { + addSourceDiagnostic(node, false, stable, HydrologyCandidateRejection.CAVE_CONTAINMENT, diagnostics); + continue; + } + int routeLength = routing.routeLengths()[node.index()]; + if (routeLength <= 0 || routeLength > planner.settings.routing().maximumRouteLength()) { + addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.ROUTE_LIMIT, diagnostics); + continue; + } + if (routeLength < planner.settings.routing().minimumCourseLength(surface)) { + addSourceDiagnostic(node, surface, stable, HydrologyCandidateRejection.COURSE_TOO_SHORT, diagnostics); + continue; + } + // Elevation and route length share the same scale: 1000 route blocks count as 100 blocks of height. + double score = (required ? 1.0E15D : 0D) + + weight * 1.0E9D + + (terrain.naturalHeight() + routeLength * 0.1D * planner.settings.routing().lengthPreference()) * 1.0E5D + + routing.potential()[node.index()] + + HydrologyHash.unit(stable); + candidates.add(new SourceCandidate(node.index(), stable, score, required)); + hasRequiredCandidate |= required; + } + int target = expectedCount(sourceSettings.density(), HydrologyHash.mix( + planner.worldSeed, + sourceSalt, + key.tileX(), + key.tileZ() + )); + int requiredMinimum = hasRequiredCandidate + ? Math.max(1, sourceSettings.minimumPerTile()) + : 0; + target = Math.max(requiredMinimum, target); + int maximum = hasRequiredCandidate + ? Math.max(1, sourceSettings.maximumPerTile()) + : sourceSettings.maximumPerTile(); + target = Math.min(maximum, target); + int tributaries = surface ? planner.settings.routing().tributaries() : planner.settings.underground().tributaries(); + int coursesPerOutlet = 1 + tributaries; + // Tributaries are budgeted on top of the source density: every outlet may draw its extra courses + // beyond the tile's expected count, or no junction would ever fit inside a one-source budget. + int tributaryBudget = Math.multiplyExact(routing.outlets().size(), tributaries); + target = Math.min(Math.addExact(maximum, tributaryBudget), Math.addExact(target, tributaryBudget)); + target = effectiveSourceTarget(surface && !enforceGlobalSpacing, target, routing.outlets().size(), coursesPerOutlet); + Comparator candidateOrder = Comparator + .comparing(SourceCandidate::required) + .reversed(); + candidates.sort(candidateOrder + .thenComparing(Comparator.comparingDouble(SourceCandidate::score).reversed()) + .thenComparingLong(SourceCandidate::stableId)); + prioritizeInlandSource(candidates, routing); + int guaranteed = Math.min(target, requiredMinimum); + int maximumCoursesPerOutlet = coursesPerOutlet; + SourceAdmissionSelection admission = selectSourceAdmissionsByOutlet( + candidates, + routing, + target, + guaranteed, + maximumCoursesPerOutlet, + (int candidateIndex) -> { + if (!enforceGlobalSpacing) { + return true; + } + SourceCandidate candidate = candidates.get(candidateIndex); + return globallyAdmittedSource( + grid.node(candidate.nodeIndex()), + sourceSettings, + sourceSalt, + surface, + routingContexts + ); + } + ); + int rejectionsPerTarget = surface + ? SURFACE_OPTIONAL_SOURCE_REJECTIONS_PER_TARGET + : OPTIONAL_SOURCE_REJECTIONS_PER_TARGET; + int maximumOptionalRejections = Math.max( + rejectionsPerTarget, + target * rejectionsPerTarget + ); + int admittedGuaranteed = Math.min(guaranteed, admission.selectedCandidateIndices().size()); + return new SourceSelection( + surface, + candidates, + admission, + admittedGuaranteed, + maximumOptionalRejections + ); + } + + static int effectiveSourceTarget(boolean outletBounded, int requestedTarget, int outletCount) { + return effectiveSourceTarget(outletBounded, requestedTarget, outletCount, 1); + } + + static int effectiveSourceTarget(boolean outletBounded, int requestedTarget, int outletCount, int coursesPerOutlet) { + if (requestedTarget < 0 || outletCount < 0 || coursesPerOutlet < 1) { + throw new IllegalArgumentException("Source target bounds cannot be negative."); + } + long bound = (long) outletCount * coursesPerOutlet; + return outletBounded ? (int) Math.min(requestedTarget, bound) : requestedTarget; + } + + SourceAdmissionSelection selectSourceAdmissionsByOutlet( + List candidates, + HydrologyRoutingPlan routing, + int target, + int guaranteed, + int maximumCoursesPerOutlet, + IntPredicate globallyAdmitted + ) { + int candidateCount = candidates.size(); + ArrayList selected = new ArrayList<>(Math.min(candidateCount, target)); + boolean[] selectedCandidates = new boolean[candidateCount]; + boolean[] spacingRejectedCandidates = new boolean[candidateCount]; + boolean[] evaluatedCandidates = new boolean[candidateCount]; + int[] outletIndices = new int[candidateCount]; + HashMap selectedByOutlet = new HashMap<>(); + for (int candidateIndex = 0; candidateIndex < candidateCount; candidateIndex++) { + outletIndices[candidateIndex] = routing.outletIndex()[candidates.get(candidateIndex).nodeIndex()]; + } + for (int candidateIndex = 0; + candidateIndex < candidateCount && selected.size() < target; + candidateIndex++) { + int outletIndex = outletIndices[candidateIndex]; + if (selectedByOutlet.getOrDefault(outletIndex, 0) >= maximumCoursesPerOutlet) { + continue; + } + evaluatedCandidates[candidateIndex] = true; + if (!globallyAdmitted.test(candidateIndex)) { + spacingRejectedCandidates[candidateIndex] = true; + continue; + } + selected.add(candidateIndex); + selectedCandidates[candidateIndex] = true; + selectedByOutlet.merge(outletIndex, 1, Math::addExact); + } + for (int candidateIndex = 0; + candidateIndex < candidateCount && selected.size() < guaranteed; + candidateIndex++) { + if (selectedCandidates[candidateIndex]) { + continue; + } + int outletIndex = outletIndices[candidateIndex]; + if (selectedByOutlet.getOrDefault(outletIndex, 0) >= maximumCoursesPerOutlet) { + continue; + } + selected.add(candidateIndex); + selectedCandidates[candidateIndex] = true; + spacingRejectedCandidates[candidateIndex] = false; + selectedByOutlet.merge(outletIndex, 1, Math::addExact); + } + return new SourceAdmissionSelection( + target, + selected, + selectedCandidates, + spacingRejectedCandidates, + evaluatedCandidates, + globallyAdmitted, + outletIndices, + maximumCoursesPerOutlet + ); + } + + void prioritizeInlandSource(List candidates, HydrologyRoutingPlan routing) { + if (candidates.size() < 2) { + return; + } + boolean required = candidates.getFirst().required(); + for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { + SourceCandidate candidate = candidates.get(candidateIndex); + if (candidate.required() != required) { + break; + } + if (!isInlandSource(candidate, routing)) { + continue; + } + if (candidateIndex > 0) { + candidates.addFirst(candidates.remove(candidateIndex)); + } + return; + } + } + + boolean isInlandSource(SourceCandidate candidate, HydrologyRoutingPlan routing) { + if (candidate == null) { + return false; + } + int outletIndex = routing.outletIndex()[candidate.nodeIndex()]; + return outletIndex >= 0 + && routing.outlets().get(outletIndex).outlet().type() == HydrologyFeatureType.INLAND_GROTTO; + } + + static SourceAdmissionSelection selectSourceAdmissions( + int candidateCount, + int target, + int guaranteed, + IntPredicate globallyAdmitted + ) { + if (candidateCount < 0 || target < 0 || guaranteed < 0 || guaranteed > target) { + throw new IllegalArgumentException("Source admission bounds are invalid."); + } + Objects.requireNonNull(globallyAdmitted, "globallyAdmitted"); + ArrayList selected = new ArrayList<>(Math.min(candidateCount, target)); + boolean[] selectedCandidates = new boolean[candidateCount]; + boolean[] spacingRejectedCandidates = new boolean[candidateCount]; + boolean[] evaluatedCandidates = new boolean[candidateCount]; + for (int candidateIndex = 0; + candidateIndex < candidateCount && selected.size() < target; + candidateIndex++) { + evaluatedCandidates[candidateIndex] = true; + if (!globallyAdmitted.test(candidateIndex)) { + spacingRejectedCandidates[candidateIndex] = true; + continue; + } + selected.add(candidateIndex); + selectedCandidates[candidateIndex] = true; + } + for (int candidateIndex = 0; + candidateIndex < candidateCount && selected.size() < guaranteed; + candidateIndex++) { + if (selectedCandidates[candidateIndex]) { + continue; + } + selected.add(candidateIndex); + selectedCandidates[candidateIndex] = true; + spacingRejectedCandidates[candidateIndex] = false; + } + return new SourceAdmissionSelection( + target, + selected, + selectedCandidates, + spacingRejectedCandidates, + evaluatedCandidates, + globallyAdmitted, + new int[candidateCount], + Integer.MAX_VALUE + ); + } + + boolean globallyAdmittedSource( + HydrologyGridNode candidate, + HydrologyPlannerSettings.Source sourceSettings, + long sourceSalt, + boolean surface, + Map routingContexts + ) { + int minimumSpacing = sourceSettings.minimumSpacing(); + boolean required = surface + ? candidate.terrain().surfaceSourceRequired() + : candidate.terrain().undergroundSourceRequired(); + if (minimumSpacing <= 0 || required) { + return true; + } + SourcePriority candidatePriority = sourcePriority(candidate.x(), candidate.z(), candidate.terrain(), sourceSalt, surface); + int sampleSpacing = planner.settings.routing().sampleSpacing(); + int latticeRadius = (int) StrictMath.ceil(minimumSpacing / (double) sampleSpacing); + for (int offsetZ = -latticeRadius; offsetZ <= latticeRadius; offsetZ++) { + for (int offsetX = -latticeRadius; offsetX <= latticeRadius; offsetX++) { + if (offsetX == 0 && offsetZ == 0) { + continue; + } + long deltaX = (long) offsetX * sampleSpacing; + long deltaZ = (long) offsetZ * sampleSpacing; + if (StrictMath.hypot(deltaX, deltaZ) >= minimumSpacing) { + continue; + } + long neighborX = (long) candidate.x() + deltaX; + long neighborZ = (long) candidate.z() + deltaZ; + if (neighborX < Integer.MIN_VALUE || neighborX > Integer.MAX_VALUE + || neighborZ < Integer.MIN_VALUE || neighborZ > Integer.MAX_VALUE) { + continue; + } + int x = (int) neighborX; + int z = (int) neighborZ; + HydrologyTileKey owner = HydrologyTileKey.fromBlock(x, z, planner.settings.routing().tileSize()); + SourceRoutingContext context = routingContexts.computeIfAbsent(owner, planner::sourceRoutingContext); + HydrologyGridNode neighbor = context.grid().nodeAtWorld(x, z); + if (neighbor == null) { + throw new IllegalStateException("Source coordinate is absent from its owner routing lattice."); + } + HydrologyTerrainSample terrain = neighbor.terrain(); + if (!rawSourceEligible(terrain, sourceSettings, surface)) { + continue; + } + if (!routeViable(neighbor, context, surface)) { + continue; + } + SourcePriority neighborPriority = sourcePriority(x, z, terrain, sourceSalt, surface); + if (compareSourcePriority(neighborPriority, candidatePriority) > 0) { + return false; + } + } + } + return true; + } + + SourceRoutingContext compileSourceRoutingContext(HydrologyTileKey key) { + HydrologySampledGrid grid = planner.outletPlanner.sample(key); + ArrayList diagnostics = new ArrayList<>(); + List surfaceOutlets = planner.outletPlanner.resolveOutlets(key, grid, true, diagnostics); + HydrologyRoutingPlan surfaceRouting = buildRouting(grid, surfaceOutlets, true); + List undergroundOutlets = planner.settings.underground().enabled() + ? planner.outletPlanner.resolveOutlets(key, grid, false, diagnostics) + : surfaceOutlets; + HydrologyRoutingPlan undergroundRouting = planner.settings.underground().enabled() + ? buildRouting(grid, undergroundOutlets, false) + : surfaceRouting; + return new SourceRoutingContext( + grid, + surfaceRouting, + undergroundRouting, + List.copyOf(diagnostics) + ); + } + + boolean routeViable(HydrologyGridNode node, SourceRoutingContext context, boolean surface) { + HydrologyRoutingPlan routing = context.routing(surface); + if (routing.outlets().isEmpty() + || !Double.isFinite(routing.potential()[node.index()]) + || routing.parent()[node.index()] < 0 + || !sourceOutletAllowed(node, routing, surface)) { + return false; + } + int routeLength = routing.routeLengths()[node.index()]; + return routeLength >= planner.settings.routing().minimumCourseLength(surface) + && routeLength <= planner.settings.routing().maximumRouteLength(); + } + + boolean sourceOutletAllowed(HydrologyGridNode node, HydrologyRoutingPlan routing, boolean surface) { + int outletIndex = routing.outletIndex()[node.index()]; + if (outletIndex < 0 || outletIndex >= routing.outlets().size()) { + return false; + } + RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); + return !surface + || outlet.type() != HydrologyFeatureType.INLAND_GROTTO + || planner.settings.outlets().surfaceSinkholesEnabled(); + } + + boolean rawSourceEligible( + HydrologyTerrainSample terrain, + HydrologyPlannerSettings.Source sourceSettings, + boolean surface + ) { + if (terrain.ocean() || !terrain.transitAllowed()) { + return false; + } + boolean allowed = surface ? terrain.surfaceSourceAllowed() : terrain.undergroundSourceAllowed(); + boolean required = surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(); + if (!allowed || surface && terrain.naturalHeight() < sourceSettings.minimumElevation()) { + return false; + } + if (!surface && planner.settings.underground().connectToExistingCaves() && !terrain.caveAvailable()) { + return false; + } + double weight = surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(); + return required || weight > 0D; + } + + SourcePriority sourcePriority( + int x, + int z, + HydrologyTerrainSample terrain, + long sourceSalt, + boolean surface + ) { + return new SourcePriority( + surface ? terrain.surfaceSourceRequired() : terrain.undergroundSourceRequired(), + surface ? terrain.surfaceSourceWeight() : terrain.undergroundSourceWeight(), + terrain.naturalHeight(), + sourceStableId(sourceSalt, x, z), + x, + z + ); + } + + long sourceStableId(long sourceSalt, int x, int z) { + return HydrologyHash.mix(planner.worldSeed, sourceSalt, x, z); + } + + int compareSourcePriority(SourcePriority first, SourcePriority second) { + int requiredComparison = Boolean.compare(first.required(), second.required()); + if (requiredComparison != 0) { + return requiredComparison; + } + int weightComparison = Double.compare(first.weight(), second.weight()); + if (weightComparison != 0) { + return weightComparison; + } + int stableComparison = Long.compareUnsigned(first.stableId(), second.stableId()); + if (stableComparison != 0) { + return stableComparison; + } + int heightComparison = Integer.compare(first.naturalHeight(), second.naturalHeight()); + if (heightComparison != 0) { + return heightComparison; + } + int xComparison = Integer.compare(first.x(), second.x()); + return xComparison != 0 ? xComparison : Integer.compare(first.z(), second.z()); + } + + static void addSourceDiagnostic( + HydrologyGridNode node, + boolean surface, + long stableId, + HydrologyCandidateRejection rejection, + List diagnostics + ) { + int y = surface ? node.terrain().naturalHeight() : node.terrain().caveFluidY(); + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(stableId, DIAGNOSTIC_SALT, rejection.ordinal()), + HydrologyCandidateKind.SOURCE, + surface ? HydrologyFeatureType.SURFACE_POOL : HydrologyFeatureType.UNDERGROUND_POOL, + new HydrologyPoint(node.x(), y, node.z()), + rejection, 0 + )); + } + + int expectedCount(double density, long stable) { + int count = (int) StrictMath.floor(density); + double remainder = density - count; + return count + (HydrologyHash.unit(stable) < remainder ? 1 : 0); + } + + static int[] routeLengths(int[] parent, int width, HydrologyPlannerSettings.Routing routing) { + int[] lengths = new int[parent.length]; + int[] pending = new int[parent.length]; + double[] distances = new double[parent.length]; + Arrays.fill(distances, Double.NaN); + double diagonalDistance = StrictMath.hypot(routing.sampleSpacing(), routing.sampleSpacing()); + for (int sourceIndex = 0; sourceIndex < parent.length; sourceIndex++) { + if (!Double.isNaN(distances[sourceIndex])) { + continue; + } + int current = sourceIndex; + int pendingCount = 0; + while (current >= 0 && Double.isNaN(distances[current])) { + pending[pendingCount++] = current; + distances[current] = -1D; + current = parent[current]; + } + if (current >= 0 && distances[current] < 0D) { + throw new IllegalStateException("Hydrology drainage routing contains a cycle."); + } + double distance = current < 0 ? 0D : distances[current]; + while (pendingCount > 0) { + int node = pending[--pendingCount]; + int next = parent[node]; + if (next >= 0) { + boolean cardinal = node / width == next / width || node % width == next % width; + distance += cardinal ? routing.sampleSpacing() : diagonalDistance; + } + distances[node] = distance; + lengths[node] = distance > routing.maximumRouteLength() + ? Integer.MAX_VALUE + : (int) StrictMath.ceil(distance); + } + } + return lengths; + } + + int[] countContributions(List sources, HydrologyRoutingPlan routing) { + int[] counts = new int[routing.parent().length]; + for (int source : sources) { + int current = source; + int steps = 0; + while (routing.parent()[current] >= 0 && steps++ < planner.settings.routing().maximumRouteNodes()) { + counts[current]++; + current = routing.parent()[current]; + } + } + return counts; + } + + CompiledGraph compileGraph( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + int[] surfaceContributions, + int[] undergroundContributions, + Map> refinedEdges + ) { + HashSet includedNodeIndices = new HashSet<>(); + ArrayList edges = new ArrayList<>(); + HashMap edgeByUpstream = new HashMap<>(); + for (HydrologyGridNode upstream : grid.nodes()) { + int downstreamIndex = routing.parent()[upstream.index()]; + if (downstreamIndex < 0 || !Double.isFinite(routing.potential()[upstream.index()])) { + continue; + } + boolean acceptedCourseEdge = surfaceContributions[upstream.index()] > 0 + || undergroundContributions[upstream.index()] > 0; + if (!acceptedCourseEdge) { + continue; + } + HydrologyGridNode downstream = grid.node(downstreamIndex); + RiverOutlet outlet = routing.outlets().get(routing.outletIndex()[upstream.index()]).outlet(); + long edgeId = HydrologyHash.mix(planner.worldSeed, EDGE_SALT, upstream.id(), downstream.id(), outlet.id()); + List centerline = refinedEdges.get(edgeId); + int transverseCandidates = HydrologyRouteGeometry.ROUTE_TRANSVERSE_CANDIDATES; + if (centerline == null) { + HydrologyPoint upstreamAnchor = planner.routeGeometry.routeAnchor(upstream); + HydrologyPoint downstreamAnchor = planner.routeGeometry.routeAnchor(downstream); + HydrologyPoint continuation = planner.routeGeometry.edgeContinuation(grid, routing, downstream, outlet); + RefinedEdgeKey refinedEdgeKey = new RefinedEdgeKey( + upstream.id(), + downstream.id(), + upstreamAnchor.x(), + upstreamAnchor.z(), + downstreamAnchor.x(), + downstreamAnchor.z(), + continuation.x(), + continuation.z(), + transverseCandidates + ); + centerline = planner.refinedEdgeCache.get( + refinedEdgeKey, + ignored -> planner.routeGeometry.refineEdge( + upstream.id(), + downstream.id(), + upstreamAnchor, + downstreamAnchor, + continuation, + transverseCandidates + ) + ); + refinedEdges.put(edgeId, centerline); + } + if (centerline.isEmpty()) { + HydrologyPoint upstreamAnchor = planner.routeGeometry.routeAnchor(upstream); + HydrologyPoint downstreamAnchor = planner.routeGeometry.routeAnchor(downstream); + HydrologyPoint continuation = planner.routeGeometry.edgeContinuation(grid, routing, downstream, outlet); + RefinedEdgeKey refinedEdgeKey = new RefinedEdgeKey( + upstream.id(), + downstream.id(), + upstreamAnchor.x(), + upstreamAnchor.z(), + downstreamAnchor.x(), + downstreamAnchor.z(), + continuation.x(), + continuation.z(), + HydrologyRouteGeometry.ROUTE_FALLBACK_TRANSVERSE_CANDIDATES + ); + centerline = planner.refinedEdgeCache.get( + refinedEdgeKey, + ignored -> planner.routeGeometry.refineEdge( + upstream.id(), + downstream.id(), + upstreamAnchor, + downstreamAnchor, + continuation, + HydrologyRouteGeometry.ROUTE_FALLBACK_TRANSVERSE_CANDIDATES + ) + ); + refinedEdges.put(edgeId, centerline); + } + if (centerline.isEmpty()) { + centerline = planner.routeGeometry.constrainedTerrainFallbackEdge( + planner.routeGeometry.routeAnchor(upstream), + planner.routeGeometry.routeAnchor(downstream) + ); + refinedEdges.put(edgeId, centerline); + } + if (centerline.isEmpty()) { + continue; + } + double cost = routing.potential()[upstream.index()] - routing.potential()[downstreamIndex]; + DrainageEdge edge = new DrainageEdge( + edgeId, + upstream.id(), + downstream.id(), + outlet.id(), + cost, + surfaceContributions[upstream.index()], + undergroundContributions[upstream.index()], + centerline + ); + edges.add(edge); + edgeByUpstream.put(upstream.index(), edge); + includedNodeIndices.add(upstream.index()); + includedNodeIndices.add(downstream.index()); + } + ArrayList nodes = new ArrayList<>(includedNodeIndices.size()); + for (HydrologyGridNode node : grid.nodes()) { + if (!includedNodeIndices.contains(node.index())) { + continue; + } + int outletIndex = routing.outletIndex()[node.index()]; + RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); + HydrologyPoint anchor = planner.routeGeometry.routeAnchor(node); + HydrologyTerrainSample terrain = Objects.requireNonNull( + planner.sampleLandBasis(anchor.x(), anchor.z()), + "Hydrology route anchor left natural land" + ); + nodes.add(new DrainageNode( + node.id(), + anchor.x(), + anchor.z(), + terrain, + routing.potential()[node.index()], + outlet.id() + )); + } + ArrayList outlets = new ArrayList<>(routing.outlets().size()); + for (OutletCandidate outletCandidate : routing.outlets()) { + outlets.add(outletCandidate.outlet()); + } + return new CompiledGraph(List.copyOf(nodes), List.copyOf(edges), List.copyOf(outlets), Map.copyOf(edgeByUpstream)); + } + + CompiledGraph mergeGraphs(CompiledGraph first, CompiledGraph second) { + LinkedHashMap nodes = new LinkedHashMap<>(); + for (DrainageNode node : first.nodes()) { + nodes.put(node.id(), node); + } + for (DrainageNode node : second.nodes()) { + nodes.putIfAbsent(node.id(), node); + } + LinkedHashMap edges = new LinkedHashMap<>(); + for (DrainageEdge edge : first.edges()) { + edges.put(edge.id(), edge); + } + for (DrainageEdge edge : second.edges()) { + DrainageNode upstream = nodes.get(edge.upstreamNodeId()); + DrainageNode downstream = nodes.get(edge.downstreamNodeId()); + if (upstream != null + && downstream != null + && downstream.potential() < upstream.potential()) { + edges.putIfAbsent(edge.id(), edge); + } + } + LinkedHashMap outlets = new LinkedHashMap<>(); + for (RiverOutlet outlet : first.outlets()) { + outlets.put(outlet.id(), outlet); + } + for (RiverOutlet outlet : second.outlets()) { + outlets.putIfAbsent(outlet.id(), outlet); + } + HashMap edgeByUpstream = new HashMap<>(first.edgeByUpstream()); + for (Map.Entry entry : second.edgeByUpstream().entrySet()) { + if (entry.getValue().equals(edges.get(entry.getValue().id()))) { + edgeByUpstream.putIfAbsent(entry.getKey(), entry.getValue()); + } + } + return new CompiledGraph( + List.copyOf(nodes.values()), + List.copyOf(edges.values()), + List.copyOf(outlets.values()), + Map.copyOf(edgeByUpstream) + ); + } + + record SourcePriority( + boolean required, + double weight, + int naturalHeight, + long stableId, + int x, + int z + ) { + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySurfaceCoursePlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySurfaceCoursePlanner.java new file mode 100644 index 000000000..20db4d9de --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologySurfaceCoursePlanner.java @@ -0,0 +1,937 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.surface.SurfaceCourseResult; +import art.arcane.iris.engine.hydrology.surface.SurfaceTerminal; + +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Objects; +import java.util.OptionalLong; + +final class HydrologySurfaceCoursePlanner { + private final HydrologyPlanner planner; + + HydrologySurfaceCoursePlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + static final long COURSE_SALT = 0x434f55525345L; + static final double SURFACE_MAXIMUM_RENDERED_TURN_DEGREES = 50D; + static final double SURFACE_MAXIMUM_ISOLATED_TURN_DEGREES = 35D; + static final double SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES = 10D; + static final double SURFACE_MAXIMUM_P95_TURN_DEGREES = 35D; + static final double SURFACE_MAXIMUM_SINUOSITY = 1.45D; + static final double SURFACE_GRID_LOCK_TOLERANCE_DEGREES = 5D; + static final double SURFACE_MAXIMUM_GRID_LOCKED_FRACTION = 0.5D; + static final double SURFACE_MAXIMUM_GRID_LOCKED_RUN = 64D; + static final double SURFACE_MAXIMUM_WIDTH_SCALE = 1.18D; + + void compileSurfaceCourses( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + CompiledGraph graph, + List sources, + List courses, + List diagnostics + ) { + LinkedHashMap> draftsByOutlet = new LinkedHashMap<>(); + for (int source : sources) { + HydrologyGridNode sourceNode = grid.node(source); + long sourceCourseId = HydrologyHash.mix( + planner.worldSeed, + COURSE_SALT, + HydrologySourcePlanner.SURFACE_SOURCE_SALT, + sourceNode.id() + ); + HydrologyCoursePath path = coursePath(grid, routing, graph, source, true); + if (path == null) { + planner.undergroundCourses.addCompiledSourceDiagnostic( + sourceNode, + true, + sourceCourseId, + HydrologyCandidateRejection.NO_DRAINAGE_PATH, + diagnostics + ); + continue; + } + long courseId = HydrologyHash.mix(sourceCourseId, path.outlet().id()); + HydrologyPoint trunkPoint = path.points().getFirst(); + HydrologyTerrainSample trunkTerrain = Objects.requireNonNull( + planner.sampleDetailed(trunkPoint.x(), trunkPoint.z()), + "Hydrology surface trunk left sampled terrain" + ); + String profileKey = planner.segments.chooseProfile(trunkTerrain, path.outlet().id()); + draftsByOutlet.computeIfAbsent(path.outlet().id(), (Long ignored) -> new ArrayList<>()) + .add(new SurfaceCourseDraft(sourceNode, courseId, profileKey, path)); + } + for (ArrayList outletDrafts : draftsByOutlet.values()) { + outletDrafts.sort(Comparator + .comparingDouble((SurfaceCourseDraft draft) -> planner.tributaries.edgeLength( + draft.path().edges(), + draft.path().edges().size() + )) + .reversed() + .thenComparingLong(SurfaceCourseDraft::courseId)); + RiverCourse mainCourse = null; + HashMap mainRejections = new HashMap<>(); + int tributaries = 0; + for (SurfaceCourseDraft draft : outletDrafts) { + if (mainCourse != null && tributaries >= planner.settings.routing().tributaries()) { + break; + } + if (mainCourse == null) { + SurfaceCourseBuild candidate = buildSurfaceCourse( + draft.courseId(), + draft.profileKey(), + draft.source(), + draft.path() + ); + if (candidate.course() == null) { + mainRejections.put(draft.courseId(), candidate); + continue; + } + mainCourse = candidate.course(); + courses.add(mainCourse); + continue; + } + RiverCourse tributary = planner.tributaries.buildSurfaceTributary(draft, mainCourse, diagnostics); + if (tributary != null) { + courses.add(tributary); + tributaries++; + } + } + if (mainCourse == null) { + for (SurfaceCourseDraft draft : outletDrafts) { + SurfaceCourseBuild rejected = mainRejections.get(draft.courseId()); + planner.undergroundCourses.addCompiledSourceDiagnostic( + draft.source(), + true, + draft.courseId(), + rejected.rejection(), + rejected.rejectionDetail(), + diagnostics + ); + } + } + } + } + + SurfaceCourseBuild buildSurfaceCourse( + long courseId, + String profileKey, + HydrologyGridNode source, + HydrologyCoursePath initialPath + ) { + return buildSurfaceCourseAtPath(courseId, profileKey, source, initialPath); + } + + SurfaceCourseBuild buildSurfaceCourseAtPath( + long courseId, + String profileKey, + HydrologyGridNode source, + HydrologyCoursePath path + ) { + if (path.points().size() < 2) { + return SurfaceCourseBuild.rejected(HydrologyCandidateRejection.COURSE_TOO_SHORT, 0); + } + RiverOutlet outlet = path.outlet(); + boolean surfaceSinkhole = path.reachesOutlet() && planner.segments.surfaceSinkhole(outlet); + SurfaceTerminal terminal; + if (!path.reachesOutlet() || outlet.type() == HydrologyFeatureType.INLAND_GROTTO) { + terminal = SurfaceTerminal.SINKHOLE; + } else if (outlet.type() == HydrologyFeatureType.COASTAL_GROTTO) { + terminal = SurfaceTerminal.COASTAL_GROTTO; + } else { + terminal = SurfaceTerminal.OCEAN_MOUTH; + } + int outletHead = planner.segments.outletHead(outlet); + int terminalHead = surfaceSinkhole ? Math.addExact(outletHead, 1) : outletHead; + SurfaceCourseResult result = planner.surfaceCourseBuilder.build( + planner.worldSeed, + courseId, + profileKey, + path.points(), + terminal, + terminalHead + ); + if (!result.accepted()) { + return SurfaceCourseBuild.rejected(result.rejection(), result.rejectionDetail()); + } + ArrayList segments = new ArrayList<>(result.segments()); + if (path.reachesOutlet()) { + HydrologyCoursePath terminalPath = new HydrologyCoursePath( + List.of(result.pathEnd()), + path.pairEdges(), + path.edges(), + outlet, + true, + path.organicSurfaceRequired(), + null + ); + planner.segments.appendOutletSegments( + RiverCourseType.SURFACE, + courseId, + terminalPath, + result.lastHead(), + new int[] {result.lastWidth()}, + new int[] {result.lastDepth()}, + segments + ); + } + if (path.organicSurfaceRequired()) { + int shapeRejection = surfaceShapeRejection(path.points()); + if (shapeRejection != 0) { + return SurfaceCourseBuild.rejected(HydrologyCandidateRejection.SURFACE_SHAPE_UNSUPPORTED, shapeRejection); + } + } + int discharge = planner.segments.maximumSurfaceDischarge(path.edges()); + return SurfaceCourseBuild.accepted(new RiverCourse( + courseId, + RiverCourseType.SURFACE, + OptionalLong.of(source.id()), + OptionalLong.of(outlet.id()), + profileKey, + discharge, + path.edges(), + segments + )); + } + + /** 0 when the shape is organic; otherwise 1 too short, 2 too sinuous, 3 grid-locked, 4 sharp turns. */ + int surfaceShapeRejection(List routedCenterline) { + return surfaceShapeRejection(routedCenterline, false); + } + + /** + * As above; a tributary reach keeps the hard turn cap and the overall turn budget but may bend + * once where it leaves its own valley for the stem's, which a main river is not allowed to do. + */ + int surfaceShapeRejection(List routedCenterline, boolean tributary) { + List centerline = planner.routePaths.withoutDuplicateRoutePoints(routedCenterline); + if (centerline.size() < 3) { + return 1; + } + double routedLength = centerlineLength(centerline); + HydrologyPoint start = centerline.getFirst(); + HydrologyPoint end = centerline.getLast(); + double directLength = StrictMath.hypot(end.x() - start.x(), end.z() - start.z()); + if (directLength <= 0D + || routedLength / directLength > SURFACE_MAXIMUM_SINUOSITY) { + return 2; + } + List sampled = resampleRouteCenterline( + centerline, + Math.max(16D, planner.settings.routing().refinementSpacing() * 4D) + ); + double lockedLength = 0D; + double currentLockedRun = 0D; + double longestLockedRun = 0D; + for (int pointIndex = 1; pointIndex < sampled.size(); pointIndex++) { + HydrologyPoint previous = sampled.get(pointIndex - 1); + HydrologyPoint point = sampled.get(pointIndex); + double deltaX = point.x() - previous.x(); + double deltaZ = point.z() - previous.z(); + double length = StrictMath.hypot(deltaX, deltaZ); + if (length <= 0D) { + continue; + } + double angle = StrictMath.toDegrees(StrictMath.atan2(deltaZ, deltaX)); + double remainder = Math.floorMod( + (int) StrictMath.round(angle * 1_000_000D), + 45_000_000 + ) / 1_000_000D; + double gridDistance = Math.min(remainder, 45D - remainder); + if (gridDistance <= SURFACE_GRID_LOCK_TOLERANCE_DEGREES) { + lockedLength += length; + currentLockedRun += length; + longestLockedRun = Math.max(longestLockedRun, currentLockedRun); + } else { + currentLockedRun = 0D; + } + } + if (routedLength >= 96D + && (lockedLength / routedLength > SURFACE_MAXIMUM_GRID_LOCKED_FRACTION + || longestLockedRun > SURFACE_MAXIMUM_GRID_LOCKED_RUN)) { + return 3; + } + ArrayList turnAngles = new ArrayList<>(); + for (int pointIndex = 1; pointIndex < sampled.size() - 1; pointIndex++) { + double turn = HydrologyRoutePath.routeTurnDegrees( + sampled.get(pointIndex - 1), + sampled.get(pointIndex), + sampled.get(pointIndex + 1) + ); + if (turn > SURFACE_MAXIMUM_RENDERED_TURN_DEGREES) { + return 4; + } + turnAngles.add(turn); + } + if (turnAngles.isEmpty()) { + return 1; + } + for (int turnIndex = 0; turnIndex < turnAngles.size() && !tributary; turnIndex++) { + double turn = turnAngles.get(turnIndex); + double previous = turnIndex == 0 ? 0D : turnAngles.get(turnIndex - 1); + double next = turnIndex + 1 == turnAngles.size() ? 0D : turnAngles.get(turnIndex + 1); + if (turn > SURFACE_MAXIMUM_ISOLATED_TURN_DEGREES + && previous <= SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES + && next <= SURFACE_MAXIMUM_ISOLATED_NEIGHBOR_TURN_DEGREES) { + return 4; + } + } + turnAngles.sort(Double::compare); + int percentileIndex = (int) StrictMath.ceil(0.95D * turnAngles.size()) - 1; + double percentile = turnAngles.get( + Math.max(0, Math.min(percentileIndex, turnAngles.size() - 1)) + ); + if (percentile > (tributary ? SURFACE_MAXIMUM_RENDERED_TURN_DEGREES : SURFACE_MAXIMUM_P95_TURN_DEGREES)) { + return 4; + } + return 0; + } + + double centerlineLength(List points) { + double length = 0D; + for (int pointIndex = 1; pointIndex < points.size(); pointIndex++) { + HydrologyPoint previous = points.get(pointIndex - 1); + HydrologyPoint current = points.get(pointIndex); + length += StrictMath.hypot(current.x() - previous.x(), current.z() - previous.z()); + } + return length; + } + + List resampleRouteCenterline( + List points, + double spacing + ) { + double[] cumulative = new double[points.size()]; + for (int pointIndex = 1; pointIndex < points.size(); pointIndex++) { + HydrologyPoint previous = points.get(pointIndex - 1); + HydrologyPoint point = points.get(pointIndex); + cumulative[pointIndex] = cumulative[pointIndex - 1] + + StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); + } + double totalLength = cumulative[cumulative.length - 1]; + if (totalLength <= spacing) { + return points; + } + int samples = Math.max(2, (int) StrictMath.floor(totalLength / spacing)); + ArrayList sampled = new ArrayList<>(samples + 2); + int segmentIndex = 0; + for (double distance = 0D; distance < totalLength; distance += spacing) { + while (segmentIndex < points.size() - 2 + && cumulative[segmentIndex + 1] < distance) { + segmentIndex++; + } + HydrologyPoint start = points.get(segmentIndex); + HydrologyPoint end = points.get(segmentIndex + 1); + double segmentLength = cumulative[segmentIndex + 1] - cumulative[segmentIndex]; + double progress = segmentLength <= 0D + ? 0D + : (distance - cumulative[segmentIndex]) / segmentLength; + HydrologyPoint point = new HydrologyPoint( + (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress), + (int) StrictMath.round(start.y() + (end.y() - start.y()) * progress), + (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress) + ); + if (sampled.isEmpty() + || point.x() != sampled.getLast().x() + || point.z() != sampled.getLast().z()) { + sampled.add(point); + } + } + HydrologyPoint last = points.getLast(); + HydrologyPoint sampledLast = sampled.isEmpty() ? null : sampled.getLast(); + double remaining = sampledLast == null + ? Double.POSITIVE_INFINITY + : StrictMath.hypot(last.x() - sampledLast.x(), last.z() - sampledLast.z()); + if (remaining >= spacing * 0.5D) { + sampled.add(last); + } + return List.copyOf(sampled); + } + + HydrologyCoursePath coursePath( + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + CompiledGraph graph, + int sourceIndex, + boolean surface + ) { + ArrayList edges = new ArrayList<>(); + ArrayList guide = new ArrayList<>(); + ArrayList guideEdges = new ArrayList<>(); + int current = sourceIndex; + int steps = 0; + while (routing.parent()[current] >= 0) { + DrainageEdge edge = graph.edgeByUpstream().get(current); + if (edge == null) { + return null; + } + edges.add(edge); + int downstream = routing.parent()[current]; + if (surface) { + for (HydrologyPoint point : edge.centerline()) { + if (guide.isEmpty()) { + guide.add(point); + } else if (point.x() != guide.getLast().x() || point.z() != guide.getLast().z()) { + guide.add(point); + guideEdges.add(edge); + } + } + } + current = downstream; + if (++steps > planner.settings.routing().maximumRouteNodes()) { + return null; + } + } + int outletIndex = routing.outletIndex()[sourceIndex]; + if (outletIndex < 0 || edges.isEmpty()) { + return null; + } + RiverOutlet outlet = routing.outlets().get(outletIndex).outlet(); + if (!surface) { + return planner.undergroundCourses.undergroundCoursePath(edges, outlet); + } + if (guide.size() < 2 || guideEdges.size() != guide.size() - 1) { + return null; + } + ArrayList routedGuide = new ArrayList<>(guide); + ArrayList routedGuideEdges = new ArrayList<>(guideEdges); + HydrologyPoint landward = outlet.landwardPoint(); + HydrologyPoint guideEnd = routedGuide.getLast(); + boolean terminateAtSinkhole = planner.segments.surfaceSinkhole(outlet) + && (guideEnd.x() != landward.x() || guideEnd.z() != landward.z()); + if (terminateAtSinkhole) { + routedGuide.set(routedGuide.size() - 1, landward); + } + List surfaceGuide = planner.routePaths.withoutDuplicateRoutePoints(routedGuide); + long geometryId = HydrologyHash.mix( + planner.worldSeed, + COURSE_SALT, + HydrologySourcePlanner.SURFACE_SOURCE_SALT, + edges.getFirst().upstreamNodeId(), + outlet.id() + ); + Objects.requireNonNull(grid, "Surface course routing grid is required"); + HydrologyPlanner.PlanningSamples samples = planner.planningSamples.get(); + DraftProfile profile = planner.currentDraftProfile(); + profile.routeCalls++; + List points; + if (samples == null) { + profile.routeSolves++; + long solveStarted = System.nanoTime(); + points = surfaceCourseCenterline(grid, surfaceGuide, geometryId); + profile.routeSolveNanos += System.nanoTime() - solveStarted; + } else { + HashMap> routes = samples.surfaceRoutes.computeIfAbsent( + grid, ignored -> new HashMap<>() + ); + SurfaceRouteKey routeKey = new SurfaceRouteKey(surfaceGuide, geometryId); + points = routes.computeIfAbsent(routeKey, ignored -> { + profile.routeSolves++; + long solveStarted = System.nanoTime(); + List solved = surfaceCourseCenterline(grid, surfaceGuide, geometryId); + profile.routeSolveNanos += System.nanoTime() - solveStarted; + return solved; + }); + } + if (points.size() < 2) { + return null; + } + List pairEdges = mapCoursePairs(points, routedGuide, routedGuideEdges); + if (pairEdges.size() != points.size() - 1) { + return null; + } + return new HydrologyCoursePath( + points, + pairEdges, + List.copyOf(edges), + outlet, + true, + routing.organicSurfaceRequired(), + null + ); + } + + List surfaceCourseCenterline( + HydrologySampledGrid grid, + List guide, + long geometryId + ) { + if (guide.size() < 2) { + return List.of(); + } + int refinement = planner.settings.routing().refinementSpacing(); + List base = smoothSurfaceGuide(resampleSurfaceGuide(guide, refinement)); + List nominal = meanderSurfaceGuide(base, geometryId, refinement); + if (nominal.size() < 2) { + return List.of(); + } + ArrayList> layers = new ArrayList<>(nominal.size()); + int transverseCandidates = HydrologyRouteGeometry.SURFACE_COURSE_TRANSVERSE_CANDIDATES; + for (int pointIndex = 0; pointIndex < nominal.size(); pointIndex++) { + SurfaceCurvePoint point = nominal.get(pointIndex); + RouteDirection tangent = surfaceCurveTangent(nominal, pointIndex); + if (pointIndex == 0 || pointIndex == nominal.size() - 1) { + HydrologyPoint endpoint = pointIndex == 0 ? guide.getFirst() : guide.getLast(); + layers.add(List.of(planner.routeGeometry.routeEndpoint(endpoint, tangent))); + continue; + } + double progress = pointIndex / (double) (nominal.size() - 1); + SurfaceCurvePoint basePoint = base.get(pointIndex); + RoutePosition position = new RoutePosition( + point.x(), + point.z(), + basePoint.x(), + basePoint.z(), + tangent + ); + long candidateId = HydrologyHash.mix(geometryId, pointIndex); + List candidates = planner.routeGeometry.unresolvedSurfaceRouteCandidates( + grid, + geometryId, + candidateId, + position, + progress, + refinement, + transverseCandidates + ); + if (candidates.isEmpty()) { + return List.of(); + } + layers.add(candidates); + } + ArrayList> availableLayers = new ArrayList<>(layers); + double maximumTurn = Math.min( + HydrologyRouteGeometry.SURFACE_COURSE_MAXIMUM_TURN_DEGREES, + planner.settings.geometry().meanders().maximumTurnDegrees() + ); + while (true) { + RouteCandidate[] route = planner.routeGeometry.selectCurvatureAwareTerrainRoute( + availableLayers, + refinement, + maximumTurn, + HydrologyRouteGeometry.SURFACE_COURSE_TURN_COST + ); + if (route.length == 0) { + if (addExhaustedSurfaceRouteFallbacks( + grid, + availableLayers, + nominal, + base, + geometryId + )) { + continue; + } + return List.of(); + } + int pitRemoval = planner.routePaths.removeTerrainPits(availableLayers, route); + if (pitRemoval < 0) { + return List.of(); + } + if (pitRemoval > 0) { + continue; + } + ArrayList points = new ArrayList<>(route.length); + for (RouteCandidate candidate : route) { + HydrologyPoint point = candidate.point(); + if (points.isEmpty() + || point.x() != points.getLast().x() + || point.z() != points.getLast().z()) { + points.add(point); + } + } + if (points.size() < 2 || !planner.routePaths.traversableRoute(points)) { + return List.of(); + } + return planner.routePaths.smoothTerrainRoute(points); + } + } + + boolean addExhaustedSurfaceRouteFallbacks( + HydrologySampledGrid grid, + List> layers, + List nominal, + List base, + long geometryId + ) { + boolean added = false; + for (int layerIndex = 1; layerIndex < layers.size() - 1; layerIndex++) { + List layer = layers.get(layerIndex); + if (!exhaustedSurfaceRouteLayer(layer)) { + continue; + } + SurfaceCurvePoint nominalPoint = nominal.get(layerIndex); + SurfaceCurvePoint basePoint = base.get(layerIndex); + RouteDirection tangent = surfaceCurveTangent(nominal, layerIndex); + int fallbackX = (int) StrictMath.round(basePoint.x()); + int fallbackZ = (int) StrictMath.round(basePoint.z()); + long packed = RiverFootprint.pack(fallbackX, fallbackZ); + boolean present = false; + for (RouteCandidate candidate : layer) { + if (RiverFootprint.pack(candidate.point().x(), candidate.point().z()) == packed) { + present = true; + break; + } + } + if (present) { + continue; + } + RouteTerrainEstimate estimate = planner.routeGeometry.routeTerrainEstimate(grid, fallbackX, fallbackZ); + double offset = (basePoint.x() - nominalPoint.x()) * -tangent.z() + + (basePoint.z() - nominalPoint.z()) * tangent.x(); + double localScore = estimate.terrainScore() + + StrictMath.abs(offset) * 0.18D + + HydrologyHash.unit(HydrologyHash.mix( + planner.worldSeed, + geometryId, + HydrologyHash.mix(geometryId, layerIndex), + fallbackX, + fallbackZ + )) * 1.0E-6D; + ArrayList expanded = new ArrayList<>(layer); + expanded.add(new RouteCandidate( + new HydrologyPoint(fallbackX, estimate.height(), fallbackZ), + offset, + localScore, + estimate.terrainScore(), + tangent, + false + )); + layers.set(layerIndex, List.copyOf(expanded)); + added = true; + } + return added; + } + + boolean exhaustedSurfaceRouteLayer(List layer) { + for (RouteCandidate candidate : layer) { + if (!candidate.terrainResolved() || Double.isFinite(candidate.localScore())) { + return false; + } + } + return true; + } + + double routeTurnScore(List route) { + List sampled = resampleRouteCenterline( + route, + Math.max(16D, planner.settings.routing().refinementSpacing() * 4D) + ); + if (sampled.size() < 3) { + return Double.POSITIVE_INFINITY; + } + ArrayList turns = new ArrayList<>(sampled.size() - 2); + double maximum = 0D; + for (int pointIndex = 1; pointIndex < sampled.size() - 1; pointIndex++) { + double turn = HydrologyRoutePath.routeTurnDegrees( + sampled.get(pointIndex - 1), + sampled.get(pointIndex), + sampled.get(pointIndex + 1) + ); + turns.add(turn); + maximum = Math.max(maximum, turn); + } + turns.sort(Double::compare); + int percentileIndex = (int) StrictMath.ceil(0.95D * turns.size()) - 1; + double percentile = turns.get(Math.max(0, Math.min(percentileIndex, turns.size() - 1))); + return percentile + maximum * 0.05D; + } + + double surfaceRouteCandidateBankPenalty(RouteCandidate candidate) { + int minimumBankDistance = surfaceBankDistance(planner.settings.surface().minimumWidth()); + int maximumBankDistance = surfaceBankDistance(planner.settings.surface().maximumWidth()); + int maximumBankRise = Math.addExact( + planner.settings.surface().maximumIncision(), + (int) StrictMath.ceil(planner.settings.surface().banks().minimumBlendWidth() * 0.5D) + ); + HydrologyPoint point = candidate.point(); + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + if (terrain == null) { + return Double.POSITIVE_INFINITY; + } + if (terrain.slope() >= planner.settings.hydraulics().waterfallMinimumDrop()) { + return 0D; + } + int head = Math.subtractExact( + terrain.naturalHeight(), + planner.settings.surface().banks().sink() + ); + return surfaceRouteBankPenalty( + point, + candidate.tangent(), + minimumBankDistance, + maximumBankDistance, + head, + maximumBankRise + ); + } + + double surfaceRouteBankPenalty( + HydrologyPoint point, + RouteDirection tangent, + int minimumDistance, + int maximumDistance, + int head, + int maximumBankRise + ) { + double penalty = 0D; + for (int distance = minimumDistance; distance <= maximumDistance; distance++) { + penalty += surfaceRouteBankPenalty(point, tangent, distance, head, maximumBankRise); + penalty += surfaceRouteBankPenalty(point, tangent, -distance, head, maximumBankRise); + } + return penalty; + } + + double surfaceRouteBankPenalty( + HydrologyPoint point, + RouteDirection tangent, + int signedDistance, + int head, + int maximumBankRise + ) { + HydrologyTerrainSample bank = surfaceBankTerrain(point, tangent, signedDistance); + if (bank == null) { + return 1.0E12D; + } + int rise = bank.naturalHeight() - head; + int shortfall = HydrologyRouteGeometry.SURFACE_MINIMUM_NATURAL_BANK_RISE - rise; + if (shortfall > 0) { + return (double) shortfall * shortfall * 4096D; + } + int excess = Math.max(0, rise - maximumBankRise); + return (double) excess * excess * 128D; + } + + int surfaceBankDistance(int width) { + int channelRadius = (int) StrictMath.ceil(width / 2D); + return Math.max( + channelRadius + 1, + (int) StrictMath.ceil( + channelRadius * SURFACE_MAXIMUM_WIDTH_SCALE + planner.settings.surface().shoreWidth() + ) + 1 + ); + } + + List resampleSurfaceGuide(List guide, int spacing) { + double[] cumulative = new double[guide.size()]; + for (int pointIndex = 1; pointIndex < guide.size(); pointIndex++) { + HydrologyPoint previous = guide.get(pointIndex - 1); + HydrologyPoint point = guide.get(pointIndex); + cumulative[pointIndex] = cumulative[pointIndex - 1] + + StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); + } + double totalLength = cumulative[cumulative.length - 1]; + if (totalLength <= 0D) { + return List.of(); + } + int capacity = Math.addExact(2, (int) StrictMath.ceil(totalLength / spacing)); + ArrayList sampled = new ArrayList<>(capacity); + int segmentIndex = 0; + for (double distance = 0D; distance < totalLength; distance += spacing) { + while (segmentIndex < guide.size() - 2 + && cumulative[segmentIndex + 1] < distance) { + segmentIndex++; + } + HydrologyPoint start = guide.get(segmentIndex); + HydrologyPoint end = guide.get(segmentIndex + 1); + double segmentLength = cumulative[segmentIndex + 1] - cumulative[segmentIndex]; + double progress = segmentLength <= 0D + ? 0D + : (distance - cumulative[segmentIndex]) / segmentLength; + sampled.add(new SurfaceCurvePoint( + start.x() + (end.x() - start.x()) * progress, + start.z() + (end.z() - start.z()) * progress, + distance + )); + } + HydrologyPoint end = guide.getLast(); + sampled.add(new SurfaceCurvePoint(end.x(), end.z(), totalLength)); + return List.copyOf(sampled); + } + + List smoothSurfaceGuide(List guide) { + if (guide.size() < 3) { + return guide; + } + List current = guide; + int passes = Math.max(2, planner.settings.geometry().meanders().smoothingPasses() + 1); + for (int pass = 0; pass < passes; pass++) { + ArrayList smoothed = new ArrayList<>(current.size()); + smoothed.add(current.getFirst()); + for (int pointIndex = 1; pointIndex < current.size() - 1; pointIndex++) { + SurfaceCurvePoint previous = current.get(pointIndex - 1); + SurfaceCurvePoint point = current.get(pointIndex); + SurfaceCurvePoint next = current.get(pointIndex + 1); + smoothed.add(new SurfaceCurvePoint( + previous.x() * 0.25D + point.x() * 0.5D + next.x() * 0.25D, + previous.z() * 0.25D + point.z() * 0.5D + next.z() * 0.25D, + point.distance() + )); + } + smoothed.add(current.getLast()); + current = List.copyOf(smoothed); + } + return current; + } + + List meanderSurfaceGuide( + List guide, + long geometryId, + int refinement + ) { + HydrologyPlannerSettings.Meanders meanders = planner.settings.geometry().meanders(); + double detailWeight = meanders.detailStrength() * 0.08D; + double totalWeight = meanders.primaryStrength() + detailWeight; + if (guide.size() < 3 || totalWeight <= 0D || meanders.maximumOffsetRatio() <= 0D) { + return guide; + } + double maximumOffset = planner.settings.routing().sampleSpacing() * Math.min( + 0.16D, + meanders.maximumOffsetRatio() * 0.32D + ); + double primaryPhase = HydrologyHash.unit(HydrologyHash.mix(geometryId, HydrologyRouteGeometry.ROUTE_WORM_PRIMARY_SALT)) + * StrictMath.PI * 2D; + double detailPhase = HydrologyHash.unit(HydrologyHash.mix(geometryId, HydrologyRouteGeometry.ROUTE_WORM_DETAIL_SALT)) + * StrictMath.PI * 2D; + double totalLength = guide.getLast().distance(); + double taperLength = Math.max( + refinement * 8D, + Math.min(planner.settings.routing().sampleSpacing() * 0.75D, meanders.primaryWavelength() * 0.35D) + ); + ArrayList meandered = new ArrayList<>(guide.size()); + for (int pointIndex = 0; pointIndex < guide.size(); pointIndex++) { + SurfaceCurvePoint point = guide.get(pointIndex); + RouteDirection tangent = surfaceCurveTangent(guide, pointIndex); + double endpointDistance = Math.min(point.distance(), totalLength - point.distance()); + double taperProgress = Math.min(1D, endpointDistance / taperLength); + double taper = StrictMath.pow(StrictMath.sin(taperProgress * StrictMath.PI * 0.5D), 2D); + double primary = StrictMath.sin( + point.distance() * StrictMath.PI * 2D / meanders.primaryWavelength() + primaryPhase + ) * meanders.primaryStrength(); + double detail = StrictMath.sin( + point.distance() * StrictMath.PI * 2D / meanders.detailWavelength() + detailPhase + ) * detailWeight; + double offset = maximumOffset * taper * (primary + detail) / totalWeight; + meandered.add(new SurfaceCurvePoint( + point.x() - tangent.z() * offset, + point.z() + tangent.x() * offset, + point.distance() + )); + } + return List.copyOf(meandered); + } + + RouteDirection surfaceCurveTangent(List points, int pointIndex) { + SurfaceCurvePoint start = points.get(Math.max(0, pointIndex - 2)); + SurfaceCurvePoint end = points.get(Math.min(points.size() - 1, pointIndex + 2)); + double deltaX = end.x() - start.x(); + double deltaZ = end.z() - start.z(); + double length = StrictMath.hypot(deltaX, deltaZ); + return length <= 0D + ? new RouteDirection(1D, 0D) + : new RouteDirection(deltaX / length, deltaZ / length); + } + + List mapCoursePairs( + List points, + List guide, + List guideEdges + ) { + ArrayList mapped = new ArrayList<>(points.size() - 1); + int minimumGuideIndex = 0; + for (int pointIndex = 0; pointIndex < points.size() - 1; pointIndex++) { + HydrologyPoint first = points.get(pointIndex); + HydrologyPoint second = points.get(pointIndex + 1); + double x = (first.x() + second.x()) * 0.5D; + double z = (first.z() + second.z()) * 0.5D; + int selectedIndex = minimumGuideIndex; + double selectedDistance = Double.POSITIVE_INFINITY; + for (int guideIndex = minimumGuideIndex; guideIndex < guideEdges.size(); guideIndex++) { + double distance = pointToSegmentDistanceSquared( + x, + z, + guide.get(guideIndex), + guide.get(guideIndex + 1) + ); + if (distance < selectedDistance) { + selectedIndex = guideIndex; + selectedDistance = distance; + } + } + minimumGuideIndex = selectedIndex; + mapped.add(guideEdges.get(selectedIndex)); + } + return List.copyOf(mapped); + } + + double pointToSegmentDistanceSquared( + double x, + double z, + HydrologyPoint start, + HydrologyPoint end + ) { + double deltaX = end.x() - start.x(); + double deltaZ = end.z() - start.z(); + double lengthSquared = deltaX * deltaX + deltaZ * deltaZ; + if (lengthSquared == 0D) { + double pointX = x - start.x(); + double pointZ = z - start.z(); + return pointX * pointX + pointZ * pointZ; + } + double progress = ((x - start.x()) * deltaX + (z - start.z()) * deltaZ) / lengthSquared; + progress = Math.max(0D, Math.min(1D, progress)); + double nearestX = start.x() + deltaX * progress; + double nearestZ = start.z() + deltaZ * progress; + double pointX = x - nearestX; + double pointZ = z - nearestZ; + return pointX * pointX + pointZ * pointZ; + } + + HydrologyTerrainSample surfaceBankTerrain( + HydrologyPoint point, + RouteDirection tangent, + int signedDistance + ) { + HydrologyPoint bankPoint = surfaceBankPoint(point, tangent, signedDistance); + int bankX = bankPoint.x(); + int bankZ = bankPoint.z(); + return planner.sampleLandBasisWithoutSlope(bankX, bankZ); + } + + HydrologyPoint surfaceBankPoint(HydrologyPoint point, RouteDirection tangent, int signedDistance) { + return new HydrologyPoint( + (int) StrictMath.round(point.x() - tangent.z() * signedDistance), + point.y(), + (int) StrictMath.round(point.z() + tangent.x() * signedDistance) + ); + } + + record SurfaceCurvePoint(double x, double z, double distance) { + } + + record SurfaceCourseBuild( + RiverCourse course, + HydrologyCandidateRejection rejection, + int rejectionDetail + ) { + SurfaceCourseBuild { + if ((course == null) == (rejection == null)) { + throw new IllegalArgumentException("Surface course builds require exactly one result."); + } + } + + private static SurfaceCourseBuild accepted(RiverCourse course) { + return new SurfaceCourseBuild(Objects.requireNonNull(course, "course"), null, 0); + } + + private static SurfaceCourseBuild rejected(HydrologyCandidateRejection rejection, int detail) { + return new SurfaceCourseBuild(null, Objects.requireNonNull(rejection, "rejection"), detail); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyTributaryPlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyTributaryPlanner.java new file mode 100644 index 000000000..dc9539326 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyTributaryPlanner.java @@ -0,0 +1,674 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.surface.SurfaceCourseResult; +import art.arcane.iris.engine.hydrology.surface.SurfaceTerminal; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.OptionalLong; +import java.util.Set; + +final class HydrologyTributaryPlanner { + private final HydrologyPlanner planner; + + HydrologyTributaryPlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + static final int TRIBUTARY_JUNCTION_ATTEMPTS = 4; + static final int TRIBUTARY_BACKWATER_LIMIT = 3; + static final int TRIBUTARY_JUNCTION_FLAT_STATIONS = 6; + static final int TRIBUTARY_JUNCTION_PAIR_INDEX = 0x4a4f494e; + + List normalizeOutletContinuations(List courses) { + HashMap canonicalCourses = new HashMap<>(); + for (RiverCourse course : courses) { + if (!hasInlandOutletContinuation(course) || course.outletId().isEmpty()) { + continue; + } + OutletCourseKey key = new OutletCourseKey(course.outletId().getAsLong()); + canonicalCourses.merge( + key, + course, + this::preferredOutletContinuation + ); + } + ArrayList normalized = new ArrayList<>(courses.size()); + for (RiverCourse course : courses) { + if (course.outletId().isEmpty()) { + normalized.add(course); + continue; + } + OutletCourseKey key = new OutletCourseKey(course.outletId().getAsLong()); + RiverCourse canonicalCourse = canonicalCourses.get(key); + if (canonicalCourse == null || canonicalCourse.id() == course.id()) { + normalized.add(course); + continue; + } + List segments = course.segments(); + int retainedSize = course.surfaceSinkholeContinuation() + ? segments.size() - 2 + : segments.getLast().type() == HydrologyFeatureType.INLAND_GROTTO + ? segments.size() - 1 + : segments.size(); + retainedSize = trimCanonicalOutletOverlap(course, canonicalCourse, retainedSize); + if (retainedSize < 1) { + continue; + } + normalized.add(new RiverCourse( + course.id(), + course.type(), + course.sourceNodeId(), + course.outletId(), + course.profileKey(), + course.discharge(), + course.drainageEdges(), + segments.subList(0, retainedSize) + )); + } + return List.copyOf(normalized); + } + + int trimCanonicalOutletOverlap( + RiverCourse course, + RiverCourse canonicalCourse, + int retainedSize + ) { + if (!canonicalCourse.surfaceSinkholeContinuation() + || canonicalCourse.segments().isEmpty() + || retainedSize < 1) { + return retainedSize; + } + HydraulicSegment canonicalGrotto = canonicalCourse.segments().getLast(); + if (canonicalGrotto.type() != HydrologyFeatureType.INLAND_GROTTO) { + return retainedSize; + } + int exclusionRadius = Math.addExact( + planner.settings.outlets().inlandGrotto().horizontalRadius(), + Math.addExact((int) StrictMath.ceil(planner.settings.underground().maximumWidth() / 2D), 2) + ); + long exclusionRadiusSquared = (long) exclusionRadius * exclusionRadius; + while (retainedSize > 0 && segmentOverlapsOutlet( + course.segments().get(retainedSize - 1), + canonicalGrotto, + exclusionRadiusSquared + )) { + retainedSize--; + } + return retainedSize; + } + + boolean segmentOverlapsOutlet( + HydraulicSegment segment, + HydraulicSegment outlet, + long exclusionRadiusSquared + ) { + for (HydrologyPoint point : segment.centerline()) { + for (HydrologyPoint outletPoint : outlet.centerline()) { + if (point.distanceSquared2D(outletPoint) <= exclusionRadiusSquared) { + return true; + } + } + } + return false; + } + + List normalizeSharedTrunks(List courses, List diagnostics) { + HashMap edgeOwners = new HashMap<>(); + for (RiverCourse course : courses) { + if (course.sourceNodeId().isEmpty()) { + continue; + } + for (DrainageEdge edge : course.drainageEdges()) { + CourseEdgeKey key = new CourseEdgeKey(course.type(), edge.id()); + edgeOwners.merge( + key, + course, + this::preferredTrunkCourse + ); + } + } + ArrayList normalized = new ArrayList<>(courses.size()); + for (RiverCourse course : courses) { + if (course.sourceNodeId().isEmpty() || course.drainageEdges().isEmpty()) { + normalized.add(course); + continue; + } + int ownedEdgeCount = 0; + for (DrainageEdge edge : course.drainageEdges()) { + RiverCourse owner = edgeOwners.get(new CourseEdgeKey(course.type(), edge.id())); + if (owner == null || owner.id() != course.id()) { + break; + } + ownedEdgeCount++; + } + if (ownedEdgeCount == course.drainageEdges().size()) { + normalized.add(course); + continue; + } + if (ownedEdgeCount < 1) { + continue; + } + HydrologyPoint boundary = course.drainageEdges() + .get(ownedEdgeCount - 1) + .centerline() + .getLast(); + if (course.type() == RiverCourseType.SURFACE) { + // Surface tributaries are cut at their junction before they are built, so a surface + // course still sharing drainage with a longer trunk has no junction to keep it. + addTributaryDiagnostic(course.id(), course.segments().getFirst().start(), + HydrologyCandidateRejection.NO_DRAINAGE_PATH, ownedEdgeCount, diagnostics); + continue; + } + int retainedSegmentCount = retainedSegmentCount(course.segments(), boundary); + if (retainedSegmentCount < 1) { + normalized.add(course); + continue; + } + normalized.add(new RiverCourse( + course.id(), + course.type(), + course.sourceNodeId(), + course.outletId(), + course.profileKey(), + course.discharge(), + course.drainageEdges().subList(0, ownedEdgeCount), + course.segments().subList(0, retainedSegmentCount) + )); + } + return List.copyOf(normalized); + } + + /** + * Builds a later draft to the stem's outlet as a tributary. The draft's path is cut where it first + * comes within a stem width of the stem or first enters drainage the stem already owns, and it is + * shaped with the stem's water level at that station as its terminal, so it arrives at or above the + * stem and steps down into it. When the tributary would arrive below the stem's water there, the + * junction slides downstream along the stem to the first station whose water is low enough and the + * course is shaped again. The tributary owns only the drainage edges upstream of the junction. + */ + RiverCourse buildSurfaceTributary( + SurfaceCourseDraft draft, + RiverCourse stem, + List diagnostics + ) { + HydrologyCoursePath path = draft.path(); + HydrologyPoint sourcePoint = path.points().getFirst(); + HashSet stemEdges = new HashSet<>(); + for (DrainageEdge edge : stem.drainageEdges()) { + stemEdges.add(edge.id()); + } + ArrayList stemStations = new ArrayList<>(); + ArrayList stemWidths = new ArrayList<>(); + for (HydraulicSegment segment : stem.segments()) { + for (HydrologyPoint point : segment.centerline()) { + stemStations.add(point); + stemWidths.add(segment.width()); + } + } + int minimumStemIndex = 0; + HydrologyCandidateRejection rejection = HydrologyCandidateRejection.NO_DRAINAGE_PATH; + int rejectionDetail = 0; + for (int attempt = 0; attempt < TRIBUTARY_JUNCTION_ATTEMPTS; attempt++) { + int[] junction = tributaryJunction(path, stemStations, stemWidths, stemEdges, minimumStemIndex); + if (junction == null) { + break; + } + int joinIndex = junction[0]; + int stemIndex = junction[1]; + HydrologyPoint joinStation = stemStations.get(stemIndex); + if (joinIndex < 1) { + rejection = HydrologyCandidateRejection.COURSE_TOO_SHORT; + rejectionDetail = 0; + break; + } + TributaryBuild build = buildSurfaceTributaryAt(draft, joinIndex, stemIndex, stemStations, stemWidths, stemEdges); + if (build.course() != null) { + return build.course(); + } + rejection = build.rejection(); + rejectionDetail = build.rejectionDetail(); + if (rejection != HydrologyCandidateRejection.SURFACE_HEAD_RANGE) { + break; + } + // The tributary arrives rejectionDetail blocks below the stem's water: slide the junction + // downstream to the first stem station whose water is that much lower. + int target = joinStation.y() - rejectionDetail; + int nextStemIndex = -1; + for (int index = stemIndex + 1; index < stemStations.size(); index++) { + if (stemStations.get(index).y() <= target) { + nextStemIndex = index; + break; + } + } + if (nextStemIndex < 0) { + break; + } + minimumStemIndex = nextStemIndex; + } + addTributaryDiagnostic(draft.courseId(), sourcePoint, rejection, rejectionDetail, diagnostics); + return null; + } + + /** + * The first draft point, in path order, that lies within a stem width of a stem station at or past + * {@code minimumStemIndex} or that enters drainage the stem owns, as {draft point index, stem station + * index}; null when the draft never meets the stem there. Among the stations the point can reach the + * lowest water wins, then the flattest stretch, so the tributary's mouth sits at the river's level + * where the two channels touch and never above the stem's shore. + */ + static int[] tributaryJunction( + HydrologyCoursePath path, + List stemStations, + List stemWidths, + Set stemEdges, + int minimumStemIndex + ) { + for (int index = 0; index < path.points().size(); index++) { + HydrologyPoint point = path.points().get(index); + boolean sharedEdge = index > 0 && stemEdges.contains(path.pairEdges().get(index - 1).id()); + int best = -1; + int bestFlatness = -1; + double bestDistance = Double.POSITIVE_INFINITY; + for (int stemIndex = minimumStemIndex; stemIndex < stemStations.size(); stemIndex++) { + double distance = point.distanceSquared2D(stemStations.get(stemIndex)); + double reach = stemWidths.get(stemIndex) + 1D; + boolean reachable = distance <= reach * reach; + if (!reachable && !(sharedEdge && best < 0 && distance < bestDistance)) { + continue; + } + int flatness = reachable ? stemFlatness(stemStations, stemIndex) : -1; + int level = stemStations.get(stemIndex).y(); + int bestLevel = best < 0 ? Integer.MAX_VALUE : stemStations.get(best).y(); + if (level < bestLevel + || level == bestLevel && (flatness > bestFlatness || flatness == bestFlatness && distance < bestDistance)) { + best = stemIndex; + bestFlatness = flatness; + bestDistance = distance; + } + } + if (best >= 0) { + return new int[] {index, best}; + } + } + return null; + } + + /** How many of the stem stations around {@code stemIndex} share its water level. */ + static int stemFlatness(List stemStations, int stemIndex) { + int level = stemStations.get(stemIndex).y(); + int flat = 0; + for (int offset = -TRIBUTARY_JUNCTION_FLAT_STATIONS; offset <= TRIBUTARY_JUNCTION_FLAT_STATIONS; offset++) { + int index = stemIndex + offset; + if (index >= 0 && index < stemStations.size() && stemStations.get(index).y() == level) { + flat++; + } + } + return flat; + } + + /** Raises every trailing station below {@code level} to it, so the tail is a flat pool at the stem's water. */ + static void backwater(List segments, int level) { + for (int index = segments.size() - 1; index >= 0; index--) { + HydraulicSegment segment = segments.get(index); + if (segment.upstreamHeadY() >= level && segment.downstreamHeadY() >= level) { + break; + } + ArrayList centerline = new ArrayList<>(segment.centerline().size()); + for (HydrologyPoint point : segment.centerline()) { + centerline.add(point.y() < level ? new HydrologyPoint(point.x(), level, point.z()) : point); + } + int upstream = Math.max(segment.upstreamHeadY(), level); + int downstream = Math.max(segment.downstreamHeadY(), level); + segments.set(index, new HydraulicSegment( + segment.id(), + segment.courseId(), + upstream == downstream ? HydrologyFeatureType.SURFACE_POOL : segment.type(), + upstream, + downstream, + segment.width(), + segment.depth(), + segment.fallingFluid(), + segment.receivingPool(), + List.copyOf(centerline) + )); + if (segment.upstreamHeadY() >= level) { + break; + } + } + } + + /** + * Lowers the trailing stations of a tributary towards {@code level}, one block per cascade run of + * centerline distance from the junction and never deeper than the channel may cut, so the reach + * grades down into the stem instead of hanging above it. Where the ground holds a station up, the + * stations upstream of it are held with it, so the graded reach still descends into the stem. + */ + void levelApproach(List segments, int level) { + int run = Math.max(1, planner.settings.surface().banks().cascadeRun()); + int maximumIncision = planner.settings.surface().maximumIncision(); + double distance = 0D; + HydrologyPoint previous = null; + int downstreamHead = Integer.MIN_VALUE; + for (int index = segments.size() - 1; index >= 0; index--) { + HydraulicSegment segment = segments.get(index); + ArrayList centerline = new ArrayList<>(segment.centerline()); + boolean changed = false; + boolean settled = false; + for (int pointIndex = centerline.size() - 1; pointIndex >= 0; pointIndex--) { + HydrologyPoint point = centerline.get(pointIndex); + if (previous != null) { + distance += StrictMath.hypot(point.x() - previous.x(), point.z() - previous.z()); + } + previous = point; + int allowed = level + (int) StrictMath.floor(distance / run); + if (point.y() <= allowed) { + settled = true; + break; + } + int floor = planner.sampleBasisWithoutSlope(point.x(), point.z()).naturalHeight() - maximumIncision; + int lowered = Math.min(point.y(), Math.max(Math.max(allowed, floor), downstreamHead)); + if (lowered < point.y()) { + centerline.set(pointIndex, new HydrologyPoint(point.x(), lowered, point.z())); + changed = true; + } + downstreamHead = lowered; + } + if (changed) { + // A level reach may carry a bump above its heads (a pool's centerline is not graded); + // once its tail is cut down the reach becomes a graded transition, which must never rise + // downstream, so every station is held at or below the one before it. + int ceiling = centerline.getFirst().y(); + for (int pointIndex = 1; pointIndex < centerline.size(); pointIndex++) { + HydrologyPoint point = centerline.get(pointIndex); + if (point.y() > ceiling) { + centerline.set(pointIndex, new HydrologyPoint(point.x(), ceiling, point.z())); + } else { + ceiling = point.y(); + } + } + int upstream = centerline.getFirst().y(); + int downstream = centerline.getLast().y(); + HydrologyFeatureType type = segment.type(); + if (upstream > downstream && !type.isDrop()) { + type = upstream - downstream >= planner.settings.hydraulics().waterfallMinimumDrop() + ? HydrologyFeatureType.WATERFALL + : upstream - downstream == 1 ? HydrologyFeatureType.RIFFLE : HydrologyFeatureType.CASCADE; + } else if (upstream == downstream && type.isDrop()) { + type = HydrologyFeatureType.SURFACE_POOL; + } + segments.set(index, new HydraulicSegment( + segment.id(), + segment.courseId(), + type, + upstream, + downstream, + segment.width(), + segment.depth(), + segment.fallingFluid(), + segment.receivingPool(), + List.copyOf(centerline) + )); + } + if (settled) { + break; + } + } + } + + static int lastWidth(SurfaceCourseResult result) { + return Math.max(1, result.lastWidth()); + } + + record TributaryBuild(RiverCourse course, HydrologyCandidateRejection rejection, int rejectionDetail) { + private static TributaryBuild rejected(HydrologyCandidateRejection rejection, int detail) { + return new TributaryBuild(null, rejection, detail); + } + } + + TributaryBuild buildSurfaceTributaryAt( + SurfaceCourseDraft draft, + int joinIndex, + int stemIndex, + List stemStations, + List stemWidths, + Set stemEdges + ) { + HydrologyCoursePath path = draft.path(); + HydrologyPoint joinStation = stemStations.get(stemIndex); + ArrayList points = new ArrayList<>(path.points().subList(0, joinIndex + 1)); + HydrologyPoint last = points.getLast(); + if (last.x() != joinStation.x() || last.z() != joinStation.z()) { + points.add(new HydrologyPoint(joinStation.x(), last.y(), joinStation.z())); + } + LinkedHashSet ownedEdges = new LinkedHashSet<>(); + for (DrainageEdge edge : path.pairEdges().subList(0, joinIndex)) { + if (!stemEdges.contains(edge.id())) { + ownedEdges.add(edge); + } + } + if (ownedEdges.isEmpty()) { + return TributaryBuild.rejected(HydrologyCandidateRejection.COURSE_TOO_SHORT, joinIndex); + } + int stemHead = joinStation.y(); + SurfaceCourseResult result = planner.tributaryCourseBuilder.build( + planner.worldSeed, + draft.courseId(), + draft.profileKey(), + List.copyOf(points), + SurfaceTerminal.TRIBUTARY, + stemHead + ); + if (!result.accepted()) { + return TributaryBuild.rejected(result.rejection(), result.rejectionDetail()); + } + if (path.organicSurfaceRequired()) { + // The reach is judged without its approach into the stem: the turn a tributary makes to + // enter its river is junction geometry, not a bend in the river itself. + double approachRadius = 3D * lastWidth(result) + 8D; + int judged = joinIndex; + while (judged > 0 && path.points().get(judged).distanceSquared2D(joinStation) <= approachRadius * approachRadius) { + judged--; + } + int shapeRejection = judged >= 2 ? planner.surfaceCourses.surfaceShapeRejection(path.points().subList(0, judged + 1), true) : 0; + if (shapeRejection != 0) { + return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_SHAPE_UNSUPPORTED, shapeRejection); + } + } + ArrayList segments = new ArrayList<>(result.segments()); + // Where the two channels touch, the tributary must sit at the lowest stem water it reaches. + double touch = stemWidths.get(stemIndex) + lastWidth(result) + 1D; + for (int index = 0; index < stemStations.size(); index++) { + HydrologyPoint station = stemStations.get(index); + if (station.distanceSquared2D(joinStation) <= touch * touch) { + stemHead = Math.min(stemHead, station.y()); + } + } + if (segments.getLast().downstreamHeadY() < stemHead) { + int shortfall = stemHead - segments.getLast().downstreamHeadY(); + if (shortfall > TRIBUTARY_BACKWATER_LIMIT) { + return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_HEAD_RANGE, shortfall); + } + // The stem's water stands a little above the tributary's floor at the junction: the tail of + // the tributary backs up to the stem's level, a short still reach the bank lip contains. + backwater(segments, stemHead); + } else if (segments.getLast().downstreamHeadY() > stemHead) { + // The tributary hangs above its river: its last stretch is cut down to the stem's water, + // a block per cascade run, so the channel meets the river at its level and not above + // the stem's shore. + levelApproach(segments, stemHead); + } + HydraulicSegment lastSegment = segments.getLast(); + HydrologyPoint end = lastSegment.end(); + if (end.x() != joinStation.x() || end.z() != joinStation.z() || lastSegment.downstreamHeadY() != stemHead) { + // The hop onto the stem is graded like any in-course drop, so the water steps down block + // by block into the river instead of standing above the stem's shore. + int drop = lastSegment.downstreamHeadY() - stemHead; + HydrologyFeatureType type = drop == 0 + ? HydrologyFeatureType.SURFACE_POOL + : drop >= planner.settings.hydraulics().waterfallMinimumDrop() + ? HydrologyFeatureType.WATERFALL + : drop == 1 ? HydrologyFeatureType.RIFFLE : HydrologyFeatureType.CASCADE; + boolean graded = planner.segments.addHydraulicSegments( + draft.courseId(), + TRIBUTARY_JUNCTION_PAIR_INDEX, + type, + lastSegment.downstreamHeadY(), + stemHead, + lastSegment.width(), + lastSegment.depth(), + List.of(end, new HydrologyPoint(joinStation.x(), stemHead, joinStation.z())), + true, + segments + ); + if (!graded) { + return TributaryBuild.rejected(HydrologyCandidateRejection.SURFACE_DROP_UNSUPPORTED, drop); + } + } + List edges = List.copyOf(ownedEdges); + return new TributaryBuild(new RiverCourse( + draft.courseId(), + RiverCourseType.SURFACE, + OptionalLong.of(draft.source().id()), + OptionalLong.of(path.outlet().id()), + draft.profileKey(), + planner.segments.maximumSurfaceDischarge(edges), + edges, + segments + ), null, 0); + } + + void addTributaryDiagnostic( + long courseId, + HydrologyPoint sourcePoint, + HydrologyCandidateRejection rejection, + int detail, + List diagnostics + ) { + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(courseId, HydrologySourcePlanner.DIAGNOSTIC_SALT, rejection.ordinal(), 0x5452494255544152L), + HydrologyCandidateKind.TRIBUTARY, + HydrologyFeatureType.SURFACE_POOL, + sourcePoint, + rejection, + detail + )); + } + + RiverCourse preferredTrunkCourse(RiverCourse first, RiverCourse second) { + double firstLength = edgeLength(first.drainageEdges(), first.drainageEdges().size()); + double secondLength = edgeLength(second.drainageEdges(), second.drainageEdges().size()); + if (firstLength != secondLength) { + return firstLength > secondLength ? first : second; + } + if (first.discharge() != second.discharge()) { + return first.discharge() > second.discharge() ? first : second; + } + return Long.compareUnsigned(first.id(), second.id()) <= 0 ? first : second; + } + + double edgeLength(List edges, int edgeCount) { + double length = 0D; + for (int edgeIndex = 0; edgeIndex < edgeCount; edgeIndex++) { + List centerline = edges.get(edgeIndex).centerline(); + for (int pointIndex = 1; pointIndex < centerline.size(); pointIndex++) { + HydrologyPoint previous = centerline.get(pointIndex - 1); + HydrologyPoint current = centerline.get(pointIndex); + length += StrictMath.hypot(current.x() - previous.x(), current.z() - previous.z()); + } + } + return length; + } + + int retainedSegmentCount(List segments, HydrologyPoint boundary) { + for (int segmentIndex = 0; segmentIndex < segments.size(); segmentIndex++) { + HydrologyPoint end = segments.get(segmentIndex).centerline().getLast(); + if (end.x() == boundary.x() && end.z() == boundary.z()) { + return segmentIndex + 1; + } + } + return 0; + } + + RiverCourse preferredOutletContinuation(RiverCourse first, RiverCourse second) { + boolean firstSurfaceSinkhole = first.surfaceSinkholeContinuation(); + boolean secondSurfaceSinkhole = second.surfaceSinkholeContinuation(); + if (firstSurfaceSinkhole != secondSurfaceSinkhole) { + return firstSurfaceSinkhole ? first : second; + } + return Long.compareUnsigned(first.id(), second.id()) <= 0 ? first : second; + } + + boolean hasInlandOutletContinuation(RiverCourse course) { + return course.surfaceSinkholeContinuation() + || course.segments().getLast().type() == HydrologyFeatureType.INLAND_GROTTO; + } + + /** + * Builds a later underground draft to the stem's outlet as a tributary: the path is cut at the first + * point the stem's passage already runs through, and the passage is solved with the stem's fluid + * level there as its outlet level, so it joins the stem at or above its water. + */ + RiverCourse buildUndergroundTributary( + UndergroundCourseDraft draft, + RiverCourse stem, + List diagnostics + ) { + HydrologyCoursePath path = draft.path(); + HashSet stemEdges = new HashSet<>(); + for (DrainageEdge edge : stem.drainageEdges()) { + stemEdges.add(edge.id()); + } + HashMap stemHeads = new HashMap<>(); + for (HydraulicSegment segment : stem.segments()) { + for (HydrologyPoint point : segment.centerline()) { + stemHeads.putIfAbsent(RiverFootprint.pack(point.x(), point.z()), point.y()); + } + } + int joinIndex = -1; + for (int index = 0; index < path.points().size(); index++) { + HydrologyPoint point = path.points().get(index); + boolean sharedEdge = index > 0 && stemEdges.contains(path.pairEdges().get(index - 1).id()); + if (sharedEdge || stemHeads.containsKey(RiverFootprint.pack(point.x(), point.z()))) { + joinIndex = index; + break; + } + } + if (joinIndex < 1 || !stemHeads.containsKey(RiverFootprint.pack( + path.points().get(joinIndex).x(), path.points().get(joinIndex).z()))) { + planner.undergroundCourses.addCompiledSourceDiagnostic(draft.source(), false, draft.courseId(), + joinIndex < 0 ? HydrologyCandidateRejection.NO_DRAINAGE_PATH : HydrologyCandidateRejection.COURSE_TOO_SHORT, + diagnostics); + return null; + } + List points = path.points().subList(0, joinIndex + 1); + List pairEdges = path.pairEdges().subList(0, joinIndex); + LinkedHashSet ownedEdges = new LinkedHashSet<>(); + for (DrainageEdge edge : pairEdges) { + if (!stemEdges.contains(edge.id())) { + ownedEdges.add(edge); + } + } + if (ownedEdges.isEmpty() + || planner.surfaceCourses.centerlineLength(points) < planner.settings.routing().minimumUndergroundCourseLength() / 2D) { + planner.undergroundCourses.addCompiledSourceDiagnostic(draft.source(), false, draft.courseId(), + HydrologyCandidateRejection.COURSE_TOO_SHORT, joinIndex, diagnostics); + return null; + } + HydrologyPoint junction = points.getLast(); + HydrologyCoursePath junctionPath = new HydrologyCoursePath( + List.copyOf(points), + List.copyOf(pairEdges), + List.copyOf(ownedEdges), + path.outlet(), + false, + false, + junction + ); + int junctionHead = stemHeads.get(RiverFootprint.pack(junction.x(), junction.z())); + return planner.undergroundCourses.buildUndergroundCourse(draft, junctionPath, junctionHead, diagnostics); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyUndergroundCoursePlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyUndergroundCoursePlanner.java new file mode 100644 index 000000000..0194b2167 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyUndergroundCoursePlanner.java @@ -0,0 +1,546 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Comparator; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Objects; +import java.util.OptionalLong; + +final class HydrologyUndergroundCoursePlanner { + private final HydrologyPlanner planner; + + HydrologyUndergroundCoursePlanner(HydrologyPlanner planner) { + this.planner = planner; + } + + void compileUndergroundCourses( + HydrologyTileKey key, + HydrologySampledGrid grid, + HydrologyRoutingPlan routing, + CompiledGraph graph, + List sources, + List courses, + List diagnostics + ) { + LinkedHashMap> draftsByOutlet = new LinkedHashMap<>(); + for (int sourceIndex : sources) { + HydrologyGridNode source = grid.node(sourceIndex); + long courseId = HydrologyHash.mix(planner.worldSeed, HydrologySurfaceCoursePlanner.COURSE_SALT, HydrologySourcePlanner.UNDERGROUND_SOURCE_SALT, source.id()); + HydrologyCoursePath path = planner.surfaceCourses.coursePath(null, routing, graph, sourceIndex, false); + if (path == null) { + addCompiledSourceDiagnostic( + source, + false, + courseId, + HydrologyCandidateRejection.NO_DRAINAGE_PATH, + diagnostics + ); + continue; + } + draftsByOutlet.computeIfAbsent(path.outlet().id(), (Long ignored) -> new ArrayList<>()) + .add(new UndergroundCourseDraft(source, courseId, path)); + } + for (ArrayList outletDrafts : draftsByOutlet.values()) { + outletDrafts.sort(Comparator + .comparingDouble((UndergroundCourseDraft draft) -> planner.tributaries.edgeLength( + draft.path().edges(), + draft.path().edges().size() + )) + .reversed() + .thenComparingLong(UndergroundCourseDraft::courseId)); + RiverCourse mainCourse = null; + int tributaries = 0; + for (UndergroundCourseDraft draft : outletDrafts) { + if (mainCourse != null && tributaries >= planner.settings.underground().tributaries()) { + break; + } + if (mainCourse == null) { + RiverCourse course = buildUndergroundCourse(draft, draft.path(), planner.segments.outletHead(draft.path().outlet()), diagnostics); + if (course != null) { + mainCourse = course; + courses.add(course); + } + continue; + } + RiverCourse tributary = planner.tributaries.buildUndergroundTributary(draft, mainCourse, diagnostics); + if (tributary != null) { + courses.add(tributary); + tributaries++; + } + } + } + } + + RiverCourse buildUndergroundCourse( + UndergroundCourseDraft draft, + HydrologyCoursePath path, + int outletHead, + List diagnostics + ) { + HydrologyGridNode source = draft.source(); + long courseId = draft.courseId(); + HydrologyPoint sourcePoint = path.points().getFirst(); + HydrologyPoint trunkPoint = path.points().getLast(); + HydrologyTerrainSample trunkTerrain = Objects.requireNonNull( + planner.sampleDetailed(trunkPoint.x(), trunkPoint.z()), + "Hydrology underground trunk left sampled terrain" + ); + String profileKey = planner.segments.chooseProfile(trunkTerrain, path.outlet().id()); + int styledHead = planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, + profileKey, + sourcePoint.x(), + sourcePoint.z(), + 0L, + planner.settings.underground().minimumFluidY(), + planner.settings.underground().maximumFluidY() + ); + if (outletHead > planner.settings.underground().maximumFluidY()) { + addCompiledSourceDiagnostic( + source, + false, + courseId, + HydrologyCandidateRejection.OUTLET_LEVEL, + diagnostics + ); + return null; + } + int initialHead = Math.max(styledHead, outletHead); + RiverCourse course = buildUndergroundCourse(courseId, profileKey, source, path, initialHead, outletHead); + if (course == null) { + addCompiledSourceDiagnostic( + source, + false, + courseId, + HydrologyCandidateRejection.CAVE_CONTAINMENT, + diagnostics + ); + } + return course; + } + + void addCompiledSourceDiagnostic( + HydrologyGridNode source, + boolean surface, + long courseId, + HydrologyCandidateRejection rejection, + List diagnostics + ) { + addCompiledSourceDiagnostic(source, surface, courseId, rejection, 0, diagnostics); + } + + void addCompiledSourceDiagnostic( + HydrologyGridNode source, + boolean surface, + long courseId, + HydrologyCandidateRejection rejection, + int detail, + List diagnostics + ) { + int y = surface ? source.terrain().naturalHeight() : source.terrain().caveFluidY(); + diagnostics.add(new HydrologyDiagnosticCandidate( + HydrologyHash.mix(courseId, HydrologySourcePlanner.DIAGNOSTIC_SALT, rejection.ordinal()), + HydrologyCandidateKind.SOURCE, + surface ? HydrologyFeatureType.SURFACE_POOL : HydrologyFeatureType.UNDERGROUND_POOL, + new HydrologyPoint(source.x(), y, source.z()), + rejection, + detail + )); + } + + RiverCourse buildUndergroundCourse( + long courseId, + String profileKey, + HydrologyGridNode source, + HydrologyCoursePath path, + int initialHead, + int outletHead + ) { + int pairCount = path.points().size() - 1; + if (pairCount < 1) { + return null; + } + int[] heads = new int[path.points().size()]; + int[] preferredHeads = new int[path.points().size()]; + int[] widths = new int[pairCount]; + int[] depths = new int[pairCount]; + preferredHeads[0] = initialHead; + for (int index = 0; index < pairCount; index++) { + HydrologyPoint point = path.points().get(index); + HydrologyTerrainSample terrain = planner.sampleBasisWithoutSlope(point.x(), point.z()); + int discharge = Math.max(1, path.pairEdges().get(index).contributingUndergroundSources()); + widths[index] = planner.segments.scaledDimension( + planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_WIDTH, + profileKey, + point.x(), + point.z(), + 0L, + planner.settings.underground().minimumWidth(), + planner.settings.underground().maximumWidth() + ), + planner.settings.underground().minimumWidth(), + planner.settings.underground().maximumWidth(), + discharge, + terrain.widthMultiplier() + ); + depths[index] = planner.segments.scaledDimension( + planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_DEPTH, + profileKey, + point.x(), + point.z(), + 0L, + planner.settings.underground().minimumDepth(), + planner.settings.underground().maximumDepth() + ), + planner.settings.underground().minimumDepth(), + planner.settings.underground().maximumDepth(), + discharge, + terrain.depthMultiplier() + ); + HydrologyPoint downstreamPoint = path.points().get(index + 1); + int caveHead = planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_FLUID_LEVEL, + profileKey, + downstreamPoint.x(), + downstreamPoint.z(), + 0L, + planner.settings.underground().minimumFluidY(), + planner.settings.underground().maximumFluidY() + ); + preferredHeads[index + 1] = caveHead; + } + int[] minimumHeads = undergroundMinimumHeads(path, depths, outletHead); + int[] optimisticMaximumHeads = undergroundOptimisticMaximumHeads(path); + if (!undergroundHeadsFeasible(minimumHeads, optimisticMaximumHeads, outletHead)) { + return null; + } + int[] maximumHeads = undergroundMaximumHeads(courseId, profileKey, path, widths); + if (!solveUndergroundHeads(preferredHeads, minimumHeads, maximumHeads, outletHead, heads)) { + return null; + } + levelUndergroundMouth(path, heads, outletHead); + ArrayList segments = new ArrayList<>(pairCount + 1); + for (int index = 0; index < pairCount; index++) { + int drop = heads[index] - heads[index + 1]; + HydrologyFeatureType type = drop > 0 + ? HydrologyFeatureType.UNDERGROUND_DROP + : HydrologyFeatureType.UNDERGROUND_POOL; + if (!planner.segments.addHydraulicSegments( + courseId, + index, + type, + heads[index], + heads[index + 1], + widths[index], + depths[index], + List.of( + HydrologyPlanner.withY(path.points().get(index), heads[index]), + HydrologyPlanner.withY(path.points().get(index + 1), heads[index + 1]) + ), + false, + segments + )) { + return null; + } + } + planner.segments.appendOutletSegments( + RiverCourseType.UNDERGROUND, + courseId, + path, + heads[heads.length - 1], + widths, + depths, + segments + ); + int discharge = planner.segments.maximumUndergroundDischarge(path.edges()); + return new RiverCourse( + courseId, + RiverCourseType.UNDERGROUND, + OptionalLong.of(source.id()), + OptionalLong.of(path.outlet().id()), + profileKey, + discharge, + path.edges(), + segments + ); + } + + int[] undergroundMaximumHeads( + long courseId, + String profileKey, + HydrologyCoursePath path, + int[] widths + ) { + int[] segmentCaps = new int[widths.length]; + for (int index = 0; index < widths.length; index++) { + int radius = Math.max(1, widths[index] / 2); + segmentCaps[index] = undergroundSegmentCap( + courseId, + profileKey, + path.points().get(index), + path.points().get(index + 1), + radius + ); + } + return nodeMaximumHeads(segmentCaps); + } + + int[] undergroundOptimisticMaximumHeads(HydrologyCoursePath path) { + int segmentCount = path.points().size() - 1; + int[] segmentCaps = new int[segmentCount]; + Arrays.fill(segmentCaps, Integer.MAX_VALUE); + int minimumHeadroom = planner.settings.underground().minimumHeadroom(); + for (int index = 0; index < segmentCount; index++) { + HydrologyPoint start = path.points().get(index); + HydrologyPoint end = path.points().get(index + 1); + segmentCaps[index] = Math.min( + optimisticUndergroundSegmentCap(start, minimumHeadroom), + optimisticUndergroundSegmentCap(end, minimumHeadroom) + ); + } + return nodeMaximumHeads(segmentCaps); + } + + int optimisticUndergroundSegmentCap(HydrologyPoint point, int minimumHeadroom) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(point.x(), point.z()); + return terrain == null || terrain.ocean() + ? Integer.MAX_VALUE + : terrain.naturalHeight() - minimumHeadroom - planner.settings.underground().minimumRockCover(); + } + + int undergroundSegmentCap( + long courseId, + String profileKey, + HydrologyPoint start, + HydrologyPoint end, + int radius + ) { + int minimumHeadroom = planner.settings.underground().minimumHeadroom(); + int maximumHeadroom = planner.settings.underground().maximumHeadroom(); + UndergroundSegmentCapKey key = new UndergroundSegmentCapKey( + courseId, + profileKey, + start.x(), + start.z(), + end.x(), + end.z(), + radius, + minimumHeadroom, + maximumHeadroom + ); + HydrologyPlanner.PlanningSamples samples = planner.planningSamples.get(); + if (samples != null) { + Integer cached = samples.undergroundSegmentCaps.get(key); + if (cached != null) { + return cached; + } + } + int segmentCap = Integer.MAX_VALUE; + List centerline = planner.segments.line(start, end, 1); + for (HydrologyPoint point : centerline) { + int headroom = planner.sampleGeometry( + HydrologyGeometrySampler.Field.UNDERGROUND_HEADROOM, + profileKey, + point.x(), + point.z(), + courseId, + minimumHeadroom, + maximumHeadroom + ); + int minimumLandHeight = minimumLandHeightWithinRadius(point.x(), point.z(), radius); + if (minimumLandHeight != Integer.MAX_VALUE) { + segmentCap = Math.min(segmentCap, minimumLandHeight - headroom - planner.settings.underground().minimumRockCover()); + } + } + if (samples != null) { + samples.undergroundSegmentCaps.put(key, segmentCap); + } + return segmentCap; + } + + int[] nodeMaximumHeads(int[] segmentCaps) { + int[] maximumHeads = new int[segmentCaps.length + 1]; + maximumHeads[0] = segmentCaps[0]; + for (int index = 1; index < maximumHeads.length - 1; index++) { + maximumHeads[index] = Math.min(segmentCaps[index - 1], segmentCaps[index]); + } + maximumHeads[maximumHeads.length - 1] = segmentCaps[segmentCaps.length - 1]; + return maximumHeads; + } + + int minimumLandHeightWithinRadius(int x, int z, int radius) { + HydrologyPlanner.PlanningSamples samples = planner.planningSamples.get(); + MinimumLandHeightKey key = new MinimumLandHeightKey(x, z, radius); + if (samples != null) { + Integer cached = samples.minimumLandHeights.get(key); + if (cached != null) { + return cached; + } + } + + List offsets = samples == null + ? radialOffsets(radius) + : samples.radialOffsets.computeIfAbsent(radius, this::radialOffsets); + int minimumHeight = Integer.MAX_VALUE; + for (HydrologyGridOffset offset : offsets) { + HydrologyTerrainSample terrain = planner.sampleLandBasis(x + offset.x(), z + offset.z()); + if (terrain == null || terrain.ocean()) { + continue; + } + minimumHeight = Math.min(minimumHeight, terrain.naturalHeight()); + } + if (samples != null) { + samples.minimumLandHeights.put(key, minimumHeight); + } + return minimumHeight; + } + + List radialOffsets(int radius) { + int blockRadius = (int) StrictMath.ceil(radius + 0.25D); + ArrayList offsets = new ArrayList<>(); + for (int deltaZ = -blockRadius; deltaZ <= blockRadius; deltaZ++) { + for (int deltaX = -blockRadius; deltaX <= blockRadius; deltaX++) { + if (StrictMath.hypot(deltaX, deltaZ) <= radius + 0.25D) { + offsets.add(new HydrologyGridOffset(deltaX, deltaZ)); + } + } + } + return List.copyOf(offsets); + } + + int[] undergroundMinimumHeads(HydrologyCoursePath path, int[] depths, int outletHead) { + int[] minimumHeads = new int[path.points().size()]; + for (int index = 0; index < minimumHeads.length; index++) { + int depth = index == 0 + ? depths[0] + : index == depths.length ? depths[depths.length - 1] : Math.max(depths[index - 1], depths[index]); + depth = Math.max(depth, planner.settings.geometry().drops().maximumBasinDepth()); + long worldFloorHead = (long) planner.minimumY + depth + planner.settings.underground().minimumFloorCover(); + int boundedWorldFloor = worldFloorHead < Integer.MIN_VALUE + ? Integer.MIN_VALUE + : worldFloorHead > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) worldFloorHead; + int configuredMinimum = index == minimumHeads.length - 1 + ? outletHead + : planner.settings.underground().minimumFluidY(); + minimumHeads[index] = Math.max(outletHead, Math.max(configuredMinimum, boundedWorldFloor)); + } + return minimumHeads; + } + + static boolean undergroundHeadsFeasible( + int[] minimumHeads, + int[] maximumHeads, + int outletHead + ) { + if (minimumHeads.length == 0 || minimumHeads.length != maximumHeads.length) { + throw new IllegalArgumentException("Underground head arrays must have the same positive length."); + } + int index = minimumHeads.length - 1; + int requiredHead = Math.max(minimumHeads[index], outletHead); + if (requiredHead > maximumHeads[index]) { + return false; + } + for (index--; index >= 0; index--) { + requiredHead = Math.max(minimumHeads[index], requiredHead); + if (requiredHead > maximumHeads[index]) { + return false; + } + } + return true; + } + + static boolean solveUndergroundHeads( + int[] preferredHeads, + int[] minimumHeads, + int[] maximumHeads, + int outletHead, + int[] solvedHeads + ) { + int length = preferredHeads.length; + if (length == 0 + || minimumHeads.length != length + || maximumHeads.length != length + || solvedHeads.length != length) { + throw new IllegalArgumentException("Underground head arrays must have the same positive length."); + } + int[] requiredHeads = new int[length]; + requiredHeads[length - 1] = Math.max(minimumHeads[length - 1], outletHead); + if (requiredHeads[length - 1] > maximumHeads[length - 1]) { + return false; + } + for (int index = length - 2; index >= 0; index--) { + requiredHeads[index] = Math.max(minimumHeads[index], requiredHeads[index + 1]); + if (requiredHeads[index] > maximumHeads[index]) { + return false; + } + } + solvedHeads[0] = HydrologyPlanner.clamp(preferredHeads[0], requiredHeads[0], maximumHeads[0]); + for (int index = 1; index < length; index++) { + int maximum = Math.min(maximumHeads[index], solvedHeads[index - 1]); + if (requiredHeads[index] > maximum) { + return false; + } + solvedHeads[index] = HydrologyPlanner.clamp(preferredHeads[index], requiredHeads[index], maximum); + } + solvedHeads[length - 1] = outletHead; + return outletHead >= minimumHeads[length - 1] + && outletHead <= maximumHeads[length - 1] + && (length == 1 || solvedHeads[length - 2] >= outletHead); + } + + HydrologyCoursePath undergroundCoursePath(List edges, RiverOutlet outlet) { + ArrayList points = new ArrayList<>(); + ArrayList pairEdges = new ArrayList<>(); + for (DrainageEdge edge : edges) { + for (int pointIndex = 0; pointIndex < edge.centerline().size(); pointIndex++) { + HydrologyPoint point = edge.centerline().get(pointIndex); + if (points.isEmpty()) { + points.add(point); + } else if (pointIndex > 0) { + points.add(point); + pairEdges.add(edge); + } + } + } + return points.size() >= 2 && pairEdges.size() == points.size() - 1 + ? new HydrologyCoursePath( + List.copyOf(points), + List.copyOf(pairEdges), + List.copyOf(edges), + outlet, + true, + false, + null + ) + : null; + } + + void levelUndergroundMouth(HydrologyCoursePath path, int[] heads, int outletHead) { + heads[heads.length - 1] = outletHead; + int levelingDistance = planner.settings.outlets().mouthLevelingDistance(); + if (levelingDistance == 0) { + return; + } + double remaining = 0D; + int initialHead = heads[0]; + for (int index = path.points().size() - 2; index >= 0; index--) { + HydrologyPoint current = path.points().get(index); + HydrologyPoint downstream = path.points().get(index + 1); + remaining += StrictMath.hypot(downstream.x() - current.x(), downstream.z() - current.z()); + if (remaining > levelingDistance) { + break; + } + double ratio = remaining / levelingDistance; + int cap = outletHead + (int) StrictMath.ceil((initialHead - outletHead) * ratio); + heads[index] = Math.min(heads[index], cap); + } + for (int index = 1; index < heads.length; index++) { + heads[index] = Math.min(heads[index - 1], heads[index]); + } + heads[heads.length - 1] = outletHead; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/MinimumLandHeightKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/MinimumLandHeightKey.java new file mode 100644 index 000000000..129cb1c7b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/MinimumLandHeightKey.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record MinimumLandHeightKey(int x, int z, int radius) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCandidate.java b/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCandidate.java new file mode 100644 index 000000000..3ba3704fa --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCandidate.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record OutletCandidate(int landIndex, int oceanIndex, RiverOutlet outlet) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCourseKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCourseKey.java new file mode 100644 index 000000000..63d472fa6 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/OutletCourseKey.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record OutletCourseKey(long outletId) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RefinedEdgeKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RefinedEdgeKey.java new file mode 100644 index 000000000..64cc2eaaf --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RefinedEdgeKey.java @@ -0,0 +1,14 @@ +package art.arcane.iris.engine.hydrology; + +record RefinedEdgeKey( + long upstreamId, + long downstreamId, + int upstreamX, + int upstreamZ, + int downstreamX, + int downstreamZ, + int continuationX, + int continuationZ, + int transverseCandidates +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RouteCandidate.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteCandidate.java new file mode 100644 index 000000000..af7ca4ab9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteCandidate.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology; + +record RouteCandidate( + HydrologyPoint point, + double offset, + double localScore, + double terrainScore, + RouteDirection tangent, + boolean terrainResolved +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RouteDirection.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteDirection.java new file mode 100644 index 000000000..a5c6b499d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteDirection.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record RouteDirection(double x, double z) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RoutePosition.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutePosition.java new file mode 100644 index 000000000..114a72876 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutePosition.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record RoutePosition(double x, double z, double baseX, double baseZ, RouteDirection tangent) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RouteTerrainEstimate.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteTerrainEstimate.java new file mode 100644 index 000000000..76971ad1f --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RouteTerrainEstimate.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record RouteTerrainEstimate(int height, double terrainScore) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingContextLoad.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingContextLoad.java new file mode 100644 index 000000000..703098b0b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingContextLoad.java @@ -0,0 +1,6 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.concurrent.CompletableFuture; + +record RoutingContextLoad(Thread owner, CompletableFuture future) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingQueueEntry.java b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingQueueEntry.java new file mode 100644 index 000000000..37eb34ee2 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/RoutingQueueEntry.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology; + +record RoutingQueueEntry( + int nodeIndex, + double potential, + int outletIndex +) + implements Comparable { + @Override + public int compareTo(RoutingQueueEntry other) { + int potentialComparison = Double.compare(potential, other.potential); + if (potentialComparison != 0) { + return potentialComparison; + } + int nodeComparison = Integer.compare(nodeIndex, other.nodeIndex); + return nodeComparison != 0 ? nodeComparison : Integer.compare(outletIndex, other.outletIndex); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceAdmissionSelection.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceAdmissionSelection.java new file mode 100644 index 000000000..012cd4d01 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceAdmissionSelection.java @@ -0,0 +1,73 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; +import java.util.function.IntPredicate; + +final class SourceAdmissionSelection { + final int targetCount; + final List selectedCandidateIndices; + final boolean[] selectedCandidates; + final boolean[] spacingRejectedCandidates; + final boolean[] evaluatedCandidates; + final IntPredicate globallyAdmitted; + final int[] outletIndices; + final int maximumCoursesPerOutlet; + + SourceAdmissionSelection( + int targetCount, + List selectedCandidateIndices, + boolean[] selectedCandidates, + boolean[] spacingRejectedCandidates, + boolean[] evaluatedCandidates, + IntPredicate globallyAdmitted, + int[] outletIndices, + int maximumCoursesPerOutlet + ) { + if (outletIndices.length != selectedCandidates.length || maximumCoursesPerOutlet < 1) { + throw new IllegalArgumentException("Source outlet admission bounds are invalid."); + } + this.targetCount = targetCount; + this.selectedCandidateIndices = List.copyOf(selectedCandidateIndices); + this.selectedCandidates = selectedCandidates; + this.spacingRejectedCandidates = spacingRejectedCandidates; + this.evaluatedCandidates = evaluatedCandidates; + this.globallyAdmitted = globallyAdmitted; + this.outletIndices = outletIndices; + this.maximumCoursesPerOutlet = maximumCoursesPerOutlet; + } + + List selectedCandidateIndices() { + return selectedCandidateIndices; + } + + int targetCount() { + return targetCount; + } + + boolean selected(int candidateIndex) { + return selectedCandidates[candidateIndex]; + } + + boolean rejectedBySpacing(int candidateIndex) { + return spacingRejectedCandidates[candidateIndex]; + } + + boolean admitted(int candidateIndex) { + if (!evaluatedCandidates[candidateIndex]) { + evaluatedCandidates[candidateIndex] = true; + spacingRejectedCandidates[candidateIndex] = !globallyAdmitted.test(candidateIndex); + } + return !spacingRejectedCandidates[candidateIndex]; + } + + boolean outletQuotaAvailable(int candidateIndex, List selectedIndices) { + int outletIndex = outletIndices[candidateIndex]; + int selectedForOutlet = 0; + for (int selectedIndex : selectedIndices) { + if (outletIndices[selectedIndex] == outletIndex) { + selectedForOutlet++; + } + } + return selectedForOutlet < maximumCoursesPerOutlet; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceCandidate.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceCandidate.java new file mode 100644 index 000000000..9060c75f6 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceCandidate.java @@ -0,0 +1,9 @@ +package art.arcane.iris.engine.hydrology; + +record SourceCandidate( + int nodeIndex, + long stableId, + double score, + boolean required +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceRoutingContext.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceRoutingContext.java new file mode 100644 index 000000000..c7c5c885e --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceRoutingContext.java @@ -0,0 +1,14 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record SourceRoutingContext( + HydrologySampledGrid grid, + HydrologyRoutingPlan surfaceRouting, + HydrologyRoutingPlan undergroundRouting, + List diagnostics +) { + HydrologyRoutingPlan routing(boolean surface) { + return surface ? surfaceRouting : undergroundRouting; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java new file mode 100644 index 000000000..8a9751a36 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java @@ -0,0 +1,192 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +final class SourceSelection { + final boolean surface; + final List candidates; + final SourceAdmissionSelection admission; + final int guaranteedMinimum; + final int maximumOptionalRejections; + final int targetCount; + final ArrayList selectedCandidateIndices; + final boolean[] selectedCandidates; + final boolean[] attemptedCandidates; + int rejectedOptionalCandidates; + + SourceSelection( + boolean surface, + List candidates, + SourceAdmissionSelection admission, + int guaranteedMinimum, + int maximumOptionalRejections + ) { + if (guaranteedMinimum < 0 || guaranteedMinimum > admission.selectedCandidateIndices().size()) { + throw new IllegalArgumentException("Guaranteed source minimum is outside the admission bounds."); + } + if (maximumOptionalRejections < 0) { + throw new IllegalArgumentException("Maximum optional source rejections cannot be negative."); + } + this.surface = surface; + this.candidates = List.copyOf(candidates); + this.admission = admission; + this.guaranteedMinimum = guaranteedMinimum; + this.maximumOptionalRejections = maximumOptionalRejections; + this.selectedCandidateIndices = new ArrayList<>(admission.selectedCandidateIndices()); + this.targetCount = admission.targetCount(); + this.selectedCandidates = new boolean[candidates.size()]; + this.attemptedCandidates = new boolean[candidates.size()]; + for (int candidateIndex : selectedCandidateIndices) { + selectedCandidates[candidateIndex] = true; + } + } + + static SourceSelection empty(boolean surface) { + return new SourceSelection( + surface, + List.of(), + new SourceAdmissionSelection( + 0, + List.of(), + new boolean[0], + new boolean[0], + new boolean[0], + (int candidateIndex) -> false, + new int[0], + Integer.MAX_VALUE + ), + 0, + 0 + ); + } + + List selectedNodeIndices() { + ArrayList selectedNodes = new ArrayList<>(selectedCandidateIndices.size()); + for (int candidateIndex : selectedCandidateIndices) { + selectedNodes.add(candidates.get(candidateIndex).nodeIndex()); + } + return List.copyOf(selectedNodes); + } + + int candidateCount() { + return candidates.size(); + } + + boolean needsSurfaceFallback() { + return surface && targetCount > 0 && selectedCandidateIndices.isEmpty(); + } + + boolean hasAcceptedSelection() { + return !selectedCandidateIndices.isEmpty(); + } + + boolean advanceAfterPublication(List acceptedCourses, HydrologySampledGrid grid) { + Set acceptedSourceNodeIds = acceptedSourceNodeIds(acceptedCourses); + int acceptedRequired = 0; + boolean changed = false; + int selectedPosition = 0; + while (selectedPosition < selectedCandidateIndices.size()) { + int candidateIndex = selectedCandidateIndices.get(selectedPosition); + SourceCandidate candidate = candidates.get(candidateIndex); + long sourceNodeId = grid.node(candidate.nodeIndex()).id(); + if (acceptedSourceNodeIds.contains(sourceNodeId)) { + if (candidate.required()) { + attemptedCandidates[candidateIndex] = true; + acceptedRequired++; + } + selectedPosition++; + continue; + } + attemptedCandidates[candidateIndex] = true; + if (!candidate.required()) { + rejectedOptionalCandidates++; + } + selectedCandidateIndices.remove(selectedPosition); + selectedCandidates[candidateIndex] = false; + changed = true; + } + int requiredVacancies = Math.max(0, guaranteedMinimum - acceptedRequired); + for (int vacancy = 0; vacancy < requiredVacancies; vacancy++) { + int replacement = nextRequiredCandidate(); + if (replacement < 0) { + break; + } + selectedCandidateIndices.add(replacement); + selectedCandidates[replacement] = true; + changed = true; + } + while (selectedCandidateIndices.size() < targetCount) { + int replacement = nextAdmittedCandidate(); + if (replacement < 0) { + break; + } + selectedCandidateIndices.add(replacement); + selectedCandidates[replacement] = true; + changed = true; + } + return changed; + } + + Set acceptedSourceNodeIds(List acceptedCourses) { + RiverCourseType expectedType = surface ? RiverCourseType.SURFACE : RiverCourseType.UNDERGROUND; + HashSet accepted = new HashSet<>(); + for (RiverCourse course : acceptedCourses) { + if (course.type() == expectedType && course.sourceNodeId().isPresent()) { + accepted.add(course.sourceNodeId().getAsLong()); + } + } + return accepted; + } + + int nextRequiredCandidate() { + for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { + SourceCandidate candidate = candidates.get(candidateIndex); + if (candidate.required() + && !selectedCandidates[candidateIndex] + && !attemptedCandidates[candidateIndex] + && admission.outletQuotaAvailable(candidateIndex, selectedCandidateIndices)) { + return candidateIndex; + } + } + return -1; + } + + int nextAdmittedCandidate() { + if (rejectedOptionalCandidates >= maximumOptionalRejections) { + return -1; + } + for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { + if (!selectedCandidates[candidateIndex] + && !attemptedCandidates[candidateIndex] + && admission.outletQuotaAvailable(candidateIndex, selectedCandidateIndices) + && admission.admitted(candidateIndex)) { + return candidateIndex; + } + } + return -1; + } + + void addFinalAdmissionDiagnostics( + HydrologySampledGrid grid, + List diagnostics + ) { + for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { + if (selectedCandidates[candidateIndex] || attemptedCandidates[candidateIndex]) { + continue; + } + SourceCandidate candidate = candidates.get(candidateIndex); + HydrologySourcePlanner.addSourceDiagnostic( + grid.node(candidate.nodeIndex()), + surface, + candidate.stableId(), + admission.rejectedBySpacing(candidateIndex) + ? HydrologyCandidateRejection.SOURCE_SPACING + : HydrologyCandidateRejection.SOURCE_QUOTA, + diagnostics + ); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceCourseDraft.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceCourseDraft.java new file mode 100644 index 000000000..a574ca2a0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceCourseDraft.java @@ -0,0 +1,9 @@ +package art.arcane.iris.engine.hydrology; + +record SurfaceCourseDraft( + HydrologyGridNode source, + long courseId, + String profileKey, + HydrologyCoursePath path +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceRouteKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceRouteKey.java new file mode 100644 index 000000000..ca3ddca5e --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SurfaceRouteKey.java @@ -0,0 +1,6 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record SurfaceRouteKey(List guide, long geometryId) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundCourseDraft.java b/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundCourseDraft.java new file mode 100644 index 000000000..692c6cb63 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundCourseDraft.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record UndergroundCourseDraft(HydrologyGridNode source, long courseId, HydrologyCoursePath path) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundSegmentCapKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundSegmentCapKey.java new file mode 100644 index 000000000..a9e188edf --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/UndergroundSegmentCapKey.java @@ -0,0 +1,14 @@ +package art.arcane.iris.engine.hydrology; + +record UndergroundSegmentCapKey( + long courseId, + String profileKey, + int startX, + int startZ, + int endX, + int endZ, + int radius, + int minimumHeadroom, + int maximumHeadroom +) { +} diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlanHashTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlanHashTest.java new file mode 100644 index 000000000..9c27e2032 --- /dev/null +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlanHashTest.java @@ -0,0 +1,227 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlan; +import org.junit.Test; + +import java.nio.charset.StandardCharsets; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.List; +import java.util.Map; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class HydrologyPlanHashTest { + private static final String EXPECTED_PLAN_DIGEST = "de765d4be6c95954f8df344ee2d1dd72c97e8640fc28c92c3ec4717cff0d88e4"; + + private static final List TILES = List.of( + new HydrologyTileKey(0, 0), + new HydrologyTileKey(-1, -1), + new HydrologyTileKey(0, -1), + new HydrologyTileKey(1, 0)); + + @Test + public void fullTilePlansAreByteIdentical() { + StringBuilder canonical = new StringBuilder(); + int courses = 0; + int columns = 0; + for (long seed : new long[]{77L, 19L}) { + HydrologyPlannerSettings settings = planSettings(); + HydrologyPlanner planner = new HydrologyPlanner(seed, settings, rollingCoast(112)); + for (HydrologyTileKey key : TILES) { + HydrologyTile tile = planner.plan(key); + courses += tile.courses().size(); + columns += tile.footprint().columns().size(); + canonical.append(render(tile)); + } + } + assertTrue("planned courses: " + courses, courses > 0); + assertTrue("planned columns: " + columns, columns > 0); + assertEquals(EXPECTED_PLAN_DIGEST, digest(canonical.toString())); + } + + private static String render(HydrologyTile tile) { + StringBuilder out = new StringBuilder(); + out.append("tile ").append(tile.key()).append('\n'); + out.append("seed ").append(tile.worldSeed()).append('\n'); + out.append("fingerprint ").append(tile.settingsFingerprint()).append('\n'); + out.append("size ").append(tile.tileSize()).append('\n'); + for (DrainageNode node : tile.nodes()) { + out.append("node ").append(node).append('\n'); + } + for (DrainageEdge edge : tile.edges()) { + out.append("edge ").append(edge).append('\n'); + } + for (RiverOutlet outlet : tile.outlets()) { + out.append("outlet ").append(outlet).append('\n'); + } + for (RiverCourse course : tile.courses()) { + out.append("course ").append(course).append('\n'); + } + for (HydrologyCavePlan plan : tile.cavePlans()) { + out.append("cave ").append(plan).append('\n'); + } + for (HydrologyDiagnosticCandidate diagnostic : tile.diagnosticCandidates()) { + out.append("diagnostic ").append(diagnostic).append('\n'); + } + for (HydrologyFeatureRef feature : tile.features()) { + out.append("feature ").append(feature).append('\n'); + } + List> columns = + new ArrayList<>(tile.footprint().columns().entrySet()); + columns.sort(Comparator.comparingLong(Map.Entry::getKey)); + for (Map.Entry column : columns) { + out.append("column ").append(column.getKey()).append(' ').append(column.getValue()).append('\n'); + } + return out.toString(); + } + + private static String digest(String value) { + MessageDigest sha256; + try { + sha256 = MessageDigest.getInstance("SHA-256"); + } catch (NoSuchAlgorithmException e) { + throw new IllegalStateException(e); + } + byte[] hash = sha256.digest(value.getBytes(StandardCharsets.UTF_8)); + StringBuilder hex = new StringBuilder(hash.length * 2); + for (byte b : hash) { + hex.append(Character.forDigit((b >> 4) & 0xF, 16)); + hex.append(Character.forDigit(b & 0xF, 16)); + } + return hex.toString(); + } + + private static HydrologyTerrainSampler rollingCoast(int coastX) { + return (int x, int z) -> { + if (x >= coastX) { + return oceanTerrain(); + } + int height = 118 - Math.floorDiv(x, 12) + (int) StrictMath.round(StrictMath.sin(z / 18D) * 2D); + return landTerrain(height, x >= 0 && x <= 24); + }; + } + + private static HydrologyTerrainSample landTerrain(int height, boolean source) { + return new HydrologyTerrainSample( + height, + 1D, + false, + true, + 72, + 74, + true, + true, + source, + true, + true, + false, + 0D, + source ? 1D : 0D, + 1D, + 1D, + 1D, + 1D, + 1D, + 1D, + "parent", + "surface", + "mouth", + "shore", + "dry", + "flooded", + List.of("beta", "alpha"), + List.of(), + Double.NaN, + null, + Double.NaN, + true + ); + } + + private static HydrologyTerrainSample oceanTerrain() { + return new HydrologyTerrainSample( + 54, + 0D, + true, + false, + 30, + 32, + false, + false, + false, + false, + false, + false, + 0D, + 0D, + 0D, + 1D, + 1D, + 1D, + 1D, + 1D, + "parent", + "surface", + "mouth", + "shore", + "dry", + "flooded", + List.of("beta", "alpha"), + List.of(), + Double.NaN, + null, + Double.NaN, + true + ); + } + + private static HydrologyPlannerSettings planSettings() { + HydrologyPlannerSettings.Source surfaceSources = new HydrologyPlannerSettings.Source( + true, 4D, 80, 0, 6, 24); + HydrologyPlannerSettings.Source undergroundSources = new HydrologyPlannerSettings.Source( + true, 2D, Integer.MIN_VALUE, 0, 4, 32); + HydrologyPlannerSettings.ChannelShape stableChannel = + HydrologyPlannerSettings.ChannelShape.of(2D, 0D, 0D, 11); + HydrologyPlannerSettings.Geometry geometry = new HydrologyPlannerSettings.Geometry( + new HydrologyPlannerSettings.Meanders(224, 72, 0D, 0D, 0D, 0, 75D), + stableChannel, + stableChannel, + stableChannel, + HydrologyPlannerSettings.Geometry.defaults().drops()); + return new HydrologyPlannerSettings( + 63, + new HydrologyPlannerSettings.Routing(128, 16, 512, 256, 0, 0, 0.5D, 12D, 0.5D, 0.1D, 1D, 0), + new HydrologyPlannerSettings.Surface( + true, + surfaceSources, + 4, + 18, + 2, + 4, + 10, + 1.5D, + HydrologyPlannerSettings.Banks.defaults()), + new HydrologyPlannerSettings.Hydraulics(4), + HydrologyPlannerSettings.Underground.of( + true, undergroundSources, 68, 82, 4, 12, 2, 4, 5, 9, true, 0), + HydrologyPlannerSettings.Outlets.of( + true, + new HydrologyPlannerSettings.Grotto(false, 4, 3, 3, 4096), + new HydrologyPlannerSettings.Grotto(false, 4, 3, 3, 4096), + false, + 12, + 32, + 2, + 4, + 4), + geometry, + List.of(), + List.of(), + 0D, + HydrologyPlannerSettings.SeaCaves.disabled()); + } +} diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerGlobalInvariantTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerGlobalInvariantTest.java index 8e11fb768..c39f6422c 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerGlobalInvariantTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerGlobalInvariantTest.java @@ -188,7 +188,7 @@ public class HydrologyPlannerGlobalInvariantTest { globallyAdmitted[candidateIndex] = random.nextBoolean(); } - HydrologyPlanner.SourceAdmissionSelection lazy = HydrologyPlanner.selectSourceAdmissions( + SourceAdmissionSelection lazy = HydrologySourcePlanner.selectSourceAdmissions( candidateCount, target, guaranteed, @@ -208,7 +208,7 @@ public class HydrologyPlannerGlobalInvariantTest { public void lazyAdmissionStopsGlobalEvaluationWhenQuotaIsFilled() { AtomicInteger evaluations = new AtomicInteger(); - HydrologyPlanner.SourceAdmissionSelection selection = HydrologyPlanner.selectSourceAdmissions( + SourceAdmissionSelection selection = HydrologySourcePlanner.selectSourceAdmissions( 256, 1, 0, diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerSettingsTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerSettingsTest.java index 4d445d62a..984a2b501 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerSettingsTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerSettingsTest.java @@ -331,12 +331,12 @@ public class HydrologyPlannerSettingsTest { ); HydrologyTerrainSample terrainWithoutUndergroundRiverCave = HydrologyTerrainSample.openLand(100, 1D, "parent"); - assertFalse(HydrologyPlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 3, 3, 0)); - assertTrue(HydrologyPlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 3, 3, -64)); - assertTrue(HydrologyPlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 4, 3, 0)); - assertTrue(HydrologyPlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 80, 3, 0)); - assertFalse(HydrologyPlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 96, 3, 0)); - assertFalse(HydrologyPlanner.deepSiteFits( + assertFalse(HydrologyFeatureSitePlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 3, 3, 0)); + assertTrue(HydrologyFeatureSitePlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 3, 3, -64)); + assertTrue(HydrologyFeatureSitePlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 4, 3, 0)); + assertTrue(HydrologyFeatureSitePlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 80, 3, 0)); + assertFalse(HydrologyFeatureSitePlanner.deepSiteFits(terrainWithoutUndergroundRiverCave, deepFluid, 96, 3, 0)); + assertFalse(HydrologyFeatureSitePlanner.deepSiteFits( HydrologyTerrainSample.ocean(50, "ocean"), deepFluid, 40, diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTest.java index 9298469df..d5fdccf39 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTest.java @@ -536,7 +536,7 @@ public class HydrologyPlannerTest { } private static AutoCloseable earlyAdmission(HydrologyPlanner planner, HydrologyTileKey key) throws Exception { - Class contextType = Class.forName(HydrologyPlanner.class.getName() + "$CrossTileResolutionContext"); + Class contextType = CrossTileResolutionContext.class; Constructor contextConstructor = contextType.getDeclaredConstructor(HydrologyTileKey.class, long.class, int.class); contextConstructor.setAccessible(true); Object context = contextConstructor.newInstance(key, 64L, 4096); @@ -631,8 +631,8 @@ public class HydrologyPlannerTest { @Test public void biomeIncisionMultiplierCannotExceedTheConfiguredSurfaceMaximum() { - assertEquals(6, HydrologyPlanner.permittedSurfaceIncision(6, 2D)); - assertEquals(3, HydrologyPlanner.permittedSurfaceIncision(6, 0.5D)); + assertEquals(6, HydrologySourcePlanner.permittedSurfaceIncision(6, 2D)); + assertEquals(3, HydrologySourcePlanner.permittedSurfaceIncision(6, 0.5D)); } @Test @@ -709,12 +709,12 @@ public class HydrologyPlannerTest { @Test public void fallbackSourceTargetCannotExceedAvailableOutlets() { - assertEquals(1, HydrologyPlanner.effectiveSourceTarget(true, 8, 1)); - assertEquals(0, HydrologyPlanner.effectiveSourceTarget(true, 8, 0)); - assertEquals(8, HydrologyPlanner.effectiveSourceTarget(false, 8, 1)); + assertEquals(1, HydrologySourcePlanner.effectiveSourceTarget(true, 8, 1)); + assertEquals(0, HydrologySourcePlanner.effectiveSourceTarget(true, 8, 0)); + assertEquals(8, HydrologySourcePlanner.effectiveSourceTarget(false, 8, 1)); assertThrows( IllegalArgumentException.class, - () -> HydrologyPlanner.effectiveSourceTarget(true, -1, 1) + () -> HydrologySourcePlanner.effectiveSourceTarget(true, -1, 1) ); } @@ -1507,7 +1507,7 @@ public class HydrologyPlannerTest { int outlet = random.nextInt(11) - 3; boolean expected = bruteForceUndergroundHeads(minimum, maximum, outlet, 0, Integer.MAX_VALUE); - boolean actual = HydrologyPlanner.solveUndergroundHeads( + boolean actual = HydrologyUndergroundCoursePlanner.solveUndergroundHeads( preferred, minimum, maximum, @@ -3424,31 +3424,31 @@ public class HydrologyPlannerTest { } private double anchorScore(HydrologyPlanner planner, HydrologyTerrainSample terrain, int x, int z) throws Exception { - Class nodeType = Class.forName(HydrologyPlanner.class.getName() + "$GridNode"); + Class nodeType = HydrologyGridNode.class; Constructor constructor = nodeType.getDeclaredConstructor(int.class, int.class, int.class, int.class, int.class, long.class, HydrologyTerrainSample.class); constructor.setAccessible(true); Object node = constructor.newInstance(0, 0, 0, 0, 0, 719L, terrain); - Method method = HydrologyPlanner.class.getDeclaredMethod("anchorScore", nodeType, + Method method = HydrologyRouteGeometry.class.getDeclaredMethod("anchorScore", nodeType, int.class, int.class, int.class, int.class, double.class); method.setAccessible(true); - return (double) method.invoke(planner, node, x, z, 0, 0, 0.3D); + return (double) method.invoke(planner.routeGeometry, node, x, z, 0, 0, 0.3D); } private List routeCandidates(HydrologyPlanner planner) throws Exception { - Class directionType = Class.forName(HydrologyPlanner.class.getName() + "$Direction"); + Class directionType = RouteDirection.class; Constructor directionConstructor = directionType.getDeclaredConstructor(double.class, double.class); directionConstructor.setAccessible(true); Object direction = directionConstructor.newInstance(1D, 0D); - Class positionType = Class.forName(HydrologyPlanner.class.getName() + "$RoutePosition"); + Class positionType = RoutePosition.class; Constructor positionConstructor = positionType.getDeclaredConstructor(double.class, double.class, double.class, double.class, directionType); positionConstructor.setAccessible(true); Object position = positionConstructor.newInstance(0D, 0D, 100D, 0D, direction); - Method method = HydrologyPlanner.class.getDeclaredMethod("routeCandidates", long.class, long.class, + Method method = HydrologyRouteGeometry.class.getDeclaredMethod("routeCandidates", long.class, long.class, positionType, double.class, int.class, int.class, String.class); method.setAccessible(true); - return (List) method.invoke(planner, 1L, 2L, position, 0.5D, 4, 1, null); + return (List) method.invoke(planner.routeGeometry, 1L, 2L, position, 0.5D, 4, 1, null); } private static final class CountingNaturalSampler implements HydrologyNaturalTerrainSampler { diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTributaryTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTributaryTest.java index d53cae636..52faae3fd 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTributaryTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyPlannerTributaryTest.java @@ -108,7 +108,7 @@ public class HydrologyPlannerTributaryTest { ArrayList segments = new ArrayList<>(List.of(new HydraulicSegment( 1L, 7L, HydrologyFeatureType.SURFACE_POOL, 120, 120, 4, 2, false, false, List.copyOf(centerline)))); - planner.levelApproach(segments, 100); + planner.tributaries.levelApproach(segments, 100); List graded = new ArrayList<>(); int previousHead = Integer.MAX_VALUE; @@ -146,7 +146,7 @@ public class HydrologyPlannerTributaryTest { ArrayList segments = new ArrayList<>(List.of(new HydraulicSegment( 1L, 7L, HydrologyFeatureType.SURFACE_POOL, 120, 120, 4, 2, false, false, List.copyOf(centerline)))); - planner.levelApproach(segments, 112); + planner.tributaries.levelApproach(segments, 112); List graded = segments.getFirst().centerline(); assertEquals(13, graded.size()); diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteLengthsTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteLengthsTest.java index c13096af0..f54f50ebd 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteLengthsTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteLengthsTest.java @@ -19,10 +19,10 @@ public class HydrologyRouteLengthsTest { int[] parent = forest(width, random); HydrologyPlannerSettings.Routing routing = routing(spacing, maximumLength); assertArrayEquals(walks(parent, width, routing), - HydrologyPlanner.routeLengths(parent, width, routing)); + HydrologySourcePlanner.routeLengths(parent, width, routing)); reverse(parent); assertArrayEquals(walks(parent, width, routing), - HydrologyPlanner.routeLengths(parent, width, routing)); + HydrologySourcePlanner.routeLengths(parent, width, routing)); } } } @@ -32,7 +32,7 @@ public class HydrologyRouteLengthsTest { public void exactLengthLimitAndMissingOutletsKeepTheirBounds() { int[] parent = {1, 2, 3, 4, -1, -1, -1, -1, -1}; assertArrayEquals(new int[]{Integer.MAX_VALUE, 12, 8, 4, 0, 0, 0, 0, 0}, - HydrologyPlanner.routeLengths(parent, 9, routing(4, 12))); + HydrologySourcePlanner.routeLengths(parent, 9, routing(4, 12))); } @Test @@ -48,11 +48,11 @@ public class HydrologyRouteLengthsTest { } } parent[parent.length - 1] = -1; - int[] lengths = HydrologyPlanner.routeLengths(parent, width, routing(4, Integer.MAX_VALUE)); + int[] lengths = HydrologySourcePlanner.routeLengths(parent, width, routing(4, Integer.MAX_VALUE)); assertEquals((parent.length - 1) * 4, lengths[0]); assertEquals(0, lengths[lengths.length - 1]); reverse(parent); - lengths = HydrologyPlanner.routeLengths(parent, width, routing(4, Integer.MAX_VALUE)); + lengths = HydrologySourcePlanner.routeLengths(parent, width, routing(4, Integer.MAX_VALUE)); assertEquals((parent.length - 1) * 4, lengths[lengths.length - 1]); assertEquals(0, lengths[0]); } @@ -60,7 +60,7 @@ public class HydrologyRouteLengthsTest { @Test public void cyclesFailBeforeTheyCanStallPlanning() { assertThrows(IllegalStateException.class, - () -> HydrologyPlanner.routeLengths(new int[]{1, 0}, 2, routing(4, 128))); + () -> HydrologySourcePlanner.routeLengths(new int[]{1, 0}, 2, routing(4, 128))); } private static int[] forest(int width, Random random) { diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteTurnCacheTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteTurnCacheTest.java index 1e19e69e7..ee37443bc 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteTurnCacheTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyRouteTurnCacheTest.java @@ -194,22 +194,22 @@ public class HydrologyRouteTurnCacheTest { } private static final class Solver { - private final HydrologyPlanner planner = mock(HydrologyPlanner.class, CALLS_REAL_METHODS); + private final HydrologyRouteGeometry geometry = mock(HydrologyRouteGeometry.class, CALLS_REAL_METHODS); private final Constructor candidateConstructor; private final Object tangent; private final Method solve; private final Method indices; private Solver() throws Exception { - Class direction = Class.forName(HydrologyPlanner.class.getName() + "$Direction"); + Class direction = RouteDirection.class; Constructor directionConstructor = direction.getDeclaredConstructor(double.class, double.class); directionConstructor.setAccessible(true); tangent = directionConstructor.newInstance(1D, 0D); - Class candidate = Class.forName(HydrologyPlanner.class.getName() + "$RouteCandidate"); + Class candidate = RouteCandidate.class; candidateConstructor = candidate.getDeclaredConstructor(HydrologyPoint.class, double.class, double.class, double.class, direction, boolean.class); candidateConstructor.setAccessible(true); - solve = HydrologyPlanner.class.getDeclaredMethod("selectCurvatureAwareTerrainRoute", List.class, + solve = HydrologyRouteGeometry.class.getDeclaredMethod("selectCurvatureAwareTerrainRoute", List.class, double.class, double.class, double.class, double[][].class, double[][][].class, double[][][][].class); solve.setAccessible(true); indices = solve.getReturnType().getDeclaredMethod("indices"); @@ -226,7 +226,7 @@ public class HydrologyRouteTurnCacheTest { } layers.add(candidates); } - return (int[]) indices.invoke(solve.invoke(planner, layers, 12D, maximumTurn, 12D, + return (int[]) indices.invoke(solve.invoke(geometry, layers, 12D, maximumTurn, 12D, fixture.penalties(), fixture.transitions(), cache)); } } From 2fb1dc4fd6091d9bea3bbfc5c9199c027a78e592 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:50:50 -0400 Subject: [PATCH 24/35] Restore datapack bukkit purity - Return the Minecraft version lookups to DatapackIngestService so no new file couples to org.bukkit - Drop the redundant self imports of the service's own nested types --- .../core/datapack/DatapackIngestService.java | 22 ++++++++++++------- .../datapack/DatapackStartupValidation.java | 2 +- .../iris/core/datapack/DatapackSupport.java | 12 ---------- .../datapack/DatapackIngestServiceTest.java | 4 ++-- 4 files changed, 17 insertions(+), 23 deletions(-) diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java index 4c7005fe8..71b82d927 100644 --- a/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackIngestService.java @@ -18,12 +18,6 @@ package art.arcane.iris.core.datapack; -import art.arcane.iris.core.datapack.DatapackIngestService.StructureScopeResources; -import art.arcane.iris.core.datapack.DatapackIngestService.StartupValidationOutcome; -import art.arcane.iris.core.datapack.DatapackIngestService.Report; -import art.arcane.iris.core.datapack.DatapackIngestService.ReapplyStatus; -import art.arcane.iris.core.datapack.DatapackIngestService.ReapplyOutcome; -import art.arcane.iris.core.datapack.DatapackIngestService.Entry; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisPlatforms; import art.arcane.iris.core.IrisStartupValidation; @@ -31,6 +25,7 @@ import art.arcane.iris.core.IrisSettings; import art.arcane.iris.core.ServerConfigurator; import art.arcane.iris.core.datapack.ModrinthResolver.ResolvedDatapack; import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.nms.MinecraftVersion; import art.arcane.iris.core.project.IrisProject; import art.arcane.iris.core.project.IrisCodeWorkspace; import art.arcane.iris.engine.object.IrisDimension; @@ -38,6 +33,8 @@ import art.arcane.iris.util.common.format.C; import art.arcane.iris.util.common.plugin.VolmitSender; import art.arcane.volmlib.util.collection.KList; import art.arcane.volmlib.util.io.IO; +import org.bukkit.Bukkit; +import org.bukkit.Server; import java.io.File; import java.io.IOException; @@ -78,7 +75,7 @@ public final class DatapackIngestService { List urls = configured.stream().sorted().toList(); boolean autoIngest = IrisSettings.get().getGeneral().autoIngestDatapacks; boolean stripOverrides = DatapackPackMetadata.resolveStripOverrides(); - String mcVersion = DatapackSupport.serverMcVersion(); + String mcVersion = serverMcVersion(); int irisVersion = IrisPlatforms.get().irisVersionNumber(); File root = IrisPlatforms.get().dataFolder("datapacks"); KList worldFolders = ServerConfigurator.getDatapacksFolder(); @@ -156,6 +153,15 @@ public final class DatapackIngestService { DatapackStartupValidation.refreshStartupValidationAfterMaintenance(maintenanceChanged); } + static String serverMcVersion() { + return serverMcVersion(Bukkit.getServer()); + } + + static String serverMcVersion(Server server) { + MinecraftVersion detected = MinecraftVersion.detect(server); + return detected == null ? null : detected.value(); + } + public static void refreshWorkspaces() { try (Stream stream = ServerConfigurator.allPacks()) { stream.forEach(DatapackIngestService::refreshWorkspace); @@ -244,7 +250,7 @@ public final class DatapackIngestService { } KList worldFolders = ServerConfigurator.getDatapacksFolder(); - String mcVersion = DatapackSupport.serverMcVersion(); + String mcVersion = serverMcVersion(); try { DatapackScratchRecovery.recoverTransactions(root, worldFolders); } catch (IOException e) { diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java index 924a80fc0..838776064 100644 --- a/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackStartupValidation.java @@ -95,7 +95,7 @@ final class DatapackStartupValidation { List urls = configured.stream().sorted().toList(); boolean autoIngest = IrisSettings.get().getGeneral().autoIngestDatapacks; boolean stripOverrides = DatapackPackMetadata.resolveStripOverrides(); - String mcVersion = DatapackSupport.serverMcVersion(); + String mcVersion = DatapackIngestService.serverMcVersion(); int irisVersion = IrisPlatforms.get().irisVersionNumber(); if (!startupValidationContextMatches( validated, mcVersion, irisVersion, autoIngest, stripOverrides, urls)) { diff --git a/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java b/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java index 52da21707..42be7a288 100644 --- a/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java +++ b/core/src/main/java/art/arcane/iris/core/datapack/DatapackSupport.java @@ -19,13 +19,10 @@ package art.arcane.iris.core.datapack; import art.arcane.iris.spi.IrisLogging; -import art.arcane.iris.core.nms.MinecraftVersion; import art.arcane.iris.util.common.io.Durability; import art.arcane.iris.util.common.plugin.VolmitSender; import com.google.gson.Gson; import com.google.gson.GsonBuilder; -import org.bukkit.Bukkit; -import org.bukkit.Server; import java.io.File; import java.io.IOException; @@ -130,15 +127,6 @@ final class DatapackSupport { throw new IOException("Cannot determine " + purpose + " state at " + path); } - static String serverMcVersion() { - return serverMcVersion(Bukkit.getServer()); - } - - static String serverMcVersion(Server server) { - MinecraftVersion detected = MinecraftVersion.detect(server); - return detected == null ? null : detected.value(); - } - static String safe(String value) { return value == null || value.isBlank() ? "?" : value; } diff --git a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java index a61082737..135cfbca7 100644 --- a/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java +++ b/core/src/test/java/art/arcane/iris/core/datapack/DatapackIngestServiceTest.java @@ -72,7 +72,7 @@ public class DatapackIngestServiceTest { doReturn("26.2").when(server).getMinecraftVersion(); doReturn("26.2.build.33").when(server).getBukkitVersion(); - assertEquals("26.2", DatapackSupport.serverMcVersion(server)); + assertEquals("26.2", DatapackIngestService.serverMcVersion(server)); } @Test @@ -80,7 +80,7 @@ public class DatapackIngestServiceTest { Server server = mock(Server.class); doReturn("1.21.4-R0.1-SNAPSHOT").when(server).getBukkitVersion(); - assertEquals("1.21.4", DatapackSupport.serverMcVersion(server)); + assertEquals("1.21.4", DatapackIngestService.serverMcVersion(server)); } @Test From 85e12caf9bf324cbe3fd356affd0428c45950daa Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:50:51 -0400 Subject: [PATCH 25/35] Split hydrology footprint and cave planners - Move segment rasterisation and channel shaping out of HydrologyFootprintCompiler into HydrologyFootprintRasterizer and HydrologyChannelGeometry - Move chamber, throat and pool construction out of HydrologyCaveContainmentPlanner into HydrologyCaveChamberPlanner - Promote the candidate span, candidate builder, stencil, column and cave observation types out of the three compilers to top level --- .../engine/hydrology/CaveCandidateBounds.java | 35 + .../hydrology/CaveCandidateBuilder.java | 189 +++ .../hydrology/CaveCandidateSpanBuilder.java | 360 +++++ .../engine/hydrology/CaveCourseGraph.java | 10 + .../iris/engine/hydrology/CaveSpanSet.java | 103 ++ .../hydrology/CaveSurfaceComposition.java | 18 + .../engine/hydrology/CaveSurfaceOpening.java | 74 + .../iris/engine/hydrology/CaveYSpan.java | 4 + .../hydrology/CrossTileResolutionContext.java | 6 +- .../iris/engine/hydrology/DraftProfile.java | 8 +- .../FootprintCenterlineProjection.java | 11 + .../hydrology/FootprintCourseRasterKey.java | 11 + .../engine/hydrology/FootprintFeatureKey.java | 11 + .../engine/hydrology/FootprintLayerShape.java | 19 + .../hydrology/FootprintMutableColumn.java | 173 ++ .../hydrology/FootprintRasterStencil.java | 11 + .../FootprintRasterStencilBuilder.java | 37 + .../hydrology/FootprintRasterStencilKey.java | 8 + .../FootprintValidationCourseRaster.java | 12 + .../hydrology/HydrologyCaveCourseFilter.java | 921 ++--------- .../hydrology/HydrologyChannelGeometry.java | 358 +++++ .../hydrology/HydrologyFootprintCompiler.java | 1395 ++--------------- .../HydrologyFootprintRasterizer.java | 565 +++++++ .../engine/hydrology/SourceSelection.java | 12 +- .../hydrology/cave/CaveBoundaryResult.java | 18 + .../hydrology/cave/CaveCachedValidation.java | 14 + .../engine/hydrology/cave/CaveClaimGroup.java | 9 + .../hydrology/cave/CaveComponentResult.java | 18 + .../hydrology/cave/CaveGrottoResult.java | 18 + .../cave/CaveIndependentDecision.java | 16 + .../engine/hydrology/cave/CavePathResult.java | 13 + .../cave/CaveSurfaceObservations.java | 40 + .../hydrology/cave/CaveValidationBatch.java | 11 + .../hydrology/cave/CaveViewObservations.java | 30 + .../cave/HydrologyCaveChamberPlanner.java | 809 ++++++++++ .../cave/HydrologyCaveContainmentPlanner.java | 1137 +------------- .../cave/RecordingCaveVoxelView.java | 96 ++ 37 files changed, 3370 insertions(+), 3210 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBounds.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBuilder.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateSpanBuilder.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveCourseGraph.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveSpanSet.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceComposition.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceOpening.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/CaveYSpan.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCenterlineProjection.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCourseRasterKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintFeatureKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintLayerShape.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintMutableColumn.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencil.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilBuilder.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilKey.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/FootprintValidationCourseRaster.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyChannelGeometry.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintRasterizer.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveBoundaryResult.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveCachedValidation.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveClaimGroup.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveComponentResult.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveGrottoResult.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveIndependentDecision.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CavePathResult.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveSurfaceObservations.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveValidationBatch.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveViewObservations.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveChamberPlanner.java create mode 100644 core/src/main/java/art/arcane/iris/engine/hydrology/cave/RecordingCaveVoxelView.java diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBounds.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBounds.java new file mode 100644 index 000000000..35013312c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBounds.java @@ -0,0 +1,35 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.CavePosition; + +record CaveCandidateBounds( + int entryX, + int entryY, + int entryZ, + int waterHeadY, + int horizontalRadius, + int maximumDepth, + int dryHeadroom +) { + boolean containsColumn(int x, int z) { + long deltaX = (long) x - entryX; + long deltaZ = (long) z - entryZ; + long radiusSquared = (long) horizontalRadius * horizontalRadius; + return deltaX * deltaX + deltaZ * deltaZ <= radiusSquared; + } + + int minimumY() { + return Math.toIntExact((long) entryY - maximumDepth); + } + + int maximumY() { + return Math.max(entryY, Math.addExact(waterHeadY, dryHeadroom + 1)); + } + + boolean contains(CavePosition position) { + if (!containsColumn(position.x(), position.z())) { + return false; + } + return position.y() >= minimumY() && position.y() <= maximumY(); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBuilder.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBuilder.java new file mode 100644 index 000000000..deb7f24b9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateBuilder.java @@ -0,0 +1,189 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.CavePosition; +import art.arcane.iris.engine.hydrology.cave.CavePositionIndex; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveAction; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCandidate; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveFluidPolicy; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveGrottoShape; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveMode; +import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlannerSettings; +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveSource; + +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; + +final class CaveCandidateBuilder { + private final RiverCourse course; + private final HydraulicSegment representative; + private final LinkedHashMap actions; + private final LinkedHashSet openings; + private final CavePositionIndex openingIndex; + private final List surfaceOpenings; + private int minimumX; + private int maximumX; + private int minimumY; + private int maximumY; + private int minimumZ; + private int maximumZ; + + CaveCandidateBuilder(RiverCourse course, HydraulicSegment representative) { + this.course = course; + this.representative = representative; + this.actions = new LinkedHashMap<>(); + this.openings = new LinkedHashSet<>(); + this.openingIndex = new CavePositionIndex(); + this.surfaceOpenings = HydrologyCaveCourseFilter.surfaceOpenings(course); + this.minimumX = Integer.MAX_VALUE; + this.maximumX = Integer.MIN_VALUE; + this.minimumY = Integer.MAX_VALUE; + this.maximumY = Integer.MIN_VALUE; + this.minimumZ = Integer.MAX_VALUE; + this.maximumZ = Integer.MIN_VALUE; + } + + private RiverCourse course() { + return course; + } + + private HydraulicSegment representative() { + return representative; + } + + boolean isEmpty() { + return actions.isEmpty(); + } + + void addAction(CavePosition position, HydrologyCaveAction action) { + HydrologyCaveAction existing = actions.get(position); + if (existing == null || actionPriority(action) < actionPriority(existing)) { + actions.put(position, action); + } + include(position); + } + + void addOpening(CavePosition position) { + if (openingIndex.add(position.x(), position.y(), position.z())) { + openings.add(position); + } + include(position); + } + + void addOpening(int x, int y, int z) { + if (openingIndex.add(x, y, z)) { + openings.add(new CavePosition(x, y, z)); + } + include(x, y, z); + } + + void addOpeningNeighborhood(CavePosition position) { + addOpening(position); + for (int[] offset : HydrologyCaveCourseFilter.NEIGHBORS) { + addOpening( + position.x() + offset[0], + position.y() + offset[1], + position.z() + offset[2] + ); + } + } + + void addAdjacentSurfaceOpenings( + HydrologyFootprintCompiler.ValidationRaster validation + ) { + ArrayList actionPositions = new ArrayList<>(actions.keySet()); + for (CavePosition position : actionPositions) { + for (int[] offset : HydrologyCaveCourseFilter.HORIZONTAL_NEIGHBORS) { + int neighborX = position.x() + offset[0]; + int neighborZ = position.z() + offset[1]; + if (validation.ownsSurfaceChannelAt(neighborX, neighborZ, course.id())) { + addOpening(neighborX, position.y(), neighborZ); + } + } + } + } + + void addSurfaceOpening(HydrologyColumnLayer layer, CavePosition position) { + for (CaveSurfaceOpening opening : surfaceOpenings) { + if (!opening.matches(layer, position)) { + continue; + } + if (opening.includeNeighborhood()) { + addOpeningNeighborhood(position); + } else { + addOpening(position); + } + } + } + + private void include(CavePosition position) { + include(position.x(), position.y(), position.z()); + } + + private void include(int x, int y, int z) { + minimumX = Math.min(minimumX, x); + maximumX = Math.max(maximumX, x); + minimumY = Math.min(minimumY, y); + maximumY = Math.max(maximumY, y); + minimumZ = Math.min(minimumZ, z); + maximumZ = Math.max(maximumZ, z); + } + + HydrologyCaveCandidate build(HydrologyCaveCourseFilter.Options options) { + HydrologyPoint start = representative.start(); + int waterHead = representative.upstreamHeadY(); + int entryY = Math.max(waterHead, maximumY); + CavePosition entry = new CavePosition(start.x(), entryY, start.z()); + CavePosition target = new CavePosition(start.x(), waterHead, start.z()); + int horizontalRadius = HydrologyCaveCourseFilter.horizontalRadius( + entry.x(), + entry.z(), + minimumX, + maximumX, + minimumZ, + maximumZ + ); + int maximumDepth = Math.max(1, entryY - minimumY + 2); + int dryHeadroom = Math.max(0, maximumY - waterHead); + int volume = Math.max(1, actions.size()); + HydrologyCavePlannerSettings settings = new HydrologyCavePlannerSettings( + horizontalRadius, + maximumDepth, + volume, + 1, + 1, + 1, + 1, + dryHeadroom, + HydrologyCaveFluidPolicy.REJECT_EXISTING, + HydrologyCaveGrottoShape.ELLIPSOID, + horizontalRadius, + maximumDepth + ); + return new HydrologyCaveCandidate( + new HydrologyCaveSource( + course.id(), + entry, + target, + waterHead, + HydrologyCaveMode.GENERATED_GROTTO + ), + course.profileKey(), + settings, + options.connectToExistingCaves() && course.type() == RiverCourseType.UNDERGROUND, + actions, + openings + ); + } + + private static int actionPriority(HydrologyCaveAction action) { + return switch (action) { + case WET_SOURCE -> 0; + case FALLING_FLUID -> 1; + case DRY_AIR -> 2; + case SEAL_GUARD -> 3; + }; + } + +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateSpanBuilder.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateSpanBuilder.java new file mode 100644 index 000000000..e61f84ca6 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCandidateSpanBuilder.java @@ -0,0 +1,360 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.CavePosition; +import art.arcane.iris.engine.hydrology.cave.CaveVoxelView; + +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +final class CaveCandidateSpanBuilder { + private final RiverCourse course; + private final HydraulicSegment representative; + private final LinkedHashMap actions; + private final LinkedHashMap openings; + private final LinkedHashMap coastalGrottoActions; + private final LinkedHashMap inlandGrottoActions; + private final List surfaceOpenings; + private int minimumX; + private int maximumX; + private int minimumY; + private int maximumY; + private int minimumZ; + private int maximumZ; + + CaveCandidateSpanBuilder(RiverCourse course, HydraulicSegment representative) { + this.course = course; + this.representative = representative; + this.actions = new LinkedHashMap<>(); + this.openings = new LinkedHashMap<>(); + this.coastalGrottoActions = new LinkedHashMap<>(); + this.inlandGrottoActions = new LinkedHashMap<>(); + this.surfaceOpenings = HydrologyCaveCourseFilter.surfaceOpenings(course); + this.minimumX = Integer.MAX_VALUE; + this.maximumX = Integer.MIN_VALUE; + this.minimumY = Integer.MAX_VALUE; + this.maximumY = Integer.MIN_VALUE; + this.minimumZ = Integer.MAX_VALUE; + this.maximumZ = Integer.MIN_VALUE; + } + + RiverCourse course() { + return course; + } + + HydraulicSegment representative() { + return representative; + } + + boolean isEmpty() { + return actions.isEmpty(); + } + + boolean allowsIntentionalSurfaceExposure() { + return course.surfaceSinkholeContinuation(); + } + + void addAction(int x, int z, HydrologyColumnLayer layer) { + int minimumActionY = layer.bedY() + 1; + int maximumActionY = layer.ceilingY(); + if (minimumActionY > maximumActionY) { + return; + } + addSpan(actions, x, z, minimumActionY, maximumActionY); + if (layer.feature().type() == HydrologyFeatureType.COASTAL_GROTTO) { + addSpan(coastalGrottoActions, x, z, minimumActionY, maximumActionY); + } else if (layer.feature().type() == HydrologyFeatureType.INLAND_GROTTO) { + addSpan(inlandGrottoActions, x, z, minimumActionY, maximumActionY); + } + include(x, minimumActionY, z); + include(x, maximumActionY, z); + for (CaveSurfaceOpening opening : surfaceOpenings) { + if (!opening.matchesColumn(layer, x, z)) { + continue; + } + int minimumOpeningY = Math.max(minimumActionY, opening.minimumY()); + if (minimumOpeningY > maximumActionY) { + continue; + } + if (!opening.includeNeighborhood()) { + addOpening(x, z, minimumOpeningY, maximumActionY); + continue; + } + addOpening(x, z, minimumOpeningY - 1, maximumActionY + 1); + for (int[] offset : HydrologyCaveCourseFilter.HORIZONTAL_NEIGHBORS) { + addOpening(x + offset[0], z + offset[1], minimumOpeningY, maximumActionY); + } + } + } + + void addOceanOpening(int x, int z, int minimumOpeningY, int maximumOpeningY) { + if (minimumOpeningY <= maximumOpeningY) { + addOpening(x, z, minimumOpeningY, maximumOpeningY); + } + } + + void addOpeningNeighborhood( + int x, + int z, + int minimumOpeningY, + int maximumOpeningY + ) { + if (minimumOpeningY > maximumOpeningY) { + return; + } + addOpening(x, z, minimumOpeningY - 1, maximumOpeningY + 1); + for (int[] offset : HydrologyCaveCourseFilter.HORIZONTAL_NEIGHBORS) { + addOpening(x + offset[0], z + offset[1], minimumOpeningY, maximumOpeningY); + } + } + + void addAdjacentSurfaceOpenings( + HydrologyFootprintCompiler.ValidationRaster validation + ) { + for (Map.Entry entry : actions.entrySet()) { + int x = RiverFootprint.unpackX(entry.getKey()); + int z = RiverFootprint.unpackZ(entry.getKey()); + for (int[] offset : HydrologyCaveCourseFilter.HORIZONTAL_NEIGHBORS) { + int neighborX = x + offset[0]; + int neighborZ = z + offset[1]; + if (!validation.ownsSurfaceChannelAt(neighborX, neighborZ, course.id())) { + continue; + } + for (CaveYSpan span : entry.getValue().spans()) { + addOpening(neighborX, neighborZ, span.minimumY(), span.maximumY()); + } + } + } + } + + HydrologyFeatureType oversizedGrotto(HydrologyCaveCourseFilter.Options options) { + if (positionCount(coastalGrottoActions) + > options.maximumVolume(HydrologyFeatureType.COASTAL_GROTTO)) { + return HydrologyFeatureType.COASTAL_GROTTO; + } + if (positionCount(inlandGrottoActions) + > options.maximumVolume(HydrologyFeatureType.INLAND_GROTTO)) { + return HydrologyFeatureType.INLAND_GROTTO; + } + return null; + } + + long positionCount() { + return positionCount(actions); + } + + boolean exposed(CaveVoxelView view) { + CaveCandidateBounds bounds = bounds(); + for (Map.Entry entry : actions.entrySet()) { + int x = RiverFootprint.unpackX(entry.getKey()); + int z = RiverFootprint.unpackZ(entry.getKey()); + CaveSpanSet actionSpans = entry.getValue(); + CaveSpanSet openingSpans = openings.get(entry.getKey()); + if (exposedDifference(actionSpans, null, openingSpans, x, z, bounds, view)) { + return true; + } + for (CaveYSpan span : actionSpans.spans()) { + int lowerBoundary = span.minimumY() - 1; + if (!actionSpans.contains(lowerBoundary) + && !contains(openingSpans, lowerBoundary) + && exposed(x, lowerBoundary, z, bounds, view)) { + return true; + } + int upperBoundary = span.maximumY() + 1; + if (!actionSpans.contains(upperBoundary) + && !contains(openingSpans, upperBoundary) + && exposed(x, upperBoundary, z, bounds, view)) { + return true; + } + } + for (int[] offset : HydrologyCaveCourseFilter.HORIZONTAL_NEIGHBORS) { + int neighborX = x + offset[0]; + int neighborZ = z + offset[1]; + long neighborKey = RiverFootprint.pack(neighborX, neighborZ); + if (exposedDifference( + actionSpans, + actions.get(neighborKey), + openings.get(neighborKey), + neighborX, + neighborZ, + bounds, + view + )) { + return true; + } + } + } + return false; + } + + private boolean exposedDifference( + CaveSpanSet source, + CaveSpanSet excludedActions, + CaveSpanSet excludedOpenings, + int x, + int z, + CaveCandidateBounds bounds, + CaveVoxelView view + ) { + for (CaveYSpan span : source.spans()) { + if (exposedDifference( + span, + excludedActions, + excludedOpenings, + x, + z, + bounds, + view + )) { + return true; + } + } + return false; + } + + private boolean exposedDifference( + CaveYSpan source, + CaveSpanSet excludedActions, + CaveSpanSet excludedOpenings, + int x, + int z, + CaveCandidateBounds bounds, + CaveVoxelView view + ) { + List actionSpans = excludedActions == null ? List.of() : excludedActions.spans(); + List openingSpans = excludedOpenings == null ? List.of() : excludedOpenings.spans(); + int actionIndex = 0; + int openingIndex = 0; + long cursor = source.minimumY(); + while (cursor <= source.maximumY()) { + while (actionIndex < actionSpans.size() + && actionSpans.get(actionIndex).maximumY() < cursor) { + actionIndex++; + } + while (openingIndex < openingSpans.size() + && openingSpans.get(openingIndex).maximumY() < cursor) { + openingIndex++; + } + CaveYSpan action = actionIndex < actionSpans.size() ? actionSpans.get(actionIndex) : null; + CaveYSpan opening = openingIndex < openingSpans.size() ? openingSpans.get(openingIndex) : null; + CaveYSpan excluded = first(action, opening); + if (excluded == null || excluded.minimumY() > source.maximumY()) { + return exposed(x, (int) cursor, source.maximumY(), z, bounds, view); + } + if (cursor < excluded.minimumY() + && exposed(x, (int) cursor, excluded.minimumY() - 1, z, bounds, view)) { + return true; + } + cursor = Math.max(cursor, (long) excluded.maximumY() + 1L); + if (excluded == action) { + actionIndex++; + } else { + openingIndex++; + } + } + return false; + } + + private CaveYSpan first(CaveYSpan first, CaveYSpan second) { + if (first == null) { + return second; + } + if (second == null) { + return first; + } + return first.minimumY() <= second.minimumY() ? first : second; + } + + boolean exposed( + int x, + int minimumY, + int maximumY, + int z, + CaveCandidateBounds bounds, + CaveVoxelView view + ) { + if (!bounds.containsColumn(x, z)) { + return false; + } + int boundedMinimumY = Math.max(minimumY, bounds.minimumY()); + int boundedMaximumY = Math.min(maximumY, bounds.maximumY()); + return boundedMinimumY <= boundedMaximumY + && view.hasAboveTerrainSurface(x, z, boundedMinimumY, boundedMaximumY); + } + + boolean exposed( + int x, + int y, + int z, + CaveCandidateBounds bounds, + CaveVoxelView view + ) { + CavePosition position = new CavePosition(x, y, z); + return bounds.contains(position) + && view.isInWorld(position) + && view.isAboveTerrainSurface(position); + } + + private CaveCandidateBounds bounds() { + HydrologyPoint start = representative.start(); + int waterHead = representative.upstreamHeadY(); + int entryY = Math.max(waterHead, maximumY); + int horizontalRadius = HydrologyCaveCourseFilter.horizontalRadius( + start.x(), + start.z(), + minimumX, + maximumX, + minimumZ, + maximumZ + ); + int maximumDepth = Math.max(1, entryY - minimumY + 2); + int dryHeadroom = Math.max(0, maximumY - waterHead); + return new CaveCandidateBounds( + start.x(), + entryY, + start.z(), + waterHead, + horizontalRadius, + maximumDepth, + dryHeadroom + ); + } + + private void addOpening(int x, int z, int minimumOpeningY, int maximumOpeningY) { + addSpan(openings, x, z, minimumOpeningY, maximumOpeningY); + include(x, minimumOpeningY, z); + include(x, maximumOpeningY, z); + } + + private void include(int x, int y, int z) { + minimumX = Math.min(minimumX, x); + maximumX = Math.max(maximumX, x); + minimumY = Math.min(minimumY, y); + maximumY = Math.max(maximumY, y); + minimumZ = Math.min(minimumZ, z); + maximumZ = Math.max(maximumZ, z); + } + + private static void addSpan( + Map spans, + int x, + int z, + int minimumY, + int maximumY + ) { + spans.computeIfAbsent(RiverFootprint.pack(x, z), (Long ignored) -> new CaveSpanSet()) + .add(minimumY, maximumY); + } + + private static boolean contains(CaveSpanSet spans, int y) { + return spans != null && spans.contains(y); + } + + static long positionCount(Map spans) { + long count = 0L; + for (CaveSpanSet spanSet : spans.values()) { + count += spanSet.positionCount(); + } + return count; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCourseGraph.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCourseGraph.java new file mode 100644 index 000000000..db38ed40c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveCourseGraph.java @@ -0,0 +1,10 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record CaveCourseGraph( + List nodes, + List edges, + List outlets +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSpanSet.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSpanSet.java new file mode 100644 index 000000000..209cad45a --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSpanSet.java @@ -0,0 +1,103 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +final class CaveSpanSet { + private int[] pending; + private int size; + private List normalized; + + CaveSpanSet() { + this.pending = new int[4]; + this.normalized = null; + } + + void add(int minimumY, int maximumY) { + if (minimumY > maximumY) { + return; + } + int requiredLength = Math.multiplyExact(size + 1, 2); + if (requiredLength > pending.length) { + pending = Arrays.copyOf(pending, Math.multiplyExact(pending.length, 2)); + } + pending[size * 2] = minimumY; + pending[size * 2 + 1] = maximumY; + size++; + normalized = null; + } + + List spans() { + if (normalized != null) { + return normalized; + } + sortPending(); + ArrayList merged = new ArrayList<>(size); + for (int index = 0; index < size; index++) { + CaveYSpan span = new CaveYSpan(pending[index * 2], pending[index * 2 + 1]); + if (merged.isEmpty()) { + merged.add(span); + continue; + } + CaveYSpan previous = merged.getLast(); + if ((long) span.minimumY() > (long) previous.maximumY() + 1L) { + merged.add(span); + continue; + } + merged.set( + merged.size() - 1, + new CaveYSpan(previous.minimumY(), Math.max(previous.maximumY(), span.maximumY())) + ); + } + normalized = List.copyOf(merged); + return normalized; + } + + private void sortPending() { + for (int index = 1; index < size; index++) { + int minimumY = pending[index * 2]; + int maximumY = pending[index * 2 + 1]; + int insertionIndex = index; + while (insertionIndex > 0) { + int previousMinimumY = pending[(insertionIndex - 1) * 2]; + int previousMaximumY = pending[(insertionIndex - 1) * 2 + 1]; + if (previousMinimumY < minimumY + || previousMinimumY == minimumY && previousMaximumY <= maximumY) { + break; + } + pending[insertionIndex * 2] = previousMinimumY; + pending[insertionIndex * 2 + 1] = previousMaximumY; + insertionIndex--; + } + pending[insertionIndex * 2] = minimumY; + pending[insertionIndex * 2 + 1] = maximumY; + } + } + + boolean contains(int y) { + List spans = spans(); + int minimumIndex = 0; + int maximumIndex = spans.size() - 1; + while (minimumIndex <= maximumIndex) { + int index = (minimumIndex + maximumIndex) >>> 1; + CaveYSpan span = spans.get(index); + if (y < span.minimumY()) { + maximumIndex = index - 1; + } else if (y > span.maximumY()) { + minimumIndex = index + 1; + } else { + return true; + } + } + return false; + } + + long positionCount() { + long count = 0L; + for (CaveYSpan span : spans()) { + count += (long) span.maximumY() - span.minimumY() + 1L; + } + return count; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceComposition.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceComposition.java new file mode 100644 index 000000000..185ba356b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceComposition.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCandidate; + +import java.util.Objects; + +record CaveSurfaceComposition( + HydrologyCaveCandidate candidate, + boolean accepted +) { + static CaveSurfaceComposition accepted(HydrologyCaveCandidate candidate) { + return new CaveSurfaceComposition(Objects.requireNonNull(candidate), true); + } + + static CaveSurfaceComposition rejected() { + return new CaveSurfaceComposition(null, false); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceOpening.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceOpening.java new file mode 100644 index 000000000..04fc9ca95 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveSurfaceOpening.java @@ -0,0 +1,74 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.cave.CavePosition; + +import java.util.List; + +record CaveSurfaceOpening( + long segmentId, + HydrologyPoint point, + double interiorX, + double interiorZ, + long radiusSquared, + int minimumY, + boolean includeNeighborhood +) { + static CaveSurfaceOpening create( + HydraulicSegment segment, + boolean start, + long radiusSquared, + int minimumY, + boolean includeNeighborhood + ) { + List centerline = segment.centerline(); + int boundaryIndex = start ? 0 : centerline.size() - 1; + int interiorIndex = start + ? Math.min(1, centerline.size() - 1) + : Math.max(0, centerline.size() - 2); + HydrologyPoint point = centerline.get(boundaryIndex); + HydrologyPoint interior = centerline.get(interiorIndex); + double deltaX = interior.x() - point.x(); + double deltaZ = interior.z() - point.z(); + double lengthSquared = deltaX * deltaX + deltaZ * deltaZ; + double scale = 0D; + if (includeNeighborhood) { + scale = lengthSquared <= radiusSquared + ? 1D + : StrictMath.sqrt(radiusSquared / lengthSquared); + } + return new CaveSurfaceOpening( + segment.id(), + point, + point.x() + deltaX * scale, + point.z() + deltaZ * scale, + radiusSquared, + minimumY, + includeNeighborhood + ); + } + + boolean matches(HydrologyColumnLayer layer, CavePosition position) { + return matchesColumn(layer, position.x(), position.z()) + && position.y() >= minimumY; + } + + boolean matchesColumn(HydrologyColumnLayer layer, int x, int z) { + return (includeNeighborhood || layer.feature().segmentId() == segmentId) + && distanceSquared(x, z) <= radiusSquared; + } + + private double distanceSquared(int x, int z) { + double pathX = interiorX - point.x(); + double pathZ = interiorZ - point.z(); + double pathLengthSquared = pathX * pathX + pathZ * pathZ; + double positionX = x - point.x(); + double positionZ = z - point.z(); + double progress = pathLengthSquared == 0D + ? 0D + : (positionX * pathX + positionZ * pathZ) / pathLengthSquared; + double clampedProgress = Math.max(0D, Math.min(1D, progress)); + double deltaX = positionX - pathX * clampedProgress; + double deltaZ = positionZ - pathZ * clampedProgress; + return deltaX * deltaX + deltaZ * deltaZ; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CaveYSpan.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveYSpan.java new file mode 100644 index 000000000..51d05a86b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CaveYSpan.java @@ -0,0 +1,4 @@ +package art.arcane.iris.engine.hydrology; + +record CaveYSpan(int minimumY, int maximumY) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java index 079fc56f5..c1f167680 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/CrossTileResolutionContext.java @@ -8,10 +8,10 @@ import java.util.Set; final class CrossTileResolutionContext { final Map resolved; - final Set resolving; + private final Set resolving; final HydrologyTileKey root; - final long maximumTileOffset; - final int maximumOwners; + private final long maximumTileOffset; + private final int maximumOwners; int iterations; CrossTileResolutionContext( diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java index adb15612e..9c1ab3d53 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/DraftProfile.java @@ -7,10 +7,10 @@ import art.arcane.iris.spi.IrisLogging; * selection, settling, publication passes, and the time spent waiting on lower-rank neighbour drafts. */ final class DraftProfile { - final long[] phaseNanos = new long[DraftPhase.values().length]; - long dependencyNanos; - int dependencies; - int admissions; + private final long[] phaseNanos = new long[DraftPhase.values().length]; + private long dependencyNanos; + private int dependencies; + private int admissions; int earlyOwners; int routeCalls; int routeSolves; diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCenterlineProjection.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCenterlineProjection.java new file mode 100644 index 000000000..9c825afa0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCenterlineProjection.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology; + +record FootprintCenterlineProjection( + int pointIndex, + double x, + double z, + double distance, + int flowX, + int flowZ +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCourseRasterKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCourseRasterKey.java new file mode 100644 index 000000000..7c64d0830 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintCourseRasterKey.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.List; + +record FootprintCourseRasterKey( + long courseId, + RiverCourseType courseType, + String profileKey, + List segments +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintFeatureKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintFeatureKey.java new file mode 100644 index 000000000..0e4742b1b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintFeatureKey.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology; + +record FootprintFeatureKey( + long courseId, + long segmentId, + HydrologyFeatureType type, + int role, + int flowX, + int flowZ +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintLayerShape.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintLayerShape.java new file mode 100644 index 000000000..86cf44cdd --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintLayerShape.java @@ -0,0 +1,19 @@ +package art.arcane.iris.engine.hydrology; + +record FootprintLayerShape( + int channelRadius, + double shoreWidth, + double gradingWidth, + int bed, + int fluidHead, + int ceiling, + boolean ellipsoid, + boolean archedChannel, + boolean roundedSurfaceBed, + boolean organicBoundary, + boolean fallingThroat +) { + double totalRadius() { + return channelRadius + shoreWidth + gradingWidth; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintMutableColumn.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintMutableColumn.java new file mode 100644 index 000000000..a8563b9d5 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintMutableColumn.java @@ -0,0 +1,173 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; + +final class FootprintMutableColumn { + private final int x; + private final int z; + private final int naturalHeight; + private final int seaLevel; + private final boolean ocean; + private final String parentBiomeKey; + private HydrologyColumnLayer singleLayer; + private LinkedHashMap layers; + + FootprintMutableColumn(int x, int z, HydrologyTerrainSample terrain, int seaLevel) { + this.x = x; + this.z = z; + this.naturalHeight = terrain.naturalHeight(); + this.seaLevel = seaLevel; + this.ocean = terrain.ocean(); + this.parentBiomeKey = terrain.parentBiomeKey(); + } + + FootprintMutableColumn(HydrologyColumnSample sample) { + this.x = sample.x(); + this.z = sample.z(); + this.naturalHeight = sample.naturalHeight(); + this.seaLevel = sample.seaLevel(); + this.ocean = sample.ocean(); + this.parentBiomeKey = sample.parentBiomeKey(); + for (HydrologyColumnLayer layer : sample.layers()) { + add(layer); + } + } + + void add(HydrologyColumnLayer layer) { + if (layers == null) { + if (singleLayer == null) { + singleLayer = layer; + return; + } + if (singleLayer.feature().id() == layer.feature().id()) { + singleLayer = merge(singleLayer, layer); + return; + } + layers = new LinkedHashMap<>(); + layers.put(singleLayer.feature().id(), singleLayer); + singleLayer = null; + } + HydrologyColumnLayer existing = layers.get(layer.feature().id()); + layers.put(layer.feature().id(), existing == null ? layer : merge(existing, layer)); + } + + HydrologyColumnSample build() { + List builtLayers; + if (layers != null) { + builtLayers = resolveSurfaceHeadConflicts(new ArrayList<>(layers.values())); + } else if (singleLayer != null) { + builtLayers = List.of(singleLayer); + } else { + builtLayers = List.of(); + } + return new HydrologyColumnSample( + x, + z, + naturalHeight, + seaLevel, + ocean, + parentBiomeKey, + builtLayers + ); + } + + private List resolveSurfaceHeadConflicts(List candidates) { + HashMap selectedByCourse = new HashMap<>(); + for (HydrologyColumnLayer candidate : candidates) { + if (!conflictingSurfaceCandidate(candidate)) { + continue; + } + long courseId = candidate.feature().courseId(); + HydrologyColumnLayer selected = selectedByCourse.get(courseId); + if (selected == null || prefersSurfaceLayer(candidate, selected)) { + selectedByCourse.put(courseId, candidate); + } + } + if (selectedByCourse.isEmpty()) { + return candidates; + } + ArrayList resolved = new ArrayList<>(candidates.size()); + for (HydrologyColumnLayer candidate : candidates) { + HydrologyColumnLayer selected = selectedByCourse.get(candidate.feature().courseId()); + if (!conflictingSurfaceCandidate(candidate) + || selected == null + || candidate.fluidHeadY() == selected.fluidHeadY()) { + resolved.add(candidate); + } + } + return List.copyOf(resolved); + } + + private boolean conflictingSurfaceCandidate(HydrologyColumnLayer layer) { + return layer.feature().type().isSurface() + && layer.channel() + && layer.connectedFluid() + && layer.fluidOwned() + && !layer.fallingFluid(); + } + + private boolean prefersSurfaceLayer(HydrologyColumnLayer candidate, HydrologyColumnLayer selected) { + if (candidate.receivingPool() != selected.receivingPool()) { + return candidate.receivingPool(); + } + if (candidate.fluidHeadY() != selected.fluidHeadY()) { + return candidate.fluidHeadY() > selected.fluidHeadY(); + } + return candidate.feature().id() < selected.feature().id(); + } + + void merge(HydrologyColumnSample sample) { + if (sample.x() != x + || sample.z() != z + || sample.naturalHeight() != naturalHeight + || sample.seaLevel() != seaLevel + || sample.ocean() != ocean + || !sample.parentBiomeKey().equals(parentBiomeKey)) { + throw new IllegalStateException("Hydrology course footprints disagree on terrain metadata at " + + x + "," + z + "."); + } + for (HydrologyColumnLayer layer : sample.layers()) { + add(layer); + } + } + + private HydrologyColumnLayer merge(HydrologyColumnLayer first, HydrologyColumnLayer second) { + if (first.equals(second)) { + return first; + } + HydrologyFeatureRef feature = first.feature().y() <= second.feature().y() + ? first.feature() + : second.feature(); + boolean drySurfaceBlend = first.feature().type().isSurface() + && second.feature().type().isSurface() + && !first.channel() + && !second.channel(); + int bedY = drySurfaceBlend + ? Math.max(first.bedY(), second.bedY()) + : Math.min(first.bedY(), second.bedY()); + return new HydrologyColumnLayer( + feature, + bedY, + Math.max(first.fluidHeadY(), second.fluidHeadY()), + Math.max(first.ceilingY(), second.ceilingY()), + first.channel() || second.channel(), + first.shore() || second.shore(), + first.grading() || second.grading(), + first.connectedFluid() || second.connectedFluid(), + first.fallingFluid() || second.fallingFluid(), + first.receivingPool() || second.receivingPool(), + first.terrainOwned() || second.terrainOwned(), + first.fluidOwned() || second.fluidOwned(), + first.oceanApron() || second.oceanApron(), + first.profileKey(), + first.surfaceBiomeKey(), + first.mouthBiomeKey(), + first.shoreBiomeKey(), + first.bankBiomeKey(), + first.floodedCaveBiomeKey() + ); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencil.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencil.java new file mode 100644 index 000000000..b8f02130b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencil.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology; + +record FootprintRasterStencil( + int[] deltaXs, + int[] deltaZs, + double[] distances +) { + int size() { + return deltaXs.length; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilBuilder.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilBuilder.java new file mode 100644 index 000000000..fde7bdf4b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilBuilder.java @@ -0,0 +1,37 @@ +package art.arcane.iris.engine.hydrology; + +import java.util.Arrays; + +final class FootprintRasterStencilBuilder { + private int[] deltaXs; + private int[] deltaZs; + private double[] distances; + private int size; + + FootprintRasterStencilBuilder() { + this.deltaXs = new int[64]; + this.deltaZs = new int[64]; + this.distances = new double[64]; + } + + void add(int deltaX, int deltaZ, double distance) { + if (size == deltaXs.length) { + int expandedSize = Math.multiplyExact(size, 2); + deltaXs = Arrays.copyOf(deltaXs, expandedSize); + deltaZs = Arrays.copyOf(deltaZs, expandedSize); + distances = Arrays.copyOf(distances, expandedSize); + } + deltaXs[size] = deltaX; + deltaZs[size] = deltaZ; + distances[size] = distance; + size++; + } + + FootprintRasterStencil build() { + return new FootprintRasterStencil( + Arrays.copyOf(deltaXs, size), + Arrays.copyOf(deltaZs, size), + Arrays.copyOf(distances, size) + ); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilKey.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilKey.java new file mode 100644 index 000000000..a1c00ce49 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintRasterStencilKey.java @@ -0,0 +1,8 @@ +package art.arcane.iris.engine.hydrology; + +record FootprintRasterStencilKey( + int channelRadius, + double shoreWidth, + double gradingWidth +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintValidationCourseRaster.java b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintValidationCourseRaster.java new file mode 100644 index 000000000..f16229bd4 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/FootprintValidationCourseRaster.java @@ -0,0 +1,12 @@ +package art.arcane.iris.engine.hydrology; + +import art.arcane.iris.engine.hydrology.surface.SurfaceFootprint; + +import java.util.List; + +record FootprintValidationCourseRaster( + long courseId, + List columns, + SurfaceFootprint surface +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCaveCourseFilter.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCaveCourseFilter.java index 0e2802747..26af0e5d1 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCaveCourseFilter.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyCaveCourseFilter.java @@ -1,24 +1,17 @@ package art.arcane.iris.engine.hydrology; import art.arcane.iris.engine.hydrology.cave.CavePosition; -import art.arcane.iris.engine.hydrology.cave.CavePositionIndex; import art.arcane.iris.engine.hydrology.cave.CaveVoxel; import art.arcane.iris.engine.hydrology.cave.CaveVoxelView; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveAction; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveCandidate; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveContainmentPlanner; -import art.arcane.iris.engine.hydrology.cave.HydrologyCaveFluidPolicy; -import art.arcane.iris.engine.hydrology.cave.HydrologyCaveGrottoShape; -import art.arcane.iris.engine.hydrology.cave.HydrologyCaveMode; import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlan; import art.arcane.iris.engine.hydrology.cave.HydrologyCavePlannerSettings; import art.arcane.iris.engine.hydrology.cave.HydrologyCaveRejection; -import art.arcane.iris.engine.hydrology.cave.HydrologyCaveSource; import java.util.ArrayList; -import java.util.Arrays; import java.util.Collections; -import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.IdentityHashMap; @@ -31,16 +24,23 @@ import java.util.Objects; import java.util.Set; final class HydrologyCaveCourseFilter { - private static final long DIAGNOSTIC_SALT = 0x43415645464c5452L; - private static final int[][] NEIGHBORS = { + static final long DIAGNOSTIC_SALT = 0x43415645464c5452L; + + static final int[][] NEIGHBORS = { {1, 0, 0}, {-1, 0, 0}, {0, 1, 0}, {0, -1, 0}, {0, 0, 1}, {0, 0, -1} - }; - private static final int[][] HORIZONTAL_NEIGHBORS = { + } + +; + + static final int[][] HORIZONTAL_NEIGHBORS = { {1, 0}, {-1, 0}, {0, 1}, {0, -1} - }; - private static final CaveVoxelView GENERATED_CHANNEL_VIEW = new CaveVoxelView() { + } + +; + + static final CaveVoxelView GENERATED_CHANNEL_VIEW = new CaveVoxelView() { @Override public boolean isInWorld(CavePosition position) { return true; @@ -60,14 +60,16 @@ final class HydrologyCaveCourseFilter { public boolean isAboveTerrainSurface(CavePosition position) { return false; } - }; + } - private final HydrologyCaveContainmentPlanner planner; - private final CaveVoxelView view; - private final Options options; - private final Map candidateCache; - private final HydrologyCaveContainmentPlanner.ValidationCache validationCache; - private final HydrologyObservedPlannedSurface plannedSurface; +; + + final HydrologyCaveContainmentPlanner planner; + final CaveVoxelView view; + final Options options; + final Map candidateCache; + final HydrologyCaveContainmentPlanner.ValidationCache validationCache; + final HydrologyObservedPlannedSurface plannedSurface; HydrologyCaveCourseFilter(CaveVoxelView view, Options options) { this(view, options, null, null, null); @@ -119,7 +121,7 @@ final class HydrologyCaveCourseFilter { return filter(nodes, edges, outlets, courses, null, validation, diagnostics); } - private Result filter( + Result filter( List nodes, List edges, List outlets, @@ -162,11 +164,11 @@ final class HydrologyCaveCourseFilter { } } uncachedCourses.removeIf((RiverCourse course) -> preflightRejectedCourseIds.contains(course.id())); - LinkedHashMap builders = validation == null + LinkedHashMap builders = validation == null ? candidateBuilders(uncachedCourses, columns) : candidateBuilders(uncachedCourses, validation); if (candidateCourses.isEmpty() && preflightRejectedCourseIds.isEmpty()) { - Graph graph = acceptedGraph(nodes, edges, outlets, normalizedCourses); + CaveCourseGraph graph = acceptedGraph(nodes, edges, outlets, normalizedCourses); return new Result( graph.nodes(), graph.edges(), @@ -185,7 +187,7 @@ final class HydrologyCaveCourseFilter { CandidateKey key = candidateKeys.get(course.id()); HydrologyCaveCandidate candidate = cachedCandidates.get(course.id()); if (candidate == null) { - CandidateBuilder builder = builders.get(course.id()); + CaveCandidateBuilder builder = builders.get(course.id()); if (builder == null) { throw new IllegalStateException("Hydrology cave candidate raster was empty."); } @@ -195,8 +197,8 @@ final class HydrologyCaveCourseFilter { } exposureValidatedCandidates.add(candidate); } - SurfaceComposition composition = validation == null - ? SurfaceComposition.accepted(candidate) + CaveSurfaceComposition composition = validation == null + ? CaveSurfaceComposition.accepted(candidate) : composeSurfacePublication(candidate, course, validation, publishedCoursesById); if (!composition.accepted()) { if (rejectedCourseIds.add(course.id())) { @@ -242,7 +244,7 @@ final class HydrologyCaveCourseFilter { } } if (rejectedCourseIds.isEmpty()) { - Graph graph = acceptedGraph(nodes, edges, outlets, normalizedCourses); + CaveCourseGraph graph = acceptedGraph(nodes, edges, outlets, normalizedCourses); return new Result( graph.nodes(), graph.edges(), @@ -258,7 +260,7 @@ final class HydrologyCaveCourseFilter { acceptedCourses.add(course); } } - Graph graph = acceptedGraph(nodes, edges, outlets, acceptedCourses); + CaveCourseGraph graph = acceptedGraph(nodes, edges, outlets, acceptedCourses); return new Result( graph.nodes(), graph.edges(), @@ -268,7 +270,7 @@ final class HydrologyCaveCourseFilter { ); } - private boolean compatibleSharedCandidates( + boolean compatibleSharedCandidates( HydrologyCaveCandidate first, HydrologyCaveCandidate second, Map coursesById @@ -282,7 +284,7 @@ final class HydrologyCaveCourseFilter { || sharesTerminalGrotto(firstCourse, secondCourse, first); } - private List alignSharedTerminalPlanActions( + List alignSharedTerminalPlanActions( List plans, List candidates, Map coursesById @@ -330,7 +332,7 @@ final class HydrologyCaveCourseFilter { return List.copyOf(aligned); } - private HydrologyCavePlan withActions( + HydrologyCavePlan withActions( HydrologyCavePlan plan, Map actions ) { @@ -343,7 +345,7 @@ final class HydrologyCaveCourseFilter { ); } - private void alignSharedTerminalCandidateActions( + void alignSharedTerminalCandidateActions( List candidates, Map coursesById, Set exposureValidatedCandidates @@ -386,7 +388,7 @@ final class HydrologyCaveCourseFilter { } } - private HydrologyCaveAction sharedTerminalAction( + HydrologyCaveAction sharedTerminalAction( HydrologyCaveAction first, HydrologyCaveAction second ) { @@ -395,7 +397,7 @@ final class HydrologyCaveCourseFilter { : second; } - private int sharedTerminalActionPriority(HydrologyCaveAction action) { + int sharedTerminalActionPriority(HydrologyCaveAction action) { return switch (action) { case FALLING_FLUID -> 0; case WET_SOURCE -> 1; @@ -404,7 +406,7 @@ final class HydrologyCaveCourseFilter { }; } - private HydrologyCaveCandidate withActions( + HydrologyCaveCandidate withActions( HydrologyCaveCandidate candidate, Map actions ) { @@ -418,7 +420,7 @@ final class HydrologyCaveCourseFilter { ); } - private void replaceExposureCandidate( + void replaceExposureCandidate( Set exposureValidatedCandidates, HydrologyCaveCandidate existing, HydrologyCaveCandidate replacement @@ -428,7 +430,7 @@ final class HydrologyCaveCourseFilter { } } - private SurfaceComposition composeSurfacePublication( + CaveSurfaceComposition composeSurfacePublication( HydrologyCaveCandidate candidate, RiverCourse course, HydrologyFootprintCompiler.ValidationRaster validation, @@ -476,7 +478,7 @@ final class HydrologyCaveCourseFilter { || (surfaceCourseId != course.id() && !candidate.intentionalOpenings().contains(position) && !sharedTerminalGrotto)) { - return SurfaceComposition.rejected(); + return CaveSurfaceComposition.rejected(); } if (caveAction == surfaceCell.action()) { continue; @@ -484,7 +486,7 @@ final class HydrologyCaveCourseFilter { if (surfaceCourseId != course.id() && !sharesDrainageOutlet(course, surfaceCourse) && !sharedTerminalGrotto) { - return SurfaceComposition.rejected(); + return CaveSurfaceComposition.rejected(); } if (composedActions == null) { composedActions = new LinkedHashMap<>(candidate.actions()); @@ -493,9 +495,9 @@ final class HydrologyCaveCourseFilter { } } if (composedActions == null) { - return SurfaceComposition.accepted(candidate); + return CaveSurfaceComposition.accepted(candidate); } - return SurfaceComposition.accepted(new HydrologyCaveCandidate( + return CaveSurfaceComposition.accepted(new HydrologyCaveCandidate( candidate.source(), candidate.profileKey(), candidate.settings(), @@ -505,7 +507,7 @@ final class HydrologyCaveCourseFilter { )); } - private boolean sharesTerminalGrotto( + boolean sharesTerminalGrotto( RiverCourse first, RiverCourse second, HydrologyCaveCandidate candidate @@ -532,7 +534,7 @@ final class HydrologyCaveCourseFilter { && Math.abs(firstPoint.y() - secondPoint.y()) <= verticalRadius; } - private HydraulicSegment terminalGrotto(RiverCourse course) { + HydraulicSegment terminalGrotto(RiverCourse course) { if (course == null || course.segments().isEmpty()) { return null; } @@ -540,14 +542,14 @@ final class HydrologyCaveCourseFilter { return segment.type().isGrotto() ? segment : null; } - private boolean sharesDrainageOutlet(RiverCourse first, RiverCourse second) { + boolean sharesDrainageOutlet(RiverCourse first, RiverCourse second) { return second != null && first.outletId().isPresent() && second.outletId().isPresent() && first.outletId().getAsLong() == second.outletId().getAsLong(); } - private int maximumCaveY(HydrologyColumnSample sample, long courseId) { + int maximumCaveY(HydrologyColumnSample sample, long courseId) { int maximumY = Integer.MIN_VALUE; for (HydrologyColumnLayer layer : sample.layers()) { if (layer.feature().courseId() == courseId @@ -566,28 +568,28 @@ final class HydrologyCaveCourseFilter { Iterable columns, List diagnostics ) { - LinkedHashMap builders = candidateSpanBuilders(courses, columns); + LinkedHashMap builders = candidateSpanBuilders(courses, columns); return preflightRejectedCourseIds(builders, diagnostics); } - private Set preflightRejectedCourseIds( + Set preflightRejectedCourseIds( List courses, HydrologyFootprintCompiler.ValidationRaster validation, List diagnostics ) { - LinkedHashMap builders = candidateSpanBuilders(courses, validation); + LinkedHashMap builders = candidateSpanBuilders(courses, validation); return preflightRejectedCourseIds(builders, diagnostics); } - private Set preflightRejectedCourseIds( - LinkedHashMap builders, + Set preflightRejectedCourseIds( + LinkedHashMap builders, List diagnostics ) { if (builders.isEmpty()) { return Set.of(); } HashSet rejectedCourseIds = new HashSet<>(); - for (CandidateSpanBuilder builder : builders.values()) { + for (CaveCandidateSpanBuilder builder : builders.values()) { HydrologyFeatureType oversizedGrotto = builder.oversizedGrotto(options); boolean oversizedCourse = builder.positionCount() > HydrologyCavePlannerSettings.MAXIMUM_PLANNED_MUTATIONS; @@ -604,7 +606,7 @@ final class HydrologyCaveCourseFilter { HydrologyCandidateRejection.VOLUME_LIMIT.ordinal() ); } - for (CandidateSpanBuilder builder : builders.values()) { + for (CaveCandidateSpanBuilder builder : builders.values()) { if (rejectedCourseIds.contains(builder.course().id()) || !builder.exposed(view) || builder.allowsIntentionalSurfaceExposure()) { @@ -623,7 +625,7 @@ final class HydrologyCaveCourseFilter { return Set.copyOf(rejectedCourseIds); } - private List withoutZeroContributionEdges(List courses) { + List withoutZeroContributionEdges(List courses) { ArrayList normalized = new ArrayList<>(courses.size()); boolean changed = false; for (RiverCourse course : courses) { @@ -653,15 +655,15 @@ final class HydrologyCaveCourseFilter { return changed ? List.copyOf(normalized) : courses; } - private LinkedHashMap candidateSpanBuilders( + LinkedHashMap candidateSpanBuilders( List courses, Iterable columns ) { - LinkedHashMap builders = new LinkedHashMap<>(); + LinkedHashMap builders = new LinkedHashMap<>(); for (RiverCourse course : courses) { HydraulicSegment representative = representativeCaveSegment(course); if (representative != null) { - builders.put(course.id(), new CandidateSpanBuilder(course, representative)); + builders.put(course.id(), new CaveCandidateSpanBuilder(course, representative)); } } if (builders.isEmpty()) { @@ -670,7 +672,7 @@ final class HydrologyCaveCourseFilter { for (HydrologyColumnSample sample : columns) { for (HydrologyColumnLayer layer : sample.layers()) { - CandidateSpanBuilder builder = builders.get(layer.feature().courseId()); + CaveCandidateSpanBuilder builder = builders.get(layer.feature().courseId()); if (builder == null || !isCaveLayer(layer) || layer.oceanApron() || !layer.channel() || !layer.terrainOwned()) { continue; @@ -678,27 +680,27 @@ final class HydrologyCaveCourseFilter { builder.addAction(sample.x(), sample.z(), layer); } for (HydrologyColumnLayer layer : sample.layers()) { - CandidateSpanBuilder builder = builders.get(layer.feature().courseId()); + CaveCandidateSpanBuilder builder = builders.get(layer.feature().courseId()); if (builder != null && layer.oceanApron()) { builder.addOceanOpening(sample.x(), sample.z(), sample.naturalHeight() + 1, layer.ceilingY()); } } } - builders.values().removeIf(CandidateSpanBuilder::isEmpty); + builders.values().removeIf(CaveCandidateSpanBuilder::isEmpty); return builders; } - private LinkedHashMap candidateSpanBuilders( + LinkedHashMap candidateSpanBuilders( List courses, HydrologyFootprintCompiler.ValidationRaster validation ) { - LinkedHashMap builders = new LinkedHashMap<>(); + LinkedHashMap builders = new LinkedHashMap<>(); for (RiverCourse course : courses) { HydraulicSegment representative = representativeCaveSegment(course); if (representative == null) { continue; } - CandidateSpanBuilder builder = new CandidateSpanBuilder(course, representative); + CaveCandidateSpanBuilder builder = new CaveCandidateSpanBuilder(course, representative); for (HydrologyColumnSample sample : validation.columnsForCourse(course.id())) { int maximumCaveY = Integer.MIN_VALUE; for (HydrologyColumnLayer layer : sample.layers()) { @@ -750,15 +752,15 @@ final class HydrologyCaveCourseFilter { return builders; } - private LinkedHashMap candidateBuilders( + LinkedHashMap candidateBuilders( List courses, Iterable columns ) { - LinkedHashMap builders = new LinkedHashMap<>(); + LinkedHashMap builders = new LinkedHashMap<>(); for (RiverCourse course : courses) { HydraulicSegment representative = representativeCaveSegment(course); if (representative != null) { - builders.put(course.id(), new CandidateBuilder(course, representative)); + builders.put(course.id(), new CaveCandidateBuilder(course, representative)); } } if (builders.isEmpty()) { @@ -767,7 +769,7 @@ final class HydrologyCaveCourseFilter { for (HydrologyColumnSample sample : columns) { for (HydrologyColumnLayer layer : sample.layers()) { - CandidateBuilder builder = builders.get(layer.feature().courseId()); + CaveCandidateBuilder builder = builders.get(layer.feature().courseId()); if (builder == null || !isCaveLayer(layer) || layer.oceanApron() || !layer.channel() || !layer.terrainOwned()) { continue; @@ -779,7 +781,7 @@ final class HydrologyCaveCourseFilter { } } for (HydrologyColumnLayer layer : sample.layers()) { - CandidateBuilder builder = builders.get(layer.feature().courseId()); + CaveCandidateBuilder builder = builders.get(layer.feature().courseId()); if (builder == null || !layer.oceanApron()) { continue; } @@ -788,21 +790,21 @@ final class HydrologyCaveCourseFilter { } } } - builders.values().removeIf(CandidateBuilder::isEmpty); + builders.values().removeIf(CaveCandidateBuilder::isEmpty); return builders; } - private LinkedHashMap candidateBuilders( + LinkedHashMap candidateBuilders( List courses, HydrologyFootprintCompiler.ValidationRaster validation ) { - LinkedHashMap builders = new LinkedHashMap<>(); + LinkedHashMap builders = new LinkedHashMap<>(); for (RiverCourse course : courses) { HydraulicSegment representative = representativeCaveSegment(course); if (representative == null) { continue; } - CandidateBuilder builder = new CandidateBuilder(course, representative); + CaveCandidateBuilder builder = new CaveCandidateBuilder(course, representative); for (HydrologyColumnSample sample : validation.columnsForCourse(course.id())) { int maximumCaveY = Integer.MIN_VALUE; for (HydrologyColumnLayer layer : sample.layers()) { @@ -853,7 +855,7 @@ final class HydrologyCaveCourseFilter { return builders; } - private static HydraulicSegment representativeCaveSegment(RiverCourse course) { + static HydraulicSegment representativeCaveSegment(RiverCourse course) { HydraulicSegment selected = null; for (HydraulicSegment segment : course.segments()) { if (!segment.type().isUnderground() && !segment.type().isDeepFluid()) { @@ -866,7 +868,7 @@ final class HydrologyCaveCourseFilter { return selected; } - private static int candidatePriority(HydrologyFeatureType type) { + static int candidatePriority(HydrologyFeatureType type) { if (type.isGrotto()) { return 0; } @@ -876,11 +878,11 @@ final class HydrologyCaveCourseFilter { return 2; } - private boolean isCaveLayer(HydrologyColumnLayer layer) { + boolean isCaveLayer(HydrologyColumnLayer layer) { return layer.feature().type().isUnderground() || layer.feature().type().isDeepFluid(); } - private HydrologyCaveAction actionAt(HydrologyColumnLayer layer, int y) { + HydrologyCaveAction actionAt(HydrologyColumnLayer layer, int y) { if (y > layer.fluidHeadY()) { return HydrologyCaveAction.DRY_AIR; } @@ -890,7 +892,7 @@ final class HydrologyCaveCourseFilter { return HydrologyCaveAction.WET_SOURCE; } - private void addDiagnostic( + void addDiagnostic( RiverCourse course, HydrologyCavePlan plan, List diagnostics @@ -906,7 +908,7 @@ final class HydrologyCaveCourseFilter { ); } - private void addDiagnostic( + void addDiagnostic( RiverCourse course, HydraulicSegment representative, HydrologyFeatureType type, @@ -930,7 +932,7 @@ final class HydrologyCaveCourseFilter { )); } - private static Graph acceptedGraph( + static CaveCourseGraph acceptedGraph( List nodes, List edges, List outlets, @@ -975,7 +977,7 @@ final class HydrologyCaveCourseFilter { acceptedOutlets.add(outlet); } } - return new Graph( + return new CaveCourseGraph( List.copyOf(acceptedNodes), List.copyOf(acceptedEdges), List.copyOf(acceptedOutlets) @@ -1000,7 +1002,7 @@ final class HydrologyCaveCourseFilter { acceptedPlans.add(plan); } } - Graph graph = acceptedGraph( + CaveCourseGraph graph = acceptedGraph( result.nodes(), result.edges(), result.outlets(), @@ -1048,26 +1050,6 @@ final class HydrologyCaveCourseFilter { ) { } - private record Graph( - List nodes, - List edges, - List outlets - ) { - } - - private record SurfaceComposition( - HydrologyCaveCandidate candidate, - boolean accepted - ) { - private static SurfaceComposition accepted(HydrologyCaveCandidate candidate) { - return new SurfaceComposition(Objects.requireNonNull(candidate), true); - } - - private static SurfaceComposition rejected() { - return new SurfaceComposition(null, false); - } - } - record Options( boolean connectToExistingCaves, int coastalGrottoMaximumVolume, @@ -1079,7 +1061,7 @@ final class HydrologyCaveCourseFilter { } } - private int maximumVolume(HydrologyFeatureType type) { + int maximumVolume(HydrologyFeatureType type) { return switch (type) { case COASTAL_GROTTO -> coastalGrottoMaximumVolume; case INLAND_GROTTO -> inlandGrottoMaximumVolume; @@ -1200,492 +1182,7 @@ final class HydrologyCaveCourseFilter { } } - private static final class CandidateSpanBuilder { - private final RiverCourse course; - private final HydraulicSegment representative; - private final LinkedHashMap actions; - private final LinkedHashMap openings; - private final LinkedHashMap coastalGrottoActions; - private final LinkedHashMap inlandGrottoActions; - private final List surfaceOpenings; - private int minimumX; - private int maximumX; - private int minimumY; - private int maximumY; - private int minimumZ; - private int maximumZ; - - private CandidateSpanBuilder(RiverCourse course, HydraulicSegment representative) { - this.course = course; - this.representative = representative; - this.actions = new LinkedHashMap<>(); - this.openings = new LinkedHashMap<>(); - this.coastalGrottoActions = new LinkedHashMap<>(); - this.inlandGrottoActions = new LinkedHashMap<>(); - this.surfaceOpenings = surfaceOpenings(course); - this.minimumX = Integer.MAX_VALUE; - this.maximumX = Integer.MIN_VALUE; - this.minimumY = Integer.MAX_VALUE; - this.maximumY = Integer.MIN_VALUE; - this.minimumZ = Integer.MAX_VALUE; - this.maximumZ = Integer.MIN_VALUE; - } - - private RiverCourse course() { - return course; - } - - private HydraulicSegment representative() { - return representative; - } - - private boolean isEmpty() { - return actions.isEmpty(); - } - - private boolean allowsIntentionalSurfaceExposure() { - return course.surfaceSinkholeContinuation(); - } - - private void addAction(int x, int z, HydrologyColumnLayer layer) { - int minimumActionY = layer.bedY() + 1; - int maximumActionY = layer.ceilingY(); - if (minimumActionY > maximumActionY) { - return; - } - addSpan(actions, x, z, minimumActionY, maximumActionY); - if (layer.feature().type() == HydrologyFeatureType.COASTAL_GROTTO) { - addSpan(coastalGrottoActions, x, z, minimumActionY, maximumActionY); - } else if (layer.feature().type() == HydrologyFeatureType.INLAND_GROTTO) { - addSpan(inlandGrottoActions, x, z, minimumActionY, maximumActionY); - } - include(x, minimumActionY, z); - include(x, maximumActionY, z); - for (SurfaceOpening opening : surfaceOpenings) { - if (!opening.matchesColumn(layer, x, z)) { - continue; - } - int minimumOpeningY = Math.max(minimumActionY, opening.minimumY()); - if (minimumOpeningY > maximumActionY) { - continue; - } - if (!opening.includeNeighborhood()) { - addOpening(x, z, minimumOpeningY, maximumActionY); - continue; - } - addOpening(x, z, minimumOpeningY - 1, maximumActionY + 1); - for (int[] offset : HORIZONTAL_NEIGHBORS) { - addOpening(x + offset[0], z + offset[1], minimumOpeningY, maximumActionY); - } - } - } - - private void addOceanOpening(int x, int z, int minimumOpeningY, int maximumOpeningY) { - if (minimumOpeningY <= maximumOpeningY) { - addOpening(x, z, minimumOpeningY, maximumOpeningY); - } - } - - private void addOpeningNeighborhood( - int x, - int z, - int minimumOpeningY, - int maximumOpeningY - ) { - if (minimumOpeningY > maximumOpeningY) { - return; - } - addOpening(x, z, minimumOpeningY - 1, maximumOpeningY + 1); - for (int[] offset : HORIZONTAL_NEIGHBORS) { - addOpening(x + offset[0], z + offset[1], minimumOpeningY, maximumOpeningY); - } - } - - private void addAdjacentSurfaceOpenings( - HydrologyFootprintCompiler.ValidationRaster validation - ) { - for (Map.Entry entry : actions.entrySet()) { - int x = RiverFootprint.unpackX(entry.getKey()); - int z = RiverFootprint.unpackZ(entry.getKey()); - for (int[] offset : HORIZONTAL_NEIGHBORS) { - int neighborX = x + offset[0]; - int neighborZ = z + offset[1]; - if (!validation.ownsSurfaceChannelAt(neighborX, neighborZ, course.id())) { - continue; - } - for (YSpan span : entry.getValue().spans()) { - addOpening(neighborX, neighborZ, span.minimumY(), span.maximumY()); - } - } - } - } - - private HydrologyFeatureType oversizedGrotto(Options options) { - if (positionCount(coastalGrottoActions) - > options.maximumVolume(HydrologyFeatureType.COASTAL_GROTTO)) { - return HydrologyFeatureType.COASTAL_GROTTO; - } - if (positionCount(inlandGrottoActions) - > options.maximumVolume(HydrologyFeatureType.INLAND_GROTTO)) { - return HydrologyFeatureType.INLAND_GROTTO; - } - return null; - } - - private long positionCount() { - return positionCount(actions); - } - - private boolean exposed(CaveVoxelView view) { - CandidateBounds bounds = bounds(); - for (Map.Entry entry : actions.entrySet()) { - int x = RiverFootprint.unpackX(entry.getKey()); - int z = RiverFootprint.unpackZ(entry.getKey()); - SpanSet actionSpans = entry.getValue(); - SpanSet openingSpans = openings.get(entry.getKey()); - if (exposedDifference(actionSpans, null, openingSpans, x, z, bounds, view)) { - return true; - } - for (YSpan span : actionSpans.spans()) { - int lowerBoundary = span.minimumY() - 1; - if (!actionSpans.contains(lowerBoundary) - && !contains(openingSpans, lowerBoundary) - && exposed(x, lowerBoundary, z, bounds, view)) { - return true; - } - int upperBoundary = span.maximumY() + 1; - if (!actionSpans.contains(upperBoundary) - && !contains(openingSpans, upperBoundary) - && exposed(x, upperBoundary, z, bounds, view)) { - return true; - } - } - for (int[] offset : HORIZONTAL_NEIGHBORS) { - int neighborX = x + offset[0]; - int neighborZ = z + offset[1]; - long neighborKey = RiverFootprint.pack(neighborX, neighborZ); - if (exposedDifference( - actionSpans, - actions.get(neighborKey), - openings.get(neighborKey), - neighborX, - neighborZ, - bounds, - view - )) { - return true; - } - } - } - return false; - } - - private boolean exposedDifference( - SpanSet source, - SpanSet excludedActions, - SpanSet excludedOpenings, - int x, - int z, - CandidateBounds bounds, - CaveVoxelView view - ) { - for (YSpan span : source.spans()) { - if (exposedDifference( - span, - excludedActions, - excludedOpenings, - x, - z, - bounds, - view - )) { - return true; - } - } - return false; - } - - private boolean exposedDifference( - YSpan source, - SpanSet excludedActions, - SpanSet excludedOpenings, - int x, - int z, - CandidateBounds bounds, - CaveVoxelView view - ) { - List actionSpans = excludedActions == null ? List.of() : excludedActions.spans(); - List openingSpans = excludedOpenings == null ? List.of() : excludedOpenings.spans(); - int actionIndex = 0; - int openingIndex = 0; - long cursor = source.minimumY(); - while (cursor <= source.maximumY()) { - while (actionIndex < actionSpans.size() - && actionSpans.get(actionIndex).maximumY() < cursor) { - actionIndex++; - } - while (openingIndex < openingSpans.size() - && openingSpans.get(openingIndex).maximumY() < cursor) { - openingIndex++; - } - YSpan action = actionIndex < actionSpans.size() ? actionSpans.get(actionIndex) : null; - YSpan opening = openingIndex < openingSpans.size() ? openingSpans.get(openingIndex) : null; - YSpan excluded = first(action, opening); - if (excluded == null || excluded.minimumY() > source.maximumY()) { - return exposed(x, (int) cursor, source.maximumY(), z, bounds, view); - } - if (cursor < excluded.minimumY() - && exposed(x, (int) cursor, excluded.minimumY() - 1, z, bounds, view)) { - return true; - } - cursor = Math.max(cursor, (long) excluded.maximumY() + 1L); - if (excluded == action) { - actionIndex++; - } else { - openingIndex++; - } - } - return false; - } - - private YSpan first(YSpan first, YSpan second) { - if (first == null) { - return second; - } - if (second == null) { - return first; - } - return first.minimumY() <= second.minimumY() ? first : second; - } - - private boolean exposed( - int x, - int minimumY, - int maximumY, - int z, - CandidateBounds bounds, - CaveVoxelView view - ) { - if (!bounds.containsColumn(x, z)) { - return false; - } - int boundedMinimumY = Math.max(minimumY, bounds.minimumY()); - int boundedMaximumY = Math.min(maximumY, bounds.maximumY()); - return boundedMinimumY <= boundedMaximumY - && view.hasAboveTerrainSurface(x, z, boundedMinimumY, boundedMaximumY); - } - - private boolean exposed( - int x, - int y, - int z, - CandidateBounds bounds, - CaveVoxelView view - ) { - CavePosition position = new CavePosition(x, y, z); - return bounds.contains(position) - && view.isInWorld(position) - && view.isAboveTerrainSurface(position); - } - - private CandidateBounds bounds() { - HydrologyPoint start = representative.start(); - int waterHead = representative.upstreamHeadY(); - int entryY = Math.max(waterHead, maximumY); - int horizontalRadius = horizontalRadius( - start.x(), - start.z(), - minimumX, - maximumX, - minimumZ, - maximumZ - ); - int maximumDepth = Math.max(1, entryY - minimumY + 2); - int dryHeadroom = Math.max(0, maximumY - waterHead); - return new CandidateBounds( - start.x(), - entryY, - start.z(), - waterHead, - horizontalRadius, - maximumDepth, - dryHeadroom - ); - } - - private void addOpening(int x, int z, int minimumOpeningY, int maximumOpeningY) { - addSpan(openings, x, z, minimumOpeningY, maximumOpeningY); - include(x, minimumOpeningY, z); - include(x, maximumOpeningY, z); - } - - private void include(int x, int y, int z) { - minimumX = Math.min(minimumX, x); - maximumX = Math.max(maximumX, x); - minimumY = Math.min(minimumY, y); - maximumY = Math.max(maximumY, y); - minimumZ = Math.min(minimumZ, z); - maximumZ = Math.max(maximumZ, z); - } - - private static void addSpan( - Map spans, - int x, - int z, - int minimumY, - int maximumY - ) { - spans.computeIfAbsent(RiverFootprint.pack(x, z), (Long ignored) -> new SpanSet()) - .add(minimumY, maximumY); - } - - private static boolean contains(SpanSet spans, int y) { - return spans != null && spans.contains(y); - } - - private static long positionCount(Map spans) { - long count = 0L; - for (SpanSet spanSet : spans.values()) { - count += spanSet.positionCount(); - } - return count; - } - } - - private static final class SpanSet { - private int[] pending; - private int size; - private List normalized; - - private SpanSet() { - this.pending = new int[4]; - this.normalized = null; - } - - private void add(int minimumY, int maximumY) { - if (minimumY > maximumY) { - return; - } - int requiredLength = Math.multiplyExact(size + 1, 2); - if (requiredLength > pending.length) { - pending = Arrays.copyOf(pending, Math.multiplyExact(pending.length, 2)); - } - pending[size * 2] = minimumY; - pending[size * 2 + 1] = maximumY; - size++; - normalized = null; - } - - private List spans() { - if (normalized != null) { - return normalized; - } - sortPending(); - ArrayList merged = new ArrayList<>(size); - for (int index = 0; index < size; index++) { - YSpan span = new YSpan(pending[index * 2], pending[index * 2 + 1]); - if (merged.isEmpty()) { - merged.add(span); - continue; - } - YSpan previous = merged.getLast(); - if ((long) span.minimumY() > (long) previous.maximumY() + 1L) { - merged.add(span); - continue; - } - merged.set( - merged.size() - 1, - new YSpan(previous.minimumY(), Math.max(previous.maximumY(), span.maximumY())) - ); - } - normalized = List.copyOf(merged); - return normalized; - } - - private void sortPending() { - for (int index = 1; index < size; index++) { - int minimumY = pending[index * 2]; - int maximumY = pending[index * 2 + 1]; - int insertionIndex = index; - while (insertionIndex > 0) { - int previousMinimumY = pending[(insertionIndex - 1) * 2]; - int previousMaximumY = pending[(insertionIndex - 1) * 2 + 1]; - if (previousMinimumY < minimumY - || previousMinimumY == minimumY && previousMaximumY <= maximumY) { - break; - } - pending[insertionIndex * 2] = previousMinimumY; - pending[insertionIndex * 2 + 1] = previousMaximumY; - insertionIndex--; - } - pending[insertionIndex * 2] = minimumY; - pending[insertionIndex * 2 + 1] = maximumY; - } - } - - private boolean contains(int y) { - List spans = spans(); - int minimumIndex = 0; - int maximumIndex = spans.size() - 1; - while (minimumIndex <= maximumIndex) { - int index = (minimumIndex + maximumIndex) >>> 1; - YSpan span = spans.get(index); - if (y < span.minimumY()) { - maximumIndex = index - 1; - } else if (y > span.maximumY()) { - minimumIndex = index + 1; - } else { - return true; - } - } - return false; - } - - private long positionCount() { - long count = 0L; - for (YSpan span : spans()) { - count += (long) span.maximumY() - span.minimumY() + 1L; - } - return count; - } - } - - private record YSpan(int minimumY, int maximumY) { - } - - private record CandidateBounds( - int entryX, - int entryY, - int entryZ, - int waterHeadY, - int horizontalRadius, - int maximumDepth, - int dryHeadroom - ) { - private boolean containsColumn(int x, int z) { - long deltaX = (long) x - entryX; - long deltaZ = (long) z - entryZ; - long radiusSquared = (long) horizontalRadius * horizontalRadius; - return deltaX * deltaX + deltaZ * deltaZ <= radiusSquared; - } - - private int minimumY() { - return Math.toIntExact((long) entryY - maximumDepth); - } - - private int maximumY() { - return Math.max(entryY, Math.addExact(waterHeadY, dryHeadroom + 1)); - } - - private boolean contains(CavePosition position) { - if (!containsColumn(position.x(), position.z())) { - return false; - } - return position.y() >= minimumY() && position.y() <= maximumY(); - } - } - - private static int horizontalRadius( + static int horizontalRadius( int entryX, int entryZ, int minimumX, @@ -1708,11 +1205,11 @@ final class HydrologyCaveCourseFilter { return Math.max(1, (int) StrictMath.ceil(StrictMath.sqrt(maximumDistanceSquared)) + 2); } - private static List surfaceOpenings(RiverCourse course) { + static List surfaceOpenings(RiverCourse course) { if (course.type() != RiverCourseType.SURFACE) { return List.of(); } - ArrayList openings = new ArrayList<>(); + ArrayList openings = new ArrayList<>(); List segments = course.segments(); for (int index = 0; index < segments.size(); index++) { HydraulicSegment segment = segments.get(index); @@ -1738,7 +1235,7 @@ final class HydrologyCaveCourseFilter { boolean includeNeighborhood = segment.type() != HydrologyFeatureType.SINKHOLE; if (index == 0 || !segments.get(index - 1).type().isUnderground()) { - openings.add(SurfaceOpening.create( + openings.add(CaveSurfaceOpening.create( segment, true, radiusSquared, @@ -1751,7 +1248,7 @@ final class HydrologyCaveCourseFilter { if (terminalCoastalOpening || (index < segments.size() - 1 && !segments.get(index + 1).type().isUnderground())) { - openings.add(SurfaceOpening.create( + openings.add(CaveSurfaceOpening.create( segment, false, radiusSquared, @@ -1762,246 +1259,4 @@ final class HydrologyCaveCourseFilter { } return List.copyOf(openings); } - - private static final class CandidateBuilder { - private final RiverCourse course; - private final HydraulicSegment representative; - private final LinkedHashMap actions; - private final LinkedHashSet openings; - private final CavePositionIndex openingIndex; - private final List surfaceOpenings; - private int minimumX; - private int maximumX; - private int minimumY; - private int maximumY; - private int minimumZ; - private int maximumZ; - - private CandidateBuilder(RiverCourse course, HydraulicSegment representative) { - this.course = course; - this.representative = representative; - this.actions = new LinkedHashMap<>(); - this.openings = new LinkedHashSet<>(); - this.openingIndex = new CavePositionIndex(); - this.surfaceOpenings = surfaceOpenings(course); - this.minimumX = Integer.MAX_VALUE; - this.maximumX = Integer.MIN_VALUE; - this.minimumY = Integer.MAX_VALUE; - this.maximumY = Integer.MIN_VALUE; - this.minimumZ = Integer.MAX_VALUE; - this.maximumZ = Integer.MIN_VALUE; - } - - private RiverCourse course() { - return course; - } - - private HydraulicSegment representative() { - return representative; - } - - private boolean isEmpty() { - return actions.isEmpty(); - } - - private void addAction(CavePosition position, HydrologyCaveAction action) { - HydrologyCaveAction existing = actions.get(position); - if (existing == null || actionPriority(action) < actionPriority(existing)) { - actions.put(position, action); - } - include(position); - } - - private void addOpening(CavePosition position) { - if (openingIndex.add(position.x(), position.y(), position.z())) { - openings.add(position); - } - include(position); - } - - private void addOpening(int x, int y, int z) { - if (openingIndex.add(x, y, z)) { - openings.add(new CavePosition(x, y, z)); - } - include(x, y, z); - } - - private void addOpeningNeighborhood(CavePosition position) { - addOpening(position); - for (int[] offset : NEIGHBORS) { - addOpening( - position.x() + offset[0], - position.y() + offset[1], - position.z() + offset[2] - ); - } - } - - private void addAdjacentSurfaceOpenings( - HydrologyFootprintCompiler.ValidationRaster validation - ) { - ArrayList actionPositions = new ArrayList<>(actions.keySet()); - for (CavePosition position : actionPositions) { - for (int[] offset : HORIZONTAL_NEIGHBORS) { - int neighborX = position.x() + offset[0]; - int neighborZ = position.z() + offset[1]; - if (validation.ownsSurfaceChannelAt(neighborX, neighborZ, course.id())) { - addOpening(neighborX, position.y(), neighborZ); - } - } - } - } - - private void addSurfaceOpening(HydrologyColumnLayer layer, CavePosition position) { - for (SurfaceOpening opening : surfaceOpenings) { - if (!opening.matches(layer, position)) { - continue; - } - if (opening.includeNeighborhood()) { - addOpeningNeighborhood(position); - } else { - addOpening(position); - } - } - } - - private void include(CavePosition position) { - include(position.x(), position.y(), position.z()); - } - - private void include(int x, int y, int z) { - minimumX = Math.min(minimumX, x); - maximumX = Math.max(maximumX, x); - minimumY = Math.min(minimumY, y); - maximumY = Math.max(maximumY, y); - minimumZ = Math.min(minimumZ, z); - maximumZ = Math.max(maximumZ, z); - } - - private HydrologyCaveCandidate build(Options options) { - HydrologyPoint start = representative.start(); - int waterHead = representative.upstreamHeadY(); - int entryY = Math.max(waterHead, maximumY); - CavePosition entry = new CavePosition(start.x(), entryY, start.z()); - CavePosition target = new CavePosition(start.x(), waterHead, start.z()); - int horizontalRadius = horizontalRadius( - entry.x(), - entry.z(), - minimumX, - maximumX, - minimumZ, - maximumZ - ); - int maximumDepth = Math.max(1, entryY - minimumY + 2); - int dryHeadroom = Math.max(0, maximumY - waterHead); - int volume = Math.max(1, actions.size()); - HydrologyCavePlannerSettings settings = new HydrologyCavePlannerSettings( - horizontalRadius, - maximumDepth, - volume, - 1, - 1, - 1, - 1, - dryHeadroom, - HydrologyCaveFluidPolicy.REJECT_EXISTING, - HydrologyCaveGrottoShape.ELLIPSOID, - horizontalRadius, - maximumDepth - ); - return new HydrologyCaveCandidate( - new HydrologyCaveSource( - course.id(), - entry, - target, - waterHead, - HydrologyCaveMode.GENERATED_GROTTO - ), - course.profileKey(), - settings, - options.connectToExistingCaves() && course.type() == RiverCourseType.UNDERGROUND, - actions, - openings - ); - } - - private static int actionPriority(HydrologyCaveAction action) { - return switch (action) { - case WET_SOURCE -> 0; - case FALLING_FLUID -> 1; - case DRY_AIR -> 2; - case SEAL_GUARD -> 3; - }; - } - - } - - private record SurfaceOpening( - long segmentId, - HydrologyPoint point, - double interiorX, - double interiorZ, - long radiusSquared, - int minimumY, - boolean includeNeighborhood - ) { - private static SurfaceOpening create( - HydraulicSegment segment, - boolean start, - long radiusSquared, - int minimumY, - boolean includeNeighborhood - ) { - List centerline = segment.centerline(); - int boundaryIndex = start ? 0 : centerline.size() - 1; - int interiorIndex = start - ? Math.min(1, centerline.size() - 1) - : Math.max(0, centerline.size() - 2); - HydrologyPoint point = centerline.get(boundaryIndex); - HydrologyPoint interior = centerline.get(interiorIndex); - double deltaX = interior.x() - point.x(); - double deltaZ = interior.z() - point.z(); - double lengthSquared = deltaX * deltaX + deltaZ * deltaZ; - double scale = 0D; - if (includeNeighborhood) { - scale = lengthSquared <= radiusSquared - ? 1D - : StrictMath.sqrt(radiusSquared / lengthSquared); - } - return new SurfaceOpening( - segment.id(), - point, - point.x() + deltaX * scale, - point.z() + deltaZ * scale, - radiusSquared, - minimumY, - includeNeighborhood - ); - } - - private boolean matches(HydrologyColumnLayer layer, CavePosition position) { - return matchesColumn(layer, position.x(), position.z()) - && position.y() >= minimumY; - } - - private boolean matchesColumn(HydrologyColumnLayer layer, int x, int z) { - return (includeNeighborhood || layer.feature().segmentId() == segmentId) - && distanceSquared(x, z) <= radiusSquared; - } - - private double distanceSquared(int x, int z) { - double pathX = interiorX - point.x(); - double pathZ = interiorZ - point.z(); - double pathLengthSquared = pathX * pathX + pathZ * pathZ; - double positionX = x - point.x(); - double positionZ = z - point.z(); - double progress = pathLengthSquared == 0D - ? 0D - : (positionX * pathX + positionZ * pathZ) / pathLengthSquared; - double clampedProgress = Math.max(0D, Math.min(1D, progress)); - double deltaX = positionX - pathX * clampedProgress; - double deltaZ = positionZ - pathZ * clampedProgress; - return deltaX * deltaX + deltaZ * deltaZ; - } - } } diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyChannelGeometry.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyChannelGeometry.java new file mode 100644 index 000000000..53e76b48c --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyChannelGeometry.java @@ -0,0 +1,358 @@ +package art.arcane.iris.engine.hydrology; + +final class HydrologyChannelGeometry { + private final HydrologyFootprintCompiler compiler; + + HydrologyChannelGeometry(HydrologyFootprintCompiler compiler) { + this.compiler = compiler; + } + + static final long ORGANIC_SHAPE_FIRST_PHASE_SALT = 0x4f5247414e31L; + static final long ORGANIC_SHAPE_SECOND_PHASE_SALT = 0x4f5247414e32L; + static final long ORGANIC_BED_VARIATION_SALT = 0x424544564152L; + static final long ORGANIC_CEILING_VARIATION_SALT = 0x4345494c564152L; + + double smoothStep(double progress) { + return progress * progress * (3D - 2D * progress); + } + + FootprintLayerShape shape( + RiverCourse course, + HydraulicSegment segment, + HydrologyPoint point, + int bed, + int fluidHead, + boolean falling, + boolean receiving + ) { + HydrologyFeatureType type = segment.type(); + int channelRadius = Math.max(1, segment.width() / 2); + double shoreWidth = 0D; + double gradingWidth = 0D; + int ceiling = fluidHead; + boolean ellipsoid = false; + boolean archedChannel = false; + boolean roundedSurfaceBed = false; + boolean organicBoundary = type.isSurface() || type.isUnderground() || type.isDeepFluid() || falling || receiving; + if (course.type() == RiverCourseType.SURFACE && type.isSurface()) { + roundedSurfaceBed = !falling; + shoreWidth = compiler.settings.surface().shoreWidth(); + gradingWidth = compiler.geometrySampler.sample( + HydrologyGeometrySampler.Field.SURFACE_BLEND_WIDTH, + course.profileKey(), + point.x(), + point.z(), + segment.id(), + compiler.settings.surface().banks().minimumBlendWidth(), + compiler.settings.surface().banks().maximumBlendWidth() + ); + if (type == HydrologyFeatureType.WATERFALL) { + shoreWidth = Math.min(2.5D, shoreWidth); + gradingWidth = Math.min(gradingWidth, Math.max(8D, channelRadius * 4D)); + } + } + if (type == HydrologyFeatureType.UNDERGROUND_POOL + || type == HydrologyFeatureType.UNDERGROUND_DROP + || type == HydrologyFeatureType.SINKHOLE) { + ceiling = fluidHead + compiler.geometrySampler.sample( + HydrologyGeometrySampler.Field.UNDERGROUND_HEADROOM, + course.profileKey(), + point.x(), + point.z(), + course.id(), + compiler.settings.underground().minimumHeadroom(), + compiler.settings.underground().maximumHeadroom() + ); + archedChannel = !falling; + } else if (type == HydrologyFeatureType.COASTAL_GROTTO) { + HydrologyPlannerSettings.Grotto grotto = compiler.settings.outlets().coastalGrotto(); + channelRadius = grotto.horizontalRadius(); + bed = fluidHead - grotto.verticalRadius(); + ceiling = fluidHead + grotto.headroom(); + ellipsoid = true; + organicBoundary = true; + } else if (type == HydrologyFeatureType.INLAND_GROTTO) { + HydrologyPlannerSettings.Grotto grotto = compiler.settings.outlets().inlandGrotto(); + channelRadius = grotto.horizontalRadius(); + bed = fluidHead - grotto.verticalRadius(); + ceiling = fluidHead + grotto.headroom(); + ellipsoid = true; + organicBoundary = true; + } else if (type.isDeepFluid()) { + HydrologyPlannerSettings.DeepFluid deepFluid = compiler.deepFluids.get(course.profileKey()); + if (deepFluid == null) { + throw new IllegalStateException("Missing deep-fluid planner settings for " + course.profileKey() + "."); + } + if (type == HydrologyFeatureType.DEEP_POOL) { + channelRadius = Math.max(1, segment.width() / 2); + bed = fluidHead - Math.max(segment.depth(), deepFluid.minimumVerticalRadius()); + ellipsoid = true; + } else { + archedChannel = !falling; + } + ceiling = fluidHead + deepFluid.headroom(); + organicBoundary = true; + } + if (receiving) { + HydrologyPlannerSettings.Drops drops = compiler.settings.geometry().drops(); + if (course.type() != RiverCourseType.SURFACE || !type.isSurface()) { + channelRadius = Math.max( + channelRadius, + (int) StrictMath.ceil(drops.basinWidth(segment.width()) / 2D) + ); + } + bed = Math.min(bed, fluidHead - drops.basinDepth(segment.depth(), segment.drop())); + if (course.type() == RiverCourseType.SURFACE && type.isSurface()) { + gradingWidth = Math.max( + gradingWidth, + Math.min(compiler.settings.surface().banks().maximumBlendWidth(), channelRadius * 2D) + ); + } + } + if (type == HydrologyFeatureType.UNDERGROUND_POOL && segment.centerline().size() > 1) { + int depthVariation = Math.min( + 2, + Math.max(0, compiler.settings.underground().maximumDepth() - (fluidHead - bed)) + ); + bed -= organicVerticalVariation( + HydrologyHash.mix(segment.id(), ORGANIC_BED_VARIATION_SALT), + point.x(), + point.z(), + depthVariation + ); + } + if (falling) { + bed = Math.min(bed, segment.downstreamHeadY() - 1); + ceiling = Math.max(ceiling, segment.upstreamHeadY()); + } + return new FootprintLayerShape( + channelRadius, + shoreWidth, + gradingWidth, + bed, + fluidHead, + ceiling, + ellipsoid, + archedChannel, + roundedSurfaceBed, + organicBoundary, + falling + ); + } + + int organicVerticalVariation( + long seed, + int x, + int z, + int maximum + ) { + if (maximum == 0) { + return 0; + } + double sampled = organicNoise(seed, x, z, 12); + return (int) StrictMath.round(sampled * maximum); + } + + double ellipsoidScale(int radius, double distance, double roundness) { + double normalized = Math.min(1D, distance / Math.max(1D, radius)); + return StrictMath.pow( + Math.max(0D, 1D - StrictMath.pow(normalized, roundness)), + 1D / roundness + ); + } + + double shapedDistance( + FootprintLayerShape shape, + HydraulicSegment segment, + int worldX, + int worldZ, + double deltaX, + double deltaZ, + int flowX, + int flowZ, + double rawDistance + ) { + if (segment.type() == HydrologyFeatureType.DEEP_POOL) { + return deepPoolDistance(shape, segment, worldX, worldZ, deltaX, deltaZ); + } + if (segment.type().isSurface() && !shape.fallingThroat()) { + return surfaceChannelDistance(shape, segment, worldX, worldZ, deltaX, deltaZ, flowX, flowZ); + } + if (rawDistance == 0D) { + return 0D; + } + double distance = rawDistance; + if (shape.fallingThroat() && (flowX != 0 || flowZ != 0)) { + double flowLength = StrictMath.hypot(flowX, flowZ); + double along = StrictMath.abs(deltaX * flowX + deltaZ * flowZ) / flowLength; + double across = StrictMath.abs(deltaX * -flowZ + deltaZ * flowX) / flowLength; + if (along > 0.75D) { + return shape.totalRadius() + 1D; + } + distance = across; + } + if (!shape.organicBoundary()) { + return distance; + } + HydrologyPlannerSettings.ChannelShape channelShape = channelShape(segment.type()); + if (segment.type() == HydrologyFeatureType.COASTAL_GROTTO + || segment.type() == HydrologyFeatureType.INLAND_GROTTO) { + double orientation = HydrologyHash.unit(HydrologyHash.mix( + segment.courseId(), + ORGANIC_SHAPE_FIRST_PHASE_SALT + )) * StrictMath.PI * 2D; + double cosine = StrictMath.cos(orientation); + double sine = StrictMath.sin(orientation); + double rotatedX = deltaX * cosine + deltaZ * sine; + double rotatedZ = -deltaX * sine + deltaZ * cosine; + double aspect = channelShape.aspectMinimum() + HydrologyHash.unit(HydrologyHash.mix( + segment.courseId(), + ORGANIC_SHAPE_SECOND_PHASE_SALT + )) * channelShape.aspectRange(); + distance = StrictMath.hypot(rotatedX, rotatedZ / aspect); + } + double angle = StrictMath.atan2(deltaZ, deltaX); + double firstPhase = HydrologyHash.unit(HydrologyHash.mix( + segment.courseId(), + ORGANIC_SHAPE_FIRST_PHASE_SALT + )) * StrictMath.PI * 2D; + double secondPhase = HydrologyHash.unit(HydrologyHash.mix( + segment.courseId(), + ORGANIC_SHAPE_SECOND_PHASE_SALT + )) * StrictMath.PI * 2D; + double firstLobe = 0.5D + 0.5D * StrictMath.sin(angle * 3D + firstPhase); + double secondLobe = 0.5D + 0.5D * StrictMath.sin(angle * 5D + secondPhase); + double coherent = signedOrganicNoise( + segment.courseId(), + worldX, + worldZ, + channelShape.roughnessWavelength() + ); + double detail = signedOrganicNoise( + HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_SECOND_PHASE_SALT), + worldX, + worldZ, + Math.max(3, channelShape.roughnessWavelength() / 2) + ); + double radialScale = channelShape.radialBase() + + (firstLobe - 0.5D) * channelShape.primaryLobeStrength() + + (secondLobe - 0.5D) * channelShape.detailLobeStrength() + + coherent * channelShape.wallRoughness() * 0.7D + + detail * channelShape.wallRoughness() * 0.3D; + radialScale = Math.max(channelShape.radialMinimum(), Math.min(channelShape.radialMaximum(), radialScale)); + return distance / radialScale; + } + + double surfaceChannelDistance( + FootprintLayerShape shape, + HydraulicSegment segment, + int worldX, + int worldZ, + double deltaX, + double deltaZ, + int flowX, + int flowZ + ) { + double flowLength = StrictMath.hypot(flowX, flowZ); + if (flowLength == 0D) { + return deepPoolDistance(shape, segment, worldX, worldZ, deltaX, deltaZ); + } + double signedCross = (deltaX * -flowZ + deltaZ * flowX) / flowLength; + HydrologyPlannerSettings.ChannelShape channelShape = compiler.settings.geometry().surface(); + double thalweg = signedOrganicNoise( + HydrologyHash.mix(segment.courseId(), ORGANIC_BED_VARIATION_SALT), + worldX, + worldZ, + channelShape.roughnessWavelength() + ) * shape.channelRadius() * channelShape.wallRoughness(); + long bankSeed = HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_SECOND_PHASE_SALT); + double bankNoise = signedOrganicNoise( + bankSeed, + worldX, + worldZ, + channelShape.roughnessWavelength() + ); + double sideBias = signedCross < thalweg + ? HydrologyHash.unit(HydrologyHash.mix(bankSeed, 1L)) + : HydrologyHash.unit(HydrologyHash.mix(bankSeed, 2L)); + double widthScale = 0.86D + + bankNoise * channelShape.wallRoughness() + + (sideBias - 0.5D) * 0.08D; + widthScale = Math.max(1D, Math.min(1.18D, widthScale)); + double organicDistance = StrictMath.abs(signedCross - thalweg) / widthScale; + return Math.min(StrictMath.abs(signedCross), organicDistance); + } + + HydrologyPlannerSettings.ChannelShape channelShape(HydrologyFeatureType type) { + if (type.isGrotto() || type == HydrologyFeatureType.DEEP_POOL) { + return compiler.settings.geometry().grottos(); + } + if (type.isUnderground() || type == HydrologyFeatureType.DEEP_CHANNEL) { + return compiler.settings.geometry().underground(); + } + return compiler.settings.geometry().surface(); + } + + double signedOrganicNoise(long seed, int x, int z, int scale) { + return organicNoise(seed, x, z, scale) * 2D - 1D; + } + + double deepPoolDistance( + FootprintLayerShape shape, + HydraulicSegment segment, + int worldX, + int worldZ, + double deltaX, + double deltaZ + ) { + double radius = Math.max(1D, shape.channelRadius()); + long seed = HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_FIRST_PHASE_SALT); + double orientation = HydrologyHash.unit(seed) * StrictMath.PI * 2D; + double cosine = StrictMath.cos(orientation); + double sine = StrictMath.sin(orientation); + double rotatedX = deltaX * cosine + deltaZ * sine; + double rotatedZ = -deltaX * sine + deltaZ * cosine; + double angle = StrictMath.atan2(rotatedZ, rotatedX); + double secondPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 2L)) * StrictMath.PI * 2D; + double thirdPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 3L)) * StrictMath.PI * 2D; + double fifthPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 5L)) * StrictMath.PI * 2D; + double radialScale = 0.84D + + StrictMath.sin(angle * 2D + secondPhase) * 0.07D + + StrictMath.sin(angle * 3D + thirdPhase) * 0.05D + + StrictMath.sin(angle * 5D + fifthPhase) * 0.035D; + radialScale = Math.max(0.68D, Math.min(1D, radialScale)); + double normalizedDistance = StrictMath.hypot( + rotatedX / (radius * 0.92D), + rotatedZ / (radius * 0.7D) + ); + return normalizedDistance * radius / radialScale; + } + + double organicNoise(long seed, int x, int z, int scale) { + int cellX = Math.floorDiv(x, scale); + int cellZ = Math.floorDiv(z, scale); + double localX = Math.floorMod(x, scale) / (double) scale; + double localZ = Math.floorMod(z, scale) / (double) scale; + double smoothX = localX * localX * (3D - 2D * localX); + double smoothZ = localZ * localZ * (3D - 2D * localZ); + double top = interpolate( + organicCorner(seed, cellX, cellZ), + organicCorner(seed, cellX + 1, cellZ), + smoothX + ); + double bottom = interpolate( + organicCorner(seed, cellX, cellZ + 1), + organicCorner(seed, cellX + 1, cellZ + 1), + smoothX + ); + return interpolate(top, bottom, smoothZ); + } + + double organicCorner(long seed, int cellX, int cellZ) { + return HydrologyHash.unit(HydrologyHash.mix(seed, cellX, cellZ)); + } + + double interpolate(double first, double second, double progress) { + return first + (second - first) * progress; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintCompiler.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintCompiler.java index bb66f0b63..e5e3a9cd0 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintCompiler.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintCompiler.java @@ -9,7 +9,6 @@ import it.unimi.dsi.fastutil.longs.Long2ObjectMap; import it.unimi.dsi.fastutil.longs.Long2ObjectOpenHashMap; import java.util.ArrayList; -import java.util.Arrays; import java.util.Comparator; import java.util.HashMap; import java.util.LinkedHashMap; @@ -18,32 +17,34 @@ import java.util.Map; import java.util.Objects; final class HydrologyFootprintCompiler { - private static final int FEATURE_ROLE_COUNT = 7; - private static final int COURSE_FOOTPRINT_CACHE_SIZE = 32; - private static final int VALIDATION_RASTER_CACHE_SIZE = 32; - private static final int[][] HORIZONTAL_NEIGHBORS = { - {1, 0}, {-1, 0}, {0, 1}, {0, -1} - }; - private static final long ORGANIC_SHAPE_FIRST_PHASE_SALT = 0x4f5247414e31L; - private static final long ORGANIC_SHAPE_SECOND_PHASE_SALT = 0x4f5247414e32L; - private static final long ORGANIC_BED_VARIATION_SALT = 0x424544564152L; - private static final long ORGANIC_CEILING_VARIATION_SALT = 0x4345494c564152L; + static final int FEATURE_ROLE_COUNT = 7; + static final int COURSE_FOOTPRINT_CACHE_SIZE = 32; + static final int VALIDATION_RASTER_CACHE_SIZE = 32; - private final HydrologyPlannerSettings settings; - private final HydrologyTerrainSampler sampler; - private final HydrologyNaturalTerrainSampler naturalSampler; - private final HydrologyGeometrySampler geometrySampler; - private final Map deepFluids; - private final Long2ObjectOpenHashMap terrainSamples; - private final Long2ObjectOpenHashMap terrainBases; - private final Long2ObjectOpenHashMap naturalClassifications; - private final Map features; - private final LinkedHashMap courseFootprints; - private final LinkedHashMap validationCourseRasters; - private final Map rasterStencils; - private final SurfaceFootprintCompiler surfaceCompiler; - private final LinkedHashMap surfaceFootprints; - private int fullMaterializationCount; + static final int[][] HORIZONTAL_NEIGHBORS = { + {1, 0}, {-1, 0}, {0, 1}, {0, -1} + } + +; + + final HydrologyPlannerSettings settings; + final HydrologyTerrainSampler sampler; + final HydrologyNaturalTerrainSampler naturalSampler; + final HydrologyGeometrySampler geometrySampler; + final Map deepFluids; + final Long2ObjectOpenHashMap terrainSamples; + final Long2ObjectOpenHashMap terrainBases; + final Long2ObjectOpenHashMap naturalClassifications; + final Map features; + final LinkedHashMap courseFootprints; + final LinkedHashMap validationCourseRasters; + final Map rasterStencils; + final SurfaceFootprintCompiler surfaceCompiler; + final LinkedHashMap surfaceFootprints; + + int fullMaterializationCount; + final HydrologyFootprintRasterizer rasterizer; + final HydrologyChannelGeometry channelGeometry; HydrologyFootprintCompiler( HydrologyPlannerSettings settings, @@ -83,10 +84,12 @@ final class HydrologyFootprintCompiler { this.surfaceCompiler = new SurfaceFootprintCompiler(settings, this::sampleTerrainBasis, this.geometrySampler); this.surfaceFootprints = new LinkedHashMap<>(COURSE_FOOTPRINT_CACHE_SIZE, 1F, true); this.fullMaterializationCount = 0; + this.rasterizer = new HydrologyFootprintRasterizer(this); + this.channelGeometry = new HydrologyChannelGeometry(this); } SurfaceFootprint surfaceFootprint(RiverCourse course) { - CourseRasterKey rasterKey = new CourseRasterKey( + FootprintCourseRasterKey rasterKey = new FootprintCourseRasterKey( course.id(), course.type(), course.profileKey(), @@ -112,14 +115,14 @@ final class HydrologyFootprintCompiler { if (courses.size() == 1) { return compileCourse(courses.getFirst()); } - Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); + Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); for (RiverCourse course : courses) { RiverFootprint footprint = compileCourse(course); for (Map.Entry entry : footprint.columns().entrySet()) { HydrologyColumnSample sample = entry.getValue(); - MutableColumn column = columns.get(entry.getKey()); + FootprintMutableColumn column = columns.get(entry.getKey()); if (column == null) { - columns.put(entry.getKey(), new MutableColumn(sample)); + columns.put(entry.getKey(), new FootprintMutableColumn(sample)); continue; } column.merge(sample); @@ -143,11 +146,11 @@ final class HydrologyFootprintCompiler { ); } - ArrayList courseRasters = new ArrayList<>(courses.size()); + ArrayList courseRasters = new ArrayList<>(courses.size()); ArrayList surfaces = new ArrayList<>(); Long2ObjectOpenHashMap firstSamples = new Long2ObjectOpenHashMap<>(); for (RiverCourse course : courses) { - ValidationCourseRaster raster = compileValidationCourse(course); + FootprintValidationCourseRaster raster = compileValidationCourse(course); courseRasters.add(raster); surfaces.add(raster.surface()); for (HydrologyColumnSample sample : raster.columns()) { @@ -168,21 +171,21 @@ final class HydrologyFootprintCompiler { return fullMaterializationCount; } - private ValidationCourseRaster compileValidationCourse(RiverCourse course) { - CourseRasterKey rasterKey = new CourseRasterKey( + FootprintValidationCourseRaster compileValidationCourse(RiverCourse course) { + FootprintCourseRasterKey rasterKey = new FootprintCourseRasterKey( course.id(), course.type(), course.profileKey(), course.segments() ); - ValidationCourseRaster cached = validationCourseRasters.get(rasterKey); + FootprintValidationCourseRaster cached = validationCourseRasters.get(rasterKey); if (cached != null) { return cached; } boolean caveCourse = hasCaveSegment(course); features.clear(); - Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); + Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); SurfaceFootprint surface = surfaceFootprint(course); for (SurfaceLayerColumn column : surface.columns()) { addLayer(columns, column.x(), column.z(), column.terrain(), column.layer()); @@ -192,12 +195,12 @@ final class HydrologyFootprintCompiler { HydraulicSegment segment = course.segments().get(segmentIndex); boolean firstSegment = segmentIndex == 0; boolean clipStart = segmentIndex > 0 - && segmentsJoin(course.segments().get(segmentIndex - 1), segment); + && rasterizer.segmentsJoin(course.segments().get(segmentIndex - 1), segment); boolean clipEnd = segmentIndex + 1 < course.segments().size() - && segmentsJoin(segment, course.segments().get(segmentIndex + 1)); + && rasterizer.segmentsJoin(segment, course.segments().get(segmentIndex + 1)); if (caveCourse && (segment.type().isUnderground() || segment.type().isDeepFluid())) { - rasterizeSegment( + rasterizer.rasterizeSegment( columns, course, segment, @@ -209,7 +212,7 @@ final class HydrologyFootprintCompiler { ); } } - ValidationCourseRaster raster = new ValidationCourseRaster( + FootprintValidationCourseRaster raster = new FootprintValidationCourseRaster( course.id(), buildValidationColumns(columns), surface @@ -221,7 +224,7 @@ final class HydrologyFootprintCompiler { return raster; } - private boolean hasCaveSegment(RiverCourse course) { + boolean hasCaveSegment(RiverCourse course) { for (HydraulicSegment segment : course.segments()) { if (segment.type().isUnderground() || segment.type().isDeepFluid()) { return true; @@ -230,11 +233,11 @@ final class HydrologyFootprintCompiler { return false; } - private List buildValidationColumns( - Long2ObjectLinkedOpenHashMap columns + List buildValidationColumns( + Long2ObjectLinkedOpenHashMap columns ) { ArrayList built = new ArrayList<>(columns.size()); - for (MutableColumn column : columns.values()) { + for (FootprintMutableColumn column : columns.values()) { built.add(column.build()); } built.sort(Comparator.comparingLong( @@ -243,7 +246,7 @@ final class HydrologyFootprintCompiler { return List.copyOf(built); } - private static void validateMatchingTerrainMetadata( + static void validateMatchingTerrainMetadata( HydrologyColumnSample first, HydrologyColumnSample second ) { @@ -258,8 +261,8 @@ final class HydrologyFootprintCompiler { } } - private RiverFootprint compileCourse(RiverCourse course) { - CourseRasterKey rasterKey = new CourseRasterKey( + RiverFootprint compileCourse(RiverCourse course) { + FootprintCourseRasterKey rasterKey = new FootprintCourseRasterKey( course.id(), course.type(), course.profileKey(), @@ -270,7 +273,7 @@ final class HydrologyFootprintCompiler { return cached; } features.clear(); - Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); + Long2ObjectLinkedOpenHashMap columns = new Long2ObjectLinkedOpenHashMap<>(); SurfaceFootprint surface = surfaceFootprint(course); for (SurfaceLayerColumn column : surface.columns()) { addLayer(columns, column.x(), column.z(), column.terrain(), column.layer()); @@ -282,10 +285,10 @@ final class HydrologyFootprintCompiler { continue; } boolean clipStart = segmentIndex > 0 - && segmentsJoin(course.segments().get(segmentIndex - 1), segment); + && rasterizer.segmentsJoin(course.segments().get(segmentIndex - 1), segment); boolean clipEnd = segmentIndex + 1 < course.segments().size() - && segmentsJoin(segment, course.segments().get(segmentIndex + 1)); - rasterizeSegment( + && rasterizer.segmentsJoin(segment, course.segments().get(segmentIndex + 1)); + rasterizer.rasterizeSegment( columns, course, segment, @@ -304,707 +307,15 @@ final class HydrologyFootprintCompiler { return footprint; } - private RiverFootprint build(Long2ObjectLinkedOpenHashMap columns) { + RiverFootprint build(Long2ObjectLinkedOpenHashMap columns) { LinkedHashMap immutable = new LinkedHashMap<>(); - for (Long2ObjectMap.Entry entry : columns.long2ObjectEntrySet()) { + for (Long2ObjectMap.Entry entry : columns.long2ObjectEntrySet()) { immutable.put(entry.getLongKey(), entry.getValue().build()); } return new RiverFootprint(immutable); } - private double smoothStep(double progress) { - return progress * progress * (3D - 2D * progress); - } - - private void rasterizeSegment( - Long2ObjectLinkedOpenHashMap columns, - RiverCourse course, - HydraulicSegment segment, - boolean firstSegment, - boolean clipStart, - boolean clipEnd, - boolean validationOnly, - SurfaceRasterIndex plannedSurface - ) { - List centerline = continuousCenterline(segment); - if (segment.fallingFluid() && centerline.size() > 1) { - HydrologyPoint throat = centerline.getFirst(); - int fluidHead = segment.upstreamHeadY(); - LayerShape throatShape = shape( - course, - segment, - throat, - segment.downstreamHeadY() - 1, - fluidHead, - true, - false - ); - rasterizePoint( - columns, - course, - segment, - throat, - 0, - throatShape, - flowDelta(centerline, 0, true), - flowDelta(centerline, 0, false), - firstSegment, - true, - false, - false, - validationOnly, - plannedSurface - ); - rasterizeSweptSegment( - columns, - course, - segment, - List.copyOf(centerline.subList(1, centerline.size())), - false, - true, - clipEnd, - validationOnly, - plannedSurface - ); - return; - } - if (sweptChannel(segment, centerline)) { - rasterizeSweptSegment( - columns, - course, - segment, - centerline, - firstSegment, - clipStart, - clipEnd, - validationOnly, - plannedSurface - ); - return; - } - for (int pointIndex = 0; pointIndex < centerline.size(); pointIndex++) { - HydrologyPoint point = centerline.get(pointIndex); - boolean oceanConnection = (segment.type() == HydrologyFeatureType.MOUTH - || segment.type() == HydrologyFeatureType.COASTAL_GROTTO) - && pointIndex == centerline.size() - 1; - boolean falling = segment.fallingFluid() && pointIndex == 0; - boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; - int fluidHead = falling ? segment.upstreamHeadY() : point.y(); - int bed = falling - ? segment.downstreamHeadY() - 1 - : fluidHead - segment.depth(); - LayerShape shape = shape(course, segment, point, bed, fluidHead, falling, receiving); - int flowX = flowDelta(centerline, pointIndex, true); - int flowZ = flowDelta(centerline, pointIndex, false); - rasterizePoint( - columns, - course, - segment, - point, - pointIndex, - shape, - flowX, - flowZ, - firstSegment && pointIndex == 0, - falling, - receiving, - oceanConnection, - validationOnly, - plannedSurface - ); - } - } - - private boolean sweptChannel( - HydraulicSegment segment, - List centerline - ) { - if (centerline.size() < 2 || segment.fallingFluid()) { - return false; - } - return segment.type().isSurface() - || segment.type() == HydrologyFeatureType.UNDERGROUND_POOL - || segment.type() == HydrologyFeatureType.UNDERGROUND_DROP - || segment.type() == HydrologyFeatureType.SINKHOLE - || segment.type() == HydrologyFeatureType.DEEP_CHANNEL; - } - - private void rasterizeSweptSegment( - Long2ObjectLinkedOpenHashMap columns, - RiverCourse course, - HydraulicSegment segment, - List centerline, - boolean firstSegment, - boolean clipStart, - boolean clipEnd, - boolean validationOnly, - SurfaceRasterIndex plannedSurface - ) { - LayerShape[] shapes = new LayerShape[centerline.size()]; - int maximumRadius = 1; - int minimumX = Integer.MAX_VALUE; - int maximumX = Integer.MIN_VALUE; - int minimumZ = Integer.MAX_VALUE; - int maximumZ = Integer.MIN_VALUE; - for (int pointIndex = 0; pointIndex < centerline.size(); pointIndex++) { - HydrologyPoint point = centerline.get(pointIndex); - int fluidHead = point.y(); - boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; - LayerShape shape = shape( - course, - segment, - point, - fluidHead - segment.depth(), - fluidHead, - false, - receiving - ); - shapes[pointIndex] = shape; - int rasterRadius = segment.type().isSurface() - ? (int) StrictMath.ceil(shape.totalRadius()) - : shape.channelRadius(); - maximumRadius = Math.max(maximumRadius, rasterRadius); - minimumX = Math.min(minimumX, point.x()); - maximumX = Math.max(maximumX, point.x()); - minimumZ = Math.min(minimumZ, point.z()); - maximumZ = Math.max(maximumZ, point.z()); - } - minimumX = Math.subtractExact(minimumX, maximumRadius); - maximumX = Math.addExact(maximumX, maximumRadius); - minimumZ = Math.subtractExact(minimumZ, maximumRadius); - maximumZ = Math.addExact(maximumZ, maximumRadius); - HydrologyFeatureRef[][] pointFeatures = new HydrologyFeatureRef[centerline.size()][FEATURE_ROLE_COUNT]; - for (int z = minimumZ; z <= maximumZ; z++) { - for (int x = minimumX; x <= maximumX; x++) { - if (!withinLongitudinalBounds(centerline, x, z, clipStart, clipEnd)) { - continue; - } - CenterlineProjection projection = projectCenterline(centerline, x, z); - int pointIndex = projection.pointIndex(); - HydrologyPoint point = centerline.get(pointIndex); - boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; - LayerShape shape = shapes[pointIndex]; - int deltaX = x - point.x(); - int deltaZ = z - point.z(); - double rawDistance = projection.distance(); - double rasterRadius = segment.type().isSurface() - ? shape.totalRadius() - : shape.channelRadius(); - if (rawDistance > rasterRadius + 0.25D) { - continue; - } - int flowX = projection.flowX(); - int flowZ = projection.flowZ(); - double channelDistance = shapedDistance( - shape, - segment, - x, - z, - x - projection.x(), - z - projection.z(), - flowX, - flowZ, - rawDistance - ); - boolean channel = channelDistance <= shape.channelRadius() + 0.25D; - if (!segment.type().isSurface() && !channel) { - continue; - } - boolean shore = !channel - && channelDistance <= shape.channelRadius() + shape.shoreWidth() + 0.25D; - boolean grading = !channel && !shore && rawDistance <= shape.totalRadius() + 0.25D; - if (!channel && !shore && !grading) { - continue; - } - double distance = grading ? rawDistance : channelDistance; - HydrologyRoutingTerrainSampler.NaturalClassification classification = classifyNatural(x, z); - boolean oceanConnection = (segment.type() == HydrologyFeatureType.MOUTH - || segment.type() == HydrologyFeatureType.COASTAL_GROTTO) - && pointIndex == centerline.size() - 1; - boolean apronEligible = oceanApronEligible(segment, distance); - if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - && !apronEligible) { - continue; - } - if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.LAND - && oceanConnection) { - continue; - } - boolean exactSlope = classification != HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - && !oceanConnection - && !channel - && segment.type() != HydrologyFeatureType.WATERFALL - && segment.type() != HydrologyFeatureType.CASCADE; - HydrologyTerrainSample terrain = exactSlope ? sampleTerrain(x, z) : sampleTerrainBasis(x, z); - if (terrain == null) { - continue; - } - boolean naturalOcean = classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - || terrain.ocean() - || naturallySubmergedSurfaceColumn(segment, terrain); - if (oceanConnection || naturalOcean) { - if (naturalOcean && apronEligible) { - addOceanApron(columns, course, segment, point, x, z, distance, flowX, flowZ, - terrain, pointFeatures[pointIndex]); - } - continue; - } - boolean source = firstSegment && pointIndex == 0; - if (validationOnly && segment.type().isSurface()) { - feature(course, segment, x, shape.fluidHead(), z, flowX, flowZ, - source && deltaX == 0 && deltaZ == 0, channel, shore, grading, - false, false, pointFeatures[pointIndex]); - continue; - } - HydrologyColumnLayer layer = regularLayer( - course, - segment, - point, - shape, - terrain, - distance, - deltaX, - deltaZ, - flowX, - flowZ, - source, - channel, - shore, - grading, - false, - receiving, - pointFeatures[pointIndex] - ); - layer = terrainContainedCaveLayer(course, segment, terrain, layer, x, z, plannedSurface); - if (layer == null) { - continue; - } - addLayer(columns, x, z, terrain, layer); - } - } - } - - private CenterlineProjection projectCenterline(List centerline, int x, int z) { - if (centerline.size() == 1) { - HydrologyPoint point = centerline.getFirst(); - return new CenterlineProjection( - 0, - point.x(), - point.z(), - StrictMath.hypot(x - point.x(), z - point.z()), - 1, - 0 - ); - } - int selectedPoint = 0; - double selectedX = centerline.getFirst().x(); - double selectedZ = centerline.getFirst().z(); - double selectedDistanceSquared = Double.POSITIVE_INFINITY; - int selectedFlowX = 1; - int selectedFlowZ = 0; - for (int segmentIndex = 0; segmentIndex < centerline.size() - 1; segmentIndex++) { - HydrologyPoint start = centerline.get(segmentIndex); - HydrologyPoint end = centerline.get(segmentIndex + 1); - double flowX = end.x() - start.x(); - double flowZ = end.z() - start.z(); - double lengthSquared = flowX * flowX + flowZ * flowZ; - if (lengthSquared == 0D) { - continue; - } - double progress = ((x - start.x()) * flowX + (z - start.z()) * flowZ) / lengthSquared; - progress = Math.max(0D, Math.min(1D, progress)); - double projectedX = start.x() + flowX * progress; - double projectedZ = start.z() + flowZ * progress; - double deltaX = x - projectedX; - double deltaZ = z - projectedZ; - double distanceSquared = deltaX * deltaX + deltaZ * deltaZ; - if (distanceSquared >= selectedDistanceSquared) { - continue; - } - selectedDistanceSquared = distanceSquared; - selectedX = projectedX; - selectedZ = projectedZ; - selectedPoint = progress < 0.5D ? segmentIndex : segmentIndex + 1; - selectedFlowX = end.x() - start.x(); - selectedFlowZ = end.z() - start.z(); - } - int tangentReach = Math.max(2, settings.routing().refinementSpacing() * 2); - HydrologyPoint tangentStart = centerline.get(Math.max(0, selectedPoint - tangentReach)); - HydrologyPoint tangentEnd = centerline.get(Math.min(centerline.size() - 1, selectedPoint + tangentReach)); - int tangentX = tangentEnd.x() - tangentStart.x(); - int tangentZ = tangentEnd.z() - tangentStart.z(); - if (tangentX != 0 || tangentZ != 0) { - selectedFlowX = tangentX; - selectedFlowZ = tangentZ; - } - return new CenterlineProjection( - selectedPoint, - selectedX, - selectedZ, - StrictMath.sqrt(selectedDistanceSquared), - selectedFlowX, - selectedFlowZ - ); - } - - private boolean withinLongitudinalBounds( - List centerline, - int x, - int z, - boolean clipStart, - boolean clipEnd - ) { - if (centerline.size() < 2) { - return true; - } - HydrologyPoint start = centerline.getFirst(); - HydrologyPoint afterStart = centerline.get(1); - long startDot = (long) (x - start.x()) * (afterStart.x() - start.x()) - + (long) (z - start.z()) * (afterStart.z() - start.z()); - if (clipStart && startDot < 0L) { - return false; - } - if (!clipEnd) { - return true; - } - HydrologyPoint end = centerline.getLast(); - HydrologyPoint beforeEnd = centerline.get(centerline.size() - 2); - long endDot = (long) (x - end.x()) * (end.x() - beforeEnd.x()) - + (long) (z - end.z()) * (end.z() - beforeEnd.z()); - return endDot <= 0L; - } - - private boolean segmentsJoin(HydraulicSegment upstream, HydraulicSegment downstream) { - HydrologyPoint upstreamEnd = upstream.centerline().getLast(); - HydrologyPoint downstreamStart = downstream.centerline().getFirst(); - return upstreamEnd.x() == downstreamStart.x() - && upstreamEnd.y() == downstreamStart.y() - && upstreamEnd.z() == downstreamStart.z(); - } - - private List continuousCenterline(HydraulicSegment segment) { - List configured = segment.centerline(); - if (configured.size() == 1) { - return configured; - } - ArrayList continuous = new ArrayList<>(); - for (int pairIndex = 0; pairIndex < configured.size() - 1; pairIndex++) { - HydrologyPoint start = configured.get(pairIndex); - HydrologyPoint end = configured.get(pairIndex + 1); - int steps = Math.max(Math.abs(end.x() - start.x()), Math.abs(end.z() - start.z())); - if (steps == 0) { - if (continuous.isEmpty()) { - continuous.add(start); - } - continue; - } - int firstStep = continuous.isEmpty() ? 0 : 1; - for (int step = firstStep; step <= steps; step++) { - double progress = step / (double) steps; - int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); - int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); - int y = segment.fallingFluid() && !continuous.isEmpty() - ? segment.downstreamHeadY() - : (int) StrictMath.round(start.y() + (end.y() - start.y()) * progress); - HydrologyPoint previous = continuous.isEmpty() ? null : continuous.getLast(); - if (previous == null || previous.x() != x || previous.z() != z) { - continuous.add(new HydrologyPoint(x, y, z)); - } - } - } - return List.copyOf(continuous); - } - - private LayerShape shape( - RiverCourse course, - HydraulicSegment segment, - HydrologyPoint point, - int bed, - int fluidHead, - boolean falling, - boolean receiving - ) { - HydrologyFeatureType type = segment.type(); - int channelRadius = Math.max(1, segment.width() / 2); - double shoreWidth = 0D; - double gradingWidth = 0D; - int ceiling = fluidHead; - boolean ellipsoid = false; - boolean archedChannel = false; - boolean roundedSurfaceBed = false; - boolean organicBoundary = type.isSurface() || type.isUnderground() || type.isDeepFluid() || falling || receiving; - if (course.type() == RiverCourseType.SURFACE && type.isSurface()) { - roundedSurfaceBed = !falling; - shoreWidth = settings.surface().shoreWidth(); - gradingWidth = geometrySampler.sample( - HydrologyGeometrySampler.Field.SURFACE_BLEND_WIDTH, - course.profileKey(), - point.x(), - point.z(), - segment.id(), - settings.surface().banks().minimumBlendWidth(), - settings.surface().banks().maximumBlendWidth() - ); - if (type == HydrologyFeatureType.WATERFALL) { - shoreWidth = Math.min(2.5D, shoreWidth); - gradingWidth = Math.min(gradingWidth, Math.max(8D, channelRadius * 4D)); - } - } - if (type == HydrologyFeatureType.UNDERGROUND_POOL - || type == HydrologyFeatureType.UNDERGROUND_DROP - || type == HydrologyFeatureType.SINKHOLE) { - ceiling = fluidHead + geometrySampler.sample( - HydrologyGeometrySampler.Field.UNDERGROUND_HEADROOM, - course.profileKey(), - point.x(), - point.z(), - course.id(), - settings.underground().minimumHeadroom(), - settings.underground().maximumHeadroom() - ); - archedChannel = !falling; - } else if (type == HydrologyFeatureType.COASTAL_GROTTO) { - HydrologyPlannerSettings.Grotto grotto = settings.outlets().coastalGrotto(); - channelRadius = grotto.horizontalRadius(); - bed = fluidHead - grotto.verticalRadius(); - ceiling = fluidHead + grotto.headroom(); - ellipsoid = true; - organicBoundary = true; - } else if (type == HydrologyFeatureType.INLAND_GROTTO) { - HydrologyPlannerSettings.Grotto grotto = settings.outlets().inlandGrotto(); - channelRadius = grotto.horizontalRadius(); - bed = fluidHead - grotto.verticalRadius(); - ceiling = fluidHead + grotto.headroom(); - ellipsoid = true; - organicBoundary = true; - } else if (type.isDeepFluid()) { - HydrologyPlannerSettings.DeepFluid deepFluid = deepFluids.get(course.profileKey()); - if (deepFluid == null) { - throw new IllegalStateException("Missing deep-fluid planner settings for " + course.profileKey() + "."); - } - if (type == HydrologyFeatureType.DEEP_POOL) { - channelRadius = Math.max(1, segment.width() / 2); - bed = fluidHead - Math.max(segment.depth(), deepFluid.minimumVerticalRadius()); - ellipsoid = true; - } else { - archedChannel = !falling; - } - ceiling = fluidHead + deepFluid.headroom(); - organicBoundary = true; - } - if (receiving) { - HydrologyPlannerSettings.Drops drops = settings.geometry().drops(); - if (course.type() != RiverCourseType.SURFACE || !type.isSurface()) { - channelRadius = Math.max( - channelRadius, - (int) StrictMath.ceil(drops.basinWidth(segment.width()) / 2D) - ); - } - bed = Math.min(bed, fluidHead - drops.basinDepth(segment.depth(), segment.drop())); - if (course.type() == RiverCourseType.SURFACE && type.isSurface()) { - gradingWidth = Math.max( - gradingWidth, - Math.min(settings.surface().banks().maximumBlendWidth(), channelRadius * 2D) - ); - } - } - if (type == HydrologyFeatureType.UNDERGROUND_POOL && segment.centerline().size() > 1) { - int depthVariation = Math.min( - 2, - Math.max(0, settings.underground().maximumDepth() - (fluidHead - bed)) - ); - bed -= organicVerticalVariation( - HydrologyHash.mix(segment.id(), ORGANIC_BED_VARIATION_SALT), - point.x(), - point.z(), - depthVariation - ); - } - if (falling) { - bed = Math.min(bed, segment.downstreamHeadY() - 1); - ceiling = Math.max(ceiling, segment.upstreamHeadY()); - } - return new LayerShape( - channelRadius, - shoreWidth, - gradingWidth, - bed, - fluidHead, - ceiling, - ellipsoid, - archedChannel, - roundedSurfaceBed, - organicBoundary, - falling - ); - } - - private int organicVerticalVariation( - long seed, - int x, - int z, - int maximum - ) { - if (maximum == 0) { - return 0; - } - double sampled = organicNoise(seed, x, z, 12); - return (int) StrictMath.round(sampled * maximum); - } - - private void rasterizePoint( - Long2ObjectLinkedOpenHashMap columns, - RiverCourse course, - HydraulicSegment segment, - HydrologyPoint point, - int pointIndex, - LayerShape shape, - int flowX, - int flowZ, - boolean source, - boolean falling, - boolean receiving, - boolean oceanConnection, - boolean validationOnly, - SurfaceRasterIndex plannedSurface - ) { - RasterStencil stencil = rasterStencil(shape); - HydrologyFeatureRef[] pointFeatures = new HydrologyFeatureRef[FEATURE_ROLE_COUNT]; - boolean underground = segment.type().isUnderground() || segment.type().isDeepFluid(); - for (int offsetIndex = 0; offsetIndex < stencil.size(); offsetIndex++) { - int deltaX = stencil.deltaXs()[offsetIndex]; - int deltaZ = stencil.deltaZs()[offsetIndex]; - int x = point.x() + deltaX; - int z = point.z() + deltaZ; - double channelDistance = shapedDistance( - shape, - segment, - x, - z, - deltaX, - deltaZ, - flowX, - flowZ, - stencil.distances()[offsetIndex] - ); - boolean channel = channelDistance <= shape.channelRadius() + 0.25D; - if (underground && !channel) { - continue; - } - boolean shore = !channel - && stencil.distances()[offsetIndex] <= shape.channelRadius() + shape.shoreWidth() + 0.25D; - boolean grading = !channel - && !shore - && stencil.distances()[offsetIndex] <= shape.totalRadius() + 0.25D; - double distance = grading ? stencil.distances()[offsetIndex] : channelDistance; - HydrologyRoutingTerrainSampler.NaturalClassification classification = classifyNatural(x, z); - boolean apronEligible = oceanApronEligible(segment, distance); - if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - && !apronEligible) { - continue; - } - if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.LAND - && oceanConnection) { - continue; - } - boolean exactSlope = classification != HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - && !oceanConnection - && !channel - && segment.type() != HydrologyFeatureType.WATERFALL - && segment.type() != HydrologyFeatureType.CASCADE; - HydrologyTerrainSample terrain = exactSlope - ? sampleTerrain(x, z) - : sampleTerrainBasis(x, z); - if (terrain == null) { - continue; - } - boolean naturalOcean = classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN - || terrain.ocean() - || naturallySubmergedSurfaceColumn(segment, terrain); - if (oceanConnection) { - if (naturalOcean) { - addOceanApron( - columns, - course, - segment, - point, - x, - z, - distance, - flowX, - flowZ, - terrain, - pointFeatures - ); - } - continue; - } - if (naturalOcean) { - addOceanApron( - columns, - course, - segment, - point, - x, - z, - distance, - flowX, - flowZ, - terrain, - pointFeatures - ); - continue; - } - if (validationOnly && !underground) { - feature( - course, - segment, - x, - shape.fluidHead(), - z, - flowX, - flowZ, - source && deltaX == 0 && deltaZ == 0, - channel, - shore, - grading, - channel && falling, - channel && receiving, - pointFeatures - ); - continue; - } - HydrologyColumnLayer layer = regularLayer( - course, - segment, - point, - shape, - terrain, - distance, - deltaX, - deltaZ, - flowX, - flowZ, - source, - channel, - shore, - grading, - falling, - receiving, - pointFeatures - ); - layer = terrainContainedCaveLayer(course, segment, terrain, layer, x, z, plannedSurface); - if (layer == null) { - continue; - } - addLayer(columns, x, z, terrain, layer); - if (segment.type() == HydrologyFeatureType.COASTAL_GROTTO) { - addAdjacentSeaApron(columns, course, segment, point, x, z, flowX, flowZ, pointFeatures); - } - } - } - - private HydrologyColumnLayer terrainContainedCaveLayer( + HydrologyColumnLayer terrainContainedCaveLayer( RiverCourse course, HydraulicSegment segment, HydrologyTerrainSample terrain, @@ -1062,7 +373,7 @@ final class HydrologyFootprintCompiler { return withCeiling(layer, maximumCeiling); } - private HydrologyColumnLayer withCeiling(HydrologyColumnLayer layer, int ceiling) { + HydrologyColumnLayer withCeiling(HydrologyColumnLayer layer, int ceiling) { return new HydrologyColumnLayer( layer.feature(), layer.bedY(), @@ -1086,11 +397,11 @@ final class HydrologyFootprintCompiler { ); } - private HydrologyColumnLayer regularLayer( + HydrologyColumnLayer regularLayer( RiverCourse course, HydraulicSegment segment, HydrologyPoint point, - LayerShape shape, + FootprintLayerShape shape, HydrologyTerrainSample terrain, double distance, int deltaX, @@ -1138,10 +449,10 @@ final class HydrologyFootprintCompiler { ); } - private HydrologyColumnLayer regularLayer( + HydrologyColumnLayer regularLayer( RiverCourse course, HydraulicSegment segment, - LayerShape shape, + FootprintLayerShape shape, HydrologyTerrainSample terrain, double distance, int worldX, @@ -1153,9 +464,9 @@ final class HydrologyFootprintCompiler { boolean receiving, HydrologyFeatureRef feature ) { - HydrologyPlannerSettings.ChannelShape channelShape = channelShape(segment.type()); + HydrologyPlannerSettings.ChannelShape channelShape = channelGeometry.channelShape(segment.type()); double ellipsoidScale = channel && (shape.ellipsoid() || shape.archedChannel()) - ? ellipsoidScale(shape.channelRadius(), distance, channelShape.bedRoundness()) + ? channelGeometry.ellipsoidScale(shape.channelRadius(), distance, channelShape.bedRoundness()) : 0D; int bed = resolvedBed( segment, @@ -1197,25 +508,25 @@ final class HydrologyFootprintCompiler { ); } - private RasterStencil rasterStencil(LayerShape shape) { - RasterStencilKey key = new RasterStencilKey( + FootprintRasterStencil rasterStencil(FootprintLayerShape shape) { + FootprintRasterStencilKey key = new FootprintRasterStencilKey( shape.channelRadius(), shape.shoreWidth(), shape.gradingWidth() ); - RasterStencil cached = rasterStencils.get(key); + FootprintRasterStencil cached = rasterStencils.get(key); if (cached != null) { return cached; } - RasterStencil stencil = buildRasterStencil(key); + FootprintRasterStencil stencil = buildRasterStencil(key); rasterStencils.put(key, stencil); return stencil; } - private RasterStencil buildRasterStencil(RasterStencilKey key) { + FootprintRasterStencil buildRasterStencil(FootprintRasterStencilKey key) { double totalRadius = key.channelRadius() + key.shoreWidth() + key.gradingWidth(); int blockRadius = (int) StrictMath.ceil(totalRadius); - RasterStencilBuilder builder = new RasterStencilBuilder(); + FootprintRasterStencilBuilder builder = new FootprintRasterStencilBuilder(); for (int deltaZ = -blockRadius; deltaZ <= blockRadius; deltaZ++) { for (int deltaX = -blockRadius; deltaX <= blockRadius; deltaX++) { double distance = StrictMath.hypot(deltaX, deltaZ); @@ -1234,8 +545,8 @@ final class HydrologyFootprintCompiler { return builder.build(); } - private void addOceanApron( - Long2ObjectLinkedOpenHashMap columns, + void addOceanApron( + Long2ObjectLinkedOpenHashMap columns, RiverCourse course, HydraulicSegment segment, HydrologyPoint point, @@ -1253,8 +564,8 @@ final class HydrologyFootprintCompiler { addOceanApronLayer(columns, course, segment, point, x, z, flowX, flowZ, terrain, pointFeatures); } - private void addOceanApronLayer( - Long2ObjectLinkedOpenHashMap columns, + void addOceanApronLayer( + Long2ObjectLinkedOpenHashMap columns, RiverCourse course, HydraulicSegment segment, HydrologyPoint point, @@ -1308,8 +619,8 @@ final class HydrologyFootprintCompiler { addLayer(columns, x, z, terrain, layer); } - private int gradedBed( - LayerShape shape, + int gradedBed( + FootprintLayerShape shape, HydrologyTerrainSample terrain, double distance ) { @@ -1319,16 +630,16 @@ final class HydrologyFootprintCompiler { } double bankDistance = Math.max(0D, distance - shape.channelRadius()); int targetBed = Math.addExact(shape.fluidHead(), 1); - double progress = smoothStep(Math.min(1D, bankDistance / transitionWidth)); + double progress = channelGeometry.smoothStep(Math.min(1D, bankDistance / transitionWidth)); int blendedBed = (int) StrictMath.round( targetBed + (terrain.naturalHeight() - targetBed) * progress ); return Math.min(terrain.naturalHeight(), blendedBed); } - private int resolvedBed( + int resolvedBed( HydraulicSegment segment, - LayerShape shape, + FootprintLayerShape shape, HydrologyPlannerSettings.ChannelShape channelShape, HydrologyTerrainSample terrain, double distance, @@ -1352,8 +663,8 @@ final class HydrologyFootprintCompiler { (normalized - thalwegFraction) / (1D - thalwegFraction) ); int maximumDepth = Math.max(1, shape.fluidHead() - shape.bed()); - double roughness = signedOrganicNoise( - HydrologyHash.mix(segment.id(), ORGANIC_BED_VARIATION_SALT), + double roughness = channelGeometry.signedOrganicNoise( + HydrologyHash.mix(segment.id(), HydrologyChannelGeometry.ORGANIC_BED_VARIATION_SALT), worldX, worldZ, channelShape.roughnessWavelength() @@ -1379,9 +690,9 @@ final class HydrologyFootprintCompiler { return Math.min(resolved, terrain.naturalHeight()); } - private int localBed( + int localBed( HydraulicSegment segment, - LayerShape shape, + FootprintLayerShape shape, HydrologyPlannerSettings.ChannelShape channelShape, double scale, int worldX, @@ -1391,8 +702,8 @@ final class HydrologyFootprintCompiler { return shape.bed(); } int lowerExtent = shape.fluidHead() - shape.bed(); - double roughness = signedOrganicNoise( - HydrologyHash.mix(segment.id(), ORGANIC_BED_VARIATION_SALT), + double roughness = channelGeometry.signedOrganicNoise( + HydrologyHash.mix(segment.id(), HydrologyChannelGeometry.ORGANIC_BED_VARIATION_SALT), worldX, worldZ, channelShape.roughnessWavelength() @@ -1408,8 +719,8 @@ final class HydrologyFootprintCompiler { return shape.fluidHead() - localExtent; } - private int localCeiling( - LayerShape shape, + int localCeiling( + FootprintLayerShape shape, double scale, HydraulicSegment segment, HydrologyPlannerSettings.ChannelShape channelShape, @@ -1422,8 +733,8 @@ final class HydrologyFootprintCompiler { int upperExtent = shape.ceiling() - shape.fluidHead(); double extent = upperExtent * scale; if (channelShape.ceilingRoughness() > 0D) { - double roughness = signedOrganicNoise( - HydrologyHash.mix(segment.id(), ORGANIC_CEILING_VARIATION_SALT), + double roughness = channelGeometry.signedOrganicNoise( + HydrologyHash.mix(segment.id(), HydrologyChannelGeometry.ORGANIC_CEILING_VARIATION_SALT), worldX, worldZ, channelShape.roughnessWavelength() @@ -1441,7 +752,7 @@ final class HydrologyFootprintCompiler { * Layers whose ceiling follows the terrain: the underground transition of a surface river, and the * chamber of a standalone sea cave, which must never break the surface above it. */ - private boolean terrainRoofedLayer(RiverCourse course, HydraulicSegment segment) { + boolean terrainRoofedLayer(RiverCourse course, HydraulicSegment segment) { if (course.type() == RiverCourseType.SEA_CAVE) { return segment.type() == HydrologyFeatureType.COASTAL_GROTTO; } @@ -1450,226 +761,23 @@ final class HydrologyFootprintCompiler { || segment.type() == HydrologyFeatureType.UNDERGROUND_DROP); } - private double ellipsoidScale(int radius, double distance, double roundness) { - double normalized = Math.min(1D, distance / Math.max(1D, radius)); - return StrictMath.pow( - Math.max(0D, 1D - StrictMath.pow(normalized, roundness)), - 1D / roundness - ); - } - - private double shapedDistance( - LayerShape shape, - HydraulicSegment segment, - int worldX, - int worldZ, - double deltaX, - double deltaZ, - int flowX, - int flowZ, - double rawDistance - ) { - if (segment.type() == HydrologyFeatureType.DEEP_POOL) { - return deepPoolDistance(shape, segment, worldX, worldZ, deltaX, deltaZ); - } - if (segment.type().isSurface() && !shape.fallingThroat()) { - return surfaceChannelDistance(shape, segment, worldX, worldZ, deltaX, deltaZ, flowX, flowZ); - } - if (rawDistance == 0D) { - return 0D; - } - double distance = rawDistance; - if (shape.fallingThroat() && (flowX != 0 || flowZ != 0)) { - double flowLength = StrictMath.hypot(flowX, flowZ); - double along = StrictMath.abs(deltaX * flowX + deltaZ * flowZ) / flowLength; - double across = StrictMath.abs(deltaX * -flowZ + deltaZ * flowX) / flowLength; - if (along > 0.75D) { - return shape.totalRadius() + 1D; - } - distance = across; - } - if (!shape.organicBoundary()) { - return distance; - } - HydrologyPlannerSettings.ChannelShape channelShape = channelShape(segment.type()); - if (segment.type() == HydrologyFeatureType.COASTAL_GROTTO - || segment.type() == HydrologyFeatureType.INLAND_GROTTO) { - double orientation = HydrologyHash.unit(HydrologyHash.mix( - segment.courseId(), - ORGANIC_SHAPE_FIRST_PHASE_SALT - )) * StrictMath.PI * 2D; - double cosine = StrictMath.cos(orientation); - double sine = StrictMath.sin(orientation); - double rotatedX = deltaX * cosine + deltaZ * sine; - double rotatedZ = -deltaX * sine + deltaZ * cosine; - double aspect = channelShape.aspectMinimum() + HydrologyHash.unit(HydrologyHash.mix( - segment.courseId(), - ORGANIC_SHAPE_SECOND_PHASE_SALT - )) * channelShape.aspectRange(); - distance = StrictMath.hypot(rotatedX, rotatedZ / aspect); - } - double angle = StrictMath.atan2(deltaZ, deltaX); - double firstPhase = HydrologyHash.unit(HydrologyHash.mix( - segment.courseId(), - ORGANIC_SHAPE_FIRST_PHASE_SALT - )) * StrictMath.PI * 2D; - double secondPhase = HydrologyHash.unit(HydrologyHash.mix( - segment.courseId(), - ORGANIC_SHAPE_SECOND_PHASE_SALT - )) * StrictMath.PI * 2D; - double firstLobe = 0.5D + 0.5D * StrictMath.sin(angle * 3D + firstPhase); - double secondLobe = 0.5D + 0.5D * StrictMath.sin(angle * 5D + secondPhase); - double coherent = signedOrganicNoise( - segment.courseId(), - worldX, - worldZ, - channelShape.roughnessWavelength() - ); - double detail = signedOrganicNoise( - HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_SECOND_PHASE_SALT), - worldX, - worldZ, - Math.max(3, channelShape.roughnessWavelength() / 2) - ); - double radialScale = channelShape.radialBase() - + (firstLobe - 0.5D) * channelShape.primaryLobeStrength() - + (secondLobe - 0.5D) * channelShape.detailLobeStrength() - + coherent * channelShape.wallRoughness() * 0.7D - + detail * channelShape.wallRoughness() * 0.3D; - radialScale = Math.max(channelShape.radialMinimum(), Math.min(channelShape.radialMaximum(), radialScale)); - return distance / radialScale; - } - - private double surfaceChannelDistance( - LayerShape shape, - HydraulicSegment segment, - int worldX, - int worldZ, - double deltaX, - double deltaZ, - int flowX, - int flowZ - ) { - double flowLength = StrictMath.hypot(flowX, flowZ); - if (flowLength == 0D) { - return deepPoolDistance(shape, segment, worldX, worldZ, deltaX, deltaZ); - } - double signedCross = (deltaX * -flowZ + deltaZ * flowX) / flowLength; - HydrologyPlannerSettings.ChannelShape channelShape = settings.geometry().surface(); - double thalweg = signedOrganicNoise( - HydrologyHash.mix(segment.courseId(), ORGANIC_BED_VARIATION_SALT), - worldX, - worldZ, - channelShape.roughnessWavelength() - ) * shape.channelRadius() * channelShape.wallRoughness(); - long bankSeed = HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_SECOND_PHASE_SALT); - double bankNoise = signedOrganicNoise( - bankSeed, - worldX, - worldZ, - channelShape.roughnessWavelength() - ); - double sideBias = signedCross < thalweg - ? HydrologyHash.unit(HydrologyHash.mix(bankSeed, 1L)) - : HydrologyHash.unit(HydrologyHash.mix(bankSeed, 2L)); - double widthScale = 0.86D - + bankNoise * channelShape.wallRoughness() - + (sideBias - 0.5D) * 0.08D; - widthScale = Math.max(1D, Math.min(1.18D, widthScale)); - double organicDistance = StrictMath.abs(signedCross - thalweg) / widthScale; - return Math.min(StrictMath.abs(signedCross), organicDistance); - } - - private HydrologyPlannerSettings.ChannelShape channelShape(HydrologyFeatureType type) { - if (type.isGrotto() || type == HydrologyFeatureType.DEEP_POOL) { - return settings.geometry().grottos(); - } - if (type.isUnderground() || type == HydrologyFeatureType.DEEP_CHANNEL) { - return settings.geometry().underground(); - } - return settings.geometry().surface(); - } - - private double signedOrganicNoise(long seed, int x, int z, int scale) { - return organicNoise(seed, x, z, scale) * 2D - 1D; - } - - private double deepPoolDistance( - LayerShape shape, - HydraulicSegment segment, - int worldX, - int worldZ, - double deltaX, - double deltaZ - ) { - double radius = Math.max(1D, shape.channelRadius()); - long seed = HydrologyHash.mix(segment.courseId(), ORGANIC_SHAPE_FIRST_PHASE_SALT); - double orientation = HydrologyHash.unit(seed) * StrictMath.PI * 2D; - double cosine = StrictMath.cos(orientation); - double sine = StrictMath.sin(orientation); - double rotatedX = deltaX * cosine + deltaZ * sine; - double rotatedZ = -deltaX * sine + deltaZ * cosine; - double angle = StrictMath.atan2(rotatedZ, rotatedX); - double secondPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 2L)) * StrictMath.PI * 2D; - double thirdPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 3L)) * StrictMath.PI * 2D; - double fifthPhase = HydrologyHash.unit(HydrologyHash.mix(seed, 5L)) * StrictMath.PI * 2D; - double radialScale = 0.84D - + StrictMath.sin(angle * 2D + secondPhase) * 0.07D - + StrictMath.sin(angle * 3D + thirdPhase) * 0.05D - + StrictMath.sin(angle * 5D + fifthPhase) * 0.035D; - radialScale = Math.max(0.68D, Math.min(1D, radialScale)); - double normalizedDistance = StrictMath.hypot( - rotatedX / (radius * 0.92D), - rotatedZ / (radius * 0.7D) - ); - return normalizedDistance * radius / radialScale; - } - - private double organicNoise(long seed, int x, int z, int scale) { - int cellX = Math.floorDiv(x, scale); - int cellZ = Math.floorDiv(z, scale); - double localX = Math.floorMod(x, scale) / (double) scale; - double localZ = Math.floorMod(z, scale) / (double) scale; - double smoothX = localX * localX * (3D - 2D * localX); - double smoothZ = localZ * localZ * (3D - 2D * localZ); - double top = interpolate( - organicCorner(seed, cellX, cellZ), - organicCorner(seed, cellX + 1, cellZ), - smoothX - ); - double bottom = interpolate( - organicCorner(seed, cellX, cellZ + 1), - organicCorner(seed, cellX + 1, cellZ + 1), - smoothX - ); - return interpolate(top, bottom, smoothZ); - } - - private double organicCorner(long seed, int cellX, int cellZ) { - return HydrologyHash.unit(HydrologyHash.mix(seed, cellX, cellZ)); - } - - private double interpolate(double first, double second, double progress) { - return first + (second - first) * progress; - } - - private void addLayer( - Long2ObjectLinkedOpenHashMap columns, + void addLayer( + Long2ObjectLinkedOpenHashMap columns, int x, int z, HydrologyTerrainSample terrain, HydrologyColumnLayer layer ) { long packed = RiverFootprint.pack(x, z); - MutableColumn column = columns.get(packed); + FootprintMutableColumn column = columns.get(packed); if (column == null) { - column = new MutableColumn(x, z, terrain, settings.seaLevel()); + column = new FootprintMutableColumn(x, z, terrain, settings.seaLevel()); columns.put(packed, column); } column.add(layer); } - private HydrologyTerrainSample sampleTerrain(int x, int z) { + HydrologyTerrainSample sampleTerrain(int x, int z) { long packed = RiverFootprint.pack(x, z); HydrologyTerrainSample cached = terrainSamples.get(packed); if (cached != null) { @@ -1685,7 +793,7 @@ final class HydrologyFootprintCompiler { return sampled; } - private HydrologyTerrainSample sampleTerrainBasis(int x, int z) { + HydrologyTerrainSample sampleTerrainBasis(int x, int z) { if (naturalSampler == null) { return sampleTerrain(x, z); } @@ -1701,7 +809,7 @@ final class HydrologyFootprintCompiler { return sampled; } - private HydrologyRoutingTerrainSampler.NaturalClassification classifyNatural(int x, int z) { + HydrologyRoutingTerrainSampler.NaturalClassification classifyNatural(int x, int z) { if (naturalSampler == null) { return HydrologyRoutingTerrainSampler.NaturalClassification.UNAVAILABLE; } @@ -1718,14 +826,14 @@ final class HydrologyFootprintCompiler { return sampled; } - private boolean naturallySubmergedSurfaceColumn( + boolean naturallySubmergedSurfaceColumn( HydraulicSegment segment, HydrologyTerrainSample terrain ) { return segment.type().isSurface() && terrain.naturalHeight() <= settings.seaLevel(); } - private boolean oceanApronEligible(HydraulicSegment segment, double distance) { + boolean oceanApronEligible(HydraulicSegment segment, double distance) { return (segment.type() == HydrologyFeatureType.MOUTH || segment.type() == HydrologyFeatureType.COASTAL_GROTTO) && distance <= apronReach(segment) + 0.25D; @@ -1736,7 +844,7 @@ final class HydrologyFootprintCompiler { * horizontal radius, so its apron reaches at least that far: every sea column the chamber touches * must carry the apron that declares the sea face an intentional opening. */ - private int apronReach(HydraulicSegment segment) { + int apronReach(HydraulicSegment segment) { int reach = settings.outlets().maximumOceanApron(); if (segment.type() == HydrologyFeatureType.COASTAL_GROTTO) { return Math.max(reach, settings.outlets().coastalGrotto().horizontalRadius()); @@ -1748,8 +856,8 @@ final class HydrologyFootprintCompiler { * The organic chamber boundary can put a sea column one block past the apron reach while the land * column beside it is still carved; the apron follows the chamber there so the face stays open. */ - private void addAdjacentSeaApron( - Long2ObjectLinkedOpenHashMap columns, + void addAdjacentSeaApron( + Long2ObjectLinkedOpenHashMap columns, RiverCourse course, HydraulicSegment segment, HydrologyPoint point, @@ -1785,7 +893,7 @@ final class HydrologyFootprintCompiler { } } - private HydrologyFeatureRef feature( + HydrologyFeatureRef feature( RiverCourse course, HydraulicSegment segment, int x, @@ -1808,7 +916,7 @@ final class HydrologyFootprintCompiler { } int featureFlowX = Integer.compare(flowX, 0); int featureFlowZ = Integer.compare(flowZ, 0); - FeatureKey key = new FeatureKey( + FootprintFeatureKey key = new FootprintFeatureKey( course.id(), segment.id(), segment.type(), @@ -1843,7 +951,7 @@ final class HydrologyFootprintCompiler { return feature; } - private int flowDelta(List centerline, int pointIndex, boolean xAxis) { + int flowDelta(List centerline, int pointIndex, boolean xAxis) { HydrologyPoint from; HydrologyPoint to; if (centerline.size() == 1) { @@ -1859,110 +967,6 @@ final class HydrologyFootprintCompiler { return Integer.compare(xAxis ? to.x() : to.z(), xAxis ? from.x() : from.z()); } - private record LayerShape( - int channelRadius, - double shoreWidth, - double gradingWidth, - int bed, - int fluidHead, - int ceiling, - boolean ellipsoid, - boolean archedChannel, - boolean roundedSurfaceBed, - boolean organicBoundary, - boolean fallingThroat - ) { - private double totalRadius() { - return channelRadius + shoreWidth + gradingWidth; - } - } - - private record CenterlineProjection( - int pointIndex, - double x, - double z, - double distance, - int flowX, - int flowZ - ) { - } - - private record ValidationCourseRaster( - long courseId, - List columns, - SurfaceFootprint surface - ) { - } - - private record FeatureKey( - long courseId, - long segmentId, - HydrologyFeatureType type, - int role, - int flowX, - int flowZ - ) { - } - - private record RasterStencilKey( - int channelRadius, - double shoreWidth, - double gradingWidth - ) { - } - - private record CourseRasterKey( - long courseId, - RiverCourseType courseType, - String profileKey, - List segments - ) { - } - - private record RasterStencil( - int[] deltaXs, - int[] deltaZs, - double[] distances - ) { - private int size() { - return deltaXs.length; - } - } - - private static final class RasterStencilBuilder { - private int[] deltaXs; - private int[] deltaZs; - private double[] distances; - private int size; - - private RasterStencilBuilder() { - this.deltaXs = new int[64]; - this.deltaZs = new int[64]; - this.distances = new double[64]; - } - - private void add(int deltaX, int deltaZ, double distance) { - if (size == deltaXs.length) { - int expandedSize = Math.multiplyExact(size, 2); - deltaXs = Arrays.copyOf(deltaXs, expandedSize); - deltaZs = Arrays.copyOf(deltaZs, expandedSize); - distances = Arrays.copyOf(distances, expandedSize); - } - deltaXs[size] = deltaX; - deltaZs[size] = deltaZ; - distances[size] = distance; - size++; - } - - private RasterStencil build() { - return new RasterStencil( - Arrays.copyOf(deltaXs, size), - Arrays.copyOf(deltaZs, size), - Arrays.copyOf(distances, size) - ); - } - } - record Sampling( HydrologyTerrainSampler sampler, HydrologyGeometrySampler geometrySampler, @@ -1975,7 +979,7 @@ final class HydrologyFootprintCompiler { } final class ValidationRaster { - private final List courseRasters; + private final List courseRasters; private final Long2ObjectOpenHashMap> columnsByCourse; private final SurfaceRasterIndex surfaceRaster; private final RiverFootprint materializedSurface; @@ -1983,14 +987,14 @@ final class HydrologyFootprintCompiler { private List mergedColumns; private ValidationRaster( - List courseRasters, + List courseRasters, SurfaceRasterIndex surfaceRaster ) { this(courseRasters, surfaceRaster, null); } private ValidationRaster( - List courseRasters, + List courseRasters, SurfaceRasterIndex surfaceRaster, RiverFootprint materializedSurface ) { @@ -1999,7 +1003,7 @@ final class HydrologyFootprintCompiler { this.materializedSurface = materializedSurface; this.columnsByCourse = new Long2ObjectOpenHashMap<>(courseRasters.size()); int references = 0; - for (ValidationCourseRaster raster : courseRasters) { + for (FootprintValidationCourseRaster raster : courseRasters) { if (columnsByCourse.put(raster.courseId(), raster.columns()) != null) { throw new IllegalStateException("Duplicate hydrology validation course " + raster.courseId()); } @@ -2018,13 +1022,13 @@ final class HydrologyFootprintCompiler { if (cached != null) { return cached; } - Long2ObjectLinkedOpenHashMap merged = new Long2ObjectLinkedOpenHashMap<>(); - for (ValidationCourseRaster raster : courseRasters) { + Long2ObjectLinkedOpenHashMap merged = new Long2ObjectLinkedOpenHashMap<>(); + for (FootprintValidationCourseRaster raster : courseRasters) { for (HydrologyColumnSample sample : raster.columns()) { long packed = RiverFootprint.pack(sample.x(), sample.z()); - MutableColumn column = merged.get(packed); + FootprintMutableColumn column = merged.get(packed); if (column == null) { - merged.put(packed, new MutableColumn(sample)); + merged.put(packed, new FootprintMutableColumn(sample)); } else { column.merge(sample); } @@ -2100,7 +1104,7 @@ final class HydrologyFootprintCompiler { } } - private final class SurfaceRasterIndex implements HydrologyCaveVoxelViewFactory.PlannedSurface { + final class SurfaceRasterIndex implements HydrologyCaveVoxelViewFactory.PlannedSurface { private final Long2ObjectOpenHashMap surfaceColumns; private final Long2IntOpenHashMap validationNaturalHeights; @@ -2108,14 +1112,14 @@ final class HydrologyFootprintCompiler { List footprints, Long2ObjectOpenHashMap validationSamples ) { - Long2ObjectLinkedOpenHashMap merged = new Long2ObjectLinkedOpenHashMap<>(); + Long2ObjectLinkedOpenHashMap merged = new Long2ObjectLinkedOpenHashMap<>(); for (SurfaceFootprint footprint : footprints) { for (SurfaceLayerColumn column : footprint.columns()) { addLayer(merged, column.x(), column.z(), column.terrain(), column.layer()); } } this.surfaceColumns = new Long2ObjectOpenHashMap<>(merged.size()); - for (Long2ObjectMap.Entry entry : merged.long2ObjectEntrySet()) { + for (Long2ObjectMap.Entry entry : merged.long2ObjectEntrySet()) { surfaceColumns.put(entry.getLongKey(), entry.getValue().build()); } this.validationNaturalHeights = new Long2IntOpenHashMap(validationSamples.size()); @@ -2165,171 +1169,4 @@ final class HydrologyFootprintCompiler { return false; } } - - private static final class MutableColumn { - private final int x; - private final int z; - private final int naturalHeight; - private final int seaLevel; - private final boolean ocean; - private final String parentBiomeKey; - private HydrologyColumnLayer singleLayer; - private LinkedHashMap layers; - - private MutableColumn(int x, int z, HydrologyTerrainSample terrain, int seaLevel) { - this.x = x; - this.z = z; - this.naturalHeight = terrain.naturalHeight(); - this.seaLevel = seaLevel; - this.ocean = terrain.ocean(); - this.parentBiomeKey = terrain.parentBiomeKey(); - } - - private MutableColumn(HydrologyColumnSample sample) { - this.x = sample.x(); - this.z = sample.z(); - this.naturalHeight = sample.naturalHeight(); - this.seaLevel = sample.seaLevel(); - this.ocean = sample.ocean(); - this.parentBiomeKey = sample.parentBiomeKey(); - for (HydrologyColumnLayer layer : sample.layers()) { - add(layer); - } - } - - private void add(HydrologyColumnLayer layer) { - if (layers == null) { - if (singleLayer == null) { - singleLayer = layer; - return; - } - if (singleLayer.feature().id() == layer.feature().id()) { - singleLayer = merge(singleLayer, layer); - return; - } - layers = new LinkedHashMap<>(); - layers.put(singleLayer.feature().id(), singleLayer); - singleLayer = null; - } - HydrologyColumnLayer existing = layers.get(layer.feature().id()); - layers.put(layer.feature().id(), existing == null ? layer : merge(existing, layer)); - } - - private HydrologyColumnSample build() { - List builtLayers; - if (layers != null) { - builtLayers = resolveSurfaceHeadConflicts(new ArrayList<>(layers.values())); - } else if (singleLayer != null) { - builtLayers = List.of(singleLayer); - } else { - builtLayers = List.of(); - } - return new HydrologyColumnSample( - x, - z, - naturalHeight, - seaLevel, - ocean, - parentBiomeKey, - builtLayers - ); - } - - private List resolveSurfaceHeadConflicts(List candidates) { - HashMap selectedByCourse = new HashMap<>(); - for (HydrologyColumnLayer candidate : candidates) { - if (!conflictingSurfaceCandidate(candidate)) { - continue; - } - long courseId = candidate.feature().courseId(); - HydrologyColumnLayer selected = selectedByCourse.get(courseId); - if (selected == null || prefersSurfaceLayer(candidate, selected)) { - selectedByCourse.put(courseId, candidate); - } - } - if (selectedByCourse.isEmpty()) { - return candidates; - } - ArrayList resolved = new ArrayList<>(candidates.size()); - for (HydrologyColumnLayer candidate : candidates) { - HydrologyColumnLayer selected = selectedByCourse.get(candidate.feature().courseId()); - if (!conflictingSurfaceCandidate(candidate) - || selected == null - || candidate.fluidHeadY() == selected.fluidHeadY()) { - resolved.add(candidate); - } - } - return List.copyOf(resolved); - } - - private boolean conflictingSurfaceCandidate(HydrologyColumnLayer layer) { - return layer.feature().type().isSurface() - && layer.channel() - && layer.connectedFluid() - && layer.fluidOwned() - && !layer.fallingFluid(); - } - - private boolean prefersSurfaceLayer(HydrologyColumnLayer candidate, HydrologyColumnLayer selected) { - if (candidate.receivingPool() != selected.receivingPool()) { - return candidate.receivingPool(); - } - if (candidate.fluidHeadY() != selected.fluidHeadY()) { - return candidate.fluidHeadY() > selected.fluidHeadY(); - } - return candidate.feature().id() < selected.feature().id(); - } - - private void merge(HydrologyColumnSample sample) { - if (sample.x() != x - || sample.z() != z - || sample.naturalHeight() != naturalHeight - || sample.seaLevel() != seaLevel - || sample.ocean() != ocean - || !sample.parentBiomeKey().equals(parentBiomeKey)) { - throw new IllegalStateException("Hydrology course footprints disagree on terrain metadata at " - + x + "," + z + "."); - } - for (HydrologyColumnLayer layer : sample.layers()) { - add(layer); - } - } - - private HydrologyColumnLayer merge(HydrologyColumnLayer first, HydrologyColumnLayer second) { - if (first.equals(second)) { - return first; - } - HydrologyFeatureRef feature = first.feature().y() <= second.feature().y() - ? first.feature() - : second.feature(); - boolean drySurfaceBlend = first.feature().type().isSurface() - && second.feature().type().isSurface() - && !first.channel() - && !second.channel(); - int bedY = drySurfaceBlend - ? Math.max(first.bedY(), second.bedY()) - : Math.min(first.bedY(), second.bedY()); - return new HydrologyColumnLayer( - feature, - bedY, - Math.max(first.fluidHeadY(), second.fluidHeadY()), - Math.max(first.ceilingY(), second.ceilingY()), - first.channel() || second.channel(), - first.shore() || second.shore(), - first.grading() || second.grading(), - first.connectedFluid() || second.connectedFluid(), - first.fallingFluid() || second.fallingFluid(), - first.receivingPool() || second.receivingPool(), - first.terrainOwned() || second.terrainOwned(), - first.fluidOwned() || second.fluidOwned(), - first.oceanApron() || second.oceanApron(), - first.profileKey(), - first.surfaceBiomeKey(), - first.mouthBiomeKey(), - first.shoreBiomeKey(), - first.bankBiomeKey(), - first.floodedCaveBiomeKey() - ); - } - } } diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintRasterizer.java b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintRasterizer.java new file mode 100644 index 000000000..9b82a251f --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/HydrologyFootprintRasterizer.java @@ -0,0 +1,565 @@ +package art.arcane.iris.engine.hydrology; + +import it.unimi.dsi.fastutil.longs.Long2ObjectLinkedOpenHashMap; + +import java.util.ArrayList; +import java.util.List; + +final class HydrologyFootprintRasterizer { + private final HydrologyFootprintCompiler compiler; + + HydrologyFootprintRasterizer(HydrologyFootprintCompiler compiler) { + this.compiler = compiler; + } + + void rasterizeSegment( + Long2ObjectLinkedOpenHashMap columns, + RiverCourse course, + HydraulicSegment segment, + boolean firstSegment, + boolean clipStart, + boolean clipEnd, + boolean validationOnly, + HydrologyFootprintCompiler.SurfaceRasterIndex plannedSurface + ) { + List centerline = continuousCenterline(segment); + if (segment.fallingFluid() && centerline.size() > 1) { + HydrologyPoint throat = centerline.getFirst(); + int fluidHead = segment.upstreamHeadY(); + FootprintLayerShape throatShape = compiler.channelGeometry.shape( + course, + segment, + throat, + segment.downstreamHeadY() - 1, + fluidHead, + true, + false + ); + rasterizePoint( + columns, + course, + segment, + throat, + 0, + throatShape, + compiler.flowDelta(centerline, 0, true), + compiler.flowDelta(centerline, 0, false), + firstSegment, + true, + false, + false, + validationOnly, + plannedSurface + ); + rasterizeSweptSegment( + columns, + course, + segment, + List.copyOf(centerline.subList(1, centerline.size())), + false, + true, + clipEnd, + validationOnly, + plannedSurface + ); + return; + } + if (sweptChannel(segment, centerline)) { + rasterizeSweptSegment( + columns, + course, + segment, + centerline, + firstSegment, + clipStart, + clipEnd, + validationOnly, + plannedSurface + ); + return; + } + for (int pointIndex = 0; pointIndex < centerline.size(); pointIndex++) { + HydrologyPoint point = centerline.get(pointIndex); + boolean oceanConnection = (segment.type() == HydrologyFeatureType.MOUTH + || segment.type() == HydrologyFeatureType.COASTAL_GROTTO) + && pointIndex == centerline.size() - 1; + boolean falling = segment.fallingFluid() && pointIndex == 0; + boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; + int fluidHead = falling ? segment.upstreamHeadY() : point.y(); + int bed = falling + ? segment.downstreamHeadY() - 1 + : fluidHead - segment.depth(); + FootprintLayerShape shape = compiler.channelGeometry.shape(course, segment, point, bed, fluidHead, falling, receiving); + int flowX = compiler.flowDelta(centerline, pointIndex, true); + int flowZ = compiler.flowDelta(centerline, pointIndex, false); + rasterizePoint( + columns, + course, + segment, + point, + pointIndex, + shape, + flowX, + flowZ, + firstSegment && pointIndex == 0, + falling, + receiving, + oceanConnection, + validationOnly, + plannedSurface + ); + } + } + + boolean sweptChannel( + HydraulicSegment segment, + List centerline + ) { + if (centerline.size() < 2 || segment.fallingFluid()) { + return false; + } + return segment.type().isSurface() + || segment.type() == HydrologyFeatureType.UNDERGROUND_POOL + || segment.type() == HydrologyFeatureType.UNDERGROUND_DROP + || segment.type() == HydrologyFeatureType.SINKHOLE + || segment.type() == HydrologyFeatureType.DEEP_CHANNEL; + } + + void rasterizeSweptSegment( + Long2ObjectLinkedOpenHashMap columns, + RiverCourse course, + HydraulicSegment segment, + List centerline, + boolean firstSegment, + boolean clipStart, + boolean clipEnd, + boolean validationOnly, + HydrologyFootprintCompiler.SurfaceRasterIndex plannedSurface + ) { + FootprintLayerShape[] shapes = new FootprintLayerShape[centerline.size()]; + int maximumRadius = 1; + int minimumX = Integer.MAX_VALUE; + int maximumX = Integer.MIN_VALUE; + int minimumZ = Integer.MAX_VALUE; + int maximumZ = Integer.MIN_VALUE; + for (int pointIndex = 0; pointIndex < centerline.size(); pointIndex++) { + HydrologyPoint point = centerline.get(pointIndex); + int fluidHead = point.y(); + boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; + FootprintLayerShape shape = compiler.channelGeometry.shape( + course, + segment, + point, + fluidHead - segment.depth(), + fluidHead, + false, + receiving + ); + shapes[pointIndex] = shape; + int rasterRadius = segment.type().isSurface() + ? (int) StrictMath.ceil(shape.totalRadius()) + : shape.channelRadius(); + maximumRadius = Math.max(maximumRadius, rasterRadius); + minimumX = Math.min(minimumX, point.x()); + maximumX = Math.max(maximumX, point.x()); + minimumZ = Math.min(minimumZ, point.z()); + maximumZ = Math.max(maximumZ, point.z()); + } + minimumX = Math.subtractExact(minimumX, maximumRadius); + maximumX = Math.addExact(maximumX, maximumRadius); + minimumZ = Math.subtractExact(minimumZ, maximumRadius); + maximumZ = Math.addExact(maximumZ, maximumRadius); + HydrologyFeatureRef[][] pointFeatures = new HydrologyFeatureRef[centerline.size()][HydrologyFootprintCompiler.FEATURE_ROLE_COUNT]; + for (int z = minimumZ; z <= maximumZ; z++) { + for (int x = minimumX; x <= maximumX; x++) { + if (!withinLongitudinalBounds(centerline, x, z, clipStart, clipEnd)) { + continue; + } + FootprintCenterlineProjection projection = projectCenterline(centerline, x, z); + int pointIndex = projection.pointIndex(); + HydrologyPoint point = centerline.get(pointIndex); + boolean receiving = segment.receivingPool() && pointIndex == centerline.size() - 1; + FootprintLayerShape shape = shapes[pointIndex]; + int deltaX = x - point.x(); + int deltaZ = z - point.z(); + double rawDistance = projection.distance(); + double rasterRadius = segment.type().isSurface() + ? shape.totalRadius() + : shape.channelRadius(); + if (rawDistance > rasterRadius + 0.25D) { + continue; + } + int flowX = projection.flowX(); + int flowZ = projection.flowZ(); + double channelDistance = compiler.channelGeometry.shapedDistance( + shape, + segment, + x, + z, + x - projection.x(), + z - projection.z(), + flowX, + flowZ, + rawDistance + ); + boolean channel = channelDistance <= shape.channelRadius() + 0.25D; + if (!segment.type().isSurface() && !channel) { + continue; + } + boolean shore = !channel + && channelDistance <= shape.channelRadius() + shape.shoreWidth() + 0.25D; + boolean grading = !channel && !shore && rawDistance <= shape.totalRadius() + 0.25D; + if (!channel && !shore && !grading) { + continue; + } + double distance = grading ? rawDistance : channelDistance; + HydrologyRoutingTerrainSampler.NaturalClassification classification = compiler.classifyNatural(x, z); + boolean oceanConnection = (segment.type() == HydrologyFeatureType.MOUTH + || segment.type() == HydrologyFeatureType.COASTAL_GROTTO) + && pointIndex == centerline.size() - 1; + boolean apronEligible = compiler.oceanApronEligible(segment, distance); + if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + && !apronEligible) { + continue; + } + if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.LAND + && oceanConnection) { + continue; + } + boolean exactSlope = classification != HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + && !oceanConnection + && !channel + && segment.type() != HydrologyFeatureType.WATERFALL + && segment.type() != HydrologyFeatureType.CASCADE; + HydrologyTerrainSample terrain = exactSlope ? compiler.sampleTerrain(x, z) : compiler.sampleTerrainBasis(x, z); + if (terrain == null) { + continue; + } + boolean naturalOcean = classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + || terrain.ocean() + || compiler.naturallySubmergedSurfaceColumn(segment, terrain); + if (oceanConnection || naturalOcean) { + if (naturalOcean && apronEligible) { + compiler.addOceanApron(columns, course, segment, point, x, z, distance, flowX, flowZ, + terrain, pointFeatures[pointIndex]); + } + continue; + } + boolean source = firstSegment && pointIndex == 0; + if (validationOnly && segment.type().isSurface()) { + compiler.feature(course, segment, x, shape.fluidHead(), z, flowX, flowZ, + source && deltaX == 0 && deltaZ == 0, channel, shore, grading, + false, false, pointFeatures[pointIndex]); + continue; + } + HydrologyColumnLayer layer = compiler.regularLayer( + course, + segment, + point, + shape, + terrain, + distance, + deltaX, + deltaZ, + flowX, + flowZ, + source, + channel, + shore, + grading, + false, + receiving, + pointFeatures[pointIndex] + ); + layer = compiler.terrainContainedCaveLayer(course, segment, terrain, layer, x, z, plannedSurface); + if (layer == null) { + continue; + } + compiler.addLayer(columns, x, z, terrain, layer); + } + } + } + + FootprintCenterlineProjection projectCenterline(List centerline, int x, int z) { + if (centerline.size() == 1) { + HydrologyPoint point = centerline.getFirst(); + return new FootprintCenterlineProjection( + 0, + point.x(), + point.z(), + StrictMath.hypot(x - point.x(), z - point.z()), + 1, + 0 + ); + } + int selectedPoint = 0; + double selectedX = centerline.getFirst().x(); + double selectedZ = centerline.getFirst().z(); + double selectedDistanceSquared = Double.POSITIVE_INFINITY; + int selectedFlowX = 1; + int selectedFlowZ = 0; + for (int segmentIndex = 0; segmentIndex < centerline.size() - 1; segmentIndex++) { + HydrologyPoint start = centerline.get(segmentIndex); + HydrologyPoint end = centerline.get(segmentIndex + 1); + double flowX = end.x() - start.x(); + double flowZ = end.z() - start.z(); + double lengthSquared = flowX * flowX + flowZ * flowZ; + if (lengthSquared == 0D) { + continue; + } + double progress = ((x - start.x()) * flowX + (z - start.z()) * flowZ) / lengthSquared; + progress = Math.max(0D, Math.min(1D, progress)); + double projectedX = start.x() + flowX * progress; + double projectedZ = start.z() + flowZ * progress; + double deltaX = x - projectedX; + double deltaZ = z - projectedZ; + double distanceSquared = deltaX * deltaX + deltaZ * deltaZ; + if (distanceSquared >= selectedDistanceSquared) { + continue; + } + selectedDistanceSquared = distanceSquared; + selectedX = projectedX; + selectedZ = projectedZ; + selectedPoint = progress < 0.5D ? segmentIndex : segmentIndex + 1; + selectedFlowX = end.x() - start.x(); + selectedFlowZ = end.z() - start.z(); + } + int tangentReach = Math.max(2, compiler.settings.routing().refinementSpacing() * 2); + HydrologyPoint tangentStart = centerline.get(Math.max(0, selectedPoint - tangentReach)); + HydrologyPoint tangentEnd = centerline.get(Math.min(centerline.size() - 1, selectedPoint + tangentReach)); + int tangentX = tangentEnd.x() - tangentStart.x(); + int tangentZ = tangentEnd.z() - tangentStart.z(); + if (tangentX != 0 || tangentZ != 0) { + selectedFlowX = tangentX; + selectedFlowZ = tangentZ; + } + return new FootprintCenterlineProjection( + selectedPoint, + selectedX, + selectedZ, + StrictMath.sqrt(selectedDistanceSquared), + selectedFlowX, + selectedFlowZ + ); + } + + boolean withinLongitudinalBounds( + List centerline, + int x, + int z, + boolean clipStart, + boolean clipEnd + ) { + if (centerline.size() < 2) { + return true; + } + HydrologyPoint start = centerline.getFirst(); + HydrologyPoint afterStart = centerline.get(1); + long startDot = (long) (x - start.x()) * (afterStart.x() - start.x()) + + (long) (z - start.z()) * (afterStart.z() - start.z()); + if (clipStart && startDot < 0L) { + return false; + } + if (!clipEnd) { + return true; + } + HydrologyPoint end = centerline.getLast(); + HydrologyPoint beforeEnd = centerline.get(centerline.size() - 2); + long endDot = (long) (x - end.x()) * (end.x() - beforeEnd.x()) + + (long) (z - end.z()) * (end.z() - beforeEnd.z()); + return endDot <= 0L; + } + + boolean segmentsJoin(HydraulicSegment upstream, HydraulicSegment downstream) { + HydrologyPoint upstreamEnd = upstream.centerline().getLast(); + HydrologyPoint downstreamStart = downstream.centerline().getFirst(); + return upstreamEnd.x() == downstreamStart.x() + && upstreamEnd.y() == downstreamStart.y() + && upstreamEnd.z() == downstreamStart.z(); + } + + List continuousCenterline(HydraulicSegment segment) { + List configured = segment.centerline(); + if (configured.size() == 1) { + return configured; + } + ArrayList continuous = new ArrayList<>(); + for (int pairIndex = 0; pairIndex < configured.size() - 1; pairIndex++) { + HydrologyPoint start = configured.get(pairIndex); + HydrologyPoint end = configured.get(pairIndex + 1); + int steps = Math.max(Math.abs(end.x() - start.x()), Math.abs(end.z() - start.z())); + if (steps == 0) { + if (continuous.isEmpty()) { + continuous.add(start); + } + continue; + } + int firstStep = continuous.isEmpty() ? 0 : 1; + for (int step = firstStep; step <= steps; step++) { + double progress = step / (double) steps; + int x = (int) StrictMath.round(start.x() + (end.x() - start.x()) * progress); + int z = (int) StrictMath.round(start.z() + (end.z() - start.z()) * progress); + int y = segment.fallingFluid() && !continuous.isEmpty() + ? segment.downstreamHeadY() + : (int) StrictMath.round(start.y() + (end.y() - start.y()) * progress); + HydrologyPoint previous = continuous.isEmpty() ? null : continuous.getLast(); + if (previous == null || previous.x() != x || previous.z() != z) { + continuous.add(new HydrologyPoint(x, y, z)); + } + } + } + return List.copyOf(continuous); + } + + void rasterizePoint( + Long2ObjectLinkedOpenHashMap columns, + RiverCourse course, + HydraulicSegment segment, + HydrologyPoint point, + int pointIndex, + FootprintLayerShape shape, + int flowX, + int flowZ, + boolean source, + boolean falling, + boolean receiving, + boolean oceanConnection, + boolean validationOnly, + HydrologyFootprintCompiler.SurfaceRasterIndex plannedSurface + ) { + FootprintRasterStencil stencil = compiler.rasterStencil(shape); + HydrologyFeatureRef[] pointFeatures = new HydrologyFeatureRef[HydrologyFootprintCompiler.FEATURE_ROLE_COUNT]; + boolean underground = segment.type().isUnderground() || segment.type().isDeepFluid(); + for (int offsetIndex = 0; offsetIndex < stencil.size(); offsetIndex++) { + int deltaX = stencil.deltaXs()[offsetIndex]; + int deltaZ = stencil.deltaZs()[offsetIndex]; + int x = point.x() + deltaX; + int z = point.z() + deltaZ; + double channelDistance = compiler.channelGeometry.shapedDistance( + shape, + segment, + x, + z, + deltaX, + deltaZ, + flowX, + flowZ, + stencil.distances()[offsetIndex] + ); + boolean channel = channelDistance <= shape.channelRadius() + 0.25D; + if (underground && !channel) { + continue; + } + boolean shore = !channel + && stencil.distances()[offsetIndex] <= shape.channelRadius() + shape.shoreWidth() + 0.25D; + boolean grading = !channel + && !shore + && stencil.distances()[offsetIndex] <= shape.totalRadius() + 0.25D; + double distance = grading ? stencil.distances()[offsetIndex] : channelDistance; + HydrologyRoutingTerrainSampler.NaturalClassification classification = compiler.classifyNatural(x, z); + boolean apronEligible = compiler.oceanApronEligible(segment, distance); + if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + && !apronEligible) { + continue; + } + if (classification == HydrologyRoutingTerrainSampler.NaturalClassification.LAND + && oceanConnection) { + continue; + } + boolean exactSlope = classification != HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + && !oceanConnection + && !channel + && segment.type() != HydrologyFeatureType.WATERFALL + && segment.type() != HydrologyFeatureType.CASCADE; + HydrologyTerrainSample terrain = exactSlope + ? compiler.sampleTerrain(x, z) + : compiler.sampleTerrainBasis(x, z); + if (terrain == null) { + continue; + } + boolean naturalOcean = classification == HydrologyRoutingTerrainSampler.NaturalClassification.OCEAN + || terrain.ocean() + || compiler.naturallySubmergedSurfaceColumn(segment, terrain); + if (oceanConnection) { + if (naturalOcean) { + compiler.addOceanApron( + columns, + course, + segment, + point, + x, + z, + distance, + flowX, + flowZ, + terrain, + pointFeatures + ); + } + continue; + } + if (naturalOcean) { + compiler.addOceanApron( + columns, + course, + segment, + point, + x, + z, + distance, + flowX, + flowZ, + terrain, + pointFeatures + ); + continue; + } + if (validationOnly && !underground) { + compiler.feature( + course, + segment, + x, + shape.fluidHead(), + z, + flowX, + flowZ, + source && deltaX == 0 && deltaZ == 0, + channel, + shore, + grading, + channel && falling, + channel && receiving, + pointFeatures + ); + continue; + } + HydrologyColumnLayer layer = compiler.regularLayer( + course, + segment, + point, + shape, + terrain, + distance, + deltaX, + deltaZ, + flowX, + flowZ, + source, + channel, + shore, + grading, + falling, + receiving, + pointFeatures + ); + layer = compiler.terrainContainedCaveLayer(course, segment, terrain, layer, x, z, plannedSurface); + if (layer == null) { + continue; + } + compiler.addLayer(columns, x, z, terrain, layer); + if (segment.type() == HydrologyFeatureType.COASTAL_GROTTO) { + compiler.addAdjacentSeaApron(columns, course, segment, point, x, z, flowX, flowZ, pointFeatures); + } + } + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java index 8a9751a36..53fd811b6 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/SourceSelection.java @@ -9,13 +9,13 @@ final class SourceSelection { final boolean surface; final List candidates; final SourceAdmissionSelection admission; - final int guaranteedMinimum; + private final int guaranteedMinimum; final int maximumOptionalRejections; final int targetCount; final ArrayList selectedCandidateIndices; final boolean[] selectedCandidates; - final boolean[] attemptedCandidates; - int rejectedOptionalCandidates; + private final boolean[] attemptedCandidates; + private int rejectedOptionalCandidates; SourceSelection( boolean surface, @@ -130,7 +130,7 @@ final class SourceSelection { return changed; } - Set acceptedSourceNodeIds(List acceptedCourses) { + private Set acceptedSourceNodeIds(List acceptedCourses) { RiverCourseType expectedType = surface ? RiverCourseType.SURFACE : RiverCourseType.UNDERGROUND; HashSet accepted = new HashSet<>(); for (RiverCourse course : acceptedCourses) { @@ -141,7 +141,7 @@ final class SourceSelection { return accepted; } - int nextRequiredCandidate() { + private int nextRequiredCandidate() { for (int candidateIndex = 0; candidateIndex < candidates.size(); candidateIndex++) { SourceCandidate candidate = candidates.get(candidateIndex); if (candidate.required() @@ -154,7 +154,7 @@ final class SourceSelection { return -1; } - int nextAdmittedCandidate() { + private int nextAdmittedCandidate() { if (rejectedOptionalCandidates >= maximumOptionalRejections) { return -1; } diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveBoundaryResult.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveBoundaryResult.java new file mode 100644 index 000000000..8cc36cf57 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveBoundaryResult.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.Set; + +record CaveBoundaryResult(Set sealGuards, HydrologyCaveRejection rejection) { + static CaveBoundaryResult accepted(Set sealGuards) { + return new CaveBoundaryResult( + Collections.unmodifiableSet(new LinkedHashSet<>(sealGuards)), + HydrologyCaveRejection.NONE + ); + } + + static CaveBoundaryResult rejected(HydrologyCaveRejection rejection) { + return new CaveBoundaryResult(Set.of(), rejection); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveCachedValidation.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveCachedValidation.java new file mode 100644 index 000000000..fe39b1d37 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveCachedValidation.java @@ -0,0 +1,14 @@ +package art.arcane.iris.engine.hydrology.cave; + +record CaveCachedValidation( + HydrologyCavePlan plan, + CaveViewObservations viewObservations, + CaveSurfaceObservations surfaceObservations +) { + long retainedPositions() { + return Math.max(1L, (long) plan.actions().size() + + plan.baselinePreconditions().size() + + viewObservations.size() + + surfaceObservations.observations().size()); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveClaimGroup.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveClaimGroup.java new file mode 100644 index 000000000..e0b30f82d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveClaimGroup.java @@ -0,0 +1,9 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.Map; + +record CaveClaimGroup( + HydrologyCaveCandidate candidate, + Map actions +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveComponentResult.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveComponentResult.java new file mode 100644 index 000000000..2f566d433 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveComponentResult.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.Set; + +record CaveComponentResult(Set positions, HydrologyCaveRejection rejection) { + static CaveComponentResult accepted(Set positions) { + return new CaveComponentResult( + Collections.unmodifiableSet(new LinkedHashSet<>(positions)), + HydrologyCaveRejection.NONE + ); + } + + static CaveComponentResult rejected(HydrologyCaveRejection rejection) { + return new CaveComponentResult(Set.of(), rejection); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveGrottoResult.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveGrottoResult.java new file mode 100644 index 000000000..0ff858204 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveGrottoResult.java @@ -0,0 +1,18 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.Collections; +import java.util.LinkedHashSet; +import java.util.Set; + +record CaveGrottoResult(Set positions, HydrologyCaveRejection rejection) { + static CaveGrottoResult accepted(Set positions) { + return new CaveGrottoResult( + Collections.unmodifiableSet(new LinkedHashSet<>(positions)), + HydrologyCaveRejection.NONE + ); + } + + static CaveGrottoResult rejected(HydrologyCaveRejection rejection) { + return new CaveGrottoResult(Set.of(), rejection); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveIndependentDecision.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveIndependentDecision.java new file mode 100644 index 000000000..8558aa951 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveIndependentDecision.java @@ -0,0 +1,16 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.List; + +record CaveIndependentDecision( + HydrologyCaveRejection rejection, + List guards +) { + private static CaveIndependentDecision accepted(List guards) { + return new CaveIndependentDecision(HydrologyCaveRejection.NONE, List.copyOf(guards)); + } + + private static CaveIndependentDecision rejected(HydrologyCaveRejection rejection) { + return new CaveIndependentDecision(rejection, List.of()); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CavePathResult.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CavePathResult.java new file mode 100644 index 000000000..77148114d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CavePathResult.java @@ -0,0 +1,13 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.List; + +record CavePathResult(List positions, HydrologyCaveRejection rejection) { + static CavePathResult accepted(List positions) { + return new CavePathResult(List.copyOf(positions), HydrologyCaveRejection.NONE); + } + + static CavePathResult rejected(HydrologyCaveRejection rejection) { + return new CavePathResult(List.of(), rejection); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveSurfaceObservations.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveSurfaceObservations.java new file mode 100644 index 000000000..cde81b26d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveSurfaceObservations.java @@ -0,0 +1,40 @@ +package art.arcane.iris.engine.hydrology.cave; + +import art.arcane.iris.engine.hydrology.HydrologyObservedPlannedSurface; + +import java.util.ArrayList; +import java.util.List; + +record CaveSurfaceObservations( + List observations +) { + static CaveSurfaceObservations empty() { + return new CaveSurfaceObservations(List.of()); + } + + static CaveSurfaceObservations capture( + CaveViewObservations viewObservations, + HydrologyObservedPlannedSurface plannedSurface + ) { + ArrayList observations = new ArrayList<>(); + for (int index = 0; index < viewObservations.size(); index++) { + CavePosition position = viewObservations.positions()[index]; + observations.addAll(plannedSurface.observationsAt(position.x(), position.z())); + } + return new CaveSurfaceObservations(List.copyOf(observations)); + } + + boolean matches(HydrologyObservedPlannedSurface plannedSurface) { + for (HydrologyObservedPlannedSurface.Observation observation : observations) { + int resolvedHeight = plannedSurface.resolve( + observation.x(), + observation.z(), + observation.naturalHeight() + ); + if (resolvedHeight != observation.resolvedHeight()) { + return false; + } + } + return true; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveValidationBatch.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveValidationBatch.java new file mode 100644 index 000000000..5d3813bda --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveValidationBatch.java @@ -0,0 +1,11 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.List; +import java.util.Map; + +record CaveValidationBatch( + List plans, + Map actions, + Map baselinePreconditions +) { +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveViewObservations.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveViewObservations.java new file mode 100644 index 000000000..116c71b13 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/CaveViewObservations.java @@ -0,0 +1,30 @@ +package art.arcane.iris.engine.hydrology.cave; + +record CaveViewObservations( + CavePosition[] positions, + byte[] operations, + byte[] values, + int size +) { + static CaveViewObservations empty() { + return new CaveViewObservations(new CavePosition[0], new byte[0], new byte[0], 0); + } + + boolean matches(CaveVoxelView view) { + for (int index = 0; index < size; index++) { + CavePosition position = positions[index]; + int actual = switch (operations[index]) { + case RecordingCaveVoxelView.IN_WORLD -> view.isInWorld(position) ? 1 : 0; + case RecordingCaveVoxelView.VOXEL -> view.voxelAt(position).ordinal(); + case RecordingCaveVoxelView.OPEN_TO_SURFACE -> view.isOpenToSurface(position) ? 1 : 0; + case RecordingCaveVoxelView.ABOVE_TERRAIN_SURFACE -> + view.isAboveTerrainSurface(position) ? 1 : 0; + default -> throw new IllegalStateException("Unknown cave view operation."); + }; + if (actual != Byte.toUnsignedInt(values[index])) { + return false; + } + } + return true; + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveChamberPlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveChamberPlanner.java new file mode 100644 index 000000000..5eb7eb854 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveChamberPlanner.java @@ -0,0 +1,809 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Collection; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Queue; +import java.util.Set; + +final class HydrologyCaveChamberPlanner { + private final HydrologyCaveContainmentPlanner planner; + + HydrologyCaveChamberPlanner(HydrologyCaveContainmentPlanner planner) { + this.planner = planner; + } + + HydrologyCavePlan planGrottoOrClosedComponent( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + CaveVoxel targetVoxel = planner.voxelAt(view, source.target()); + if (planner.isFluidReachable(targetVoxel, settings)) { + return planClosedComponent(view, source, settings, throat); + } + if (targetVoxel == CaveVoxel.LAVA) { + return planner.rejected(source, HydrologyCaveRejection.LAVA_CONTACT); + } + if (targetVoxel == CaveVoxel.INCOMPATIBLE_FLUID) { + return planner.rejected(source, HydrologyCaveRejection.INCOMPATIBLE_FLUID); + } + return planGeneratedGrotto(view, source, settings, throat); + } + + HydrologyCavePlan planWaterfallPool( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + if (!view.isOpenToSurface(source.target())) { + return planGrottoOrClosedComponent(view, source, settings, throat); + } + HydrologyCaveRejection dryThroatRejection = validateDryThroatContacts(view, source, throat); + if (dryThroatRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, dryThroatRejection); + } + HydrologyCaveRejection shaftRejection = validateWaterfallShaft(view, source, settings, throat); + if (shaftRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, shaftRejection); + } + CaveVoxel targetVoxel = planner.voxelAt(view, source.target()); + if (!planner.isFluidReachable(targetVoxel, settings)) { + return planner.rejected(source, planner.rejectionForTarget(targetVoxel, settings)); + } + + Map actions = new LinkedHashMap<>(); + addThroatActions(actions, throat, source); + addSealGuards(view, source, actions); + return planner.accepted(view, source, actions); + } + + HydrologyCavePlan planClosedComponent( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + HydrologyCaveRejection dryThroatRejection = validateDryThroatContacts(view, source, throat); + if (dryThroatRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, dryThroatRejection); + } + HydrologyCaveRejection waterfallRejection = validateWaterfallShaft(view, source, settings, throat); + if (waterfallRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, waterfallRejection); + } + + CaveVoxel targetVoxel = planner.voxelAt(view, source.target()); + if (!planner.isFluidReachable(targetVoxel, settings)) { + return planner.rejected(source, planner.rejectionForTarget(targetVoxel, settings)); + } + + CaveComponentResult component = resolveClosedComponent(view, source, settings, throat); + if (component.rejection() != HydrologyCaveRejection.NONE) { + return planner.rejected(source, component.rejection()); + } + + Map actions = new LinkedHashMap<>(); + addThroatActions(actions, throat, source); + for (CavePosition position : component.positions()) { + actions.put(position, HydrologyCaveAction.WET_SOURCE); + } + addSealGuards(view, source, actions); + return planner.accepted(view, source, actions); + } + + HydrologyCaveRejection validateDryThroatContacts( + CaveVoxelView view, + HydrologyCaveSource source, + List throat + ) { + Set throatPositions = Set.copyOf(throat); + for (CavePosition position : throat) { + if (position.y() <= source.waterHeadY()) { + continue; + } + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (throatPositions.contains(neighbor) || isInletOpening(source, neighbor)) { + continue; + } + if (!view.isInWorld(neighbor)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + CaveVoxel voxel = planner.voxelAt(view, neighbor); + if (voxel == CaveVoxel.LAVA) { + return HydrologyCaveRejection.LAVA_CONTACT; + } + if (voxel == CaveVoxel.COMPATIBLE_FLUID) { + return HydrologyCaveRejection.EXISTING_FLUID; + } + if (voxel == CaveVoxel.INCOMPATIBLE_FLUID) { + return HydrologyCaveRejection.INCOMPATIBLE_FLUID; + } + } + } + return HydrologyCaveRejection.NONE; + } + + HydrologyCaveRejection validateWaterfallShaft( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + if (source.mode() != HydrologyCaveMode.WATERFALL_POOL) { + return HydrologyCaveRejection.NONE; + } + + Set throatPositions = Set.copyOf(throat); + for (CavePosition position : throat) { + if (position.y() <= source.waterHeadY()) { + continue; + } + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (throatPositions.contains(neighbor) || isInletOpening(source, neighbor)) { + continue; + } + if (!view.isInWorld(neighbor)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, neighbor); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + CaveVoxel voxel = planner.voxelAt(view, neighbor); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return hazard; + } + if (voxel != CaveVoxel.SOLID) { + return HydrologyCaveRejection.WATERFALL_SHAFT_OPEN; + } + } + } + return HydrologyCaveRejection.NONE; + } + + HydrologyCavePlan planGeneratedGrotto( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + CaveGrottoResult grotto = buildGrotto(source, settings); + if (grotto.rejection() != HydrologyCaveRejection.NONE) { + return planner.rejected(source, grotto.rejection()); + } + Set chamber = grotto.positions(); + + Set carve = new LinkedHashSet<>(chamber.size() + throat.size()); + carve.addAll(chamber); + carve.addAll(throat); + HydrologyCaveRejection carveRejection = validateGeneratedCarve(view, source, settings, carve); + if (carveRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, carveRejection); + } + + CaveBoundaryResult boundary = validateGeneratedBoundary(view, source, settings, carve); + if (boundary.rejection() != HydrologyCaveRejection.NONE) { + return planner.rejected(source, boundary.rejection()); + } + + Map actions = new LinkedHashMap<>(); + addChamberActions(actions, chamber, source.waterHeadY()); + addThroatActions(actions, throat, source); + for (CavePosition position : boundary.sealGuards()) { + actions.put(position, HydrologyCaveAction.SEAL_GUARD); + } + return planner.accepted(view, source, actions); + } + + HydrologyCavePlan planDeepPool( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + CaveGrottoResult grotto = buildGrotto(source, settings); + if (grotto.rejection() != HydrologyCaveRejection.NONE) { + return planner.rejected(source, grotto.rejection()); + } + Set chamber = grotto.positions(); + Set carve = new LinkedHashSet<>(chamber.size() + throat.size()); + carve.addAll(chamber); + carve.addAll(throat); + + HydrologyCaveRejection carveRejection = validateDeepPoolCarve(view, source, settings, carve); + if (carveRejection != HydrologyCaveRejection.NONE) { + return planner.rejected(source, carveRejection); + } + CaveBoundaryResult boundary = validateDeepPoolBoundary(view, source, settings, carve); + if (boundary.rejection() != HydrologyCaveRejection.NONE) { + return planner.rejected(source, boundary.rejection()); + } + + Map actions = new LinkedHashMap<>(); + addChamberActions(actions, chamber, source.waterHeadY()); + addThroatActions(actions, throat, source); + for (CavePosition position : boundary.sealGuards()) { + actions.put(position, HydrologyCaveAction.SEAL_GUARD); + } + return planner.accepted(view, source, actions); + } + + HydrologyCaveRejection validateDeepPoolCarve( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + Set carve + ) { + for (CavePosition position : carve) { + if (!view.isInWorld(position)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, position); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + CaveVoxel voxel = planner.voxelAt(view, position); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return hazard; + } + if (voxel == CaveVoxel.SOLID) { + continue; + } + if (position.y() > source.waterHeadY() + && voxel == CaveVoxel.CAVE_AIR + && !view.isOpenToSurface(position)) { + continue; + } + return HydrologyCaveRejection.GROTTO_INTERSECTION; + } + return HydrologyCaveRejection.NONE; + } + + CaveBoundaryResult validateDeepPoolBoundary( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + Set carve + ) { + Set guards = new LinkedHashSet<>(); + for (CavePosition position : carve) { + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (carve.contains(neighbor)) { + continue; + } + if (!view.isInWorld(neighbor)) { + return CaveBoundaryResult.rejected(HydrologyCaveRejection.WORLD_BOUNDARY); + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, neighbor); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return CaveBoundaryResult.rejected(boundsRejection); + } + CaveVoxel voxel = planner.voxelAt(view, neighbor); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return CaveBoundaryResult.rejected(hazard); + } + if (voxel == CaveVoxel.SOLID) { + guards.add(neighbor); + continue; + } + if (neighbor.y() > source.waterHeadY() + && voxel == CaveVoxel.CAVE_AIR + && !view.isOpenToSurface(neighbor)) { + continue; + } + return CaveBoundaryResult.rejected(HydrologyCaveRejection.GROTTO_SHELL_OPEN); + } + } + return CaveBoundaryResult.accepted(guards); + } + + CaveComponentResult resolveClosedComponent( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat + ) { + Queue queue = new ArrayDeque<>(); + Set queued = new LinkedHashSet<>(); + int visitedCount = 0; + + queue.add(source.target()); + queued.add(source.target()); + HydrologyCaveRejection seedRejection = addThroatContacts(view, source, settings, throat, queue, queued); + if (seedRejection != HydrologyCaveRejection.NONE) { + return CaveComponentResult.rejected(seedRejection); + } + + while (!queue.isEmpty()) { + CavePosition position = queue.remove(); + HydrologyCaveRejection positionRejection = validateReachablePosition(view, source, settings, position); + if (positionRejection != HydrologyCaveRejection.NONE) { + return CaveComponentResult.rejected(positionRejection); + } + if (++visitedCount > settings.maxFloodVolume()) { + return CaveComponentResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); + } + + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + HydrologyCaveRejection neighborRejection = inspectReachableNeighbor( + view, + source, + settings, + neighbor, + queue, + queued + ); + if (neighborRejection != HydrologyCaveRejection.NONE) { + return CaveComponentResult.rejected(neighborRejection); + } + } + } + + return CaveComponentResult.accepted(queued); + } + + HydrologyCaveRejection addThroatContacts( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List throat, + Queue queue, + Set queued + ) { + for (CavePosition position : throat) { + if (position.y() > source.waterHeadY()) { + continue; + } + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + HydrologyCaveRejection rejection = inspectReachableNeighbor( + view, + source, + settings, + neighbor, + queue, + queued + ); + if (rejection != HydrologyCaveRejection.NONE) { + return rejection; + } + } + } + return HydrologyCaveRejection.NONE; + } + + HydrologyCaveRejection inspectReachableNeighbor( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + CavePosition position, + Queue queue, + Set queued + ) { + if (position.y() > source.waterHeadY()) { + return inspectAboveHeadNeighbor(view, source, position); + } + if (!view.isInWorld(position)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + + CaveVoxel voxel = planner.voxelAt(view, position); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return hazard; + } + if (!planner.isFluidReachable(voxel, settings)) { + return HydrologyCaveRejection.NONE; + } + + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, position); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + if (queued.add(position)) { + queue.add(position); + } + return HydrologyCaveRejection.NONE; + } + + HydrologyCaveRejection inspectAboveHeadNeighbor( + CaveVoxelView view, + HydrologyCaveSource source, + CavePosition position + ) { + if (isInletOpening(source, position) || !view.isInWorld(position)) { + return HydrologyCaveRejection.NONE; + } + CaveVoxel voxel = planner.voxelAt(view, position); + return switch (voxel) { + case LAVA -> HydrologyCaveRejection.LAVA_CONTACT; + case COMPATIBLE_FLUID -> HydrologyCaveRejection.EXISTING_FLUID; + case INCOMPATIBLE_FLUID -> HydrologyCaveRejection.INCOMPATIBLE_FLUID; + default -> HydrologyCaveRejection.NONE; + }; + } + + HydrologyCaveRejection validateReachablePosition( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + CavePosition position + ) { + if (!view.isInWorld(position)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, position); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + if (view.isOpenToSurface(position)) { + return HydrologyCaveRejection.OPEN_SURFACE; + } + CaveVoxel voxel = planner.voxelAt(view, position); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return hazard; + } + return planner.isFluidReachable(voxel, settings) + ? HydrologyCaveRejection.NONE + : HydrologyCaveRejection.NO_CAVE_TARGET; + } + + CavePathResult buildThroat( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings + ) { + CavePosition entry = source.entry(); + CavePosition target = source.target(); + int deltaX = target.x() - entry.x(); + int deltaY = target.y() - entry.y(); + int deltaZ = target.z() - entry.z(); + int movesX = Math.abs(deltaX); + int movesY = Math.abs(deltaY); + int movesZ = Math.abs(deltaZ); + int length = movesX + movesY + movesZ; + if (length > settings.maxThroatLength()) { + return CavePathResult.rejected(HydrologyCaveRejection.THROAT_LIMIT); + } + + int stepX = Integer.signum(deltaX); + int stepY = Integer.signum(deltaY); + int stepZ = Integer.signum(deltaZ); + int usedX = 0; + int usedY = 0; + int usedZ = 0; + CavePosition current = entry; + List positions = new ArrayList<>(length + 1); + + while (true) { + HydrologyCaveRejection positionRejection = validateThroatPosition(view, source, settings, current); + if (positionRejection != HydrologyCaveRejection.NONE) { + return CavePathResult.rejected(positionRejection); + } + positions.add(current); + if (current.equals(target)) { + return expandThroat(view, source, settings, positions); + } + + int axis = selectNextAxis(source.sourceId(), movesX, movesY, movesZ, usedX, usedY, usedZ); + if (axis == 0) { + current = current.offset(stepX, 0, 0); + usedX++; + } else if (axis == 1) { + current = current.offset(0, stepY, 0); + usedY++; + } else { + current = current.offset(0, 0, stepZ); + usedZ++; + } + } + } + + CavePathResult expandThroat( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + List centerline + ) { + int radius = settings.throatRadius(); + int extent = radius - 1; + int radiusSquared = radius * radius; + Set expanded = new LinkedHashSet<>(); + for (CavePosition center : centerline) { + for (int dx = -extent; dx <= extent; dx++) { + for (int dy = -extent; dy <= extent; dy++) { + for (int dz = -extent; dz <= extent; dz++) { + if ((dx * dx) + (dy * dy) + (dz * dz) >= radiusSquared) { + continue; + } + CavePosition position = center.offset(dx, dy, dz); + if (position.y() > source.entry().y()) { + continue; + } + HydrologyCaveRejection rejection = validateThroatPosition(view, source, settings, position); + if (rejection != HydrologyCaveRejection.NONE) { + return CavePathResult.rejected(rejection); + } + expanded.add(position); + if (expanded.size() > settings.maxFloodVolume()) { + return CavePathResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); + } + } + } + } + } + return CavePathResult.accepted(List.copyOf(expanded)); + } + + int selectNextAxis( + long sourceId, + int movesX, + int movesY, + int movesZ, + int usedX, + int usedY, + int usedZ + ) { + double scoreX = nextAxisScore(movesX, usedX); + double scoreY = nextAxisScore(movesY, usedY); + double scoreZ = nextAxisScore(movesZ, usedZ); + double minimum = Math.min(scoreX, Math.min(scoreY, scoreZ)); + int tieOffset = Math.floorMod(sourceId, 3); + for (int offset = 0; offset < 3; offset++) { + int axis = (tieOffset + offset) % 3; + double score = axis == 0 ? scoreX : axis == 1 ? scoreY : scoreZ; + if (score == minimum) { + return axis; + } + } + throw new IllegalStateException("No remaining throat axis"); + } + + double nextAxisScore(int moves, int used) { + if (used >= moves) { + return Double.POSITIVE_INFINITY; + } + return ((2D * used) + 1D) / moves; + } + + HydrologyCaveRejection validateThroatPosition( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + CavePosition position + ) { + if (!view.isInWorld(position)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, position); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + return planner.rejectionForHazard(planner.voxelAt(view, position), settings); + } + + CaveGrottoResult buildGrotto(HydrologyCaveSource source, HydrologyCavePlannerSettings settings) { + int horizontalRadius = settings.grottoHorizontalRadius(); + int verticalRadius = settings.grottoVerticalRadius(); + Set candidates = new LinkedHashSet<>(); + + for (int dx = -horizontalRadius; dx <= horizontalRadius; dx++) { + for (int dy = -verticalRadius; dy <= verticalRadius; dy++) { + for (int dz = -horizontalRadius; dz <= horizontalRadius; dz++) { + if (settings.grottoShape().contains(source, settings, dx, dy, dz)) { + candidates.add(source.target().offset(dx, dy, dz)); + if (candidates.size() > settings.maxFloodVolume()) { + return CaveGrottoResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); + } + } + } + } + } + candidates.add(source.target()); + for (int offset = 1; offset <= settings.dryHeadroom(); offset++) { + CavePosition headroom = new CavePosition( + source.target().x(), source.waterHeadY() + offset, source.target().z()); + if (Math.abs(headroom.y() - source.target().y()) > verticalRadius) { + return CaveGrottoResult.rejected(HydrologyCaveRejection.DRY_HEADROOM_LIMIT); + } + candidates.add(headroom); + if (candidates.size() > settings.maxFloodVolume()) { + return CaveGrottoResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); + } + } + return CaveGrottoResult.accepted(connectedGrotto(source.target(), candidates)); + } + + Set connectedGrotto(CavePosition target, Set candidates) { + Queue queue = new ArrayDeque<>(); + Set connected = new LinkedHashSet<>(); + queue.add(target); + connected.add(target); + while (!queue.isEmpty()) { + CavePosition position = queue.remove(); + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (candidates.contains(neighbor) && connected.add(neighbor)) { + queue.add(neighbor); + } + } + } + return connected; + } + + HydrologyCaveRejection validateGeneratedCarve( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + Set carve + ) { + for (CavePosition position : carve) { + if (!view.isInWorld(position)) { + return HydrologyCaveRejection.WORLD_BOUNDARY; + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, position); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return boundsRejection; + } + CaveVoxel voxel = planner.voxelAt(view, position); + if (isGeneratedInletCarve(view, source, settings, position, voxel)) { + continue; + } + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return hazard; + } + if (voxel != CaveVoxel.SOLID) { + return HydrologyCaveRejection.GROTTO_INTERSECTION; + } + } + return HydrologyCaveRejection.NONE; + } + + CaveBoundaryResult validateGeneratedBoundary( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + Set carve + ) { + Set guards = new LinkedHashSet<>(); + for (CavePosition position : carve) { + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (carve.contains(neighbor)) { + continue; + } + if (isInletOpening(source, neighbor) + || isGeneratedInletOpening(view, source, settings, neighbor)) { + continue; + } + if (!view.isInWorld(neighbor)) { + return CaveBoundaryResult.rejected(HydrologyCaveRejection.WORLD_BOUNDARY); + } + HydrologyCaveRejection boundsRejection = planner.validateBounds(source, settings, neighbor); + if (boundsRejection != HydrologyCaveRejection.NONE) { + return CaveBoundaryResult.rejected(boundsRejection); + } + CaveVoxel voxel = planner.voxelAt(view, neighbor); + HydrologyCaveRejection hazard = planner.rejectionForHazard(voxel, settings); + if (hazard != HydrologyCaveRejection.NONE) { + return CaveBoundaryResult.rejected(hazard); + } + if (voxel != CaveVoxel.SOLID) { + return CaveBoundaryResult.rejected(HydrologyCaveRejection.GROTTO_SHELL_OPEN); + } + guards.add(neighbor); + } + } + return CaveBoundaryResult.accepted(guards); + } + + void addChamberActions( + Map actions, + Collection positions, + int waterHeadY + ) { + for (CavePosition position : positions) { + HydrologyCaveAction action = position.y() <= waterHeadY + ? HydrologyCaveAction.WET_SOURCE + : HydrologyCaveAction.DRY_AIR; + actions.put(position, action); + } + } + + void addThroatActions( + Map actions, + Collection throat, + HydrologyCaveSource source + ) { + for (CavePosition position : throat) { + HydrologyCaveAction action; + if (position.y() <= source.waterHeadY()) { + action = HydrologyCaveAction.WET_SOURCE; + } else if (source.mode() == HydrologyCaveMode.WATERFALL_POOL + || source.mode() == HydrologyCaveMode.GENERATED_GROTTO) { + action = HydrologyCaveAction.FALLING_FLUID; + } else { + action = HydrologyCaveAction.DRY_AIR; + } + actions.put(position, action); + } + } + + void addSealGuards( + CaveVoxelView view, + HydrologyCaveSource source, + Map actions + ) { + Set guards = new LinkedHashSet<>(); + for (CavePosition position : List.copyOf(actions.keySet())) { + for (CavePosition direction : HydrologyCaveContainmentPlanner.DIRECTIONS) { + CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); + if (actions.containsKey(neighbor) + || isInletOpening(source, neighbor) + || !view.isInWorld(neighbor)) { + continue; + } + if (planner.voxelAt(view, neighbor) == CaveVoxel.SOLID) { + guards.add(neighbor); + } + } + } + for (CavePosition guard : guards) { + actions.put(guard, HydrologyCaveAction.SEAL_GUARD); + } + } + + boolean isInletOpening(HydrologyCaveSource source, CavePosition position) { + return position.equals(source.entry().offset(0, 1, 0)); + } + + boolean isGeneratedInletCarve( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + CavePosition position, + CaveVoxel voxel + ) { + if (voxel != CaveVoxel.CAVE_AIR && voxel != CaveVoxel.COMPATIBLE_FLUID) { + return false; + } + int extent = Math.max(0, settings.throatRadius() - 1); + long deltaX = (long) position.x() - source.entry().x(); + long deltaZ = (long) position.z() - source.entry().z(); + return position.y() >= source.entry().y() - extent + && position.y() <= source.entry().y() + && deltaX * deltaX + deltaZ * deltaZ <= (long) extent * extent + && view.isOpenToSurface(position); + } + + boolean isGeneratedInletOpening( + CaveVoxelView view, + HydrologyCaveSource source, + HydrologyCavePlannerSettings settings, + CavePosition position + ) { + int radius = Math.max(1, settings.throatRadius()); + long deltaX = (long) position.x() - source.entry().x(); + long deltaZ = (long) position.z() - source.entry().z(); + return position.y() >= source.entry().y() + && position.y() <= source.entry().y() + 1 + && deltaX * deltaX + deltaZ * deltaZ < (long) radius * radius + && view.isOpenToSurface(position); + } +} diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveContainmentPlanner.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveContainmentPlanner.java index e1d067d21..139677dd4 100644 --- a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveContainmentPlanner.java +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/HydrologyCaveContainmentPlanner.java @@ -2,27 +2,23 @@ package art.arcane.iris.engine.hydrology.cave; import art.arcane.iris.engine.hydrology.HydrologyObservedPlannedSurface; -import java.util.ArrayDeque; import java.util.ArrayList; -import java.util.Arrays; import java.util.Collection; -import java.util.Collections; import java.util.Comparator; import java.util.HashMap; import java.util.IdentityHashMap; import java.util.LinkedHashMap; -import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.OptionalLong; -import java.util.Queue; import java.util.Set; import java.util.function.BiPredicate; public final class HydrologyCaveContainmentPlanner { - private static final int MAXIMUM_INITIAL_GUARD_INDEX_SIZE = 16_384; - private static final List DIRECTIONS = List.of( + static final int MAXIMUM_INITIAL_GUARD_INDEX_SIZE = 16_384; + + static final List DIRECTIONS = List.of( new CavePosition(1, 0, 0), new CavePosition(-1, 0, 0), new CavePosition(0, 1, 0), @@ -30,8 +26,14 @@ public final class HydrologyCaveContainmentPlanner { new CavePosition(0, 0, 1), new CavePosition(0, 0, -1) ); - private static final Comparator SOURCE_PRIORITY = + + static final Comparator SOURCE_PRIORITY = HydrologyCaveConflictPolicy.sourcePriority(); + final HydrologyCaveChamberPlanner chambers; + + public HydrologyCaveContainmentPlanner() { + this.chambers = new HydrologyCaveChamberPlanner(this); + } public HydrologyCavePlan plan( CaveVoxelView view, @@ -47,27 +49,27 @@ public final class HydrologyCaveContainmentPlanner { return rejected(source, sourceRejection); } - PathResult throat = buildThroat(view, source, settings); + CavePathResult throat = chambers.buildThroat(view, source, settings); if (throat.rejection() != HydrologyCaveRejection.NONE) { return rejected(source, throat.rejection()); } return switch (source.mode()) { - case CLOSED_COMPONENT -> planClosedComponent(view, source, settings, throat.positions()); - case GENERATED_GROTTO -> planGeneratedGrotto(view, source, settings, throat.positions()); - case GROTTO_OR_CLOSED_COMPONENT -> planGrottoOrClosedComponent( + case CLOSED_COMPONENT -> chambers.planClosedComponent(view, source, settings, throat.positions()); + case GENERATED_GROTTO -> chambers.planGeneratedGrotto(view, source, settings, throat.positions()); + case GROTTO_OR_CLOSED_COMPONENT -> chambers.planGrottoOrClosedComponent( view, source, settings, throat.positions() ); - case WATERFALL_POOL -> planWaterfallPool( + case WATERFALL_POOL -> chambers.planWaterfallPool( view, source, settings, throat.positions() ); - case DEEP_POOL -> planDeepPool(view, source, settings, throat.positions()); + case DEEP_POOL -> chambers.planDeepPool(view, source, settings, throat.positions()); }; } @@ -133,7 +135,7 @@ public final class HydrologyCaveContainmentPlanner { ValidationCache validationCache, HydrologyObservedPlannedSurface plannedSurface ) { - ValidationBatch batch = validateBatch( + CaveValidationBatch batch = validateBatch( view, candidates, validationCache, @@ -203,7 +205,7 @@ public final class HydrologyCaveContainmentPlanner { ).plans(); } - private ValidationBatch validateBatch( + CaveValidationBatch validateBatch( CaveVoxelView view, Collection candidates, ValidationCache validationCache, @@ -252,26 +254,19 @@ public final class HydrologyCaveContainmentPlanner { claims.putIfAbsent(position, claimGroup)); } - return new ValidationBatch( + return new CaveValidationBatch( List.copyOf(plans), combinedActions, combinedPreconditions ); } - private record ValidationBatch( - List plans, - Map actions, - Map baselinePreconditions - ) { - } - public static final class ValidationCache { private static final int DEFAULT_MAXIMUM_ENTRIES = 256; private static final long DEFAULT_MAXIMUM_RETAINED_POSITIONS = 262_144L; - private final IdentityHashMap validations; - private final HashMap equivalentValidations; + private final IdentityHashMap validations; + private final HashMap equivalentValidations; private final int maximumEntries; private final long maximumRetainedPositions; private long retainedPositions; @@ -302,7 +297,7 @@ public final class HydrologyCaveContainmentPlanner { HydrologyObservedPlannedSurface plannedSurface, boolean exposureValidated ) { - CachedValidation cached = validations.get(candidate); + CaveCachedValidation cached = validations.get(candidate); if (cached == null) { cached = equivalentValidations.get(candidate); if (cached != null) { @@ -323,14 +318,14 @@ public final class HydrologyCaveContainmentPlanner { boolean observeColumnsOnly = plannedSurface != null; RecordingCaveVoxelView recording = new RecordingCaveVoxelView(view, observeColumnsOnly); HydrologyCavePlan plan = planner.validate(recording, candidate, exposureValidated); - ViewObservations viewObservations = recording.snapshot(); - SurfaceObservations surfaceObservations = plannedSurface == null - ? SurfaceObservations.empty() - : SurfaceObservations.capture(viewObservations, plannedSurface); + CaveViewObservations viewObservations = recording.snapshot(); + CaveSurfaceObservations surfaceObservations = plannedSurface == null + ? CaveSurfaceObservations.empty() + : CaveSurfaceObservations.capture(viewObservations, plannedSurface); if (observeColumnsOnly) { - viewObservations = ViewObservations.empty(); + viewObservations = CaveViewObservations.empty(); } - CachedValidation validation = new CachedValidation(plan, viewObservations, surfaceObservations); + CaveCachedValidation validation = new CaveCachedValidation(plan, viewObservations, surfaceObservations); retain(candidate, validation); return plan; } @@ -345,7 +340,7 @@ public final class HydrologyCaveContainmentPlanner { misses = 0L; } - private void retain(HydrologyCaveCandidate candidate, CachedValidation validation) { + private void retain(HydrologyCaveCandidate candidate, CaveCachedValidation validation) { long weight = validation.retainedPositions(); if (weight > maximumRetainedPositions) { return; @@ -359,12 +354,12 @@ public final class HydrologyCaveContainmentPlanner { retainedPositions += weight; } - private void remove(CachedValidation cached) { + private void remove(CaveCachedValidation cached) { validations.entrySet().removeIf( - (Map.Entry entry) -> entry.getValue() == cached + (Map.Entry entry) -> entry.getValue() == cached ); equivalentValidations.entrySet().removeIf( - (Map.Entry entry) -> entry.getValue() == cached + (Map.Entry entry) -> entry.getValue() == cached ); retainedPositions -= cached.retainedPositions(); } @@ -380,181 +375,11 @@ public final class HydrologyCaveContainmentPlanner { } } - private static final class RecordingCaveVoxelView implements CaveVoxelView { - private static final byte IN_WORLD = 0; - private static final byte VOXEL = 1; - private static final byte OPEN_TO_SURFACE = 2; - private static final byte ABOVE_TERRAIN_SURFACE = 3; - - private final CaveVoxelView delegate; - private final boolean observeColumnsOnly; - private CavePosition[] positions; - private byte[] operations; - private byte[] values; - private CavePositionIndex[] observed; - private int size; - - private RecordingCaveVoxelView(CaveVoxelView delegate, boolean observeColumnsOnly) { - this.delegate = delegate; - this.observeColumnsOnly = observeColumnsOnly; - this.positions = new CavePosition[1024]; - this.operations = observeColumnsOnly ? new byte[0] : new byte[1024]; - this.values = observeColumnsOnly ? new byte[0] : new byte[1024]; - this.observed = observeColumnsOnly - ? new CavePositionIndex[]{new CavePositionIndex()} - : new CavePositionIndex[]{ - new CavePositionIndex(), - new CavePositionIndex(), - new CavePositionIndex(), - new CavePositionIndex() - }; - } - - @Override - public boolean isInWorld(CavePosition position) { - boolean result = delegate.isInWorld(position); - add(position, IN_WORLD, result ? 1 : 0); - return result; - } - - @Override - public CaveVoxel voxelAt(CavePosition position) { - CaveVoxel result = delegate.voxelAt(position); - add(position, VOXEL, result.ordinal()); - return result; - } - - @Override - public boolean isOpenToSurface(CavePosition position) { - boolean result = delegate.isOpenToSurface(position); - add(position, OPEN_TO_SURFACE, result ? 1 : 0); - return result; - } - - @Override - public boolean isAboveTerrainSurface(CavePosition position) { - boolean result = delegate.isAboveTerrainSurface(position); - add(position, ABOVE_TERRAIN_SURFACE, result ? 1 : 0); - return result; - } - - private void add(CavePosition position, byte operation, int value) { - int observedIndex = observeColumnsOnly ? 0 : operation; - int observedY = observeColumnsOnly ? 0 : position.y(); - if (!observed[observedIndex].add(position.x(), observedY, position.z())) { - return; - } - if (size == positions.length) { - int expandedSize = Math.multiplyExact(size, 2); - positions = Arrays.copyOf(positions, expandedSize); - if (!observeColumnsOnly) { - operations = Arrays.copyOf(operations, expandedSize); - values = Arrays.copyOf(values, expandedSize); - } - } - positions[size] = position; - if (!observeColumnsOnly) { - operations[size] = operation; - values[size] = (byte) value; - } - size++; - } - - private ViewObservations snapshot() { - observed = null; - if (positions.length == 1024) { - return new ViewObservations( - Arrays.copyOf(positions, size), - observeColumnsOnly ? operations : Arrays.copyOf(operations, size), - observeColumnsOnly ? values : Arrays.copyOf(values, size), - size - ); - } - return new ViewObservations(positions, operations, values, size); - } - } - - private record CachedValidation( - HydrologyCavePlan plan, - ViewObservations viewObservations, - SurfaceObservations surfaceObservations - ) { - private long retainedPositions() { - return Math.max(1L, (long) plan.actions().size() - + plan.baselinePreconditions().size() - + viewObservations.size() - + surfaceObservations.observations().size()); - } - } - - private record SurfaceObservations( - List observations - ) { - private static SurfaceObservations empty() { - return new SurfaceObservations(List.of()); - } - - private static SurfaceObservations capture( - ViewObservations viewObservations, - HydrologyObservedPlannedSurface plannedSurface - ) { - ArrayList observations = new ArrayList<>(); - for (int index = 0; index < viewObservations.size(); index++) { - CavePosition position = viewObservations.positions()[index]; - observations.addAll(plannedSurface.observationsAt(position.x(), position.z())); - } - return new SurfaceObservations(List.copyOf(observations)); - } - - private boolean matches(HydrologyObservedPlannedSurface plannedSurface) { - for (HydrologyObservedPlannedSurface.Observation observation : observations) { - int resolvedHeight = plannedSurface.resolve( - observation.x(), - observation.z(), - observation.naturalHeight() - ); - if (resolvedHeight != observation.resolvedHeight()) { - return false; - } - } - return true; - } - } - - private record ViewObservations( - CavePosition[] positions, - byte[] operations, - byte[] values, - int size - ) { - private static ViewObservations empty() { - return new ViewObservations(new CavePosition[0], new byte[0], new byte[0], 0); - } - - private boolean matches(CaveVoxelView view) { - for (int index = 0; index < size; index++) { - CavePosition position = positions[index]; - int actual = switch (operations[index]) { - case RecordingCaveVoxelView.IN_WORLD -> view.isInWorld(position) ? 1 : 0; - case RecordingCaveVoxelView.VOXEL -> view.voxelAt(position).ordinal(); - case RecordingCaveVoxelView.OPEN_TO_SURFACE -> view.isOpenToSurface(position) ? 1 : 0; - case RecordingCaveVoxelView.ABOVE_TERRAIN_SURFACE -> - view.isAboveTerrainSurface(position) ? 1 : 0; - default -> throw new IllegalStateException("Unknown cave view operation."); - }; - if (actual != Byte.toUnsignedInt(values[index])) { - return false; - } - } - return true; - } - } - public HydrologyCavePlan validate(CaveVoxelView view, HydrologyCaveCandidate candidate) { return validate(view, candidate, false); } - private HydrologyCavePlan validate( + HydrologyCavePlan validate( CaveVoxelView view, HydrologyCaveCandidate candidate, boolean exposureValidated @@ -619,7 +444,7 @@ public final class HydrologyCaveContainmentPlanner { return accepted(source, actions, preconditions); } - private boolean exceedsFloodVolume( + boolean exceedsFloodVolume( Map actions, int maximumFloodVolume ) { @@ -635,7 +460,7 @@ public final class HydrologyCaveContainmentPlanner { return false; } - private boolean eligibleForTerrainSurfaceCheck( + boolean eligibleForTerrainSurfaceCheck( CaveVoxelView view, HydrologyCaveSource source, HydrologyCavePlannerSettings settings, @@ -645,7 +470,7 @@ public final class HydrologyCaveContainmentPlanner { && validateBounds(source, settings, position) == HydrologyCaveRejection.NONE; } - private boolean isPlannedVolumeAboveTerrainSurface( + boolean isPlannedVolumeAboveTerrainSurface( CaveVoxelView view, HydrologyCaveCandidate candidate, CavePositionIndex actionIndex, @@ -679,7 +504,7 @@ public final class HydrologyCaveContainmentPlanner { return false; } - private HydrologyCaveRejection validatePlannedPosition( + HydrologyCaveRejection validatePlannedPosition( CaveVoxelView view, HydrologyCaveSource source, HydrologyCavePlannerSettings settings, @@ -706,7 +531,7 @@ public final class HydrologyCaveContainmentPlanner { return HydrologyCaveRejection.NONE; } - private HydrologyCaveRejection addPlannedBoundaryGuards( + HydrologyCaveRejection addPlannedBoundaryGuards( CaveVoxelView view, HydrologyCaveSource source, HydrologyCavePlannerSettings settings, @@ -782,7 +607,7 @@ public final class HydrologyCaveContainmentPlanner { return HydrologyCaveRejection.NONE; } - private HydrologyCaveRejection validateIntentionalOpening( + HydrologyCaveRejection validateIntentionalOpening( CaveVoxelView view, HydrologyCaveSource source, HydrologyCavePlannerSettings settings, @@ -808,7 +633,7 @@ public final class HydrologyCaveContainmentPlanner { return HydrologyCaveRejection.NONE; } - private OptionalLong findConflictingSourceId( + OptionalLong findConflictingSourceId( HydrologyCaveCandidate candidate, Map actions, Map claimedBy, @@ -831,797 +656,7 @@ public final class HydrologyCaveContainmentPlanner { return winner == null ? OptionalLong.empty() : OptionalLong.of(winner.sourceId()); } - private HydrologyCavePlan planGrottoOrClosedComponent( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - CaveVoxel targetVoxel = voxelAt(view, source.target()); - if (isFluidReachable(targetVoxel, settings)) { - return planClosedComponent(view, source, settings, throat); - } - if (targetVoxel == CaveVoxel.LAVA) { - return rejected(source, HydrologyCaveRejection.LAVA_CONTACT); - } - if (targetVoxel == CaveVoxel.INCOMPATIBLE_FLUID) { - return rejected(source, HydrologyCaveRejection.INCOMPATIBLE_FLUID); - } - return planGeneratedGrotto(view, source, settings, throat); - } - - private HydrologyCavePlan planWaterfallPool( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - if (!view.isOpenToSurface(source.target())) { - return planGrottoOrClosedComponent(view, source, settings, throat); - } - HydrologyCaveRejection dryThroatRejection = validateDryThroatContacts(view, source, throat); - if (dryThroatRejection != HydrologyCaveRejection.NONE) { - return rejected(source, dryThroatRejection); - } - HydrologyCaveRejection shaftRejection = validateWaterfallShaft(view, source, settings, throat); - if (shaftRejection != HydrologyCaveRejection.NONE) { - return rejected(source, shaftRejection); - } - CaveVoxel targetVoxel = voxelAt(view, source.target()); - if (!isFluidReachable(targetVoxel, settings)) { - return rejected(source, rejectionForTarget(targetVoxel, settings)); - } - - Map actions = new LinkedHashMap<>(); - addThroatActions(actions, throat, source); - addSealGuards(view, source, actions); - return accepted(view, source, actions); - } - - private HydrologyCavePlan planClosedComponent( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - HydrologyCaveRejection dryThroatRejection = validateDryThroatContacts(view, source, throat); - if (dryThroatRejection != HydrologyCaveRejection.NONE) { - return rejected(source, dryThroatRejection); - } - HydrologyCaveRejection waterfallRejection = validateWaterfallShaft(view, source, settings, throat); - if (waterfallRejection != HydrologyCaveRejection.NONE) { - return rejected(source, waterfallRejection); - } - - CaveVoxel targetVoxel = voxelAt(view, source.target()); - if (!isFluidReachable(targetVoxel, settings)) { - return rejected(source, rejectionForTarget(targetVoxel, settings)); - } - - ComponentResult component = resolveClosedComponent(view, source, settings, throat); - if (component.rejection() != HydrologyCaveRejection.NONE) { - return rejected(source, component.rejection()); - } - - Map actions = new LinkedHashMap<>(); - addThroatActions(actions, throat, source); - for (CavePosition position : component.positions()) { - actions.put(position, HydrologyCaveAction.WET_SOURCE); - } - addSealGuards(view, source, actions); - return accepted(view, source, actions); - } - - private HydrologyCaveRejection validateDryThroatContacts( - CaveVoxelView view, - HydrologyCaveSource source, - List throat - ) { - Set throatPositions = Set.copyOf(throat); - for (CavePosition position : throat) { - if (position.y() <= source.waterHeadY()) { - continue; - } - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (throatPositions.contains(neighbor) || isInletOpening(source, neighbor)) { - continue; - } - if (!view.isInWorld(neighbor)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - CaveVoxel voxel = voxelAt(view, neighbor); - if (voxel == CaveVoxel.LAVA) { - return HydrologyCaveRejection.LAVA_CONTACT; - } - if (voxel == CaveVoxel.COMPATIBLE_FLUID) { - return HydrologyCaveRejection.EXISTING_FLUID; - } - if (voxel == CaveVoxel.INCOMPATIBLE_FLUID) { - return HydrologyCaveRejection.INCOMPATIBLE_FLUID; - } - } - } - return HydrologyCaveRejection.NONE; - } - - private HydrologyCaveRejection validateWaterfallShaft( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - if (source.mode() != HydrologyCaveMode.WATERFALL_POOL) { - return HydrologyCaveRejection.NONE; - } - - Set throatPositions = Set.copyOf(throat); - for (CavePosition position : throat) { - if (position.y() <= source.waterHeadY()) { - continue; - } - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (throatPositions.contains(neighbor) || isInletOpening(source, neighbor)) { - continue; - } - if (!view.isInWorld(neighbor)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, neighbor); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - CaveVoxel voxel = voxelAt(view, neighbor); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return hazard; - } - if (voxel != CaveVoxel.SOLID) { - return HydrologyCaveRejection.WATERFALL_SHAFT_OPEN; - } - } - } - return HydrologyCaveRejection.NONE; - } - - private HydrologyCavePlan planGeneratedGrotto( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - GrottoResult grotto = buildGrotto(source, settings); - if (grotto.rejection() != HydrologyCaveRejection.NONE) { - return rejected(source, grotto.rejection()); - } - Set chamber = grotto.positions(); - - Set carve = new LinkedHashSet<>(chamber.size() + throat.size()); - carve.addAll(chamber); - carve.addAll(throat); - HydrologyCaveRejection carveRejection = validateGeneratedCarve(view, source, settings, carve); - if (carveRejection != HydrologyCaveRejection.NONE) { - return rejected(source, carveRejection); - } - - BoundaryResult boundary = validateGeneratedBoundary(view, source, settings, carve); - if (boundary.rejection() != HydrologyCaveRejection.NONE) { - return rejected(source, boundary.rejection()); - } - - Map actions = new LinkedHashMap<>(); - addChamberActions(actions, chamber, source.waterHeadY()); - addThroatActions(actions, throat, source); - for (CavePosition position : boundary.sealGuards()) { - actions.put(position, HydrologyCaveAction.SEAL_GUARD); - } - return accepted(view, source, actions); - } - - private HydrologyCavePlan planDeepPool( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - GrottoResult grotto = buildGrotto(source, settings); - if (grotto.rejection() != HydrologyCaveRejection.NONE) { - return rejected(source, grotto.rejection()); - } - Set chamber = grotto.positions(); - Set carve = new LinkedHashSet<>(chamber.size() + throat.size()); - carve.addAll(chamber); - carve.addAll(throat); - - HydrologyCaveRejection carveRejection = validateDeepPoolCarve(view, source, settings, carve); - if (carveRejection != HydrologyCaveRejection.NONE) { - return rejected(source, carveRejection); - } - BoundaryResult boundary = validateDeepPoolBoundary(view, source, settings, carve); - if (boundary.rejection() != HydrologyCaveRejection.NONE) { - return rejected(source, boundary.rejection()); - } - - Map actions = new LinkedHashMap<>(); - addChamberActions(actions, chamber, source.waterHeadY()); - addThroatActions(actions, throat, source); - for (CavePosition position : boundary.sealGuards()) { - actions.put(position, HydrologyCaveAction.SEAL_GUARD); - } - return accepted(view, source, actions); - } - - private HydrologyCaveRejection validateDeepPoolCarve( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - Set carve - ) { - for (CavePosition position : carve) { - if (!view.isInWorld(position)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, position); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - CaveVoxel voxel = voxelAt(view, position); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return hazard; - } - if (voxel == CaveVoxel.SOLID) { - continue; - } - if (position.y() > source.waterHeadY() - && voxel == CaveVoxel.CAVE_AIR - && !view.isOpenToSurface(position)) { - continue; - } - return HydrologyCaveRejection.GROTTO_INTERSECTION; - } - return HydrologyCaveRejection.NONE; - } - - private BoundaryResult validateDeepPoolBoundary( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - Set carve - ) { - Set guards = new LinkedHashSet<>(); - for (CavePosition position : carve) { - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (carve.contains(neighbor)) { - continue; - } - if (!view.isInWorld(neighbor)) { - return BoundaryResult.rejected(HydrologyCaveRejection.WORLD_BOUNDARY); - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, neighbor); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return BoundaryResult.rejected(boundsRejection); - } - CaveVoxel voxel = voxelAt(view, neighbor); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return BoundaryResult.rejected(hazard); - } - if (voxel == CaveVoxel.SOLID) { - guards.add(neighbor); - continue; - } - if (neighbor.y() > source.waterHeadY() - && voxel == CaveVoxel.CAVE_AIR - && !view.isOpenToSurface(neighbor)) { - continue; - } - return BoundaryResult.rejected(HydrologyCaveRejection.GROTTO_SHELL_OPEN); - } - } - return BoundaryResult.accepted(guards); - } - - private ComponentResult resolveClosedComponent( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat - ) { - Queue queue = new ArrayDeque<>(); - Set queued = new LinkedHashSet<>(); - int visitedCount = 0; - - queue.add(source.target()); - queued.add(source.target()); - HydrologyCaveRejection seedRejection = addThroatContacts(view, source, settings, throat, queue, queued); - if (seedRejection != HydrologyCaveRejection.NONE) { - return ComponentResult.rejected(seedRejection); - } - - while (!queue.isEmpty()) { - CavePosition position = queue.remove(); - HydrologyCaveRejection positionRejection = validateReachablePosition(view, source, settings, position); - if (positionRejection != HydrologyCaveRejection.NONE) { - return ComponentResult.rejected(positionRejection); - } - if (++visitedCount > settings.maxFloodVolume()) { - return ComponentResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); - } - - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - HydrologyCaveRejection neighborRejection = inspectReachableNeighbor( - view, - source, - settings, - neighbor, - queue, - queued - ); - if (neighborRejection != HydrologyCaveRejection.NONE) { - return ComponentResult.rejected(neighborRejection); - } - } - } - - return ComponentResult.accepted(queued); - } - - private HydrologyCaveRejection addThroatContacts( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List throat, - Queue queue, - Set queued - ) { - for (CavePosition position : throat) { - if (position.y() > source.waterHeadY()) { - continue; - } - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - HydrologyCaveRejection rejection = inspectReachableNeighbor( - view, - source, - settings, - neighbor, - queue, - queued - ); - if (rejection != HydrologyCaveRejection.NONE) { - return rejection; - } - } - } - return HydrologyCaveRejection.NONE; - } - - private HydrologyCaveRejection inspectReachableNeighbor( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - CavePosition position, - Queue queue, - Set queued - ) { - if (position.y() > source.waterHeadY()) { - return inspectAboveHeadNeighbor(view, source, position); - } - if (!view.isInWorld(position)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - - CaveVoxel voxel = voxelAt(view, position); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return hazard; - } - if (!isFluidReachable(voxel, settings)) { - return HydrologyCaveRejection.NONE; - } - - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, position); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - if (queued.add(position)) { - queue.add(position); - } - return HydrologyCaveRejection.NONE; - } - - private HydrologyCaveRejection inspectAboveHeadNeighbor( - CaveVoxelView view, - HydrologyCaveSource source, - CavePosition position - ) { - if (isInletOpening(source, position) || !view.isInWorld(position)) { - return HydrologyCaveRejection.NONE; - } - CaveVoxel voxel = voxelAt(view, position); - return switch (voxel) { - case LAVA -> HydrologyCaveRejection.LAVA_CONTACT; - case COMPATIBLE_FLUID -> HydrologyCaveRejection.EXISTING_FLUID; - case INCOMPATIBLE_FLUID -> HydrologyCaveRejection.INCOMPATIBLE_FLUID; - default -> HydrologyCaveRejection.NONE; - }; - } - - private HydrologyCaveRejection validateReachablePosition( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - CavePosition position - ) { - if (!view.isInWorld(position)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, position); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - if (view.isOpenToSurface(position)) { - return HydrologyCaveRejection.OPEN_SURFACE; - } - CaveVoxel voxel = voxelAt(view, position); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return hazard; - } - return isFluidReachable(voxel, settings) - ? HydrologyCaveRejection.NONE - : HydrologyCaveRejection.NO_CAVE_TARGET; - } - - private PathResult buildThroat( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings - ) { - CavePosition entry = source.entry(); - CavePosition target = source.target(); - int deltaX = target.x() - entry.x(); - int deltaY = target.y() - entry.y(); - int deltaZ = target.z() - entry.z(); - int movesX = Math.abs(deltaX); - int movesY = Math.abs(deltaY); - int movesZ = Math.abs(deltaZ); - int length = movesX + movesY + movesZ; - if (length > settings.maxThroatLength()) { - return PathResult.rejected(HydrologyCaveRejection.THROAT_LIMIT); - } - - int stepX = Integer.signum(deltaX); - int stepY = Integer.signum(deltaY); - int stepZ = Integer.signum(deltaZ); - int usedX = 0; - int usedY = 0; - int usedZ = 0; - CavePosition current = entry; - List positions = new ArrayList<>(length + 1); - - while (true) { - HydrologyCaveRejection positionRejection = validateThroatPosition(view, source, settings, current); - if (positionRejection != HydrologyCaveRejection.NONE) { - return PathResult.rejected(positionRejection); - } - positions.add(current); - if (current.equals(target)) { - return expandThroat(view, source, settings, positions); - } - - int axis = selectNextAxis(source.sourceId(), movesX, movesY, movesZ, usedX, usedY, usedZ); - if (axis == 0) { - current = current.offset(stepX, 0, 0); - usedX++; - } else if (axis == 1) { - current = current.offset(0, stepY, 0); - usedY++; - } else { - current = current.offset(0, 0, stepZ); - usedZ++; - } - } - } - - private PathResult expandThroat( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - List centerline - ) { - int radius = settings.throatRadius(); - int extent = radius - 1; - int radiusSquared = radius * radius; - Set expanded = new LinkedHashSet<>(); - for (CavePosition center : centerline) { - for (int dx = -extent; dx <= extent; dx++) { - for (int dy = -extent; dy <= extent; dy++) { - for (int dz = -extent; dz <= extent; dz++) { - if ((dx * dx) + (dy * dy) + (dz * dz) >= radiusSquared) { - continue; - } - CavePosition position = center.offset(dx, dy, dz); - if (position.y() > source.entry().y()) { - continue; - } - HydrologyCaveRejection rejection = validateThroatPosition(view, source, settings, position); - if (rejection != HydrologyCaveRejection.NONE) { - return PathResult.rejected(rejection); - } - expanded.add(position); - if (expanded.size() > settings.maxFloodVolume()) { - return PathResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); - } - } - } - } - } - return PathResult.accepted(List.copyOf(expanded)); - } - - private int selectNextAxis( - long sourceId, - int movesX, - int movesY, - int movesZ, - int usedX, - int usedY, - int usedZ - ) { - double scoreX = nextAxisScore(movesX, usedX); - double scoreY = nextAxisScore(movesY, usedY); - double scoreZ = nextAxisScore(movesZ, usedZ); - double minimum = Math.min(scoreX, Math.min(scoreY, scoreZ)); - int tieOffset = Math.floorMod(sourceId, 3); - for (int offset = 0; offset < 3; offset++) { - int axis = (tieOffset + offset) % 3; - double score = axis == 0 ? scoreX : axis == 1 ? scoreY : scoreZ; - if (score == minimum) { - return axis; - } - } - throw new IllegalStateException("No remaining throat axis"); - } - - private double nextAxisScore(int moves, int used) { - if (used >= moves) { - return Double.POSITIVE_INFINITY; - } - return ((2D * used) + 1D) / moves; - } - - private HydrologyCaveRejection validateThroatPosition( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - CavePosition position - ) { - if (!view.isInWorld(position)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, position); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - return rejectionForHazard(voxelAt(view, position), settings); - } - - private GrottoResult buildGrotto(HydrologyCaveSource source, HydrologyCavePlannerSettings settings) { - int horizontalRadius = settings.grottoHorizontalRadius(); - int verticalRadius = settings.grottoVerticalRadius(); - Set candidates = new LinkedHashSet<>(); - - for (int dx = -horizontalRadius; dx <= horizontalRadius; dx++) { - for (int dy = -verticalRadius; dy <= verticalRadius; dy++) { - for (int dz = -horizontalRadius; dz <= horizontalRadius; dz++) { - if (settings.grottoShape().contains(source, settings, dx, dy, dz)) { - candidates.add(source.target().offset(dx, dy, dz)); - if (candidates.size() > settings.maxFloodVolume()) { - return GrottoResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); - } - } - } - } - } - candidates.add(source.target()); - for (int offset = 1; offset <= settings.dryHeadroom(); offset++) { - CavePosition headroom = new CavePosition( - source.target().x(), source.waterHeadY() + offset, source.target().z()); - if (Math.abs(headroom.y() - source.target().y()) > verticalRadius) { - return GrottoResult.rejected(HydrologyCaveRejection.DRY_HEADROOM_LIMIT); - } - candidates.add(headroom); - if (candidates.size() > settings.maxFloodVolume()) { - return GrottoResult.rejected(HydrologyCaveRejection.VOLUME_LIMIT); - } - } - return GrottoResult.accepted(connectedGrotto(source.target(), candidates)); - } - - private Set connectedGrotto(CavePosition target, Set candidates) { - Queue queue = new ArrayDeque<>(); - Set connected = new LinkedHashSet<>(); - queue.add(target); - connected.add(target); - while (!queue.isEmpty()) { - CavePosition position = queue.remove(); - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (candidates.contains(neighbor) && connected.add(neighbor)) { - queue.add(neighbor); - } - } - } - return connected; - } - - private HydrologyCaveRejection validateGeneratedCarve( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - Set carve - ) { - for (CavePosition position : carve) { - if (!view.isInWorld(position)) { - return HydrologyCaveRejection.WORLD_BOUNDARY; - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, position); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return boundsRejection; - } - CaveVoxel voxel = voxelAt(view, position); - if (isGeneratedInletCarve(view, source, settings, position, voxel)) { - continue; - } - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return hazard; - } - if (voxel != CaveVoxel.SOLID) { - return HydrologyCaveRejection.GROTTO_INTERSECTION; - } - } - return HydrologyCaveRejection.NONE; - } - - private BoundaryResult validateGeneratedBoundary( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - Set carve - ) { - Set guards = new LinkedHashSet<>(); - for (CavePosition position : carve) { - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (carve.contains(neighbor)) { - continue; - } - if (isInletOpening(source, neighbor) - || isGeneratedInletOpening(view, source, settings, neighbor)) { - continue; - } - if (!view.isInWorld(neighbor)) { - return BoundaryResult.rejected(HydrologyCaveRejection.WORLD_BOUNDARY); - } - HydrologyCaveRejection boundsRejection = validateBounds(source, settings, neighbor); - if (boundsRejection != HydrologyCaveRejection.NONE) { - return BoundaryResult.rejected(boundsRejection); - } - CaveVoxel voxel = voxelAt(view, neighbor); - HydrologyCaveRejection hazard = rejectionForHazard(voxel, settings); - if (hazard != HydrologyCaveRejection.NONE) { - return BoundaryResult.rejected(hazard); - } - if (voxel != CaveVoxel.SOLID) { - return BoundaryResult.rejected(HydrologyCaveRejection.GROTTO_SHELL_OPEN); - } - guards.add(neighbor); - } - } - return BoundaryResult.accepted(guards); - } - - private void addChamberActions( - Map actions, - Collection positions, - int waterHeadY - ) { - for (CavePosition position : positions) { - HydrologyCaveAction action = position.y() <= waterHeadY - ? HydrologyCaveAction.WET_SOURCE - : HydrologyCaveAction.DRY_AIR; - actions.put(position, action); - } - } - - private void addThroatActions( - Map actions, - Collection throat, - HydrologyCaveSource source - ) { - for (CavePosition position : throat) { - HydrologyCaveAction action; - if (position.y() <= source.waterHeadY()) { - action = HydrologyCaveAction.WET_SOURCE; - } else if (source.mode() == HydrologyCaveMode.WATERFALL_POOL - || source.mode() == HydrologyCaveMode.GENERATED_GROTTO) { - action = HydrologyCaveAction.FALLING_FLUID; - } else { - action = HydrologyCaveAction.DRY_AIR; - } - actions.put(position, action); - } - } - - private void addSealGuards( - CaveVoxelView view, - HydrologyCaveSource source, - Map actions - ) { - Set guards = new LinkedHashSet<>(); - for (CavePosition position : List.copyOf(actions.keySet())) { - for (CavePosition direction : DIRECTIONS) { - CavePosition neighbor = position.offset(direction.x(), direction.y(), direction.z()); - if (actions.containsKey(neighbor) - || isInletOpening(source, neighbor) - || !view.isInWorld(neighbor)) { - continue; - } - if (voxelAt(view, neighbor) == CaveVoxel.SOLID) { - guards.add(neighbor); - } - } - } - for (CavePosition guard : guards) { - actions.put(guard, HydrologyCaveAction.SEAL_GUARD); - } - } - - private boolean isInletOpening(HydrologyCaveSource source, CavePosition position) { - return position.equals(source.entry().offset(0, 1, 0)); - } - - private boolean isGeneratedInletCarve( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - CavePosition position, - CaveVoxel voxel - ) { - if (voxel != CaveVoxel.CAVE_AIR && voxel != CaveVoxel.COMPATIBLE_FLUID) { - return false; - } - int extent = Math.max(0, settings.throatRadius() - 1); - long deltaX = (long) position.x() - source.entry().x(); - long deltaZ = (long) position.z() - source.entry().z(); - return position.y() >= source.entry().y() - extent - && position.y() <= source.entry().y() - && deltaX * deltaX + deltaZ * deltaZ <= (long) extent * extent - && view.isOpenToSurface(position); - } - - private boolean isGeneratedInletOpening( - CaveVoxelView view, - HydrologyCaveSource source, - HydrologyCavePlannerSettings settings, - CavePosition position - ) { - int radius = Math.max(1, settings.throatRadius()); - long deltaX = (long) position.x() - source.entry().x(); - long deltaZ = (long) position.z() - source.entry().z(); - return position.y() >= source.entry().y() - && position.y() <= source.entry().y() + 1 - && deltaX * deltaX + deltaZ * deltaZ < (long) radius * radius - && view.isOpenToSurface(position); - } - - private HydrologyCaveRejection validateSource(HydrologyCaveSource source) { + HydrologyCaveRejection validateSource(HydrologyCaveSource source) { if (source.entry().y() < source.waterHeadY()) { return HydrologyCaveRejection.INVALID_SOURCE; } @@ -1634,7 +669,7 @@ public final class HydrologyCaveContainmentPlanner { return HydrologyCaveRejection.NONE; } - private HydrologyCaveRejection validateBounds( + HydrologyCaveRejection validateBounds( HydrologyCaveSource source, HydrologyCavePlannerSettings settings, CavePosition position @@ -1663,7 +698,7 @@ public final class HydrologyCaveContainmentPlanner { return HydrologyCaveRejection.NONE; } - private HydrologyCaveRejection rejectionForTarget( + HydrologyCaveRejection rejectionForTarget( CaveVoxel voxel, HydrologyCavePlannerSettings settings ) { @@ -1671,7 +706,7 @@ public final class HydrologyCaveContainmentPlanner { return hazard == HydrologyCaveRejection.NONE ? HydrologyCaveRejection.NO_CAVE_TARGET : hazard; } - private HydrologyCaveRejection rejectionForHazard( + HydrologyCaveRejection rejectionForHazard( CaveVoxel voxel, HydrologyCavePlannerSettings settings ) { @@ -1687,7 +722,7 @@ public final class HydrologyCaveContainmentPlanner { }; } - private boolean isFluidReachable(CaveVoxel voxel, HydrologyCavePlannerSettings settings) { + boolean isFluidReachable(CaveVoxel voxel, HydrologyCavePlannerSettings settings) { return voxel == CaveVoxel.CAVE_AIR || (voxel == CaveVoxel.COMPATIBLE_FLUID && settings.existingFluidPolicy() != HydrologyCaveFluidPolicy.REJECT_EXISTING) @@ -1695,11 +730,11 @@ public final class HydrologyCaveContainmentPlanner { && settings.existingFluidPolicy() == HydrologyCaveFluidPolicy.REPLACE_CONTAINED); } - private CaveVoxel voxelAt(CaveVoxelView view, CavePosition position) { + CaveVoxel voxelAt(CaveVoxelView view, CavePosition position) { return Objects.requireNonNull(view.voxelAt(position)); } - private OptionalLong findWinningSourceId( + OptionalLong findWinningSourceId( Set positions, Map claimedBy ) { @@ -1716,7 +751,7 @@ public final class HydrologyCaveContainmentPlanner { return winner == null ? OptionalLong.empty() : OptionalLong.of(winner.sourceId()); } - private HydrologyCavePlan accepted( + HydrologyCavePlan accepted( CaveVoxelView view, HydrologyCaveSource source, Map actions @@ -1731,7 +766,7 @@ public final class HydrologyCaveContainmentPlanner { return accepted(source, actions, preconditions); } - private HydrologyCavePlan accepted( + HydrologyCavePlan accepted( HydrologyCaveSource source, Map actions, Map preconditions @@ -1745,7 +780,7 @@ public final class HydrologyCaveContainmentPlanner { ); } - private HydrologyCavePlan acceptedDecision(HydrologyCaveSource source) { + HydrologyCavePlan acceptedDecision(HydrologyCaveSource source) { return new HydrologyCavePlan( source, HydrologyCaveRejection.NONE, @@ -1755,7 +790,7 @@ public final class HydrologyCaveContainmentPlanner { ); } - private HydrologyCavePlan rejected(HydrologyCaveSource source, HydrologyCaveRejection rejection) { + HydrologyCavePlan rejected(HydrologyCaveSource source, HydrologyCaveRejection rejection) { return new HydrologyCavePlan( source, rejection, @@ -1765,7 +800,7 @@ public final class HydrologyCaveContainmentPlanner { ); } - private HydrologyCavePlan rejectedOverlap(HydrologyCaveSource source, long winnerSourceId) { + HydrologyCavePlan rejectedOverlap(HydrologyCaveSource source, long winnerSourceId) { return new HydrologyCavePlan( source, HydrologyCaveRejection.OVERLAPPING_SOURCE, @@ -1774,72 +809,4 @@ public final class HydrologyCaveContainmentPlanner { OptionalLong.of(winnerSourceId) ); } - - private record PathResult(List positions, HydrologyCaveRejection rejection) { - private static PathResult accepted(List positions) { - return new PathResult(List.copyOf(positions), HydrologyCaveRejection.NONE); - } - - private static PathResult rejected(HydrologyCaveRejection rejection) { - return new PathResult(List.of(), rejection); - } - } - - private record IndependentDecision( - HydrologyCaveRejection rejection, - List guards - ) { - private static IndependentDecision accepted(List guards) { - return new IndependentDecision(HydrologyCaveRejection.NONE, List.copyOf(guards)); - } - - private static IndependentDecision rejected(HydrologyCaveRejection rejection) { - return new IndependentDecision(rejection, List.of()); - } - } - - private record ComponentResult(Set positions, HydrologyCaveRejection rejection) { - private static ComponentResult accepted(Set positions) { - return new ComponentResult( - Collections.unmodifiableSet(new LinkedHashSet<>(positions)), - HydrologyCaveRejection.NONE - ); - } - - private static ComponentResult rejected(HydrologyCaveRejection rejection) { - return new ComponentResult(Set.of(), rejection); - } - } - - private record BoundaryResult(Set sealGuards, HydrologyCaveRejection rejection) { - private static BoundaryResult accepted(Set sealGuards) { - return new BoundaryResult( - Collections.unmodifiableSet(new LinkedHashSet<>(sealGuards)), - HydrologyCaveRejection.NONE - ); - } - - private static BoundaryResult rejected(HydrologyCaveRejection rejection) { - return new BoundaryResult(Set.of(), rejection); - } - } - - private record GrottoResult(Set positions, HydrologyCaveRejection rejection) { - private static GrottoResult accepted(Set positions) { - return new GrottoResult( - Collections.unmodifiableSet(new LinkedHashSet<>(positions)), - HydrologyCaveRejection.NONE - ); - } - - private static GrottoResult rejected(HydrologyCaveRejection rejection) { - return new GrottoResult(Set.of(), rejection); - } - } - - private record CaveClaimGroup( - HydrologyCaveCandidate candidate, - Map actions - ) { - } } diff --git a/core/src/main/java/art/arcane/iris/engine/hydrology/cave/RecordingCaveVoxelView.java b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/RecordingCaveVoxelView.java new file mode 100644 index 000000000..2b7b5534b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/engine/hydrology/cave/RecordingCaveVoxelView.java @@ -0,0 +1,96 @@ +package art.arcane.iris.engine.hydrology.cave; + +import java.util.Arrays; + +final class RecordingCaveVoxelView implements CaveVoxelView { + static final byte IN_WORLD = 0; + static final byte VOXEL = 1; + static final byte OPEN_TO_SURFACE = 2; + static final byte ABOVE_TERRAIN_SURFACE = 3; + private final CaveVoxelView delegate; + private final boolean observeColumnsOnly; + private CavePosition[] positions; + private byte[] operations; + private byte[] values; + private CavePositionIndex[] observed; + private int size; + + RecordingCaveVoxelView(CaveVoxelView delegate, boolean observeColumnsOnly) { + this.delegate = delegate; + this.observeColumnsOnly = observeColumnsOnly; + this.positions = new CavePosition[1024]; + this.operations = observeColumnsOnly ? new byte[0] : new byte[1024]; + this.values = observeColumnsOnly ? new byte[0] : new byte[1024]; + this.observed = observeColumnsOnly + ? new CavePositionIndex[]{new CavePositionIndex()} + : new CavePositionIndex[]{ + new CavePositionIndex(), + new CavePositionIndex(), + new CavePositionIndex(), + new CavePositionIndex() + }; + } + + @Override + public boolean isInWorld(CavePosition position) { + boolean result = delegate.isInWorld(position); + add(position, IN_WORLD, result ? 1 : 0); + return result; + } + + @Override + public CaveVoxel voxelAt(CavePosition position) { + CaveVoxel result = delegate.voxelAt(position); + add(position, VOXEL, result.ordinal()); + return result; + } + + @Override + public boolean isOpenToSurface(CavePosition position) { + boolean result = delegate.isOpenToSurface(position); + add(position, OPEN_TO_SURFACE, result ? 1 : 0); + return result; + } + + @Override + public boolean isAboveTerrainSurface(CavePosition position) { + boolean result = delegate.isAboveTerrainSurface(position); + add(position, ABOVE_TERRAIN_SURFACE, result ? 1 : 0); + return result; + } + + private void add(CavePosition position, byte operation, int value) { + int observedIndex = observeColumnsOnly ? 0 : operation; + int observedY = observeColumnsOnly ? 0 : position.y(); + if (!observed[observedIndex].add(position.x(), observedY, position.z())) { + return; + } + if (size == positions.length) { + int expandedSize = Math.multiplyExact(size, 2); + positions = Arrays.copyOf(positions, expandedSize); + if (!observeColumnsOnly) { + operations = Arrays.copyOf(operations, expandedSize); + values = Arrays.copyOf(values, expandedSize); + } + } + positions[size] = position; + if (!observeColumnsOnly) { + operations[size] = operation; + values[size] = (byte) value; + } + size++; + } + + CaveViewObservations snapshot() { + observed = null; + if (positions.length == 1024) { + return new CaveViewObservations( + Arrays.copyOf(positions, size), + observeColumnsOnly ? operations : Arrays.copyOf(operations, size), + observeColumnsOnly ? values : Arrays.copyOf(values, size), + size + ); + } + return new CaveViewObservations(positions, operations, values, size); + } +} From a4e22006e0df093da2d9075c3282c726c5ac1b12 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:07:40 -0400 Subject: [PATCH 26/35] Split jigsaw command tree - Move each jigsaw subgroup executor into its own top-level command class - Move the adoption plan store, handlers and helpers into CommandJigsawAdopt - Move the vanilla export lease and reporting helpers into CommandJigsawExports - Move the studio open lifecycle into CommandJigsawOpen - Point the jigsaw contract test at the relocated command types - Exclude the new jigsaw command sources from the generation revision scope --- .../iris/core/commands/CommandJigsaw.java | 1429 +---------------- .../core/commands/CommandJigsawAdopt.java | 424 +++++ .../core/commands/CommandJigsawConnector.java | 84 + .../core/commands/CommandJigsawExports.java | 159 ++ .../iris/core/commands/CommandJigsawOpen.java | 251 +++ .../core/commands/CommandJigsawPiece.java | 238 +++ .../iris/core/commands/CommandJigsawPool.java | 38 + .../core/commands/CommandJigsawPreview.java | 26 + .../core/commands/CommandJigsawRules.java | 74 + .../core/commands/CommandJigsawVariant.java | 169 ++ .../core/commands/CommandJigsawWorkcell.java | 81 + .../commands/CommandJigsawContractTest.java | 124 +- .../buildtools/GenerationRevisionScope.java | 10 + 13 files changed, 1634 insertions(+), 1473 deletions(-) create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawAdopt.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawConnector.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawExports.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawOpen.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPiece.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPool.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPreview.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawRules.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawVariant.java create mode 100644 adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawWorkcell.java diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java index 6c0d302c6..be5ee3411 100644 --- a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java @@ -2,23 +2,17 @@ package art.arcane.iris.core.commands; import art.arcane.iris.Iris; import art.arcane.iris.core.loader.IrisData; -import art.arcane.iris.core.pack.BrokenPackException; -import art.arcane.iris.core.runtime.WorldRuntimeControlService; import art.arcane.iris.core.runtime.StudioOpenCoordinator; import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarArchetype; -import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarTopology; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphMapper; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioProjectCreator; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioStructureEditor; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; import art.arcane.iris.core.service.JigsawStudioGraphEvaluation; import art.arcane.iris.core.service.JigsawStudioService; @@ -26,21 +20,9 @@ import art.arcane.iris.core.service.StudioSVC; import art.arcane.iris.core.structure.StructureImporter; import art.arcane.iris.core.structure.VillageImporter; import art.arcane.iris.core.structure.authoring.StructureKey; -import art.arcane.iris.core.structure.authoring.StructureOwnershipManifest; -import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; import art.arcane.iris.core.structure.authoring.StructureWriteResult; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionDiagnostic; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionInputKind; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionPlan; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionRequest; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionResult; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionService; -import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionStrategy; -import art.arcane.iris.core.structure.export.VanillaJigsawDatapackExporter; -import art.arcane.iris.core.structure.export.VanillaJigsawExportDiagnostic; import art.arcane.iris.core.structure.export.VanillaJigsawExportFormat; import art.arcane.iris.core.structure.export.VanillaJigsawExportRequest; -import art.arcane.iris.core.structure.export.VanillaJigsawExportResult; import art.arcane.iris.core.structure.export.VanillaJigsawExportSource; import art.arcane.iris.engine.framework.structure.PlanarJigsawWorkcellResolver; import art.arcane.iris.engine.object.IrisDimension; @@ -51,7 +33,6 @@ import art.arcane.iris.engine.object.IrisJigsawWorkcellArchetype; import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; -import art.arcane.iris.platform.bukkit.BukkitPlatform; import art.arcane.iris.util.common.director.DirectorExecutor; import art.arcane.iris.util.common.director.specialhandlers.IrisStructureHandler; import art.arcane.iris.util.common.format.C; @@ -63,18 +44,12 @@ import art.arcane.volmlib.util.director.DirectorParameterHandler; import art.arcane.volmlib.util.director.annotations.Director; import art.arcane.volmlib.util.director.annotations.Param; import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; -import org.bukkit.GameMode; import org.bukkit.Location; import org.bukkit.NamespacedKey; -import org.bukkit.World; -import org.bukkit.block.Block; -import org.bukkit.block.data.type.Jigsaw; import org.bukkit.entity.Player; import java.io.File; import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.LinkOption; import java.nio.file.Path; import java.util.HashSet; import java.util.Locale; @@ -83,24 +58,15 @@ import java.util.Objects; import java.util.Optional; import java.util.Set; import java.util.UUID; -import java.util.concurrent.CompletionException; import java.util.concurrent.ConcurrentHashMap; -import java.util.concurrent.atomic.AtomicBoolean; -import java.util.regex.Pattern; @Director(name = "jigsaw", aliases = {"jig", "jgs"}, description = "Iris Jigsaw Studio tools", origin = DirectorOrigin.PLAYER) public class CommandJigsaw implements DirectorExecutor { - private static final long DEFAULT_STUDIO_SEED = 1337L; + static final long DEFAULT_STUDIO_SEED = 1337L; static final StudioOpenCoordinator.StudioOpenKind STUDIO_OPEN_KIND = StudioOpenCoordinator.StudioOpenKind.JIGSAW; - private static final Pattern EXPORT_OUTPUT_NAME = Pattern.compile("[a-zA-Z0-9_-][a-zA-Z0-9._-]{0,127}"); - private static final Map PLAYER_PACKS = new ConcurrentHashMap<>(); - private static final Map ADOPTION_PLANS = new ConcurrentHashMap<>(); - private static final Map ADOPTION_SERVICES = new ConcurrentHashMap<>(); - private static final Set EXPORTING_PLAYERS = ConcurrentHashMap.newKeySet(); - private static final Set EXPORT_DESTINATIONS = ConcurrentHashMap.newKeySet(); - + static final Map PLAYER_PACKS = new ConcurrentHashMap<>(); private CommandJigsawPiece piece; private CommandJigsawPool pool; private CommandJigsawConnector connector; @@ -212,7 +178,7 @@ public class CommandJigsaw implements DirectorExecutor { data.invalidateStructureResources(); VolmitSender commandSender = sender(); commandSender.sendMessage(C.GREEN + result.message()); - openProject(player(), commandSender, dimension, targetKey, seed); + CommandJigsawOpen.openProject(player(), commandSender, dimension, targetKey, seed); } @Director(description = "Open an existing Iris jigsaw graph in transient Studio", @@ -224,129 +190,7 @@ public class CommandJigsaw implements DirectorExecutor { customHandler = IrisStructureHandler.class) String structure, @Param(description = "Studio world seed", defaultValue = "1337") long seed ) { - openProject(player(), sender(), dimension, structure, seed); - } - - private static void openProject( - Player targetPlayer, - VolmitSender commandSender, - IrisDimension dimension, - String structure, - long seed - ) { - UUID playerId = targetPlayer.getUniqueId(); - UUID ownerId = JigsawStudioActivation.activeOwnerId(); - if (ownerId != null && !ownerId.equals(playerId)) { - sendError(commandSender, "Jigsaw Studio is already owned by another player session."); - return; - } - UUID openingOwner = JigsawStudioActivation.openingOwnerId(); - if (openingOwner != null) { - sendError(commandSender, openingOwner.equals(playerId) - ? "Your Jigsaw Studio is already opening." - : "Jigsaw Studio is already opening for another player."); - return; - } - ActiveContext previous = active(targetPlayer); - if (ownerId != null && previous == null) { - sendError(commandSender, "Your active Jigsaw Studio binding is unavailable. Close it before opening another project."); - return; - } - ActiveContext dirty = findDirtyContext(); - if (dirty != null) { - sendError(commandSender, - "The current Jigsaw Studio is waiting for autosave. Wait for it to finish or close with discard=true."); - return; - } - IrisData data = requireData(dimension, commandSender); - if (data == null) { - return; - } - IrisStructure irisStructure = data.load(IrisStructure.class, structure, false); - if (irisStructure == null) { - sendError(commandSender, "No Iris jigsaw structure '" + structure + "' exists in this pack."); - return; - } - - JigsawStudioLayout layout; - try { - layout = JigsawStudioGraphMapper.map(data, irisStructure); - } catch (RuntimeException exception) { - Iris.reportError("Failed to map Jigsaw Studio graph '" + structure + "'.", exception); - sendError(commandSender, "Could not map this jigsaw graph: " + exception.getMessage()); - return; - } - String packKey = dimension.getLoadKey(); - if (!JigsawStudioActivation.tryBeginOpen(playerId)) { - sendError(commandSender, - "Jigsaw Studio began opening for another player. Try again after it finishes."); - return; - } - JigsawStudioService studioService = JigsawStudioService.get(); - UUID closingRequestId = previous == null ? null : previous.request().requestId(); - if (closingRequestId != null) { - JigsawStudioService.CloseStart closeStart = studioService.tryBeginClose( - closingRequestId, - playerId, - false); - if (closeStart != JigsawStudioService.CloseStart.STARTED) { - JigsawStudioActivation.finishOpen(playerId); - sendError(commandSender, closeStart == JigsawStudioService.CloseStart.SAVE_IN_PROGRESS - ? "The current Jigsaw Studio is saving. Wait for it to finish before opening another project." - : closeStart == JigsawStudioService.CloseStart.OPERATION_IN_PROGRESS - ? "The current Jigsaw Studio is loading a variant. Wait for it to finish before opening another project." - : closeStart == JigsawStudioService.CloseStart.DIRTY - ? "The current Jigsaw Studio is waiting for autosave. Wait for it to finish before opening another project." - : "The current Jigsaw Studio could not be reserved for replacement."); - return; - } - } - JigsawStudioActivation.StagedActivation staged; - try { - staged = JigsawStudioActivation.stage( - packKey, - structure, - layout.mode(), - compatibilityOf(irisStructure), - layout.cellDimensions(), - data, - layout, - playerId, - closingRequestId); - } catch (RuntimeException exception) { - JigsawStudioActivation.finishOpen(playerId); - studioService.cancelClose(closingRequestId); - Iris.reportError("Failed to stage Jigsaw Studio for '" + structure + "'.", exception); - sendError(commandSender, "Jigsaw Studio staging failed: " + exception.getMessage()); - return; - } - commandSender.sendMessage(C.GREEN + "Opening transient Jigsaw Studio for '" + structure + "' with " - + layout.bays().size() + " workcells."); - - try { - Iris.service(StudioSVC.class).openTracked( - commandSender, - seed, - packKey, - STUDIO_OPEN_KIND, - () -> beginStagedOpen(staged), - world -> finishOpen(targetPlayer, world, staged, studioService)) - .whenComplete((result, throwable) -> J.s(() -> finishOpenAttempt( - commandSender, - playerId, - structure, - closingRequestId, - studioService, - staged, - result, - throwable))); - } catch (Throwable exception) { - JigsawStudioActivation.finishOpen(playerId); - studioService.cancelClose(closingRequestId); - JigsawStudioActivation.rollback(staged); - Iris.reportError("Failed to open Jigsaw Studio for '" + structure + "'.", exception); - sendError(commandSender, "Jigsaw Studio open failed: " + exception.getMessage()); - } + CommandJigsawOpen.openProject(player(), sender(), dimension, structure, seed); } @Director(description = "Close the active Jigsaw Studio", sync = true, @@ -578,7 +422,7 @@ public class CommandJigsaw implements DirectorExecutor { } VanillaJigsawExportFormat exportFormat; try { - exportFormat = parseFormat(format); + exportFormat = CommandJigsawExports.parseFormat(format); } catch (IllegalArgumentException exception) { sendError(exception.getMessage()); return; @@ -587,7 +431,7 @@ public class CommandJigsaw implements DirectorExecutor { .toPath().toAbsolutePath().normalize(); Path destination; try { - destination = resolveExportDestination(exportRoot, output, exportFormat); + destination = CommandJigsawExports.resolveExportDestination(exportRoot, output, exportFormat); } catch (IllegalArgumentException exception) { sendError(exception.getMessage()); return; @@ -612,19 +456,19 @@ public class CommandJigsaw implements DirectorExecutor { JigsawStudioService studioService = JigsawStudioService.get(); JigsawStudioService.ExportStart exportStart = studioService.tryBeginExport(requestId, playerId); if (exportStart != JigsawStudioService.ExportStart.STARTED) { - sendError(exportStartError(exportStart)); + sendError(CommandJigsawExports.exportStartError(exportStart)); return; } - if (!beginExport(playerId, destination)) { + if (!CommandJigsawExports.beginExport(playerId, destination)) { studioService.finishExport(requestId); sendError("A vanilla Jigsaw export for this player or output is already in progress."); return; } - ExportLease lease = new ExportLease(() -> { - finishExport(playerId, destination); + CommandJigsawExports.ExportLease lease = new CommandJigsawExports.ExportLease(() -> { + CommandJigsawExports.finishExport(playerId, destination); studioService.finishExport(requestId); }); - ExportOperation operation = new ExportOperation( + CommandJigsawExports.ExportOperation operation = new CommandJigsawExports.ExportOperation( targetPlayer, sender(), requestId, @@ -634,7 +478,7 @@ public class CommandJigsaw implements DirectorExecutor { sender().sendMessage(C.GRAY + "Exporting '" + operation.structureKey() + "' in the background to " + destination + "..."); try { - J.a(() -> runExport(operation)); + J.a(() -> CommandJigsawExports.runExport(operation)); } catch (RuntimeException exception) { operation.lease().release(); Iris.reportError("Failed to schedule vanilla Jigsaw export for '" @@ -643,238 +487,11 @@ public class CommandJigsaw implements DirectorExecutor { } } - static String exportStartError(JigsawStudioService.ExportStart exportStart) { - Objects.requireNonNull(exportStart, "Jigsaw Studio export start status"); - return switch (exportStart) { - case NOT_ACTIVE -> "The active Jigsaw Studio is no longer available."; - case NOT_OWNER -> "Only the Jigsaw Studio owner can export this project."; - case DIRTY -> "Wait for the pending autosave or discard the edits before exporting the on-disk graph."; - case CLOSING -> "The active Jigsaw Studio is closing and cannot be exported."; - case SAVE_IN_PROGRESS -> "Wait for the current Jigsaw Studio save to finish before exporting."; - case OPERATION_IN_PROGRESS -> "Wait for the current Jigsaw Studio operation to finish before exporting."; - case IN_PROGRESS -> "A Jigsaw Studio export is already in progress."; - case STARTED -> throw new IllegalArgumentException("STARTED is not an export failure"); - }; - } - - static boolean beginExport(UUID playerId, Path destination) { - Objects.requireNonNull(playerId); - Path normalizedDestination = Objects.requireNonNull(destination).toAbsolutePath().normalize(); - if (!EXPORTING_PLAYERS.add(playerId)) { - return false; - } - if (EXPORT_DESTINATIONS.add(normalizedDestination)) { - return true; - } - EXPORTING_PLAYERS.remove(playerId); - return false; - } - - static void finishExport(UUID playerId, Path destination) { - EXPORTING_PLAYERS.remove(Objects.requireNonNull(playerId)); - EXPORT_DESTINATIONS.remove(Objects.requireNonNull(destination).toAbsolutePath().normalize()); - } - - private static void pruneAdoptionPlanBindings() { - for (Map.Entry entry : ADOPTION_PLANS.entrySet()) { - AdoptionPlanBinding binding = entry.getValue(); - if (binding.service().plan(entry.getKey()).isEmpty()) { - ADOPTION_PLANS.remove(entry.getKey(), binding); - } - } - } - - private static boolean studioIsActiveOrOpening() { + static boolean studioIsActiveOrOpening() { return JigsawStudioActivation.activeOwnerId() != null || JigsawStudioActivation.openingOwnerId() != null; } - private static void runAdoptionApply( - Player targetPlayer, - VolmitSender commandSender, - UUID planId, - AdoptionPlanBinding binding - ) { - if (studioIsActiveOrOpening()) { - ADOPTION_PLANS.putIfAbsent(planId, binding); - J.runEntity(targetPlayer, () -> sendError(commandSender, - "Close the active or opening Jigsaw Studio before applying an adoption plan.")); - return; - } - IrisStructureAdoptionResult result; - Throwable failure = null; - try { - result = binding.service().apply(binding.plan()); - } catch (Throwable throwable) { - result = null; - failure = throwable; - Iris.reportError("Failed to apply Jigsaw adoption plan '" + planId + "'.", throwable); - } - IrisStructureAdoptionResult completedResult = result; - Throwable completedFailure = failure; - J.runEntity(targetPlayer, () -> finishAdoptionApply( - targetPlayer, - commandSender, - binding, - completedResult, - completedFailure)); - } - - private static void runAdoptionInspect( - Player targetPlayer, - VolmitSender commandSender, - UUID ownerId, - IrisDimension dimension, - IrisData data, - Path root, - String sourceKey, - Optional targetKey, - IrisStructureAdoptionStrategy strategy - ) { - IrisStructureAdoptionService service = null; - IrisStructureAdoptionPlan plan = null; - Throwable failure = null; - try { - IrisStructureAdoptionInputKind inputKind = adoptionInputKind(root, sourceKey); - service = ADOPTION_SERVICES.computeIfAbsent(root, IrisStructureAdoptionService::new); - plan = service.inspect(new IrisStructureAdoptionRequest( - sourceKey, - targetKey, - strategy, - inputKind)); - } catch (Throwable throwable) { - failure = throwable; - Iris.reportError("Failed to inspect Jigsaw adoption source '" + sourceKey + "'.", throwable); - } - IrisStructureAdoptionService completedService = service; - IrisStructureAdoptionPlan completedPlan = plan; - Throwable completedFailure = failure; - J.runEntity(targetPlayer, () -> finishAdoptionInspect( - commandSender, - ownerId, - dimension, - data, - completedService, - completedPlan, - completedFailure)); - } - - private static void finishAdoptionInspect( - VolmitSender commandSender, - UUID ownerId, - IrisDimension dimension, - IrisData data, - IrisStructureAdoptionService service, - IrisStructureAdoptionPlan plan, - Throwable failure - ) { - if (failure != null || service == null || plan == null) { - sendError(commandSender, "Jigsaw adoption inspection failed: " - + (failure == null ? "no result" : failure.getMessage())); - return; - } - pruneAdoptionPlanBindings(); - if (service.plan(plan.planId()).isPresent()) { - ADOPTION_PLANS.put(plan.planId(), new AdoptionPlanBinding( - ownerId, dimension, data, service, plan)); - } - reportAdoptionPlan(commandSender, plan); - } - - private static void finishAdoptionApply( - Player targetPlayer, - VolmitSender commandSender, - AdoptionPlanBinding binding, - IrisStructureAdoptionResult result, - Throwable failure - ) { - if (failure != null || result == null) { - sendError(commandSender, "Jigsaw adoption failed: " - + (failure == null ? "no result" : failure.getMessage())); - return; - } - reportAdoptionResult(commandSender, result); - if (!result.successful()) { - return; - } - StructureKey target = result.receipt().orElseThrow().targetStructure(); - binding.data().invalidateStructureResources(); - openProject(targetPlayer, commandSender, binding.dimension(), target.path(), DEFAULT_STUDIO_SEED); - } - - private static void reportAdoptionPlan(VolmitSender commandSender, IrisStructureAdoptionPlan plan) { - C statusColor = plan.canApply() ? C.GREEN : C.RED; - commandSender.sendMessage(statusColor + "Adoption plan " + plan.planId() + " -> " - + plan.disposition() + " for " + plan.targetStructure().value() + "."); - commandSender.sendMessage(C.GRAY + "Resources=" + plan.resourceCount() - + ", bytes=" + plan.totalSourceBytes() - + ", errors=" + plan.errorCount() - + ", warnings=" + plan.warningCount() + "."); - for (IrisStructureAdoptionDiagnostic diagnostic : plan.diagnostics()) { - commandSender.sendMessage(adoptionColor(diagnostic).toString() + diagnostic.summary()); - } - if (plan.canApply()) { - commandSender.sendMessage(C.AQUA + "Apply with /iris jigsaw adopt apply " + plan.planId()); - } - } - - private static void reportAdoptionResult(VolmitSender commandSender, IrisStructureAdoptionResult result) { - commandSender.sendMessage((result.successful() ? C.GREEN : C.RED) - + "Adoption plan " + result.planId() + ": " + result.status() + "."); - for (IrisStructureAdoptionDiagnostic diagnostic : result.diagnostics()) { - commandSender.sendMessage(adoptionColor(diagnostic).toString() + diagnostic.summary()); - } - } - - private static C adoptionColor(IrisStructureAdoptionDiagnostic diagnostic) { - return switch (diagnostic.severity()) { - case ERROR -> C.RED; - case WARNING -> C.YELLOW; - case INFO -> C.GRAY; - }; - } - - private static void runExport(ExportOperation operation) { - VanillaJigsawExportResult result = null; - Throwable failure = null; - try { - result = new VanillaJigsawDatapackExporter().export(operation.request()); - } catch (Throwable throwable) { - failure = throwable; - Iris.reportError("Vanilla Jigsaw export failed for '" + operation.structureKey() + "'.", throwable); - } finally { - operation.lease().release(); - } - VanillaJigsawExportResult completedResult = result; - Throwable completedFailure = failure; - Runnable response = () -> reportExport(operation, completedResult, completedFailure); - J.runEntity(operation.player(), response); - } - - private static void reportExport( - ExportOperation operation, - VanillaJigsawExportResult result, - Throwable failure - ) { - if (failure != null || result == null) { - operation.sender().sendMessage(C.RED + "Background vanilla export for '" - + operation.structureKey() + "' failed: " - + (failure == null ? "no result" : failure.getMessage())); - return; - } - for (VanillaJigsawExportDiagnostic diagnostic : result.diagnostics()) { - C color = diagnostic.isBlocking() ? C.RED : C.YELLOW; - operation.sender().sendMessage(color.toString() + diagnostic.code() + ": " + diagnostic.message()); - } - ActiveContext current = active(operation.player()); - boolean sameSession = current != null - && current.request().requestId().equals(operation.requestId()); - String contextLabel = sameSession ? "Vanilla export" : "Background vanilla export for '" - + operation.structureKey() + "'"; - operation.sender().sendMessage((result.isSuccess() ? C.GREEN : C.RED) + contextLabel + " " - + result.status() + ": " + result.output()); - } - static ActiveContext active(Player player) { if (player == null) { return null; @@ -902,7 +519,7 @@ public class CommandJigsaw implements DirectorExecutor { return new ActiveContext(binding.packKey(), request, session); } - private static ActiveContext findDirtyContext() { + static ActiveContext findDirtyContext() { for (SessionBinding binding : PLAYER_PACKS.values()) { JigsawStudioActivation.Request request = JigsawStudioActivation.getRequest(binding.packKey()); JigsawStudioSession session = JigsawStudioActivation.getSession(binding.packKey()); @@ -927,7 +544,7 @@ public class CommandJigsaw implements DirectorExecutor { return requireData(dimension, sender()); } - private static IrisData requireData(IrisDimension dimension, VolmitSender commandSender) { + static IrisData requireData(IrisDimension dimension, VolmitSender commandSender) { IrisData data = dimension == null ? null : dimension.getLoader(); if (data == null) { sendError(commandSender, "Could not resolve the requested Iris pack dimension."); @@ -935,108 +552,11 @@ public class CommandJigsaw implements DirectorExecutor { return data; } - private static void beginStagedOpen(JigsawStudioActivation.StagedActivation staged) { - if (!JigsawStudioActivation.beginStagedGeneration(staged)) { - throw new IllegalStateException("The staged Jigsaw Studio activation is no longer current"); - } - } - - private static void finishOpenAttempt( - VolmitSender commandSender, - UUID playerId, - String structureKey, - UUID closingRequestId, - JigsawStudioService studioService, - JigsawStudioActivation.StagedActivation staged, - StudioOpenCoordinator.StudioOpenResult result, - Throwable throwable - ) { - JigsawStudioActivation.finishOpen(playerId); - if (throwable == null && result != null) { - studioService.cancelClose(closingRequestId); - return; - } - studioService.cancelClose(closingRequestId); - JigsawStudioActivation.rollback(staged); - Throwable failure = unwrapCompletionFailure(throwable == null - ? new IllegalStateException("Studio open completed without a result") - : throwable); - if (isExpectedOpenDenial(failure)) { - Iris.warn("Jigsaw Studio open for '%s' was denied: %s", - structureKey, failure.getMessage()); - return; - } - Iris.reportError("Failed to open Jigsaw Studio for '" + structureKey + "'.", failure); - sendError(commandSender, "Jigsaw Studio open failed: " + failure.getMessage()); - } - - private static void finishOpen( - Player targetPlayer, - World world, - JigsawStudioActivation.StagedActivation staged, - JigsawStudioService studioService - ) { - if (world == null) { - throw new IllegalStateException("Jigsaw Studio opened without a world"); - } - JigsawStudioActivation.Request request = staged.request(); - JigsawStudioSession session = staged.session(); - try { - WorldRuntimeControlService.get().applyObjectStudioWorldRules(world); - } catch (Throwable exception) { - Iris.reportError("Failed to apply Jigsaw Studio world rules for '" + world.getName() + "'.", exception); - } - JigsawStudioBay destination = initialBay(session.layout()); - Location target = destination == null - ? new Location(world, 0.5D, 66D, 0.5D) - : new Location( - world, - destination.bounds().originX() + destination.bounds().dimensions().width() / 2.0D, - destination.bounds().maxY() + 2.0D, - destination.bounds().originZ() + destination.bounds().dimensions().depth() / 2.0D); - if (destination != null) { - session.selectBay(destination.stableId()); - } - if (!JigsawStudioActivation.commit(staged)) { - throw new IllegalStateException("The staged Jigsaw Studio activation could not be committed"); - } - studioService.activationCommitted(world, request.requestId()); - PLAYER_PACKS.put(targetPlayer.getUniqueId(), new SessionBinding( - request.packKey(), request.requestId())); - try { - J.runEntity(targetPlayer, () -> BukkitPlatform.teleportAsync(targetPlayer, target) - .thenRun(() -> J.runEntity(targetPlayer, () -> targetPlayer.setGameMode(GameMode.CREATIVE)))); - } catch (RuntimeException exception) { - Iris.reportError("Failed to move the player to the committed Jigsaw Studio workcell.", exception); - } - } - - private static JigsawStudioBay initialBay(JigsawStudioLayout layout) { - for (JigsawStudioBay bay : layout.bays()) { - if (layout.defaultVariant(bay).isPresent()) { - return bay; - } - } - return layout.bays().isEmpty() ? null : layout.bays().getFirst(); - } - - private static Throwable unwrapCompletionFailure(Throwable failure) { - Throwable current = failure; - while (current instanceof CompletionException && current.getCause() != null) { - current = current.getCause(); - } - return current; - } - - static boolean isExpectedOpenDenial(Throwable failure) { - return unwrapCompletionFailure(failure) instanceof BrokenPackException; - } - private void sendError(String message) { sender().sendMessage(C.RED + message); } - private static void sendError(VolmitSender commandSender, String message) { + static void sendError(VolmitSender commandSender, String message) { commandSender.sendMessage(C.RED + message); } @@ -1056,7 +576,7 @@ public class CommandJigsaw implements DirectorExecutor { }; } - private static JigsawStudioCompatibilityTarget compatibilityOf(IrisStructure structure) { + static JigsawStudioCompatibilityTarget compatibilityOf(IrisStructure structure) { return structure.resolvedCompatibility() == IrisJigsawCompatibility.VANILLA_PORTABLE ? JigsawStudioCompatibilityTarget.VANILLA_PORTABLE : JigsawStudioCompatibilityTarget.IRIS_EXTENDED; @@ -1098,97 +618,6 @@ public class CommandJigsaw implements DirectorExecutor { + ". This Studio converter accepts registered jigsaw structures only."; } - static String parseAdoptionSource(String value) { - String normalized = Objects.requireNonNull(value, "Adoption source").trim() - .toLowerCase(Locale.ROOT); - StructureKey source = StructureKey.parse(normalized, "iris"); - if (!"iris".equals(source.namespace())) { - throw new IllegalArgumentException("Adoption sources must use the iris namespace."); - } - return source.path(); - } - - static Optional parseAdoptionTarget(String value) { - String normalized = Objects.requireNonNull(value, "Adoption target").trim() - .toLowerCase(Locale.ROOT); - if (normalized.isEmpty() || "auto".equals(normalized)) { - return Optional.empty(); - } - StructureKey target = StructureKey.parse(normalized, "iris"); - if (!"iris".equals(target.namespace())) { - throw new IllegalArgumentException("Adoption targets must use the iris namespace."); - } - return Optional.of(target); - } - - private static IrisStructureAdoptionStrategy parseAdoptionStrategy(String value) { - return switch (Objects.requireNonNull(value, "Adoption strategy").trim().toLowerCase(Locale.ROOT)) { - case "auto" -> IrisStructureAdoptionStrategy.AUTO; - case "in-place", "in_place", "inplace", "claim" -> IrisStructureAdoptionStrategy.IN_PLACE; - case "clone", "copy" -> IrisStructureAdoptionStrategy.CLONE; - default -> throw new IllegalArgumentException("Adoption strategy must be auto, in-place, or clone."); - }; - } - - static IrisStructureAdoptionInputKind adoptionInputKind(Path packRoot, String source) throws IOException { - Path root = canonicalAdoptionRoot(packRoot); - StructureKey sourceKey = new StructureKey("iris", parseAdoptionSource(source)); - Path manifestPath = new StructureTransactionWriter(root).ownershipManifestPath(sourceKey); - if (!Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - return IrisStructureAdoptionInputKind.UNOWNED_IRIS; - } - if (!Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Ownership manifest is not a regular file: " + manifestPath); - } - StructureOwnershipManifest manifest; - try { - manifest = StructureOwnershipManifest.fromJson(Files.readAllBytes(manifestPath)); - } catch (RuntimeException exception) { - throw new IOException("Invalid ownership manifest at " + manifestPath, exception); - } - if (!manifest.structure().equals(sourceKey)) { - throw new IOException("Ownership manifest at " + manifestPath - + " belongs to " + manifest.structure().value()); - } - return manifest.provenance().origin() == StructureOwnershipManifest.Origin.MANAGED_DATAPACK - ? IrisStructureAdoptionInputKind.MANAGED_DATAPACK - : IrisStructureAdoptionInputKind.UNOWNED_IRIS; - } - - private static Path canonicalAdoptionRoot(Path packRoot) throws IOException { - Path normalized = Objects.requireNonNull(packRoot, "Adoption pack root").toAbsolutePath().normalize(); - return Files.exists(normalized, LinkOption.NOFOLLOW_LINKS) ? normalized.toRealPath() : normalized; - } - - private static VanillaJigsawExportFormat parseFormat(String value) { - return switch (value.trim().toLowerCase(Locale.ROOT)) { - case "zip" -> VanillaJigsawExportFormat.ZIP; - case "directory", "dir", "folder" -> VanillaJigsawExportFormat.DIRECTORY; - default -> throw new IllegalArgumentException("Export format must be directory or zip."); - }; - } - - static Path resolveExportDestination( - Path exportRoot, - String output, - VanillaJigsawExportFormat format - ) { - Path root = Objects.requireNonNull(exportRoot, "Jigsaw export root").toAbsolutePath().normalize(); - String requested = Objects.requireNonNull(output, "Jigsaw export output name"); - String name = requested.trim(); - if (!name.equals(requested) || !EXPORT_OUTPUT_NAME.matcher(name).matches()) { - throw new IllegalArgumentException( - "Export output must be one file name using letters, numbers, '.', '_', or '-'."); - } - String fileName = format == VanillaJigsawExportFormat.ZIP && !name.endsWith(".zip") - ? name + ".zip" : name; - Path destination = root.resolve(fileName).normalize(); - if (destination.equals(root) || !root.equals(destination.getParent())) { - throw new IllegalArgumentException("Export output must be one artifact inside the Studio exports folder."); - } - return destination; - } - static JigsawStudioBay selectedBay(ActiveContext context) { String selected = context.session().selectedBayId().orElse(null); return selected == null ? null : context.session().layout().get(selected); @@ -1328,42 +757,7 @@ public class CommandJigsaw implements DirectorExecutor { } } - private record SessionBinding(String packKey, UUID requestId) { - } - - private record ExportOperation( - Player player, - VolmitSender sender, - UUID requestId, - String structureKey, - VanillaJigsawExportRequest request, - ExportLease lease - ) { - } - - static final class ExportLease { - private final Runnable release; - private final AtomicBoolean released; - - ExportLease(Runnable release) { - this.release = Objects.requireNonNull(release, "Jigsaw export lease release action"); - this.released = new AtomicBoolean(); - } - - void release() { - if (released.compareAndSet(false, true)) { - release.run(); - } - } - } - - private record AdoptionPlanBinding( - UUID ownerId, - IrisDimension dimension, - IrisData data, - IrisStructureAdoptionService service, - IrisStructureAdoptionPlan plan - ) { + record SessionBinding(String packKey, UUID requestId) { } public static final class JigsawModeHandler implements DirectorParameterHandler { @@ -1419,791 +813,4 @@ public class CommandJigsaw implements DirectorExecutor { } } - public static final class JigsawAdoptionStrategyHandler implements DirectorParameterHandler { - @Override - public KList getPossibilities() { - return new KList<>("auto", "in-place", "clone"); - } - - @Override - public String toString(String value) { - return value == null ? "" : value; - } - - @Override - public String parse(String input, boolean force) throws DirectorParsingException { - try { - return switch (parseAdoptionStrategy(input)) { - case AUTO -> "auto"; - case IN_PLACE -> "in-place"; - case CLONE -> "clone"; - }; - } catch (IllegalArgumentException exception) { - throw new DirectorParsingException(exception.getMessage()); - } - } - - @Override - public boolean supports(Class type) { - return type == String.class; - } - } - - public static final class JigsawAdoptionPlanHandler implements DirectorParameterHandler { - @Override - public KList getPossibilities() { - return new KList<>(); - } - - @Override - public String toString(String value) { - return value == null ? "" : value; - } - - @Override - public String parse(String input, boolean force) throws DirectorParsingException { - try { - return UUID.fromString(input).toString(); - } catch (IllegalArgumentException exception) { - throw new DirectorParsingException("Adoption plan ID must be a UUID."); - } - } - - @Override - public boolean supports(Class type) { - return type == String.class; - } - } - - @Director(name = "adopt", description = "Inspect and apply safe ownership adoption plans", - origin = DirectorOrigin.PLAYER) - public static class CommandJigsawAdopt implements DirectorExecutor { - @Director(description = "Inspect an Iris graph for safe Studio ownership adoption", sync = true, - origin = DirectorOrigin.PLAYER) - public void inspect( - @Param(description = "Pack dimension") IrisDimension dimension, - @Param(description = "Existing Iris structure key") String source, - @Param(description = "New owned Iris key, or auto", defaultValue = "auto") String target, - @Param(description = "auto, in-place, or clone", defaultValue = "auto", - customHandler = JigsawAdoptionStrategyHandler.class) String strategy - ) { - VolmitSender commandSender = sender(); - IrisData data = requireData(dimension, commandSender); - if (data == null) { - return; - } - String sourceKey; - Optional targetKey; - IrisStructureAdoptionStrategy adoptionStrategy; - Path root; - try { - sourceKey = parseAdoptionSource(source); - targetKey = parseAdoptionTarget(target); - adoptionStrategy = parseAdoptionStrategy(strategy); - root = canonicalAdoptionRoot(data.getDataFolder().toPath()); - } catch (IOException | IllegalArgumentException exception) { - sendError(commandSender, "Could not inspect adoption source: " + exception.getMessage()); - return; - } - Player targetPlayer = player(); - UUID ownerId = targetPlayer.getUniqueId(); - commandSender.sendMessage(C.GRAY + "Inspecting Jigsaw adoption source '" + sourceKey - + "' asynchronously..."); - try { - J.a(() -> runAdoptionInspect( - targetPlayer, - commandSender, - ownerId, - dimension, - data, - root, - sourceKey, - targetKey, - adoptionStrategy)); - } catch (RuntimeException exception) { - Iris.reportError("Failed to schedule Jigsaw adoption inspection for '" - + sourceKey + "'.", exception); - sendError(commandSender, "Jigsaw adoption inspection could not be scheduled: " - + exception.getMessage()); - } - } - - @Director(description = "Apply one inspected adoption plan without overwriting", sync = true, - origin = DirectorOrigin.PLAYER) - public void apply( - @Param(description = "Plan UUID returned by adopt inspect", - customHandler = JigsawAdoptionPlanHandler.class) String planId - ) { - VolmitSender commandSender = sender(); - UUID parsedPlanId; - try { - parsedPlanId = UUID.fromString(planId); - } catch (IllegalArgumentException exception) { - sendError(commandSender, "Adoption plan ID must be a UUID."); - return; - } - if (studioIsActiveOrOpening()) { - sendError(commandSender, - "Close the active or opening Jigsaw Studio before applying an adoption plan."); - return; - } - pruneAdoptionPlanBindings(); - AdoptionPlanBinding binding = ADOPTION_PLANS.get(parsedPlanId); - UUID playerId = player().getUniqueId(); - if (binding == null || !binding.ownerId().equals(playerId)) { - sendError(commandSender, "No active adoption plan '" + parsedPlanId - + "' belongs to your player session. Run adopt inspect again."); - return; - } - if (binding.service().plan(parsedPlanId).isEmpty()) { - ADOPTION_PLANS.remove(parsedPlanId, binding); - sendError(commandSender, "Adoption plan '" + parsedPlanId - + "' expired or was already consumed. Run adopt inspect again."); - return; - } - if (!ADOPTION_PLANS.remove(parsedPlanId, binding)) { - sendError(commandSender, "Adoption plan '" + parsedPlanId + "' is already being applied."); - return; - } - Player targetPlayer = player(); - commandSender.sendMessage(C.GRAY + "Applying adoption plan '" + parsedPlanId - + "' asynchronously without overwrite..."); - try { - J.a(() -> runAdoptionApply(targetPlayer, commandSender, parsedPlanId, binding)); - } catch (RuntimeException exception) { - ADOPTION_PLANS.putIfAbsent(parsedPlanId, binding); - Iris.reportError("Failed to schedule Jigsaw adoption plan '" + parsedPlanId + "'.", exception); - sendError(commandSender, "Jigsaw adoption could not be scheduled: " + exception.getMessage()); - } - } - } - - @Director(name = "connector", description = "Inspect and configure targeted jigsaw connectors", - origin = DirectorOrigin.PLAYER) - public static class CommandJigsawConnector implements DirectorExecutor { - @Director(description = "Set the Iris-only channel on the targeted jigsaw marker", sync = true, - origin = DirectorOrigin.PLAYER) - public void channel( - @Param(description = "Exact channel, or none to clear") String channel - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - Block target = player().getTargetBlockExact(8); - if (target == null || !(target.getBlockData() instanceof Jigsaw)) { - sendError(this, "Look directly at a jigsaw marker within eight blocks."); - return; - } - JigsawStudioBay bay = context.session().layout().findAt( - target.getX(), target.getY(), target.getZ()); - JigsawStudioVariant activeVariant = bay == null - ? null - : context.session().activeVariant(bay.stableId()).orElse(null); - if (activeVariant == null) { - sendError(this, "The targeted marker must be inside a workcell with an active variant."); - return; - } - if (!activeVariant.owned()) { - sendError(this, "The active variant is read-only. Adopt it into this project before editing it."); - return; - } - IrisObject object = context.request().source().getObjectLoader().load(activeVariant.objectKey()); - if (object == null) { - sendError(this, "The active variant object '" + activeVariant.objectKey() + "' is missing."); - return; - } - IrisPosition canonicalPosition = new IrisPosition( - target.getX() - bay.bounds().originX(), - target.getY() - bay.bounds().originY(), - target.getZ() - bay.bounds().originZ()); - IrisPosition position; - try { - position = activeVariant.canonicalToSourcePosition( - canonicalPosition, - new JigsawStudioCellDimensions(object.getW(), object.getH(), object.getD())); - } catch (IllegalArgumentException exception) { - sendError(this, "Connector channel update failed: " + exception.getMessage()); - return; - } - String normalized = channel == null || channel.isBlank() || "none".equalsIgnoreCase(channel) - ? "none" - : channel.trim(); - runGraphMutation(player(), context, () -> { - JigsawStudioGraphEditor.updateConnectorChannel( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - activeVariant.pieceKey(), - position, - channel); - return mappedMutationResult( - context, - "", - "", - "Persisted connector channel '" + normalized + "' on piece '" - + activeVariant.pieceKey() + "' at " + position.getX() + "," + position.getY() - + "," + position.getZ() + "."); - }); - } - } - - @Director(name = "pool", description = "Manage owned jigsaw pools", origin = DirectorOrigin.PLAYER) - public static class CommandJigsawPool implements DirectorExecutor { - @Director(description = "Create an empty owned jigsaw pool", sync = true, - origin = DirectorOrigin.PLAYER) - public void create( - @Param(description = "New owned pool resource key") String poolKey, - @Param(description = "Owned fallback pool key, or none", defaultValue = "none") - String fallbackPoolKey - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - String fallback = "none".equalsIgnoreCase(fallbackPoolKey) ? "" : fallbackPoolKey; - runGraphMutation(player(), context, () -> { - JigsawStudioGraphEditor.createPool( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - fallback); - return mappedMutationResult( - context, - "", - "", - "Created owned pool '" + poolKey + "' with fallback '" - + (fallback.isBlank() ? "none" : fallback) + "'."); - }); - } - } - - @Director(name = "piece", description = "Manage contextual Studio pieces", origin = DirectorOrigin.PLAYER) - public static class CommandJigsawPiece implements DirectorExecutor { - @Director(description = "Create an owned piece from the selected Studio topology", sync = true, - origin = DirectorOrigin.PLAYER) - public void create( - @Param(description = "Owned pool resource key") String poolKey, - @Param(description = "New owned piece and object key") String pieceKey, - @Param(description = "Positive selection weight", defaultValue = "1") int weight - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawPlanarTopology topology = null; - JigsawStudioBay targetWorkcell = context.session().layout().get(JigsawStudioLayout.SPATIAL_WORKCELL_ID); - if (context.session().layout().mode() == JigsawStudioMode.PLANAR_JIGSAW) { - Location location = player().getLocation(); - JigsawStudioBay contextual = context.session().layout().findAt( - location.getBlockX(), location.getBlockY(), location.getBlockZ()); - if (contextual == null) { - contextual = selectedBay(context); - } else { - context.session().selectBay(contextual.stableId()); - } - if (contextual == null || contextual.topology().isEmpty()) { - sendError(this, "Stand in or select a planar topology workcell before creating a variant."); - return; - } - topology = contextual.topology().get(); - targetWorkcell = contextual; - } - if (targetWorkcell == null) { - sendError(this, "The selected Jigsaw Studio workcell is no longer available."); - return; - } - JigsawPlanarTopology selectedTopology = topology; - String activationWorkcellId = targetWorkcell.stableId(); - JigsawStudioCellDimensions dimensions = targetWorkcell.capacity(); - String topologyText = selectedTopology == null ? "blank spatial" : selectedTopology.name(); - runGraphMutation(player(), context, () -> { - JigsawStudioGraphEditor.createPiece( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - pieceKey, - weight, - dimensions, - selectedTopology); - return mappedMutationResult( - context, - activationWorkcellId, - pieceKey, - "Created owned " + topologyText + " piece '" + pieceKey - + "' and added it to pool '" + poolKey + "' atomically."); - }); - } - - @Director(description = "Add an existing jigsaw piece to an owned pool transactionally", sync = true, - origin = DirectorOrigin.PLAYER) - public void add( - @Param(description = "Owned pool resource key") String poolKey, - @Param(description = "Existing jigsaw piece key") String pieceKey, - @Param(description = "Positive selection weight", defaultValue = "1") int weight - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - IrisJigsawPiece piece = context.request().source().getJigsawPieceLoader().load(pieceKey); - if (piece == null) { - sendError(this, "No jigsaw piece '" + pieceKey + "' exists in this pack."); - return; - } - if (piece.getObject() == null || piece.getObject().isBlank()) { - sendError(this, "Jigsaw piece '" + pieceKey + "' does not declare an object."); - return; - } - IrisObject object = context.request().source().getObjectLoader().load(piece.getObject()); - if (object == null) { - sendError(this, "Jigsaw piece '" + pieceKey + "' has no loadable object."); - return; - } - PieceWorkcellResolution resolution; - try { - resolution = resolvePieceWorkcell(context.session().layout(), piece, object); - } catch (IllegalArgumentException exception) { - sendError(this, "Jigsaw piece '" + pieceKey + "' cannot be assigned to a Studio workcell: " - + exception.getMessage()); - return; - } - if (!resolution.fits()) { - IrisPosition required = resolution.requiredDimensions(); - JigsawStudioCellDimensions capacity = resolution.workcell().capacity(); - sendError(this, "Jigsaw piece '" + pieceKey + "' requires " + required.getX() + "x" - + required.getY() + "x" + required.getZ() + " in " + resolution.workcell().displayName() - + ", but that workcell capacity is " + capacity.width() + "x" + capacity.height() - + "x" + capacity.depth() + "."); - return; - } - String objectKey = piece.getObject(); - runGraphMutation(player(), context, () -> { - if (!JigsawStudioGraphEditor.ownsPiece( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - pieceKey, - objectKey)) { - throw new IOException("Piece add accepts only piece/object resources already owned by this project; " - + "use piece create for a new owned piece"); - } - JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.addPiece( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - pieceKey, - weight); - if (!update.changed()) { - throw new IOException("The owned pool is missing or already references '" + pieceKey + "'"); - } - JigsawStudioLayout layout = loadPersistedLayout(context); - String activationWorkcellId = workcellIdForVariant(layout, pieceKey); - return new JigsawStudioService.CommandGraphMutationResult( - layout, - activationWorkcellId, - pieceKey, - "Added '" + pieceKey + "' to pool '" + poolKey + "' in one graph transaction."); - }); - } - - @Director(description = "Remove the selected piece from an owned pool transactionally", sync = true, - origin = DirectorOrigin.PLAYER) - public void remove( - @Param(description = "Owned pool resource key") String poolKey - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioVariant selected = selectedVariant(context); - if (selected == null) { - sendError(this, "Select a workcell with an active variant before removing its pool entry."); - return; - } - String pieceKey = selected.pieceKey(); - runGraphMutation(player(), context, () -> { - JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.removePiece( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - pieceKey); - if (!update.changed()) { - throw new IOException("The owned pool does not reference selected piece '" + pieceKey + "'"); - } - return mappedMutationResult( - context, - "", - "", - "Removed '" + pieceKey + "' from pool '" + poolKey + "' in one graph transaction."); - }); - } - - @Director(description = "Allow or forbid cardinal rotation of the selected piece", sync = true, - origin = DirectorOrigin.PLAYER) - public void rotatable( - @Param(description = "Whether the selected piece may rotate") boolean rotatable - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioVariant selected = selectedVariant(context); - if (selected == null) { - sendError(this, "Select a workcell with an active variant before changing rotation."); - return; - } - if (!rotatable - && context.request().compatibilityTarget() - == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { - sendError(this, "Vanilla-portable pieces must remain rotatable."); - return; - } - String pieceKey = selected.pieceKey(); - runGraphMutation(player(), context, () -> { - JigsawStudioGraphEditor.updateRotatable( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - pieceKey, - rotatable); - return mappedMutationResult( - context, - "", - "", - "Persisted piece '" + pieceKey + "' rotatable=" + rotatable + "."); - }); - } - - @Director(description = "Resize the selected piece object exactly to workcell capacity", sync = true, - origin = DirectorOrigin.PLAYER) - public void expand() { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay workcell = selectedBay(context); - if (workcell == null) { - sendError(this, "Select a workcell before expanding its active variant."); - return; - } - JigsawStudioService.get().expandVariantToCell(player(), workcell.stableId()); - } - } - - @Director(name = "workcell", aliases = "cell", description = "Manage the selected Studio workcell", - origin = DirectorOrigin.PLAYER) - public static class CommandJigsawWorkcell implements DirectorExecutor { - @Director(description = "Set capacity without resizing any variant object", sync = true, - origin = DirectorOrigin.PLAYER) - public void capacity( - @Param(description = "Capacity width") int width, - @Param(description = "Capacity height") int height, - @Param(description = "Capacity depth") int depth - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selected = selectedBay(context); - if (selected == null) { - sendError(this, "Select a workcell before changing its capacity."); - return; - } - JigsawStudioCellDimensions dimensions; - try { - dimensions = new JigsawStudioCellDimensions(width, height, depth); - } catch (IllegalArgumentException exception) { - sendError(this, exception.getMessage()); - return; - } - JigsawStudioService.get().updateWorkcellDimensions( - player(), - selected.stableId(), - dimensions); - } - - @Director(description = "Set the selected workcell's author-facing label", sync = true, - origin = DirectorOrigin.PLAYER) - public void label( - @Param(description = "Display label; quote labels containing spaces") String displayName - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selected = selectedBay(context); - if (selected == null) { - sendError(this, "Select a workcell before renaming it."); - return; - } - JigsawStudioService.get().updateWorkcellDisplayName( - player(), - selected.stableId(), - displayName); - } - - @Director(name = "label-reset", aliases = "reset-label", - description = "Reset the selected workcell to its canonical solver label", sync = true, - origin = DirectorOrigin.PLAYER) - public void labelReset() { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selected = selectedBay(context); - if (selected == null) { - sendError(this, "Select a workcell before resetting its label."); - return; - } - JigsawStudioService.get().updateWorkcellDisplayName(player(), selected.stableId(), ""); - } - } - - @Director(name = "variant", description = "Manage selected jigsaw variants", origin = DirectorOrigin.PLAYER) - public static class CommandJigsawVariant implements DirectorExecutor { - @Director(description = "Set the selected piece weight in a pool", sync = true, - origin = DirectorOrigin.PLAYER) - public void weight( - @Param(description = "Pool resource key") String poolKey, - @Param(description = "Positive selection weight") int weight - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioVariant selected = selectedVariant(context); - if (selected == null) { - sendError(this, "Select a workcell with an active variant before changing its weight."); - return; - } - String pieceKey = selected.pieceKey(); - runGraphMutation(player(), context, () -> { - JigsawStudioPoolEditor.WeightUpdate update = JigsawStudioPoolEditor.updateWeight( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - pieceKey, - weight); - if (!update.changed()) { - throw new IOException("Pool '" + poolKey + "' does not reference selected piece '" - + pieceKey + "'"); - } - return mappedMutationResult( - context, - "", - "", - "Updated " + update.changedEntries() + " pool entry weight atomically in " - + update.poolPath() + "."); - }); - } - - @Director(description = "Resize only the active variant object within workcell capacity", sync = true, - origin = DirectorOrigin.PLAYER) - public void resize( - @Param(description = "Variant width") int width, - @Param(description = "Variant height") int height, - @Param(description = "Variant depth") int depth - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selectedWorkcell = selectedBay(context); - JigsawStudioVariant selectedVariant = selectedVariant(context); - if (selectedWorkcell == null || selectedVariant == null) { - sendError(this, "Select a workcell with an active variant before resizing it."); - return; - } - JigsawStudioCellDimensions dimensions; - try { - dimensions = new JigsawStudioCellDimensions(width, height, depth); - } catch (IllegalArgumentException exception) { - sendError(this, exception.getMessage()); - return; - } - JigsawStudioService.get().resizeVariant( - player(), - selectedWorkcell.stableId(), - selectedVariant.pieceKey(), - dimensions); - } - - @Director(description = "Set the active variant's author-facing label", sync = true, - origin = DirectorOrigin.PLAYER) - public void label( - @Param(description = "Display label; quote labels containing spaces") String displayName - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selectedWorkcell = selectedBay(context); - JigsawStudioVariant selectedVariant = selectedVariant(context); - if (selectedWorkcell == null || selectedVariant == null) { - sendError(this, "Select a workcell with an active variant before renaming it."); - return; - } - JigsawStudioService.get().updateVariantDisplayName( - player(), - selectedWorkcell.stableId(), - selectedVariant.pieceKey(), - displayName); - } - - @Director(name = "label-reset", aliases = "reset-label", - description = "Reset the active variant to its resource-key label", sync = true, - origin = DirectorOrigin.PLAYER) - public void labelReset() { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selectedWorkcell = selectedBay(context); - JigsawStudioVariant selectedVariant = selectedVariant(context); - if (selectedWorkcell == null || selectedVariant == null) { - sendError(this, "Select a workcell with an active variant before resetting its label."); - return; - } - JigsawStudioService.get().updateVariantDisplayName( - player(), - selectedWorkcell.stableId(), - selectedVariant.pieceKey(), - ""); - } - - @Director(description = "Duplicate the active variant in only this workcell", sync = true, - origin = DirectorOrigin.PLAYER) - public void duplicate() { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - JigsawStudioBay selected = selectedBay(context); - if (selected == null || selectedVariant(context) == null) { - sendError(this, "Select a workcell with an active variant before duplicating it."); - return; - } - JigsawStudioService.get().createVariant(player(), selected.stableId(), true); - } - - @Director(name = "duplicate-family", aliases = "family", - description = "Duplicate every enabled workcell's active variant as one coherent family", - sync = true, origin = DirectorOrigin.PLAYER) - public void duplicateFamily( - @Param(description = "Family key or next", defaultValue = "next") String themeKey - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - String selectedTheme = themeKey; - if ("next".equalsIgnoreCase(themeKey)) { - try { - selectedTheme = nextThemeKey(context); - } catch (IOException | ArithmeticException exception) { - sendError(this, exception.getMessage()); - return; - } - } - JigsawStudioService.get().duplicateActiveFamily(player(), selectedTheme); - } - } - - @Director(name = "rules", aliases = "rule", description = "Manage structure-wide jigsaw rules", - origin = DirectorOrigin.PLAYER) - public static class CommandJigsawRules implements DirectorExecutor { - @Director(description = "Set maximum expansion depth and horizontal radius", sync = true, - origin = DirectorOrigin.PLAYER) - public void limits( - @Param(description = "Maximum expansion depth") int maxDepth, - @Param(description = "Maximum radius in chunks") int maxSizeChunks - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - if (context.request().compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - && (maxDepth > 20 || maxSizeChunks > 8)) { - sendError(this, "Vanilla-portable rules require maxDepth <= 20 and maxSizeChunks <= 8."); - return; - } - runGraphMutation(player(), context, () -> { - JigsawStudioStructureEditor.updateLimits( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - maxDepth, - maxSizeChunks); - return mappedMutationResult( - context, - "", - "", - "Persisted jigsaw limits: maxDepth=" + maxDepth - + ", maxSizeChunks=" + maxSizeChunks + "."); - }); - } - - @Director(description = "Set or clear one owned pool's direct fallback", sync = true, - origin = DirectorOrigin.PLAYER) - public void fallback( - @Param(description = "Owned pool resource key") String poolKey, - @Param(description = "Owned fallback pool key, or none") String fallbackPoolKey - ) { - ActiveContext context = active(player()); - if (context == null) { - sendError(this, "Open a Jigsaw Studio project first."); - return; - } - String fallback = "none".equalsIgnoreCase(fallbackPoolKey) ? "" : fallbackPoolKey; - runGraphMutation(player(), context, () -> { - JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.updateFallback( - context.request().source().getDataFolder().toPath(), - context.request().structureKey(), - poolKey, - fallback); - if (!update.changed()) { - return mappedMutationResult(context, "", "", "Pool fallback is unchanged."); - } - return mappedMutationResult( - context, - "", - "", - "Persisted pool '" + poolKey + "' fallback as '" - + (fallback.isBlank() ? "none" : fallback) + "'."); - }); - } - } - - @Director(name = "preview", description = "Assemble a read-only jigsaw preview", - origin = DirectorOrigin.PLAYER) - public static class CommandJigsawPreview implements DirectorExecutor { - @Director(name = "goto", aliases = "teleport", description = "Teleport to the live seed-1337 preview", - sync = true, origin = DirectorOrigin.PLAYER) - public void gotoPreview() { - JigsawStudioService.get().goToPreview(player()); - } - - @Director(description = "Assemble a deterministic preview at your location", sync = true, - origin = DirectorOrigin.PLAYER) - public void assemble( - @Param(description = "Assembly seed", defaultValue = "1337") long seed - ) { - JigsawStudioService.get().previewStudio(player(), seed); - } - - } } diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawAdopt.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawAdopt.java new file mode 100644 index 000000000..61babbe2e --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawAdopt.java @@ -0,0 +1,424 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.Iris; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.structure.authoring.StructureKey; +import art.arcane.iris.core.structure.authoring.StructureOwnershipManifest; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionDiagnostic; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionInputKind; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionPlan; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionRequest; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionResult; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionService; +import art.arcane.iris.core.structure.conversion.IrisStructureAdoptionStrategy; +import art.arcane.iris.engine.object.IrisDimension; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.plugin.VolmitSender; +import art.arcane.iris.util.common.scheduling.J; +import art.arcane.volmlib.util.collection.KList; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.DirectorParameterHandler; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; +import art.arcane.volmlib.util.director.exceptions.DirectorParsingException; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.LinkOption; +import java.nio.file.Path; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +@Director(name = "adopt", description = "Inspect and apply safe ownership adoption plans", + origin = DirectorOrigin.PLAYER) +public class CommandJigsawAdopt implements DirectorExecutor { + private static final Map ADOPTION_PLANS = new ConcurrentHashMap<>(); + private static final Map ADOPTION_SERVICES = new ConcurrentHashMap<>(); + + @Director(description = "Inspect an Iris graph for safe Studio ownership adoption", sync = true, + origin = DirectorOrigin.PLAYER) + public void inspect( + @Param(description = "Pack dimension") IrisDimension dimension, + @Param(description = "Existing Iris structure key") String source, + @Param(description = "New owned Iris key, or auto", defaultValue = "auto") String target, + @Param(description = "auto, in-place, or clone", defaultValue = "auto", + customHandler = JigsawAdoptionStrategyHandler.class) String strategy + ) { + VolmitSender commandSender = sender(); + IrisData data = CommandJigsaw.requireData(dimension, commandSender); + if (data == null) { + return; + } + String sourceKey; + Optional targetKey; + IrisStructureAdoptionStrategy adoptionStrategy; + Path root; + try { + sourceKey = parseAdoptionSource(source); + targetKey = parseAdoptionTarget(target); + adoptionStrategy = parseAdoptionStrategy(strategy); + root = canonicalAdoptionRoot(data.getDataFolder().toPath()); + } catch (IOException | IllegalArgumentException exception) { + CommandJigsaw.sendError(commandSender, "Could not inspect adoption source: " + exception.getMessage()); + return; + } + Player targetPlayer = player(); + UUID ownerId = targetPlayer.getUniqueId(); + commandSender.sendMessage(C.GRAY + "Inspecting Jigsaw adoption source '" + sourceKey + + "' asynchronously..."); + try { + J.a(() -> runAdoptionInspect( + targetPlayer, + commandSender, + ownerId, + dimension, + data, + root, + sourceKey, + targetKey, + adoptionStrategy)); + } catch (RuntimeException exception) { + Iris.reportError("Failed to schedule Jigsaw adoption inspection for '" + + sourceKey + "'.", exception); + CommandJigsaw.sendError(commandSender, "Jigsaw adoption inspection could not be scheduled: " + + exception.getMessage()); + } + } + + @Director(description = "Apply one inspected adoption plan without overwriting", sync = true, + origin = DirectorOrigin.PLAYER) + public void apply( + @Param(description = "Plan UUID returned by adopt inspect", + customHandler = JigsawAdoptionPlanHandler.class) String planId + ) { + VolmitSender commandSender = sender(); + UUID parsedPlanId; + try { + parsedPlanId = UUID.fromString(planId); + } catch (IllegalArgumentException exception) { + CommandJigsaw.sendError(commandSender, "Adoption plan ID must be a UUID."); + return; + } + if (CommandJigsaw.studioIsActiveOrOpening()) { + CommandJigsaw.sendError(commandSender, + "Close the active or opening Jigsaw Studio before applying an adoption plan."); + return; + } + pruneAdoptionPlanBindings(); + AdoptionPlanBinding binding = ADOPTION_PLANS.get(parsedPlanId); + UUID playerId = player().getUniqueId(); + if (binding == null || !binding.ownerId().equals(playerId)) { + CommandJigsaw.sendError(commandSender, "No active adoption plan '" + parsedPlanId + + "' belongs to your player session. Run adopt inspect again."); + return; + } + if (binding.service().plan(parsedPlanId).isEmpty()) { + ADOPTION_PLANS.remove(parsedPlanId, binding); + CommandJigsaw.sendError(commandSender, "Adoption plan '" + parsedPlanId + + "' expired or was already consumed. Run adopt inspect again."); + return; + } + if (!ADOPTION_PLANS.remove(parsedPlanId, binding)) { + CommandJigsaw.sendError(commandSender, "Adoption plan '" + parsedPlanId + "' is already being applied."); + return; + } + Player targetPlayer = player(); + commandSender.sendMessage(C.GRAY + "Applying adoption plan '" + parsedPlanId + + "' asynchronously without overwrite..."); + try { + J.a(() -> runAdoptionApply(targetPlayer, commandSender, parsedPlanId, binding)); + } catch (RuntimeException exception) { + ADOPTION_PLANS.putIfAbsent(parsedPlanId, binding); + Iris.reportError("Failed to schedule Jigsaw adoption plan '" + parsedPlanId + "'.", exception); + CommandJigsaw.sendError(commandSender, "Jigsaw adoption could not be scheduled: " + exception.getMessage()); + } + } + + private static void pruneAdoptionPlanBindings() { + for (Map.Entry entry : ADOPTION_PLANS.entrySet()) { + AdoptionPlanBinding binding = entry.getValue(); + if (binding.service().plan(entry.getKey()).isEmpty()) { + ADOPTION_PLANS.remove(entry.getKey(), binding); + } + } + } + + private static void runAdoptionApply( + Player targetPlayer, + VolmitSender commandSender, + UUID planId, + AdoptionPlanBinding binding + ) { + if (CommandJigsaw.studioIsActiveOrOpening()) { + ADOPTION_PLANS.putIfAbsent(planId, binding); + J.runEntity(targetPlayer, () -> CommandJigsaw.sendError(commandSender, + "Close the active or opening Jigsaw Studio before applying an adoption plan.")); + return; + } + IrisStructureAdoptionResult result; + Throwable failure = null; + try { + result = binding.service().apply(binding.plan()); + } catch (Throwable throwable) { + result = null; + failure = throwable; + Iris.reportError("Failed to apply Jigsaw adoption plan '" + planId + "'.", throwable); + } + IrisStructureAdoptionResult completedResult = result; + Throwable completedFailure = failure; + J.runEntity(targetPlayer, () -> finishAdoptionApply( + targetPlayer, + commandSender, + binding, + completedResult, + completedFailure)); + } + + private static void runAdoptionInspect( + Player targetPlayer, + VolmitSender commandSender, + UUID ownerId, + IrisDimension dimension, + IrisData data, + Path root, + String sourceKey, + Optional targetKey, + IrisStructureAdoptionStrategy strategy + ) { + IrisStructureAdoptionService service = null; + IrisStructureAdoptionPlan plan = null; + Throwable failure = null; + try { + IrisStructureAdoptionInputKind inputKind = adoptionInputKind(root, sourceKey); + service = ADOPTION_SERVICES.computeIfAbsent(root, IrisStructureAdoptionService::new); + plan = service.inspect(new IrisStructureAdoptionRequest( + sourceKey, + targetKey, + strategy, + inputKind)); + } catch (Throwable throwable) { + failure = throwable; + Iris.reportError("Failed to inspect Jigsaw adoption source '" + sourceKey + "'.", throwable); + } + IrisStructureAdoptionService completedService = service; + IrisStructureAdoptionPlan completedPlan = plan; + Throwable completedFailure = failure; + J.runEntity(targetPlayer, () -> finishAdoptionInspect( + commandSender, + ownerId, + dimension, + data, + completedService, + completedPlan, + completedFailure)); + } + + private static void finishAdoptionInspect( + VolmitSender commandSender, + UUID ownerId, + IrisDimension dimension, + IrisData data, + IrisStructureAdoptionService service, + IrisStructureAdoptionPlan plan, + Throwable failure + ) { + if (failure != null || service == null || plan == null) { + CommandJigsaw.sendError(commandSender, "Jigsaw adoption inspection failed: " + + (failure == null ? "no result" : failure.getMessage())); + return; + } + pruneAdoptionPlanBindings(); + if (service.plan(plan.planId()).isPresent()) { + ADOPTION_PLANS.put(plan.planId(), new AdoptionPlanBinding( + ownerId, dimension, data, service, plan)); + } + reportAdoptionPlan(commandSender, plan); + } + + private static void finishAdoptionApply( + Player targetPlayer, + VolmitSender commandSender, + AdoptionPlanBinding binding, + IrisStructureAdoptionResult result, + Throwable failure + ) { + if (failure != null || result == null) { + CommandJigsaw.sendError(commandSender, "Jigsaw adoption failed: " + + (failure == null ? "no result" : failure.getMessage())); + return; + } + reportAdoptionResult(commandSender, result); + if (!result.successful()) { + return; + } + StructureKey target = result.receipt().orElseThrow().targetStructure(); + binding.data().invalidateStructureResources(); + CommandJigsawOpen.openProject(targetPlayer, commandSender, binding.dimension(), target.path(), CommandJigsaw.DEFAULT_STUDIO_SEED); + } + + private static void reportAdoptionPlan(VolmitSender commandSender, IrisStructureAdoptionPlan plan) { + C statusColor = plan.canApply() ? C.GREEN : C.RED; + commandSender.sendMessage(statusColor + "Adoption plan " + plan.planId() + " -> " + + plan.disposition() + " for " + plan.targetStructure().value() + "."); + commandSender.sendMessage(C.GRAY + "Resources=" + plan.resourceCount() + + ", bytes=" + plan.totalSourceBytes() + + ", errors=" + plan.errorCount() + + ", warnings=" + plan.warningCount() + "."); + for (IrisStructureAdoptionDiagnostic diagnostic : plan.diagnostics()) { + commandSender.sendMessage(adoptionColor(diagnostic).toString() + diagnostic.summary()); + } + if (plan.canApply()) { + commandSender.sendMessage(C.AQUA + "Apply with /iris jigsaw adopt apply " + plan.planId()); + } + } + + private static void reportAdoptionResult(VolmitSender commandSender, IrisStructureAdoptionResult result) { + commandSender.sendMessage((result.successful() ? C.GREEN : C.RED) + + "Adoption plan " + result.planId() + ": " + result.status() + "."); + for (IrisStructureAdoptionDiagnostic diagnostic : result.diagnostics()) { + commandSender.sendMessage(adoptionColor(diagnostic).toString() + diagnostic.summary()); + } + } + + private static C adoptionColor(IrisStructureAdoptionDiagnostic diagnostic) { + return switch (diagnostic.severity()) { + case ERROR -> C.RED; + case WARNING -> C.YELLOW; + case INFO -> C.GRAY; + }; + } + + static String parseAdoptionSource(String value) { + String normalized = Objects.requireNonNull(value, "Adoption source").trim() + .toLowerCase(Locale.ROOT); + StructureKey source = StructureKey.parse(normalized, "iris"); + if (!"iris".equals(source.namespace())) { + throw new IllegalArgumentException("Adoption sources must use the iris namespace."); + } + return source.path(); + } + + static Optional parseAdoptionTarget(String value) { + String normalized = Objects.requireNonNull(value, "Adoption target").trim() + .toLowerCase(Locale.ROOT); + if (normalized.isEmpty() || "auto".equals(normalized)) { + return Optional.empty(); + } + StructureKey target = StructureKey.parse(normalized, "iris"); + if (!"iris".equals(target.namespace())) { + throw new IllegalArgumentException("Adoption targets must use the iris namespace."); + } + return Optional.of(target); + } + + private static IrisStructureAdoptionStrategy parseAdoptionStrategy(String value) { + return switch (Objects.requireNonNull(value, "Adoption strategy").trim().toLowerCase(Locale.ROOT)) { + case "auto" -> IrisStructureAdoptionStrategy.AUTO; + case "in-place", "in_place", "inplace", "claim" -> IrisStructureAdoptionStrategy.IN_PLACE; + case "clone", "copy" -> IrisStructureAdoptionStrategy.CLONE; + default -> throw new IllegalArgumentException("Adoption strategy must be auto, in-place, or clone."); + }; + } + + static IrisStructureAdoptionInputKind adoptionInputKind(Path packRoot, String source) throws IOException { + Path root = canonicalAdoptionRoot(packRoot); + StructureKey sourceKey = new StructureKey("iris", parseAdoptionSource(source)); + Path manifestPath = new StructureTransactionWriter(root).ownershipManifestPath(sourceKey); + if (!Files.exists(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + return IrisStructureAdoptionInputKind.UNOWNED_IRIS; + } + if (!Files.isRegularFile(manifestPath, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Ownership manifest is not a regular file: " + manifestPath); + } + StructureOwnershipManifest manifest; + try { + manifest = StructureOwnershipManifest.fromJson(Files.readAllBytes(manifestPath)); + } catch (RuntimeException exception) { + throw new IOException("Invalid ownership manifest at " + manifestPath, exception); + } + if (!manifest.structure().equals(sourceKey)) { + throw new IOException("Ownership manifest at " + manifestPath + + " belongs to " + manifest.structure().value()); + } + return manifest.provenance().origin() == StructureOwnershipManifest.Origin.MANAGED_DATAPACK + ? IrisStructureAdoptionInputKind.MANAGED_DATAPACK + : IrisStructureAdoptionInputKind.UNOWNED_IRIS; + } + + private static Path canonicalAdoptionRoot(Path packRoot) throws IOException { + Path normalized = Objects.requireNonNull(packRoot, "Adoption pack root").toAbsolutePath().normalize(); + return Files.exists(normalized, LinkOption.NOFOLLOW_LINKS) ? normalized.toRealPath() : normalized; + } + + private record AdoptionPlanBinding( + UUID ownerId, + IrisDimension dimension, + IrisData data, + IrisStructureAdoptionService service, + IrisStructureAdoptionPlan plan + ) { + } + + public static final class JigsawAdoptionStrategyHandler implements DirectorParameterHandler { + @Override + public KList getPossibilities() { + return new KList<>("auto", "in-place", "clone"); + } + + @Override + public String toString(String value) { + return value == null ? "" : value; + } + + @Override + public String parse(String input, boolean force) throws DirectorParsingException { + try { + return switch (parseAdoptionStrategy(input)) { + case AUTO -> "auto"; + case IN_PLACE -> "in-place"; + case CLONE -> "clone"; + }; + } catch (IllegalArgumentException exception) { + throw new DirectorParsingException(exception.getMessage()); + } + } + + @Override + public boolean supports(Class type) { + return type == String.class; + } + } + + public static final class JigsawAdoptionPlanHandler implements DirectorParameterHandler { + @Override + public KList getPossibilities() { + return new KList<>(); + } + + @Override + public String toString(String value) { + return value == null ? "" : value; + } + + @Override + public String parse(String input, boolean force) throws DirectorParsingException { + try { + return UUID.fromString(input).toString(); + } catch (IllegalArgumentException exception) { + throw new DirectorParsingException("Adoption plan ID must be a UUID."); + } + } + + @Override + public boolean supports(Class type) { + return type == String.class; + } + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawConnector.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawConnector.java new file mode 100644 index 000000000..d466fdd0a --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawConnector.java @@ -0,0 +1,84 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; +import org.bukkit.block.Block; +import org.bukkit.block.data.type.Jigsaw; + +@Director(name = "connector", description = "Inspect and configure targeted jigsaw connectors", + origin = DirectorOrigin.PLAYER) +public class CommandJigsawConnector implements DirectorExecutor { + @Director(description = "Set the Iris-only channel on the targeted jigsaw marker", sync = true, + origin = DirectorOrigin.PLAYER) + public void channel( + @Param(description = "Exact channel, or none to clear") String channel + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + Block target = player().getTargetBlockExact(8); + if (target == null || !(target.getBlockData() instanceof Jigsaw)) { + CommandJigsaw.sendError(this, "Look directly at a jigsaw marker within eight blocks."); + return; + } + JigsawStudioBay bay = context.session().layout().findAt( + target.getX(), target.getY(), target.getZ()); + JigsawStudioVariant activeVariant = bay == null + ? null + : context.session().activeVariant(bay.stableId()).orElse(null); + if (activeVariant == null) { + CommandJigsaw.sendError(this, "The targeted marker must be inside a workcell with an active variant."); + return; + } + if (!activeVariant.owned()) { + CommandJigsaw.sendError(this, "The active variant is read-only. Adopt it into this project before editing it."); + return; + } + IrisObject object = context.request().source().getObjectLoader().load(activeVariant.objectKey()); + if (object == null) { + CommandJigsaw.sendError(this, "The active variant object '" + activeVariant.objectKey() + "' is missing."); + return; + } + IrisPosition canonicalPosition = new IrisPosition( + target.getX() - bay.bounds().originX(), + target.getY() - bay.bounds().originY(), + target.getZ() - bay.bounds().originZ()); + IrisPosition position; + try { + position = activeVariant.canonicalToSourcePosition( + canonicalPosition, + new JigsawStudioCellDimensions(object.getW(), object.getH(), object.getD())); + } catch (IllegalArgumentException exception) { + CommandJigsaw.sendError(this, "Connector channel update failed: " + exception.getMessage()); + return; + } + String normalized = channel == null || channel.isBlank() || "none".equalsIgnoreCase(channel) + ? "none" + : channel.trim(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioGraphEditor.updateConnectorChannel( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + activeVariant.pieceKey(), + position, + channel); + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Persisted connector channel '" + normalized + "' on piece '" + + activeVariant.pieceKey() + "' at " + position.getX() + "," + position.getY() + + "," + position.getZ() + "."); + }); + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawExports.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawExports.java new file mode 100644 index 000000000..cd5239509 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawExports.java @@ -0,0 +1,159 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.Iris; +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.core.structure.export.VanillaJigsawDatapackExporter; +import art.arcane.iris.core.structure.export.VanillaJigsawExportDiagnostic; +import art.arcane.iris.core.structure.export.VanillaJigsawExportFormat; +import art.arcane.iris.core.structure.export.VanillaJigsawExportRequest; +import art.arcane.iris.core.structure.export.VanillaJigsawExportResult; +import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.plugin.VolmitSender; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.entity.Player; + +import java.nio.file.Path; +import java.util.Locale; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.regex.Pattern; + +final class CommandJigsawExports { + private static final Pattern EXPORT_OUTPUT_NAME = Pattern.compile("[a-zA-Z0-9_-][a-zA-Z0-9._-]{0,127}"); + private static final Set EXPORTING_PLAYERS = ConcurrentHashMap.newKeySet(); + private static final Set EXPORT_DESTINATIONS = ConcurrentHashMap.newKeySet(); + + private CommandJigsawExports() { + } + + static String exportStartError(JigsawStudioService.ExportStart exportStart) { + Objects.requireNonNull(exportStart, "Jigsaw Studio export start status"); + return switch (exportStart) { + case NOT_ACTIVE -> "The active Jigsaw Studio is no longer available."; + case NOT_OWNER -> "Only the Jigsaw Studio owner can export this project."; + case DIRTY -> "Wait for the pending autosave or discard the edits before exporting the on-disk graph."; + case CLOSING -> "The active Jigsaw Studio is closing and cannot be exported."; + case SAVE_IN_PROGRESS -> "Wait for the current Jigsaw Studio save to finish before exporting."; + case OPERATION_IN_PROGRESS -> "Wait for the current Jigsaw Studio operation to finish before exporting."; + case IN_PROGRESS -> "A Jigsaw Studio export is already in progress."; + case STARTED -> throw new IllegalArgumentException("STARTED is not an export failure"); + }; + } + + static boolean beginExport(UUID playerId, Path destination) { + Objects.requireNonNull(playerId); + Path normalizedDestination = Objects.requireNonNull(destination).toAbsolutePath().normalize(); + if (!EXPORTING_PLAYERS.add(playerId)) { + return false; + } + if (EXPORT_DESTINATIONS.add(normalizedDestination)) { + return true; + } + EXPORTING_PLAYERS.remove(playerId); + return false; + } + + static void finishExport(UUID playerId, Path destination) { + EXPORTING_PLAYERS.remove(Objects.requireNonNull(playerId)); + EXPORT_DESTINATIONS.remove(Objects.requireNonNull(destination).toAbsolutePath().normalize()); + } + + static void runExport(ExportOperation operation) { + VanillaJigsawExportResult result = null; + Throwable failure = null; + try { + result = new VanillaJigsawDatapackExporter().export(operation.request()); + } catch (Throwable throwable) { + failure = throwable; + Iris.reportError("Vanilla Jigsaw export failed for '" + operation.structureKey() + "'.", throwable); + } finally { + operation.lease().release(); + } + VanillaJigsawExportResult completedResult = result; + Throwable completedFailure = failure; + Runnable response = () -> reportExport(operation, completedResult, completedFailure); + J.runEntity(operation.player(), response); + } + + private static void reportExport( + ExportOperation operation, + VanillaJigsawExportResult result, + Throwable failure + ) { + if (failure != null || result == null) { + operation.sender().sendMessage(C.RED + "Background vanilla export for '" + + operation.structureKey() + "' failed: " + + (failure == null ? "no result" : failure.getMessage())); + return; + } + for (VanillaJigsawExportDiagnostic diagnostic : result.diagnostics()) { + C color = diagnostic.isBlocking() ? C.RED : C.YELLOW; + operation.sender().sendMessage(color.toString() + diagnostic.code() + ": " + diagnostic.message()); + } + CommandJigsaw.ActiveContext current = CommandJigsaw.active(operation.player()); + boolean sameSession = current != null + && current.request().requestId().equals(operation.requestId()); + String contextLabel = sameSession ? "Vanilla export" : "Background vanilla export for '" + + operation.structureKey() + "'"; + operation.sender().sendMessage((result.isSuccess() ? C.GREEN : C.RED) + contextLabel + " " + + result.status() + ": " + result.output()); + } + + static VanillaJigsawExportFormat parseFormat(String value) { + return switch (value.trim().toLowerCase(Locale.ROOT)) { + case "zip" -> VanillaJigsawExportFormat.ZIP; + case "directory", "dir", "folder" -> VanillaJigsawExportFormat.DIRECTORY; + default -> throw new IllegalArgumentException("Export format must be directory or zip."); + }; + } + + static Path resolveExportDestination( + Path exportRoot, + String output, + VanillaJigsawExportFormat format + ) { + Path root = Objects.requireNonNull(exportRoot, "Jigsaw export root").toAbsolutePath().normalize(); + String requested = Objects.requireNonNull(output, "Jigsaw export output name"); + String name = requested.trim(); + if (!name.equals(requested) || !EXPORT_OUTPUT_NAME.matcher(name).matches()) { + throw new IllegalArgumentException( + "Export output must be one file name using letters, numbers, '.', '_', or '-'."); + } + String fileName = format == VanillaJigsawExportFormat.ZIP && !name.endsWith(".zip") + ? name + ".zip" : name; + Path destination = root.resolve(fileName).normalize(); + if (destination.equals(root) || !root.equals(destination.getParent())) { + throw new IllegalArgumentException("Export output must be one artifact inside the Studio exports folder."); + } + return destination; + } + + record ExportOperation( + Player player, + VolmitSender sender, + UUID requestId, + String structureKey, + VanillaJigsawExportRequest request, + ExportLease lease + ) { + } + + static final class ExportLease { + private final Runnable release; + private final AtomicBoolean released; + + ExportLease(Runnable release) { + this.release = Objects.requireNonNull(release, "Jigsaw export lease release action"); + this.released = new AtomicBoolean(); + } + + void release() { + if (released.compareAndSet(false, true)) { + release.run(); + } + } + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawOpen.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawOpen.java new file mode 100644 index 000000000..da1575ba2 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawOpen.java @@ -0,0 +1,251 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.Iris; +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.pack.BrokenPackException; +import art.arcane.iris.core.runtime.WorldRuntimeControlService; +import art.arcane.iris.core.runtime.StudioOpenCoordinator; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphMapper; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.core.service.StudioSVC; +import art.arcane.iris.engine.object.IrisDimension; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.util.common.format.C; +import art.arcane.iris.util.common.plugin.VolmitSender; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.GameMode; +import org.bukkit.Location; +import org.bukkit.World; +import org.bukkit.entity.Player; + +import java.util.UUID; +import java.util.concurrent.CompletionException; + +final class CommandJigsawOpen { + private CommandJigsawOpen() { + } + + static void openProject( + Player targetPlayer, + VolmitSender commandSender, + IrisDimension dimension, + String structure, + long seed + ) { + UUID playerId = targetPlayer.getUniqueId(); + UUID ownerId = JigsawStudioActivation.activeOwnerId(); + if (ownerId != null && !ownerId.equals(playerId)) { + CommandJigsaw.sendError(commandSender, "Jigsaw Studio is already owned by another player session."); + return; + } + UUID openingOwner = JigsawStudioActivation.openingOwnerId(); + if (openingOwner != null) { + CommandJigsaw.sendError(commandSender, openingOwner.equals(playerId) + ? "Your Jigsaw Studio is already opening." + : "Jigsaw Studio is already opening for another player."); + return; + } + CommandJigsaw.ActiveContext previous = CommandJigsaw.active(targetPlayer); + if (ownerId != null && previous == null) { + CommandJigsaw.sendError(commandSender, "Your active Jigsaw Studio binding is unavailable. Close it before opening another project."); + return; + } + CommandJigsaw.ActiveContext dirty = CommandJigsaw.findDirtyContext(); + if (dirty != null) { + CommandJigsaw.sendError(commandSender, + "The current Jigsaw Studio is waiting for autosave. Wait for it to finish or close with discard=true."); + return; + } + IrisData data = CommandJigsaw.requireData(dimension, commandSender); + if (data == null) { + return; + } + IrisStructure irisStructure = data.load(IrisStructure.class, structure, false); + if (irisStructure == null) { + CommandJigsaw.sendError(commandSender, "No Iris jigsaw structure '" + structure + "' exists in this pack."); + return; + } + + JigsawStudioLayout layout; + try { + layout = JigsawStudioGraphMapper.map(data, irisStructure); + } catch (RuntimeException exception) { + Iris.reportError("Failed to map Jigsaw Studio graph '" + structure + "'.", exception); + CommandJigsaw.sendError(commandSender, "Could not map this jigsaw graph: " + exception.getMessage()); + return; + } + String packKey = dimension.getLoadKey(); + if (!JigsawStudioActivation.tryBeginOpen(playerId)) { + CommandJigsaw.sendError(commandSender, + "Jigsaw Studio began opening for another player. Try again after it finishes."); + return; + } + JigsawStudioService studioService = JigsawStudioService.get(); + UUID closingRequestId = previous == null ? null : previous.request().requestId(); + if (closingRequestId != null) { + JigsawStudioService.CloseStart closeStart = studioService.tryBeginClose( + closingRequestId, + playerId, + false); + if (closeStart != JigsawStudioService.CloseStart.STARTED) { + JigsawStudioActivation.finishOpen(playerId); + CommandJigsaw.sendError(commandSender, closeStart == JigsawStudioService.CloseStart.SAVE_IN_PROGRESS + ? "The current Jigsaw Studio is saving. Wait for it to finish before opening another project." + : closeStart == JigsawStudioService.CloseStart.OPERATION_IN_PROGRESS + ? "The current Jigsaw Studio is loading a variant. Wait for it to finish before opening another project." + : closeStart == JigsawStudioService.CloseStart.DIRTY + ? "The current Jigsaw Studio is waiting for autosave. Wait for it to finish before opening another project." + : "The current Jigsaw Studio could not be reserved for replacement."); + return; + } + } + JigsawStudioActivation.StagedActivation staged; + try { + staged = JigsawStudioActivation.stage( + packKey, + structure, + layout.mode(), + CommandJigsaw.compatibilityOf(irisStructure), + layout.cellDimensions(), + data, + layout, + playerId, + closingRequestId); + } catch (RuntimeException exception) { + JigsawStudioActivation.finishOpen(playerId); + studioService.cancelClose(closingRequestId); + Iris.reportError("Failed to stage Jigsaw Studio for '" + structure + "'.", exception); + CommandJigsaw.sendError(commandSender, "Jigsaw Studio staging failed: " + exception.getMessage()); + return; + } + commandSender.sendMessage(C.GREEN + "Opening transient Jigsaw Studio for '" + structure + "' with " + + layout.bays().size() + " workcells."); + + try { + Iris.service(StudioSVC.class).openTracked( + commandSender, + seed, + packKey, + CommandJigsaw.STUDIO_OPEN_KIND, + () -> beginStagedOpen(staged), + world -> finishOpen(targetPlayer, world, staged, studioService)) + .whenComplete((result, throwable) -> J.s(() -> finishOpenAttempt( + commandSender, + playerId, + structure, + closingRequestId, + studioService, + staged, + result, + throwable))); + } catch (Throwable exception) { + JigsawStudioActivation.finishOpen(playerId); + studioService.cancelClose(closingRequestId); + JigsawStudioActivation.rollback(staged); + Iris.reportError("Failed to open Jigsaw Studio for '" + structure + "'.", exception); + CommandJigsaw.sendError(commandSender, "Jigsaw Studio open failed: " + exception.getMessage()); + } + } + + private static void beginStagedOpen(JigsawStudioActivation.StagedActivation staged) { + if (!JigsawStudioActivation.beginStagedGeneration(staged)) { + throw new IllegalStateException("The staged Jigsaw Studio activation is no longer current"); + } + } + + private static void finishOpenAttempt( + VolmitSender commandSender, + UUID playerId, + String structureKey, + UUID closingRequestId, + JigsawStudioService studioService, + JigsawStudioActivation.StagedActivation staged, + StudioOpenCoordinator.StudioOpenResult result, + Throwable throwable + ) { + JigsawStudioActivation.finishOpen(playerId); + if (throwable == null && result != null) { + studioService.cancelClose(closingRequestId); + return; + } + studioService.cancelClose(closingRequestId); + JigsawStudioActivation.rollback(staged); + Throwable failure = unwrapCompletionFailure(throwable == null + ? new IllegalStateException("Studio open completed without a result") + : throwable); + if (isExpectedOpenDenial(failure)) { + Iris.warn("Jigsaw Studio open for '%s' was denied: %s", + structureKey, failure.getMessage()); + return; + } + Iris.reportError("Failed to open Jigsaw Studio for '" + structureKey + "'.", failure); + CommandJigsaw.sendError(commandSender, "Jigsaw Studio open failed: " + failure.getMessage()); + } + + private static void finishOpen( + Player targetPlayer, + World world, + JigsawStudioActivation.StagedActivation staged, + JigsawStudioService studioService + ) { + if (world == null) { + throw new IllegalStateException("Jigsaw Studio opened without a world"); + } + JigsawStudioActivation.Request request = staged.request(); + JigsawStudioSession session = staged.session(); + try { + WorldRuntimeControlService.get().applyObjectStudioWorldRules(world); + } catch (Throwable exception) { + Iris.reportError("Failed to apply Jigsaw Studio world rules for '" + world.getName() + "'.", exception); + } + JigsawStudioBay destination = initialBay(session.layout()); + Location target = destination == null + ? new Location(world, 0.5D, 66D, 0.5D) + : new Location( + world, + destination.bounds().originX() + destination.bounds().dimensions().width() / 2.0D, + destination.bounds().maxY() + 2.0D, + destination.bounds().originZ() + destination.bounds().dimensions().depth() / 2.0D); + if (destination != null) { + session.selectBay(destination.stableId()); + } + if (!JigsawStudioActivation.commit(staged)) { + throw new IllegalStateException("The staged Jigsaw Studio activation could not be committed"); + } + studioService.activationCommitted(world, request.requestId()); + CommandJigsaw.PLAYER_PACKS.put(targetPlayer.getUniqueId(), new CommandJigsaw.SessionBinding( + request.packKey(), request.requestId())); + try { + J.runEntity(targetPlayer, () -> BukkitPlatform.teleportAsync(targetPlayer, target) + .thenRun(() -> J.runEntity(targetPlayer, () -> targetPlayer.setGameMode(GameMode.CREATIVE)))); + } catch (RuntimeException exception) { + Iris.reportError("Failed to move the player to the committed Jigsaw Studio workcell.", exception); + } + } + + private static JigsawStudioBay initialBay(JigsawStudioLayout layout) { + for (JigsawStudioBay bay : layout.bays()) { + if (layout.defaultVariant(bay).isPresent()) { + return bay; + } + } + return layout.bays().isEmpty() ? null : layout.bays().getFirst(); + } + + private static Throwable unwrapCompletionFailure(Throwable failure) { + Throwable current = failure; + while (current instanceof CompletionException && current.getCause() != null) { + current = current.getCause(); + } + return current; + } + + static boolean isExpectedOpenDenial(Throwable failure) { + return unwrapCompletionFailure(failure) instanceof BrokenPackException; + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPiece.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPiece.java new file mode 100644 index 000000000..374c24ea6 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPiece.java @@ -0,0 +1,238 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarTopology; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; +import org.bukkit.Location; + +import java.io.IOException; + +@Director(name = "piece", description = "Manage contextual Studio pieces", origin = DirectorOrigin.PLAYER) +public class CommandJigsawPiece implements DirectorExecutor { + @Director(description = "Create an owned piece from the selected Studio topology", sync = true, + origin = DirectorOrigin.PLAYER) + public void create( + @Param(description = "Owned pool resource key") String poolKey, + @Param(description = "New owned piece and object key") String pieceKey, + @Param(description = "Positive selection weight", defaultValue = "1") int weight + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawPlanarTopology topology = null; + JigsawStudioBay targetWorkcell = context.session().layout().get(JigsawStudioLayout.SPATIAL_WORKCELL_ID); + if (context.session().layout().mode() == JigsawStudioMode.PLANAR_JIGSAW) { + Location location = player().getLocation(); + JigsawStudioBay contextual = context.session().layout().findAt( + location.getBlockX(), location.getBlockY(), location.getBlockZ()); + if (contextual == null) { + contextual = CommandJigsaw.selectedBay(context); + } else { + context.session().selectBay(contextual.stableId()); + } + if (contextual == null || contextual.topology().isEmpty()) { + CommandJigsaw.sendError(this, "Stand in or select a planar topology workcell before creating a variant."); + return; + } + topology = contextual.topology().get(); + targetWorkcell = contextual; + } + if (targetWorkcell == null) { + CommandJigsaw.sendError(this, "The selected Jigsaw Studio workcell is no longer available."); + return; + } + JigsawPlanarTopology selectedTopology = topology; + String activationWorkcellId = targetWorkcell.stableId(); + JigsawStudioCellDimensions dimensions = targetWorkcell.capacity(); + String topologyText = selectedTopology == null ? "blank spatial" : selectedTopology.name(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioGraphEditor.createPiece( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + pieceKey, + weight, + dimensions, + selectedTopology); + return CommandJigsaw.mappedMutationResult( + context, + activationWorkcellId, + pieceKey, + "Created owned " + topologyText + " piece '" + pieceKey + + "' and added it to pool '" + poolKey + "' atomically."); + }); + } + + @Director(description = "Add an existing jigsaw piece to an owned pool transactionally", sync = true, + origin = DirectorOrigin.PLAYER) + public void add( + @Param(description = "Owned pool resource key") String poolKey, + @Param(description = "Existing jigsaw piece key") String pieceKey, + @Param(description = "Positive selection weight", defaultValue = "1") int weight + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + IrisJigsawPiece piece = context.request().source().getJigsawPieceLoader().load(pieceKey); + if (piece == null) { + CommandJigsaw.sendError(this, "No jigsaw piece '" + pieceKey + "' exists in this pack."); + return; + } + if (piece.getObject() == null || piece.getObject().isBlank()) { + CommandJigsaw.sendError(this, "Jigsaw piece '" + pieceKey + "' does not declare an object."); + return; + } + IrisObject object = context.request().source().getObjectLoader().load(piece.getObject()); + if (object == null) { + CommandJigsaw.sendError(this, "Jigsaw piece '" + pieceKey + "' has no loadable object."); + return; + } + CommandJigsaw.PieceWorkcellResolution resolution; + try { + resolution = CommandJigsaw.resolvePieceWorkcell(context.session().layout(), piece, object); + } catch (IllegalArgumentException exception) { + CommandJigsaw.sendError(this, "Jigsaw piece '" + pieceKey + "' cannot be assigned to a Studio workcell: " + + exception.getMessage()); + return; + } + if (!resolution.fits()) { + IrisPosition required = resolution.requiredDimensions(); + JigsawStudioCellDimensions capacity = resolution.workcell().capacity(); + CommandJigsaw.sendError(this, "Jigsaw piece '" + pieceKey + "' requires " + required.getX() + "x" + + required.getY() + "x" + required.getZ() + " in " + resolution.workcell().displayName() + + ", but that workcell capacity is " + capacity.width() + "x" + capacity.height() + + "x" + capacity.depth() + "."); + return; + } + String objectKey = piece.getObject(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + if (!JigsawStudioGraphEditor.ownsPiece( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + pieceKey, + objectKey)) { + throw new IOException("Piece add accepts only piece/object resources already owned by this project; " + + "use piece create for a new owned piece"); + } + JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.addPiece( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + pieceKey, + weight); + if (!update.changed()) { + throw new IOException("The owned pool is missing or already references '" + pieceKey + "'"); + } + JigsawStudioLayout layout = CommandJigsaw.loadPersistedLayout(context); + String activationWorkcellId = CommandJigsaw.workcellIdForVariant(layout, pieceKey); + return new JigsawStudioService.CommandGraphMutationResult( + layout, + activationWorkcellId, + pieceKey, + "Added '" + pieceKey + "' to pool '" + poolKey + "' in one graph transaction."); + }); + } + + @Director(description = "Remove the selected piece from an owned pool transactionally", sync = true, + origin = DirectorOrigin.PLAYER) + public void remove( + @Param(description = "Owned pool resource key") String poolKey + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioVariant selected = CommandJigsaw.selectedVariant(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before removing its pool entry."); + return; + } + String pieceKey = selected.pieceKey(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.removePiece( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + pieceKey); + if (!update.changed()) { + throw new IOException("The owned pool does not reference selected piece '" + pieceKey + "'"); + } + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Removed '" + pieceKey + "' from pool '" + poolKey + "' in one graph transaction."); + }); + } + + @Director(description = "Allow or forbid cardinal rotation of the selected piece", sync = true, + origin = DirectorOrigin.PLAYER) + public void rotatable( + @Param(description = "Whether the selected piece may rotate") boolean rotatable + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioVariant selected = CommandJigsaw.selectedVariant(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before changing rotation."); + return; + } + if (!rotatable + && context.request().compatibilityTarget() + == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { + CommandJigsaw.sendError(this, "Vanilla-portable pieces must remain rotatable."); + return; + } + String pieceKey = selected.pieceKey(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioGraphEditor.updateRotatable( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + pieceKey, + rotatable); + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Persisted piece '" + pieceKey + "' rotatable=" + rotatable + "."); + }); + } + + @Director(description = "Resize the selected piece object exactly to workcell capacity", sync = true, + origin = DirectorOrigin.PLAYER) + public void expand() { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay workcell = CommandJigsaw.selectedBay(context); + if (workcell == null) { + CommandJigsaw.sendError(this, "Select a workcell before expanding its active variant."); + return; + } + JigsawStudioService.get().expandVariantToCell(player(), workcell.stableId()); + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPool.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPool.java new file mode 100644 index 000000000..9953188c3 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPool.java @@ -0,0 +1,38 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; + +@Director(name = "pool", description = "Manage owned jigsaw pools", origin = DirectorOrigin.PLAYER) +public class CommandJigsawPool implements DirectorExecutor { + @Director(description = "Create an empty owned jigsaw pool", sync = true, + origin = DirectorOrigin.PLAYER) + public void create( + @Param(description = "New owned pool resource key") String poolKey, + @Param(description = "Owned fallback pool key, or none", defaultValue = "none") + String fallbackPoolKey + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + String fallback = "none".equalsIgnoreCase(fallbackPoolKey) ? "" : fallbackPoolKey; + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioGraphEditor.createPool( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + fallback); + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Created owned pool '" + poolKey + "' with fallback '" + + (fallback.isBlank() ? "none" : fallback) + "'."); + }); + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPreview.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPreview.java new file mode 100644 index 000000000..173d99e1a --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPreview.java @@ -0,0 +1,26 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; + +@Director(name = "preview", description = "Assemble a read-only jigsaw preview", + origin = DirectorOrigin.PLAYER) +public class CommandJigsawPreview implements DirectorExecutor { + @Director(name = "goto", aliases = "teleport", description = "Teleport to the live seed-1337 preview", + sync = true, origin = DirectorOrigin.PLAYER) + public void gotoPreview() { + JigsawStudioService.get().goToPreview(player()); + } + + @Director(description = "Assemble a deterministic preview at your location", sync = true, + origin = DirectorOrigin.PLAYER) + public void assemble( + @Param(description = "Assembly seed", defaultValue = "1337") long seed + ) { + JigsawStudioService.get().previewStudio(player(), seed); + } + +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawRules.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawRules.java new file mode 100644 index 000000000..d8aa173e2 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawRules.java @@ -0,0 +1,74 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioStructureEditor; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; + +@Director(name = "rules", aliases = "rule", description = "Manage structure-wide jigsaw rules", + origin = DirectorOrigin.PLAYER) +public class CommandJigsawRules implements DirectorExecutor { + @Director(description = "Set maximum expansion depth and horizontal radius", sync = true, + origin = DirectorOrigin.PLAYER) + public void limits( + @Param(description = "Maximum expansion depth") int maxDepth, + @Param(description = "Maximum radius in chunks") int maxSizeChunks + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + if (context.request().compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + && (maxDepth > 20 || maxSizeChunks > 8)) { + CommandJigsaw.sendError(this, "Vanilla-portable rules require maxDepth <= 20 and maxSizeChunks <= 8."); + return; + } + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioStructureEditor.updateLimits( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + maxDepth, + maxSizeChunks); + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Persisted jigsaw limits: maxDepth=" + maxDepth + + ", maxSizeChunks=" + maxSizeChunks + "."); + }); + } + + @Director(description = "Set or clear one owned pool's direct fallback", sync = true, + origin = DirectorOrigin.PLAYER) + public void fallback( + @Param(description = "Owned pool resource key") String poolKey, + @Param(description = "Owned fallback pool key, or none") String fallbackPoolKey + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + String fallback = "none".equalsIgnoreCase(fallbackPoolKey) ? "" : fallbackPoolKey; + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioPoolEditor.PoolUpdate update = JigsawStudioPoolEditor.updateFallback( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + fallback); + if (!update.changed()) { + return CommandJigsaw.mappedMutationResult(context, "", "", "Pool fallback is unchanged."); + } + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Persisted pool '" + poolKey + "' fallback as '" + + (fallback.isBlank() ? "none" : fallback) + "'."); + }); + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawVariant.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawVariant.java new file mode 100644 index 000000000..1933cf389 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawVariant.java @@ -0,0 +1,169 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; + +import java.io.IOException; + +@Director(name = "variant", description = "Manage selected jigsaw variants", origin = DirectorOrigin.PLAYER) +public class CommandJigsawVariant implements DirectorExecutor { + @Director(description = "Set the selected piece weight in a pool", sync = true, + origin = DirectorOrigin.PLAYER) + public void weight( + @Param(description = "Pool resource key") String poolKey, + @Param(description = "Positive selection weight") int weight + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioVariant selected = CommandJigsaw.selectedVariant(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before changing its weight."); + return; + } + String pieceKey = selected.pieceKey(); + CommandJigsaw.runGraphMutation(player(), context, () -> { + JigsawStudioPoolEditor.WeightUpdate update = JigsawStudioPoolEditor.updateWeight( + context.request().source().getDataFolder().toPath(), + context.request().structureKey(), + poolKey, + pieceKey, + weight); + if (!update.changed()) { + throw new IOException("Pool '" + poolKey + "' does not reference selected piece '" + + pieceKey + "'"); + } + return CommandJigsaw.mappedMutationResult( + context, + "", + "", + "Updated " + update.changedEntries() + " pool entry weight atomically in " + + update.poolPath() + "."); + }); + } + + @Director(description = "Resize only the active variant object within workcell capacity", sync = true, + origin = DirectorOrigin.PLAYER) + public void resize( + @Param(description = "Variant width") int width, + @Param(description = "Variant height") int height, + @Param(description = "Variant depth") int depth + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selectedWorkcell = CommandJigsaw.selectedBay(context); + JigsawStudioVariant selectedVariant = CommandJigsaw.selectedVariant(context); + if (selectedWorkcell == null || selectedVariant == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before resizing it."); + return; + } + JigsawStudioCellDimensions dimensions; + try { + dimensions = new JigsawStudioCellDimensions(width, height, depth); + } catch (IllegalArgumentException exception) { + CommandJigsaw.sendError(this, exception.getMessage()); + return; + } + JigsawStudioService.get().resizeVariant( + player(), + selectedWorkcell.stableId(), + selectedVariant.pieceKey(), + dimensions); + } + + @Director(description = "Set the active variant's author-facing label", sync = true, + origin = DirectorOrigin.PLAYER) + public void label( + @Param(description = "Display label; quote labels containing spaces") String displayName + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selectedWorkcell = CommandJigsaw.selectedBay(context); + JigsawStudioVariant selectedVariant = CommandJigsaw.selectedVariant(context); + if (selectedWorkcell == null || selectedVariant == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before renaming it."); + return; + } + JigsawStudioService.get().updateVariantDisplayName( + player(), + selectedWorkcell.stableId(), + selectedVariant.pieceKey(), + displayName); + } + + @Director(name = "label-reset", aliases = "reset-label", + description = "Reset the active variant to its resource-key label", sync = true, + origin = DirectorOrigin.PLAYER) + public void labelReset() { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selectedWorkcell = CommandJigsaw.selectedBay(context); + JigsawStudioVariant selectedVariant = CommandJigsaw.selectedVariant(context); + if (selectedWorkcell == null || selectedVariant == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before resetting its label."); + return; + } + JigsawStudioService.get().updateVariantDisplayName( + player(), + selectedWorkcell.stableId(), + selectedVariant.pieceKey(), + ""); + } + + @Director(description = "Duplicate the active variant in only this workcell", sync = true, + origin = DirectorOrigin.PLAYER) + public void duplicate() { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selected = CommandJigsaw.selectedBay(context); + if (selected == null || CommandJigsaw.selectedVariant(context) == null) { + CommandJigsaw.sendError(this, "Select a workcell with an active variant before duplicating it."); + return; + } + JigsawStudioService.get().createVariant(player(), selected.stableId(), true); + } + + @Director(name = "duplicate-family", aliases = "family", + description = "Duplicate every enabled workcell's active variant as one coherent family", + sync = true, origin = DirectorOrigin.PLAYER) + public void duplicateFamily( + @Param(description = "Family key or next", defaultValue = "next") String themeKey + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + String selectedTheme = themeKey; + if ("next".equalsIgnoreCase(themeKey)) { + try { + selectedTheme = CommandJigsaw.nextThemeKey(context); + } catch (IOException | ArithmeticException exception) { + CommandJigsaw.sendError(this, exception.getMessage()); + return; + } + } + JigsawStudioService.get().duplicateActiveFamily(player(), selectedTheme); + } +} diff --git a/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawWorkcell.java b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawWorkcell.java new file mode 100644 index 000000000..8c0b99b81 --- /dev/null +++ b/adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawWorkcell.java @@ -0,0 +1,81 @@ +package art.arcane.iris.core.commands; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.service.JigsawStudioService; +import art.arcane.iris.util.common.director.DirectorExecutor; +import art.arcane.volmlib.util.director.DirectorOrigin; +import art.arcane.volmlib.util.director.annotations.Director; +import art.arcane.volmlib.util.director.annotations.Param; + +@Director(name = "workcell", aliases = "cell", description = "Manage the selected Studio workcell", + origin = DirectorOrigin.PLAYER) +public class CommandJigsawWorkcell implements DirectorExecutor { + @Director(description = "Set capacity without resizing any variant object", sync = true, + origin = DirectorOrigin.PLAYER) + public void capacity( + @Param(description = "Capacity width") int width, + @Param(description = "Capacity height") int height, + @Param(description = "Capacity depth") int depth + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selected = CommandJigsaw.selectedBay(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell before changing its capacity."); + return; + } + JigsawStudioCellDimensions dimensions; + try { + dimensions = new JigsawStudioCellDimensions(width, height, depth); + } catch (IllegalArgumentException exception) { + CommandJigsaw.sendError(this, exception.getMessage()); + return; + } + JigsawStudioService.get().updateWorkcellDimensions( + player(), + selected.stableId(), + dimensions); + } + + @Director(description = "Set the selected workcell's author-facing label", sync = true, + origin = DirectorOrigin.PLAYER) + public void label( + @Param(description = "Display label; quote labels containing spaces") String displayName + ) { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selected = CommandJigsaw.selectedBay(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell before renaming it."); + return; + } + JigsawStudioService.get().updateWorkcellDisplayName( + player(), + selected.stableId(), + displayName); + } + + @Director(name = "label-reset", aliases = "reset-label", + description = "Reset the selected workcell to its canonical solver label", sync = true, + origin = DirectorOrigin.PLAYER) + public void labelReset() { + CommandJigsaw.ActiveContext context = CommandJigsaw.active(player()); + if (context == null) { + CommandJigsaw.sendError(this, "Open a Jigsaw Studio project first."); + return; + } + JigsawStudioBay selected = CommandJigsaw.selectedBay(context); + if (selected == null) { + CommandJigsaw.sendError(this, "Select a workcell before resetting its label."); + return; + } + JigsawStudioService.get().updateWorkcellDisplayName(player(), selected.stableId(), ""); + } +} diff --git a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java index 58e5a00b3..e35ef220a 100644 --- a/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java +++ b/adapters/bukkit/plugin/src/test/java/art/arcane/iris/core/commands/CommandJigsawContractTest.java @@ -108,10 +108,10 @@ public class CommandJigsawContractTest { BrokenPackException failure = new BrokenPackException( "overworld", List.of("Biome 'broken' has no resolvable regions.")); - assertTrue(CommandJigsaw.isExpectedOpenDenial(failure)); - assertTrue(CommandJigsaw.isExpectedOpenDenial( + assertTrue(CommandJigsawOpen.isExpectedOpenDenial(failure)); + assertTrue(CommandJigsawOpen.isExpectedOpenDenial( new CompletionException(failure))); - assertFalse(CommandJigsaw.isExpectedOpenDenial( + assertFalse(CommandJigsawOpen.isExpectedOpenDenial( new IllegalStateException("Unexpected Studio failure"))); } @@ -138,20 +138,20 @@ public class CommandJigsawContractTest { @Test public void adoptionCommandsExposeTwoStepPlanContract() throws Exception { - Method inspect = CommandJigsaw.CommandJigsawAdopt.class.getDeclaredMethod( + Method inspect = CommandJigsawAdopt.class.getDeclaredMethod( "inspect", IrisDimension.class, String.class, String.class, String.class); - Method apply = CommandJigsaw.CommandJigsawAdopt.class.getDeclaredMethod("apply", String.class); + Method apply = CommandJigsawAdopt.class.getDeclaredMethod("apply", String.class); Parameter[] inspectParameters = inspect.getParameters(); assertNotNull(inspect.getAnnotation(Director.class)); assertNotNull(apply.getAnnotation(Director.class)); assertParameter(inspectParameters[2], "auto", null); - assertParameter(inspectParameters[3], "auto", CommandJigsaw.JigsawAdoptionStrategyHandler.class); - assertEquals(CommandJigsaw.JigsawAdoptionPlanHandler.class, + assertParameter(inspectParameters[3], "auto", CommandJigsawAdopt.JigsawAdoptionStrategyHandler.class); + assertEquals(CommandJigsawAdopt.JigsawAdoptionPlanHandler.class, apply.getParameters()[0].getAnnotation(Param.class).customHandler()); - CommandJigsaw.JigsawAdoptionStrategyHandler strategyHandler = - new CommandJigsaw.JigsawAdoptionStrategyHandler(); + CommandJigsawAdopt.JigsawAdoptionStrategyHandler strategyHandler = + new CommandJigsawAdopt.JigsawAdoptionStrategyHandler(); assertEquals(List.of("auto", "in-place", "clone"), strategyHandler.getPossibilities()); assertEquals("in-place", strategyHandler.parse("claim", false)); assertEquals("clone", strategyHandler.parse("copy", false)); @@ -163,14 +163,14 @@ public class CommandJigsawContractTest { Path root = temporaryFolder.newFolder("adoption-provenance").toPath(); assertEquals(IrisStructureAdoptionInputKind.UNOWNED_IRIS, - CommandJigsaw.adoptionInputKind(root, "unowned")); + CommandJigsawAdopt.adoptionInputKind(root, "unowned")); writeManifest(root, "datapack-created", StructureSource.Kind.DATAPACK, StructureOwnershipManifest.Provenance.created()); assertEquals(IrisStructureAdoptionInputKind.UNOWNED_IRIS, - CommandJigsaw.adoptionInputKind(root, "datapack-created")); + CommandJigsawAdopt.adoptionInputKind(root, "datapack-created")); writeManifest(root, "managed-provenance", StructureSource.Kind.IRIS, managedProvenance()); assertEquals(IrisStructureAdoptionInputKind.MANAGED_DATAPACK, - CommandJigsaw.adoptionInputKind(root, "managed-provenance")); + CommandJigsawAdopt.adoptionInputKind(root, "managed-provenance")); } @Test @@ -275,70 +275,70 @@ public class CommandJigsawContractTest { @Test public void exposesNestedPieceVariantAndPreviewCommands() throws Exception { - assertNotNull(CommandJigsaw.CommandJigsawPool.class + assertNotNull(CommandJigsawPool.class .getDeclaredMethod("create", String.class, String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawConnector.class + assertNotNull(CommandJigsawConnector.class .getDeclaredMethod("channel", String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPiece.class + assertNotNull(CommandJigsawPiece.class .getDeclaredMethod("create", String.class, String.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPiece.class + assertNotNull(CommandJigsawPiece.class .getDeclaredMethod("add", String.class, String.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPiece.class + assertNotNull(CommandJigsawPiece.class .getDeclaredMethod("remove", String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPiece.class + assertNotNull(CommandJigsawPiece.class .getDeclaredMethod("rotatable", boolean.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPiece.class + assertNotNull(CommandJigsawPiece.class .getDeclaredMethod("expand") .getAnnotation(Director.class)); assertEquals("Resize the selected piece object exactly to workcell capacity", - CommandJigsaw.CommandJigsawPiece.class + CommandJigsawPiece.class .getDeclaredMethod("expand") .getAnnotation(Director.class) .description()); - assertNotNull(CommandJigsaw.CommandJigsawVariant.class + assertNotNull(CommandJigsawVariant.class .getDeclaredMethod("weight", String.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawVariant.class + assertNotNull(CommandJigsawVariant.class .getDeclaredMethod("resize", int.class, int.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawVariant.class + assertNotNull(CommandJigsawVariant.class .getDeclaredMethod("label", String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawVariant.class + assertNotNull(CommandJigsawVariant.class .getDeclaredMethod("labelReset") .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawVariant.class + assertNotNull(CommandJigsawVariant.class .getDeclaredMethod("duplicate") .getAnnotation(Director.class)); - Method duplicateFamily = CommandJigsaw.CommandJigsawVariant.class + Method duplicateFamily = CommandJigsawVariant.class .getDeclaredMethod("duplicateFamily", String.class); assertNotNull(duplicateFamily.getAnnotation(Director.class)); assertParameter(duplicateFamily.getParameters()[0], "next", null); - assertNotNull(CommandJigsaw.CommandJigsawWorkcell.class + assertNotNull(CommandJigsawWorkcell.class .getDeclaredMethod("capacity", int.class, int.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawWorkcell.class + assertNotNull(CommandJigsawWorkcell.class .getDeclaredMethod("label", String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawWorkcell.class + assertNotNull(CommandJigsawWorkcell.class .getDeclaredMethod("labelReset") .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawRules.class + assertNotNull(CommandJigsawRules.class .getDeclaredMethod("limits", int.class, int.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawRules.class + assertNotNull(CommandJigsawRules.class .getDeclaredMethod("fallback", String.class, String.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPreview.class + assertNotNull(CommandJigsawPreview.class .getDeclaredMethod("assemble", long.class) .getAnnotation(Director.class)); - assertNotNull(CommandJigsaw.CommandJigsawPreview.class + assertNotNull(CommandJigsawPreview.class .getDeclaredMethod("gotoPreview") .getAnnotation(Director.class)); } @@ -393,14 +393,14 @@ public class CommandJigsawContractTest { public void everyExecutableCommandRejectsNonPlayerOrigins() { Class[] commandTypes = { CommandJigsaw.class, - CommandJigsaw.CommandJigsawConnector.class, - CommandJigsaw.CommandJigsawPool.class, - CommandJigsaw.CommandJigsawPiece.class, - CommandJigsaw.CommandJigsawVariant.class, - CommandJigsaw.CommandJigsawWorkcell.class, - CommandJigsaw.CommandJigsawRules.class, - CommandJigsaw.CommandJigsawPreview.class, - CommandJigsaw.CommandJigsawAdopt.class + CommandJigsawConnector.class, + CommandJigsawPool.class, + CommandJigsawPiece.class, + CommandJigsawVariant.class, + CommandJigsawWorkcell.class, + CommandJigsawRules.class, + CommandJigsawPreview.class, + CommandJigsawAdopt.class }; for (Class commandType : commandTypes) { @@ -417,17 +417,17 @@ public class CommandJigsawContractTest { public void exportOutputIsOneSafeChildArtifact() { Path root = Path.of("build", "jigsaw-exports").toAbsolutePath().normalize(); - assertEquals(root.resolve("village.zip"), CommandJigsaw.resolveExportDestination( + assertEquals(root.resolve("village.zip"), CommandJigsawExports.resolveExportDestination( root, "village", VanillaJigsawExportFormat.ZIP)); - assertEquals(root.resolve("village"), CommandJigsaw.resolveExportDestination( + assertEquals(root.resolve("village"), CommandJigsawExports.resolveExportDestination( root, "village", VanillaJigsawExportFormat.DIRECTORY)); - assertThrows(IllegalArgumentException.class, () -> CommandJigsaw.resolveExportDestination( + assertThrows(IllegalArgumentException.class, () -> CommandJigsawExports.resolveExportDestination( root, "", VanillaJigsawExportFormat.DIRECTORY)); - assertThrows(IllegalArgumentException.class, () -> CommandJigsaw.resolveExportDestination( + assertThrows(IllegalArgumentException.class, () -> CommandJigsawExports.resolveExportDestination( root, ".", VanillaJigsawExportFormat.DIRECTORY)); - assertThrows(IllegalArgumentException.class, () -> CommandJigsaw.resolveExportDestination( + assertThrows(IllegalArgumentException.class, () -> CommandJigsawExports.resolveExportDestination( root, "../all-exports", VanillaJigsawExportFormat.DIRECTORY)); - assertThrows(IllegalArgumentException.class, () -> CommandJigsaw.resolveExportDestination( + assertThrows(IllegalArgumentException.class, () -> CommandJigsawExports.resolveExportDestination( root, "nested/export", VanillaJigsawExportFormat.DIRECTORY)); } @@ -438,42 +438,42 @@ public class CommandJigsawContractTest { Path firstDestination = Path.of("build", "jigsaw-exports", "first.zip"); Path secondDestination = Path.of("build", "jigsaw-exports", "second.zip"); - assertEquals(true, CommandJigsaw.beginExport(firstPlayer, firstDestination)); + assertEquals(true, CommandJigsawExports.beginExport(firstPlayer, firstDestination)); try { - assertEquals(false, CommandJigsaw.beginExport(firstPlayer, secondDestination)); - assertEquals(false, CommandJigsaw.beginExport(secondPlayer, firstDestination)); + assertEquals(false, CommandJigsawExports.beginExport(firstPlayer, secondDestination)); + assertEquals(false, CommandJigsawExports.beginExport(secondPlayer, firstDestination)); } finally { - CommandJigsaw.finishExport(firstPlayer, firstDestination); + CommandJigsawExports.finishExport(firstPlayer, firstDestination); } - assertEquals(true, CommandJigsaw.beginExport(secondPlayer, firstDestination)); - CommandJigsaw.finishExport(secondPlayer, firstDestination); + assertEquals(true, CommandJigsawExports.beginExport(secondPlayer, firstDestination)); + CommandJigsawExports.finishExport(secondPlayer, firstDestination); } @Test public void exportStartFailuresHavePreciseOperatorMessages() { assertEquals("The active Jigsaw Studio is no longer available.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.NOT_ACTIVE)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.NOT_ACTIVE)); assertEquals("Only the Jigsaw Studio owner can export this project.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.NOT_OWNER)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.NOT_OWNER)); assertEquals("Wait for the pending autosave or discard the edits before exporting the on-disk graph.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.DIRTY)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.DIRTY)); assertEquals("The active Jigsaw Studio is closing and cannot be exported.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.CLOSING)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.CLOSING)); assertEquals("Wait for the current Jigsaw Studio save to finish before exporting.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.SAVE_IN_PROGRESS)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.SAVE_IN_PROGRESS)); assertEquals("Wait for the current Jigsaw Studio operation to finish before exporting.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.OPERATION_IN_PROGRESS)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.OPERATION_IN_PROGRESS)); assertEquals("A Jigsaw Studio export is already in progress.", - CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.IN_PROGRESS)); + CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.IN_PROGRESS)); assertThrows(IllegalArgumentException.class, - () -> CommandJigsaw.exportStartError(JigsawStudioService.ExportStart.STARTED)); + () -> CommandJigsawExports.exportStartError(JigsawStudioService.ExportStart.STARTED)); } @Test public void exportLeaseReleaseActionRunsExactlyOnce() { AtomicInteger releases = new AtomicInteger(); - CommandJigsaw.ExportLease lease = new CommandJigsaw.ExportLease(releases::incrementAndGet); + CommandJigsawExports.ExportLease lease = new CommandJigsawExports.ExportLease(releases::incrementAndGet); lease.release(); lease.release(); diff --git a/buildSrc/src/main/java/art/arcane/iris/buildtools/GenerationRevisionScope.java b/buildSrc/src/main/java/art/arcane/iris/buildtools/GenerationRevisionScope.java index cac3eb581..34370e81a 100644 --- a/buildSrc/src/main/java/art/arcane/iris/buildtools/GenerationRevisionScope.java +++ b/buildSrc/src/main/java/art/arcane/iris/buildtools/GenerationRevisionScope.java @@ -35,6 +35,16 @@ public final class GenerationRevisionScope { "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandPregen.java", "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandIris.java", "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsaw.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawAdopt.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawConnector.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawExports.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawOpen.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPiece.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPool.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawPreview.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawRules.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawVariant.java", + "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandJigsawWorkcell.java", "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandStudio.java", "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/CommandObject.java", "adapters/bukkit/plugin/src/main/java/art/arcane/iris/core/commands/PaperCommandRegistrar.java", From e7c6b6e08e83febd753a5e5d06b7d0ad38296b74 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:25:00 -0400 Subject: [PATCH 27/35] Split jigsaw graph editor - Move planar object resize geometry into JigsawStudioObjectResizer - Move owned graph JSON document transforms into JigsawStudioGraphDocuments - Move owned graph reference checks into JigsawStudioGraphInspector - Point the graph editor resize test at the relocated resizer - Add a scripted studio persistence session digest test over project and history bytes --- .../jigsaw/JigsawStudioGraphDocuments.java | 305 +++++ .../jigsaw/JigsawStudioGraphEditor.java | 1017 +---------------- .../jigsaw/JigsawStudioGraphInspector.java | 153 +++ .../jigsaw/JigsawStudioObjectResizer.java | 548 +++++++++ .../JigsawStudioGraphEditorResizeTest.java | 8 +- .../JigsawStudioPersistenceIdentityTest.java | Bin 0 -> 9937 bytes 6 files changed, 1050 insertions(+), 981 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphDocuments.java create mode 100644 core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphInspector.java create mode 100644 core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioObjectResizer.java create mode 100644 core/src/test/java/art/arcane/iris/core/service/JigsawStudioPersistenceIdentityTest.java diff --git a/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphDocuments.java b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphDocuments.java new file mode 100644 index 000000000..9ebee0776 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphDocuments.java @@ -0,0 +1,305 @@ +package art.arcane.iris.core.runtime.jigsaw; + +import art.arcane.iris.engine.framework.structure.PlanarJigsawWorkcellResolver; +import art.arcane.iris.engine.object.IrisJigsawMode; +import art.arcane.iris.engine.object.IrisJigsawWorkcellArchetype; +import art.arcane.iris.engine.object.IrisStructure; +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonParser; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +final class JigsawStudioGraphDocuments { + static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); + + private JigsawStudioGraphDocuments() { + } + + static Map expectedThemeSetSources( + IrisStructure structure, + Set requestedStableIds + ) throws IOException { + Map expected = new LinkedHashMap<>(); + if (structure.resolvedMode() == IrisJigsawMode.SPATIAL_JIGSAW) { + if (requestedStableIds.isEmpty()) { + throw new IOException("A spatial theme set requires at least one workcell source"); + } + List stableIds = new ArrayList<>(requestedStableIds); + stableIds.sort(Comparator.naturalOrder()); + for (String stableId : stableIds) { + if (!stableId.equals(JigsawStudioLayout.SPATIAL_WORKCELL_ID) + && !stableId.startsWith(JigsawStudioLayout.SPATIAL_WORKCELL_ID + "/")) { + throw new IOException("Invalid spatial workcell source '" + stableId + "'"); + } + expected.put(stableId, null); + } + return expected; + } + Map workcells; + try { + workcells = PlanarJigsawWorkcellResolver.resolve(structure); + } catch (IllegalArgumentException exception) { + throw new IOException("Planar workcell configuration is invalid: " + + exception.getMessage(), exception); + } + for (JigsawPlanarArchetype archetype : JigsawPlanarArchetype.values()) { + PlanarJigsawWorkcellResolver.ResolvedWorkcell workcell = workcells.get(archetype.modelArchetype()); + if (workcell != null && workcell.enabled()) { + expected.put(archetype.stableId(), archetype); + } + } + if (expected.isEmpty()) { + throw new IOException("A planar theme set requires at least one enabled workcell"); + } + return expected; + } + + static void requireExactThemeSetSources( + Map requestedSources, + Set expectedStableIds + ) throws IOException { + Set missing = new LinkedHashSet<>(expectedStableIds); + missing.removeAll(requestedSources.keySet()); + Set unexpected = new LinkedHashSet<>(requestedSources.keySet()); + unexpected.removeAll(expectedStableIds); + if (!missing.isEmpty() || !unexpected.isEmpty()) { + throw new IOException("Theme-set sources must match enabled workcells exactly; missing=" + + missing + ", unexpected=" + unexpected); + } + } + + static byte[] appendThemeSet( + byte[] content, + String themeKey, + String structureResource + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw structure is not a JSON object: " + structureResource); + } + JsonObject structure = parsed.getAsJsonObject(); + JsonArray themeSets; + if (!structure.has("themeSets")) { + themeSets = new JsonArray(); + structure.add("themeSets", themeSets); + } else if (!structure.get("themeSets").isJsonArray()) { + throw new IOException("Jigsaw structure has an invalid themeSets value: " + structureResource); + } else { + themeSets = structure.getAsJsonArray("themeSets"); + } + for (JsonElement element : themeSets) { + if (element.isJsonObject() + && element.getAsJsonObject().has("key") + && themeKey.equals(element.getAsJsonObject().get("key").getAsString())) { + throw new IOException("Jigsaw structure already declares theme '" + themeKey + "'"); + } + } + JsonObject theme = new JsonObject(); + theme.addProperty("key", themeKey); + theme.addProperty("weight", 1); + themeSets.add(theme); + return (GSON.toJson(structure) + "\n").getBytes(StandardCharsets.UTF_8); + } + + static byte[] duplicatePieceForTheme( + byte[] content, + String targetPieceKey, + String themeKey, + String sourcePieceResource + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw piece is not a JSON object: " + sourcePieceResource); + } + JsonObject piece = parsed.getAsJsonObject().deepCopy(); + piece.addProperty("object", targetPieceKey); + JsonArray themes = new JsonArray(); + themes.add(themeKey); + piece.add("themes", themes); + return (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + } + + static byte[] duplicatePieceForVariant( + byte[] content, + String targetPieceKey, + String sourcePieceResource + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw piece is not a JSON object: " + sourcePieceResource); + } + JsonObject piece = parsed.getAsJsonObject().deepCopy(); + piece.addProperty("object", targetPieceKey); + return (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + } + + static PoolMembershipDuplication duplicatePoolMemberships( + byte[] content, + Map targetPieceKeysBySource, + String poolResource + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw pool is not a JSON object: " + poolResource); + } + JsonObject pool = parsed.getAsJsonObject(); + JsonArray pieces = pool.getAsJsonArray("pieces"); + if (pieces == null) { + throw new IOException("Jigsaw pool does not declare a pieces array: " + poolResource); + } + JsonArray expanded = new JsonArray(); + int duplicatedEntries = 0; + for (JsonElement element : pieces) { + expanded.add(element.deepCopy()); + if (!element.isJsonObject() || !element.getAsJsonObject().has("piece")) { + continue; + } + String sourcePieceKey = element.getAsJsonObject().get("piece").getAsString(); + String targetPieceKey = targetPieceKeysBySource.get(sourcePieceKey); + if (targetPieceKey == null) { + continue; + } + JsonObject duplicate = element.getAsJsonObject().deepCopy(); + duplicate.addProperty("piece", targetPieceKey); + expanded.add(duplicate); + duplicatedEntries++; + } + if (duplicatedEntries == 0) { + return new PoolMembershipDuplication(content, 0); + } + pool.add("pieces", expanded); + return new PoolMembershipDuplication( + (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8), + duplicatedEntries); + } + + static List normalizeThemes(List themes) { + Objects.requireNonNull(themes, "Jigsaw Studio piece themes"); + Set normalized = new LinkedHashSet<>(); + for (String theme : themes) { + Objects.requireNonNull(theme, "Jigsaw Studio piece theme"); + String key = theme.trim(); + if (key.isEmpty() || !key.equals(theme)) { + throw new IllegalArgumentException( + "Jigsaw Studio piece themes must be non-blank and whitespace-normalized"); + } + if (!normalized.add(key)) { + throw new IllegalArgumentException("Duplicate Jigsaw Studio piece theme '" + key + "'"); + } + } + return List.copyOf(normalized); + } + + static PoolEntryRemoval removePoolEntries( + byte[] content, + String pieceKey, + String poolResource + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw pool is not a JSON object: " + poolResource); + } + JsonObject pool = parsed.getAsJsonObject(); + JsonArray pieces = pool.getAsJsonArray("pieces"); + if (pieces == null) { + throw new IOException("Jigsaw pool does not declare a pieces array: " + poolResource); + } + int removed = 0; + for (int index = pieces.size() - 1; index >= 0; index--) { + JsonElement entry = pieces.get(index); + if (entry.isJsonObject() + && entry.getAsJsonObject().has("piece") + && pieceKey.equals(entry.getAsJsonObject().get("piece").getAsString())) { + pieces.remove(index); + removed++; + } + } + if (removed == 0) { + return new PoolEntryRemoval(content, 0); + } + return new PoolEntryRemoval( + (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8), + removed); + } + + static String resourceKey(String relativePath, String prefix, String suffix) { + return relativePath.substring(prefix.length(), relativePath.length() - suffix.length()); + } + + static byte[] addPoolEntry( + byte[] content, + String pieceKey, + int weight, + Path poolPath + ) throws IOException { + JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); + if (!parsed.isJsonObject()) { + throw new IOException("Jigsaw pool is not a JSON object: " + poolPath); + } + JsonObject pool = parsed.getAsJsonObject(); + if (!pool.has("pieces") || !pool.get("pieces").isJsonArray()) { + throw new IOException("Jigsaw pool does not declare a pieces array: " + poolPath); + } + JsonArray pieces = pool.getAsJsonArray("pieces"); + for (JsonElement element : pieces) { + if (element.isJsonObject() + && element.getAsJsonObject().has("piece") + && pieceKey.equals(element.getAsJsonObject().get("piece").getAsString())) { + throw new IOException("Pool already references piece '" + pieceKey + "'"); + } + } + JsonObject entry = new JsonObject(); + entry.addProperty("piece", pieceKey); + entry.addProperty("weight", weight); + pieces.add(entry); + return (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8); + } + + static String normalizeChannel(String channel) { + String normalized = channel == null ? "" : channel.trim(); + if (normalized.equalsIgnoreCase("none")) { + return ""; + } + if (normalized.length() > 128) { + throw new IllegalArgumentException("Jigsaw connector channels cannot exceed 128 characters"); + } + for (int index = 0; index < normalized.length(); index++) { + if (Character.isWhitespace(normalized.charAt(index))) { + throw new IllegalArgumentException("Jigsaw connector channels cannot contain whitespace"); + } + } + return normalized; + } + + record PoolEntryRemoval(byte[] content, int removedEntries) { + PoolEntryRemoval { + Objects.requireNonNull(content, "Jigsaw Studio pool entry removal content"); + if (removedEntries < 0) { + throw new IllegalArgumentException("Removed jigsaw pool entry count cannot be negative"); + } + } + } + + record PoolMembershipDuplication(byte[] content, int duplicatedEntries) { + PoolMembershipDuplication { + Objects.requireNonNull(content, "Jigsaw Studio duplicated pool content"); + if (duplicatedEntries < 0) { + throw new IllegalArgumentException("Duplicated pool membership count cannot be negative"); + } + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditor.java b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditor.java index 4e363afcc..57683436e 100644 --- a/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditor.java +++ b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditor.java @@ -19,8 +19,6 @@ import art.arcane.iris.engine.object.IrisObject; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; import art.arcane.iris.engine.object.JigsawJoint; -import art.arcane.iris.engine.object.TileData; -import art.arcane.iris.spi.PlatformBlockState; import art.arcane.iris.util.common.math.IrisBlockVector; import com.google.gson.Gson; import com.google.gson.GsonBuilder; @@ -38,16 +36,12 @@ import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.LinkedHashMap; -import java.util.LinkedHashSet; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Objects; -import java.util.Set; public final class JigsawStudioGraphEditor { - private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create(); - private JigsawStudioGraphEditor() { } @@ -82,7 +76,7 @@ public final class JigsawStudioGraphEditor { Path resourcePath = resolveOwnedResource(graph.root(), resource.getKey()); byte[] content = Files.readAllBytes(resourcePath); if (resource.getKey().equals(poolResource)) { - content = addPoolEntry(content, normalizedPiece, weight, resourcePath); + content = JigsawStudioGraphDocuments.addPoolEntry(content, normalizedPiece, weight, resourcePath); } bundle.resource(resource.getKey(), content); } @@ -106,7 +100,7 @@ public final class JigsawStudioGraphEditor { } } IrisObject object = new IrisObject(dimensions.width(), dimensions.height(), dimensions.depth()); - bundle.textResource(pieceResource, GSON.toJson(piece) + "\n"); + bundle.textResource(pieceResource, JigsawStudioGraphDocuments.GSON.toJson(piece) + "\n"); bundle.resource(objectResource, JigsawStudioProjectCreator.serialize(object)); return write(graph, bundle.build()); } @@ -157,15 +151,15 @@ public final class JigsawStudioGraphEditor { IrisStructure structure = readStructure( resolveOwnedResource(graph.root(), structureResource), structureResource); - Map expectedSources = expectedThemeSetSources( + Map expectedSources = JigsawStudioGraphDocuments.expectedThemeSetSources( structure, requestedSources.keySet()); - requireExactThemeSetSources(requestedSources, expectedSources.keySet()); + JigsawStudioGraphDocuments.requireExactThemeSetSources(requestedSources, expectedSources.keySet()); Map resources = readOwnedResources(graph); resources.put( structureResource, - appendThemeSet(resources.get(structureResource), themeKey, structureResource)); + JigsawStudioGraphDocuments.appendThemeSet(resources.get(structureResource), themeKey, structureResource)); Map newPieceKeysByWorkcell = new LinkedHashMap<>(); Map newPieceKeysBySource = new LinkedHashMap<>(); for (Map.Entry expected : expectedSources.entrySet()) { @@ -210,11 +204,11 @@ public final class JigsawStudioGraphEditor { + "/variants/" + variantFolder + "/" + themeKey; String targetPieceResource = "jigsaw-pieces/" + targetPieceKey + ".json"; String targetObjectResource = "objects/" + targetPieceKey + ".iob"; - requireAvailableThemeSetTarget(graph, targetPieceResource); - requireAvailableThemeSetTarget(graph, targetObjectResource); + JigsawStudioGraphInspector.requireAvailableThemeSetTarget(graph, targetPieceResource); + JigsawStudioGraphInspector.requireAvailableThemeSetTarget(graph, targetObjectResource); resources.put( targetPieceResource, - duplicatePieceForTheme( + JigsawStudioGraphDocuments.duplicatePieceForTheme( resources.get(sourcePieceResource), targetPieceKey, themeKey, @@ -231,7 +225,7 @@ public final class JigsawStudioGraphEditor { } resources.put( relativePath, - duplicatePoolMemberships( + JigsawStudioGraphDocuments.duplicatePoolMemberships( resource.getValue(), newPieceKeysBySource, relativePath).content()); @@ -316,7 +310,7 @@ public final class JigsawStudioGraphEditor { bundle.resource(relativePath, Files.readAllBytes(resolveOwnedResource(graph.root(), relativePath))); } IrisJigsawPool pool = new IrisJigsawPool().setFallback(fallback); - bundle.textResource(poolResource, GSON.toJson(pool) + "\n"); + bundle.textResource(poolResource, JigsawStudioGraphDocuments.GSON.toJson(pool) + "\n"); return write(graph, bundle.build()); } @@ -342,7 +336,7 @@ public final class JigsawStudioGraphEditor { } JsonObject piece = parsed.getAsJsonObject(); piece.addProperty("rotatable", rotatable); - content = (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + content = (JigsawStudioGraphDocuments.GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); } bundle.resource(relativePath, content); } @@ -355,7 +349,7 @@ public final class JigsawStudioGraphEditor { String pieceKey, List themes ) throws IOException { - List normalizedThemes = normalizeThemes(themes); + List normalizedThemes = JigsawStudioGraphDocuments.normalizeThemes(themes); return updateOwnedPiece( packRoot, structureKey, @@ -433,8 +427,8 @@ public final class JigsawStudioGraphEditor { String objectKey = JigsawStudioProjectCreator.Options.requireResourceKey(targetPiece.getObject()); String objectResource = "objects/" + objectKey + ".iob"; boolean removeObject = graph.manifest().resourceHashes().containsKey(objectResource) - && !otherOwnedPieceReferencesObject(graph, normalizedPiece, objectKey); - requireDeletableArchetype(graph, normalizedPiece, targetPiece); + && !JigsawStudioGraphInspector.otherOwnedPieceReferencesObject(graph, normalizedPiece, objectKey); + JigsawStudioGraphInspector.requireDeletableArchetype(graph, normalizedPiece, targetPiece); StructureResourceBundle.Builder bundle = graph.bundleBuilder(); int removedMemberships = 0; @@ -445,7 +439,7 @@ public final class JigsawStudioGraphEditor { } byte[] content = Files.readAllBytes(resolveOwnedResource(graph.root(), relativePath)); if (relativePath.startsWith("jigsaw-pools/") && relativePath.endsWith(".json")) { - PoolEntryRemoval removal = removePoolEntries(content, normalizedPiece, relativePath); + JigsawStudioGraphDocuments.PoolEntryRemoval removal = JigsawStudioGraphDocuments.removePoolEntries(content, normalizedPiece, relativePath); content = removal.content(); removedMemberships += removal.removedEntries(); if (removal.removedEntries() > 0) { @@ -494,7 +488,7 @@ public final class JigsawStudioGraphEditor { if (!graph.manifest().resourceHashes().containsKey(objectResource)) { throw new IOException("Object '" + objectKey + "' is not owned by this jigsaw project"); } - requireExclusiveObjectReference(graph, normalizedPiece, objectKey); + JigsawStudioGraphInspector.requireExclusiveObjectReference(graph, normalizedPiece, objectKey); Path objectPath = resolveOwnedResource(graph.root(), objectResource); IrisObject source = new IrisObject(); source.read(objectPath.toFile()); @@ -514,20 +508,20 @@ public final class JigsawStudioGraphEditor { IrisJigsawWorkcellArchetype archetype = IrisJigsawWorkcellArchetype.fromPiece(piece); JigsawPlanarArchetype planarArchetype = JigsawPlanarArchetype.fromModel(archetype); int quarterTurns = archetype.sourceToCanonicalQuarterTurns(piece); - previousDimensions = canonicalDimensions(sourceDimensions, quarterTurns); + previousDimensions = JigsawStudioObjectResizer.canonicalDimensions(sourceDimensions, quarterTurns); PlanarJigsawWorkcellResolver.ResolvedWorkcell workcell = PlanarJigsawWorkcellResolver.resolve(structure).get(archetype); - if (workcell == null || !workcell.contains(dimensionsPosition(targetDimensions))) { + if (workcell == null || !workcell.contains(JigsawStudioObjectResizer.dimensionsPosition(targetDimensions))) { throw new IOException("Variant '" + normalizedPiece + "' size " - + describeDimensions(targetDimensions) + " exceeds the " + + JigsawStudioObjectResizer.describeDimensions(targetDimensions) + " exceeds the " + planarArchetype.displayName() + " workcell capacity " - + describeDimensions(new JigsawStudioCellDimensions( + + JigsawStudioObjectResizer.describeDimensions(new JigsawStudioCellDimensions( workcell == null ? 1 : workcell.width(), workcell == null ? 1 : workcell.height(), workcell == null ? 1 : workcell.depth())) + "; increase that workcell capacity first"); } - PlanarPieceObjectResize resized = resizePlanarPieceObject( + JigsawStudioObjectResizer.PlanarPieceObjectResize resized = JigsawStudioObjectResizer.resizePlanarPieceObject( source, piece, planarArchetype, @@ -537,8 +531,8 @@ public final class JigsawStudioGraphEditor { relocatedConnectors = resized.relocatedConnectors(); } else { previousDimensions = sourceDimensions; - requireConnectorsInside(piece, targetDimensions, normalizedPiece); - resizedObject = resizeObject(source, targetDimensions, normalizedPiece); + JigsawStudioObjectResizer.requireConnectorsInside(piece, targetDimensions, normalizedPiece); + resizedObject = JigsawStudioObjectResizer.resizeObject(source, targetDimensions, normalizedPiece); } StructureResourceBundle.Builder bundle = graph.bundleBuilder(); @@ -547,7 +541,7 @@ public final class JigsawStudioGraphEditor { if (relativePath.equals(objectResource)) { content = JigsawStudioProjectCreator.serialize(resizedObject); } else if (relativePath.equals(pieceResource)) { - content = (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + content = (JigsawStudioGraphDocuments.GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); } else { content = Files.readAllBytes(resolveOwnedResource(graph.root(), relativePath)); } @@ -620,7 +614,7 @@ public final class JigsawStudioGraphEditor { try { writeResult = write(graph, bundle.build()); } catch (RuntimeException exception) { - throw new IOException("Workcell capacity " + describeDimensions(targetDimensions) + throw new IOException("Workcell capacity " + JigsawStudioObjectResizer.describeDimensions(targetDimensions) + " cannot contain every " + targetArchetype.displayName() + " variant: " + failureMessage(exception), exception); } @@ -636,7 +630,7 @@ public final class JigsawStudioGraphEditor { ) throws IOException { String normalizedPiece = JigsawStudioProjectCreator.Options.requireResourceKey(pieceKey); IrisPosition connectorPosition = Objects.requireNonNull(position, "Jigsaw connector position"); - String normalizedChannel = normalizeChannel(channel); + String normalizedChannel = JigsawStudioGraphDocuments.normalizeChannel(channel); OwnedGraph graph = loadOwnedGraph(packRoot, structureKey); String pieceResource = "jigsaw-pieces/" + normalizedPiece + ".json"; if (!graph.manifest().resourceHashes().containsKey(pieceResource)) { @@ -649,7 +643,7 @@ public final class JigsawStudioGraphEditor { if (relativePath.equals(pieceResource)) { IrisJigsawPiece piece; try { - piece = GSON.fromJson(new String(content, StandardCharsets.UTF_8), IrisJigsawPiece.class); + piece = JigsawStudioGraphDocuments.GSON.fromJson(new String(content, StandardCharsets.UTF_8), IrisJigsawPiece.class); } catch (RuntimeException exception) { throw new IOException("Jigsaw piece is not valid JSON: " + pieceResource, exception); } @@ -662,7 +656,7 @@ public final class JigsawStudioGraphEditor { found = true; } } - content = (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + content = (JigsawStudioGraphDocuments.GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); } bundle.resource(relativePath, content); } @@ -689,59 +683,6 @@ public final class JigsawStudioGraphEditor { return new OwnedGraph(root, writer, manifest, StructureHash.sha256(manifestContent)); } - private static Map expectedThemeSetSources( - IrisStructure structure, - Set requestedStableIds - ) throws IOException { - Map expected = new LinkedHashMap<>(); - if (structure.resolvedMode() == IrisJigsawMode.SPATIAL_JIGSAW) { - if (requestedStableIds.isEmpty()) { - throw new IOException("A spatial theme set requires at least one workcell source"); - } - List stableIds = new ArrayList<>(requestedStableIds); - stableIds.sort(Comparator.naturalOrder()); - for (String stableId : stableIds) { - if (!stableId.equals(JigsawStudioLayout.SPATIAL_WORKCELL_ID) - && !stableId.startsWith(JigsawStudioLayout.SPATIAL_WORKCELL_ID + "/")) { - throw new IOException("Invalid spatial workcell source '" + stableId + "'"); - } - expected.put(stableId, null); - } - return expected; - } - Map workcells; - try { - workcells = PlanarJigsawWorkcellResolver.resolve(structure); - } catch (IllegalArgumentException exception) { - throw new IOException("Planar workcell configuration is invalid: " - + exception.getMessage(), exception); - } - for (JigsawPlanarArchetype archetype : JigsawPlanarArchetype.values()) { - PlanarJigsawWorkcellResolver.ResolvedWorkcell workcell = workcells.get(archetype.modelArchetype()); - if (workcell != null && workcell.enabled()) { - expected.put(archetype.stableId(), archetype); - } - } - if (expected.isEmpty()) { - throw new IOException("A planar theme set requires at least one enabled workcell"); - } - return expected; - } - - private static void requireExactThemeSetSources( - Map requestedSources, - Set expectedStableIds - ) throws IOException { - Set missing = new LinkedHashSet<>(expectedStableIds); - missing.removeAll(requestedSources.keySet()); - Set unexpected = new LinkedHashSet<>(requestedSources.keySet()); - unexpected.removeAll(expectedStableIds); - if (!missing.isEmpty() || !unexpected.isEmpty()) { - throw new IOException("Theme-set sources must match enabled workcells exactly; missing=" - + missing + ", unexpected=" + unexpected); - } - } - private static Map readOwnedResources(OwnedGraph graph) throws IOException { Map resources = new LinkedHashMap<>(); for (String relativePath : graph.manifest().resourceHashes().keySet()) { @@ -752,39 +693,6 @@ public final class JigsawStudioGraphEditor { return resources; } - private static byte[] appendThemeSet( - byte[] content, - String themeKey, - String structureResource - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw structure is not a JSON object: " + structureResource); - } - JsonObject structure = parsed.getAsJsonObject(); - JsonArray themeSets; - if (!structure.has("themeSets")) { - themeSets = new JsonArray(); - structure.add("themeSets", themeSets); - } else if (!structure.get("themeSets").isJsonArray()) { - throw new IOException("Jigsaw structure has an invalid themeSets value: " + structureResource); - } else { - themeSets = structure.getAsJsonArray("themeSets"); - } - for (JsonElement element : themeSets) { - if (element.isJsonObject() - && element.getAsJsonObject().has("key") - && themeKey.equals(element.getAsJsonObject().get("key").getAsString())) { - throw new IOException("Jigsaw structure already declares theme '" + themeKey + "'"); - } - } - JsonObject theme = new JsonObject(); - theme.addProperty("key", themeKey); - theme.addProperty("weight", 1); - themeSets.add(theme); - return (GSON.toJson(structure) + "\n").getBytes(StandardCharsets.UTF_8); - } - private static StructureWriteResult createVariantFromPiece( Path packRoot, String structureKey, @@ -801,8 +709,8 @@ public final class JigsawStudioGraphEditor { if (!graph.manifest().resourceHashes().containsKey(sourcePieceResource)) { throw new IOException("Source piece '" + normalizedSource + "' is not owned by this project"); } - requireAvailableVariantTarget(graph, targetPieceResource); - requireAvailableVariantTarget(graph, targetObjectResource); + JigsawStudioGraphInspector.requireAvailableVariantTarget(graph, targetPieceResource); + JigsawStudioGraphInspector.requireAvailableVariantTarget(graph, targetObjectResource); Path sourcePiecePath = resolveOwnedResource(graph.root(), sourcePieceResource); byte[] sourcePieceContent = Files.readAllBytes(sourcePiecePath); @@ -833,7 +741,7 @@ public final class JigsawStudioGraphEditor { for (String relativePath : graph.manifest().resourceHashes().keySet()) { byte[] content = Files.readAllBytes(resolveOwnedResource(graph.root(), relativePath)); if (relativePath.startsWith("jigsaw-pools/") && relativePath.endsWith(".json")) { - PoolMembershipDuplication duplication = duplicatePoolMemberships( + JigsawStudioGraphDocuments.PoolMembershipDuplication duplication = JigsawStudioGraphDocuments.duplicatePoolMemberships( content, targetPieceKeysBySource, relativePath); @@ -848,113 +756,11 @@ public final class JigsawStudioGraphEditor { } bundle.resource( targetPieceResource, - duplicatePieceForVariant(sourcePieceContent, normalizedTarget, sourcePieceResource)); + JigsawStudioGraphDocuments.duplicatePieceForVariant(sourcePieceContent, normalizedTarget, sourcePieceResource)); bundle.resource(targetObjectResource, targetObjectContent); return write(graph, bundle.build()); } - private static void requireAvailableVariantTarget( - OwnedGraph graph, - String relativePath - ) throws IOException { - StructureResourceBundle.validateRelativePath(relativePath); - Path target = graph.root().resolve(relativePath).normalize(); - if (!target.startsWith(graph.root())) { - throw new IOException("Variant target escapes the pack root: " + relativePath); - } - if (graph.manifest().resourceHashes().containsKey(relativePath) - || Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Variant target already exists: " + relativePath); - } - } - - private static void requireAvailableThemeSetTarget( - OwnedGraph graph, - String relativePath - ) throws IOException { - StructureResourceBundle.validateRelativePath(relativePath); - Path target = graph.root().resolve(relativePath).normalize(); - if (!target.startsWith(graph.root())) { - throw new IOException("Theme-set target escapes the pack root: " + relativePath); - } - if (graph.manifest().resourceHashes().containsKey(relativePath) - || Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { - throw new IOException("Theme-set target already exists: " + relativePath); - } - } - - private static byte[] duplicatePieceForTheme( - byte[] content, - String targetPieceKey, - String themeKey, - String sourcePieceResource - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw piece is not a JSON object: " + sourcePieceResource); - } - JsonObject piece = parsed.getAsJsonObject().deepCopy(); - piece.addProperty("object", targetPieceKey); - JsonArray themes = new JsonArray(); - themes.add(themeKey); - piece.add("themes", themes); - return (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); - } - - private static byte[] duplicatePieceForVariant( - byte[] content, - String targetPieceKey, - String sourcePieceResource - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw piece is not a JSON object: " + sourcePieceResource); - } - JsonObject piece = parsed.getAsJsonObject().deepCopy(); - piece.addProperty("object", targetPieceKey); - return (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); - } - - private static PoolMembershipDuplication duplicatePoolMemberships( - byte[] content, - Map targetPieceKeysBySource, - String poolResource - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw pool is not a JSON object: " + poolResource); - } - JsonObject pool = parsed.getAsJsonObject(); - JsonArray pieces = pool.getAsJsonArray("pieces"); - if (pieces == null) { - throw new IOException("Jigsaw pool does not declare a pieces array: " + poolResource); - } - JsonArray expanded = new JsonArray(); - int duplicatedEntries = 0; - for (JsonElement element : pieces) { - expanded.add(element.deepCopy()); - if (!element.isJsonObject() || !element.getAsJsonObject().has("piece")) { - continue; - } - String sourcePieceKey = element.getAsJsonObject().get("piece").getAsString(); - String targetPieceKey = targetPieceKeysBySource.get(sourcePieceKey); - if (targetPieceKey == null) { - continue; - } - JsonObject duplicate = element.getAsJsonObject().deepCopy(); - duplicate.addProperty("piece", targetPieceKey); - expanded.add(duplicate); - duplicatedEntries++; - } - if (duplicatedEntries == 0) { - return new PoolMembershipDuplication(content, 0); - } - pool.add("pieces", expanded); - return new PoolMembershipDuplication( - (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8), - duplicatedEntries); - } - private static StructureWriteResult updateOwnedPiece( Path packRoot, String structureKey, @@ -977,30 +783,13 @@ public final class JigsawStudioGraphEditor { } JsonObject piece = parsed.getAsJsonObject(); editor.edit(piece, pieceResource); - content = (GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); + content = (JigsawStudioGraphDocuments.GSON.toJson(piece) + "\n").getBytes(StandardCharsets.UTF_8); } bundle.resource(relativePath, content); } return write(graph, bundle.build()); } - private static List normalizeThemes(List themes) { - Objects.requireNonNull(themes, "Jigsaw Studio piece themes"); - Set normalized = new LinkedHashSet<>(); - for (String theme : themes) { - Objects.requireNonNull(theme, "Jigsaw Studio piece theme"); - String key = theme.trim(); - if (key.isEmpty() || !key.equals(theme)) { - throw new IllegalArgumentException( - "Jigsaw Studio piece themes must be non-blank and whitespace-normalized"); - } - if (!normalized.add(key)) { - throw new IllegalArgumentException("Duplicate Jigsaw Studio piece theme '" + key + "'"); - } - } - return List.copyOf(normalized); - } - public static String normalizeDisplayName(String displayName) { String normalized = displayName == null ? "" : displayName.trim(); if (normalized.codePointCount(0, normalized.length()) > 64) { @@ -1017,129 +806,12 @@ public final class JigsawStudioGraphEditor { return normalized; } - private static boolean otherOwnedPieceReferencesObject( - OwnedGraph graph, - String targetPieceKey, - String objectKey - ) throws IOException { - for (String relativePath : graph.manifest().resourceHashes().keySet()) { - if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { - continue; - } - String pieceKey = resourceKey(relativePath, "jigsaw-pieces/", ".json"); - if (pieceKey.equals(targetPieceKey)) { - continue; - } - IrisJigsawPiece piece = readPiece(resolveOwnedResource(graph.root(), relativePath), relativePath); - if (objectKey.equals(piece.getObject())) { - return true; - } - } - return false; - } - - private static void requireDeletableArchetype( - OwnedGraph graph, - String targetPieceKey, - IrisJigsawPiece targetPiece - ) throws IOException { - String structureResource = "structures/" + graph.manifest().structure().path() + ".json"; - if (!graph.manifest().resourceHashes().containsKey(structureResource)) { - throw new IOException("The owned graph manifest does not include " + structureResource); - } - IrisStructure structure = readStructure( - resolveOwnedResource(graph.root(), structureResource), - structureResource); - if (structure.resolvedMode() == IrisJigsawMode.SPATIAL_JIGSAW) { - if (countOtherOwnedPieces(graph, targetPieceKey, null) == 0) { - throw new IOException("Cannot delete the final spatial jigsaw variant"); - } - return; - } - IrisJigsawWorkcellArchetype archetype = IrisJigsawWorkcellArchetype.fromPiece(targetPiece); - Map workcells; - try { - workcells = PlanarJigsawWorkcellResolver.resolve(structure); - } catch (IllegalArgumentException exception) { - throw new IOException("Planar workcell configuration is invalid: " - + exception.getMessage(), exception); - } - PlanarJigsawWorkcellResolver.ResolvedWorkcell workcell = workcells.get(archetype); - if (workcell != null && workcell.enabled() - && countOtherOwnedPieces(graph, targetPieceKey, archetype) == 0) { - throw new IOException("Cannot delete the final variant for enabled planar workcell " - + JigsawPlanarArchetype.fromModel(archetype).stableId()); - } - } - - private static int countOtherOwnedPieces( - OwnedGraph graph, - String targetPieceKey, - IrisJigsawWorkcellArchetype archetype - ) throws IOException { - int count = 0; - for (String relativePath : graph.manifest().resourceHashes().keySet()) { - if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { - continue; - } - String pieceKey = resourceKey(relativePath, "jigsaw-pieces/", ".json"); - if (pieceKey.equals(targetPieceKey)) { - continue; - } - if (archetype == null) { - count++; - continue; - } - IrisJigsawPiece piece = readPiece(resolveOwnedResource(graph.root(), relativePath), relativePath); - if (IrisJigsawWorkcellArchetype.fromPiece(piece) == archetype) { - count++; - } - } - return count; - } - - private static PoolEntryRemoval removePoolEntries( - byte[] content, - String pieceKey, - String poolResource - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw pool is not a JSON object: " + poolResource); - } - JsonObject pool = parsed.getAsJsonObject(); - JsonArray pieces = pool.getAsJsonArray("pieces"); - if (pieces == null) { - throw new IOException("Jigsaw pool does not declare a pieces array: " + poolResource); - } - int removed = 0; - for (int index = pieces.size() - 1; index >= 0; index--) { - JsonElement entry = pieces.get(index); - if (entry.isJsonObject() - && entry.getAsJsonObject().has("piece") - && pieceKey.equals(entry.getAsJsonObject().get("piece").getAsString())) { - pieces.remove(index); - removed++; - } - } - if (removed == 0) { - return new PoolEntryRemoval(content, 0); - } - return new PoolEntryRemoval( - (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8), - removed); - } - - private static String resourceKey(String relativePath, String prefix, String suffix) { - return relativePath.substring(prefix.length(), relativePath.length() - suffix.length()); - } - private static String failureMessage(RuntimeException exception) { String message = exception.getMessage(); return message == null || message.isBlank() ? exception.getClass().getSimpleName() : message; } - private static Path resolveOwnedResource(Path root, String relativePath) throws IOException { + static Path resolveOwnedResource(Path root, String relativePath) throws IOException { StructureResourceBundle.validateRelativePath(relativePath); Path resource = root.resolve(relativePath).normalize(); if (!resource.startsWith(root) || !Files.isRegularFile(resource, LinkOption.NOFOLLOW_LINKS)) { @@ -1148,38 +820,9 @@ public final class JigsawStudioGraphEditor { return resource; } - private static byte[] addPoolEntry( - byte[] content, - String pieceKey, - int weight, - Path poolPath - ) throws IOException { - JsonElement parsed = JsonParser.parseString(new String(content, StandardCharsets.UTF_8)); - if (!parsed.isJsonObject()) { - throw new IOException("Jigsaw pool is not a JSON object: " + poolPath); - } - JsonObject pool = parsed.getAsJsonObject(); - if (!pool.has("pieces") || !pool.get("pieces").isJsonArray()) { - throw new IOException("Jigsaw pool does not declare a pieces array: " + poolPath); - } - JsonArray pieces = pool.getAsJsonArray("pieces"); - for (JsonElement element : pieces) { - if (element.isJsonObject() - && element.getAsJsonObject().has("piece") - && pieceKey.equals(element.getAsJsonObject().get("piece").getAsString())) { - throw new IOException("Pool already references piece '" + pieceKey + "'"); - } - } - JsonObject entry = new JsonObject(); - entry.addProperty("piece", pieceKey); - entry.addProperty("weight", weight); - pieces.add(entry); - return (GSON.toJson(pool) + "\n").getBytes(StandardCharsets.UTF_8); - } - - private static IrisJigsawPiece readPiece(Path path, String resource) throws IOException { + static IrisJigsawPiece readPiece(Path path, String resource) throws IOException { try { - IrisJigsawPiece piece = GSON.fromJson(Files.readString(path, StandardCharsets.UTF_8), + IrisJigsawPiece piece = JigsawStudioGraphDocuments.GSON.fromJson(Files.readString(path, StandardCharsets.UTF_8), IrisJigsawPiece.class); if (piece == null) { throw new IOException("Jigsaw piece is empty: " + resource); @@ -1190,9 +833,9 @@ public final class JigsawStudioGraphEditor { } } - private static IrisStructure readStructure(Path path, String resource) throws IOException { + static IrisStructure readStructure(Path path, String resource) throws IOException { try { - IrisStructure structure = GSON.fromJson( + IrisStructure structure = JigsawStudioGraphDocuments.GSON.fromJson( Files.readString(path, StandardCharsets.UTF_8), IrisStructure.class); if (structure == null) { @@ -1204,524 +847,6 @@ public final class JigsawStudioGraphEditor { } } - private static void requireExclusiveObjectReference( - OwnedGraph graph, - String activePieceKey, - String objectKey - ) throws IOException { - for (String relativePath : graph.manifest().resourceHashes().keySet()) { - if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { - continue; - } - String pieceKey = relativePath.substring( - "jigsaw-pieces/".length(), - relativePath.length() - ".json".length()); - if (pieceKey.equals(activePieceKey)) { - continue; - } - IrisJigsawPiece piece = readPiece(resolveOwnedResource(graph.root(), relativePath), relativePath); - if (objectKey.equals(piece.getObject())) { - throw new IOException("Object '" + objectKey + "' is shared by piece '" + pieceKey - + "'; duplicate the active variant before resizing its object bounds"); - } - } - } - - static PlanarPieceObjectResize resizePlanarPieceObject( - IrisObject source, - IrisJigsawPiece piece, - JigsawPlanarArchetype archetype, - JigsawStudioCellDimensions dimensions, - String pieceKey - ) throws IOException { - IrisObject sourceObject = Objects.requireNonNull(source, "Planar Jigsaw Studio source object"); - IrisJigsawPiece targetPiece = Objects.requireNonNull(piece, "Planar Jigsaw Studio piece"); - JigsawPlanarArchetype targetArchetype = Objects.requireNonNull( - archetype, - "Planar Jigsaw Studio archetype"); - JigsawStudioCellDimensions targetDimensions = Objects.requireNonNull( - dimensions, - "Planar Jigsaw Studio target dimensions"); - String targetPieceKey = pieceKey == null || pieceKey.isBlank() ? "unknown" : pieceKey; - if (targetDimensions.width() < 3 || targetDimensions.depth() < 3) { - throw new IllegalArgumentException( - "Planar Jigsaw Studio workcell width and depth must each be at least 3 blocks"); - } - if (sourceObject.getW() < 1 || sourceObject.getH() < 1 || sourceObject.getD() < 1) { - throw new IOException("Planar piece '" + targetPieceKey + "' has invalid object dimensions"); - } - if (IrisJigsawWorkcellArchetype.fromPiece(targetPiece) != targetArchetype.modelArchetype()) { - throw new IOException("Planar piece '" + targetPieceKey + "' does not belong to " - + targetArchetype.stableId()); - } - - int quarterTurns = targetArchetype.modelArchetype().sourceToCanonicalQuarterTurns(targetPiece); - JigsawStudioCellDimensions sourceDimensions = new JigsawStudioCellDimensions( - sourceObject.getW(), - sourceObject.getH(), - sourceObject.getD()); - JigsawStudioCellDimensions canonicalDimensions = canonicalDimensions(sourceDimensions, quarterTurns); - Map canonicalBlocks = canonicalBlocks( - sourceObject, - quarterTurns, - targetPieceKey); - Map canonicalTiles = canonicalTiles( - sourceObject, - quarterTurns, - targetPieceKey); - List connectors = targetPiece.getConnectors(); - if (connectors == null) { - throw new IOException("Planar piece '" + targetPieceKey + "' has no connector list"); - } - List connectorResizes = planConnectorResizes( - connectors, - sourceDimensions, - canonicalDimensions, - targetDimensions, - quarterTurns, - targetPieceKey); - relocateConnectorPayloads(canonicalBlocks, canonicalTiles, connectorResizes, targetPieceKey); - requireContentInsideTarget(canonicalBlocks, canonicalTiles, targetDimensions, targetPieceKey); - - JigsawStudioCellDimensions resizedSourceDimensions = sourceDimensions(targetDimensions, quarterTurns); - IrisObject resizedObject = rebuildSourceObject( - canonicalBlocks, - canonicalTiles, - resizedSourceDimensions, - quarterTurns, - targetPieceKey); - int relocatedConnectors = 0; - for (ConnectorResize connectorResize : connectorResizes) { - LocalPosition sourcePosition = toSource( - connectorResize.targetCanonical(), - resizedSourceDimensions, - quarterTurns); - connectorResize.connector().setPosition(sourcePosition.toIrisPosition()); - if (!connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { - relocatedConnectors++; - } - } - return new PlanarPieceObjectResize(resizedObject, relocatedConnectors); - } - - private static Map canonicalBlocks( - IrisObject source, - int quarterTurns, - String pieceKey - ) throws IOException { - Map blocks = new LinkedHashMap<>(); - for (Map.Entry entry : source.getBlocks()) { - LocalPosition sourcePosition = unsignedPosition(entry.getKey(), source); - requireInside(sourcePosition, source.getW(), source.getH(), source.getD(), - "stored block", pieceKey); - PlatformBlockState state = entry.getValue(); - if (state == null) { - throw new IOException("Planar piece '" + pieceKey + "' contains a null stored block state"); - } - LocalPosition canonicalPosition = toCanonical( - sourcePosition, - source.getW(), - source.getD(), - quarterTurns); - if (blocks.putIfAbsent(canonicalPosition, state) != null) { - throw new IOException("Planar piece '" + pieceKey - + "' maps more than one stored block to " + canonicalPosition.describe()); - } - } - return blocks; - } - - private static Map canonicalTiles( - IrisObject source, - int quarterTurns, - String pieceKey - ) throws IOException { - Map tiles = new LinkedHashMap<>(); - for (Map.Entry entry : source.getStates()) { - LocalPosition sourcePosition = unsignedPosition(entry.getKey(), source); - requireInside(sourcePosition, source.getW(), source.getH(), source.getD(), - "tile data", pieceKey); - TileData tile = entry.getValue(); - if (tile == null) { - throw new IOException("Planar piece '" + pieceKey + "' contains null tile data"); - } - LocalPosition canonicalPosition = toCanonical( - sourcePosition, - source.getW(), - source.getD(), - quarterTurns); - if (tiles.putIfAbsent(canonicalPosition, tile.clone()) != null) { - throw new IOException("Planar piece '" + pieceKey - + "' maps more than one tile payload to " + canonicalPosition.describe()); - } - } - return tiles; - } - - private static List planConnectorResizes( - List connectors, - JigsawStudioCellDimensions sourceDimensions, - JigsawStudioCellDimensions canonicalDimensions, - JigsawStudioCellDimensions targetDimensions, - int quarterTurns, - String pieceKey - ) throws IOException { - List planned = new ArrayList<>(connectors.size()); - Set sourcePositions = new LinkedHashSet<>(); - Set targetPositions = new LinkedHashSet<>(); - IrisPosition sourceSize = dimensionsPosition(sourceDimensions); - IrisPosition canonicalSize = dimensionsPosition(canonicalDimensions); - IrisPosition targetSize = dimensionsPosition(targetDimensions); - for (int index = 0; index < connectors.size(); index++) { - IrisJigsawConnector connector = connectors.get(index); - if (connector == null || connector.getPosition() == null || connector.getDirection() == null - || connector.getDirection().isVertical()) { - throw new IOException("Planar piece '" + pieceKey + "' contains invalid connector " + index); - } - LocalPosition sourcePosition = LocalPosition.from(connector.getPosition()); - requireInside( - sourcePosition, - sourceDimensions.width(), - sourceDimensions.height(), - sourceDimensions.depth(), - "connector " + index, - pieceKey); - if (!sourcePositions.add(sourcePosition)) { - throw new IOException("Planar piece '" + pieceKey - + "' has multiple connectors at " + sourcePosition.describe()); - } - LocalPosition sourceCanonical = toCanonical( - sourcePosition, - sourceDimensions.width(), - sourceDimensions.depth(), - quarterTurns); - IrisDirection canonicalDirection = rotateHorizontalDirection( - connector.getDirection(), - quarterTurns); - LocalPosition expectedSource = LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( - sourceSize, - connector.getDirection())); - LocalPosition expectedCanonical = LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( - canonicalSize, - canonicalDirection)); - boolean canonicalConnector = sourcePosition.equals(expectedSource) - || sourceCanonical.equals(expectedCanonical); - LocalPosition targetCanonical = canonicalConnector - ? LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( - targetSize, - canonicalDirection)) - : sourceCanonical; - if (!inside(targetCanonical, targetDimensions)) { - throw new IOException("Planar piece '" + pieceKey + "' connector " + index + " at " - + sourceCanonical.describe() + " would be cropped by the requested workcell bounds"); - } - if (!targetPositions.add(targetCanonical)) { - throw new IOException("Planar piece '" + pieceKey - + "' would place multiple connectors at " + targetCanonical.describe()); - } - planned.add(new ConnectorResize(connector, sourceCanonical, targetCanonical)); - } - return List.copyOf(planned); - } - - private static void relocateConnectorPayloads( - Map blocks, - Map tiles, - List connectorResizes, - String pieceKey - ) throws IOException { - Set relocatedSources = new LinkedHashSet<>(); - for (ConnectorResize connectorResize : connectorResizes) { - if (tiles.containsKey(connectorResize.sourceCanonical()) - || tiles.containsKey(connectorResize.targetCanonical())) { - throw new IOException("Planar piece '" + pieceKey + "' has tile data at connector position " - + connectorResize.sourceCanonical().describe() - + "; connector tile data cannot be resized safely"); - } - if (!connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { - relocatedSources.add(connectorResize.sourceCanonical()); - } - } - for (ConnectorResize connectorResize : connectorResizes) { - if (connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { - continue; - } - if (blocks.containsKey(connectorResize.targetCanonical()) - && !relocatedSources.contains(connectorResize.targetCanonical())) { - throw new IOException("Planar piece '" + pieceKey + "' cannot relocate connector from " - + connectorResize.sourceCanonical().describe() + " to " - + connectorResize.targetCanonical().describe() - + " because the destination contains a stored block"); - } - } - List payloads = new ArrayList<>(relocatedSources.size()); - for (ConnectorResize connectorResize : connectorResizes) { - if (connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { - continue; - } - boolean present = blocks.containsKey(connectorResize.sourceCanonical()); - PlatformBlockState state = blocks.remove(connectorResize.sourceCanonical()); - payloads.add(new BlockRelocation(connectorResize.targetCanonical(), state, present)); - } - for (BlockRelocation payload : payloads) { - if (!payload.present()) { - continue; - } - if (blocks.putIfAbsent(payload.target(), payload.state()) != null) { - throw new IOException("Planar piece '" + pieceKey - + "' has colliding connector block payloads at " + payload.target().describe()); - } - } - } - - private static void requireContentInsideTarget( - Map blocks, - Map tiles, - JigsawStudioCellDimensions dimensions, - String pieceKey - ) throws IOException { - for (LocalPosition position : blocks.keySet()) { - if (!inside(position, dimensions)) { - throw new IOException("Planar piece '" + pieceKey + "' has a stored block, including explicit air, at " - + position.describe() + " that would be cropped by the requested workcell bounds"); - } - } - for (LocalPosition position : tiles.keySet()) { - if (!inside(position, dimensions)) { - throw new IOException("Planar piece '" + pieceKey + "' has tile data at " - + position.describe() + " that would be cropped by the requested workcell bounds"); - } - } - } - - private static IrisObject rebuildSourceObject( - Map canonicalBlocks, - Map canonicalTiles, - JigsawStudioCellDimensions sourceDimensions, - int quarterTurns, - String pieceKey - ) throws IOException { - IrisObject resized = new IrisObject( - sourceDimensions.width(), - sourceDimensions.height(), - sourceDimensions.depth()); - Set sourcePositions = new LinkedHashSet<>(); - for (Map.Entry entry : canonicalBlocks.entrySet()) { - LocalPosition sourcePosition = toSource(entry.getKey(), sourceDimensions, quarterTurns); - if (!sourcePositions.add(sourcePosition)) { - throw new IOException("Planar piece '" + pieceKey - + "' maps multiple stored blocks to " + sourcePosition.describe()); - } - resized.setUnsigned( - sourcePosition.x(), - sourcePosition.y(), - sourcePosition.z(), - entry.getValue()); - } - sourcePositions.clear(); - for (Map.Entry entry : canonicalTiles.entrySet()) { - LocalPosition sourcePosition = toSource(entry.getKey(), sourceDimensions, quarterTurns); - if (!sourcePositions.add(sourcePosition)) { - throw new IOException("Planar piece '" + pieceKey - + "' maps multiple tile payloads to " + sourcePosition.describe()); - } - resized.setUnsignedTile( - sourcePosition.x(), - sourcePosition.y(), - sourcePosition.z(), - entry.getValue().clone()); - } - return resized; - } - - private static LocalPosition unsignedPosition(IrisBlockVector signed, IrisObject object) { - return new LocalPosition( - signed.getBlockX() + object.getCenter().getBlockX(), - signed.getBlockY() + object.getCenter().getBlockY(), - signed.getBlockZ() + object.getCenter().getBlockZ()); - } - - private static JigsawStudioCellDimensions canonicalDimensions( - JigsawStudioCellDimensions source, - int quarterTurns - ) { - return Math.floorMod(quarterTurns, 2) == 0 - ? source - : new JigsawStudioCellDimensions(source.depth(), source.height(), source.width()); - } - - private static JigsawStudioCellDimensions sourceDimensions( - JigsawStudioCellDimensions canonical, - int quarterTurns - ) { - return Math.floorMod(quarterTurns, 2) == 0 - ? canonical - : new JigsawStudioCellDimensions(canonical.depth(), canonical.height(), canonical.width()); - } - - private static LocalPosition toCanonical( - LocalPosition source, - int sourceWidth, - int sourceDepth, - int quarterTurns - ) { - return switch (Math.floorMod(quarterTurns, 4)) { - case 0 -> source; - case 1 -> new LocalPosition(sourceDepth - 1 - source.z(), source.y(), source.x()); - case 2 -> new LocalPosition( - sourceWidth - 1 - source.x(), - source.y(), - sourceDepth - 1 - source.z()); - case 3 -> new LocalPosition(source.z(), source.y(), sourceWidth - 1 - source.x()); - default -> throw new IllegalStateException("Unreachable planar object rotation"); - }; - } - - private static LocalPosition toSource( - LocalPosition canonical, - JigsawStudioCellDimensions sourceDimensions, - int quarterTurns - ) { - return switch (Math.floorMod(quarterTurns, 4)) { - case 0 -> canonical; - case 1 -> new LocalPosition( - canonical.z(), - canonical.y(), - sourceDimensions.depth() - 1 - canonical.x()); - case 2 -> new LocalPosition( - sourceDimensions.width() - 1 - canonical.x(), - canonical.y(), - sourceDimensions.depth() - 1 - canonical.z()); - case 3 -> new LocalPosition( - sourceDimensions.width() - 1 - canonical.z(), - canonical.y(), - canonical.x()); - default -> throw new IllegalStateException("Unreachable planar object rotation"); - }; - } - - private static IrisDirection rotateHorizontalDirection(IrisDirection direction, int quarterTurns) { - JigsawPlanarDirection planarDirection = switch (direction) { - case NORTH_NEGATIVE_Z -> JigsawPlanarDirection.NORTH; - case EAST_POSITIVE_X -> JigsawPlanarDirection.EAST; - case SOUTH_POSITIVE_Z -> JigsawPlanarDirection.SOUTH; - case WEST_NEGATIVE_X -> JigsawPlanarDirection.WEST; - case UP_POSITIVE_Y, DOWN_NEGATIVE_Y -> throw new IllegalArgumentException( - "Planar connector direction must be horizontal"); - }; - return planarDirection.rotateClockwise(quarterTurns).irisDirection(); - } - - private static IrisPosition dimensionsPosition(JigsawStudioCellDimensions dimensions) { - return new IrisPosition(dimensions.width(), dimensions.height(), dimensions.depth()); - } - - private static boolean inside(LocalPosition position, JigsawStudioCellDimensions dimensions) { - return inside(position, dimensions.width(), dimensions.height(), dimensions.depth()); - } - - private static boolean inside(LocalPosition position, int width, int height, int depth) { - return position.x() >= 0 && position.x() < width - && position.y() >= 0 && position.y() < height - && position.z() >= 0 && position.z() < depth; - } - - private static void requireInside( - LocalPosition position, - int width, - int height, - int depth, - String content, - String pieceKey - ) throws IOException { - if (!inside(position, width, height, depth)) { - throw new IOException("Planar piece '" + pieceKey + "' has " + content + " at " - + position.describe() + " outside its object bounds"); - } - } - - static IrisObject resizeObject( - IrisObject source, - JigsawStudioCellDimensions dimensions, - String pieceKey - ) throws IOException { - IrisObject object = Objects.requireNonNull(source, "Jigsaw Studio source object"); - JigsawStudioCellDimensions target = Objects.requireNonNull( - dimensions, - "Jigsaw Studio target object dimensions"); - String normalizedPiece = pieceKey == null || pieceKey.isBlank() ? "unknown" : pieceKey; - IrisObject resized = new IrisObject(target.width(), target.height(), target.depth()); - for (Map.Entry entry : object.getBlocks()) { - IrisBlockVector position = entry.getKey(); - LocalPosition unsigned = unsignedPosition(position, object); - if (!inside(unsigned, target)) { - throw new IOException("Spatial piece '" + normalizedPiece - + "' has a stored block, including explicit air, at " + unsigned.describe() - + " that would be cropped by the requested variant size"); - } - resized.setUnsigned( - unsigned.x(), - unsigned.y(), - unsigned.z(), - entry.getValue()); - } - for (Map.Entry entry : object.getStates()) { - IrisBlockVector position = entry.getKey(); - LocalPosition unsigned = unsignedPosition(position, object); - if (!inside(unsigned, target)) { - throw new IOException("Spatial piece '" + normalizedPiece + "' has tile data at " - + unsigned.describe() + " that would be cropped by the requested variant size"); - } - resized.setUnsignedTile( - unsigned.x(), - unsigned.y(), - unsigned.z(), - entry.getValue().clone()); - } - return resized; - } - - private static void requireConnectorsInside( - IrisJigsawPiece piece, - JigsawStudioCellDimensions dimensions, - String pieceKey - ) throws IOException { - if (piece.getConnectors() == null) { - throw new IOException("Spatial piece '" + pieceKey + "' has no connector list"); - } - for (int index = 0; index < piece.getConnectors().size(); index++) { - IrisJigsawConnector connector = piece.getConnectors().get(index); - if (connector == null || connector.getPosition() == null) { - throw new IOException("Spatial piece '" + pieceKey + "' contains invalid connector " + index); - } - LocalPosition position = LocalPosition.from(connector.getPosition()); - if (!inside(position, dimensions)) { - throw new IOException("Spatial piece '" + pieceKey + "' connector " + index + " at " - + position.describe() + " would be cropped by the requested variant size"); - } - } - } - - private static String describeDimensions(JigsawStudioCellDimensions dimensions) { - return dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth(); - } - - private static String normalizeChannel(String channel) { - String normalized = channel == null ? "" : channel.trim(); - if (normalized.equalsIgnoreCase("none")) { - return ""; - } - if (normalized.length() > 128) { - throw new IllegalArgumentException("Jigsaw connector channels cannot exceed 128 characters"); - } - for (int index = 0; index < normalized.length(); index++) { - if (Character.isWhitespace(normalized.charAt(index))) { - throw new IllegalArgumentException("Jigsaw connector channels cannot contain whitespace"); - } - } - return normalized; - } - private static StructureWriteResult write(OwnedGraph graph, StructureResourceBundle bundle) throws IOException { StructureResourceBundleGraphCompiler.requireViable(bundle); return writeCompiled(graph, bundle); @@ -1804,80 +929,18 @@ public final class JigsawStudioGraphEditor { void edit(JsonObject piece, String pieceResource) throws IOException; } - private record PoolEntryRemoval(byte[] content, int removedEntries) { - private PoolEntryRemoval { - Objects.requireNonNull(content, "Jigsaw Studio pool entry removal content"); - if (removedEntries < 0) { - throw new IllegalArgumentException("Removed jigsaw pool entry count cannot be negative"); - } - } - } - - private record PoolMembershipDuplication(byte[] content, int duplicatedEntries) { - private PoolMembershipDuplication { - Objects.requireNonNull(content, "Jigsaw Studio duplicated pool content"); - if (duplicatedEntries < 0) { - throw new IllegalArgumentException("Duplicated pool membership count cannot be negative"); - } - } - } - private enum VariantObjectMode { COPY_SOURCE, EMPTY_SOURCE_SIZE } - record PlanarPieceObjectResize(IrisObject object, int relocatedConnectors) { - PlanarPieceObjectResize { - Objects.requireNonNull(object, "Resized planar Jigsaw Studio object"); - if (relocatedConnectors < 0) { - throw new IllegalArgumentException("Relocated connector count cannot be negative"); - } - } - } - - private record ConnectorResize( - IrisJigsawConnector connector, - LocalPosition sourceCanonical, - LocalPosition targetCanonical - ) { - private ConnectorResize { - Objects.requireNonNull(connector, "Planar Jigsaw Studio connector"); - Objects.requireNonNull(sourceCanonical, "Planar Jigsaw Studio source connector position"); - Objects.requireNonNull(targetCanonical, "Planar Jigsaw Studio target connector position"); - } - } - - private record BlockRelocation(LocalPosition target, PlatformBlockState state, boolean present) { - private BlockRelocation { - Objects.requireNonNull(target, "Planar Jigsaw Studio connector block target"); - if (present) { - Objects.requireNonNull(state, "Planar Jigsaw Studio connector block state"); - } - } - } - - private record LocalPosition(int x, int y, int z) { - private static LocalPosition from(IrisPosition position) { - return new LocalPosition(position.getX(), position.getY(), position.getZ()); - } - - private IrisPosition toIrisPosition() { - return new IrisPosition(x, y, z); - } - - private String describe() { - return x + "," + y + "," + z; - } - } - - private record OwnedGraph( + record OwnedGraph( Path root, StructureTransactionWriter writer, StructureOwnershipManifest manifest, String expectedManifestHash ) { - private StructureResourceBundle.Builder bundleBuilder() { + StructureResourceBundle.Builder bundleBuilder() { return StructureResourceBundle.builder(manifest.structure()) .source(manifest.source()) .backend(manifest.backend()) diff --git a/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphInspector.java b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphInspector.java new file mode 100644 index 000000000..3be84bdc6 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphInspector.java @@ -0,0 +1,153 @@ +package art.arcane.iris.core.runtime.jigsaw; + +import art.arcane.iris.core.structure.authoring.StructureResourceBundle; +import art.arcane.iris.engine.framework.structure.PlanarJigsawWorkcellResolver; +import art.arcane.iris.engine.object.IrisJigsawMode; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisJigsawWorkcellArchetype; +import art.arcane.iris.engine.object.IrisStructure; + +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.LinkOption; +import java.nio.file.Path; +import java.util.Map; + +final class JigsawStudioGraphInspector { + private JigsawStudioGraphInspector() { + } + + static void requireAvailableVariantTarget( + JigsawStudioGraphEditor.OwnedGraph graph, + String relativePath + ) throws IOException { + StructureResourceBundle.validateRelativePath(relativePath); + Path target = graph.root().resolve(relativePath).normalize(); + if (!target.startsWith(graph.root())) { + throw new IOException("Variant target escapes the pack root: " + relativePath); + } + if (graph.manifest().resourceHashes().containsKey(relativePath) + || Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Variant target already exists: " + relativePath); + } + } + + static void requireAvailableThemeSetTarget( + JigsawStudioGraphEditor.OwnedGraph graph, + String relativePath + ) throws IOException { + StructureResourceBundle.validateRelativePath(relativePath); + Path target = graph.root().resolve(relativePath).normalize(); + if (!target.startsWith(graph.root())) { + throw new IOException("Theme-set target escapes the pack root: " + relativePath); + } + if (graph.manifest().resourceHashes().containsKey(relativePath) + || Files.exists(target, LinkOption.NOFOLLOW_LINKS)) { + throw new IOException("Theme-set target already exists: " + relativePath); + } + } + + static boolean otherOwnedPieceReferencesObject( + JigsawStudioGraphEditor.OwnedGraph graph, + String targetPieceKey, + String objectKey + ) throws IOException { + for (String relativePath : graph.manifest().resourceHashes().keySet()) { + if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { + continue; + } + String pieceKey = JigsawStudioGraphDocuments.resourceKey(relativePath, "jigsaw-pieces/", ".json"); + if (pieceKey.equals(targetPieceKey)) { + continue; + } + IrisJigsawPiece piece = JigsawStudioGraphEditor.readPiece(JigsawStudioGraphEditor.resolveOwnedResource(graph.root(), relativePath), relativePath); + if (objectKey.equals(piece.getObject())) { + return true; + } + } + return false; + } + + static void requireDeletableArchetype( + JigsawStudioGraphEditor.OwnedGraph graph, + String targetPieceKey, + IrisJigsawPiece targetPiece + ) throws IOException { + String structureResource = "structures/" + graph.manifest().structure().path() + ".json"; + if (!graph.manifest().resourceHashes().containsKey(structureResource)) { + throw new IOException("The owned graph manifest does not include " + structureResource); + } + IrisStructure structure = JigsawStudioGraphEditor.readStructure( + JigsawStudioGraphEditor.resolveOwnedResource(graph.root(), structureResource), + structureResource); + if (structure.resolvedMode() == IrisJigsawMode.SPATIAL_JIGSAW) { + if (countOtherOwnedPieces(graph, targetPieceKey, null) == 0) { + throw new IOException("Cannot delete the final spatial jigsaw variant"); + } + return; + } + IrisJigsawWorkcellArchetype archetype = IrisJigsawWorkcellArchetype.fromPiece(targetPiece); + Map workcells; + try { + workcells = PlanarJigsawWorkcellResolver.resolve(structure); + } catch (IllegalArgumentException exception) { + throw new IOException("Planar workcell configuration is invalid: " + + exception.getMessage(), exception); + } + PlanarJigsawWorkcellResolver.ResolvedWorkcell workcell = workcells.get(archetype); + if (workcell != null && workcell.enabled() + && countOtherOwnedPieces(graph, targetPieceKey, archetype) == 0) { + throw new IOException("Cannot delete the final variant for enabled planar workcell " + + JigsawPlanarArchetype.fromModel(archetype).stableId()); + } + } + + static int countOtherOwnedPieces( + JigsawStudioGraphEditor.OwnedGraph graph, + String targetPieceKey, + IrisJigsawWorkcellArchetype archetype + ) throws IOException { + int count = 0; + for (String relativePath : graph.manifest().resourceHashes().keySet()) { + if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { + continue; + } + String pieceKey = JigsawStudioGraphDocuments.resourceKey(relativePath, "jigsaw-pieces/", ".json"); + if (pieceKey.equals(targetPieceKey)) { + continue; + } + if (archetype == null) { + count++; + continue; + } + IrisJigsawPiece piece = JigsawStudioGraphEditor.readPiece(JigsawStudioGraphEditor.resolveOwnedResource(graph.root(), relativePath), relativePath); + if (IrisJigsawWorkcellArchetype.fromPiece(piece) == archetype) { + count++; + } + } + return count; + } + + static void requireExclusiveObjectReference( + JigsawStudioGraphEditor.OwnedGraph graph, + String activePieceKey, + String objectKey + ) throws IOException { + for (String relativePath : graph.manifest().resourceHashes().keySet()) { + if (!relativePath.startsWith("jigsaw-pieces/") || !relativePath.endsWith(".json")) { + continue; + } + String pieceKey = relativePath.substring( + "jigsaw-pieces/".length(), + relativePath.length() - ".json".length()); + if (pieceKey.equals(activePieceKey)) { + continue; + } + IrisJigsawPiece piece = JigsawStudioGraphEditor.readPiece(JigsawStudioGraphEditor.resolveOwnedResource(graph.root(), relativePath), relativePath); + if (objectKey.equals(piece.getObject())) { + throw new IOException("Object '" + objectKey + "' is shared by piece '" + pieceKey + + "'; duplicate the active variant before resizing its object bounds"); + } + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioObjectResizer.java b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioObjectResizer.java new file mode 100644 index 000000000..20875644d --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioObjectResizer.java @@ -0,0 +1,548 @@ +package art.arcane.iris.core.runtime.jigsaw; + +import art.arcane.iris.engine.object.IrisDirection; +import art.arcane.iris.engine.object.IrisJigsawConnector; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisJigsawWorkcellArchetype; +import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.engine.object.TileData; +import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.util.common.math.IrisBlockVector; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +final class JigsawStudioObjectResizer { + private JigsawStudioObjectResizer() { + } + + static PlanarPieceObjectResize resizePlanarPieceObject( + IrisObject source, + IrisJigsawPiece piece, + JigsawPlanarArchetype archetype, + JigsawStudioCellDimensions dimensions, + String pieceKey + ) throws IOException { + IrisObject sourceObject = Objects.requireNonNull(source, "Planar Jigsaw Studio source object"); + IrisJigsawPiece targetPiece = Objects.requireNonNull(piece, "Planar Jigsaw Studio piece"); + JigsawPlanarArchetype targetArchetype = Objects.requireNonNull( + archetype, + "Planar Jigsaw Studio archetype"); + JigsawStudioCellDimensions targetDimensions = Objects.requireNonNull( + dimensions, + "Planar Jigsaw Studio target dimensions"); + String targetPieceKey = pieceKey == null || pieceKey.isBlank() ? "unknown" : pieceKey; + if (targetDimensions.width() < 3 || targetDimensions.depth() < 3) { + throw new IllegalArgumentException( + "Planar Jigsaw Studio workcell width and depth must each be at least 3 blocks"); + } + if (sourceObject.getW() < 1 || sourceObject.getH() < 1 || sourceObject.getD() < 1) { + throw new IOException("Planar piece '" + targetPieceKey + "' has invalid object dimensions"); + } + if (IrisJigsawWorkcellArchetype.fromPiece(targetPiece) != targetArchetype.modelArchetype()) { + throw new IOException("Planar piece '" + targetPieceKey + "' does not belong to " + + targetArchetype.stableId()); + } + + int quarterTurns = targetArchetype.modelArchetype().sourceToCanonicalQuarterTurns(targetPiece); + JigsawStudioCellDimensions sourceDimensions = new JigsawStudioCellDimensions( + sourceObject.getW(), + sourceObject.getH(), + sourceObject.getD()); + JigsawStudioCellDimensions canonicalDimensions = canonicalDimensions(sourceDimensions, quarterTurns); + Map canonicalBlocks = canonicalBlocks( + sourceObject, + quarterTurns, + targetPieceKey); + Map canonicalTiles = canonicalTiles( + sourceObject, + quarterTurns, + targetPieceKey); + List connectors = targetPiece.getConnectors(); + if (connectors == null) { + throw new IOException("Planar piece '" + targetPieceKey + "' has no connector list"); + } + List connectorResizes = planConnectorResizes( + connectors, + sourceDimensions, + canonicalDimensions, + targetDimensions, + quarterTurns, + targetPieceKey); + relocateConnectorPayloads(canonicalBlocks, canonicalTiles, connectorResizes, targetPieceKey); + requireContentInsideTarget(canonicalBlocks, canonicalTiles, targetDimensions, targetPieceKey); + + JigsawStudioCellDimensions resizedSourceDimensions = sourceDimensions(targetDimensions, quarterTurns); + IrisObject resizedObject = rebuildSourceObject( + canonicalBlocks, + canonicalTiles, + resizedSourceDimensions, + quarterTurns, + targetPieceKey); + int relocatedConnectors = 0; + for (ConnectorResize connectorResize : connectorResizes) { + LocalPosition sourcePosition = toSource( + connectorResize.targetCanonical(), + resizedSourceDimensions, + quarterTurns); + connectorResize.connector().setPosition(sourcePosition.toIrisPosition()); + if (!connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { + relocatedConnectors++; + } + } + return new PlanarPieceObjectResize(resizedObject, relocatedConnectors); + } + + private static Map canonicalBlocks( + IrisObject source, + int quarterTurns, + String pieceKey + ) throws IOException { + Map blocks = new LinkedHashMap<>(); + for (Map.Entry entry : source.getBlocks()) { + LocalPosition sourcePosition = unsignedPosition(entry.getKey(), source); + requireInside(sourcePosition, source.getW(), source.getH(), source.getD(), + "stored block", pieceKey); + PlatformBlockState state = entry.getValue(); + if (state == null) { + throw new IOException("Planar piece '" + pieceKey + "' contains a null stored block state"); + } + LocalPosition canonicalPosition = toCanonical( + sourcePosition, + source.getW(), + source.getD(), + quarterTurns); + if (blocks.putIfAbsent(canonicalPosition, state) != null) { + throw new IOException("Planar piece '" + pieceKey + + "' maps more than one stored block to " + canonicalPosition.describe()); + } + } + return blocks; + } + + private static Map canonicalTiles( + IrisObject source, + int quarterTurns, + String pieceKey + ) throws IOException { + Map tiles = new LinkedHashMap<>(); + for (Map.Entry entry : source.getStates()) { + LocalPosition sourcePosition = unsignedPosition(entry.getKey(), source); + requireInside(sourcePosition, source.getW(), source.getH(), source.getD(), + "tile data", pieceKey); + TileData tile = entry.getValue(); + if (tile == null) { + throw new IOException("Planar piece '" + pieceKey + "' contains null tile data"); + } + LocalPosition canonicalPosition = toCanonical( + sourcePosition, + source.getW(), + source.getD(), + quarterTurns); + if (tiles.putIfAbsent(canonicalPosition, tile.clone()) != null) { + throw new IOException("Planar piece '" + pieceKey + + "' maps more than one tile payload to " + canonicalPosition.describe()); + } + } + return tiles; + } + + private static List planConnectorResizes( + List connectors, + JigsawStudioCellDimensions sourceDimensions, + JigsawStudioCellDimensions canonicalDimensions, + JigsawStudioCellDimensions targetDimensions, + int quarterTurns, + String pieceKey + ) throws IOException { + List planned = new ArrayList<>(connectors.size()); + Set sourcePositions = new LinkedHashSet<>(); + Set targetPositions = new LinkedHashSet<>(); + IrisPosition sourceSize = dimensionsPosition(sourceDimensions); + IrisPosition canonicalSize = dimensionsPosition(canonicalDimensions); + IrisPosition targetSize = dimensionsPosition(targetDimensions); + for (int index = 0; index < connectors.size(); index++) { + IrisJigsawConnector connector = connectors.get(index); + if (connector == null || connector.getPosition() == null || connector.getDirection() == null + || connector.getDirection().isVertical()) { + throw new IOException("Planar piece '" + pieceKey + "' contains invalid connector " + index); + } + LocalPosition sourcePosition = LocalPosition.from(connector.getPosition()); + requireInside( + sourcePosition, + sourceDimensions.width(), + sourceDimensions.height(), + sourceDimensions.depth(), + "connector " + index, + pieceKey); + if (!sourcePositions.add(sourcePosition)) { + throw new IOException("Planar piece '" + pieceKey + + "' has multiple connectors at " + sourcePosition.describe()); + } + LocalPosition sourceCanonical = toCanonical( + sourcePosition, + sourceDimensions.width(), + sourceDimensions.depth(), + quarterTurns); + IrisDirection canonicalDirection = rotateHorizontalDirection( + connector.getDirection(), + quarterTurns); + LocalPosition expectedSource = LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( + sourceSize, + connector.getDirection())); + LocalPosition expectedCanonical = LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( + canonicalSize, + canonicalDirection)); + boolean canonicalConnector = sourcePosition.equals(expectedSource) + || sourceCanonical.equals(expectedCanonical); + LocalPosition targetCanonical = canonicalConnector + ? LocalPosition.from(IrisJigsawConnector.canonicalPlanarPosition( + targetSize, + canonicalDirection)) + : sourceCanonical; + if (!inside(targetCanonical, targetDimensions)) { + throw new IOException("Planar piece '" + pieceKey + "' connector " + index + " at " + + sourceCanonical.describe() + " would be cropped by the requested workcell bounds"); + } + if (!targetPositions.add(targetCanonical)) { + throw new IOException("Planar piece '" + pieceKey + + "' would place multiple connectors at " + targetCanonical.describe()); + } + planned.add(new ConnectorResize(connector, sourceCanonical, targetCanonical)); + } + return List.copyOf(planned); + } + + private static void relocateConnectorPayloads( + Map blocks, + Map tiles, + List connectorResizes, + String pieceKey + ) throws IOException { + Set relocatedSources = new LinkedHashSet<>(); + for (ConnectorResize connectorResize : connectorResizes) { + if (tiles.containsKey(connectorResize.sourceCanonical()) + || tiles.containsKey(connectorResize.targetCanonical())) { + throw new IOException("Planar piece '" + pieceKey + "' has tile data at connector position " + + connectorResize.sourceCanonical().describe() + + "; connector tile data cannot be resized safely"); + } + if (!connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { + relocatedSources.add(connectorResize.sourceCanonical()); + } + } + for (ConnectorResize connectorResize : connectorResizes) { + if (connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { + continue; + } + if (blocks.containsKey(connectorResize.targetCanonical()) + && !relocatedSources.contains(connectorResize.targetCanonical())) { + throw new IOException("Planar piece '" + pieceKey + "' cannot relocate connector from " + + connectorResize.sourceCanonical().describe() + " to " + + connectorResize.targetCanonical().describe() + + " because the destination contains a stored block"); + } + } + List payloads = new ArrayList<>(relocatedSources.size()); + for (ConnectorResize connectorResize : connectorResizes) { + if (connectorResize.sourceCanonical().equals(connectorResize.targetCanonical())) { + continue; + } + boolean present = blocks.containsKey(connectorResize.sourceCanonical()); + PlatformBlockState state = blocks.remove(connectorResize.sourceCanonical()); + payloads.add(new BlockRelocation(connectorResize.targetCanonical(), state, present)); + } + for (BlockRelocation payload : payloads) { + if (!payload.present()) { + continue; + } + if (blocks.putIfAbsent(payload.target(), payload.state()) != null) { + throw new IOException("Planar piece '" + pieceKey + + "' has colliding connector block payloads at " + payload.target().describe()); + } + } + } + + private static void requireContentInsideTarget( + Map blocks, + Map tiles, + JigsawStudioCellDimensions dimensions, + String pieceKey + ) throws IOException { + for (LocalPosition position : blocks.keySet()) { + if (!inside(position, dimensions)) { + throw new IOException("Planar piece '" + pieceKey + "' has a stored block, including explicit air, at " + + position.describe() + " that would be cropped by the requested workcell bounds"); + } + } + for (LocalPosition position : tiles.keySet()) { + if (!inside(position, dimensions)) { + throw new IOException("Planar piece '" + pieceKey + "' has tile data at " + + position.describe() + " that would be cropped by the requested workcell bounds"); + } + } + } + + private static IrisObject rebuildSourceObject( + Map canonicalBlocks, + Map canonicalTiles, + JigsawStudioCellDimensions sourceDimensions, + int quarterTurns, + String pieceKey + ) throws IOException { + IrisObject resized = new IrisObject( + sourceDimensions.width(), + sourceDimensions.height(), + sourceDimensions.depth()); + Set sourcePositions = new LinkedHashSet<>(); + for (Map.Entry entry : canonicalBlocks.entrySet()) { + LocalPosition sourcePosition = toSource(entry.getKey(), sourceDimensions, quarterTurns); + if (!sourcePositions.add(sourcePosition)) { + throw new IOException("Planar piece '" + pieceKey + + "' maps multiple stored blocks to " + sourcePosition.describe()); + } + resized.setUnsigned( + sourcePosition.x(), + sourcePosition.y(), + sourcePosition.z(), + entry.getValue()); + } + sourcePositions.clear(); + for (Map.Entry entry : canonicalTiles.entrySet()) { + LocalPosition sourcePosition = toSource(entry.getKey(), sourceDimensions, quarterTurns); + if (!sourcePositions.add(sourcePosition)) { + throw new IOException("Planar piece '" + pieceKey + + "' maps multiple tile payloads to " + sourcePosition.describe()); + } + resized.setUnsignedTile( + sourcePosition.x(), + sourcePosition.y(), + sourcePosition.z(), + entry.getValue().clone()); + } + return resized; + } + + private static LocalPosition unsignedPosition(IrisBlockVector signed, IrisObject object) { + return new LocalPosition( + signed.getBlockX() + object.getCenter().getBlockX(), + signed.getBlockY() + object.getCenter().getBlockY(), + signed.getBlockZ() + object.getCenter().getBlockZ()); + } + + static JigsawStudioCellDimensions canonicalDimensions( + JigsawStudioCellDimensions source, + int quarterTurns + ) { + return Math.floorMod(quarterTurns, 2) == 0 + ? source + : new JigsawStudioCellDimensions(source.depth(), source.height(), source.width()); + } + + private static JigsawStudioCellDimensions sourceDimensions( + JigsawStudioCellDimensions canonical, + int quarterTurns + ) { + return Math.floorMod(quarterTurns, 2) == 0 + ? canonical + : new JigsawStudioCellDimensions(canonical.depth(), canonical.height(), canonical.width()); + } + + private static LocalPosition toCanonical( + LocalPosition source, + int sourceWidth, + int sourceDepth, + int quarterTurns + ) { + return switch (Math.floorMod(quarterTurns, 4)) { + case 0 -> source; + case 1 -> new LocalPosition(sourceDepth - 1 - source.z(), source.y(), source.x()); + case 2 -> new LocalPosition( + sourceWidth - 1 - source.x(), + source.y(), + sourceDepth - 1 - source.z()); + case 3 -> new LocalPosition(source.z(), source.y(), sourceWidth - 1 - source.x()); + default -> throw new IllegalStateException("Unreachable planar object rotation"); + }; + } + + private static LocalPosition toSource( + LocalPosition canonical, + JigsawStudioCellDimensions sourceDimensions, + int quarterTurns + ) { + return switch (Math.floorMod(quarterTurns, 4)) { + case 0 -> canonical; + case 1 -> new LocalPosition( + canonical.z(), + canonical.y(), + sourceDimensions.depth() - 1 - canonical.x()); + case 2 -> new LocalPosition( + sourceDimensions.width() - 1 - canonical.x(), + canonical.y(), + sourceDimensions.depth() - 1 - canonical.z()); + case 3 -> new LocalPosition( + sourceDimensions.width() - 1 - canonical.z(), + canonical.y(), + canonical.x()); + default -> throw new IllegalStateException("Unreachable planar object rotation"); + }; + } + + private static IrisDirection rotateHorizontalDirection(IrisDirection direction, int quarterTurns) { + JigsawPlanarDirection planarDirection = switch (direction) { + case NORTH_NEGATIVE_Z -> JigsawPlanarDirection.NORTH; + case EAST_POSITIVE_X -> JigsawPlanarDirection.EAST; + case SOUTH_POSITIVE_Z -> JigsawPlanarDirection.SOUTH; + case WEST_NEGATIVE_X -> JigsawPlanarDirection.WEST; + case UP_POSITIVE_Y, DOWN_NEGATIVE_Y -> throw new IllegalArgumentException( + "Planar connector direction must be horizontal"); + }; + return planarDirection.rotateClockwise(quarterTurns).irisDirection(); + } + + static IrisPosition dimensionsPosition(JigsawStudioCellDimensions dimensions) { + return new IrisPosition(dimensions.width(), dimensions.height(), dimensions.depth()); + } + + private static boolean inside(LocalPosition position, JigsawStudioCellDimensions dimensions) { + return inside(position, dimensions.width(), dimensions.height(), dimensions.depth()); + } + + private static boolean inside(LocalPosition position, int width, int height, int depth) { + return position.x() >= 0 && position.x() < width + && position.y() >= 0 && position.y() < height + && position.z() >= 0 && position.z() < depth; + } + + private static void requireInside( + LocalPosition position, + int width, + int height, + int depth, + String content, + String pieceKey + ) throws IOException { + if (!inside(position, width, height, depth)) { + throw new IOException("Planar piece '" + pieceKey + "' has " + content + " at " + + position.describe() + " outside its object bounds"); + } + } + + static IrisObject resizeObject( + IrisObject source, + JigsawStudioCellDimensions dimensions, + String pieceKey + ) throws IOException { + IrisObject object = Objects.requireNonNull(source, "Jigsaw Studio source object"); + JigsawStudioCellDimensions target = Objects.requireNonNull( + dimensions, + "Jigsaw Studio target object dimensions"); + String normalizedPiece = pieceKey == null || pieceKey.isBlank() ? "unknown" : pieceKey; + IrisObject resized = new IrisObject(target.width(), target.height(), target.depth()); + for (Map.Entry entry : object.getBlocks()) { + IrisBlockVector position = entry.getKey(); + LocalPosition unsigned = unsignedPosition(position, object); + if (!inside(unsigned, target)) { + throw new IOException("Spatial piece '" + normalizedPiece + + "' has a stored block, including explicit air, at " + unsigned.describe() + + " that would be cropped by the requested variant size"); + } + resized.setUnsigned( + unsigned.x(), + unsigned.y(), + unsigned.z(), + entry.getValue()); + } + for (Map.Entry entry : object.getStates()) { + IrisBlockVector position = entry.getKey(); + LocalPosition unsigned = unsignedPosition(position, object); + if (!inside(unsigned, target)) { + throw new IOException("Spatial piece '" + normalizedPiece + "' has tile data at " + + unsigned.describe() + " that would be cropped by the requested variant size"); + } + resized.setUnsignedTile( + unsigned.x(), + unsigned.y(), + unsigned.z(), + entry.getValue().clone()); + } + return resized; + } + + static void requireConnectorsInside( + IrisJigsawPiece piece, + JigsawStudioCellDimensions dimensions, + String pieceKey + ) throws IOException { + if (piece.getConnectors() == null) { + throw new IOException("Spatial piece '" + pieceKey + "' has no connector list"); + } + for (int index = 0; index < piece.getConnectors().size(); index++) { + IrisJigsawConnector connector = piece.getConnectors().get(index); + if (connector == null || connector.getPosition() == null) { + throw new IOException("Spatial piece '" + pieceKey + "' contains invalid connector " + index); + } + LocalPosition position = LocalPosition.from(connector.getPosition()); + if (!inside(position, dimensions)) { + throw new IOException("Spatial piece '" + pieceKey + "' connector " + index + " at " + + position.describe() + " would be cropped by the requested variant size"); + } + } + } + + static String describeDimensions(JigsawStudioCellDimensions dimensions) { + return dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth(); + } + + record PlanarPieceObjectResize(IrisObject object, int relocatedConnectors) { + PlanarPieceObjectResize { + Objects.requireNonNull(object, "Resized planar Jigsaw Studio object"); + if (relocatedConnectors < 0) { + throw new IllegalArgumentException("Relocated connector count cannot be negative"); + } + } + } + + private record ConnectorResize( + IrisJigsawConnector connector, + LocalPosition sourceCanonical, + LocalPosition targetCanonical + ) { + private ConnectorResize { + Objects.requireNonNull(connector, "Planar Jigsaw Studio connector"); + Objects.requireNonNull(sourceCanonical, "Planar Jigsaw Studio source connector position"); + Objects.requireNonNull(targetCanonical, "Planar Jigsaw Studio target connector position"); + } + } + + private record BlockRelocation(LocalPosition target, PlatformBlockState state, boolean present) { + private BlockRelocation { + Objects.requireNonNull(target, "Planar Jigsaw Studio connector block target"); + if (present) { + Objects.requireNonNull(state, "Planar Jigsaw Studio connector block state"); + } + } + } + + private record LocalPosition(int x, int y, int z) { + private static LocalPosition from(IrisPosition position) { + return new LocalPosition(position.getX(), position.getY(), position.getZ()); + } + + private IrisPosition toIrisPosition() { + return new IrisPosition(x, y, z); + } + + private String describe() { + return x + "," + y + "," + z; + } + } +} diff --git a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java index 9c8c1ca04..55d158904 100644 --- a/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java +++ b/core/src/test/java/art/arcane/iris/core/runtime/jigsaw/JigsawStudioGraphEditorResizeTest.java @@ -147,8 +147,8 @@ public class JigsawStudioGraphEditorResizeTest { source.setUnsigned(4, 1, 1, stone); IrisJigsawPiece piece = endPiece(IrisDirection.EAST_POSITIVE_X, new IrisPosition(6, 1, 2)); - JigsawStudioGraphEditor.PlanarPieceObjectResize result = - JigsawStudioGraphEditor.resizePlanarPieceObject( + JigsawStudioObjectResizer.PlanarPieceObjectResize result = + JigsawStudioObjectResizer.resizePlanarPieceObject( source, piece, JigsawPlanarArchetype.END, @@ -175,7 +175,7 @@ public class JigsawStudioGraphEditorResizeTest { IOException failure = assertThrows( IOException.class, - () -> JigsawStudioGraphEditor.resizePlanarPieceObject( + () -> JigsawStudioObjectResizer.resizePlanarPieceObject( source, piece, JigsawPlanarArchetype.BLANK, @@ -199,7 +199,7 @@ public class JigsawStudioGraphEditorResizeTest { IOException failure = assertThrows( IOException.class, - () -> JigsawStudioGraphEditor.resizePlanarPieceObject( + () -> JigsawStudioObjectResizer.resizePlanarPieceObject( source, piece, JigsawPlanarArchetype.END, diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPersistenceIdentityTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPersistenceIdentityTest.java new file mode 100644 index 0000000000000000000000000000000000000000..78b623908c597465e38a5c89717568f29fbfada8 GIT binary patch literal 9937 zcmd5?ZFAc;628y*6*zq{Jyqa$J8siV6j@G`I8M z07;0XB0K5KX=2L~!R79=&%R)hg!!M@oD(Kf%B0UCPK6YT`my9xad{_v{>zgm;x>t8 z+Pq3;Q7UdZy%BT8?&(|ob``RS$)5BVJY6Or;=vNeX%>jM&%^Kxq(@4`k$SwC_%>mw zn2J!O%L$Wno<3UEYsr$uAP{LRA1&iu96TPAE5Us}%0m8lJg(w6{7w_DWPHQ@v@bdP z9wf%8%=|Qyd=qt)T})Y)E@CO7IV}XdVQSIp5FX71a66u&&U6SA&v`mo@LN7!!-kZr zRAmX$pPprs?>L)47Tx`WAi-LXaDkBx_o8#Uw;np>ize^d^f$O8X&G z3LV^Vt>xDura@lhUI-1)hcstKSCy z$yiuIw0`kKW|)AJY#M?@ADKaN>gEaZic1B^@yO@H02qh)4Y)x5dP3m!vY?XwXr!1Y z&P2pQ;*y%2eHis#4KIe1f0JKVu2IQD_Js%DHYkMB6DjUk%84Tnuz;{60-76DPd6iLbhOvT{CF;`f1 zKS}{f5EA8>-Ex!ldr|NPSQpFXt0i3Ywn@5>@x3BN9w9ja5sE77y%zMkBoK4Z>2l^l zKQT6n7!ACR%2jz9N4&GW4g5p7UkyNwwn&~pVd8-m<=UirlB4E%$Uri9fCU>Vn%>8t z=!RAScD!zvjV?@@qyZEYXfvJD--B<~IzdZGpxYb8aSH5M;R^+}O1-i8>$ksIiFLiNJb%|E8lW*$c?Xv14u!z&E zi{AU*==$yO^|<$Ov-|q>W|9s^!}0atUz5Rm$TIC>R;_f~TW{~UOY$EeIaQet*-gzd zU}wbxRTE4Qjv*2`S>zFELceX9SNOoq(Ke|gQbrPGNy4MRvmaH&619laekLW98qdL; z{6soCuo`IpZMGEcC(V)onDUW}`6BJ5!zkci>P~J^xl7y<(IvZG*Qi3NE;-!BP9~aT z{d$Ck(Dgux{aZEMr3Xi6u9iiZSQmV^N2;`_>}2TgObQmI=j>L5OWo8%>L)Y(5g65W zTaYEtmw*R*(4*b){PqVpFwy(Oahyq@x(5lfbC)afbidQ=rCcR?k5y^JRTidREmR8F zTC!Eu@SK2pPo*~l4LPQje)RyDf<2!*U4o4#jb}i$wlIE}YG*p->*`+MP7qe!4g{>9JuO9+__w4mYSH=BwtYm z^3wtQzTt|_}ly8<^W+=-3HhmIpghnOh`3R{aETN@4@oVCh<7iB^4_nT*( zvmU5*7S=&Lc6$R0eT!c!7Uw1IoQ2^O`tLPveE{h?;DTyDRT%oiBB|PPxP3AKF7z2x zWf*oebi3|iZ|@MA>V5b*tTYs}SQ5|dpg@}Ge#p;7;V$g4FxROG_jT%CGW|({qlw@6 zQoUM!jOAw^=Gf4uz}(qvn^p$o6gCbN<|t4_huEOj<<_6y78=`?y*Fy#LXc`of>Je$3Bq*u15h@|@TyL`N75O_ZSM!8Dx(|9{$@RVH4nVW zx43%0OFu+GobLcg27f{(u&Cq53)qw>*c&u%MsWd!;kO8N-`cVv)T>%{;gZ9lMN~wD zGm)~B8#5P$(ed*<)j%27)6o}XW#3bY*rwGg-yfM==M24{zo?q1(^@07;q16r- z3Jk#J;p^}EK7L0Un)3tXXZMr1&dI`kN%Vn)1w=CXwv@p%?9i61?@we|oT z)_x3U0TG@Z*l+B639mOS{5RjB_W$*xpss-CWI`;A+*a!7-#Dq3>iM_KJ{aW#* zE#+U86COLRJ1ePYJ7ff9=(Z0Mky2tXsEcBxYr zP=-!DP+jN%(%f>LC`e1zB%plHv5JEIatSBq&B@B>qH9I|H%1Ng!8qG1zxW+X4M-?S zgc_Da!cSA!Aae#YNFm`o6HYAjNhn^iuLoIVHCwO04if#us*~*l@!dGi&c?U8O=-`y z1aGre=mD2&c9Yc3*0y~@iJFG7_`dV0^YbcCP!yU_JMW}iA3A%h!Zx*Xx6w+ViQ+3+ z0#(4*3QlfNm1l>msvk3cMEe5TO4PvbwI-@wGm(Tb%djH=Sp0w8?4J(_f!_eeypWRR#|L literal 0 HcmV?d00001 From 8b9d1fb2fb2988920a88ae112d05ba3cbb0b64ad Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 05:39:22 -0400 Subject: [PATCH 28/35] Split jigsaw studio menus - Move each jigsaw menu kind into its own renderer class - Move workcell capacity staging into JigsawStudioWorkcellMenu - Move menu presentation helpers and adjustment math into JigsawStudioMenuFormat - Promote the menu action contract to JigsawStudioMenuActions - Point the menu controller test at the relocated menu types --- .../core/service/JigsawStudioDetailsMenu.java | 325 +++ .../core/service/JigsawStudioMainMenu.java | 286 ++ .../core/service/JigsawStudioMenuActions.java | 111 + .../service/JigsawStudioMenuController.java | 2428 +---------------- .../core/service/JigsawStudioMenuFormat.java | 477 ++++ .../core/service/JigsawStudioService.java | 6 +- .../service/JigsawStudioStructureMenu.java | 194 ++ .../core/service/JigsawStudioToolboxMenu.java | 370 +++ .../core/service/JigsawStudioVariantMenu.java | 213 ++ .../service/JigsawStudioWorkcellMenu.java | 536 ++++ .../JigsawStudioMenuControllerTest.java | 133 +- 11 files changed, 2668 insertions(+), 2411 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioDetailsMenu.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioMainMenu.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuActions.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuFormat.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioStructureMenu.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolboxMenu.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantMenu.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellMenu.java diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDetailsMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDetailsMenu.java new file mode 100644 index 000000000..bd3295e6b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDetailsMenu.java @@ -0,0 +1,325 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.List; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.CHANCE_STEP_PERCENTAGE_POINTS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.GRID_POSITIONS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.MEMBERSHIPS_PER_PAGE; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.chance; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.clampPage; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.dimensions; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.displayKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.maximumPlacements; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.page; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.pageCount; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.themes; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.yesNo; + +final class JigsawStudioDetailsMenu { + private final JigsawStudioMenuController controller; + + JigsawStudioDetailsMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int requestedPage + ) { + int page = clampPage(requestedPage, variant.memberships().size(), MEMBERSHIPS_PER_PAGE); + controller.purgeExpiredConfirmations(window.getViewer().getUniqueId()); + window.batch(() -> { + window.clearElements(); + addDetailsHeader(window, state, workcell, variant, page); + addMemberships(window, state, workcell, variant, page); + addDetailsFooter(window, state, workcell, variant, page); + }); + } + + private void addDetailsHeader( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int page + ) { + UIElement back = element("back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); + back.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(-4, 0, back); + + UIElement identity = element("identity", Material.NAME_TAG, ChatColor.AQUA + safe(variant.displayName())); + identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); + identity.addLore(variant.owned() + ? ChatColor.GREEN + "Owned variant" + : ChatColor.GRAY + "Read-only variant"); + identity.addLore(variant.active() + ? ChatColor.GREEN + "Loaded in this workcell" + : ChatColor.GRAY + "Not currently loaded"); + identity.addLore(ChatColor.GRAY + "Size: " + variant.dimensions() + .map(JigsawStudioMenuFormat::dimensions) + .orElse("Object missing")); + identity.addLore(ChatColor.GRAY + "Themes: " + themes(variant.themes())); + identity.addLore(ChatColor.GRAY + "Depth: " + variant.rules().minimumDepth() + + "-" + variant.rules().maximumDepth()); + identity.addLore(ChatColor.GRAY + "Placements: " + variant.rules().minimumPlacements() + + "-" + maximumPlacements(variant.rules().maximumPlacements())); + identity.addLore(ChatColor.GRAY + "Terminal: " + yesNo(variant.rules().terminal())); + identity.addLore(ChatColor.GRAY + "Pool entries: " + variant.memberships().size()); + if (variant.owned()) { + identity.addLore(ChatColor.YELLOW + "Left-click for a rename stick"); + identity.addLore(ChatColor.GRAY + "Rename that stick in an anvil, then right-click it."); + identity.addLore(ChatColor.GRAY + "Sneak-right-click the stick to reset this label."); + identity.onLeftClick(clicked -> controller.actions.giveTool( + window.getViewer(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.RENAME_VARIANT, + state.requestId(), + workcell.stableId(), + variant.pieceKey()))); + } + window.setElement(0, 0, identity); + + boolean activeOwned = variant.active() && variant.owned(); + boolean irisRuleEditing = activeOwned && state.irisExtended(); + UIElement settings = element( + "variant-settings", + irisRuleEditing ? Material.COMPARATOR : Material.GRAY_DYE, + irisRuleEditing + ? ChatColor.GOLD + "Themes & Piece Rules" + : ChatColor.GRAY + "Themes & Rules Unavailable"); + settings.addLore(irisRuleEditing + ? ChatColor.GRAY + "Edit this loaded variant's theme membership and placement rules." + : state.irisExtended() + ? ChatColor.GRAY + "Load an owned variant before editing its rules." + : ChatColor.GRAY + "Vanilla-portable pieces cannot encode Iris theme or rule metadata."); + if (irisRuleEditing) { + settings.addLore(ChatColor.YELLOW + "Left-click to edit"); + settings.onLeftClick(clicked -> controller.openVariantSettings( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); + } + window.setElement(-2, 0, settings); + + boolean rotationEditable = variant.active() && variant.rotationEditable(); + UIElement rotation = element( + "rotation", + rotationEditable ? Material.REPEATER : Material.BARRIER, + rotationEditable + ? ChatColor.LIGHT_PURPLE + "Toggle Rotation" + : ChatColor.GRAY + "Rotation is Read-only"); + rotation.addLore(ChatColor.GRAY + "Currently: " + (variant.rotatable() ? "Enabled" : "Disabled")); + if (rotationEditable) { + rotation.addLore(ChatColor.YELLOW + "Left-click to toggle"); + rotation.onLeftClick(clicked -> controller.toggleRotation( + window.getViewer(), state.requestId(), workcell.stableId())); + } else if (!variant.active()) { + rotation.addLore(ChatColor.GRAY + "Load this variant before editing rotation."); + } else if (variant.owned() && variant.rotatable()) { + rotation.addLore(ChatColor.GRAY + "Vanilla-portable variants must remain rotatable."); + } + window.setElement(3, 0, rotation); + + boolean sizeEditable = variant.owned() && variant.dimensions().isPresent(); + UIElement size = element( + "variant-size", + sizeEditable ? Material.SCAFFOLDING : Material.BARRIER, + sizeEditable + ? ChatColor.GREEN + "Edit This Variant's Size" + : ChatColor.GRAY + "Variant Size is Read-only"); + size.addLore(ChatColor.GRAY + "Current: " + variant.dimensions() + .map(JigsawStudioMenuFormat::dimensions) + .orElse("Object missing")); + size.addLore(ChatColor.GRAY + "Workcell capacity: " + dimensions(workcell.capacity())); + if (sizeEditable) { + size.addLore(ChatColor.YELLOW + "Left-click for width, height, and depth controls"); + size.onLeftClick(clicked -> controller.openVariantSizeSettings( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey())); + if (variant.resizableToCapacity()) { + size.addLore(ChatColor.YELLOW + "Shift-left: resize this variant to capacity"); + size.onShiftLeftClick(clicked -> controller.resizeVariant( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + workcell.capacity())); + } + } + window.setElement(2, 0, size); + + boolean lastVariant = workcell.variants().size() <= 1; + boolean deletionAvailable = variant.owned() && !variant.active() && !lastVariant; + boolean confirmed = deletionAvailable && controller.isDeleteConfirmed( + window.getViewer().getUniqueId(), + state.requestId(), + workcell.stableId(), + variant.pieceKey()); + UIElement delete = element( + "delete-variant", + deletionAvailable ? confirmed ? Material.REDSTONE : Material.LAVA_BUCKET : Material.BARRIER, + deletionAvailable + ? confirmed ? ChatColor.RED + "Confirm Delete Variant" : ChatColor.RED + "Delete Variant" + : variant.active() + ? ChatColor.GRAY + "Loaded Variant Cannot Be Deleted" + : lastVariant + ? ChatColor.GRAY + "Last Variant Cannot Be Deleted" + : ChatColor.GRAY + "Deletion is Read-only") + .setEnchanted(confirmed); + if (deletionAvailable) { + delete.addLore(confirmed + ? ChatColor.RED + "Click again to permanently delete this owned variant." + : ChatColor.RED + "Click twice within 10 seconds to confirm."); + delete.onLeftClick(clicked -> controller.confirmOrDeleteVariant( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + page)); + } else if (variant.active()) { + delete.addLore(ChatColor.GRAY + "Load another variant in this workcell first."); + } else if (lastVariant) { + delete.addLore(ChatColor.GRAY + "Create another variant before deleting this one."); + } + window.setElement(4, 0, delete); + } + + private void addMemberships( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int page + ) { + List memberships = page( + variant.memberships(), page, MEMBERSHIPS_PER_PAGE); + if (memberships.isEmpty()) { + UIElement empty = element("no-memberships", Material.BARRIER, ChatColor.RED + "No Pool Entries"); + empty.addLore(ChatColor.GRAY + "This variant is not linked from an owned pool."); + window.setElement(0, 2, empty); + return; + } + + for (int index = 0; index < memberships.size(); index++) { + JigsawStudioMenuState.Membership membership = memberships.get(index); + int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; + int row = 1 + index / GRID_POSITIONS.length; + boolean confirmed = variant.active() && variant.owned() && controller.isUnlinkConfirmed( + window.getViewer().getUniqueId(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + membership); + UIElement element = element( + "membership-" + index, + confirmed ? Material.REDSTONE : Material.GOLD_NUGGET, + (confirmed ? ChatColor.RED : ChatColor.GOLD) + + safe(displayKey(membership.poolKey())) + + " [" + membership.entryIndex() + "]") + .setEnchanted(confirmed); + element.addLore(ChatColor.DARK_GRAY + safe(membership.poolKey())); + element.addLore(ChatColor.GRAY + "Exact entry: " + membership.entryIndex()); + element.addLore(ChatColor.WHITE + "Weight: " + membership.weight()); + element.addLore((state.irisExtended() ? ChatColor.WHITE : ChatColor.GRAY) + + "Chance: " + chance(membership.chance()) + + (state.irisExtended() ? "" : " (Iris only)")); + if (variant.active() && variant.owned()) { + element.addLore(ChatColor.GREEN + "Left-click: weight +1"); + element.addLore(ChatColor.YELLOW + "Right-click: weight -1"); + if (state.irisExtended()) { + element.addLore(ChatColor.GREEN + "Shift-left: chance +" + + CHANCE_STEP_PERCENTAGE_POINTS + "%"); + element.addLore(ChatColor.YELLOW + "Shift-right: chance -" + + CHANCE_STEP_PERCENTAGE_POINTS + "%"); + } else { + element.addLore(ChatColor.GRAY + "Vanilla-portable pool entries always have 100% chance."); + } + element.addLore(confirmed + ? ChatColor.RED + "Middle-click again to unlink" + : ChatColor.RED + "Middle-click twice to unlink"); + element.onLeftClick(clicked -> controller.adjustMembershipWeight( + window.getViewer(), state.requestId(), workcell.stableId(), membership, 1)); + element.onRightClick(clicked -> controller.adjustMembershipWeight( + window.getViewer(), state.requestId(), workcell.stableId(), membership, -1)); + if (state.irisExtended()) { + element.onShiftLeftClick(clicked -> controller.adjustMembershipChance( + window.getViewer(), + state.requestId(), + workcell.stableId(), + membership, + CHANCE_STEP_PERCENTAGE_POINTS)); + element.onShiftRightClick(clicked -> controller.adjustMembershipChance( + window.getViewer(), + state.requestId(), + workcell.stableId(), + membership, + -CHANCE_STEP_PERCENTAGE_POINTS)); + } + element.onMiddleClick(clicked -> controller.confirmOrUnlink( + window.getViewer(), state.requestId(), workcell.stableId(), membership, page)); + } else { + element.addLore(variant.active() + ? ChatColor.GRAY + "Read-only pool entry" + : ChatColor.GRAY + "Load this variant to edit its pool entry"); + } + window.setElement(position, row, element); + } + } + + private void addDetailsFooter( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int page + ) { + UIElement back = element("footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + back.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(-4, 5, back); + + int pageCount = pageCount(variant.memberships().size(), MEMBERSHIPS_PER_PAGE); + if (page > 0) { + UIElement previous = element("membership-previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); + previous.onLeftClick(clicked -> controller.refreshDetails( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + page - 1)); + window.setElement(-1, 5, previous); + } + UIElement indicator = element("membership-page", Material.BOOK, ChatColor.WHITE + "Page " + + (page + 1) + "/" + pageCount); + indicator.addLore(ChatColor.GRAY + "" + variant.memberships().size() + " exact pool entries"); + window.setElement(0, 5, indicator); + if (page + 1 < pageCount) { + UIElement next = element("membership-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); + next.onLeftClick(clicked -> controller.refreshDetails( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + page + 1)); + window.setElement(1, 5, next); + } + window.setElement(2, 5, evaluationElement(state.evaluation())); + + UIElement toolbox = element("details-toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); + toolbox.onLeftClick(clicked -> controller.openToolbox( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(4, 5, toolbox); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMainMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMainMenu.java new file mode 100644 index 000000000..7c9f739fc --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMainMenu.java @@ -0,0 +1,286 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.util.common.scheduling.J; +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.List; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.GRID_POSITIONS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.VARIANTS_PER_PAGE; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.clampPage; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.compatibilityName; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.dimensions; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.nextThemeSetKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.page; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.pageCount; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.themes; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.variantMaterial; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.workcellMaterial; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.workcellStatus; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.yesNo; + +final class JigsawStudioMainMenu { + private final JigsawStudioMenuController controller; + + JigsawStudioMainMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell selected, + int requestedPage + ) { + int page = clampPage(requestedPage, selected.variants().size(), VARIANTS_PER_PAGE); + window.batch(() -> { + window.clearElements(); + addWorkcells(window, state, selected.stableId()); + addFamilyControl(window, state); + addStructureControl(window, state, selected.stableId()); + addVariants(window, state, selected, page); + addMainActions(window, state, selected, page); + }); + } + + private void addFamilyControl(UIWindow window, JigsawStudioMenuState state) { + String nextThemeKey = nextThemeSetKey(state.themeSets()); + boolean available = state.irisExtended() && state.workcells().stream() + .filter(JigsawStudioMenuState.Workcell::enabled) + .allMatch(workcell -> workcell.activeVariant() != null && workcell.activeVariant().owned()); + UIElement family = element( + "duplicate-family", + available ? Material.PURPLE_DYE : Material.GRAY_DYE, + available + ? ChatColor.LIGHT_PURPLE + "Duplicate All Enabled Cells as Family" + : ChatColor.GRAY + "Duplicate All Enabled Cells as Family"); + family.addLore(ChatColor.GRAY + "Copies each enabled cell's loaded variant into one coherent family."); + family.addLore(ChatColor.GRAY + "New family: " + safe(nextThemeKey)); + if (available) { + family.addLore(ChatColor.YELLOW + "Left-click to duplicate the complete family atomically"); + family.onLeftClick(clicked -> controller.duplicateActiveFamily( + window.getViewer(), state.requestId(), nextThemeKey)); + } else if (!state.irisExtended()) { + family.addLore(ChatColor.GRAY + "Coherent families require Iris compatibility."); + } else { + family.addLore(ChatColor.GRAY + "Load an owned variant in every enabled workcell first."); + } + window.setElement(3, 0, family); + } + + private void addStructureControl( + UIWindow window, + JigsawStudioMenuState state, + String selectedWorkcellId + ) { + UIElement structure = element( + "structure-rules", + state.irisExtended() + ? state.requireCaps() ? Material.IRON_BARS : Material.TRIPWIRE_HOOK + : Material.BARRIER, + ChatColor.LIGHT_PURPLE + "Structure Rules"); + structure.addLore(ChatColor.GRAY + "Mandatory caps: " + yesNo(state.requireCaps())); + structure.addLore(ChatColor.GRAY + "Theme sets: " + state.themeSets().size()); + structure.addLore(ChatColor.GRAY + "Compatibility: " + compatibilityName(state.compatibilityTarget())); + structure.addLore(ChatColor.YELLOW + "Left-click for themes and rules"); + structure.addLore(state.irisExtended() + ? ChatColor.YELLOW + "Right-click to toggle mandatory caps" + : ChatColor.GRAY + "Mandatory caps and themes require Iris compatibility"); + structure.onLeftClick(clicked -> controller.openStructureSettings( + window.getViewer(), state.requestId(), selectedWorkcellId, 0)); + if (state.irisExtended()) { + structure.onRightClick(clicked -> controller.setRequireCaps( + window.getViewer(), state.requestId(), !state.requireCaps())); + } + window.setElement(4, 0, structure); + } + + private void addWorkcells(UIWindow window, JigsawStudioMenuState state, String selectedWorkcellId) { + int count = state.workcells().size(); + int start = count == 1 ? 0 : -(count / 2); + for (int index = 0; index < count; index++) { + JigsawStudioMenuState.Workcell workcell = state.workcells().get(index); + boolean selected = workcell.stableId().equals(selectedWorkcellId); + UIElement element = element( + "workcell-" + index, + workcellMaterial(workcell, selected), + (selected ? ChatColor.AQUA : workcell.enabled() ? ChatColor.WHITE : ChatColor.GRAY) + + safe(workcell.displayName())) + .setEnchanted(selected); + element.addLore(workcell.enabled() + ? ChatColor.GREEN + "Enabled" + : ChatColor.RED + "Disabled for assembly and export"); + if (!workcell.canonicalName().equals(workcell.displayName())) { + element.addLore(ChatColor.GRAY + "Solver role: " + safe(workcell.canonicalName())); + } + element.addLore(ChatColor.GRAY + "Capacity: " + dimensions(workcell.capacity())); + element.addLore(ChatColor.GRAY + "Variants: " + workcell.variants().size()); + JigsawStudioMenuState.Variant active = workcell.activeVariant(); + element.addLore(ChatColor.GRAY + "Loaded: " + + (active == null ? "None" : safe(active.displayName()))); + element.addLore(workcellStatus(workcell)); + element.addLore(ChatColor.GRAY + "Connector blocks: " + + (workcell.connectorsVisible() ? "Visible" : "Hidden")); + element.addLore(ChatColor.YELLOW + "Left-click to select and teleport"); + element.addLore(ChatColor.YELLOW + "Right-click for workcell settings"); + if (workcell.dirty() && !workcell.saving()) { + element.addLore(ChatColor.GOLD + "Shift-left: Flush Autosave Now"); + element.onShiftLeftClick(clicked -> controller.flushNow( + window.getViewer(), state.requestId(), workcell.stableId())); + } + element.onLeftClick(clicked -> controller.selectWorkcell( + window.getViewer(), + state.requestId(), + workcell.stableId())); + element.onRightClick(clicked -> J.runEntity( + window.getViewer(), + () -> controller.openWorkcellSettings( + window.getViewer(), + state.requestId(), + workcell.stableId()), + 1)); + window.setElement(start + index, 0, element); + } + } + + private void addVariants( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + int page + ) { + List variants = page( + workcell.variants(), page, VARIANTS_PER_PAGE); + if (variants.isEmpty()) { + UIElement empty = element("no-variants", Material.BARRIER, ChatColor.RED + "No variants"); + empty.addLore(ChatColor.GRAY + "Create a variant to begin authoring this workcell."); + window.setElement(0, 2, empty); + return; + } + + for (int index = 0; index < variants.size(); index++) { + JigsawStudioMenuState.Variant variant = variants.get(index); + int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; + int row = 1 + index / GRID_POSITIONS.length; + UIElement element = element( + "variant-" + index, + variantMaterial(variant), + (variant.active() ? ChatColor.GREEN : ChatColor.WHITE) + + safe(variant.displayName()) + + (variant.active() ? ChatColor.AQUA + " [Loaded]" : "")) + .setEnchanted(variant.active()); + element.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); + element.addLore(variant.owned() + ? ChatColor.GREEN + "Owned" + : ChatColor.GRAY + "Read-only"); + element.addLore(ChatColor.GRAY + "Rotation: " + (variant.rotatable() ? "Enabled" : "Disabled")); + element.addLore(ChatColor.GRAY + "Size: " + variant.dimensions() + .map(JigsawStudioMenuFormat::dimensions) + .orElse("Object missing")); + element.addLore(ChatColor.GRAY + "Themes: " + themes(variant.themes())); + element.addLore(ChatColor.GRAY + "Pool entries: " + variant.memberships().size()); + element.addLore(variant.active() + ? ChatColor.YELLOW + "Loaded; right-click for details" + : ChatColor.YELLOW + "Left-click to load"); + if (!variant.active()) { + element.addLore(ChatColor.YELLOW + "Right-click for details or deletion"); + } + element.onLeftClick(clicked -> controller.switchVariant( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey())); + element.onRightClick(clicked -> J.runEntity( + window.getViewer(), + () -> controller.openDetails( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + 0), + 1)); + window.setElement(position, row, element); + } + } + + private void addMainActions( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + int page + ) { + UIElement create = element("create", Material.NETHER_STAR, ChatColor.GREEN + "New Blank Variant"); + create.addLore(ChatColor.GRAY + "Create an empty owned variant with this cell's current size."); + create.onLeftClick(clicked -> controller.createVariant( + window.getViewer(), state.requestId(), workcell.stableId(), false)); + window.setElement(-4, 5, create); + + JigsawStudioMenuState.Variant active = workcell.activeVariant(); + boolean duplicateAvailable = active != null && active.owned(); + UIElement duplicate = element( + "duplicate", + duplicateAvailable ? Material.PAPER : Material.GRAY_DYE, + duplicateAvailable + ? ChatColor.AQUA + "Duplicate This Cell's Variant" + : active == null + ? ChatColor.GRAY + "Duplicate This Cell's Variant" + : ChatColor.GRAY + "Duplicate This Cell's Variant"); + duplicate.addLore(duplicateAvailable + ? ChatColor.GRAY + "Clone the loaded variant into an owned variant." + : active == null + ? ChatColor.GRAY + "Load a variant before duplicating it." + : ChatColor.GRAY + "Adopt the read-only graph before duplicating it."); + if (duplicateAvailable) { + duplicate.onLeftClick(clicked -> controller.createVariant( + window.getViewer(), state.requestId(), workcell.stableId(), true)); + } + window.setElement(-3, 5, duplicate); + + UIElement settings = element("settings", Material.CRAFTING_TABLE, ChatColor.GOLD + "Workcell Settings"); + settings.addLore(ChatColor.GRAY + "Enabled: " + yesNo(workcell.enabled())); + settings.addLore(ChatColor.GRAY + "Capacity: " + dimensions(workcell.capacity())); + settings.onLeftClick(clicked -> controller.openWorkcellSettings( + window.getViewer(), state.requestId(), workcell.stableId())); + window.setElement(-2, 5, settings); + + int pageCount = pageCount(workcell.variants().size(), VARIANTS_PER_PAGE); + if (page > 0) { + UIElement previous = element("previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); + previous.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), page - 1)); + window.setElement(-1, 5, previous); + } + + UIElement pageIndicator = element("page", Material.BOOK, ChatColor.WHITE + "Page " + + (page + 1) + "/" + pageCount); + pageIndicator.addLore(ChatColor.GRAY + "" + workcell.variants().size() + " variants"); + window.setElement(0, 5, pageIndicator); + + if (page + 1 < pageCount) { + UIElement next = element("next", Material.ARROW, ChatColor.YELLOW + "Next Page"); + next.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), page + 1)); + window.setElement(1, 5, next); + } + + window.setElement(2, 5, evaluationElement(state.evaluation())); + + UIElement preview = element("preview", Material.ENDER_EYE, ChatColor.LIGHT_PURPLE + "Go to Preview"); + preview.addLore(ChatColor.GRAY + "Open the deterministic assembly preview."); + preview.onLeftClick(clicked -> controller.goToPreview(window.getViewer(), state.requestId())); + window.setElement(3, 5, preview); + + UIElement toolbox = element("toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); + toolbox.addLore(ChatColor.GRAY + "Take named sticks bound to this Studio session."); + toolbox.onLeftClick(clicked -> controller.openToolbox( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(4, 5, toolbox); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuActions.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuActions.java new file mode 100644 index 000000000..7a3f675cc --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuActions.java @@ -0,0 +1,111 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import org.bukkit.entity.Player; + +import java.util.List; +import java.util.Optional; + +public interface JigsawStudioMenuActions { + Optional menuState(Player player); + + boolean selectWorkcell(Player player, String workcellId); + + boolean teleportToWorkcell(Player player, String workcellId); + + boolean setConnectorBlocksVisible(Player player, String workcellId, boolean visible); + + boolean resetConnectorBlocks(Player player, String workcellId); + + boolean undoAutosave(Player player); + + boolean switchVariant(Player player, String workcellId, String pieceKey, boolean discardDirty); + + boolean createVariant(Player player, String workcellId, boolean duplicateActive); + + boolean setWorkcellEnabled(Player player, String workcellId, boolean enabled); + + boolean updateWorkcellDimensions( + Player player, + String workcellId, + JigsawStudioCellDimensions dimensions + ); + + boolean updateWorkcellDisplayName(Player player, String workcellId, String displayName); + + boolean setRequireCaps(Player player, boolean requireCaps); + + boolean duplicateActiveFamily(Player player, String themeKey); + + boolean updateThemeSetWeight(Player player, String themeKey, int weight); + + boolean flushAutosave(Player player, String workcellId); + + boolean goToPreview(Player player); + + boolean toggleVariantRotatable(Player player, String workcellId); + + boolean expandVariantToCell(Player player, String workcellId); + + boolean resizeVariant( + Player player, + String workcellId, + String pieceKey, + JigsawStudioCellDimensions dimensions + ); + + boolean updateVariantDisplayName( + Player player, + String workcellId, + String pieceKey, + String displayName + ); + + boolean updateVariantThemes( + Player player, + String workcellId, + String pieceKey, + List themes + ); + + boolean updateVariantRules( + Player player, + String workcellId, + String pieceKey, + JigsawStudioPieceRules rules + ); + + boolean adjustVariantWeight( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int delta + ); + + boolean adjustVariantChance( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int deltaPercentagePoints + ); + + boolean unlinkVariantMembership( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex + ); + + boolean deleteVariant(Player player, String workcellId, String pieceKey); + + boolean deleteProject(Player player); + + boolean giveTool(Player player, JigsawStudioToolPayload payload); +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuController.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuController.java index f1028b0ef..99b833a17 100644 --- a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuController.java +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuController.java @@ -1,14 +1,11 @@ package art.arcane.iris.core.service; +import art.arcane.iris.core.service.JigsawStudioMenuFormat.DimensionAxis; +import art.arcane.iris.core.service.JigsawStudioMenuFormat.RuleField; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; import art.arcane.iris.util.common.scheduling.J; -import art.arcane.volmlib.util.data.MaterialBlock; -import art.arcane.volmlib.util.inventorygui.UIElement; import art.arcane.volmlib.util.inventorygui.UIPaneDecorator; import art.arcane.volmlib.util.inventorygui.UIWindow; import art.arcane.volmlib.util.inventorygui.WindowResolution; @@ -20,13 +17,21 @@ import org.bukkit.plugin.java.JavaPlugin; import java.util.ArrayList; import java.util.List; -import java.util.Locale; import java.util.Map; import java.util.Objects; import java.util.Optional; import java.util.UUID; import java.util.concurrent.ConcurrentHashMap; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.activeVariant; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.adjustedDimensions; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.adjustedPositiveValue; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.adjustedRules; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.hasMembership; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.nextThemeSetKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.title; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.variant; + public final class JigsawStudioMenuController { static final int VARIANTS_PER_PAGE = 28; static final int MEMBERSHIPS_PER_PAGE = 28; @@ -37,21 +42,30 @@ public final class JigsawStudioMenuController { static final int PLACEMENT_RULE_SHIFT_STEP = 16; private static final long DESTRUCTIVE_CONFIRM_NANOS = 10_000_000_000L; - private static final int WORKCELL_RESIZE_REFRESH_TICKS = 2; - private static final int WORKCELL_RESIZE_REFRESH_ATTEMPTS = 200; - private static final int[] GRID_POSITIONS = {-3, -2, -1, 0, 1, 2, 3}; + static final int[] GRID_POSITIONS = {-3, -2, -1, 0, 1, 2, 3}; private final JavaPlugin plugin; - private final Actions actions; - private final Map windows = new ConcurrentHashMap<>(); + final JigsawStudioMenuActions actions; + final Map windows = new ConcurrentHashMap<>(); private final Map pendingUnlinks = new ConcurrentHashMap<>(); private final Map pendingDeletes = new ConcurrentHashMap<>(); private final Map pendingProjectDeletes = new ConcurrentHashMap<>(); - private final Map pendingWorkcellResizes = new ConcurrentHashMap<>(); + private final JigsawStudioMainMenu mainMenu; + private final JigsawStudioWorkcellMenu workcellMenu; + private final JigsawStudioStructureMenu structureMenu; + private final JigsawStudioDetailsMenu detailsMenu; + private final JigsawStudioVariantMenu variantMenu; + private final JigsawStudioToolboxMenu toolboxMenu; - public JigsawStudioMenuController(JavaPlugin plugin, Actions actions) { + public JigsawStudioMenuController(JavaPlugin plugin, JigsawStudioMenuActions actions) { this.plugin = Objects.requireNonNull(plugin, "Jigsaw Studio menu plugin"); this.actions = Objects.requireNonNull(actions, "Jigsaw Studio menu actions"); + mainMenu = new JigsawStudioMainMenu(this); + workcellMenu = new JigsawStudioWorkcellMenu(this); + structureMenu = new JigsawStudioStructureMenu(this); + detailsMenu = new JigsawStudioDetailsMenu(this); + variantMenu = new JigsawStudioVariantMenu(this); + toolboxMenu = new JigsawStudioToolboxMenu(this); } public boolean open(Player player) { @@ -104,14 +118,14 @@ public final class JigsawStudioMenuController { pendingUnlinks.remove(playerId); pendingDeletes.remove(playerId); pendingProjectDeletes.remove(playerId); - pendingWorkcellResizes.remove(playerId); + workcellMenu.clearStagedResize(playerId); }); windows.put(playerId, window); pendingUnlinks.remove(playerId); pendingDeletes.remove(playerId); pendingProjectDeletes.remove(playerId); - pendingWorkcellResizes.remove(playerId); - renderMain(window, state, selected, 0); + workcellMenu.clearStagedResize(playerId); + mainMenu.render(window, state, selected, 0); window.open(); return true; } @@ -196,7 +210,7 @@ public final class JigsawStudioMenuController { if (window == null) { return false; } - renderVariantSizeSettings(window, current.get(), workcell, variant); + workcellMenu.renderSize(window, current.get(), workcell, variant); return true; } @@ -248,7 +262,7 @@ public final class JigsawStudioMenuController { pendingUnlinks.clear(); pendingDeletes.clear(); pendingProjectDeletes.clear(); - pendingWorkcellResizes.clear(); + workcellMenu.clearStagedResizes(); for (UIWindow window : activeWindows) { Player player = window.getViewer(); if (J.isOwnedByCurrentRegion(player)) { @@ -259,1266 +273,7 @@ public final class JigsawStudioMenuController { } } - private void renderMain( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell selected, - int requestedPage - ) { - int page = clampPage(requestedPage, selected.variants().size(), VARIANTS_PER_PAGE); - window.batch(() -> { - window.clearElements(); - addWorkcells(window, state, selected.stableId()); - addFamilyControl(window, state); - addStructureControl(window, state, selected.stableId()); - addVariants(window, state, selected, page); - addMainActions(window, state, selected, page); - }); - } - - private void addFamilyControl(UIWindow window, JigsawStudioMenuState state) { - String nextThemeKey = nextThemeSetKey(state.themeSets()); - boolean available = state.irisExtended() && state.workcells().stream() - .filter(JigsawStudioMenuState.Workcell::enabled) - .allMatch(workcell -> workcell.activeVariant() != null && workcell.activeVariant().owned()); - UIElement family = element( - "duplicate-family", - available ? Material.PURPLE_DYE : Material.GRAY_DYE, - available - ? ChatColor.LIGHT_PURPLE + "Duplicate All Enabled Cells as Family" - : ChatColor.GRAY + "Duplicate All Enabled Cells as Family"); - family.addLore(ChatColor.GRAY + "Copies each enabled cell's loaded variant into one coherent family."); - family.addLore(ChatColor.GRAY + "New family: " + safe(nextThemeKey)); - if (available) { - family.addLore(ChatColor.YELLOW + "Left-click to duplicate the complete family atomically"); - family.onLeftClick(clicked -> duplicateActiveFamily( - window.getViewer(), state.requestId(), nextThemeKey)); - } else if (!state.irisExtended()) { - family.addLore(ChatColor.GRAY + "Coherent families require Iris compatibility."); - } else { - family.addLore(ChatColor.GRAY + "Load an owned variant in every enabled workcell first."); - } - window.setElement(3, 0, family); - } - - private void addStructureControl( - UIWindow window, - JigsawStudioMenuState state, - String selectedWorkcellId - ) { - UIElement structure = element( - "structure-rules", - state.irisExtended() - ? state.requireCaps() ? Material.IRON_BARS : Material.TRIPWIRE_HOOK - : Material.BARRIER, - ChatColor.LIGHT_PURPLE + "Structure Rules"); - structure.addLore(ChatColor.GRAY + "Mandatory caps: " + yesNo(state.requireCaps())); - structure.addLore(ChatColor.GRAY + "Theme sets: " + state.themeSets().size()); - structure.addLore(ChatColor.GRAY + "Compatibility: " + compatibilityName(state.compatibilityTarget())); - structure.addLore(ChatColor.YELLOW + "Left-click for themes and rules"); - structure.addLore(state.irisExtended() - ? ChatColor.YELLOW + "Right-click to toggle mandatory caps" - : ChatColor.GRAY + "Mandatory caps and themes require Iris compatibility"); - structure.onLeftClick(clicked -> openStructureSettings( - window.getViewer(), state.requestId(), selectedWorkcellId, 0)); - if (state.irisExtended()) { - structure.onRightClick(clicked -> setRequireCaps( - window.getViewer(), state.requestId(), !state.requireCaps())); - } - window.setElement(4, 0, structure); - } - - private void addWorkcells(UIWindow window, JigsawStudioMenuState state, String selectedWorkcellId) { - int count = state.workcells().size(); - int start = count == 1 ? 0 : -(count / 2); - for (int index = 0; index < count; index++) { - JigsawStudioMenuState.Workcell workcell = state.workcells().get(index); - boolean selected = workcell.stableId().equals(selectedWorkcellId); - UIElement element = element( - "workcell-" + index, - workcellMaterial(workcell, selected), - (selected ? ChatColor.AQUA : workcell.enabled() ? ChatColor.WHITE : ChatColor.GRAY) - + safe(workcell.displayName())) - .setEnchanted(selected); - element.addLore(workcell.enabled() - ? ChatColor.GREEN + "Enabled" - : ChatColor.RED + "Disabled for assembly and export"); - if (!workcell.canonicalName().equals(workcell.displayName())) { - element.addLore(ChatColor.GRAY + "Solver role: " + safe(workcell.canonicalName())); - } - element.addLore(ChatColor.GRAY + "Capacity: " + dimensions(workcell.capacity())); - element.addLore(ChatColor.GRAY + "Variants: " + workcell.variants().size()); - JigsawStudioMenuState.Variant active = workcell.activeVariant(); - element.addLore(ChatColor.GRAY + "Loaded: " - + (active == null ? "None" : safe(active.displayName()))); - element.addLore(workcellStatus(workcell)); - element.addLore(ChatColor.GRAY + "Connector blocks: " - + (workcell.connectorsVisible() ? "Visible" : "Hidden")); - element.addLore(ChatColor.YELLOW + "Left-click to select and teleport"); - element.addLore(ChatColor.YELLOW + "Right-click for workcell settings"); - if (workcell.dirty() && !workcell.saving()) { - element.addLore(ChatColor.GOLD + "Shift-left: Flush Autosave Now"); - element.onShiftLeftClick(clicked -> flushNow( - window.getViewer(), state.requestId(), workcell.stableId())); - } - element.onLeftClick(clicked -> selectWorkcell( - window.getViewer(), - state.requestId(), - workcell.stableId())); - element.onRightClick(clicked -> J.runEntity( - window.getViewer(), - () -> openWorkcellSettings( - window.getViewer(), - state.requestId(), - workcell.stableId()), - 1)); - window.setElement(start + index, 0, element); - } - } - - private void addVariants( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - int page - ) { - List variants = page( - workcell.variants(), page, VARIANTS_PER_PAGE); - if (variants.isEmpty()) { - UIElement empty = element("no-variants", Material.BARRIER, ChatColor.RED + "No variants"); - empty.addLore(ChatColor.GRAY + "Create a variant to begin authoring this workcell."); - window.setElement(0, 2, empty); - return; - } - - for (int index = 0; index < variants.size(); index++) { - JigsawStudioMenuState.Variant variant = variants.get(index); - int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; - int row = 1 + index / GRID_POSITIONS.length; - UIElement element = element( - "variant-" + index, - variantMaterial(variant), - (variant.active() ? ChatColor.GREEN : ChatColor.WHITE) - + safe(variant.displayName()) - + (variant.active() ? ChatColor.AQUA + " [Loaded]" : "")) - .setEnchanted(variant.active()); - element.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); - element.addLore(variant.owned() - ? ChatColor.GREEN + "Owned" - : ChatColor.GRAY + "Read-only"); - element.addLore(ChatColor.GRAY + "Rotation: " + (variant.rotatable() ? "Enabled" : "Disabled")); - element.addLore(ChatColor.GRAY + "Size: " + variant.dimensions() - .map(JigsawStudioMenuController::dimensions) - .orElse("Object missing")); - element.addLore(ChatColor.GRAY + "Themes: " + themes(variant.themes())); - element.addLore(ChatColor.GRAY + "Pool entries: " + variant.memberships().size()); - element.addLore(variant.active() - ? ChatColor.YELLOW + "Loaded; right-click for details" - : ChatColor.YELLOW + "Left-click to load"); - if (!variant.active()) { - element.addLore(ChatColor.YELLOW + "Right-click for details or deletion"); - } - element.onLeftClick(clicked -> switchVariant( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey())); - element.onRightClick(clicked -> J.runEntity( - window.getViewer(), - () -> openDetails( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - 0), - 1)); - window.setElement(position, row, element); - } - } - - private void addMainActions( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - int page - ) { - UIElement create = element("create", Material.NETHER_STAR, ChatColor.GREEN + "New Blank Variant"); - create.addLore(ChatColor.GRAY + "Create an empty owned variant with this cell's current size."); - create.onLeftClick(clicked -> createVariant( - window.getViewer(), state.requestId(), workcell.stableId(), false)); - window.setElement(-4, 5, create); - - JigsawStudioMenuState.Variant active = workcell.activeVariant(); - boolean duplicateAvailable = active != null && active.owned(); - UIElement duplicate = element( - "duplicate", - duplicateAvailable ? Material.PAPER : Material.GRAY_DYE, - duplicateAvailable - ? ChatColor.AQUA + "Duplicate This Cell's Variant" - : active == null - ? ChatColor.GRAY + "Duplicate This Cell's Variant" - : ChatColor.GRAY + "Duplicate This Cell's Variant"); - duplicate.addLore(duplicateAvailable - ? ChatColor.GRAY + "Clone the loaded variant into an owned variant." - : active == null - ? ChatColor.GRAY + "Load a variant before duplicating it." - : ChatColor.GRAY + "Adopt the read-only graph before duplicating it."); - if (duplicateAvailable) { - duplicate.onLeftClick(clicked -> createVariant( - window.getViewer(), state.requestId(), workcell.stableId(), true)); - } - window.setElement(-3, 5, duplicate); - - UIElement settings = element("settings", Material.CRAFTING_TABLE, ChatColor.GOLD + "Workcell Settings"); - settings.addLore(ChatColor.GRAY + "Enabled: " + yesNo(workcell.enabled())); - settings.addLore(ChatColor.GRAY + "Capacity: " + dimensions(workcell.capacity())); - settings.onLeftClick(clicked -> openWorkcellSettings( - window.getViewer(), state.requestId(), workcell.stableId())); - window.setElement(-2, 5, settings); - - int pageCount = pageCount(workcell.variants().size(), VARIANTS_PER_PAGE); - if (page > 0) { - UIElement previous = element("previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); - previous.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), page - 1)); - window.setElement(-1, 5, previous); - } - - UIElement pageIndicator = element("page", Material.BOOK, ChatColor.WHITE + "Page " - + (page + 1) + "/" + pageCount); - pageIndicator.addLore(ChatColor.GRAY + "" + workcell.variants().size() + " variants"); - window.setElement(0, 5, pageIndicator); - - if (page + 1 < pageCount) { - UIElement next = element("next", Material.ARROW, ChatColor.YELLOW + "Next Page"); - next.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), page + 1)); - window.setElement(1, 5, next); - } - - window.setElement(2, 5, evaluationElement(state.evaluation())); - - UIElement preview = element("preview", Material.ENDER_EYE, ChatColor.LIGHT_PURPLE + "Go to Preview"); - preview.addLore(ChatColor.GRAY + "Open the deterministic assembly preview."); - preview.onLeftClick(clicked -> goToPreview(window.getViewer(), state.requestId())); - window.setElement(3, 5, preview); - - UIElement toolbox = element("toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); - toolbox.addLore(ChatColor.GRAY + "Take named sticks bound to this Studio session."); - toolbox.onLeftClick(clicked -> openToolbox( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(4, 5, toolbox); - } - - private void renderWorkcellSettings( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell - ) { - PendingWorkcellResize pendingResize = pendingWorkcellResize( - window.getViewer().getUniqueId(), - state.requestId(), - workcell.stableId()); - JigsawStudioMenuState.Workcell renderedWorkcell = pendingResize == null - ? workcell - : withCapacity(workcell, pendingResize.dimensions()); - window.batch(() -> { - window.clearElements(); - - UIElement back = element("settings-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); - back.onLeftClick(clicked -> leaveWorkcellSettings( - window.getViewer(), state.requestId(), renderedWorkcell.stableId())); - window.setElement(-4, 0, back); - - UIElement identity = element( - "settings-identity", - renderedWorkcell.enabled() ? Material.LIME_WOOL : Material.GRAY_WOOL, - ChatColor.AQUA + safe(renderedWorkcell.displayName())); - identity.addLore(ChatColor.DARK_GRAY + safe(renderedWorkcell.stableId())); - identity.addLore(renderedWorkcell.enabled() - ? ChatColor.GREEN + "Enabled" - : ChatColor.RED + "Disabled for assembly and export"); - if (!renderedWorkcell.canonicalName().equals(renderedWorkcell.displayName())) { - identity.addLore(ChatColor.GRAY + "Solver role: " + safe(renderedWorkcell.canonicalName())); - } - identity.addLore(ChatColor.GRAY + "Capacity: " + dimensions(renderedWorkcell.capacity())); - if (pendingResize != null) { - identity.addLore(pendingResize.applying() - ? ChatColor.YELLOW + "Applying one live relayout" - : ChatColor.GOLD + "Pending; apply when all dimensions are ready"); - } - identity.addLore(ChatColor.YELLOW + "Left-click for a rename stick"); - identity.addLore(ChatColor.GRAY + "Rename that stick in an anvil, then right-click it."); - identity.addLore(ChatColor.GRAY + "Sneak-right-click the stick to reset this label."); - identity.onLeftClick(clicked -> actions.giveTool( - window.getViewer(), - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.RENAME_WORKCELL, - state.requestId(), - renderedWorkcell.stableId()))); - window.setElement(0, 0, identity); - window.setElement(4, 0, evaluationElement(state.evaluation())); - - if (state.mode() == JigsawStudioMode.PLANAR_JIGSAW) { - UIElement enabled = element( - "settings-enabled", - renderedWorkcell.enabled() ? Material.LEVER : Material.REDSTONE_TORCH, - renderedWorkcell.enabled() - ? ChatColor.GREEN + "Workcell Enabled" - : ChatColor.RED + "Workcell Disabled"); - enabled.addLore(ChatColor.GRAY + "Disabled workcells remain editable and keep their size."); - enabled.addLore(ChatColor.YELLOW + "Left-click to " - + (renderedWorkcell.enabled() ? "disable" : "enable")); - enabled.onLeftClick(clicked -> setWorkcellEnabled( - window.getViewer(), - state.requestId(), - renderedWorkcell.stableId(), - !renderedWorkcell.enabled())); - window.setElement(0, 1, enabled); - } else { - UIElement spatial = element( - "spatial-bounds", - Material.SCAFFOLDING, - ChatColor.AQUA + "Spatial Workcell Bounds"); - spatial.addLore(ChatColor.GRAY + "Spatial project bounds are shared by the project."); - spatial.addLore(ChatColor.GRAY + "Changing them regenerates the Studio layout."); - window.setElement(0, 1, spatial); - } - - UIElement connectors = element( - "settings-connectors", - renderedWorkcell.connectorsVisible() ? Material.JIGSAW : Material.STRUCTURE_VOID, - renderedWorkcell.connectorsVisible() - ? ChatColor.GREEN + "Connector Blocks Visible" - : ChatColor.YELLOW + "Connector Blocks Hidden"); - connectors.addLore(ChatColor.GRAY + "Hidden connectors retain their metadata and final block state."); - connectors.addLore(ChatColor.YELLOW + "Left-click to " - + (renderedWorkcell.connectorsVisible() ? "hide" : "show") + " connector blocks"); - connectors.onLeftClick(clicked -> toggleConnectorBlocks( - window.getViewer(), - state.requestId(), - renderedWorkcell.stableId(), - !renderedWorkcell.connectorsVisible())); - window.setElement(2, 1, connectors); - - UIElement resetConnectors = element( - "settings-reset-connectors", - Material.RECOVERY_COMPASS, - ChatColor.AQUA + "Reset Connector Blocks"); - resetConnectors.addLore(ChatColor.GRAY + "Restore every connector in this workcell from disk."); - resetConnectors.addLore(ChatColor.GRAY + "Other edited blocks are left unchanged."); - resetConnectors.onLeftClick(clicked -> resetConnectorBlocks( - window.getViewer(), - state.requestId(), - renderedWorkcell.stableId())); - window.setElement(4, 1, resetConnectors); - - window.setElement(-2, 2, axisElement( - window, - state, - renderedWorkcell, - DimensionAxis.WIDTH, - Material.IRON_INGOT)); - window.setElement(0, 2, axisElement( - window, - state, - renderedWorkcell, - DimensionAxis.HEIGHT, - Material.GOLD_INGOT)); - window.setElement(2, 2, axisElement( - window, - state, - renderedWorkcell, - DimensionAxis.DEPTH, - Material.COPPER_INGOT)); - - if (pendingResize != null) { - UIElement apply = element( - "settings-apply-capacity", - pendingResize.applying() ? Material.CLOCK : Material.EMERALD_BLOCK, - pendingResize.applying() - ? ChatColor.YELLOW + "Applying Cell Size" - : ChatColor.GREEN + "Apply Cell Size"); - apply.addLore(ChatColor.WHITE + dimensions(pendingResize.dimensions())); - apply.addLore(ChatColor.GRAY + "Regenerates the layout once after all size edits."); - if (!pendingResize.applying()) { - apply.onLeftClick(clicked -> applyWorkcellResize( - window.getViewer(), state.requestId(), renderedWorkcell.stableId())); - } - window.setElement(0, 3, apply); - - if (!pendingResize.applying()) { - UIElement discard = element( - "settings-discard-capacity", - Material.BARRIER, - ChatColor.RED + "Discard Size Changes"); - discard.onLeftClick(clicked -> discardWorkcellResize( - window.getViewer(), state.requestId(), renderedWorkcell.stableId())); - window.setElement(2, 3, discard); - } - } - - UIElement footerBack = element("settings-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - footerBack.onLeftClick(clicked -> leaveWorkcellSettings( - window.getViewer(), state.requestId(), renderedWorkcell.stableId())); - window.setElement(-4, 5, footerBack); - - UIElement undo = element( - "settings-undo", - Material.CLOCK, - ChatColor.LIGHT_PURPLE + "Undo Last Autosave"); - undo.addLore(ChatColor.GRAY + "Restore the previous owned graph iteration."); - undo.addLore(ChatColor.GRAY + "Up to five autosave iterations are retained on disk."); - undo.onLeftClick(clicked -> undoAutosave( - window.getViewer(), - state.requestId())); - window.setElement(0, 5, undo); - - if (renderedWorkcell.dirty() && !renderedWorkcell.saving()) { - UIElement saveNow = element( - "save-now", - Material.EMERALD, - ChatColor.GOLD + "Flush Autosave Now"); - saveNow.addLore(ChatColor.GRAY + "Autosave is automatic."); - saveNow.addLore(ChatColor.GRAY + "Use this only to flush pending work or recover immediately."); - saveNow.onLeftClick(clicked -> flushNow( - window.getViewer(), state.requestId(), renderedWorkcell.stableId())); - window.setElement(2, 5, saveNow); - } - - UIElement preview = element( - "settings-preview", - Material.ENDER_EYE, - ChatColor.LIGHT_PURPLE + "Go to Preview"); - preview.onLeftClick(clicked -> goToPreview(window.getViewer(), state.requestId())); - window.setElement(3, 5, preview); - - UIElement toolbox = element("settings-toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); - toolbox.onLeftClick(clicked -> openToolbox( - window.getViewer(), state.requestId(), renderedWorkcell.stableId(), 0)); - window.setElement(4, 5, toolbox); - }); - } - - private void renderVariantSizeSettings( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant - ) { - JigsawStudioCellDimensions current = variant.dimensions().orElseThrow(); - window.batch(() -> { - window.clearElements(); - - UIElement back = element("variant-size-back", Material.ARROW, ChatColor.YELLOW + "Back to Details"); - back.onLeftClick(clicked -> openDetails( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); - window.setElement(-4, 0, back); - - UIElement identity = element( - "variant-size-identity", - Material.SCAFFOLDING, - ChatColor.AQUA + safe(variant.displayName()) + " Size"); - identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); - identity.addLore(ChatColor.WHITE + "Current: " + dimensions(current)); - identity.addLore(ChatColor.GRAY + "Workcell capacity: " + dimensions(workcell.capacity())); - identity.addLore(ChatColor.GRAY + "Only this variant object and its edge connectors change."); - window.setElement(0, 0, identity); - window.setElement(4, 0, evaluationElement(state.evaluation())); - - window.setElement(-2, 2, variantAxisElement( - window, state, workcell, variant, DimensionAxis.WIDTH, Material.IRON_INGOT)); - window.setElement(0, 2, variantAxisElement( - window, state, workcell, variant, DimensionAxis.HEIGHT, Material.GOLD_INGOT)); - window.setElement(2, 2, variantAxisElement( - window, state, workcell, variant, DimensionAxis.DEPTH, Material.COPPER_INGOT)); - - UIElement capacity = element( - "variant-size-capacity", - variant.resizableToCapacity() ? Material.NETHER_STAR : Material.GRAY_DYE, - variant.resizableToCapacity() - ? ChatColor.GREEN + "Resize This Variant to Capacity" - : ChatColor.GRAY + "Variant Already Matches Capacity"); - capacity.addLore(ChatColor.GRAY + dimensions(workcell.capacity())); - if (variant.resizableToCapacity()) { - capacity.addLore(ChatColor.YELLOW + "Left-click to resize only this variant"); - capacity.onLeftClick(clicked -> resizeVariant( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - workcell.capacity())); - } - window.setElement(0, 3, capacity); - - UIElement footerBack = element("variant-size-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - footerBack.onLeftClick(clicked -> openDetails( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); - window.setElement(-4, 5, footerBack); - }); - } - - private UIElement variantAxisElement( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - DimensionAxis axis, - Material material - ) { - JigsawStudioCellDimensions current = variant.dimensions().orElseThrow(); - UIElement element = element( - "variant-axis-" + axis.name().toLowerCase(Locale.ROOT), - material, - ChatColor.AQUA + axis.displayName() + ": " + axis.value(current)); - element.addLore(ChatColor.GREEN + "Left-click: +1"); - element.addLore(ChatColor.YELLOW + "Right-click: -1"); - element.addLore(ChatColor.GREEN + "Shift-left: +8"); - element.addLore(ChatColor.YELLOW + "Shift-right: -8"); - element.addLore(ChatColor.GRAY + "Maximum: " + axis.value(workcell.capacity())); - element.onLeftClick(clicked -> resizeVariantAxis( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, 1)); - element.onRightClick(clicked -> resizeVariantAxis( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, -1)); - element.onShiftLeftClick(clicked -> resizeVariantAxis( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, 8)); - element.onShiftRightClick(clicked -> resizeVariantAxis( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, -8)); - return element; - } - - private void renderStructureSettings( - UIWindow window, - JigsawStudioMenuState state, - String selectedWorkcellId, - int requestedPage - ) { - int page = clampPage(requestedPage, state.themeSets().size(), THEME_SETS_PER_PAGE); - purgeExpiredConfirmations(window.getViewer().getUniqueId()); - window.batch(() -> { - window.clearElements(); - - UIElement back = element("structure-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); - back.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), selectedWorkcellId, 0)); - window.setElement(-4, 0, back); - - UIElement identity = element( - "structure-identity", - Material.JIGSAW, - ChatColor.LIGHT_PURPLE + "Structure Themes & Caps"); - identity.addLore(ChatColor.DARK_GRAY + safe(state.structureKey())); - identity.addLore(ChatColor.GRAY + "Compatibility: " + compatibilityName(state.compatibilityTarget())); - identity.addLore(ChatColor.GRAY + "Theme sets select one coherent variant family per assembly."); - identity.addLore(ChatColor.GRAY + "Empty piece themes remain available to every family."); - window.setElement(0, 0, identity); - window.setElement(4, 0, evaluationElement(state.evaluation())); - - UIElement requireCaps = element( - "require-caps", - state.irisExtended() - ? state.requireCaps() ? Material.IRON_BARS : Material.TRIPWIRE_HOOK - : Material.BARRIER, - !state.irisExtended() - ? ChatColor.GRAY + "Mandatory Caps Require Iris Compatibility" - : state.requireCaps() - ? ChatColor.GREEN + "Mandatory Caps Enabled" - : ChatColor.YELLOW + "Mandatory Caps Disabled"); - requireCaps.addLore(!state.irisExtended() - ? ChatColor.GRAY + "Vanilla-portable export rejects Iris mandatory-cap metadata." - : state.requireCaps() - ? ChatColor.GRAY + "Every open connector must close with a terminal piece." - : ChatColor.GRAY + "Assembly may leave an open connector when no cap can fit."); - if (state.irisExtended()) { - requireCaps.addLore(ChatColor.YELLOW + "Left-click to toggle"); - requireCaps.onLeftClick(clicked -> setRequireCaps( - window.getViewer(), state.requestId(), !state.requireCaps())); - } - window.setElement(-3, 1, requireCaps); - - String nextThemeKey = nextThemeSetKey(state.themeSets()); - boolean themeEditingAvailable = state.irisExtended(); - UIElement createTheme = element( - "new-theme-set", - themeEditingAvailable ? Material.NETHER_STAR : Material.BARRIER, - themeEditingAvailable - ? ChatColor.GREEN + "Duplicate All Enabled Cells as Family: " + safe(nextThemeKey) - : ChatColor.GRAY + "Theme Sets Require Iris Compatibility"); - if (themeEditingAvailable) { - createTheme.addLore(ChatColor.GRAY + "Creates one new owned variant for every enabled workcell."); - createTheme.addLore(ChatColor.GRAY + "All created variants join " + safe(nextThemeKey) + "."); - createTheme.addLore(ChatColor.GRAY + "One family is selected for the complete assembly."); - createTheme.addLore(ChatColor.YELLOW + "Left-click to create the complete set"); - createTheme.onLeftClick(clicked -> duplicateActiveFamily( - window.getViewer(), state.requestId(), nextThemeKey)); - } else { - createTheme.addLore(ChatColor.GRAY + "Vanilla jigsaw resources cannot encode Iris theme metadata."); - } - window.setElement(0, 1, createTheme); - - boolean deleteConfirmed = isProjectDeleteConfirmed( - window.getViewer().getUniqueId(), state.requestId()); - UIElement deleteProject = element( - "delete-project", - deleteConfirmed ? Material.REDSTONE : Material.LAVA_BUCKET, - deleteConfirmed - ? ChatColor.RED + "Confirm Delete Jigsaw" - : ChatColor.RED + "Delete Jigsaw") - .setEnchanted(deleteConfirmed); - deleteProject.addLore(deleteConfirmed - ? ChatColor.RED + "Click again to delete this entire managed project." - : ChatColor.RED + "Click twice within 10 seconds to confirm."); - deleteProject.onLeftClick(clicked -> confirmOrDeleteProject( - window.getViewer(), state.requestId(), selectedWorkcellId, page)); - window.setElement(3, 1, deleteProject); - - addThemeSets(window, state, page); - - UIElement footerBack = element("structure-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - footerBack.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), selectedWorkcellId, 0)); - window.setElement(-4, 5, footerBack); - - int pageCount = pageCount(state.themeSets().size(), THEME_SETS_PER_PAGE); - if (page > 0) { - UIElement previous = element( - "theme-previous", - Material.ARROW, - ChatColor.YELLOW + "Previous Page"); - previous.onLeftClick(clicked -> refreshStructureSettings( - window.getViewer(), state.requestId(), selectedWorkcellId, page - 1)); - window.setElement(-1, 5, previous); - } - UIElement indicator = element( - "theme-page", - Material.BOOK, - ChatColor.WHITE + "Page " + (page + 1) + "/" + pageCount); - indicator.addLore(ChatColor.GRAY + "" + state.themeSets().size() + " theme sets"); - window.setElement(0, 5, indicator); - if (page + 1 < pageCount) { - UIElement next = element("theme-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); - next.onLeftClick(clicked -> refreshStructureSettings( - window.getViewer(), state.requestId(), selectedWorkcellId, page + 1)); - window.setElement(1, 5, next); - } - window.setElement(4, 5, evaluationElement(state.evaluation())); - }); - } - - private void addThemeSets( - UIWindow window, - JigsawStudioMenuState state, - int page - ) { - List themeSets = page( - state.themeSets(), page, THEME_SETS_PER_PAGE); - if (themeSets.isEmpty()) { - UIElement empty = element( - "no-theme-sets", - Material.GRAY_DYE, - ChatColor.GRAY + "Implicit Unthemed Assembly"); - empty.addLore(ChatColor.GRAY + "Create variant-1 to begin coherent theme selection."); - window.setElement(0, 3, empty); - return; - } - for (int index = 0; index < themeSets.size(); index++) { - JigsawStudioMenuState.ThemeSet themeSet = themeSets.get(index); - int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; - int row = 2 + index / GRID_POSITIONS.length; - UIElement element = element( - "theme-set-" + index, - state.irisExtended() ? Material.PURPLE_DYE : Material.GRAY_DYE, - (state.irisExtended() ? ChatColor.LIGHT_PURPLE : ChatColor.GRAY) + safe(themeSet.key())); - element.addLore(ChatColor.WHITE + "Selection weight: " + themeSet.weight()); - element.addLore(ChatColor.WHITE + "Whole-assembly chance: " - + themeSelectionPercent(state.themeSets(), themeSet)); - if (state.irisExtended()) { - element.addLore(ChatColor.GREEN + "Left-click: weight +1"); - element.addLore(ChatColor.YELLOW + "Right-click: weight -1"); - element.addLore(ChatColor.GREEN + "Shift-left: weight +8"); - element.addLore(ChatColor.YELLOW + "Shift-right: weight -8"); - element.onLeftClick(clicked -> adjustThemeSetWeight( - window.getViewer(), state.requestId(), themeSet, 1)); - element.onRightClick(clicked -> adjustThemeSetWeight( - window.getViewer(), state.requestId(), themeSet, -1)); - element.onShiftLeftClick(clicked -> adjustThemeSetWeight( - window.getViewer(), state.requestId(), themeSet, 8)); - element.onShiftRightClick(clicked -> adjustThemeSetWeight( - window.getViewer(), state.requestId(), themeSet, -8)); - } else { - element.addLore(ChatColor.GRAY + "Theme metadata is unavailable for vanilla-portable graphs."); - } - window.setElement(position, row, element); - } - } - - private UIElement axisElement( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - DimensionAxis axis, - Material material - ) { - UIElement element = element( - "axis-" + axis.name().toLowerCase(Locale.ROOT), - material, - ChatColor.AQUA + axis.displayName() + " Capacity: " + axis.value(workcell.capacity())); - element.addLore(ChatColor.GREEN + "Left-click: +1"); - element.addLore(ChatColor.YELLOW + "Right-click: -1"); - element.addLore(ChatColor.GREEN + "Shift-left: +8"); - element.addLore(ChatColor.YELLOW + "Shift-right: -8"); - element.addLore(ChatColor.GRAY + "Changes stay in this menu until Apply Cell Size."); - element.onLeftClick(clicked -> resizeWorkcell( - window.getViewer(), state.requestId(), workcell.stableId(), axis, 1)); - element.onRightClick(clicked -> resizeWorkcell( - window.getViewer(), state.requestId(), workcell.stableId(), axis, -1)); - element.onShiftLeftClick(clicked -> resizeWorkcell( - window.getViewer(), state.requestId(), workcell.stableId(), axis, 8)); - element.onShiftRightClick(clicked -> resizeWorkcell( - window.getViewer(), state.requestId(), workcell.stableId(), axis, -8)); - return element; - } - - private void renderDetails( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int requestedPage - ) { - int page = clampPage(requestedPage, variant.memberships().size(), MEMBERSHIPS_PER_PAGE); - purgeExpiredConfirmations(window.getViewer().getUniqueId()); - window.batch(() -> { - window.clearElements(); - addDetailsHeader(window, state, workcell, variant, page); - addMemberships(window, state, workcell, variant, page); - addDetailsFooter(window, state, workcell, variant, page); - }); - } - - private void addDetailsHeader( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int page - ) { - UIElement back = element("back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); - back.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(-4, 0, back); - - UIElement identity = element("identity", Material.NAME_TAG, ChatColor.AQUA + safe(variant.displayName())); - identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); - identity.addLore(variant.owned() - ? ChatColor.GREEN + "Owned variant" - : ChatColor.GRAY + "Read-only variant"); - identity.addLore(variant.active() - ? ChatColor.GREEN + "Loaded in this workcell" - : ChatColor.GRAY + "Not currently loaded"); - identity.addLore(ChatColor.GRAY + "Size: " + variant.dimensions() - .map(JigsawStudioMenuController::dimensions) - .orElse("Object missing")); - identity.addLore(ChatColor.GRAY + "Themes: " + themes(variant.themes())); - identity.addLore(ChatColor.GRAY + "Depth: " + variant.rules().minimumDepth() - + "-" + variant.rules().maximumDepth()); - identity.addLore(ChatColor.GRAY + "Placements: " + variant.rules().minimumPlacements() - + "-" + maximumPlacements(variant.rules().maximumPlacements())); - identity.addLore(ChatColor.GRAY + "Terminal: " + yesNo(variant.rules().terminal())); - identity.addLore(ChatColor.GRAY + "Pool entries: " + variant.memberships().size()); - if (variant.owned()) { - identity.addLore(ChatColor.YELLOW + "Left-click for a rename stick"); - identity.addLore(ChatColor.GRAY + "Rename that stick in an anvil, then right-click it."); - identity.addLore(ChatColor.GRAY + "Sneak-right-click the stick to reset this label."); - identity.onLeftClick(clicked -> actions.giveTool( - window.getViewer(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.RENAME_VARIANT, - state.requestId(), - workcell.stableId(), - variant.pieceKey()))); - } - window.setElement(0, 0, identity); - - boolean activeOwned = variant.active() && variant.owned(); - boolean irisRuleEditing = activeOwned && state.irisExtended(); - UIElement settings = element( - "variant-settings", - irisRuleEditing ? Material.COMPARATOR : Material.GRAY_DYE, - irisRuleEditing - ? ChatColor.GOLD + "Themes & Piece Rules" - : ChatColor.GRAY + "Themes & Rules Unavailable"); - settings.addLore(irisRuleEditing - ? ChatColor.GRAY + "Edit this loaded variant's theme membership and placement rules." - : state.irisExtended() - ? ChatColor.GRAY + "Load an owned variant before editing its rules." - : ChatColor.GRAY + "Vanilla-portable pieces cannot encode Iris theme or rule metadata."); - if (irisRuleEditing) { - settings.addLore(ChatColor.YELLOW + "Left-click to edit"); - settings.onLeftClick(clicked -> openVariantSettings( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); - } - window.setElement(-2, 0, settings); - - boolean rotationEditable = variant.active() && variant.rotationEditable(); - UIElement rotation = element( - "rotation", - rotationEditable ? Material.REPEATER : Material.BARRIER, - rotationEditable - ? ChatColor.LIGHT_PURPLE + "Toggle Rotation" - : ChatColor.GRAY + "Rotation is Read-only"); - rotation.addLore(ChatColor.GRAY + "Currently: " + (variant.rotatable() ? "Enabled" : "Disabled")); - if (rotationEditable) { - rotation.addLore(ChatColor.YELLOW + "Left-click to toggle"); - rotation.onLeftClick(clicked -> toggleRotation( - window.getViewer(), state.requestId(), workcell.stableId())); - } else if (!variant.active()) { - rotation.addLore(ChatColor.GRAY + "Load this variant before editing rotation."); - } else if (variant.owned() && variant.rotatable()) { - rotation.addLore(ChatColor.GRAY + "Vanilla-portable variants must remain rotatable."); - } - window.setElement(3, 0, rotation); - - boolean sizeEditable = variant.owned() && variant.dimensions().isPresent(); - UIElement size = element( - "variant-size", - sizeEditable ? Material.SCAFFOLDING : Material.BARRIER, - sizeEditable - ? ChatColor.GREEN + "Edit This Variant's Size" - : ChatColor.GRAY + "Variant Size is Read-only"); - size.addLore(ChatColor.GRAY + "Current: " + variant.dimensions() - .map(JigsawStudioMenuController::dimensions) - .orElse("Object missing")); - size.addLore(ChatColor.GRAY + "Workcell capacity: " + dimensions(workcell.capacity())); - if (sizeEditable) { - size.addLore(ChatColor.YELLOW + "Left-click for width, height, and depth controls"); - size.onLeftClick(clicked -> openVariantSizeSettings( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey())); - if (variant.resizableToCapacity()) { - size.addLore(ChatColor.YELLOW + "Shift-left: resize this variant to capacity"); - size.onShiftLeftClick(clicked -> resizeVariant( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - workcell.capacity())); - } - } - window.setElement(2, 0, size); - - boolean lastVariant = workcell.variants().size() <= 1; - boolean deletionAvailable = variant.owned() && !variant.active() && !lastVariant; - boolean confirmed = deletionAvailable && isDeleteConfirmed( - window.getViewer().getUniqueId(), - state.requestId(), - workcell.stableId(), - variant.pieceKey()); - UIElement delete = element( - "delete-variant", - deletionAvailable ? confirmed ? Material.REDSTONE : Material.LAVA_BUCKET : Material.BARRIER, - deletionAvailable - ? confirmed ? ChatColor.RED + "Confirm Delete Variant" : ChatColor.RED + "Delete Variant" - : variant.active() - ? ChatColor.GRAY + "Loaded Variant Cannot Be Deleted" - : lastVariant - ? ChatColor.GRAY + "Last Variant Cannot Be Deleted" - : ChatColor.GRAY + "Deletion is Read-only") - .setEnchanted(confirmed); - if (deletionAvailable) { - delete.addLore(confirmed - ? ChatColor.RED + "Click again to permanently delete this owned variant." - : ChatColor.RED + "Click twice within 10 seconds to confirm."); - delete.onLeftClick(clicked -> confirmOrDeleteVariant( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - page)); - } else if (variant.active()) { - delete.addLore(ChatColor.GRAY + "Load another variant in this workcell first."); - } else if (lastVariant) { - delete.addLore(ChatColor.GRAY + "Create another variant before deleting this one."); - } - window.setElement(4, 0, delete); - } - - private void addMemberships( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int page - ) { - List memberships = page( - variant.memberships(), page, MEMBERSHIPS_PER_PAGE); - if (memberships.isEmpty()) { - UIElement empty = element("no-memberships", Material.BARRIER, ChatColor.RED + "No Pool Entries"); - empty.addLore(ChatColor.GRAY + "This variant is not linked from an owned pool."); - window.setElement(0, 2, empty); - return; - } - - for (int index = 0; index < memberships.size(); index++) { - JigsawStudioMenuState.Membership membership = memberships.get(index); - int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; - int row = 1 + index / GRID_POSITIONS.length; - boolean confirmed = variant.active() && variant.owned() && isUnlinkConfirmed( - window.getViewer().getUniqueId(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - membership); - UIElement element = element( - "membership-" + index, - confirmed ? Material.REDSTONE : Material.GOLD_NUGGET, - (confirmed ? ChatColor.RED : ChatColor.GOLD) - + safe(displayKey(membership.poolKey())) - + " [" + membership.entryIndex() + "]") - .setEnchanted(confirmed); - element.addLore(ChatColor.DARK_GRAY + safe(membership.poolKey())); - element.addLore(ChatColor.GRAY + "Exact entry: " + membership.entryIndex()); - element.addLore(ChatColor.WHITE + "Weight: " + membership.weight()); - element.addLore((state.irisExtended() ? ChatColor.WHITE : ChatColor.GRAY) - + "Chance: " + chance(membership.chance()) - + (state.irisExtended() ? "" : " (Iris only)")); - if (variant.active() && variant.owned()) { - element.addLore(ChatColor.GREEN + "Left-click: weight +1"); - element.addLore(ChatColor.YELLOW + "Right-click: weight -1"); - if (state.irisExtended()) { - element.addLore(ChatColor.GREEN + "Shift-left: chance +" - + CHANCE_STEP_PERCENTAGE_POINTS + "%"); - element.addLore(ChatColor.YELLOW + "Shift-right: chance -" - + CHANCE_STEP_PERCENTAGE_POINTS + "%"); - } else { - element.addLore(ChatColor.GRAY + "Vanilla-portable pool entries always have 100% chance."); - } - element.addLore(confirmed - ? ChatColor.RED + "Middle-click again to unlink" - : ChatColor.RED + "Middle-click twice to unlink"); - element.onLeftClick(clicked -> adjustMembershipWeight( - window.getViewer(), state.requestId(), workcell.stableId(), membership, 1)); - element.onRightClick(clicked -> adjustMembershipWeight( - window.getViewer(), state.requestId(), workcell.stableId(), membership, -1)); - if (state.irisExtended()) { - element.onShiftLeftClick(clicked -> adjustMembershipChance( - window.getViewer(), - state.requestId(), - workcell.stableId(), - membership, - CHANCE_STEP_PERCENTAGE_POINTS)); - element.onShiftRightClick(clicked -> adjustMembershipChance( - window.getViewer(), - state.requestId(), - workcell.stableId(), - membership, - -CHANCE_STEP_PERCENTAGE_POINTS)); - } - element.onMiddleClick(clicked -> confirmOrUnlink( - window.getViewer(), state.requestId(), workcell.stableId(), membership, page)); - } else { - element.addLore(variant.active() - ? ChatColor.GRAY + "Read-only pool entry" - : ChatColor.GRAY + "Load this variant to edit its pool entry"); - } - window.setElement(position, row, element); - } - } - - private void addDetailsFooter( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int page - ) { - UIElement back = element("footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - back.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(-4, 5, back); - - int pageCount = pageCount(variant.memberships().size(), MEMBERSHIPS_PER_PAGE); - if (page > 0) { - UIElement previous = element("membership-previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); - previous.onLeftClick(clicked -> refreshDetails( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - page - 1)); - window.setElement(-1, 5, previous); - } - UIElement indicator = element("membership-page", Material.BOOK, ChatColor.WHITE + "Page " - + (page + 1) + "/" + pageCount); - indicator.addLore(ChatColor.GRAY + "" + variant.memberships().size() + " exact pool entries"); - window.setElement(0, 5, indicator); - if (page + 1 < pageCount) { - UIElement next = element("membership-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); - next.onLeftClick(clicked -> refreshDetails( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - page + 1)); - window.setElement(1, 5, next); - } - window.setElement(2, 5, evaluationElement(state.evaluation())); - - UIElement toolbox = element("details-toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); - toolbox.onLeftClick(clicked -> openToolbox( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(4, 5, toolbox); - } - - private void renderVariantSettings( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int requestedPage - ) { - int page = clampPage(requestedPage, state.themeSets().size(), THEME_SETS_PER_PAGE); - window.batch(() -> { - window.clearElements(); - - UIElement back = element("variant-settings-back", Material.ARROW, ChatColor.YELLOW + "Back to Details"); - back.onLeftClick(clicked -> openDetails( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); - window.setElement(-4, 0, back); - - UIElement identity = element( - "variant-settings-identity", - Material.COMPARATOR, - ChatColor.GOLD + safe(variant.displayName()) + " Rules"); - identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); - identity.addLore(ChatColor.GRAY + "Theme memberships: " + themes(variant.themes())); - identity.addLore(ChatColor.GRAY + "Use Duplicate All Enabled Cells as Family for coherent sets."); - window.setElement(0, 0, identity); - window.setElement(4, 0, evaluationElement(state.evaluation())); - - if (!variant.active() || !variant.owned() || !state.irisExtended()) { - UIElement unavailable = element( - "variant-settings-unavailable", - Material.BARRIER, - state.irisExtended() - ? ChatColor.RED + "Load an Owned Variant First" - : ChatColor.GRAY + "Iris Metadata Unavailable"); - unavailable.addLore(state.irisExtended() - ? ChatColor.GRAY + "Rules and themes can only change for the loaded owned variant." - : ChatColor.GRAY + "Vanilla-portable pieces use vanilla placement behavior."); - window.setElement(0, 2, unavailable); - } else { - window.setElement(-4, 1, ruleElement( - window, state, workcell, variant, RuleField.MINIMUM_DEPTH)); - window.setElement(-2, 1, ruleElement( - window, state, workcell, variant, RuleField.MAXIMUM_DEPTH)); - window.setElement(0, 1, ruleElement( - window, state, workcell, variant, RuleField.MINIMUM_PLACEMENTS)); - window.setElement(2, 1, ruleElement( - window, state, workcell, variant, RuleField.MAXIMUM_PLACEMENTS)); - - UIElement terminal = element( - "rule-terminal", - variant.rules().terminal() ? Material.REDSTONE_TORCH : Material.LEVER, - variant.rules().terminal() - ? ChatColor.GREEN + "Terminal Piece: Yes" - : ChatColor.YELLOW + "Terminal Piece: No"); - terminal.addLore(ChatColor.GRAY + "Terminal pieces consume a connector without expanding."); - terminal.addLore(ChatColor.YELLOW + "Left-click to toggle"); - terminal.onLeftClick(clicked -> updateVariantRules( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - withTerminal(variant.rules(), !variant.rules().terminal()))); - window.setElement(4, 1, terminal); - - addVariantThemeMemberships(window, state, workcell, variant, page); - } - - UIElement footerBack = element("variant-rules-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - footerBack.onLeftClick(clicked -> openDetails( - window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); - window.setElement(-4, 5, footerBack); - - int pageCount = pageCount(state.themeSets().size(), THEME_SETS_PER_PAGE); - if (page > 0) { - UIElement previous = element( - "variant-theme-previous", - Material.ARROW, - ChatColor.YELLOW + "Previous Page"); - previous.onLeftClick(clicked -> refreshVariantSettings( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - page - 1)); - window.setElement(-1, 5, previous); - } - UIElement indicator = element( - "variant-theme-page", - Material.BOOK, - ChatColor.WHITE + "Theme Page " + (page + 1) + "/" + pageCount); - indicator.addLore(ChatColor.GRAY + "" + state.themeSets().size() + " declared themes"); - window.setElement(0, 5, indicator); - if (page + 1 < pageCount) { - UIElement next = element( - "variant-theme-next", - Material.ARROW, - ChatColor.YELLOW + "Next Page"); - next.onLeftClick(clicked -> refreshVariantSettings( - window.getViewer(), - state.requestId(), - workcell.stableId(), - variant.pieceKey(), - page + 1)); - window.setElement(1, 5, next); - } - window.setElement(4, 5, evaluationElement(state.evaluation())); - }); - } - - private UIElement ruleElement( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - RuleField field - ) { - int value = field.value(variant.rules()); - UIElement element = element( - "rule-" + field.name().toLowerCase(Locale.ROOT), - field.material(), - ChatColor.AQUA + field.displayName() + ": " + field.displayValue(value)); - boolean unlimitedMaximum = field == RuleField.MAXIMUM_PLACEMENTS && value == 0; - if (unlimitedMaximum) { - element.addLore(ChatColor.GRAY + "Increase is already unlimited."); - } else { - element.addLore(ChatColor.GREEN + "Left-click: +1"); - element.addLore(ChatColor.GREEN + "Shift-left: +" + field.shiftStep()); - element.onLeftClick(clicked -> adjustVariantRule( - window.getViewer(), state.requestId(), workcell, variant, field, 1)); - element.onShiftLeftClick(clicked -> adjustVariantRule( - window.getViewer(), state.requestId(), workcell, variant, field, field.shiftStep())); - } - element.addLore(unlimitedMaximum - ? ChatColor.YELLOW + "Right-click: set 512" - : ChatColor.YELLOW + "Right-click: -1"); - element.addLore(unlimitedMaximum - ? ChatColor.YELLOW + "Shift-right: set 497" - : ChatColor.YELLOW + "Shift-right: -" + field.shiftStep()); - element.onRightClick(clicked -> adjustVariantRule( - window.getViewer(), state.requestId(), workcell, variant, field, -1)); - element.onShiftRightClick(clicked -> adjustVariantRule( - window.getViewer(), state.requestId(), workcell, variant, field, -field.shiftStep())); - return element; - } - - private void addVariantThemeMemberships( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - int page - ) { - List themeSets = page( - state.themeSets(), page, THEME_SETS_PER_PAGE); - if (themeSets.isEmpty()) { - UIElement empty = element( - "variant-no-themes", - Material.GRAY_DYE, - ChatColor.GRAY + "Available to Every Theme"); - empty.addLore(ChatColor.GRAY + "Create a coherent theme set from Structure Rules first."); - window.setElement(0, 3, empty); - return; - } - for (int index = 0; index < themeSets.size(); index++) { - JigsawStudioMenuState.ThemeSet themeSet = themeSets.get(index); - boolean member = variant.themes().contains(themeSet.key()); - int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; - int row = 2 + index / GRID_POSITIONS.length; - UIElement element = element( - "variant-theme-" + index, - member ? Material.LIME_DYE : Material.GRAY_DYE, - (member ? ChatColor.GREEN : ChatColor.GRAY) + safe(themeSet.key())) - .setEnchanted(member); - element.addLore(member - ? ChatColor.GREEN + "This variant belongs to the theme." - : ChatColor.GRAY + "This variant does not belong to the theme."); - element.addLore(ChatColor.GRAY + "Only variants in the selected family are eligible."); - element.addLore(ChatColor.YELLOW + "Left-click to toggle membership"); - element.onLeftClick(clicked -> toggleVariantTheme( - window.getViewer(), state.requestId(), workcell, variant, themeSet.key())); - window.setElement(position, row, element); - } - } - - private void renderToolbox( - UIWindow window, - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell, - int requestedPage - ) { - List allTools = toolboxTools(state, workcell); - int page = clampPage(requestedPage, allTools.size(), TOOLS_PER_PAGE); - List tools = page(allTools, page, TOOLS_PER_PAGE); - window.batch(() -> { - window.clearElements(); - - UIElement back = element("toolbox-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); - back.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(-4, 0, back); - - UIElement heading = element("toolbox-heading", Material.CHEST, ChatColor.AQUA + "Bound Tool Sticks"); - heading.addLore(ChatColor.GRAY + "Every stick is bound to request " + state.requestId()); - heading.addLore(ChatColor.GRAY + "Stale sticks stop working when this Studio closes."); - window.setElement(0, 0, heading); - window.setElement(4, 0, evaluationElement(state.evaluation())); - - for (int index = 0; index < tools.size(); index++) { - ToolboxTool tool = tools.get(index); - int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; - int row = 1 + index / GRID_POSITIONS.length; - UIElement element = element( - "tool-" + index, - Material.STICK, - ChatColor.AQUA + safe(tool.displayName())); - element.addLore(ChatColor.GRAY + "Action: " + tool.payload().action().displayName()); - addToolBindingLore(element, tool.payload()); - element.addLore(tool.payload().action().destructive() - ? ChatColor.RED + "Bound tools require confirmation when used." - : ChatColor.YELLOW + "Left-click to receive this named stick."); - element.onLeftClick(clicked -> giveTool( - window.getViewer(), state.requestId(), tool.payload())); - window.setElement(position, row, element); - } - - UIElement footerBack = element("toolbox-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); - footerBack.onLeftClick(clicked -> refreshMain( - window.getViewer(), state.requestId(), workcell.stableId(), 0)); - window.setElement(-4, 5, footerBack); - - int pageCount = pageCount(allTools.size(), TOOLS_PER_PAGE); - if (page > 0) { - UIElement previous = element("toolbox-previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); - previous.onLeftClick(clicked -> refreshToolbox( - window.getViewer(), state.requestId(), workcell.stableId(), page - 1)); - window.setElement(-1, 5, previous); - } - UIElement indicator = element("toolbox-page", Material.BOOK, ChatColor.WHITE + "Page " - + (page + 1) + "/" + pageCount); - indicator.addLore(ChatColor.GRAY + "" + allTools.size() + " bound tools"); - window.setElement(0, 5, indicator); - if (page + 1 < pageCount) { - UIElement next = element("toolbox-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); - next.onLeftClick(clicked -> refreshToolbox( - window.getViewer(), state.requestId(), workcell.stableId(), page + 1)); - window.setElement(1, 5, next); - } - }); - } - - private void selectWorkcell(Player player, UUID requestId, String workcellId) { + void selectWorkcell(Player player, UUID requestId, String workcellId) { if (matchingState(player, requestId, true).isEmpty()) { return; } @@ -1528,7 +283,7 @@ public final class JigsawStudioMenuController { } } - private void toggleConnectorBlocks( + void toggleConnectorBlocks( Player player, UUID requestId, String workcellId, @@ -1543,7 +298,7 @@ public final class JigsawStudioMenuController { } } - private void resetConnectorBlocks(Player player, UUID requestId, String workcellId) { + void resetConnectorBlocks(Player player, UUID requestId, String workcellId) { Optional current = matchingState(player, requestId, true); if (current.isEmpty() || current.get().workcell(workcellId) == null) { return; @@ -1553,7 +308,7 @@ public final class JigsawStudioMenuController { } } - private void undoAutosave(Player player, UUID requestId) { + void undoAutosave(Player player, UUID requestId) { if (matchingState(player, requestId, true).isEmpty()) { return; } @@ -1562,7 +317,7 @@ public final class JigsawStudioMenuController { } } - private void switchVariant(Player player, UUID requestId, String workcellId, String pieceKey) { + void switchVariant(Player player, UUID requestId, String workcellId, String pieceKey) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -1582,7 +337,7 @@ public final class JigsawStudioMenuController { } } - private void openDetails( + void openDetails( Player player, UUID requestId, String workcellId, @@ -1601,11 +356,11 @@ public final class JigsawStudioMenuController { } UIWindow window = windows.get(player.getUniqueId()); if (window != null) { - renderDetails(window, current.get(), workcell, variant, page); + detailsMenu.render(window, current.get(), workcell, variant, page); } } - private void openWorkcellSettings(Player player, UUID requestId, String workcellId) { + void openWorkcellSettings(Player player, UUID requestId, String workcellId) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -1616,10 +371,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderWorkcellSettings(window, current.get(), workcell); + workcellMenu.render(window, current.get(), workcell); } - private void openStructureSettings( + void openStructureSettings( Player player, UUID requestId, String selectedWorkcellId, @@ -1634,10 +389,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderStructureSettings(window, current.get(), selectedWorkcellId, page); + structureMenu.render(window, current.get(), selectedWorkcellId, page); } - private void openVariantSettings( + void openVariantSettings( Player player, UUID requestId, String workcellId, @@ -1664,10 +419,10 @@ public final class JigsawStudioMenuController { + "Vanilla-portable pieces cannot encode Iris theme or piece-rule metadata."); return; } - renderVariantSettings(window, current.get(), workcell, variant, page); + variantMenu.render(window, current.get(), workcell, variant, page); } - private void openVariantSizeSettings( + void openVariantSizeSettings( Player player, UUID requestId, String workcellId, @@ -1685,10 +440,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderVariantSizeSettings(window, current.get(), workcell, variant); + workcellMenu.renderSize(window, current.get(), workcell, variant); } - private void openToolbox(Player player, UUID requestId, String workcellId, int page) { + void openToolbox(Player player, UUID requestId, String workcellId, int page) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -1699,10 +454,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderToolbox(window, current.get(), workcell, page); + toolboxMenu.render(window, current.get(), workcell, page); } - private void createVariant( + void createVariant( Player player, UUID requestId, String workcellId, @@ -1716,7 +471,7 @@ public final class JigsawStudioMenuController { } } - private void setWorkcellEnabled( + void setWorkcellEnabled( Player player, UUID requestId, String workcellId, @@ -1735,179 +490,7 @@ public final class JigsawStudioMenuController { } } - private void resizeWorkcell( - Player player, - UUID requestId, - String workcellId, - DimensionAxis axis, - int delta - ) { - Optional current = matchingState(player, requestId, true); - if (current.isEmpty()) { - return; - } - JigsawStudioMenuState.Workcell workcell = current.get().workcell(workcellId); - if (workcell == null) { - stale(player); - return; - } - UUID playerId = player.getUniqueId(); - PendingWorkcellResize existing = pendingWorkcellResize(playerId, requestId, workcellId); - if (existing != null && existing.applying()) { - send(player, ChatColor.YELLOW + "That cell size is already being applied."); - return; - } - JigsawStudioCellDimensions base = existing == null - ? workcell.capacity() - : existing.dimensions(); - Optional adjusted = adjustedDimensions( - base, axis, delta); - if (adjusted.isEmpty()) { - send(player, ChatColor.RED + "That workcell size is outside Iris limits."); - return; - } - PendingWorkcellResize pending = new PendingWorkcellResize( - requestId, - workcellId, - adjusted.get(), - false); - pendingWorkcellResizes.put(playerId, pending); - UIWindow window = windows.get(playerId); - if (window != null) { - renderWorkcellSettings(window, current.get(), withCapacity(workcell, pending.dimensions())); - } - } - - private void applyWorkcellResize(Player player, UUID requestId, String workcellId) { - Optional current = matchingState(player, requestId, true); - if (current.isEmpty()) { - return; - } - UUID playerId = player.getUniqueId(); - PendingWorkcellResize pending = pendingWorkcellResize(playerId, requestId, workcellId); - JigsawStudioMenuState.Workcell workcell = current.get().workcell(workcellId); - if (pending == null || pending.applying() || workcell == null) { - return; - } - if (workcell.capacity().equals(pending.dimensions())) { - pendingWorkcellResizes.remove(playerId, pending); - refreshWorkcellSettings(player, requestId, workcellId); - return; - } - PendingWorkcellResize applying = new PendingWorkcellResize( - requestId, - workcellId, - pending.dimensions(), - true); - pendingWorkcellResizes.put(playerId, applying); - UIWindow window = windows.get(playerId); - if (window != null) { - renderWorkcellSettings(window, current.get(), withCapacity(workcell, applying.dimensions())); - } - if (!actions.updateWorkcellDimensions(player, workcellId, applying.dimensions())) { - pendingWorkcellResizes.replace(playerId, applying, pending); - refreshWorkcellSettings(player, requestId, workcellId); - return; - } - scheduleWorkcellResizeRefresh(player, applying, WORKCELL_RESIZE_REFRESH_ATTEMPTS); - } - - private void scheduleWorkcellResizeRefresh( - Player player, - PendingWorkcellResize pending, - int attemptsRemaining - ) { - boolean scheduled = J.runEntity( - player, - () -> refreshAppliedWorkcellResize(player, pending, attemptsRemaining), - WORKCELL_RESIZE_REFRESH_TICKS); - if (!scheduled) { - pendingWorkcellResizes.remove(player.getUniqueId(), pending); - } - } - - private void refreshAppliedWorkcellResize( - Player player, - PendingWorkcellResize pending, - int attemptsRemaining - ) { - UUID playerId = player.getUniqueId(); - if (!pending.equals(pendingWorkcellResizes.get(playerId))) { - return; - } - Optional current = matchingState(player, pending.requestId(), false); - JigsawStudioMenuState.Workcell workcell = current - .map(state -> state.workcell(pending.workcellId())) - .orElse(null); - if (workcell == null) { - pendingWorkcellResizes.remove(playerId, pending); - return; - } - if (workcell.capacity().equals(pending.dimensions())) { - pendingWorkcellResizes.remove(playerId, pending); - UIWindow window = windows.get(playerId); - if (window != null) { - renderWorkcellSettings(window, current.orElseThrow(), workcell); - } - return; - } - if (attemptsRemaining > 0) { - scheduleWorkcellResizeRefresh(player, pending, attemptsRemaining - 1); - return; - } - PendingWorkcellResize retry = new PendingWorkcellResize( - pending.requestId(), - pending.workcellId(), - pending.dimensions(), - false); - pendingWorkcellResizes.replace(playerId, pending, retry); - UIWindow window = windows.get(playerId); - if (window != null) { - renderWorkcellSettings(window, current.orElseThrow(), withCapacity(workcell, retry.dimensions())); - } - send(player, ChatColor.YELLOW - + "Cell resizing is still pending; use Apply Cell Size to retry after the current operation settles."); - } - - private void discardWorkcellResize(Player player, UUID requestId, String workcellId) { - PendingWorkcellResize pending = pendingWorkcellResize(player.getUniqueId(), requestId, workcellId); - if (pending != null && !pending.applying()) { - pendingWorkcellResizes.remove(player.getUniqueId(), pending); - } - refreshWorkcellSettings(player, requestId, workcellId); - } - - private void leaveWorkcellSettings(Player player, UUID requestId, String workcellId) { - PendingWorkcellResize pending = pendingWorkcellResize(player.getUniqueId(), requestId, workcellId); - if (pending != null && !pending.applying()) { - pendingWorkcellResizes.remove(player.getUniqueId(), pending); - } - refreshMain(player, requestId, workcellId, 0); - } - - private void refreshWorkcellSettings(Player player, UUID requestId, String workcellId) { - Optional current = matchingState(player, requestId, true); - UIWindow window = windows.get(player.getUniqueId()); - JigsawStudioMenuState.Workcell workcell = current - .map(state -> state.workcell(workcellId)) - .orElse(null); - if (window == null || workcell == null) { - return; - } - renderWorkcellSettings(window, current.orElseThrow(), workcell); - } - - private PendingWorkcellResize pendingWorkcellResize(UUID playerId, UUID requestId, String workcellId) { - PendingWorkcellResize pending = pendingWorkcellResizes.get(playerId); - if (pending == null - || !pending.requestId().equals(requestId) - || !pending.workcellId().equals(workcellId)) { - return null; - } - return pending; - } - - private void resizeVariantAxis( + void resizeVariantAxis( Player player, UUID requestId, String workcellId, @@ -1934,7 +517,7 @@ public final class JigsawStudioMenuController { resizeVariant(player, requestId, workcellId, pieceKey, adjusted.get()); } - private void resizeVariant( + void resizeVariant( Player player, UUID requestId, String workcellId, @@ -1962,7 +545,7 @@ public final class JigsawStudioMenuController { } } - private void setRequireCaps(Player player, UUID requestId, boolean requireCaps) { + void setRequireCaps(Player player, UUID requestId, boolean requireCaps) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -1982,7 +565,7 @@ public final class JigsawStudioMenuController { } } - private void duplicateActiveFamily(Player player, UUID requestId, String themeKey) { + void duplicateActiveFamily(Player player, UUID requestId, String themeKey) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -2001,7 +584,7 @@ public final class JigsawStudioMenuController { } } - private void adjustThemeSetWeight( + void adjustThemeSetWeight( Player player, UUID requestId, JigsawStudioMenuState.ThemeSet expected, @@ -2031,7 +614,7 @@ public final class JigsawStudioMenuController { } } - private void flushNow(Player player, UUID requestId, String workcellId) { + void flushNow(Player player, UUID requestId, String workcellId) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -2050,14 +633,14 @@ public final class JigsawStudioMenuController { } } - private void goToPreview(Player player, UUID requestId) { + void goToPreview(Player player, UUID requestId) { if (matchingState(player, requestId, true).isPresent() && actions.goToPreview(player)) { closeAfterAction(player); } } - private void toggleRotation(Player player, UUID requestId, String workcellId) { + void toggleRotation(Player player, UUID requestId, String workcellId) { Optional current = matchingState(player, requestId, true); if (current.isEmpty() || activeVariant(current.get(), workcellId) == null) { return; @@ -2067,7 +650,7 @@ public final class JigsawStudioMenuController { } } - private void adjustVariantRule( + void adjustVariantRule( Player player, UUID requestId, JigsawStudioMenuState.Workcell workcell, @@ -2097,7 +680,7 @@ public final class JigsawStudioMenuController { rules.get()); } - private void updateVariantRules( + void updateVariantRules( Player player, UUID requestId, String workcellId, @@ -2123,7 +706,7 @@ public final class JigsawStudioMenuController { } } - private void toggleVariantTheme( + void toggleVariantTheme( Player player, UUID requestId, JigsawStudioMenuState.Workcell workcell, @@ -2160,7 +743,7 @@ public final class JigsawStudioMenuController { } } - private void adjustMembershipWeight( + void adjustMembershipWeight( Player player, UUID requestId, String workcellId, @@ -2189,7 +772,7 @@ public final class JigsawStudioMenuController { } } - private void adjustMembershipChance( + void adjustMembershipChance( Player player, UUID requestId, String workcellId, @@ -2222,7 +805,7 @@ public final class JigsawStudioMenuController { } } - private void confirmOrUnlink( + void confirmOrUnlink( Player player, UUID requestId, String workcellId, @@ -2264,7 +847,7 @@ public final class JigsawStudioMenuController { } } - private void confirmOrDeleteVariant( + void confirmOrDeleteVariant( Player player, UUID requestId, String workcellId, @@ -2300,7 +883,7 @@ public final class JigsawStudioMenuController { } } - private void confirmOrDeleteProject( + void confirmOrDeleteProject( Player player, UUID requestId, String selectedWorkcellId, @@ -2325,7 +908,7 @@ public final class JigsawStudioMenuController { } } - private void giveTool(Player player, UUID requestId, JigsawStudioToolPayload payload) { + void giveTool(Player player, UUID requestId, JigsawStudioToolPayload payload) { if (matchingState(player, requestId, true).isEmpty()) { return; } @@ -2336,7 +919,7 @@ public final class JigsawStudioMenuController { actions.giveTool(player, payload); } - private void refreshMain(Player player, UUID requestId, String workcellId, int page) { + void refreshMain(Player player, UUID requestId, String workcellId, int page) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -2347,10 +930,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderMain(window, current.get(), workcell, page); + mainMenu.render(window, current.get(), workcell, page); } - private void refreshDetails(Player player, UUID requestId, String workcellId, int page) { + void refreshDetails(Player player, UUID requestId, String workcellId, int page) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -2363,7 +946,7 @@ public final class JigsawStudioMenuController { refreshDetails(player, requestId, workcellId, active.pieceKey(), page); } - private void refreshDetails( + void refreshDetails( Player player, UUID requestId, String workcellId, @@ -2381,10 +964,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderDetails(window, current.get(), workcell, variant, page); + detailsMenu.render(window, current.get(), workcell, variant, page); } - private void refreshStructureSettings( + void refreshStructureSettings( Player player, UUID requestId, String selectedWorkcellId, @@ -2399,10 +982,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderStructureSettings(window, current.get(), selectedWorkcellId, page); + structureMenu.render(window, current.get(), selectedWorkcellId, page); } - private void refreshVariantSettings( + void refreshVariantSettings( Player player, UUID requestId, String workcellId, @@ -2420,10 +1003,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderVariantSettings(window, current.get(), workcell, variant, page); + variantMenu.render(window, current.get(), workcell, variant, page); } - private void refreshToolbox(Player player, UUID requestId, String workcellId, int page) { + void refreshToolbox(Player player, UUID requestId, String workcellId, int page) { Optional current = matchingState(player, requestId, true); if (current.isEmpty()) { return; @@ -2434,10 +1017,10 @@ public final class JigsawStudioMenuController { stale(player); return; } - renderToolbox(window, current.get(), workcell, page); + toolboxMenu.render(window, current.get(), workcell, page); } - private Optional matchingState(Player player, UUID requestId, boolean closeStale) { + Optional matchingState(Player player, UUID requestId, boolean closeStale) { Optional current = actions.menuState(player); if (current.isPresent() && current.get().requestId().equals(requestId)) { return current; @@ -2448,12 +1031,12 @@ public final class JigsawStudioMenuController { return Optional.empty(); } - private void stale(Player player) { + void stale(Player player) { closeAfterAction(player); send(player, ChatColor.RED + "This Jigsaw Studio menu is stale. Open the control chest again."); } - private static void send(Player player, String message) { + static void send(Player player, String message) { ComponentMessenger.sendSection(player, message); } @@ -2461,7 +1044,7 @@ public final class JigsawStudioMenuController { J.runEntity(player, () -> close(player), 1); } - private boolean isUnlinkConfirmed( + boolean isUnlinkConfirmed( UUID playerId, UUID requestId, String workcellId, @@ -2483,7 +1066,7 @@ public final class JigsawStudioMenuController { && pending.entryIndex() == membership.entryIndex(); } - private boolean isDeleteConfirmed( + boolean isDeleteConfirmed( UUID playerId, UUID requestId, String workcellId, @@ -2502,7 +1085,7 @@ public final class JigsawStudioMenuController { && pending.pieceKey().equals(pieceKey); } - private boolean isProjectDeleteConfirmed(UUID playerId, UUID requestId) { + boolean isProjectDeleteConfirmed(UUID playerId, UUID requestId) { PendingProjectDelete pending = pendingProjectDeletes.get(playerId); if (pending == null) { return false; @@ -2514,7 +1097,7 @@ public final class JigsawStudioMenuController { return pending.requestId().equals(requestId); } - private void purgeExpiredConfirmations(UUID playerId) { + void purgeExpiredConfirmations(UUID playerId) { PendingUnlink unlink = pendingUnlinks.get(playerId); if (unlink != null && unlink.expiresAtNanos() < System.nanoTime()) { pendingUnlinks.remove(playerId, unlink); @@ -2535,833 +1118,6 @@ public final class JigsawStudioMenuController { pendingProjectDeletes.remove(playerId); } - private static boolean hasMembership( - JigsawStudioMenuState state, - String workcellId, - JigsawStudioMenuState.Membership expected - ) { - JigsawStudioMenuState.Variant active = activeVariant(state, workcellId); - if (active == null) { - return false; - } - for (JigsawStudioMenuState.Membership membership : active.memberships()) { - if (membership.poolKey().equals(expected.poolKey()) - && membership.entryIndex() == expected.entryIndex()) { - return true; - } - } - return false; - } - - private static JigsawStudioMenuState.Variant activeVariant( - JigsawStudioMenuState state, - String workcellId - ) { - JigsawStudioMenuState.Workcell workcell = state.workcell(workcellId); - return workcell == null ? null : workcell.activeVariant(); - } - - private static JigsawStudioMenuState.Variant variant( - JigsawStudioMenuState.Workcell workcell, - String pieceKey - ) { - if (workcell == null || pieceKey == null) { - return null; - } - for (JigsawStudioMenuState.Variant variant : workcell.variants()) { - if (variant.pieceKey().equals(pieceKey)) { - return variant; - } - } - return null; - } - - static String nextThemeSetKey(List themeSets) { - List values = List.copyOf(Objects.requireNonNull( - themeSets, - "Jigsaw Studio theme sets")); - int candidate = 1; - while (candidate > 0) { - String key = "variant-" + candidate; - boolean present = false; - for (JigsawStudioMenuState.ThemeSet themeSet : values) { - if (Objects.requireNonNull(themeSet, "Jigsaw Studio theme set").key().equals(key)) { - present = true; - break; - } - } - if (!present) { - return key; - } - candidate = Math.incrementExact(candidate); - } - throw new IllegalStateException("Jigsaw Studio cannot allocate another numbered theme set"); - } - - static String themeSelectionPercent( - List themeSets, - JigsawStudioMenuState.ThemeSet target - ) { - List activeThemeSets = Objects.requireNonNull( - themeSets, - "Jigsaw Studio theme sets"); - JigsawStudioMenuState.ThemeSet activeTarget = Objects.requireNonNull( - target, - "Jigsaw Studio target theme set"); - int totalWeight = 0; - for (JigsawStudioMenuState.ThemeSet themeSet : activeThemeSets) { - totalWeight = Math.addExact(totalWeight, Objects.requireNonNull( - themeSet, - "Jigsaw Studio theme set").weight()); - } - if (totalWeight < 1) { - return "0.0%"; - } - return String.format( - Locale.ROOT, - "%.1f%%", - activeTarget.weight() * 100.0D / totalWeight); - } - - static Optional adjustedPositiveValue(int value, int delta) { - if (value < 1 || delta == 0) { - throw new IllegalArgumentException("Jigsaw Studio positive value adjustment is invalid"); - } - try { - int adjusted = Math.addExact(value, delta); - return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); - } catch (ArithmeticException exception) { - return Optional.empty(); - } - } - - static Optional adjustedRules( - JigsawStudioPieceRules rules, - RuleField field, - int delta - ) { - JigsawStudioPieceRules current = Objects.requireNonNull(rules, "Jigsaw Studio piece rules"); - RuleField target = Objects.requireNonNull(field, "Jigsaw Studio piece rule field"); - if (delta == 0) { - throw new IllegalArgumentException("Jigsaw Studio piece rule delta cannot be zero"); - } - try { - int minimumDepth = current.minimumDepth(); - int maximumDepth = current.maximumDepth(); - int minimumPlacements = current.minimumPlacements(); - int maximumPlacements = current.maximumPlacements(); - switch (target) { - case MINIMUM_DEPTH -> minimumDepth = Math.addExact(minimumDepth, delta); - case MAXIMUM_DEPTH -> maximumDepth = Math.addExact(maximumDepth, delta); - case MINIMUM_PLACEMENTS -> minimumPlacements = Math.addExact(minimumPlacements, delta); - case MAXIMUM_PLACEMENTS -> { - Optional adjustedMaximum = adjustedMaximumPlacements(maximumPlacements, delta); - if (adjustedMaximum.isEmpty()) { - return Optional.empty(); - } - maximumPlacements = adjustedMaximum.get(); - } - } - return Optional.of(new JigsawStudioPieceRules( - minimumDepth, - maximumDepth, - minimumPlacements, - maximumPlacements, - current.terminal())); - } catch (ArithmeticException | IllegalArgumentException exception) { - return Optional.empty(); - } - } - - static JigsawStudioPieceRules withTerminal(JigsawStudioPieceRules rules, boolean terminal) { - JigsawStudioPieceRules current = Objects.requireNonNull(rules, "Jigsaw Studio piece rules"); - return new JigsawStudioPieceRules( - current.minimumDepth(), - current.maximumDepth(), - current.minimumPlacements(), - current.maximumPlacements(), - terminal); - } - - private static Optional adjustedMaximumPlacements(int value, int delta) { - if (value == 0) { - if (delta > 0) { - return Optional.empty(); - } - int adjusted = Math.addExact(513, delta); - return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); - } - int adjusted = Math.addExact(value, delta); - if (adjusted > 512) { - return Optional.of(0); - } - return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); - } - - static Optional adjustedDimensions( - JigsawStudioCellDimensions dimensions, - DimensionAxis axis, - int delta - ) { - JigsawStudioCellDimensions current = Objects.requireNonNull( - dimensions, - "Jigsaw Studio workcell dimensions"); - DimensionAxis target = Objects.requireNonNull(axis, "Jigsaw Studio workcell dimension axis"); - if (delta == 0) { - throw new IllegalArgumentException("Jigsaw Studio workcell dimension delta cannot be zero"); - } - try { - int width = target == DimensionAxis.WIDTH - ? Math.addExact(current.width(), delta) - : current.width(); - int height = target == DimensionAxis.HEIGHT - ? Math.addExact(current.height(), delta) - : current.height(); - int depth = target == DimensionAxis.DEPTH - ? Math.addExact(current.depth(), delta) - : current.depth(); - return Optional.of(new JigsawStudioCellDimensions(width, height, depth)); - } catch (ArithmeticException | IllegalArgumentException exception) { - return Optional.empty(); - } - } - - static JigsawStudioMenuState.Workcell withCapacity( - JigsawStudioMenuState.Workcell workcell, - JigsawStudioCellDimensions capacity - ) { - JigsawStudioMenuState.Workcell source = Objects.requireNonNull( - workcell, - "Jigsaw Studio menu workcell"); - return new JigsawStudioMenuState.Workcell( - source.stableId(), - source.canonicalName(), - source.displayName(), - Objects.requireNonNull(capacity, "Jigsaw Studio staged workcell capacity"), - source.enabled(), - source.activeVariantKey(), - source.dirty(), - source.saving(), - source.loading(), - source.connectorsVisible(), - source.variants()); - } - - static List toolboxTools( - JigsawStudioMenuState state, - JigsawStudioMenuState.Workcell workcell - ) { - JigsawStudioMenuState menu = Objects.requireNonNull(state, "Jigsaw Studio toolbox state"); - JigsawStudioMenuState.Workcell selected = Objects.requireNonNull( - workcell, - "Jigsaw Studio toolbox workcell"); - UUID requestId = menu.requestId(); - List tools = new ArrayList<>(); - tools.add(new ToolboxTool( - "Open Control Menu", - JigsawStudioToolPayload.request(JigsawStudioToolAction.OPEN_MENU, requestId))); - tools.add(new ToolboxTool( - "Select " + selected.displayName(), - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.SELECT_WORKCELL, - requestId, - selected.stableId()))); - if (menu.mode() == JigsawStudioMode.PLANAR_JIGSAW) { - tools.add(new ToolboxTool( - "Toggle " + selected.displayName(), - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.TOGGLE_WORKCELL, - requestId, - selected.stableId()))); - } - tools.add(new ToolboxTool( - "Resize " + selected.displayName() + " Capacity", - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.RESIZE_WORKCELL, - requestId, - selected.stableId()))); - tools.add(new ToolboxTool( - "Rename " + selected.displayName(), - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.RENAME_WORKCELL, - requestId, - selected.stableId()))); - tools.add(new ToolboxTool( - "New Blank " + selected.displayName() + " Variant", - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.CREATE_VARIANT, - requestId, - selected.stableId()))); - tools.add(new ToolboxTool( - "Go to Preview", - JigsawStudioToolPayload.request(JigsawStudioToolAction.PREVIEW_GRAPH, requestId))); - tools.add(new ToolboxTool( - "Flush " + selected.displayName() + " Autosave", - JigsawStudioToolPayload.workcell( - JigsawStudioToolAction.FLUSH_AUTOSAVE, - requestId, - selected.stableId()))); - if (menu.irisExtended()) { - tools.add(new ToolboxTool( - "Duplicate All Enabled Cells as Family: " + nextThemeSetKey(menu.themeSets()), - JigsawStudioToolPayload.request(JigsawStudioToolAction.DUPLICATE_FAMILY, requestId))); - } - - JigsawStudioMenuState.Variant active = selected.activeVariant(); - if (active != null) { - if (active.owned()) { - tools.add(new ToolboxTool( - "Duplicate This Cell's Variant: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.DUPLICATE_VARIANT, - requestId, - selected.stableId(), - active.pieceKey()))); - } - if (active.owned()) { - tools.add(new ToolboxTool( - "Rename This Variant: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.RENAME_VARIANT, - requestId, - selected.stableId(), - active.pieceKey()))); - tools.add(new ToolboxTool( - "Resize This Variant: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.RESIZE_VARIANT, - requestId, - selected.stableId(), - active.pieceKey()))); - } - if (active.rotationEditable()) { - tools.add(new ToolboxTool( - "Toggle Rotation: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.TOGGLE_ROTATION, - requestId, - selected.stableId(), - active.pieceKey()))); - } - if (active.owned() && active.resizableToCapacity()) { - tools.add(new ToolboxTool( - "Resize " + active.displayName() + " to Capacity", - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.EXPAND_TO_CELL, - requestId, - selected.stableId(), - active.pieceKey()))); - } - if (active.owned() && menu.irisExtended()) { - tools.add(new ToolboxTool( - "Open Theme Memberships: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.SET_THEME, - requestId, - selected.stableId(), - active.pieceKey()))); - tools.add(new ToolboxTool( - "Open Piece Rules: " + active.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.SET_PIECE_RULES, - requestId, - selected.stableId(), - active.pieceKey()))); - } - if (active.owned()) { - for (JigsawStudioMenuState.Membership membership : active.memberships()) { - addMembershipTools( - tools, - requestId, - selected, - active, - membership, - menu.irisExtended()); - } - } - } - for (JigsawStudioMenuState.Variant variant : selected.variants()) { - if (variant.active()) { - continue; - } - tools.add(new ToolboxTool( - "Load " + variant.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.LOAD_VARIANT, - requestId, - selected.stableId(), - variant.pieceKey()))); - if (variant.owned()) { - tools.add(new ToolboxTool( - "Rename " + variant.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.RENAME_VARIANT, - requestId, - selected.stableId(), - variant.pieceKey()))); - tools.add(new ToolboxTool( - "Resize " + variant.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.RESIZE_VARIANT, - requestId, - selected.stableId(), - variant.pieceKey()))); - } - if (variant.owned() && selected.variants().size() > 1) { - tools.add(new ToolboxTool( - "Delete " + variant.displayName(), - JigsawStudioToolPayload.variant( - JigsawStudioToolAction.DELETE_VARIANT, - requestId, - selected.stableId(), - variant.pieceKey()))); - } - } - if (menu.irisExtended()) { - tools.add(new ToolboxTool( - menu.requireCaps() ? "Disable Mandatory Caps" : "Enable Mandatory Caps", - JigsawStudioToolPayload.request(JigsawStudioToolAction.TOGGLE_REQUIRE_CAPS, requestId))); - } - tools.add(new ToolboxTool( - "Delete Project", - JigsawStudioToolPayload.request(JigsawStudioToolAction.DELETE_PROJECT, requestId))); - return List.copyOf(tools); - } - - private static void addMembershipTools( - List tools, - UUID requestId, - JigsawStudioMenuState.Workcell workcell, - JigsawStudioMenuState.Variant variant, - JigsawStudioMenuState.Membership membership, - boolean chanceEditable - ) { - String membershipName = displayKey(membership.poolKey()) + " [" + membership.entryIndex() + "]"; - tools.add(new ToolboxTool( - "Weight +1: " + membershipName, - JigsawStudioToolPayload.membership( - JigsawStudioToolAction.ADJUST_VARIANT_WEIGHT, - requestId, - workcell.stableId(), - variant.pieceKey(), - membership.poolKey(), - membership.entryIndex(), - 1))); - tools.add(new ToolboxTool( - "Weight -1: " + membershipName, - JigsawStudioToolPayload.membership( - JigsawStudioToolAction.ADJUST_VARIANT_WEIGHT, - requestId, - workcell.stableId(), - variant.pieceKey(), - membership.poolKey(), - membership.entryIndex(), - -1))); - if (chanceEditable) { - tools.add(new ToolboxTool( - "Chance +" + CHANCE_STEP_PERCENTAGE_POINTS + "%: " + membershipName, - JigsawStudioToolPayload.membership( - JigsawStudioToolAction.ADJUST_VARIANT_CHANCE, - requestId, - workcell.stableId(), - variant.pieceKey(), - membership.poolKey(), - membership.entryIndex(), - CHANCE_STEP_PERCENTAGE_POINTS))); - tools.add(new ToolboxTool( - "Chance -" + CHANCE_STEP_PERCENTAGE_POINTS + "%: " + membershipName, - JigsawStudioToolPayload.membership( - JigsawStudioToolAction.ADJUST_VARIANT_CHANCE, - requestId, - workcell.stableId(), - variant.pieceKey(), - membership.poolKey(), - membership.entryIndex(), - -CHANCE_STEP_PERCENTAGE_POINTS))); - } - tools.add(new ToolboxTool( - "Unlink " + membershipName, - JigsawStudioToolPayload.membership( - JigsawStudioToolAction.UNLINK_MEMBERSHIP, - requestId, - workcell.stableId(), - variant.pieceKey(), - membership.poolKey(), - membership.entryIndex(), - 0))); - } - - private static void addToolBindingLore(UIElement element, JigsawStudioToolPayload payload) { - if (!payload.workcellId().isEmpty()) { - element.addLore(ChatColor.GRAY + "Workcell: " + safe(payload.workcellId())); - } - if (!payload.pieceKey().isEmpty()) { - element.addLore(ChatColor.GRAY + "Variant: " + safe(payload.pieceKey())); - } - if (!payload.poolKey().isEmpty()) { - element.addLore(ChatColor.GRAY + "Pool: " + safe(payload.poolKey()) - + (payload.entryIndex() < 0 ? "" : " [" + payload.entryIndex() + "]")); - } - if (payload.amount() != 0) { - element.addLore(ChatColor.GRAY + "Amount: " + payload.amount()); - } - } - - static int pageCount(int itemCount, int pageSize) { - if (itemCount < 0 || pageSize < 1) { - throw new IllegalArgumentException("Jigsaw Studio menu page bounds are invalid"); - } - return Math.max(1, (itemCount + pageSize - 1) / pageSize); - } - - static int clampPage(int requestedPage, int itemCount, int pageSize) { - int maximum = pageCount(itemCount, pageSize) - 1; - return Math.max(0, Math.min(requestedPage, maximum)); - } - - static List page(List items, int requestedPage, int pageSize) { - List values = List.copyOf(Objects.requireNonNull(items, "Jigsaw Studio menu page items")); - int page = clampPage(requestedPage, values.size(), pageSize); - int start = page * pageSize; - int end = Math.min(values.size(), start + pageSize); - return values.subList(start, end); - } - - private static UIElement evaluationElement(JigsawStudioMenuState.Evaluation evaluation) { - UIElement element = element( - "evaluation", - evaluationMaterial(evaluation.state()), - evaluationColor(evaluation.state()) + evaluationName(evaluation.state())); - element.addLore(ChatColor.GRAY + "Evaluation updates automatically."); - element.addLore(ChatColor.GRAY + "Seed: " + evaluation.seed()); - if (evaluation.generation() > 0L) { - element.addLore(ChatColor.GRAY + "Generation: " + evaluation.generation()); - } - if (!evaluation.selectedTheme().isEmpty()) { - element.addLore(ChatColor.GRAY + "Theme: " + safe(evaluation.selectedTheme())); - } - element.addLore(ChatColor.GRAY + "Pieces: " + evaluation.pieceCount()); - if (!evaluation.detail().isEmpty()) { - element.addLore(ChatColor.GRAY + safe(evaluation.detail())); - } - return element; - } - - static Material evaluationMaterial(JigsawStudioEvaluationState state) { - return switch (state) { - case PENDING -> Material.CLOCK; - case VALID -> Material.EMERALD; - case WARNING -> Material.YELLOW_DYE; - case INVALID -> Material.RED_DYE; - case STALE -> Material.GRAY_DYE; - }; - } - - private static ChatColor evaluationColor(JigsawStudioEvaluationState state) { - return switch (state) { - case PENDING -> ChatColor.AQUA; - case VALID -> ChatColor.GREEN; - case WARNING -> ChatColor.YELLOW; - case INVALID -> ChatColor.RED; - case STALE -> ChatColor.GRAY; - }; - } - - private static String evaluationName(JigsawStudioEvaluationState state) { - return switch (state) { - case PENDING -> "Evaluation Pending"; - case VALID -> "Ready to Assemble"; - case WARNING -> "Ready with Warnings"; - case INVALID -> "Assembly Blocked"; - case STALE -> "Evaluation Stale"; - }; - } - - private static Material workcellMaterial(JigsawStudioMenuState.Workcell workcell, boolean selected) { - if (!workcell.enabled()) { - return Material.GRAY_WOOL; - } - if (workcell.loading() || workcell.saving()) { - return Material.YELLOW_WOOL; - } - if (workcell.dirty()) { - return Material.ORANGE_WOOL; - } - return selected ? Material.LIME_WOOL : Material.LIGHT_GRAY_WOOL; - } - - static Material variantMaterial(JigsawStudioMenuState.Variant variant) { - if (variant.active()) { - return Material.JIGSAW; - } - return variant.owned() ? Material.PAPER : Material.GRAY_DYE; - } - - static String workcellStatus(JigsawStudioMenuState.Workcell workcell) { - if (workcell.loading()) { - return ChatColor.YELLOW + "Loading variant"; - } - if (workcell.saving()) { - return ChatColor.YELLOW + "Autosave in progress"; - } - if (workcell.dirty()) { - return ChatColor.GOLD + "Autosave pending"; - } - return ChatColor.GREEN + "Autosaved"; - } - - private static String dimensions(JigsawStudioCellDimensions dimensions) { - return dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth(); - } - - private static String themes(List themes) { - return themes.isEmpty() ? "None" : safe(String.join(", ", themes)); - } - - private static String maximumPlacements(int maximum) { - return maximum == 0 ? "Unlimited" : Integer.toString(maximum); - } - - private static String chance(double chance) { - return String.format(Locale.ROOT, "%.1f%%", chance * 100D); - } - - private static String yesNo(boolean value) { - return value ? "Yes" : "No"; - } - - private static String compatibilityName(JigsawStudioCompatibilityTarget target) { - return switch (target) { - case IRIS_EXTENDED -> "Iris Extended"; - case VANILLA_PORTABLE -> "Vanilla Portable"; - }; - } - - private static UIElement element(String id, Material material, String name) { - return new UIElement(id) - .setMaterial(new MaterialBlock(material)) - .setName(name); - } - - private static String title(String structureKey) { - String value = "Iris Jigsaw: " + safe(displayKey(structureKey)); - return value.length() > 32 ? value.substring(0, 32) : value; - } - - private static String displayKey(String resourceKey) { - int separator = resourceKey.lastIndexOf('/'); - return separator < 0 ? resourceKey : resourceKey.substring(separator + 1); - } - - private static String safe(String value) { - return BoardSVC.untrustedBoardValue(value); - } - - public interface Actions { - Optional menuState(Player player); - - boolean selectWorkcell(Player player, String workcellId); - - boolean teleportToWorkcell(Player player, String workcellId); - - boolean setConnectorBlocksVisible(Player player, String workcellId, boolean visible); - - boolean resetConnectorBlocks(Player player, String workcellId); - - boolean undoAutosave(Player player); - - boolean switchVariant(Player player, String workcellId, String pieceKey, boolean discardDirty); - - boolean createVariant(Player player, String workcellId, boolean duplicateActive); - - boolean setWorkcellEnabled(Player player, String workcellId, boolean enabled); - - boolean updateWorkcellDimensions( - Player player, - String workcellId, - JigsawStudioCellDimensions dimensions - ); - - boolean updateWorkcellDisplayName(Player player, String workcellId, String displayName); - - boolean setRequireCaps(Player player, boolean requireCaps); - - boolean duplicateActiveFamily(Player player, String themeKey); - - boolean updateThemeSetWeight(Player player, String themeKey, int weight); - - boolean flushAutosave(Player player, String workcellId); - - boolean goToPreview(Player player); - - boolean toggleVariantRotatable(Player player, String workcellId); - - boolean expandVariantToCell(Player player, String workcellId); - - boolean resizeVariant( - Player player, - String workcellId, - String pieceKey, - JigsawStudioCellDimensions dimensions - ); - - boolean updateVariantDisplayName( - Player player, - String workcellId, - String pieceKey, - String displayName - ); - - boolean updateVariantThemes( - Player player, - String workcellId, - String pieceKey, - List themes - ); - - boolean updateVariantRules( - Player player, - String workcellId, - String pieceKey, - JigsawStudioPieceRules rules - ); - - boolean adjustVariantWeight( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex, - int delta - ); - - boolean adjustVariantChance( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex, - int deltaPercentagePoints - ); - - boolean unlinkVariantMembership( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex - ); - - boolean deleteVariant(Player player, String workcellId, String pieceKey); - - boolean deleteProject(Player player); - - boolean giveTool(Player player, JigsawStudioToolPayload payload); - } - - enum RuleField { - MINIMUM_DEPTH("Minimum Depth", Material.LIGHT_BLUE_DYE, RULE_SHIFT_STEP) { - @Override - int value(JigsawStudioPieceRules rules) { - return rules.minimumDepth(); - } - }, - MAXIMUM_DEPTH("Maximum Depth", Material.BLUE_DYE, RULE_SHIFT_STEP) { - @Override - int value(JigsawStudioPieceRules rules) { - return rules.maximumDepth(); - } - }, - MINIMUM_PLACEMENTS("Minimum Placements", Material.TARGET, PLACEMENT_RULE_SHIFT_STEP) { - @Override - int value(JigsawStudioPieceRules rules) { - return rules.minimumPlacements(); - } - }, - MAXIMUM_PLACEMENTS("Maximum Placements", Material.GREEN_DYE, PLACEMENT_RULE_SHIFT_STEP) { - @Override - int value(JigsawStudioPieceRules rules) { - return rules.maximumPlacements(); - } - - @Override - String displayValue(int value) { - return maximumPlacements(value); - } - }; - - private final String displayName; - private final Material material; - private final int shiftStep; - - RuleField(String displayName, Material material, int shiftStep) { - this.displayName = displayName; - this.material = material; - this.shiftStep = shiftStep; - } - - String displayName() { - return displayName; - } - - Material material() { - return material; - } - - int shiftStep() { - return shiftStep; - } - - String displayValue(int value) { - return Integer.toString(value); - } - - abstract int value(JigsawStudioPieceRules rules); - } - - enum DimensionAxis { - WIDTH("Width") { - @Override - int value(JigsawStudioCellDimensions dimensions) { - return dimensions.width(); - } - }, - HEIGHT("Height") { - @Override - int value(JigsawStudioCellDimensions dimensions) { - return dimensions.height(); - } - }, - DEPTH("Depth") { - @Override - int value(JigsawStudioCellDimensions dimensions) { - return dimensions.depth(); - } - }; - - private final String displayName; - - DimensionAxis(String displayName) { - this.displayName = displayName; - } - - String displayName() { - return displayName; - } - - abstract int value(JigsawStudioCellDimensions dimensions); - } - - record ToolboxTool(String displayName, JigsawStudioToolPayload payload) { - ToolboxTool { - displayName = Objects.requireNonNull(displayName, "Jigsaw Studio toolbox display name").trim(); - if (displayName.isEmpty()) { - throw new IllegalArgumentException("Jigsaw Studio toolbox display name cannot be blank"); - } - payload = Objects.requireNonNull(payload, "Jigsaw Studio toolbox payload"); - } - } - private record PendingUnlink( UUID requestId, String workcellId, @@ -3383,16 +1139,4 @@ public final class JigsawStudioMenuController { private record PendingProjectDelete(UUID requestId, long expiresAtNanos) { } - private record PendingWorkcellResize( - UUID requestId, - String workcellId, - JigsawStudioCellDimensions dimensions, - boolean applying - ) { - private PendingWorkcellResize { - requestId = Objects.requireNonNull(requestId, "Jigsaw Studio resize request ID"); - workcellId = Objects.requireNonNull(workcellId, "Jigsaw Studio resize workcell ID"); - dimensions = Objects.requireNonNull(dimensions, "Jigsaw Studio resize dimensions"); - } - } } diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuFormat.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuFormat.java new file mode 100644 index 000000000..e44130646 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMenuFormat.java @@ -0,0 +1,477 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; +import art.arcane.volmlib.util.data.MaterialBlock; +import art.arcane.volmlib.util.inventorygui.UIElement; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.List; +import java.util.Locale; +import java.util.Objects; +import java.util.Optional; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.PLACEMENT_RULE_SHIFT_STEP; +import static art.arcane.iris.core.service.JigsawStudioMenuController.RULE_SHIFT_STEP; + +final class JigsawStudioMenuFormat { + private JigsawStudioMenuFormat() { + } + + static boolean hasMembership( + JigsawStudioMenuState state, + String workcellId, + JigsawStudioMenuState.Membership expected + ) { + JigsawStudioMenuState.Variant active = activeVariant(state, workcellId); + if (active == null) { + return false; + } + for (JigsawStudioMenuState.Membership membership : active.memberships()) { + if (membership.poolKey().equals(expected.poolKey()) + && membership.entryIndex() == expected.entryIndex()) { + return true; + } + } + return false; + } + + static JigsawStudioMenuState.Variant activeVariant( + JigsawStudioMenuState state, + String workcellId + ) { + JigsawStudioMenuState.Workcell workcell = state.workcell(workcellId); + return workcell == null ? null : workcell.activeVariant(); + } + + static JigsawStudioMenuState.Variant variant( + JigsawStudioMenuState.Workcell workcell, + String pieceKey + ) { + if (workcell == null || pieceKey == null) { + return null; + } + for (JigsawStudioMenuState.Variant variant : workcell.variants()) { + if (variant.pieceKey().equals(pieceKey)) { + return variant; + } + } + return null; + } + + static String nextThemeSetKey(List themeSets) { + List values = List.copyOf(Objects.requireNonNull( + themeSets, + "Jigsaw Studio theme sets")); + int candidate = 1; + while (candidate > 0) { + String key = "variant-" + candidate; + boolean present = false; + for (JigsawStudioMenuState.ThemeSet themeSet : values) { + if (Objects.requireNonNull(themeSet, "Jigsaw Studio theme set").key().equals(key)) { + present = true; + break; + } + } + if (!present) { + return key; + } + candidate = Math.incrementExact(candidate); + } + throw new IllegalStateException("Jigsaw Studio cannot allocate another numbered theme set"); + } + + static String themeSelectionPercent( + List themeSets, + JigsawStudioMenuState.ThemeSet target + ) { + List activeThemeSets = Objects.requireNonNull( + themeSets, + "Jigsaw Studio theme sets"); + JigsawStudioMenuState.ThemeSet activeTarget = Objects.requireNonNull( + target, + "Jigsaw Studio target theme set"); + int totalWeight = 0; + for (JigsawStudioMenuState.ThemeSet themeSet : activeThemeSets) { + totalWeight = Math.addExact(totalWeight, Objects.requireNonNull( + themeSet, + "Jigsaw Studio theme set").weight()); + } + if (totalWeight < 1) { + return "0.0%"; + } + return String.format( + Locale.ROOT, + "%.1f%%", + activeTarget.weight() * 100.0D / totalWeight); + } + + static Optional adjustedPositiveValue(int value, int delta) { + if (value < 1 || delta == 0) { + throw new IllegalArgumentException("Jigsaw Studio positive value adjustment is invalid"); + } + try { + int adjusted = Math.addExact(value, delta); + return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); + } catch (ArithmeticException exception) { + return Optional.empty(); + } + } + + static Optional adjustedRules( + JigsawStudioPieceRules rules, + RuleField field, + int delta + ) { + JigsawStudioPieceRules current = Objects.requireNonNull(rules, "Jigsaw Studio piece rules"); + RuleField target = Objects.requireNonNull(field, "Jigsaw Studio piece rule field"); + if (delta == 0) { + throw new IllegalArgumentException("Jigsaw Studio piece rule delta cannot be zero"); + } + try { + int minimumDepth = current.minimumDepth(); + int maximumDepth = current.maximumDepth(); + int minimumPlacements = current.minimumPlacements(); + int maximumPlacements = current.maximumPlacements(); + switch (target) { + case MINIMUM_DEPTH -> minimumDepth = Math.addExact(minimumDepth, delta); + case MAXIMUM_DEPTH -> maximumDepth = Math.addExact(maximumDepth, delta); + case MINIMUM_PLACEMENTS -> minimumPlacements = Math.addExact(minimumPlacements, delta); + case MAXIMUM_PLACEMENTS -> { + Optional adjustedMaximum = adjustedMaximumPlacements(maximumPlacements, delta); + if (adjustedMaximum.isEmpty()) { + return Optional.empty(); + } + maximumPlacements = adjustedMaximum.get(); + } + } + return Optional.of(new JigsawStudioPieceRules( + minimumDepth, + maximumDepth, + minimumPlacements, + maximumPlacements, + current.terminal())); + } catch (ArithmeticException | IllegalArgumentException exception) { + return Optional.empty(); + } + } + + static JigsawStudioPieceRules withTerminal(JigsawStudioPieceRules rules, boolean terminal) { + JigsawStudioPieceRules current = Objects.requireNonNull(rules, "Jigsaw Studio piece rules"); + return new JigsawStudioPieceRules( + current.minimumDepth(), + current.maximumDepth(), + current.minimumPlacements(), + current.maximumPlacements(), + terminal); + } + + private static Optional adjustedMaximumPlacements(int value, int delta) { + if (value == 0) { + if (delta > 0) { + return Optional.empty(); + } + int adjusted = Math.addExact(513, delta); + return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); + } + int adjusted = Math.addExact(value, delta); + if (adjusted > 512) { + return Optional.of(0); + } + return adjusted < 1 ? Optional.empty() : Optional.of(adjusted); + } + + static Optional adjustedDimensions( + JigsawStudioCellDimensions dimensions, + DimensionAxis axis, + int delta + ) { + JigsawStudioCellDimensions current = Objects.requireNonNull( + dimensions, + "Jigsaw Studio workcell dimensions"); + DimensionAxis target = Objects.requireNonNull(axis, "Jigsaw Studio workcell dimension axis"); + if (delta == 0) { + throw new IllegalArgumentException("Jigsaw Studio workcell dimension delta cannot be zero"); + } + try { + int width = target == DimensionAxis.WIDTH + ? Math.addExact(current.width(), delta) + : current.width(); + int height = target == DimensionAxis.HEIGHT + ? Math.addExact(current.height(), delta) + : current.height(); + int depth = target == DimensionAxis.DEPTH + ? Math.addExact(current.depth(), delta) + : current.depth(); + return Optional.of(new JigsawStudioCellDimensions(width, height, depth)); + } catch (ArithmeticException | IllegalArgumentException exception) { + return Optional.empty(); + } + } + + static JigsawStudioMenuState.Workcell withCapacity( + JigsawStudioMenuState.Workcell workcell, + JigsawStudioCellDimensions capacity + ) { + JigsawStudioMenuState.Workcell source = Objects.requireNonNull( + workcell, + "Jigsaw Studio menu workcell"); + return new JigsawStudioMenuState.Workcell( + source.stableId(), + source.canonicalName(), + source.displayName(), + Objects.requireNonNull(capacity, "Jigsaw Studio staged workcell capacity"), + source.enabled(), + source.activeVariantKey(), + source.dirty(), + source.saving(), + source.loading(), + source.connectorsVisible(), + source.variants()); + } + + static int pageCount(int itemCount, int pageSize) { + if (itemCount < 0 || pageSize < 1) { + throw new IllegalArgumentException("Jigsaw Studio menu page bounds are invalid"); + } + return Math.max(1, (itemCount + pageSize - 1) / pageSize); + } + + static int clampPage(int requestedPage, int itemCount, int pageSize) { + int maximum = pageCount(itemCount, pageSize) - 1; + return Math.max(0, Math.min(requestedPage, maximum)); + } + + static List page(List items, int requestedPage, int pageSize) { + List values = List.copyOf(Objects.requireNonNull(items, "Jigsaw Studio menu page items")); + int page = clampPage(requestedPage, values.size(), pageSize); + int start = page * pageSize; + int end = Math.min(values.size(), start + pageSize); + return values.subList(start, end); + } + + static UIElement evaluationElement(JigsawStudioMenuState.Evaluation evaluation) { + UIElement element = element( + "evaluation", + evaluationMaterial(evaluation.state()), + evaluationColor(evaluation.state()) + evaluationName(evaluation.state())); + element.addLore(ChatColor.GRAY + "Evaluation updates automatically."); + element.addLore(ChatColor.GRAY + "Seed: " + evaluation.seed()); + if (evaluation.generation() > 0L) { + element.addLore(ChatColor.GRAY + "Generation: " + evaluation.generation()); + } + if (!evaluation.selectedTheme().isEmpty()) { + element.addLore(ChatColor.GRAY + "Theme: " + safe(evaluation.selectedTheme())); + } + element.addLore(ChatColor.GRAY + "Pieces: " + evaluation.pieceCount()); + if (!evaluation.detail().isEmpty()) { + element.addLore(ChatColor.GRAY + safe(evaluation.detail())); + } + return element; + } + + static Material evaluationMaterial(JigsawStudioEvaluationState state) { + return switch (state) { + case PENDING -> Material.CLOCK; + case VALID -> Material.EMERALD; + case WARNING -> Material.YELLOW_DYE; + case INVALID -> Material.RED_DYE; + case STALE -> Material.GRAY_DYE; + }; + } + + private static ChatColor evaluationColor(JigsawStudioEvaluationState state) { + return switch (state) { + case PENDING -> ChatColor.AQUA; + case VALID -> ChatColor.GREEN; + case WARNING -> ChatColor.YELLOW; + case INVALID -> ChatColor.RED; + case STALE -> ChatColor.GRAY; + }; + } + + private static String evaluationName(JigsawStudioEvaluationState state) { + return switch (state) { + case PENDING -> "Evaluation Pending"; + case VALID -> "Ready to Assemble"; + case WARNING -> "Ready with Warnings"; + case INVALID -> "Assembly Blocked"; + case STALE -> "Evaluation Stale"; + }; + } + + static Material workcellMaterial(JigsawStudioMenuState.Workcell workcell, boolean selected) { + if (!workcell.enabled()) { + return Material.GRAY_WOOL; + } + if (workcell.loading() || workcell.saving()) { + return Material.YELLOW_WOOL; + } + if (workcell.dirty()) { + return Material.ORANGE_WOOL; + } + return selected ? Material.LIME_WOOL : Material.LIGHT_GRAY_WOOL; + } + + static Material variantMaterial(JigsawStudioMenuState.Variant variant) { + if (variant.active()) { + return Material.JIGSAW; + } + return variant.owned() ? Material.PAPER : Material.GRAY_DYE; + } + + static String workcellStatus(JigsawStudioMenuState.Workcell workcell) { + if (workcell.loading()) { + return ChatColor.YELLOW + "Loading variant"; + } + if (workcell.saving()) { + return ChatColor.YELLOW + "Autosave in progress"; + } + if (workcell.dirty()) { + return ChatColor.GOLD + "Autosave pending"; + } + return ChatColor.GREEN + "Autosaved"; + } + + static String dimensions(JigsawStudioCellDimensions dimensions) { + return dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth(); + } + + static String themes(List themes) { + return themes.isEmpty() ? "None" : safe(String.join(", ", themes)); + } + + static String maximumPlacements(int maximum) { + return maximum == 0 ? "Unlimited" : Integer.toString(maximum); + } + + static String chance(double chance) { + return String.format(Locale.ROOT, "%.1f%%", chance * 100D); + } + + static String yesNo(boolean value) { + return value ? "Yes" : "No"; + } + + static String compatibilityName(JigsawStudioCompatibilityTarget target) { + return switch (target) { + case IRIS_EXTENDED -> "Iris Extended"; + case VANILLA_PORTABLE -> "Vanilla Portable"; + }; + } + + static UIElement element(String id, Material material, String name) { + return new UIElement(id) + .setMaterial(new MaterialBlock(material)) + .setName(name); + } + + static String title(String structureKey) { + String value = "Iris Jigsaw: " + safe(displayKey(structureKey)); + return value.length() > 32 ? value.substring(0, 32) : value; + } + + static String displayKey(String resourceKey) { + int separator = resourceKey.lastIndexOf('/'); + return separator < 0 ? resourceKey : resourceKey.substring(separator + 1); + } + + static String safe(String value) { + return BoardSVC.untrustedBoardValue(value); + } + + enum RuleField { + MINIMUM_DEPTH("Minimum Depth", Material.LIGHT_BLUE_DYE, RULE_SHIFT_STEP) { + @Override + int value(JigsawStudioPieceRules rules) { + return rules.minimumDepth(); + } + }, + MAXIMUM_DEPTH("Maximum Depth", Material.BLUE_DYE, RULE_SHIFT_STEP) { + @Override + int value(JigsawStudioPieceRules rules) { + return rules.maximumDepth(); + } + }, + MINIMUM_PLACEMENTS("Minimum Placements", Material.TARGET, PLACEMENT_RULE_SHIFT_STEP) { + @Override + int value(JigsawStudioPieceRules rules) { + return rules.minimumPlacements(); + } + }, + MAXIMUM_PLACEMENTS("Maximum Placements", Material.GREEN_DYE, PLACEMENT_RULE_SHIFT_STEP) { + @Override + int value(JigsawStudioPieceRules rules) { + return rules.maximumPlacements(); + } + + @Override + String displayValue(int value) { + return maximumPlacements(value); + } + }; + + private final String displayName; + private final Material material; + private final int shiftStep; + + RuleField(String displayName, Material material, int shiftStep) { + this.displayName = displayName; + this.material = material; + this.shiftStep = shiftStep; + } + + String displayName() { + return displayName; + } + + Material material() { + return material; + } + + int shiftStep() { + return shiftStep; + } + + String displayValue(int value) { + return Integer.toString(value); + } + + abstract int value(JigsawStudioPieceRules rules); + } + + enum DimensionAxis { + WIDTH("Width") { + @Override + int value(JigsawStudioCellDimensions dimensions) { + return dimensions.width(); + } + }, + HEIGHT("Height") { + @Override + int value(JigsawStudioCellDimensions dimensions) { + return dimensions.height(); + } + }, + DEPTH("Depth") { + @Override + int value(JigsawStudioCellDimensions dimensions) { + return dimensions.depth(); + } + }; + + private final String displayName; + + DimensionAxis(String displayName) { + this.displayName = displayName; + } + + String displayName() { + return displayName; + } + + abstract int value(JigsawStudioCellDimensions dimensions); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java index f40fe1426..765459e03 100644 --- a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java @@ -156,7 +156,7 @@ import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicLong; import java.util.concurrent.atomic.AtomicReference; -public final class JigsawStudioService implements IrisService, JigsawStudioMenuController.Actions { +public final class JigsawStudioService implements IrisService, JigsawStudioMenuActions { private static final int AUTOSAVE_DEBOUNCE_TICKS = 40; private static final int AUTOSAVE_RETRY_TICKS = 5; private static final int REPLACEMENT_CLOSE_WAIT_TICKS = 2_400; @@ -3185,14 +3185,14 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuC } return duplicateActiveFamily( player, - JigsawStudioMenuController.nextThemeSetKey(state.get().themeSets())); + JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); } private boolean duplicateFamilyFromTool(Player player) { Optional state = menuState(player); return state.isPresent() && duplicateActiveFamily( player, - JigsawStudioMenuController.nextThemeSetKey(state.get().themeSets())); + JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); } private boolean toggleRequireCapsFromTool(Player player) { diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioStructureMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioStructureMenu.java new file mode 100644 index 000000000..f0a5db8d8 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioStructureMenu.java @@ -0,0 +1,194 @@ +package art.arcane.iris.core.service; + +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.List; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.GRID_POSITIONS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.THEME_SETS_PER_PAGE; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.clampPage; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.compatibilityName; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.nextThemeSetKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.page; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.pageCount; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.themeSelectionPercent; + +final class JigsawStudioStructureMenu { + private final JigsawStudioMenuController controller; + + JigsawStudioStructureMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + String selectedWorkcellId, + int requestedPage + ) { + int page = clampPage(requestedPage, state.themeSets().size(), THEME_SETS_PER_PAGE); + controller.purgeExpiredConfirmations(window.getViewer().getUniqueId()); + window.batch(() -> { + window.clearElements(); + + UIElement back = element("structure-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); + back.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), selectedWorkcellId, 0)); + window.setElement(-4, 0, back); + + UIElement identity = element( + "structure-identity", + Material.JIGSAW, + ChatColor.LIGHT_PURPLE + "Structure Themes & Caps"); + identity.addLore(ChatColor.DARK_GRAY + safe(state.structureKey())); + identity.addLore(ChatColor.GRAY + "Compatibility: " + compatibilityName(state.compatibilityTarget())); + identity.addLore(ChatColor.GRAY + "Theme sets select one coherent variant family per assembly."); + identity.addLore(ChatColor.GRAY + "Empty piece themes remain available to every family."); + window.setElement(0, 0, identity); + window.setElement(4, 0, evaluationElement(state.evaluation())); + + UIElement requireCaps = element( + "require-caps", + state.irisExtended() + ? state.requireCaps() ? Material.IRON_BARS : Material.TRIPWIRE_HOOK + : Material.BARRIER, + !state.irisExtended() + ? ChatColor.GRAY + "Mandatory Caps Require Iris Compatibility" + : state.requireCaps() + ? ChatColor.GREEN + "Mandatory Caps Enabled" + : ChatColor.YELLOW + "Mandatory Caps Disabled"); + requireCaps.addLore(!state.irisExtended() + ? ChatColor.GRAY + "Vanilla-portable export rejects Iris mandatory-cap metadata." + : state.requireCaps() + ? ChatColor.GRAY + "Every open connector must close with a terminal piece." + : ChatColor.GRAY + "Assembly may leave an open connector when no cap can fit."); + if (state.irisExtended()) { + requireCaps.addLore(ChatColor.YELLOW + "Left-click to toggle"); + requireCaps.onLeftClick(clicked -> controller.setRequireCaps( + window.getViewer(), state.requestId(), !state.requireCaps())); + } + window.setElement(-3, 1, requireCaps); + + String nextThemeKey = nextThemeSetKey(state.themeSets()); + boolean themeEditingAvailable = state.irisExtended(); + UIElement createTheme = element( + "new-theme-set", + themeEditingAvailable ? Material.NETHER_STAR : Material.BARRIER, + themeEditingAvailable + ? ChatColor.GREEN + "Duplicate All Enabled Cells as Family: " + safe(nextThemeKey) + : ChatColor.GRAY + "Theme Sets Require Iris Compatibility"); + if (themeEditingAvailable) { + createTheme.addLore(ChatColor.GRAY + "Creates one new owned variant for every enabled workcell."); + createTheme.addLore(ChatColor.GRAY + "All created variants join " + safe(nextThemeKey) + "."); + createTheme.addLore(ChatColor.GRAY + "One family is selected for the complete assembly."); + createTheme.addLore(ChatColor.YELLOW + "Left-click to create the complete set"); + createTheme.onLeftClick(clicked -> controller.duplicateActiveFamily( + window.getViewer(), state.requestId(), nextThemeKey)); + } else { + createTheme.addLore(ChatColor.GRAY + "Vanilla jigsaw resources cannot encode Iris theme metadata."); + } + window.setElement(0, 1, createTheme); + + boolean deleteConfirmed = controller.isProjectDeleteConfirmed( + window.getViewer().getUniqueId(), state.requestId()); + UIElement deleteProject = element( + "delete-project", + deleteConfirmed ? Material.REDSTONE : Material.LAVA_BUCKET, + deleteConfirmed + ? ChatColor.RED + "Confirm Delete Jigsaw" + : ChatColor.RED + "Delete Jigsaw") + .setEnchanted(deleteConfirmed); + deleteProject.addLore(deleteConfirmed + ? ChatColor.RED + "Click again to delete this entire managed project." + : ChatColor.RED + "Click twice within 10 seconds to confirm."); + deleteProject.onLeftClick(clicked -> controller.confirmOrDeleteProject( + window.getViewer(), state.requestId(), selectedWorkcellId, page)); + window.setElement(3, 1, deleteProject); + + addThemeSets(window, state, page); + + UIElement footerBack = element("structure-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + footerBack.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), selectedWorkcellId, 0)); + window.setElement(-4, 5, footerBack); + + int pageCount = pageCount(state.themeSets().size(), THEME_SETS_PER_PAGE); + if (page > 0) { + UIElement previous = element( + "theme-previous", + Material.ARROW, + ChatColor.YELLOW + "Previous Page"); + previous.onLeftClick(clicked -> controller.refreshStructureSettings( + window.getViewer(), state.requestId(), selectedWorkcellId, page - 1)); + window.setElement(-1, 5, previous); + } + UIElement indicator = element( + "theme-page", + Material.BOOK, + ChatColor.WHITE + "Page " + (page + 1) + "/" + pageCount); + indicator.addLore(ChatColor.GRAY + "" + state.themeSets().size() + " theme sets"); + window.setElement(0, 5, indicator); + if (page + 1 < pageCount) { + UIElement next = element("theme-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); + next.onLeftClick(clicked -> controller.refreshStructureSettings( + window.getViewer(), state.requestId(), selectedWorkcellId, page + 1)); + window.setElement(1, 5, next); + } + window.setElement(4, 5, evaluationElement(state.evaluation())); + }); + } + + private void addThemeSets( + UIWindow window, + JigsawStudioMenuState state, + int page + ) { + List themeSets = page( + state.themeSets(), page, THEME_SETS_PER_PAGE); + if (themeSets.isEmpty()) { + UIElement empty = element( + "no-theme-sets", + Material.GRAY_DYE, + ChatColor.GRAY + "Implicit Unthemed Assembly"); + empty.addLore(ChatColor.GRAY + "Create variant-1 to begin coherent theme selection."); + window.setElement(0, 3, empty); + return; + } + for (int index = 0; index < themeSets.size(); index++) { + JigsawStudioMenuState.ThemeSet themeSet = themeSets.get(index); + int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; + int row = 2 + index / GRID_POSITIONS.length; + UIElement element = element( + "theme-set-" + index, + state.irisExtended() ? Material.PURPLE_DYE : Material.GRAY_DYE, + (state.irisExtended() ? ChatColor.LIGHT_PURPLE : ChatColor.GRAY) + safe(themeSet.key())); + element.addLore(ChatColor.WHITE + "Selection weight: " + themeSet.weight()); + element.addLore(ChatColor.WHITE + "Whole-assembly chance: " + + themeSelectionPercent(state.themeSets(), themeSet)); + if (state.irisExtended()) { + element.addLore(ChatColor.GREEN + "Left-click: weight +1"); + element.addLore(ChatColor.YELLOW + "Right-click: weight -1"); + element.addLore(ChatColor.GREEN + "Shift-left: weight +8"); + element.addLore(ChatColor.YELLOW + "Shift-right: weight -8"); + element.onLeftClick(clicked -> controller.adjustThemeSetWeight( + window.getViewer(), state.requestId(), themeSet, 1)); + element.onRightClick(clicked -> controller.adjustThemeSetWeight( + window.getViewer(), state.requestId(), themeSet, -1)); + element.onShiftLeftClick(clicked -> controller.adjustThemeSetWeight( + window.getViewer(), state.requestId(), themeSet, 8)); + element.onShiftRightClick(clicked -> controller.adjustThemeSetWeight( + window.getViewer(), state.requestId(), themeSet, -8)); + } else { + element.addLore(ChatColor.GRAY + "Theme metadata is unavailable for vanilla-portable graphs."); + } + window.setElement(position, row, element); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolboxMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolboxMenu.java new file mode 100644 index 000000000..0f4b3d998 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolboxMenu.java @@ -0,0 +1,370 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.UUID; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.CHANCE_STEP_PERCENTAGE_POINTS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.GRID_POSITIONS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.TOOLS_PER_PAGE; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.clampPage; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.displayKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.nextThemeSetKey; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.page; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.pageCount; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; + +final class JigsawStudioToolboxMenu { + private final JigsawStudioMenuController controller; + + JigsawStudioToolboxMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + int requestedPage + ) { + List allTools = toolboxTools(state, workcell); + int page = clampPage(requestedPage, allTools.size(), TOOLS_PER_PAGE); + List tools = page(allTools, page, TOOLS_PER_PAGE); + window.batch(() -> { + window.clearElements(); + + UIElement back = element("toolbox-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); + back.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(-4, 0, back); + + UIElement heading = element("toolbox-heading", Material.CHEST, ChatColor.AQUA + "Bound Tool Sticks"); + heading.addLore(ChatColor.GRAY + "Every stick is bound to request " + state.requestId()); + heading.addLore(ChatColor.GRAY + "Stale sticks stop working when this Studio closes."); + window.setElement(0, 0, heading); + window.setElement(4, 0, evaluationElement(state.evaluation())); + + for (int index = 0; index < tools.size(); index++) { + ToolboxTool tool = tools.get(index); + int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; + int row = 1 + index / GRID_POSITIONS.length; + UIElement element = element( + "tool-" + index, + Material.STICK, + ChatColor.AQUA + safe(tool.displayName())); + element.addLore(ChatColor.GRAY + "Action: " + tool.payload().action().displayName()); + addToolBindingLore(element, tool.payload()); + element.addLore(tool.payload().action().destructive() + ? ChatColor.RED + "Bound tools require confirmation when used." + : ChatColor.YELLOW + "Left-click to receive this named stick."); + element.onLeftClick(clicked -> controller.giveTool( + window.getViewer(), state.requestId(), tool.payload())); + window.setElement(position, row, element); + } + + UIElement footerBack = element("toolbox-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + footerBack.onLeftClick(clicked -> controller.refreshMain( + window.getViewer(), state.requestId(), workcell.stableId(), 0)); + window.setElement(-4, 5, footerBack); + + int pageCount = pageCount(allTools.size(), TOOLS_PER_PAGE); + if (page > 0) { + UIElement previous = element("toolbox-previous", Material.ARROW, ChatColor.YELLOW + "Previous Page"); + previous.onLeftClick(clicked -> controller.refreshToolbox( + window.getViewer(), state.requestId(), workcell.stableId(), page - 1)); + window.setElement(-1, 5, previous); + } + UIElement indicator = element("toolbox-page", Material.BOOK, ChatColor.WHITE + "Page " + + (page + 1) + "/" + pageCount); + indicator.addLore(ChatColor.GRAY + "" + allTools.size() + " bound tools"); + window.setElement(0, 5, indicator); + if (page + 1 < pageCount) { + UIElement next = element("toolbox-next", Material.ARROW, ChatColor.YELLOW + "Next Page"); + next.onLeftClick(clicked -> controller.refreshToolbox( + window.getViewer(), state.requestId(), workcell.stableId(), page + 1)); + window.setElement(1, 5, next); + } + }); + } + + static List toolboxTools( + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell + ) { + JigsawStudioMenuState menu = Objects.requireNonNull(state, "Jigsaw Studio toolbox state"); + JigsawStudioMenuState.Workcell selected = Objects.requireNonNull( + workcell, + "Jigsaw Studio toolbox workcell"); + UUID requestId = menu.requestId(); + List tools = new ArrayList<>(); + tools.add(new ToolboxTool( + "Open Control Menu", + JigsawStudioToolPayload.request(JigsawStudioToolAction.OPEN_MENU, requestId))); + tools.add(new ToolboxTool( + "Select " + selected.displayName(), + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.SELECT_WORKCELL, + requestId, + selected.stableId()))); + if (menu.mode() == JigsawStudioMode.PLANAR_JIGSAW) { + tools.add(new ToolboxTool( + "Toggle " + selected.displayName(), + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.TOGGLE_WORKCELL, + requestId, + selected.stableId()))); + } + tools.add(new ToolboxTool( + "Resize " + selected.displayName() + " Capacity", + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.RESIZE_WORKCELL, + requestId, + selected.stableId()))); + tools.add(new ToolboxTool( + "Rename " + selected.displayName(), + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.RENAME_WORKCELL, + requestId, + selected.stableId()))); + tools.add(new ToolboxTool( + "New Blank " + selected.displayName() + " Variant", + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.CREATE_VARIANT, + requestId, + selected.stableId()))); + tools.add(new ToolboxTool( + "Go to Preview", + JigsawStudioToolPayload.request(JigsawStudioToolAction.PREVIEW_GRAPH, requestId))); + tools.add(new ToolboxTool( + "Flush " + selected.displayName() + " Autosave", + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.FLUSH_AUTOSAVE, + requestId, + selected.stableId()))); + if (menu.irisExtended()) { + tools.add(new ToolboxTool( + "Duplicate All Enabled Cells as Family: " + nextThemeSetKey(menu.themeSets()), + JigsawStudioToolPayload.request(JigsawStudioToolAction.DUPLICATE_FAMILY, requestId))); + } + + JigsawStudioMenuState.Variant active = selected.activeVariant(); + if (active != null) { + if (active.owned()) { + tools.add(new ToolboxTool( + "Duplicate This Cell's Variant: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.DUPLICATE_VARIANT, + requestId, + selected.stableId(), + active.pieceKey()))); + } + if (active.owned()) { + tools.add(new ToolboxTool( + "Rename This Variant: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.RENAME_VARIANT, + requestId, + selected.stableId(), + active.pieceKey()))); + tools.add(new ToolboxTool( + "Resize This Variant: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.RESIZE_VARIANT, + requestId, + selected.stableId(), + active.pieceKey()))); + } + if (active.rotationEditable()) { + tools.add(new ToolboxTool( + "Toggle Rotation: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.TOGGLE_ROTATION, + requestId, + selected.stableId(), + active.pieceKey()))); + } + if (active.owned() && active.resizableToCapacity()) { + tools.add(new ToolboxTool( + "Resize " + active.displayName() + " to Capacity", + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.EXPAND_TO_CELL, + requestId, + selected.stableId(), + active.pieceKey()))); + } + if (active.owned() && menu.irisExtended()) { + tools.add(new ToolboxTool( + "Open Theme Memberships: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.SET_THEME, + requestId, + selected.stableId(), + active.pieceKey()))); + tools.add(new ToolboxTool( + "Open Piece Rules: " + active.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.SET_PIECE_RULES, + requestId, + selected.stableId(), + active.pieceKey()))); + } + if (active.owned()) { + for (JigsawStudioMenuState.Membership membership : active.memberships()) { + addMembershipTools( + tools, + requestId, + selected, + active, + membership, + menu.irisExtended()); + } + } + } + for (JigsawStudioMenuState.Variant variant : selected.variants()) { + if (variant.active()) { + continue; + } + tools.add(new ToolboxTool( + "Load " + variant.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.LOAD_VARIANT, + requestId, + selected.stableId(), + variant.pieceKey()))); + if (variant.owned()) { + tools.add(new ToolboxTool( + "Rename " + variant.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.RENAME_VARIANT, + requestId, + selected.stableId(), + variant.pieceKey()))); + tools.add(new ToolboxTool( + "Resize " + variant.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.RESIZE_VARIANT, + requestId, + selected.stableId(), + variant.pieceKey()))); + } + if (variant.owned() && selected.variants().size() > 1) { + tools.add(new ToolboxTool( + "Delete " + variant.displayName(), + JigsawStudioToolPayload.variant( + JigsawStudioToolAction.DELETE_VARIANT, + requestId, + selected.stableId(), + variant.pieceKey()))); + } + } + if (menu.irisExtended()) { + tools.add(new ToolboxTool( + menu.requireCaps() ? "Disable Mandatory Caps" : "Enable Mandatory Caps", + JigsawStudioToolPayload.request(JigsawStudioToolAction.TOGGLE_REQUIRE_CAPS, requestId))); + } + tools.add(new ToolboxTool( + "Delete Project", + JigsawStudioToolPayload.request(JigsawStudioToolAction.DELETE_PROJECT, requestId))); + return List.copyOf(tools); + } + + private static void addMembershipTools( + List tools, + UUID requestId, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + JigsawStudioMenuState.Membership membership, + boolean chanceEditable + ) { + String membershipName = displayKey(membership.poolKey()) + " [" + membership.entryIndex() + "]"; + tools.add(new ToolboxTool( + "Weight +1: " + membershipName, + JigsawStudioToolPayload.membership( + JigsawStudioToolAction.ADJUST_VARIANT_WEIGHT, + requestId, + workcell.stableId(), + variant.pieceKey(), + membership.poolKey(), + membership.entryIndex(), + 1))); + tools.add(new ToolboxTool( + "Weight -1: " + membershipName, + JigsawStudioToolPayload.membership( + JigsawStudioToolAction.ADJUST_VARIANT_WEIGHT, + requestId, + workcell.stableId(), + variant.pieceKey(), + membership.poolKey(), + membership.entryIndex(), + -1))); + if (chanceEditable) { + tools.add(new ToolboxTool( + "Chance +" + CHANCE_STEP_PERCENTAGE_POINTS + "%: " + membershipName, + JigsawStudioToolPayload.membership( + JigsawStudioToolAction.ADJUST_VARIANT_CHANCE, + requestId, + workcell.stableId(), + variant.pieceKey(), + membership.poolKey(), + membership.entryIndex(), + CHANCE_STEP_PERCENTAGE_POINTS))); + tools.add(new ToolboxTool( + "Chance -" + CHANCE_STEP_PERCENTAGE_POINTS + "%: " + membershipName, + JigsawStudioToolPayload.membership( + JigsawStudioToolAction.ADJUST_VARIANT_CHANCE, + requestId, + workcell.stableId(), + variant.pieceKey(), + membership.poolKey(), + membership.entryIndex(), + -CHANCE_STEP_PERCENTAGE_POINTS))); + } + tools.add(new ToolboxTool( + "Unlink " + membershipName, + JigsawStudioToolPayload.membership( + JigsawStudioToolAction.UNLINK_MEMBERSHIP, + requestId, + workcell.stableId(), + variant.pieceKey(), + membership.poolKey(), + membership.entryIndex(), + 0))); + } + + private static void addToolBindingLore(UIElement element, JigsawStudioToolPayload payload) { + if (!payload.workcellId().isEmpty()) { + element.addLore(ChatColor.GRAY + "Workcell: " + safe(payload.workcellId())); + } + if (!payload.pieceKey().isEmpty()) { + element.addLore(ChatColor.GRAY + "Variant: " + safe(payload.pieceKey())); + } + if (!payload.poolKey().isEmpty()) { + element.addLore(ChatColor.GRAY + "Pool: " + safe(payload.poolKey()) + + (payload.entryIndex() < 0 ? "" : " [" + payload.entryIndex() + "]")); + } + if (payload.amount() != 0) { + element.addLore(ChatColor.GRAY + "Amount: " + payload.amount()); + } + } + + record ToolboxTool(String displayName, JigsawStudioToolPayload payload) { + ToolboxTool { + displayName = Objects.requireNonNull(displayName, "Jigsaw Studio toolbox display name").trim(); + if (displayName.isEmpty()) { + throw new IllegalArgumentException("Jigsaw Studio toolbox display name cannot be blank"); + } + payload = Objects.requireNonNull(payload, "Jigsaw Studio toolbox payload"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantMenu.java new file mode 100644 index 000000000..7a0581fb2 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantMenu.java @@ -0,0 +1,213 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.service.JigsawStudioMenuFormat.RuleField; +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; + +import java.util.List; +import java.util.Locale; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.GRID_POSITIONS; +import static art.arcane.iris.core.service.JigsawStudioMenuController.THEME_SETS_PER_PAGE; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.clampPage; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.page; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.pageCount; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.themes; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.withTerminal; + +final class JigsawStudioVariantMenu { + private final JigsawStudioMenuController controller; + + JigsawStudioVariantMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int requestedPage + ) { + int page = clampPage(requestedPage, state.themeSets().size(), THEME_SETS_PER_PAGE); + window.batch(() -> { + window.clearElements(); + + UIElement back = element("variant-settings-back", Material.ARROW, ChatColor.YELLOW + "Back to Details"); + back.onLeftClick(clicked -> controller.openDetails( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); + window.setElement(-4, 0, back); + + UIElement identity = element( + "variant-settings-identity", + Material.COMPARATOR, + ChatColor.GOLD + safe(variant.displayName()) + " Rules"); + identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); + identity.addLore(ChatColor.GRAY + "Theme memberships: " + themes(variant.themes())); + identity.addLore(ChatColor.GRAY + "Use Duplicate All Enabled Cells as Family for coherent sets."); + window.setElement(0, 0, identity); + window.setElement(4, 0, evaluationElement(state.evaluation())); + + if (!variant.active() || !variant.owned() || !state.irisExtended()) { + UIElement unavailable = element( + "variant-settings-unavailable", + Material.BARRIER, + state.irisExtended() + ? ChatColor.RED + "Load an Owned Variant First" + : ChatColor.GRAY + "Iris Metadata Unavailable"); + unavailable.addLore(state.irisExtended() + ? ChatColor.GRAY + "Rules and themes can only change for the loaded owned variant." + : ChatColor.GRAY + "Vanilla-portable pieces use vanilla placement behavior."); + window.setElement(0, 2, unavailable); + } else { + window.setElement(-4, 1, ruleElement( + window, state, workcell, variant, RuleField.MINIMUM_DEPTH)); + window.setElement(-2, 1, ruleElement( + window, state, workcell, variant, RuleField.MAXIMUM_DEPTH)); + window.setElement(0, 1, ruleElement( + window, state, workcell, variant, RuleField.MINIMUM_PLACEMENTS)); + window.setElement(2, 1, ruleElement( + window, state, workcell, variant, RuleField.MAXIMUM_PLACEMENTS)); + + UIElement terminal = element( + "rule-terminal", + variant.rules().terminal() ? Material.REDSTONE_TORCH : Material.LEVER, + variant.rules().terminal() + ? ChatColor.GREEN + "Terminal Piece: Yes" + : ChatColor.YELLOW + "Terminal Piece: No"); + terminal.addLore(ChatColor.GRAY + "Terminal pieces consume a connector without expanding."); + terminal.addLore(ChatColor.YELLOW + "Left-click to toggle"); + terminal.onLeftClick(clicked -> controller.updateVariantRules( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + withTerminal(variant.rules(), !variant.rules().terminal()))); + window.setElement(4, 1, terminal); + + addVariantThemeMemberships(window, state, workcell, variant, page); + } + + UIElement footerBack = element("variant-rules-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + footerBack.onLeftClick(clicked -> controller.openDetails( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); + window.setElement(-4, 5, footerBack); + + int pageCount = pageCount(state.themeSets().size(), THEME_SETS_PER_PAGE); + if (page > 0) { + UIElement previous = element( + "variant-theme-previous", + Material.ARROW, + ChatColor.YELLOW + "Previous Page"); + previous.onLeftClick(clicked -> controller.refreshVariantSettings( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + page - 1)); + window.setElement(-1, 5, previous); + } + UIElement indicator = element( + "variant-theme-page", + Material.BOOK, + ChatColor.WHITE + "Theme Page " + (page + 1) + "/" + pageCount); + indicator.addLore(ChatColor.GRAY + "" + state.themeSets().size() + " declared themes"); + window.setElement(0, 5, indicator); + if (page + 1 < pageCount) { + UIElement next = element( + "variant-theme-next", + Material.ARROW, + ChatColor.YELLOW + "Next Page"); + next.onLeftClick(clicked -> controller.refreshVariantSettings( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + page + 1)); + window.setElement(1, 5, next); + } + window.setElement(4, 5, evaluationElement(state.evaluation())); + }); + } + + private UIElement ruleElement( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + RuleField field + ) { + int value = field.value(variant.rules()); + UIElement element = element( + "rule-" + field.name().toLowerCase(Locale.ROOT), + field.material(), + ChatColor.AQUA + field.displayName() + ": " + field.displayValue(value)); + boolean unlimitedMaximum = field == RuleField.MAXIMUM_PLACEMENTS && value == 0; + if (unlimitedMaximum) { + element.addLore(ChatColor.GRAY + "Increase is already unlimited."); + } else { + element.addLore(ChatColor.GREEN + "Left-click: +1"); + element.addLore(ChatColor.GREEN + "Shift-left: +" + field.shiftStep()); + element.onLeftClick(clicked -> controller.adjustVariantRule( + window.getViewer(), state.requestId(), workcell, variant, field, 1)); + element.onShiftLeftClick(clicked -> controller.adjustVariantRule( + window.getViewer(), state.requestId(), workcell, variant, field, field.shiftStep())); + } + element.addLore(unlimitedMaximum + ? ChatColor.YELLOW + "Right-click: set 512" + : ChatColor.YELLOW + "Right-click: -1"); + element.addLore(unlimitedMaximum + ? ChatColor.YELLOW + "Shift-right: set 497" + : ChatColor.YELLOW + "Shift-right: -" + field.shiftStep()); + element.onRightClick(clicked -> controller.adjustVariantRule( + window.getViewer(), state.requestId(), workcell, variant, field, -1)); + element.onShiftRightClick(clicked -> controller.adjustVariantRule( + window.getViewer(), state.requestId(), workcell, variant, field, -field.shiftStep())); + return element; + } + + private void addVariantThemeMemberships( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + int page + ) { + List themeSets = page( + state.themeSets(), page, THEME_SETS_PER_PAGE); + if (themeSets.isEmpty()) { + UIElement empty = element( + "variant-no-themes", + Material.GRAY_DYE, + ChatColor.GRAY + "Available to Every Theme"); + empty.addLore(ChatColor.GRAY + "Create a coherent theme set from Structure Rules first."); + window.setElement(0, 3, empty); + return; + } + for (int index = 0; index < themeSets.size(); index++) { + JigsawStudioMenuState.ThemeSet themeSet = themeSets.get(index); + boolean member = variant.themes().contains(themeSet.key()); + int position = GRID_POSITIONS[index % GRID_POSITIONS.length]; + int row = 2 + index / GRID_POSITIONS.length; + UIElement element = element( + "variant-theme-" + index, + member ? Material.LIME_DYE : Material.GRAY_DYE, + (member ? ChatColor.GREEN : ChatColor.GRAY) + safe(themeSet.key())) + .setEnchanted(member); + element.addLore(member + ? ChatColor.GREEN + "This variant belongs to the theme." + : ChatColor.GRAY + "This variant does not belong to the theme."); + element.addLore(ChatColor.GRAY + "Only variants in the selected family are eligible."); + element.addLore(ChatColor.YELLOW + "Left-click to toggle membership"); + element.onLeftClick(clicked -> controller.toggleVariantTheme( + window.getViewer(), state.requestId(), workcell, variant, themeSet.key())); + window.setElement(position, row, element); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellMenu.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellMenu.java new file mode 100644 index 000000000..a80694191 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellMenu.java @@ -0,0 +1,536 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.service.JigsawStudioMenuFormat.DimensionAxis; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import art.arcane.iris.util.common.scheduling.J; +import art.arcane.volmlib.util.inventorygui.UIElement; +import art.arcane.volmlib.util.inventorygui.UIWindow; +import org.bukkit.ChatColor; +import org.bukkit.Material; +import org.bukkit.entity.Player; + +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +import static art.arcane.iris.core.service.JigsawStudioMenuController.send; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.adjustedDimensions; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.dimensions; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.element; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.evaluationElement; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.safe; +import static art.arcane.iris.core.service.JigsawStudioMenuFormat.withCapacity; + +final class JigsawStudioWorkcellMenu { + private static final int WORKCELL_RESIZE_REFRESH_TICKS = 2; + private static final int WORKCELL_RESIZE_REFRESH_ATTEMPTS = 200; + private final Map pendingWorkcellResizes = new ConcurrentHashMap<>(); + + private final JigsawStudioMenuController controller; + + JigsawStudioWorkcellMenu(JigsawStudioMenuController controller) { + this.controller = Objects.requireNonNull(controller, "Jigsaw Studio menu controller"); + } + + void render( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell + ) { + PendingWorkcellResize pendingResize = pendingWorkcellResize( + window.getViewer().getUniqueId(), + state.requestId(), + workcell.stableId()); + JigsawStudioMenuState.Workcell renderedWorkcell = pendingResize == null + ? workcell + : withCapacity(workcell, pendingResize.dimensions()); + window.batch(() -> { + window.clearElements(); + + UIElement back = element("settings-back", Material.ARROW, ChatColor.YELLOW + "Back to Variants"); + back.onLeftClick(clicked -> leaveWorkcellSettings( + window.getViewer(), state.requestId(), renderedWorkcell.stableId())); + window.setElement(-4, 0, back); + + UIElement identity = element( + "settings-identity", + renderedWorkcell.enabled() ? Material.LIME_WOOL : Material.GRAY_WOOL, + ChatColor.AQUA + safe(renderedWorkcell.displayName())); + identity.addLore(ChatColor.DARK_GRAY + safe(renderedWorkcell.stableId())); + identity.addLore(renderedWorkcell.enabled() + ? ChatColor.GREEN + "Enabled" + : ChatColor.RED + "Disabled for assembly and export"); + if (!renderedWorkcell.canonicalName().equals(renderedWorkcell.displayName())) { + identity.addLore(ChatColor.GRAY + "Solver role: " + safe(renderedWorkcell.canonicalName())); + } + identity.addLore(ChatColor.GRAY + "Capacity: " + dimensions(renderedWorkcell.capacity())); + if (pendingResize != null) { + identity.addLore(pendingResize.applying() + ? ChatColor.YELLOW + "Applying one live relayout" + : ChatColor.GOLD + "Pending; apply when all dimensions are ready"); + } + identity.addLore(ChatColor.YELLOW + "Left-click for a rename stick"); + identity.addLore(ChatColor.GRAY + "Rename that stick in an anvil, then right-click it."); + identity.addLore(ChatColor.GRAY + "Sneak-right-click the stick to reset this label."); + identity.onLeftClick(clicked -> controller.actions.giveTool( + window.getViewer(), + JigsawStudioToolPayload.workcell( + JigsawStudioToolAction.RENAME_WORKCELL, + state.requestId(), + renderedWorkcell.stableId()))); + window.setElement(0, 0, identity); + window.setElement(4, 0, evaluationElement(state.evaluation())); + + if (state.mode() == JigsawStudioMode.PLANAR_JIGSAW) { + UIElement enabled = element( + "settings-enabled", + renderedWorkcell.enabled() ? Material.LEVER : Material.REDSTONE_TORCH, + renderedWorkcell.enabled() + ? ChatColor.GREEN + "Workcell Enabled" + : ChatColor.RED + "Workcell Disabled"); + enabled.addLore(ChatColor.GRAY + "Disabled workcells remain editable and keep their size."); + enabled.addLore(ChatColor.YELLOW + "Left-click to " + + (renderedWorkcell.enabled() ? "disable" : "enable")); + enabled.onLeftClick(clicked -> controller.setWorkcellEnabled( + window.getViewer(), + state.requestId(), + renderedWorkcell.stableId(), + !renderedWorkcell.enabled())); + window.setElement(0, 1, enabled); + } else { + UIElement spatial = element( + "spatial-bounds", + Material.SCAFFOLDING, + ChatColor.AQUA + "Spatial Workcell Bounds"); + spatial.addLore(ChatColor.GRAY + "Spatial project bounds are shared by the project."); + spatial.addLore(ChatColor.GRAY + "Changing them regenerates the Studio layout."); + window.setElement(0, 1, spatial); + } + + UIElement connectors = element( + "settings-connectors", + renderedWorkcell.connectorsVisible() ? Material.JIGSAW : Material.STRUCTURE_VOID, + renderedWorkcell.connectorsVisible() + ? ChatColor.GREEN + "Connector Blocks Visible" + : ChatColor.YELLOW + "Connector Blocks Hidden"); + connectors.addLore(ChatColor.GRAY + "Hidden connectors retain their metadata and final block state."); + connectors.addLore(ChatColor.YELLOW + "Left-click to " + + (renderedWorkcell.connectorsVisible() ? "hide" : "show") + " connector blocks"); + connectors.onLeftClick(clicked -> controller.toggleConnectorBlocks( + window.getViewer(), + state.requestId(), + renderedWorkcell.stableId(), + !renderedWorkcell.connectorsVisible())); + window.setElement(2, 1, connectors); + + UIElement resetConnectors = element( + "settings-reset-connectors", + Material.RECOVERY_COMPASS, + ChatColor.AQUA + "Reset Connector Blocks"); + resetConnectors.addLore(ChatColor.GRAY + "Restore every connector in this workcell from disk."); + resetConnectors.addLore(ChatColor.GRAY + "Other edited blocks are left unchanged."); + resetConnectors.onLeftClick(clicked -> controller.resetConnectorBlocks( + window.getViewer(), + state.requestId(), + renderedWorkcell.stableId())); + window.setElement(4, 1, resetConnectors); + + window.setElement(-2, 2, axisElement( + window, + state, + renderedWorkcell, + DimensionAxis.WIDTH, + Material.IRON_INGOT)); + window.setElement(0, 2, axisElement( + window, + state, + renderedWorkcell, + DimensionAxis.HEIGHT, + Material.GOLD_INGOT)); + window.setElement(2, 2, axisElement( + window, + state, + renderedWorkcell, + DimensionAxis.DEPTH, + Material.COPPER_INGOT)); + + if (pendingResize != null) { + UIElement apply = element( + "settings-apply-capacity", + pendingResize.applying() ? Material.CLOCK : Material.EMERALD_BLOCK, + pendingResize.applying() + ? ChatColor.YELLOW + "Applying Cell Size" + : ChatColor.GREEN + "Apply Cell Size"); + apply.addLore(ChatColor.WHITE + dimensions(pendingResize.dimensions())); + apply.addLore(ChatColor.GRAY + "Regenerates the layout once after all size edits."); + if (!pendingResize.applying()) { + apply.onLeftClick(clicked -> applyWorkcellResize( + window.getViewer(), state.requestId(), renderedWorkcell.stableId())); + } + window.setElement(0, 3, apply); + + if (!pendingResize.applying()) { + UIElement discard = element( + "settings-discard-capacity", + Material.BARRIER, + ChatColor.RED + "Discard Size Changes"); + discard.onLeftClick(clicked -> discardWorkcellResize( + window.getViewer(), state.requestId(), renderedWorkcell.stableId())); + window.setElement(2, 3, discard); + } + } + + UIElement footerBack = element("settings-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + footerBack.onLeftClick(clicked -> leaveWorkcellSettings( + window.getViewer(), state.requestId(), renderedWorkcell.stableId())); + window.setElement(-4, 5, footerBack); + + UIElement undo = element( + "settings-undo", + Material.CLOCK, + ChatColor.LIGHT_PURPLE + "Undo Last Autosave"); + undo.addLore(ChatColor.GRAY + "Restore the previous owned graph iteration."); + undo.addLore(ChatColor.GRAY + "Up to five autosave iterations are retained on disk."); + undo.onLeftClick(clicked -> controller.undoAutosave( + window.getViewer(), + state.requestId())); + window.setElement(0, 5, undo); + + if (renderedWorkcell.dirty() && !renderedWorkcell.saving()) { + UIElement saveNow = element( + "save-now", + Material.EMERALD, + ChatColor.GOLD + "Flush Autosave Now"); + saveNow.addLore(ChatColor.GRAY + "Autosave is automatic."); + saveNow.addLore(ChatColor.GRAY + "Use this only to flush pending work or recover immediately."); + saveNow.onLeftClick(clicked -> controller.flushNow( + window.getViewer(), state.requestId(), renderedWorkcell.stableId())); + window.setElement(2, 5, saveNow); + } + + UIElement preview = element( + "settings-preview", + Material.ENDER_EYE, + ChatColor.LIGHT_PURPLE + "Go to Preview"); + preview.onLeftClick(clicked -> controller.goToPreview(window.getViewer(), state.requestId())); + window.setElement(3, 5, preview); + + UIElement toolbox = element("settings-toolbox", Material.STICK, ChatColor.AQUA + "Toolbox"); + toolbox.onLeftClick(clicked -> controller.openToolbox( + window.getViewer(), state.requestId(), renderedWorkcell.stableId(), 0)); + window.setElement(4, 5, toolbox); + }); + } + + void renderSize( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant + ) { + JigsawStudioCellDimensions current = variant.dimensions().orElseThrow(); + window.batch(() -> { + window.clearElements(); + + UIElement back = element("variant-size-back", Material.ARROW, ChatColor.YELLOW + "Back to Details"); + back.onLeftClick(clicked -> controller.openDetails( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); + window.setElement(-4, 0, back); + + UIElement identity = element( + "variant-size-identity", + Material.SCAFFOLDING, + ChatColor.AQUA + safe(variant.displayName()) + " Size"); + identity.addLore(ChatColor.DARK_GRAY + safe(variant.pieceKey())); + identity.addLore(ChatColor.WHITE + "Current: " + dimensions(current)); + identity.addLore(ChatColor.GRAY + "Workcell capacity: " + dimensions(workcell.capacity())); + identity.addLore(ChatColor.GRAY + "Only this variant object and its edge connectors change."); + window.setElement(0, 0, identity); + window.setElement(4, 0, evaluationElement(state.evaluation())); + + window.setElement(-2, 2, variantAxisElement( + window, state, workcell, variant, DimensionAxis.WIDTH, Material.IRON_INGOT)); + window.setElement(0, 2, variantAxisElement( + window, state, workcell, variant, DimensionAxis.HEIGHT, Material.GOLD_INGOT)); + window.setElement(2, 2, variantAxisElement( + window, state, workcell, variant, DimensionAxis.DEPTH, Material.COPPER_INGOT)); + + UIElement capacity = element( + "variant-size-capacity", + variant.resizableToCapacity() ? Material.NETHER_STAR : Material.GRAY_DYE, + variant.resizableToCapacity() + ? ChatColor.GREEN + "Resize This Variant to Capacity" + : ChatColor.GRAY + "Variant Already Matches Capacity"); + capacity.addLore(ChatColor.GRAY + dimensions(workcell.capacity())); + if (variant.resizableToCapacity()) { + capacity.addLore(ChatColor.YELLOW + "Left-click to resize only this variant"); + capacity.onLeftClick(clicked -> controller.resizeVariant( + window.getViewer(), + state.requestId(), + workcell.stableId(), + variant.pieceKey(), + workcell.capacity())); + } + window.setElement(0, 3, capacity); + + UIElement footerBack = element("variant-size-footer-back", Material.ARROW, ChatColor.YELLOW + "Back"); + footerBack.onLeftClick(clicked -> controller.openDetails( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), 0)); + window.setElement(-4, 5, footerBack); + }); + } + + private UIElement variantAxisElement( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + JigsawStudioMenuState.Variant variant, + DimensionAxis axis, + Material material + ) { + JigsawStudioCellDimensions current = variant.dimensions().orElseThrow(); + UIElement element = element( + "variant-axis-" + axis.name().toLowerCase(Locale.ROOT), + material, + ChatColor.AQUA + axis.displayName() + ": " + axis.value(current)); + element.addLore(ChatColor.GREEN + "Left-click: +1"); + element.addLore(ChatColor.YELLOW + "Right-click: -1"); + element.addLore(ChatColor.GREEN + "Shift-left: +8"); + element.addLore(ChatColor.YELLOW + "Shift-right: -8"); + element.addLore(ChatColor.GRAY + "Maximum: " + axis.value(workcell.capacity())); + element.onLeftClick(clicked -> controller.resizeVariantAxis( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, 1)); + element.onRightClick(clicked -> controller.resizeVariantAxis( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, -1)); + element.onShiftLeftClick(clicked -> controller.resizeVariantAxis( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, 8)); + element.onShiftRightClick(clicked -> controller.resizeVariantAxis( + window.getViewer(), state.requestId(), workcell.stableId(), variant.pieceKey(), axis, -8)); + return element; + } + + private UIElement axisElement( + UIWindow window, + JigsawStudioMenuState state, + JigsawStudioMenuState.Workcell workcell, + DimensionAxis axis, + Material material + ) { + UIElement element = element( + "axis-" + axis.name().toLowerCase(Locale.ROOT), + material, + ChatColor.AQUA + axis.displayName() + " Capacity: " + axis.value(workcell.capacity())); + element.addLore(ChatColor.GREEN + "Left-click: +1"); + element.addLore(ChatColor.YELLOW + "Right-click: -1"); + element.addLore(ChatColor.GREEN + "Shift-left: +8"); + element.addLore(ChatColor.YELLOW + "Shift-right: -8"); + element.addLore(ChatColor.GRAY + "Changes stay in this menu until Apply Cell Size."); + element.onLeftClick(clicked -> resizeWorkcell( + window.getViewer(), state.requestId(), workcell.stableId(), axis, 1)); + element.onRightClick(clicked -> resizeWorkcell( + window.getViewer(), state.requestId(), workcell.stableId(), axis, -1)); + element.onShiftLeftClick(clicked -> resizeWorkcell( + window.getViewer(), state.requestId(), workcell.stableId(), axis, 8)); + element.onShiftRightClick(clicked -> resizeWorkcell( + window.getViewer(), state.requestId(), workcell.stableId(), axis, -8)); + return element; + } + + private void resizeWorkcell( + Player player, + UUID requestId, + String workcellId, + DimensionAxis axis, + int delta + ) { + Optional current = controller.matchingState(player, requestId, true); + if (current.isEmpty()) { + return; + } + JigsawStudioMenuState.Workcell workcell = current.get().workcell(workcellId); + if (workcell == null) { + controller.stale(player); + return; + } + UUID playerId = player.getUniqueId(); + PendingWorkcellResize existing = pendingWorkcellResize(playerId, requestId, workcellId); + if (existing != null && existing.applying()) { + send(player, ChatColor.YELLOW + "That cell size is already being applied."); + return; + } + JigsawStudioCellDimensions base = existing == null + ? workcell.capacity() + : existing.dimensions(); + Optional adjusted = adjustedDimensions( + base, axis, delta); + if (adjusted.isEmpty()) { + send(player, ChatColor.RED + "That workcell size is outside Iris limits."); + return; + } + PendingWorkcellResize pending = new PendingWorkcellResize( + requestId, + workcellId, + adjusted.get(), + false); + pendingWorkcellResizes.put(playerId, pending); + UIWindow window = controller.windows.get(playerId); + if (window != null) { + render(window, current.get(), withCapacity(workcell, pending.dimensions())); + } + } + + private void applyWorkcellResize(Player player, UUID requestId, String workcellId) { + Optional current = controller.matchingState(player, requestId, true); + if (current.isEmpty()) { + return; + } + UUID playerId = player.getUniqueId(); + PendingWorkcellResize pending = pendingWorkcellResize(playerId, requestId, workcellId); + JigsawStudioMenuState.Workcell workcell = current.get().workcell(workcellId); + if (pending == null || pending.applying() || workcell == null) { + return; + } + if (workcell.capacity().equals(pending.dimensions())) { + pendingWorkcellResizes.remove(playerId, pending); + refreshWorkcellSettings(player, requestId, workcellId); + return; + } + PendingWorkcellResize applying = new PendingWorkcellResize( + requestId, + workcellId, + pending.dimensions(), + true); + pendingWorkcellResizes.put(playerId, applying); + UIWindow window = controller.windows.get(playerId); + if (window != null) { + render(window, current.get(), withCapacity(workcell, applying.dimensions())); + } + if (!controller.actions.updateWorkcellDimensions(player, workcellId, applying.dimensions())) { + pendingWorkcellResizes.replace(playerId, applying, pending); + refreshWorkcellSettings(player, requestId, workcellId); + return; + } + scheduleWorkcellResizeRefresh(player, applying, WORKCELL_RESIZE_REFRESH_ATTEMPTS); + } + + private void scheduleWorkcellResizeRefresh( + Player player, + PendingWorkcellResize pending, + int attemptsRemaining + ) { + boolean scheduled = J.runEntity( + player, + () -> refreshAppliedWorkcellResize(player, pending, attemptsRemaining), + WORKCELL_RESIZE_REFRESH_TICKS); + if (!scheduled) { + pendingWorkcellResizes.remove(player.getUniqueId(), pending); + } + } + + private void refreshAppliedWorkcellResize( + Player player, + PendingWorkcellResize pending, + int attemptsRemaining + ) { + UUID playerId = player.getUniqueId(); + if (!pending.equals(pendingWorkcellResizes.get(playerId))) { + return; + } + Optional current = controller.matchingState(player, pending.requestId(), false); + JigsawStudioMenuState.Workcell workcell = current + .map(state -> state.workcell(pending.workcellId())) + .orElse(null); + if (workcell == null) { + pendingWorkcellResizes.remove(playerId, pending); + return; + } + if (workcell.capacity().equals(pending.dimensions())) { + pendingWorkcellResizes.remove(playerId, pending); + UIWindow window = controller.windows.get(playerId); + if (window != null) { + render(window, current.orElseThrow(), workcell); + } + return; + } + if (attemptsRemaining > 0) { + scheduleWorkcellResizeRefresh(player, pending, attemptsRemaining - 1); + return; + } + PendingWorkcellResize retry = new PendingWorkcellResize( + pending.requestId(), + pending.workcellId(), + pending.dimensions(), + false); + pendingWorkcellResizes.replace(playerId, pending, retry); + UIWindow window = controller.windows.get(playerId); + if (window != null) { + render(window, current.orElseThrow(), withCapacity(workcell, retry.dimensions())); + } + send(player, ChatColor.YELLOW + + "Cell resizing is still pending; use Apply Cell Size to retry after the current operation settles."); + } + + private void discardWorkcellResize(Player player, UUID requestId, String workcellId) { + PendingWorkcellResize pending = pendingWorkcellResize(player.getUniqueId(), requestId, workcellId); + if (pending != null && !pending.applying()) { + pendingWorkcellResizes.remove(player.getUniqueId(), pending); + } + refreshWorkcellSettings(player, requestId, workcellId); + } + + private void leaveWorkcellSettings(Player player, UUID requestId, String workcellId) { + PendingWorkcellResize pending = pendingWorkcellResize(player.getUniqueId(), requestId, workcellId); + if (pending != null && !pending.applying()) { + pendingWorkcellResizes.remove(player.getUniqueId(), pending); + } + controller.refreshMain(player, requestId, workcellId, 0); + } + + private void refreshWorkcellSettings(Player player, UUID requestId, String workcellId) { + Optional current = controller.matchingState(player, requestId, true); + UIWindow window = controller.windows.get(player.getUniqueId()); + JigsawStudioMenuState.Workcell workcell = current + .map(state -> state.workcell(workcellId)) + .orElse(null); + if (window == null || workcell == null) { + return; + } + render(window, current.orElseThrow(), workcell); + } + + private PendingWorkcellResize pendingWorkcellResize(UUID playerId, UUID requestId, String workcellId) { + PendingWorkcellResize pending = pendingWorkcellResizes.get(playerId); + if (pending == null + || !pending.requestId().equals(requestId) + || !pending.workcellId().equals(workcellId)) { + return null; + } + return pending; + } + + private record PendingWorkcellResize( + UUID requestId, + String workcellId, + JigsawStudioCellDimensions dimensions, + boolean applying + ) { + private PendingWorkcellResize { + requestId = Objects.requireNonNull(requestId, "Jigsaw Studio resize request ID"); + workcellId = Objects.requireNonNull(workcellId, "Jigsaw Studio resize workcell ID"); + dimensions = Objects.requireNonNull(dimensions, "Jigsaw Studio resize dimensions"); + } + } + void clearStagedResize(UUID playerId) { + pendingWorkcellResizes.remove(playerId); + } + + void clearStagedResizes() { + pendingWorkcellResizes.clear(); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java index 7725abc38..9b86e7ac7 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java @@ -57,13 +57,13 @@ public class JigsawStudioMenuControllerTest { values.add(index); } - assertEquals(1, JigsawStudioMenuController.pageCount(0, 28)); - assertEquals(1, JigsawStudioMenuController.pageCount(28, 28)); - assertEquals(2, JigsawStudioMenuController.pageCount(29, 28)); - assertEquals(List.of(0, 1, 2), JigsawStudioMenuController.page(values, -10, 3)); - assertEquals(List.of(54, 55, 56), JigsawStudioMenuController.page(values, 999, 3)); + assertEquals(1, JigsawStudioMenuFormat.pageCount(0, 28)); + assertEquals(1, JigsawStudioMenuFormat.pageCount(28, 28)); + assertEquals(2, JigsawStudioMenuFormat.pageCount(29, 28)); + assertEquals(List.of(0, 1, 2), JigsawStudioMenuFormat.page(values, -10, 3)); + assertEquals(List.of(54, 55, 56), JigsawStudioMenuFormat.page(values, 999, 3)); assertThrows(IllegalArgumentException.class, - () -> JigsawStudioMenuController.pageCount(1, 0)); + () -> JigsawStudioMenuFormat.pageCount(1, 0)); } @Test @@ -86,7 +86,7 @@ public class JigsawStudioMenuControllerTest { false, List.of(active)); - assertEquals(ChatColor.GREEN + "Autosaved", JigsawStudioMenuController.workcellStatus(fresh)); + assertEquals(ChatColor.GREEN + "Autosaved", JigsawStudioMenuFormat.workcellStatus(fresh)); } @Test @@ -97,11 +97,11 @@ public class JigsawStudioMenuControllerTest { List.of(), List.of()); - assertEquals(Material.JIGSAW, JigsawStudioMenuController.variantMaterial(active)); + assertEquals(Material.JIGSAW, JigsawStudioMenuFormat.variantMaterial(active)); assertEquals(Material.EMERALD, - JigsawStudioMenuController.evaluationMaterial(JigsawStudioEvaluationState.VALID)); + JigsawStudioMenuFormat.evaluationMaterial(JigsawStudioEvaluationState.VALID)); assertEquals(Material.TARGET, - JigsawStudioMenuController.RuleField.MINIMUM_PLACEMENTS.material()); + JigsawStudioMenuFormat.RuleField.MINIMUM_PLACEMENTS.material()); } @Test @@ -217,33 +217,33 @@ public class JigsawStudioMenuControllerTest { assertEquals( new JigsawStudioCellDimensions(25, 12, 18), - JigsawStudioMenuController.adjustedDimensions( + JigsawStudioMenuFormat.adjustedDimensions( dimensions, - JigsawStudioMenuController.DimensionAxis.WIDTH, + JigsawStudioMenuFormat.DimensionAxis.WIDTH, 1).orElseThrow()); assertEquals( new JigsawStudioCellDimensions(24, 20, 18), - JigsawStudioMenuController.adjustedDimensions( + JigsawStudioMenuFormat.adjustedDimensions( dimensions, - JigsawStudioMenuController.DimensionAxis.HEIGHT, + JigsawStudioMenuFormat.DimensionAxis.HEIGHT, 8).orElseThrow()); assertEquals( new JigsawStudioCellDimensions(24, 12, 10), - JigsawStudioMenuController.adjustedDimensions( + JigsawStudioMenuFormat.adjustedDimensions( dimensions, - JigsawStudioMenuController.DimensionAxis.DEPTH, + JigsawStudioMenuFormat.DimensionAxis.DEPTH, -8).orElseThrow()); - assertTrue(JigsawStudioMenuController.adjustedDimensions( + assertTrue(JigsawStudioMenuFormat.adjustedDimensions( new JigsawStudioCellDimensions(1, 1, 1), - JigsawStudioMenuController.DimensionAxis.WIDTH, + JigsawStudioMenuFormat.DimensionAxis.WIDTH, -1).isEmpty()); - assertTrue(JigsawStudioMenuController.adjustedDimensions( + assertTrue(JigsawStudioMenuFormat.adjustedDimensions( new JigsawStudioCellDimensions(128, 1, 1), - JigsawStudioMenuController.DimensionAxis.WIDTH, + JigsawStudioMenuFormat.DimensionAxis.WIDTH, 1).isEmpty()); - assertThrows(IllegalArgumentException.class, () -> JigsawStudioMenuController.adjustedDimensions( + assertThrows(IllegalArgumentException.class, () -> JigsawStudioMenuFormat.adjustedDimensions( dimensions, - JigsawStudioMenuController.DimensionAxis.WIDTH, + JigsawStudioMenuFormat.DimensionAxis.WIDTH, 0)); } @@ -251,21 +251,22 @@ public class JigsawStudioMenuControllerTest { public void stagesMultipleCellSizeEditsAndAppliesOneRelayoutWithoutClosing() throws Exception { UUID playerId = UUID.fromString("55555555-5555-5555-5555-555555555555"); Player player = mock(Player.class); - JigsawStudioMenuController.Actions actions = mock(JigsawStudioMenuController.Actions.class); + JigsawStudioMenuActions actions = mock(JigsawStudioMenuActions.class); JigsawStudioMenuState.Variant active = variant("pieces/corner", true, List.of(), List.of()); JigsawStudioMenuState.Workcell workcell = workcell(active); JigsawStudioMenuState state = state(JigsawStudioMenuState.Evaluation.pending(), workcell); JigsawStudioMenuController controller = new JigsawStudioMenuController( mock(JavaPlugin.class), actions); - Method resize = JigsawStudioMenuController.class.getDeclaredMethod( + JigsawStudioWorkcellMenu workcellMenu = new JigsawStudioWorkcellMenu(controller); + Method resize = JigsawStudioWorkcellMenu.class.getDeclaredMethod( "resizeWorkcell", Player.class, UUID.class, String.class, - JigsawStudioMenuController.DimensionAxis.class, + JigsawStudioMenuFormat.DimensionAxis.class, int.class); - Method apply = JigsawStudioMenuController.class.getDeclaredMethod( + Method apply = JigsawStudioWorkcellMenu.class.getDeclaredMethod( "applyWorkcellResize", Player.class, UUID.class, @@ -280,18 +281,18 @@ public class JigsawStudioMenuControllerTest { new JigsawStudioCellDimensions(25, 20, 18))).thenReturn(true); resize.invoke( - controller, + workcellMenu, player, REQUEST_ID, workcell.stableId(), - JigsawStudioMenuController.DimensionAxis.WIDTH, + JigsawStudioMenuFormat.DimensionAxis.WIDTH, 1); resize.invoke( - controller, + workcellMenu, player, REQUEST_ID, workcell.stableId(), - JigsawStudioMenuController.DimensionAxis.HEIGHT, + JigsawStudioMenuFormat.DimensionAxis.HEIGHT, 8); verify(actions, never()).updateWorkcellDimensions( @@ -304,7 +305,7 @@ public class JigsawStudioMenuControllerTest { any(Runnable.class), eq(2))).thenReturn(true); - apply.invoke(controller, player, REQUEST_ID, workcell.stableId()); + apply.invoke(workcellMenu, player, REQUEST_ID, workcell.stableId()); verify(actions).updateWorkcellDimensions( player, @@ -319,7 +320,7 @@ public class JigsawStudioMenuControllerTest { JigsawStudioMenuState.Workcell source = workcell(active); JigsawStudioCellDimensions capacity = new JigsawStudioCellDimensions(31, 19, 27); - JigsawStudioMenuState.Workcell staged = JigsawStudioMenuController.withCapacity(source, capacity); + JigsawStudioMenuState.Workcell staged = JigsawStudioMenuFormat.withCapacity(source, capacity); assertEquals(capacity, staged.capacity()); assertEquals(source.stableId(), staged.stableId()); @@ -335,12 +336,12 @@ public class JigsawStudioMenuControllerTest { new JigsawStudioMenuState.ThemeSet("seasonal", 4), new JigsawStudioMenuState.ThemeSet("variant-2", 2)); - assertEquals("variant-3", JigsawStudioMenuController.nextThemeSetKey(themeSets)); - assertEquals("variant-1", JigsawStudioMenuController.nextThemeSetKey(List.of())); - assertEquals(Integer.valueOf(12), JigsawStudioMenuController.adjustedPositiveValue(4, 8).orElseThrow()); - assertTrue(JigsawStudioMenuController.adjustedPositiveValue(4, -8).isEmpty()); + assertEquals("variant-3", JigsawStudioMenuFormat.nextThemeSetKey(themeSets)); + assertEquals("variant-1", JigsawStudioMenuFormat.nextThemeSetKey(List.of())); + assertEquals(Integer.valueOf(12), JigsawStudioMenuFormat.adjustedPositiveValue(4, 8).orElseThrow()); + assertTrue(JigsawStudioMenuFormat.adjustedPositiveValue(4, -8).isEmpty()); assertThrows(IllegalArgumentException.class, - () -> JigsawStudioMenuController.adjustedPositiveValue(4, 0)); + () -> JigsawStudioMenuFormat.adjustedPositiveValue(4, 0)); } @Test @@ -349,10 +350,10 @@ public class JigsawStudioMenuControllerTest { new JigsawStudioMenuState.ThemeSet("variant-1", 3), new JigsawStudioMenuState.ThemeSet("variant-2", 1)); - assertEquals("75.0%", JigsawStudioMenuController.themeSelectionPercent( + assertEquals("75.0%", JigsawStudioMenuFormat.themeSelectionPercent( themes, themes.getFirst())); - assertEquals("25.0%", JigsawStudioMenuController.themeSelectionPercent( + assertEquals("25.0%", JigsawStudioMenuFormat.themeSelectionPercent( themes, themes.getLast())); } @@ -361,47 +362,47 @@ public class JigsawStudioMenuControllerTest { public void editsPieceRuleFieldsWithinRuntimeBounds() { assertEquals( new JigsawStudioPieceRules(2, 12, 2, 8, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( RULES, - JigsawStudioMenuController.RuleField.MINIMUM_DEPTH, + JigsawStudioMenuFormat.RuleField.MINIMUM_DEPTH, 1).orElseThrow()); assertEquals( new JigsawStudioPieceRules(1, 17, 2, 8, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( RULES, - JigsawStudioMenuController.RuleField.MAXIMUM_DEPTH, + JigsawStudioMenuFormat.RuleField.MAXIMUM_DEPTH, 5).orElseThrow()); assertEquals( new JigsawStudioPieceRules(1, 12, 3, 8, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( RULES, - JigsawStudioMenuController.RuleField.MINIMUM_PLACEMENTS, + JigsawStudioMenuFormat.RuleField.MINIMUM_PLACEMENTS, 1).orElseThrow()); assertEquals( new JigsawStudioPieceRules(1, 12, 2, 24, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( RULES, - JigsawStudioMenuController.RuleField.MAXIMUM_PLACEMENTS, + JigsawStudioMenuFormat.RuleField.MAXIMUM_PLACEMENTS, 16).orElseThrow()); assertEquals( new JigsawStudioPieceRules(0, 30, 0, 0, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( new JigsawStudioPieceRules(0, 30, 0, 512, false), - JigsawStudioMenuController.RuleField.MAXIMUM_PLACEMENTS, + JigsawStudioMenuFormat.RuleField.MAXIMUM_PLACEMENTS, 1).orElseThrow()); assertEquals( new JigsawStudioPieceRules(0, 30, 0, 512, false), - JigsawStudioMenuController.adjustedRules( + JigsawStudioMenuFormat.adjustedRules( new JigsawStudioPieceRules(0, 30, 0, 0, false), - JigsawStudioMenuController.RuleField.MAXIMUM_PLACEMENTS, + JigsawStudioMenuFormat.RuleField.MAXIMUM_PLACEMENTS, -1).orElseThrow()); - assertTrue(JigsawStudioMenuController.adjustedRules( + assertTrue(JigsawStudioMenuFormat.adjustedRules( RULES, - JigsawStudioMenuController.RuleField.MINIMUM_DEPTH, + JigsawStudioMenuFormat.RuleField.MINIMUM_DEPTH, 12).isEmpty()); assertEquals( new JigsawStudioPieceRules(1, 12, 2, 8, true), - JigsawStudioMenuController.withTerminal(RULES, true)); + JigsawStudioMenuFormat.withTerminal(RULES, true)); } @Test @@ -424,23 +425,23 @@ public class JigsawStudioMenuControllerTest { JigsawStudioMenuState.Workcell corner = workcell(active, List.of(active, inactive)); JigsawStudioMenuState state = state(JigsawStudioMenuState.Evaluation.pending(), corner); - List tools = JigsawStudioMenuController.toolboxTools( + List tools = JigsawStudioToolboxMenu.toolboxTools( state, corner); - JigsawStudioMenuController.ToolboxTool preview = tool(tools, JigsawStudioToolAction.PREVIEW_GRAPH, 0); - JigsawStudioMenuController.ToolboxTool chanceIncrease = tool( + JigsawStudioToolboxMenu.ToolboxTool preview = tool(tools, JigsawStudioToolAction.PREVIEW_GRAPH, 0); + JigsawStudioToolboxMenu.ToolboxTool chanceIncrease = tool( tools, JigsawStudioToolAction.ADJUST_VARIANT_CHANCE, JigsawStudioMenuController.CHANCE_STEP_PERCENTAGE_POINTS); - JigsawStudioMenuController.ToolboxTool delete = tool( + JigsawStudioToolboxMenu.ToolboxTool delete = tool( tools, JigsawStudioToolAction.DELETE_VARIANT, 0); - JigsawStudioMenuController.ToolboxTool newThemeSet = tools.stream() + JigsawStudioToolboxMenu.ToolboxTool newThemeSet = tools.stream() .filter(tool -> tool.payload().action() == JigsawStudioToolAction.DUPLICATE_FAMILY) .findFirst() .orElseThrow(); - JigsawStudioMenuController.ToolboxTool pieceRules = tools.stream() + JigsawStudioToolboxMenu.ToolboxTool pieceRules = tools.stream() .filter(tool -> tool.payload().action() == JigsawStudioToolAction.SET_PIECE_RULES) .findFirst() .orElseThrow(); @@ -489,7 +490,7 @@ public class JigsawStudioMenuControllerTest { JigsawStudioMenuState.Evaluation.pending(), List.of(room)); - List tools = JigsawStudioMenuController.toolboxTools(state, room); + List tools = JigsawStudioToolboxMenu.toolboxTools(state, room); assertTrue(tools.stream().anyMatch(tool -> tool.payload().action() == JigsawStudioToolAction.RESIZE_WORKCELL)); @@ -519,7 +520,7 @@ public class JigsawStudioMenuControllerTest { JigsawStudioMenuState.Evaluation.pending(), List.of(corner)); - List tools = JigsawStudioMenuController.toolboxTools(state, corner); + List tools = JigsawStudioToolboxMenu.toolboxTools(state, corner); assertFalse(state.irisExtended()); assertTrue(tools.stream().noneMatch(tool -> tool.payload().action() == JigsawStudioToolAction.SET_THEME)); @@ -536,7 +537,7 @@ public class JigsawStudioMenuControllerTest { @Test public void openMarshalsToThePlayerRegionBeforeReadingStudioState() { Player player = mock(Player.class); - JigsawStudioMenuController.Actions actions = mock(JigsawStudioMenuController.Actions.class); + JigsawStudioMenuActions actions = mock(JigsawStudioMenuActions.class); JigsawStudioMenuController controller = new JigsawStudioMenuController( mock(JavaPlugin.class), actions); @@ -649,12 +650,12 @@ public class JigsawStudioMenuControllerTest { memberships); } - private JigsawStudioMenuController.ToolboxTool tool( - List tools, + private JigsawStudioToolboxMenu.ToolboxTool tool( + List tools, JigsawStudioToolAction action, int amount ) { - Optional match = tools.stream() + Optional match = tools.stream() .filter(tool -> tool.payload().action() == action && tool.payload().amount() == amount) .findFirst(); return match.orElseThrow(); From 2451c89ceecca04ce8de5c0bbbb3e8dc99ceb8a3 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:12:07 -0400 Subject: [PATCH 29/35] Split jigsaw studio service - Move world registration and shutdown quiescing into JigsawStudioRegistry - Move save, export and close arbitration into JigsawStudioSaveLifecycle - Move autosave scheduling, drains and undo into JigsawStudioAutosaveScheduler - Move variant creation, duplication and deletion into JigsawStudioVariantEditor - Move variant metadata and resize edits into JigsawStudioVariantProperties - Move workcell capacity, labels and connector blocks into JigsawStudioWorkcellEditor - Move graph mutation and live relayout into JigsawStudioGraphMutations - Move dynamic graph evaluation into JigsawStudioEvaluator - Move menu state, studio tools and deferred duplication into JigsawStudioToolbelt - Move the studio world event handlers into JigsawStudioProtectionListener - Move ownership and mutation guards into JigsawStudioProtection - Move variant materialization and hydration into JigsawStudioMaterializer - Move dirty marking into JigsawStudioDirtyTracker - Move workcell capture scheduling into JigsawStudioCaptureScheduler - Move chunk capture and connector aggregation into JigsawStudioCapture - Move materialized and rendered chunk writing into JigsawStudioChunkWriter - Move jigsaw marker NBT watching into JigsawStudioTileWatcher - Move particle preview rendering into JigsawStudioVisualization - Move player workcell context into JigsawStudioPlayerContext - Point the studio service tests at the relocated collaborators - Record the split studio sources in the Bukkit purity allowlist --- core/purity-allowlist.txt | 26 + .../JigsawStudioAutosaveScheduler.java | 670 ++ .../core/service/JigsawStudioCapture.java | 697 ++ .../service/JigsawStudioCaptureScheduler.java | 493 + .../core/service/JigsawStudioChunkWriter.java | 624 ++ .../service/JigsawStudioDirtyTracker.java | 118 + .../core/service/JigsawStudioEvaluator.java | 308 + .../service/JigsawStudioGraphMutations.java | 417 + .../service/JigsawStudioMaterializer.java | 632 ++ .../service/JigsawStudioPlayerContext.java | 191 + .../core/service/JigsawStudioProtection.java | 396 + .../JigsawStudioProtectionListener.java | 710 ++ .../core/service/JigsawStudioRegistry.java | 271 + .../service/JigsawStudioSaveLifecycle.java | 512 + .../core/service/JigsawStudioService.java | 8682 +---------------- .../core/service/JigsawStudioTileWatcher.java | 340 + .../core/service/JigsawStudioToolbelt.java | 692 ++ .../service/JigsawStudioVariantEditor.java | 590 ++ .../JigsawStudioVariantProperties.java | 550 ++ .../service/JigsawStudioVisualization.java | 404 + .../service/JigsawStudioWorkcellEditor.java | 434 + .../service/JigsawStudioLifecycleTest.java | 62 +- .../JigsawStudioMenuControllerTest.java | 6 +- .../JigsawStudioPreviewRendererTest.java | 4 +- .../JigsawStudioServiceCaptureTest.java | 328 +- .../JigsawStudioVisualizationBoundsTest.java | 34 +- 26 files changed, 9617 insertions(+), 8574 deletions(-) create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioAutosaveScheduler.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioCapture.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioCaptureScheduler.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioChunkWriter.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioDirtyTracker.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioEvaluator.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioGraphMutations.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioMaterializer.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioPlayerContext.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtection.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtectionListener.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioRegistry.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioSaveLifecycle.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioTileWatcher.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolbelt.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantEditor.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantProperties.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioVisualization.java create mode 100644 core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellEditor.java diff --git a/core/purity-allowlist.txt b/core/purity-allowlist.txt index 213fdd9ec..026c9fdc3 100644 --- a/core/purity-allowlist.txt +++ b/core/purity-allowlist.txt @@ -62,11 +62,37 @@ art/arcane/iris/core/service/BoardSVC.java art/arcane/iris/core/service/EntityRiseSVC.java art/arcane/iris/core/service/ExternalDataSVC.java art/arcane/iris/core/service/GlobalCacheSVC.java +art/arcane/iris/core/service/JigsawStudioAutosaveScheduler.java +art/arcane/iris/core/service/JigsawStudioCapture.java +art/arcane/iris/core/service/JigsawStudioCaptureScheduler.java +art/arcane/iris/core/service/JigsawStudioChunkWriter.java +art/arcane/iris/core/service/JigsawStudioDetailsMenu.java +art/arcane/iris/core/service/JigsawStudioDirtyTracker.java +art/arcane/iris/core/service/JigsawStudioGraphMutations.java +art/arcane/iris/core/service/JigsawStudioMainMenu.java art/arcane/iris/core/service/JigsawStudioMarkerParser.java +art/arcane/iris/core/service/JigsawStudioMaterializer.java +art/arcane/iris/core/service/JigsawStudioMenuActions.java art/arcane/iris/core/service/JigsawStudioMenuController.java +art/arcane/iris/core/service/JigsawStudioMenuFormat.java +art/arcane/iris/core/service/JigsawStudioPlayerContext.java art/arcane/iris/core/service/JigsawStudioPreviewRenderer.java +art/arcane/iris/core/service/JigsawStudioProtection.java +art/arcane/iris/core/service/JigsawStudioProtectionListener.java +art/arcane/iris/core/service/JigsawStudioRegistry.java +art/arcane/iris/core/service/JigsawStudioSaveLifecycle.java art/arcane/iris/core/service/JigsawStudioService.java +art/arcane/iris/core/service/JigsawStudioStructureMenu.java +art/arcane/iris/core/service/JigsawStudioTileWatcher.java art/arcane/iris/core/service/JigsawStudioToolCodec.java +art/arcane/iris/core/service/JigsawStudioToolbelt.java +art/arcane/iris/core/service/JigsawStudioToolboxMenu.java +art/arcane/iris/core/service/JigsawStudioVariantEditor.java +art/arcane/iris/core/service/JigsawStudioVariantMenu.java +art/arcane/iris/core/service/JigsawStudioVariantProperties.java +art/arcane/iris/core/service/JigsawStudioVisualization.java +art/arcane/iris/core/service/JigsawStudioWorkcellEditor.java +art/arcane/iris/core/service/JigsawStudioWorkcellMenu.java art/arcane/iris/core/service/MultiverseSVC.java art/arcane/iris/core/service/ObjectSVC.java art/arcane/iris/core/service/ObjectStudioSaveService.java diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioAutosaveScheduler.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioAutosaveScheduler.java new file mode 100644 index 000000000..896d14d68 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioAutosaveScheduler.java @@ -0,0 +1,670 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkCaptureArea; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkSnapshot; +import art.arcane.iris.core.service.JigsawStudioCaptureScheduler.CaptureCoordinator; +import art.arcane.iris.core.service.JigsawStudioCaptureScheduler.CaptureTarget; +import art.arcane.iris.core.service.JigsawStudioCaptureScheduler.CaptureWork; +import art.arcane.iris.core.service.JigsawStudioMaterializer.VariantReloadRequest; +import art.arcane.iris.core.service.JigsawStudioSaveLifecycle.BayReadiness; +import art.arcane.iris.core.service.JigsawStudioSaveLifecycle.SaveAttempt; +import art.arcane.iris.core.service.JigsawStudioSaveLifecycle.SaveStart; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutationResult; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; + +import static art.arcane.iris.core.service.JigsawStudioCapture.captureChunkIntersection; +import static art.arcane.iris.core.service.JigsawStudioCapture.chunkIntersections; +import static art.arcane.iris.core.service.JigsawStudioCaptureScheduler.resolveCaptureTarget; +import static art.arcane.iris.core.service.JigsawStudioGraphMutations.loadMappedLayout; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioService.AUTOSAVE_RETRY_TICKS; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioService.writeFailure; + +final class JigsawStudioAutosaveScheduler { + static final int AUTOSAVE_DEBOUNCE_TICKS = 40; + + private static final List AUTOSAVE_PERSISTENT_RETRY_DELAYS = + List.of(40, 80, 160, 320, 600); + + private final JigsawStudioService service; + final Map autosaves = new ConcurrentHashMap<>(); + + JigsawStudioAutosaveScheduler(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean undoAutosave(Player player) { + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> undoAutosave(player)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + Map activeReloads = new HashMap<>(); + for (JigsawStudioBay workcell : session.layout().bays()) { + session.activeVariant(workcell.stableId()).ifPresent(variant -> activeReloads.put( + variant.pieceKey(), + new VariantReloadRequest( + workcell.stableId(), + studio.generator().renderBay(workcell)))); + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + message(player, "Restoring the previous Jigsaw Studio autosave iteration..."); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + Path packRoot = request.source().getDataFolder().toPath(); + JigsawStudioHistoryStore.UndoResult result = new JigsawStudioHistoryStore( + packRoot, + request.structureKey()).undoLatest(); + if (!result.available()) { + return new CommandGraphMutationResult( + session.layout(), + "", + "", + "No earlier autosave iteration is available."); + } + if (!result.successful()) { + throw new IOException("Jigsaw Studio undo failed: " + + writeFailure(result.writeResult())); + } + request.source().invalidateStructureResources(); + JigsawStudioLayout restoredLayout = loadMappedLayout(studio); + VariantReloadRequest reload = activeReloads.get(result.pieceKey()); + Optional activeReload = reload == null + || restoredLayout.get(reload.workcellId()) == null + ? Optional.empty() + : Optional.of(reload); + String warning = result.warning().isEmpty() + ? "" + : " History cleanup warning: " + result.warning(); + return new CommandGraphMutationResult( + restoredLayout, + "", + "", + Map.of(), + activeReload, + "Restored the previous autosave iteration. " + + result.remainingIterations() + " earlier iteration(s) remain." + + warning); + }); + } + + boolean flushAutosave(Player player, String workcellId) { + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> flushAutosave(player, workcellId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String targetId = workcellId == null || workcellId.isBlank() + ? session.selectedBayId().orElse("") + : workcellId; + JigsawStudioBay bay = session.layout().get(targetId); + if (bay == null) { + message(player, "Select a Jigsaw Studio workcell before saving now."); + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); + return false; + } + SaveAttempt attempt = service.saveLifecycle.startSave(studio, studio.world(), bay, player, true); + if (attempt == SaveAttempt.STARTED) { + return true; + } + if (attempt == SaveAttempt.PERSISTENT_FAILURE) { + return false; + } + AutosaveTicket ticket = autosaves.get(new AutosaveKey(requestId, bay.stableId())); + if (ticket != null) { + expediteAutosave( + ticket, + attempt == SaveAttempt.RETRY + ? AUTOSAVE_RETRY_TICKS + : AUTOSAVE_DEBOUNCE_TICKS); + } + return false; + } + + void scheduleAutosave( + ActiveStudio studio, + JigsawStudioBay bay, + JigsawStudioSession.DirtyIdentity identity, + int delayTicks + ) { + UUID requestId = studio.generator().getRequest().requestId(); + AutosaveKey key = new AutosaveKey(requestId, bay.stableId()); + AutosaveTicket ticket = new AutosaveTicket( + key, + studio, + identity, + new AtomicBoolean(false), + new AtomicBoolean(false)); + autosaves.put(key, ticket); + scheduleAutosave(ticket, delayTicks); + } + + void scheduleAutosave(AutosaveTicket ticket, int delayTicks) { + if (autosaves.get(ticket.key()) != ticket + || !ticket.scheduled().compareAndSet(false, true)) { + return; + } + JigsawStudioBay bay = resolveAutosaveBay(ticket); + if (bay == null) { + ticket.scheduled().set(false); + return; + } + JigsawStudioBounds bounds = bay.bounds(); + boolean scheduled = J.runRegion( + ticket.studio().world(), + bounds.originX() >> 4, + bounds.originZ() >> 4, + () -> runAutosave(ticket), + delayTicks); + if (!scheduled) { + ticket.scheduled().set(false); + if (ticket.scheduleFailureLogged().compareAndSet(false, true)) { + IrisLogging.warn("Jigsaw Studio autosave could not schedule workcell %s for request %s; Iris will keep retrying", + ticket.key().workcellId(), ticket.key().requestId()); + } + scheduleAutosaveReconciliation(ticket); + } + } + + private JigsawStudioBay resolveAutosaveBay(AutosaveTicket ticket) { + if (autosaves.get(ticket.key()) != ticket) { + return null; + } + JigsawStudioBay bay = resolveCurrentAutosaveBay( + ticket.studio().generator().getSession(), + ticket.key().workcellId()); + if (bay != null) { + return bay; + } + if (autosaves.remove(ticket.key(), ticket)) { + reportAutosaveFailure( + ticket, + new AutosavePersistentFailure( + "workcell is absent from the current Studio layout; pending ticket retired", + null)); + } + return null; + } + + static JigsawStudioBay resolveCurrentAutosaveBay( + JigsawStudioSession session, + String workcellId + ) { + JigsawStudioSession activeSession = Objects.requireNonNull( + session, + "Jigsaw Studio autosave session"); + return activeSession.layout().get(Objects.requireNonNull( + workcellId, + "Jigsaw Studio autosave workcell ID")); + } + + boolean retainCurrentAutosaveFailure( + ActiveStudio studio, + String workcellId, + AutosavePersistentFailure failure + ) { + AutosaveKey key = new AutosaveKey( + studio.generator().getRequest().requestId(), + workcellId); + AutosaveTicket ticket = autosaves.get(key); + return ticket != null && retainPersistentAutosaveFailure(ticket, failure); + } + + AutosaveFailureState autosaveFailureState( + ActiveStudio studio, + JigsawStudioSession.SaveIdentity saveIdentity + ) { + AutosaveKey key = new AutosaveKey( + studio.generator().getRequest().requestId(), + saveIdentity.workcellId()); + AutosaveTicket ticket = autosaves.get(key); + return ticket != null && matchesSaveIdentity(ticket.identity(), saveIdentity) + ? ticket.failureState() + : new AutosaveFailureState(); + } + + private boolean retainPersistentAutosaveFailure( + AutosaveTicket ticket, + AutosavePersistentFailure failure + ) { + if (autosaves.get(ticket.key()) != ticket + || !service.isCurrentRequest(ticket.studio(), ticket.key().requestId()) + || !ticket.studio().generator().getSession().isDirtyCurrent(ticket.identity())) { + return false; + } + AutosaveFailureDecision decision = reportAutosaveFailure(ticket, failure); + expediteAutosave(ticket, decision.retryTicks()); + return true; + } + + private static AutosaveFailureDecision reportAutosaveFailure( + AutosaveTicket ticket, + AutosavePersistentFailure failure + ) { + JigsawStudioActivation.Request request = ticket.studio().generator().getRequest(); + return recordPersistentAutosaveFailure( + ticket.failureState(), + ticket.key().requestId(), + request.structureKey(), + ticket.key().workcellId(), + ticket.identity().variantKey(), + failure.detail(), + failure.cause()); + } + + private static void reportPersistentSaveFailure( + ActiveStudio studio, + JigsawStudioSession.SaveIdentity saveIdentity, + AutosaveFailureState failureState, + AutosavePersistentFailure failure + ) { + JigsawStudioActivation.Request request = studio.generator().getRequest(); + recordPersistentAutosaveFailure( + failureState, + request.requestId(), + request.structureKey(), + saveIdentity.workcellId(), + saveIdentity.variantKey(), + failure.detail(), + failure.cause()); + } + + static AutosaveFailureDecision recordPersistentAutosaveFailure( + AutosaveFailureState state, + UUID requestId, + String structureKey, + String workcellId, + String pieceKey, + String detail, + Throwable cause + ) { + AutosaveFailureState activeState = Objects.requireNonNull( + state, + "Jigsaw Studio autosave failure state"); + AutosaveFailureDecision decision = activeState.recordPersistentFailure(); + if (!decision.logFailure()) { + return decision; + } + String context = autosaveFailureContext( + requestId, + structureKey, + workcellId, + pieceKey, + detail); + if (cause == null) { + IrisLogging.warn("%s", context); + } else { + IrisLogging.reportError(context, cause); + } + return decision; + } + + static String autosaveFailureContext( + UUID requestId, + String structureKey, + String workcellId, + String pieceKey, + String detail + ) { + return "Jigsaw Studio save failure: request=" + + Objects.requireNonNull(requestId, "Jigsaw Studio autosave request ID") + + " structure=" + + Objects.requireNonNull(structureKey, "Jigsaw Studio autosave structure key") + + " workcell=" + + Objects.requireNonNull(workcellId, "Jigsaw Studio autosave workcell ID") + + " piece=" + + Objects.requireNonNull(pieceKey, "Jigsaw Studio autosave piece key") + + " failure=" + + Objects.requireNonNull(detail, "Jigsaw Studio autosave failure detail"); + } + + static int persistentAutosaveRetryTicks(int failureCount) { + int index = Math.max(0, Math.min( + failureCount - 1, + AUTOSAVE_PERSISTENT_RETRY_DELAYS.size() - 1)); + return AUTOSAVE_PERSISTENT_RETRY_DELAYS.get(index); + } + + private void scheduleAutosaveReconciliation(AutosaveTicket ticket) { + try { + J.s(() -> { + if (autosaves.get(ticket.key()) == ticket + && !ticket.scheduled().get()) { + scheduleAutosave(ticket, AUTOSAVE_RETRY_TICKS); + } + }, AUTOSAVE_RETRY_TICKS); + } catch (Throwable exception) { + IrisLogging.reportError(exception); + } + } + + private void runAutosave(AutosaveTicket ticket) { + if (autosaves.get(ticket.key()) != ticket) { + return; + } + ticket.scheduled().set(false); + ActiveStudio studio = ticket.studio(); + JigsawStudioSession session = studio.generator().getSession(); + if (!service.isCurrentRequest(studio, ticket.key().requestId())) { + autosaves.remove(ticket.key(), ticket); + return; + } + JigsawStudioBay bay = resolveAutosaveBay(ticket); + if (bay == null) { + return; + } + if (!session.isDirtyCurrent(ticket.identity())) { + autosaves.remove(ticket.key(), ticket); + return; + } + SaveAttempt attempt = service.saveLifecycle.startSave(studio, studio.world(), bay, null, false); + if (attempt == SaveAttempt.STARTED || attempt == SaveAttempt.PERSISTENT_FAILURE) { + return; + } + scheduleAutosave( + ticket, + attempt == SaveAttempt.RETRY + ? AUTOSAVE_RETRY_TICKS + : AUTOSAVE_DEBOUNCE_TICKS); + } + + void completeAutosaveAttempt( + ActiveStudio studio, + JigsawStudioSession.SaveIdentity saveIdentity, + AutosaveFailureState failureState, + AutosavePersistentFailure persistentFailure + ) { + AutosaveKey key = new AutosaveKey( + studio.generator().getRequest().requestId(), + saveIdentity.workcellId()); + AutosaveTicket ticket = autosaves.get(key); + if (ticket == null || !matchesSaveIdentity(ticket.identity(), saveIdentity)) { + if (persistentFailure != null) { + reportPersistentSaveFailure(studio, saveIdentity, failureState, persistentFailure); + } + return; + } + if (resolveAutosaveBay(ticket) == null) { + return; + } + if (!studio.generator().getSession().isDirtyCurrent(ticket.identity())) { + autosaves.remove(key, ticket); + return; + } + if (persistentFailure != null) { + retainPersistentAutosaveFailure(ticket, persistentFailure); + return; + } + scheduleAutosave(ticket, AUTOSAVE_RETRY_TICKS); + } + + private static boolean matchesSaveIdentity( + JigsawStudioSession.DirtyIdentity dirtyIdentity, + JigsawStudioSession.SaveIdentity saveIdentity + ) { + return dirtyIdentity.sessionId().equals(saveIdentity.sessionId()) + && dirtyIdentity.workcellId().equals(saveIdentity.workcellId()) + && dirtyIdentity.variantKey().equals(saveIdentity.variantKey()) + && dirtyIdentity.loadGeneration() == saveIdentity.loadGeneration() + && dirtyIdentity.mutationGeneration() == saveIdentity.mutationGeneration(); + } + + void drainAutosavesBeforeDisable() { + for (ActiveStudio studio : List.copyOf(service.studios.values())) { + try { + drainAutosavesBeforeRemoval(studio); + } catch (Throwable exception) { + IrisLogging.reportError( + "Failed to drain Jigsaw Studio autosaves in world " + + studio.worldId() + " during shutdown.", + exception); + } + } + if (!autosaves.isEmpty()) { + IrisLogging.warn("Jigsaw Studio disabled with %d autosave operation(s) still pending after the final drain attempt", + autosaves.size()); + } + } + + void drainAutosavesBeforeRemoval(ActiveStudio studio) { + if (studio == null) { + return; + } + UUID requestId = studio.generator().getRequest().requestId(); + if (service.saveLifecycle.discardingRequest(requestId)) { + return; + } + if (J.isFolia() || !J.isPrimaryThread()) { + expediteAutosaves(requestId); + return; + } + for (AutosaveTicket ticket : List.copyOf(autosaves.values())) { + if (requestId.equals(ticket.key().requestId())) { + drainAutosaveSynchronously(ticket); + } + } + } + + private boolean drainAutosaveSynchronously(AutosaveTicket ticket) { + if (autosaves.get(ticket.key()) != ticket) { + return true; + } + ActiveStudio studio = ticket.studio(); + JigsawStudioSession session = studio.generator().getSession(); + if (!service.isCurrentRequest(studio, ticket.key().requestId())) { + autosaves.remove(ticket.key(), ticket); + return true; + } + JigsawStudioBay bay = resolveAutosaveBay(ticket); + if (bay == null) { + return false; + } + if (!session.isDirtyCurrent(ticket.identity())) { + autosaves.remove(ticket.key(), ticket); + return true; + } + JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); + if (activeVariant == null || !activeVariant.owned()) { + return false; + } + BayReadiness readiness = studio.population(bay).readiness(); + if (!readiness.ready()) { + return false; + } + CaptureTarget captureTarget; + try { + captureTarget = resolveCaptureTarget(studio, bay, activeVariant); + } catch (IOException exception) { + retainPersistentAutosaveFailure( + ticket, + new AutosavePersistentFailure( + "Jigsaw Studio cannot capture this workcell: " + failureMessage(exception), + exception)); + return false; + } + JigsawStudioSession.SaveStart sessionSave = session.beginSave(bay.stableId()); + if (sessionSave.status() != JigsawStudioSession.SaveStatus.STARTED) { + return false; + } + JigsawStudioSession.SaveIdentity saveIdentity = sessionSave.identity().orElseThrow(); + if (service.saveLifecycle.tryBeginSave(ticket.key().requestId()) != SaveStart.STARTED) { + session.abortSave(saveIdentity); + return false; + } + List areas = chunkIntersections(captureTarget.bounds()); + CaptureWork work = new CaptureWork( + studio, + studio.world(), + bay, + captureTarget, + null, + ticket.key().requestId(), + saveIdentity, + ticket.failureState()); + CaptureCoordinator coordinator = + service.captureScheduler.coordinator(work, areas); + List snapshots = new ArrayList<>(areas.size()); + try { + for (ChunkCaptureArea area : areas) { + if (!studio.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { + throw new IOException("Workcell chunk " + area.chunkX() + "," + area.chunkZ() + + " is not loaded during the final autosave drain"); + } + snapshots.add(captureChunkIntersection( + studio.world(), + captureTarget.bounds(), + captureTarget.piece(), + captureTarget.object(), + area, + captureTarget.displayRotationQuarterTurns(), + captureTarget.connectorsVisible())); + } + service.captureScheduler.assembleAndPersist(coordinator, snapshots); + } catch (Throwable exception) { + coordinator.fail("Jigsaw Studio final autosave drain failed: " + + failureMessage(exception), exception); + } + return !session.isDirtyCurrent(ticket.identity()); + } + + void expediteAutosaves(UUID requestId) { + if (requestId == null) { + return; + } + for (AutosaveTicket current : List.copyOf(autosaves.values())) { + if (!requestId.equals(current.key().requestId())) { + continue; + } + expediteAutosave(current, 0); + } + } + + private void expediteAutosave(AutosaveTicket current, int delayTicks) { + AutosaveTicket expedited = new AutosaveTicket( + current.key(), + current.studio(), + current.identity(), + new AtomicBoolean(false), + current.scheduleFailureLogged(), + current.failureState()); + if (autosaves.replace(current.key(), current, expedited)) { + scheduleAutosave(expedited, delayTicks); + } + } + + void clearAutosaves(UUID requestId) { + if (requestId != null) { + autosaves.keySet().removeIf(key -> key.requestId().equals(requestId)); + } + } + + record AutosaveKey(UUID requestId, String workcellId) { + AutosaveKey { + Objects.requireNonNull(requestId, "Jigsaw Studio autosave request ID"); + Objects.requireNonNull(workcellId, "Jigsaw Studio autosave workcell ID"); + } + } + + static final class AutosaveFailureState { + private final AtomicInteger persistentFailures = new AtomicInteger(); + private final AtomicBoolean failureLogged = new AtomicBoolean(false); + + AutosaveFailureDecision recordPersistentFailure() { + int failureCount = persistentFailures.incrementAndGet(); + return new AutosaveFailureDecision( + persistentAutosaveRetryTicks(failureCount), + failureLogged.compareAndSet(false, true)); + } + } + + record AutosaveFailureDecision(int retryTicks, boolean logFailure) { + } + + record AutosavePersistentFailure(String detail, Throwable cause) { + AutosavePersistentFailure { + Objects.requireNonNull(detail, "Jigsaw Studio persistent autosave failure detail"); + } + } + + private record AutosaveTicket( + AutosaveKey key, + ActiveStudio studio, + JigsawStudioSession.DirtyIdentity identity, + AtomicBoolean scheduled, + AtomicBoolean scheduleFailureLogged, + AutosaveFailureState failureState + ) { + private AutosaveTicket( + AutosaveKey key, + ActiveStudio studio, + JigsawStudioSession.DirtyIdentity identity, + AtomicBoolean scheduled, + AtomicBoolean scheduleFailureLogged + ) { + this( + key, + studio, + identity, + scheduled, + scheduleFailureLogged, + new AutosaveFailureState()); + } + + private AutosaveTicket { + Objects.requireNonNull(key, "Jigsaw Studio autosave key"); + Objects.requireNonNull(studio, "Jigsaw Studio autosave studio"); + Objects.requireNonNull(identity, "Jigsaw Studio autosave dirty identity"); + Objects.requireNonNull(scheduled, "Jigsaw Studio autosave schedule state"); + Objects.requireNonNull(scheduleFailureLogged, "Jigsaw Studio autosave schedule warning state"); + Objects.requireNonNull(failureState, "Jigsaw Studio autosave failure state"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCapture.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCapture.java new file mode 100644 index 000000000..d03bcd810 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCapture.java @@ -0,0 +1,697 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarArchetype; +import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarDirection; +import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarTopology; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.engine.object.IrisDirection; +import art.arcane.iris.engine.object.IrisJigsawConnector; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.engine.object.IrisObjectRotation; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.engine.object.JigsawJoint; +import art.arcane.iris.engine.object.TileData; +import art.arcane.iris.platform.bukkit.BukkitBlockState; +import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.iris.util.common.data.B; +import art.arcane.volmlib.util.collection.KMap; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.block.Block; +import org.bukkit.block.data.BlockData; +import org.bukkit.block.data.type.Jigsaw; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Set; + +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.restoreCapturedMetadataForDisplay; +import static art.arcane.iris.core.service.JigsawStudioService.chunkKey; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; + +final class JigsawStudioCapture { + private static final Comparator NEW_CONNECTOR_SOURCE_POSITION_ORDER = Comparator + .comparingInt((IrisJigsawConnector connector) -> connector.getPosition().getX()) + .thenComparingInt(connector -> connector.getPosition().getY()) + .thenComparingInt(connector -> connector.getPosition().getZ()); + + private JigsawStudioCapture() { + } + + static List chunkIntersections(JigsawStudioBounds bounds) { + JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); + List areas = new ArrayList<>(); + int minimumChunkX = captureBounds.originX() >> 4; + int maximumChunkX = captureBounds.maxX() >> 4; + int minimumChunkZ = captureBounds.originZ() >> 4; + int maximumChunkZ = captureBounds.maxZ() >> 4; + for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { + int chunkOriginX = chunkX << 4; + int minimumX = Math.max(0, chunkOriginX - captureBounds.originX()); + int maximumX = Math.min( + captureBounds.dimensions().width(), + chunkOriginX + 16 - captureBounds.originX()); + for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { + int chunkOriginZ = chunkZ << 4; + int minimumZ = Math.max(0, chunkOriginZ - captureBounds.originZ()); + int maximumZ = Math.min( + captureBounds.dimensions().depth(), + chunkOriginZ + 16 - captureBounds.originZ()); + areas.add(new ChunkCaptureArea( + chunkX, + chunkZ, + minimumX, + maximumX, + minimumZ, + maximumZ)); + } + } + return List.copyOf(areas); + } + + static ChunkSnapshot captureChunkIntersection( + World world, + JigsawStudioBounds bounds, + IrisJigsawPiece sourcePiece, + IrisObject sourceObject, + ChunkCaptureArea area + ) throws IOException { + return captureChunkIntersection(world, bounds, sourcePiece, sourceObject, area, 0); + } + + static ChunkSnapshot captureChunkIntersection( + World world, + JigsawStudioBounds bounds, + IrisJigsawPiece sourcePiece, + IrisObject sourceObject, + ChunkCaptureArea area, + int displayRotationQuarterTurns + ) throws IOException { + return captureChunkIntersection( + world, + bounds, + sourcePiece, + sourceObject, + area, + displayRotationQuarterTurns, + true); + } + + static ChunkSnapshot captureChunkIntersection( + World world, + JigsawStudioBounds bounds, + IrisJigsawPiece sourcePiece, + IrisObject sourceObject, + ChunkCaptureArea area, + int displayRotationQuarterTurns, + boolean connectorsVisible + ) throws IOException { + World captureWorld = Objects.requireNonNull(world, "Jigsaw Studio capture world"); + JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); + IrisObject captureSource = Objects.requireNonNull(sourceObject, "Jigsaw Studio source object"); + ChunkCaptureArea captureArea = Objects.requireNonNull(area, "Jigsaw Studio chunk capture area"); + int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); + int sourceWidth = (quarterTurns & 1) == 0 + ? captureBounds.dimensions().width() + : captureBounds.dimensions().depth(); + int sourceDepth = (quarterTurns & 1) == 0 + ? captureBounds.dimensions().depth() + : captureBounds.dimensions().width(); + List blocks = new ArrayList<>(); + List connectors = new ArrayList<>(); + Map hiddenConnectors = connectorsVisible + ? Map.of() + : displayedSourceConnectors(sourcePiece, captureBounds.dimensions(), quarterTurns); + for (int x = captureArea.minimumX(); x < captureArea.maximumX(); x++) { + for (int y = 0; y < bounds.dimensions().height(); y++) { + for (int z = captureArea.minimumZ(); z < captureArea.maximumZ(); z++) { + Block block = captureWorld.getBlockAt( + captureBounds.originX() + x, + captureBounds.originY() + y, + captureBounds.originZ() + z); + BlockData blockData = block.getBlockData(); + IrisJigsawConnector hiddenConnector = hiddenConnectors.get(new LocalPosition(x, y, z)); + if (hiddenConnector != null) { + hiddenConnector.setFinalState(blockData.getAsString()); + connectors.add(CapturedConnector.from(hiddenConnector)); + } + if (hiddenConnector == null && blockData instanceof Jigsaw jigsaw) { + KMap nbt = BukkitPlatform.serializeTile(block.getLocation()); + if (nbt == null) { + throw new IOException("Cannot read jigsaw marker NBT at " + + block.getX() + "," + block.getY() + "," + block.getZ() + + ". The active NMS binding must support tile serialization."); + } + IrisJigsawConnector connector; + try { + connector = JigsawStudioMarkerParser.parse(nbt, jigsaw.getOrientation(), x, y, z); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid jigsaw marker at " + + block.getX() + "," + block.getY() + "," + block.getZ() + + ": " + failureMessage(exception), exception); + } + restoreCapturedMetadataForDisplay( + connector, + sourcePiece, + captureBounds.dimensions(), + quarterTurns); + BlockData finalData; + try { + finalData = Bukkit.createBlockData(connector.getFinalState()); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid final_state '" + connector.getFinalState() + + "' at " + block.getX() + "," + block.getY() + "," + block.getZ(), exception); + } + connector.setFinalState(finalData.getAsString()); + connectors.add(CapturedConnector.from(connector)); + if (finalData.getMaterial() != Material.STRUCTURE_VOID) { + blocks.add(new CapturedBlock( + x, + y, + z, + BukkitBlockState.of(finalData), + null)); + } + continue; + } + if (isAir(blockData.getMaterial())) { + LocalPosition sourcePosition = inversePosition( + x, + y, + z, + sourceWidth, + sourceDepth, + quarterTurns); + PlatformBlockState retainedAir = retainedSourceAir( + captureSource, + sourcePosition.x(), + sourcePosition.y(), + sourcePosition.z(), + blockData); + if (retainedAir != null) { + blocks.add(new CapturedBlock(x, y, z, retainedAir, null)); + } + continue; + } + if (blockData.getMaterial() == Material.STRUCTURE_VOID) { + continue; + } + blocks.add(new CapturedBlock( + x, + y, + z, + BukkitBlockState.of(blockData), + TileData.getTileState(block, false))); + } + } + } + return new ChunkSnapshot(captureArea, blocks, connectors); + } + + private static Map displayedSourceConnectors( + IrisJigsawPiece sourcePiece, + JigsawStudioCellDimensions displayDimensions, + int displayRotationQuarterTurns + ) throws IOException { + IrisJigsawPiece source = Objects.requireNonNull(sourcePiece, "Jigsaw Studio source piece"); + if (source.getConnectors() == null) { + throw new IOException("Jigsaw Studio source piece has no connector list"); + } + int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); + int sourceWidth = (quarterTurns & 1) == 0 + ? displayDimensions.width() + : displayDimensions.depth(); + int sourceDepth = (quarterTurns & 1) == 0 + ? displayDimensions.depth() + : displayDimensions.width(); + IrisObjectRotation rotation = IrisObjectRotation.of(0, -90.0D * quarterTurns, 0); + Map displayed = new HashMap<>(source.getConnectors().size()); + for (IrisJigsawConnector sourceConnector : source.getConnectors()) { + LocalPosition sourcePosition = connectorPosition(sourceConnector, "source piece"); + LocalPosition position = forwardPosition( + sourcePosition.x(), + sourcePosition.y(), + sourcePosition.z(), + sourceWidth, + sourceDepth, + quarterTurns); + IrisJigsawConnector connector = CapturedConnector.from(sourceConnector).toConnector() + .setPosition(new IrisPosition(position.x(), position.y(), position.z())) + .setDirection(rotation.rotate(sourceConnector.getDirection())) + .setTop(rotation.rotate(sourceConnector.getTop())); + if (displayed.put(position, connector) != null) { + throw new IOException("Jigsaw Studio source piece has duplicate displayed connector position " + + connectorLocation(position)); + } + } + return Map.copyOf(displayed); + } + + static PlatformBlockState retainedSourceAir( + IrisObject sourceObject, + int x, + int y, + int z, + BlockData current + ) { + IrisObject source = Objects.requireNonNull(sourceObject, "Jigsaw Studio source object"); + BlockData currentState = Objects.requireNonNull(current, "Jigsaw Studio current block state"); + if (!isAir(currentState.getMaterial()) + || x < 0 + || y < 0 + || z < 0 + || x >= source.getW() + || y >= source.getH() + || z >= source.getD()) { + return null; + } + PlatformBlockState original = source.getBlocks().get(source.getSigned(x, y, z)); + return original != null && original.isAir() ? original : null; + } + + private static boolean isAir(Material material) { + return material == Material.AIR || material == Material.CAVE_AIR || material == Material.VOID_AIR; + } + + static Capture aggregateSnapshots( + JigsawStudioBounds bounds, + List expectedAreas, + List snapshots + ) throws IOException { + return aggregateSnapshots(bounds, expectedAreas, snapshots, 0); + } + + static Capture aggregateSnapshots( + JigsawStudioBounds bounds, + List expectedAreas, + List snapshots, + int displayRotationQuarterTurns + ) throws IOException { + JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); + int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); + List requiredAreas = List.copyOf(expectedAreas); + List capturedSnapshots = List.copyOf(snapshots); + Map requiredByChunk = new HashMap<>(); + for (ChunkCaptureArea area : requiredAreas) { + if (requiredByChunk.put(chunkKey(area.chunkX(), area.chunkZ()), area) != null) { + throw new IOException("Duplicate required bay chunk " + area.chunkX() + "," + area.chunkZ()); + } + } + if (capturedSnapshots.size() != requiredByChunk.size()) { + throw new IOException("Expected " + requiredByChunk.size() + " bay chunk snapshot(s), received " + + capturedSnapshots.size()); + } + Map capturedByChunk = new HashMap<>(); + for (ChunkSnapshot snapshot : capturedSnapshots) { + ChunkCaptureArea area = snapshot.area(); + long key = chunkKey(area.chunkX(), area.chunkZ()); + ChunkCaptureArea required = requiredByChunk.get(key); + if (!area.equals(required)) { + throw new IOException("Unexpected bay chunk intersection for " + + area.chunkX() + "," + area.chunkZ()); + } + if (capturedByChunk.put(key, snapshot) != null) { + throw new IOException("Duplicate bay chunk snapshot " + area.chunkX() + "," + area.chunkZ()); + } + } + if (!capturedByChunk.keySet().containsAll(requiredByChunk.keySet())) { + throw new IOException("One or more required bay chunk snapshots are missing"); + } + + List ordered = new ArrayList<>(capturedSnapshots); + ordered.sort(Comparator + .comparingInt((ChunkSnapshot snapshot) -> snapshot.area().chunkX()) + .thenComparingInt(snapshot -> snapshot.area().chunkZ())); + int sourceWidth = (quarterTurns & 1) == 0 + ? captureBounds.dimensions().width() + : captureBounds.dimensions().depth(); + int sourceDepth = (quarterTurns & 1) == 0 + ? captureBounds.dimensions().depth() + : captureBounds.dimensions().width(); + IrisObject object = new IrisObject( + sourceWidth, + captureBounds.dimensions().height(), + sourceDepth); + IrisObjectRotation inverseRotation = IrisObjectRotation.of(0, 90.0D * quarterTurns, 0); + List connectors = new ArrayList<>(); + Set capturedBlocks = new HashSet<>(); + Set capturedConnectors = new HashSet<>(); + boolean hasBlockEntities = false; + for (ChunkSnapshot snapshot : ordered) { + ChunkCaptureArea area = snapshot.area(); + for (CapturedBlock block : snapshot.blocks()) { + if (!area.contains(block.x(), block.z()) + || block.y() < 0 + || block.y() >= captureBounds.dimensions().height()) { + throw new IOException("Captured block falls outside bay chunk " + + area.chunkX() + "," + area.chunkZ()); + } + LocalPosition position = inversePosition( + block.x(), block.y(), block.z(), sourceWidth, sourceDepth, quarterTurns); + if (!capturedBlocks.add(position)) { + throw new IOException("Duplicate captured block at " + + block.x() + "," + block.y() + "," + block.z()); + } + PlatformBlockState sourceState = quarterTurns == 0 + ? block.state() + : inverseRotation.rotate(block.state(), 0, 0, 0); + if (sourceState == null) { + throw new IOException("Captured block state cannot be inverse-rotated at " + + block.x() + "," + block.y() + "," + block.z()); + } + object.setUnsigned(position.x(), position.y(), position.z(), sourceState); + TileData tileData = block.tileData(); + if (tileData != null) { + object.setUnsignedTile(position.x(), position.y(), position.z(), tileData.clone()); + hasBlockEntities = true; + } + } + for (CapturedConnector capturedConnector : snapshot.connectors()) { + if (!area.contains(capturedConnector.x(), capturedConnector.z()) + || capturedConnector.y() < 0 + || capturedConnector.y() >= captureBounds.dimensions().height()) { + throw new IOException("Captured connector falls outside bay chunk " + + area.chunkX() + "," + area.chunkZ()); + } + LocalPosition position = inversePosition( + capturedConnector.x(), + capturedConnector.y(), + capturedConnector.z(), + sourceWidth, + sourceDepth, + quarterTurns); + if (!capturedConnectors.add(position)) { + throw new IOException("Duplicate captured connector at " + + capturedConnector.x() + "," + capturedConnector.y() + "," + + capturedConnector.z()); + } + IrisJigsawConnector connector = capturedConnector.toConnector(); + if (quarterTurns != 0) { + connector.setPosition(new IrisPosition(position.x(), position.y(), position.z())); + connector.setDirection(inverseRotation.rotate(connector.getDirection())); + connector.setTop(inverseRotation.rotate(connector.getTop())); + PlatformBlockState finalState = B.getStateOrNull(connector.getFinalState(), false); + if (finalState == null) { + throw new IOException("Captured connector final state cannot be parsed at " + + capturedConnector.x() + "," + capturedConnector.y() + "," + + capturedConnector.z()); + } + PlatformBlockState sourceFinalState = inverseRotation.rotate(finalState, 0, 0, 0); + if (sourceFinalState == null) { + throw new IOException("Captured connector final state cannot be inverse-rotated at " + + capturedConnector.x() + "," + capturedConnector.y() + "," + + capturedConnector.z()); + } + connector.setFinalState(sourceFinalState.key()); + } + connectors.add(connector); + } + } + try (ByteArrayOutputStream output = new ByteArrayOutputStream()) { + object.write(output); + return new Capture(output.toByteArray(), connectors, hasBlockEntities); + } + } + + static List preserveCapturedConnectorOrder( + IrisJigsawPiece sourcePiece, + List capturedConnectors + ) throws IOException { + IrisJigsawPiece source = Objects.requireNonNull(sourcePiece, "Jigsaw Studio source piece"); + List sourceConnectors = source.getConnectors(); + if (sourceConnectors == null) { + throw new IOException("Jigsaw Studio source piece has no connector list"); + } + List captured = new ArrayList<>(Objects.requireNonNull( + capturedConnectors, + "Jigsaw Studio captured connectors")); + Map capturedByPosition = new HashMap<>(captured.size()); + for (IrisJigsawConnector connector : captured) { + LocalPosition position = connectorPosition(connector, "captured"); + if (capturedByPosition.put(position, connector) != null) { + throw new IOException("Jigsaw Studio capture has duplicate connector position " + + connectorLocation(position)); + } + } + + List ordered = new ArrayList<>(captured.size()); + Set sourcePositions = new HashSet<>(sourceConnectors.size()); + for (IrisJigsawConnector connector : sourceConnectors) { + LocalPosition position = connectorPosition(connector, "source piece"); + if (!sourcePositions.add(position)) { + throw new IOException("Jigsaw Studio source piece has duplicate connector position " + + connectorLocation(position)); + } + IrisJigsawConnector matched = capturedByPosition.remove(position); + if (matched != null) { + ordered.add(matched); + } + } + + List appended = new ArrayList<>(capturedByPosition.values()); + appended.sort(NEW_CONNECTOR_SOURCE_POSITION_ORDER); + ordered.addAll(appended); + return List.copyOf(ordered); + } + + private static LocalPosition connectorPosition(IrisJigsawConnector connector, String owner) throws IOException { + if (connector == null || connector.getPosition() == null) { + throw new IOException("Jigsaw Studio " + owner + " contains a connector without a position"); + } + IrisPosition position = connector.getPosition(); + return new LocalPosition(position.getX(), position.getY(), position.getZ()); + } + + private static String connectorLocation(LocalPosition position) { + return position.x() + "," + position.y() + "," + position.z(); + } + + static LocalPosition inversePosition( + int x, + int y, + int z, + int sourceWidth, + int sourceDepth, + int displayRotationQuarterTurns + ) { + return switch (Math.floorMod(displayRotationQuarterTurns, 4)) { + case 0 -> new LocalPosition(x, y, z); + case 1 -> new LocalPosition(z, y, sourceDepth - 1 - x); + case 2 -> new LocalPosition(sourceWidth - 1 - x, y, sourceDepth - 1 - z); + case 3 -> new LocalPosition(sourceWidth - 1 - z, y, x); + default -> throw new IllegalStateException("Unreachable Jigsaw Studio inverse rotation"); + }; + } + + private static LocalPosition forwardPosition( + int x, + int y, + int z, + int sourceWidth, + int sourceDepth, + int displayRotationQuarterTurns + ) { + return switch (Math.floorMod(displayRotationQuarterTurns, 4)) { + case 0 -> new LocalPosition(x, y, z); + case 1 -> new LocalPosition(sourceDepth - 1 - z, y, x); + case 2 -> new LocalPosition(sourceWidth - 1 - x, y, sourceDepth - 1 - z); + case 3 -> new LocalPosition(z, y, sourceWidth - 1 - x); + default -> throw new IllegalStateException("Unreachable Jigsaw Studio display rotation"); + }; + } + + static void requireWorkcellTopology( + JigsawStudioBay workcell, + List connectors, + int displayRotationQuarterTurns + ) throws IOException { + JigsawPlanarArchetype expected = workcell.archetype().orElse(null); + if (expected == null) { + return; + } + int mask = 0; + for (IrisJigsawConnector connector : connectors) { + mask |= switch (connector.getDirection()) { + case NORTH_NEGATIVE_Z -> JigsawPlanarDirection.NORTH.bit(); + case EAST_POSITIVE_X -> JigsawPlanarDirection.EAST.bit(); + case SOUTH_POSITIVE_Z -> JigsawPlanarDirection.SOUTH.bit(); + case WEST_NEGATIVE_X -> JigsawPlanarDirection.WEST.bit(); + case UP_POSITIVE_Y, DOWN_NEGATIVE_Y -> throw new WorkcellTopologyException( + "Planar workcell '" + workcell.stableId() + + "' cannot save a vertical connector. Remove it or use Reset Connector Blocks."); + }; + } + JigsawPlanarTopology sourceTopology = JigsawPlanarTopology.fromMask(mask); + JigsawPlanarTopology displayedTopology = sourceTopology.rotateClockwise(displayRotationQuarterTurns); + if (displayedTopology != expected.canonicalTopology()) { + throw new WorkcellTopologyException("Workcell '" + workcell.stableId() + "' requires " + + topologyDescription(expected.canonicalTopology()) + + ", but the edited markers form " + + topologyDescription(displayedTopology) + + ". Use Reset Connector Blocks to restore the saved topology, or edit the markers to match the floor glyph."); + } + } + + private static String topologyDescription(JigsawPlanarTopology topology) { + int connectorCount = topology.directions().size(); + return topology.name().toLowerCase(Locale.ROOT).replace('_', ' ') + + " (" + connectorCount + " horizontal connector" + + (connectorCount == 1 ? "" : "s") + ")"; + } + + static void storeConnectorFinalState( + IrisObject object, + int x, + int y, + int z, + BlockData finalData + ) { + Objects.requireNonNull(object, "Jigsaw Studio captured object"); + BlockData activeFinalData = Objects.requireNonNull(finalData, "Jigsaw connector final state"); + if (activeFinalData.getMaterial() != Material.STRUCTURE_VOID) { + object.setUnsigned(x, y, z, BukkitBlockState.of(activeFinalData)); + } + } + + record ChunkCaptureArea( + int chunkX, + int chunkZ, + int minimumX, + int maximumX, + int minimumZ, + int maximumZ + ) { + ChunkCaptureArea { + if (minimumX < 0 || minimumZ < 0 || maximumX <= minimumX || maximumZ <= minimumZ) { + throw new IllegalArgumentException("Jigsaw Studio chunk capture intersection is invalid"); + } + } + + boolean contains(int x, int z) { + return x >= minimumX && x < maximumX && z >= minimumZ && z < maximumZ; + } + } + + record CapturedBlock( + int x, + int y, + int z, + PlatformBlockState state, + TileData tileData + ) { + CapturedBlock { + Objects.requireNonNull(state, "Jigsaw Studio captured block state"); + tileData = tileData == null ? null : tileData.clone(); + } + + public TileData tileData() { + return tileData == null ? null : tileData.clone(); + } + } + + record CapturedConnector( + int x, + int y, + int z, + IrisDirection direction, + IrisDirection top, + String pool, + String name, + String targetName, + String channel, + JigsawJoint joint, + String finalState, + int selectionPriority, + int placementPriority + ) { + CapturedConnector { + Objects.requireNonNull(direction, "Jigsaw Studio captured connector direction"); + Objects.requireNonNull(top, "Jigsaw Studio captured connector top"); + Objects.requireNonNull(pool, "Jigsaw Studio captured connector pool"); + Objects.requireNonNull(name, "Jigsaw Studio captured connector name"); + Objects.requireNonNull(targetName, "Jigsaw Studio captured connector target"); + channel = channel == null ? "" : channel; + Objects.requireNonNull(joint, "Jigsaw Studio captured connector joint"); + Objects.requireNonNull(finalState, "Jigsaw Studio captured connector final state"); + } + + static CapturedConnector from(IrisJigsawConnector connector) { + IrisJigsawConnector source = Objects.requireNonNull(connector, "Jigsaw Studio captured connector"); + IrisPosition position = source.getPosition(); + return new CapturedConnector( + position.getX(), + position.getY(), + position.getZ(), + source.getDirection(), + source.getTop(), + source.getPool(), + source.getName(), + source.getTargetName(), + source.getChannel(), + source.getJoint(), + source.getFinalState(), + source.getSelectionPriority(), + source.getPlacementPriority()); + } + + IrisJigsawConnector toConnector() { + return new IrisJigsawConnector() + .setPosition(new IrisPosition(x, y, z)) + .setDirection(direction) + .setTop(top) + .setPool(pool) + .setName(name) + .setTargetName(targetName) + .setChannel(channel) + .setJoint(joint) + .setFinalState(finalState) + .setSelectionPriority(selectionPriority) + .setPlacementPriority(placementPriority); + } + } + + record ChunkSnapshot( + ChunkCaptureArea area, + List blocks, + List connectors + ) { + ChunkSnapshot { + Objects.requireNonNull(area, "Jigsaw Studio captured chunk area"); + blocks = List.copyOf(blocks); + connectors = List.copyOf(connectors); + } + } + + record LocalPosition(int x, int y, int z) { + } + + record Capture(byte[] objectContent, List connectors, boolean hasBlockEntities) { + Capture { + objectContent = Objects.requireNonNull(objectContent, "Jigsaw Studio object content").clone(); + connectors = List.copyOf(connectors); + } + + public byte[] objectContent() { + return objectContent.clone(); + } + } + + static final class WorkcellTopologyException extends IOException { + WorkcellTopologyException(String message) { + super(message); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCaptureScheduler.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCaptureScheduler.java new file mode 100644 index 000000000..19d109ed0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioCaptureScheduler.java @@ -0,0 +1,493 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioAutosaveScheduler.AutosaveFailureState; +import art.arcane.iris.core.service.JigsawStudioAutosaveScheduler.AutosavePersistentFailure; +import art.arcane.iris.core.service.JigsawStudioCapture.Capture; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkCaptureArea; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkSnapshot; +import art.arcane.iris.core.service.JigsawStudioCapture.WorkcellTopologyException; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; +import art.arcane.iris.core.structure.authoring.StructureWriteOptions; +import art.arcane.iris.core.structure.authoring.StructureWriteResult; +import art.arcane.iris.engine.framework.structure.StructureResourceBundleGraphCompiler; +import art.arcane.iris.engine.object.IrisJigsawConnector; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisObject; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.World; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; + +import static art.arcane.iris.core.service.JigsawStudioCapture.aggregateSnapshots; +import static art.arcane.iris.core.service.JigsawStudioCapture.captureChunkIntersection; +import static art.arcane.iris.core.service.JigsawStudioCapture.chunkIntersections; +import static art.arcane.iris.core.service.JigsawStudioCapture.preserveCapturedConnectorOrder; +import static art.arcane.iris.core.service.JigsawStudioCapture.requireWorkcellTopology; +import static art.arcane.iris.core.service.JigsawStudioService.chunkKey; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioService.playSaveSound; +import static art.arcane.iris.core.service.JigsawStudioService.writeFailure; + +final class JigsawStudioCaptureScheduler { + private final JigsawStudioService service; + + JigsawStudioCaptureScheduler(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean scheduleCapture( + ActiveStudio studio, + World world, + JigsawStudioBay bay, + CaptureTarget captureTarget, + Player player, + UUID requestId, + JigsawStudioSession.SaveIdentity saveIdentity, + AutosaveFailureState autosaveFailureState + ) { + List areas = chunkIntersections(captureTarget.bounds()); + CaptureWork work = new CaptureWork( + studio, + world, + bay, + captureTarget, + player, + requestId, + saveIdentity, + autosaveFailureState); + CaptureCoordinator coordinator = new CaptureCoordinator( + work, + areas); + for (ChunkCaptureArea area : areas) { + if (coordinator.stopped()) { + return false; + } + boolean scheduled = J.runRegion( + world, + area.chunkX(), + area.chunkZ(), + () -> captureChunk(coordinator, area)); + if (!scheduled) { + coordinator.fail("Iris could not schedule bay chunk " + + area.chunkX() + "," + area.chunkZ() + " on its owning region.", null); + return false; + } + } + return !coordinator.stopped(); + } + + private void captureChunk(CaptureCoordinator coordinator, ChunkCaptureArea area) { + if (coordinator.stopped()) { + return; + } + ActiveStudio studio = coordinator.studio(); + World world = coordinator.world(); + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + coordinator.fail("Jigsaw Studio changed before every bay chunk could be captured; save cancelled.", null); + return; + } + if (!world.isChunkLoaded(area.chunkX(), area.chunkZ())) { + coordinator.fail("Bay chunk " + area.chunkX() + "," + area.chunkZ() + + " is not loaded. Visit the whole bay and try again.", null); + return; + } + try { + ChunkSnapshot snapshot = captureChunkIntersection( + world, + coordinator.captureTarget().bounds(), + coordinator.captureTarget().piece(), + coordinator.captureTarget().object(), + area, + coordinator.captureTarget().displayRotationQuarterTurns(), + coordinator.captureTarget().connectorsVisible()); + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + coordinator.fail("Jigsaw Studio changed while bay chunks were being captured; save cancelled.", null); + return; + } + coordinator.accept(snapshot); + } catch (Throwable exception) { + coordinator.fail("Jigsaw Studio capture failed in chunk " + + area.chunkX() + "," + area.chunkZ() + ": " + failureMessage(exception), exception); + } + } + + void assembleAndPersist(CaptureCoordinator coordinator, List snapshots) { + if (coordinator.failed()) { + return; + } + ActiveStudio studio = coordinator.studio(); + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + coordinator.fail("Jigsaw Studio changed before captured chunks could be assembled; save cancelled.", null); + return; + } + try { + Capture capture = aggregateSnapshots( + coordinator.captureTarget().bounds(), + coordinator.areas(), + snapshots, + coordinator.captureTarget().displayRotationQuarterTurns()); + List connectors = preserveCapturedConnectorOrder( + coordinator.captureTarget().piece(), + capture.connectors()); + requireWorkcellTopology( + coordinator.bay(), + connectors, + coordinator.captureTarget().displayRotationQuarterTurns()); + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + coordinator.fail("Jigsaw Studio changed before the captured bay could be written; save cancelled.", null); + return; + } + message(coordinator.player(), "Captured " + connectors.size() + + " connector(s) from " + snapshots.size() + + " chunk(s); validating and writing the owned structure graph..."); + persistCapture(coordinator, capture, connectors); + } catch (WorkcellTopologyException exception) { + coordinator.failPersistent( + "Jigsaw Studio cannot autosave this planar workcell: " + + failureMessage(exception), + null); + } catch (Throwable exception) { + coordinator.failPersistent( + "Jigsaw Studio capture assembly failed: " + failureMessage(exception), + exception); + } + } + + private void persistCapture( + CaptureCoordinator coordinator, + Capture capture, + List connectors + ) { + ActiveStudio studio = coordinator.studio(); + JigsawStudioBay bay = coordinator.bay(); + Player player = coordinator.player(); + try { + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + message(player, "Jigsaw Studio changed before the captured bay could be written; save cancelled."); + return; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + IrisData source = request.source(); + Path packRoot = source.getDataFolder().toPath(); + JigsawStudioResourceBundleAssembler.Assembly assembly = + JigsawStudioResourceBundleAssembler.assemble( + packRoot, + request.structureKey(), + coordinator.saveIdentity().variantKey(), + capture.objectContent(), + connectors, + capture.hasBlockEntities()); + StructureResourceBundleGraphCompiler.requireViable(assembly.bundle()); + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + message(player, "Jigsaw Studio changed during validation; save cancelled before writing."); + return; + } + JigsawStudioHistoryStore historyStore = new JigsawStudioHistoryStore( + packRoot, + request.structureKey()); + JigsawStudioHistoryStore.Snapshot previous = historyStore.snapshotCurrent( + coordinator.saveIdentity().variantKey()); + if (!previous.matches(assembly.bundle())) { + historyStore.append(previous); + } + StructureWriteResult result; + synchronized (service.saveLifecycleLock) { + if (!service.saveLifecycle.isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { + message(player, "Jigsaw Studio changed before the validated save entered the writer; save cancelled."); + return; + } + result = new StructureTransactionWriter(packRoot) + .write(assembly.bundle(), StructureWriteOptions.overwriteExpected( + assembly.expectedManifestHash())); + } + if (!result.successful()) { + String failure = writeFailure(result); + coordinator.recordPersistentFailure(failure, result.failure().orElse(null)); + message(player, failure); + return; + } + source.invalidateStructureResources(); + studio.generator().invalidateRender(bay.stableId(), coordinator.saveIdentity().variantKey()); + JigsawStudioSession session = studio.generator().getSession(); + boolean unchanged = session.markWorkcellSaved(coordinator.saveIdentity()); + try { + service.reloadSessionLayout(studio); + } catch (IOException | RuntimeException refreshFailure) { + IrisLogging.reportError(refreshFailure); + message(player, "The graph saved, but Studio could not refresh its variant catalog. " + + "Close and reopen this project before continuing: " + + failureMessage(refreshFailure)); + } + String cleanup = result.status() == StructureWriteResult.Status.COMMITTED_CLEANUP_REQUIRED + ? " The graph committed, but transaction cleanup requires operator attention in the console." + : ""; + String mutationNotice = unchanged ? "" : " Newer edits remain unsaved."; + message(player, "Saved piece '" + coordinator.saveIdentity().variantKey() + "' and object '" + + assembly.objectKey() + "' atomically." + mutationNotice + cleanup); + playSaveSound(player); + if (unchanged) { + service.evaluator.scheduleEvaluation(studio); + } + IrisLogging.debug("Jigsaw Studio saved: structure=%s piece=%s object=%s connectors=%d status=%s", + request.structureKey(), coordinator.saveIdentity().variantKey(), assembly.objectKey(), + connectors.size(), result.status()); + } catch (Throwable exception) { + String failure = "Jigsaw Studio save failed: " + failureMessage(exception); + coordinator.recordPersistentFailure(failure, exception); + message(player, failure); + } finally { + coordinator.complete(); + } + } + + static Set requiredChunks( + JigsawStudioBay bay, + JigsawStudioGenerator.RenderedBay rendered + ) { + Set chunks = new HashSet<>(); + if (!rendered.valid()) { + return chunks; + } + JigsawStudioBounds bounds = bay.bounds(); + int minimumChunkX = bounds.originX() >> 4; + int maximumChunkX = bounds.maxX() >> 4; + int minimumChunkZ = bounds.originZ() >> 4; + int maximumChunkZ = bounds.maxZ() >> 4; + for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { + for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { + chunks.add(chunkKey(chunkX, chunkZ)); + } + } + return Set.copyOf(chunks); + } + + static CaptureTarget resolveCaptureTarget( + ActiveStudio studio, + JigsawStudioBay bay, + JigsawStudioVariant variant + ) + throws IOException { + IrisData source = studio.generator().getRequest().source(); + JigsawStudioLayout currentLayout = studio.generator().getSession().layout(); + JigsawStudioBay currentBay = currentLayout.get(bay.stableId()); + if (currentBay == null) { + throw new IOException("workcell '" + bay.stableId() + "' is absent from the current Studio layout"); + } + JigsawStudioVariant activeVariant = Objects.requireNonNull(variant, "Jigsaw Studio capture variant"); + if (!currentLayout.accepts(currentBay, activeVariant)) { + throw new IOException("variant '" + activeVariant.pieceKey() + + "' does not belong to workcell '" + currentBay.stableId() + "'"); + } + IrisJigsawPiece piece = source.getJigsawPieceLoader().load(activeVariant.pieceKey(), false); + if (piece == null || piece.getObject() == null || piece.getObject().isBlank()) { + throw new IOException("piece '" + activeVariant.pieceKey() + "' is missing or has no object"); + } + IrisObject object = source.getObjectLoader().load(piece.getObject(), false); + if (object == null || object.getW() < 1 || object.getH() < 1 || object.getD() < 1) { + throw new IOException("object '" + piece.getObject() + "' is missing or has invalid dimensions"); + } + JigsawStudioBounds bayBounds = currentBay.bounds(); + JigsawStudioCellDimensions sourceDimensions = new JigsawStudioCellDimensions( + object.getW(), object.getH(), object.getD()); + JigsawStudioCellDimensions canonicalDimensions = activeVariant.canonicalDimensions(sourceDimensions); + if (canonicalDimensions.width() > bayBounds.dimensions().width() + || canonicalDimensions.height() > bayBounds.dimensions().height() + || canonicalDimensions.depth() > bayBounds.dimensions().depth()) { + throw new IOException("object '" + piece.getObject() + "' is " + + canonicalDimensions.width() + "x" + canonicalDimensions.height() + "x" + + canonicalDimensions.depth() + " in its displayed orientation" + + " but bay '" + currentBay.stableId() + "' is only " + + bayBounds.dimensions().width() + "x" + bayBounds.dimensions().height() + "x" + + bayBounds.dimensions().depth()); + } + return new CaptureTarget( + new JigsawStudioBounds( + bayBounds.originX(), + bayBounds.originY(), + bayBounds.originZ(), + canonicalDimensions), + piece, + object, + activeVariant.sourceToCanonicalQuarterTurns(), + studio.generator().getSession().workcellSnapshot(currentBay.stableId()).connectorsVisible()); + } + + CaptureCoordinator coordinator(CaptureWork work, List areas) { + return new CaptureCoordinator(work, areas); + } + + final class CaptureCoordinator { + private final CaptureWork work; + private final List areas; + private final Map snapshots = new ConcurrentHashMap<>(); + private final AtomicInteger remaining; + private final AtomicBoolean failed = new AtomicBoolean(false); + private final AtomicBoolean assemblyStarted = new AtomicBoolean(false); + private final AtomicBoolean operationFinished = new AtomicBoolean(false); + private volatile AutosavePersistentFailure persistentFailure; + + CaptureCoordinator(CaptureWork work, List areas) { + this.work = Objects.requireNonNull(work, "Jigsaw Studio capture work"); + this.areas = List.copyOf(areas); + this.remaining = new AtomicInteger(this.areas.size()); + } + + private ActiveStudio studio() { + return work.studio(); + } + + private World world() { + return work.world(); + } + + private JigsawStudioBay bay() { + return work.bay(); + } + + private CaptureTarget captureTarget() { + return work.captureTarget(); + } + + private Player player() { + return work.player(); + } + + private UUID requestId() { + return work.requestId(); + } + + private JigsawStudioSession.SaveIdentity saveIdentity() { + return work.saveIdentity(); + } + + private List areas() { + return areas; + } + + private boolean stopped() { + return failed.get(); + } + + private boolean failed() { + return failed.get(); + } + + private void accept(ChunkSnapshot snapshot) { + if (failed.get() || assemblyStarted.get()) { + return; + } + ChunkCaptureArea area = snapshot.area(); + long key = chunkKey(area.chunkX(), area.chunkZ()); + if (snapshots.putIfAbsent(key, snapshot) != null) { + fail("Jigsaw Studio received duplicate snapshot for bay chunk " + + area.chunkX() + "," + area.chunkZ() + ".", null); + return; + } + int incomplete = remaining.decrementAndGet(); + if (incomplete < 0) { + fail("Jigsaw Studio received more bay chunk snapshots than expected.", null); + return; + } + if (incomplete == 0 && assemblyStarted.compareAndSet(false, true)) { + List completed = List.copyOf(snapshots.values()); + J.a(() -> assembleAndPersist(this, completed)); + } + } + + void fail(String failure, Throwable exception) { + if (!failed.compareAndSet(false, true)) { + return; + } + if (exception != null) { + IrisLogging.reportError(exception); + } + complete(); + message(player(), failure); + } + + private void failPersistent(String failure, Throwable exception) { + if (!failed.compareAndSet(false, true)) { + return; + } + recordPersistentFailure(failure, exception); + complete(); + message(player(), failure); + } + + private void recordPersistentFailure(String failure, Throwable exception) { + persistentFailure = new AutosavePersistentFailure(failure, exception); + } + + private void complete() { + if (operationFinished.compareAndSet(false, true)) { + studio().generator().getSession().abortSave(saveIdentity()); + service.saveLifecycle.finishSave(requestId()); + service.autosaveScheduler.completeAutosaveAttempt( + studio(), + saveIdentity(), + work.autosaveFailureState(), + persistentFailure); + service.playerContext.refreshWorkcellContext(studio().worldId(), saveIdentity().workcellId()); + } + } + } + + record CaptureWork( + ActiveStudio studio, + World world, + JigsawStudioBay bay, + CaptureTarget captureTarget, + Player player, + UUID requestId, + JigsawStudioSession.SaveIdentity saveIdentity, + AutosaveFailureState autosaveFailureState + ) { + CaptureWork { + Objects.requireNonNull(studio, "Jigsaw Studio capture studio"); + Objects.requireNonNull(world, "Jigsaw Studio capture world"); + Objects.requireNonNull(bay, "Jigsaw Studio capture bay"); + Objects.requireNonNull(captureTarget, "Jigsaw Studio capture target"); + Objects.requireNonNull(requestId, "Jigsaw Studio capture request ID"); + Objects.requireNonNull(saveIdentity, "Jigsaw Studio capture save identity"); + Objects.requireNonNull(autosaveFailureState, "Jigsaw Studio capture autosave failure state"); + } + } + + record CaptureTarget( + JigsawStudioBounds bounds, + IrisJigsawPiece piece, + IrisObject object, + int displayRotationQuarterTurns, + boolean connectorsVisible + ) { + CaptureTarget { + Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); + Objects.requireNonNull(piece, "Jigsaw Studio capture piece"); + Objects.requireNonNull(object, "Jigsaw Studio capture object"); + displayRotationQuarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioChunkWriter.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioChunkWriter.java new file mode 100644 index 000000000..ba94ad4c1 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioChunkWriter.java @@ -0,0 +1,624 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMarkerKeyCodec; +import art.arcane.iris.core.service.JigsawStudioCapture.CapturedConnector; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkCaptureArea; +import art.arcane.iris.core.service.JigsawStudioCapture.LocalPosition; +import art.arcane.iris.core.service.JigsawStudioSaveLifecycle.BayReadiness; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.object.IrisJigsawConnector; +import art.arcane.iris.engine.object.IrisJigsawPiece; +import art.arcane.iris.engine.object.IrisObjectRotation; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.engine.object.TileData; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.PlatformBlockState; +import art.arcane.volmlib.util.collection.KMap; +import org.bukkit.Bukkit; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.block.Block; +import org.bukkit.block.data.BlockData; +import org.bukkit.block.data.type.Jigsaw; + +import java.io.IOException; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + +import static art.arcane.iris.core.service.JigsawStudioCapture.inversePosition; +import static art.arcane.iris.core.service.JigsawStudioService.chunkKey; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; + +final class JigsawStudioChunkWriter { + private JigsawStudioChunkWriter() { + } + + static void restoreConnectorChunk( + World world, + JigsawStudioBay workcell, + List connectors, + Map renderedBlocks, + boolean connectorsVisible + ) throws IOException { + JigsawStudioBounds bounds = workcell.bounds(); + for (JigsawStudioGenerator.RenderedConnector connector : connectors) { + LocalPosition position = new LocalPosition(connector.x(), connector.y(), connector.z()); + Block target = world.getBlockAt( + bounds.originX() + connector.x(), + bounds.originY() + connector.y(), + bounds.originZ() + connector.z()); + if (connectorsVisible) { + BlockData marker; + try { + marker = Bukkit.createBlockData( + "minecraft:jigsaw[orientation=" + connector.orientation() + "]"); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid saved connector orientation '" + + connector.orientation() + "'", exception); + } + target.setBlockData(marker, false); + BukkitPlatform.deserializeTile(markerNbt(connector.connector()), target.getLocation()); + continue; + } + JigsawStudioGenerator.RenderedBlock renderedBlock = renderedBlocks.get(position); + BlockData restored; + if (renderedBlock != null) { + if (renderedBlock.state().isCustom() + || !(renderedBlock.state().nativeHandle() instanceof BlockData blockData)) { + throw new IOException("Saved connector block '" + renderedBlock.state().key() + + "' cannot be restored directly in Bukkit Studio"); + } + restored = blockData; + } else { + try { + restored = Bukkit.createBlockData(connector.connector().getFinalState()); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid saved connector final state '" + + connector.connector().getFinalState() + "'", exception); + } + } + target.setBlockData(restored, false); + if (renderedBlock != null && renderedBlock.tileData() != null) { + TileData tileData = renderedBlock.tileData(); + if (!tileData.isApplicable(target.getBlockData()) || !tileData.toBukkitTry(target)) { + throw new IOException("Saved connector tile data could not be restored at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + } + } + } + + static String validateMaterialization(JigsawStudioGenerator.RenderedBay rendered) { + if (!rendered.valid()) { + return rendered.failure(); + } + for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { + PlatformBlockState state = block.state(); + if (state.isCustom()) { + return "custom block '" + state.key() + + "' requires provider-owned placement and cannot be swapped live in Studio"; + } + if (!(state.nativeHandle() instanceof BlockData)) { + return "block '" + state.key() + "' has no Bukkit block-data representation"; + } + } + for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { + try { + BlockData data = Bukkit.createBlockData( + "minecraft:jigsaw[orientation=" + connector.orientation() + "]"); + if (!(data instanceof Jigsaw)) { + return "connector orientation '" + connector.orientation() + + "' did not resolve to a jigsaw marker"; + } + } catch (IllegalArgumentException exception) { + return "connector orientation '" + connector.orientation() + "' is invalid"; + } + } + return ""; + } + + static void writeMaterializedChunk( + World world, + JigsawStudioBay workcell, + JigsawStudioGenerator.RenderedBay rendered, + ChunkCaptureArea area, + boolean connectorsVisible + ) throws IOException { + JigsawStudioBounds bounds = workcell.bounds(); + Map expected = materializedBlockData(rendered, connectorsVisible); + BlockData air = Material.AIR.createBlockData(); + for (int x = area.minimumX(); x < area.maximumX(); x++) { + for (int y = 0; y < bounds.dimensions().height(); y++) { + for (int z = area.minimumZ(); z < area.maximumZ(); z++) { + Block target = world.getBlockAt( + bounds.originX() + x, + bounds.originY() + y, + bounds.originZ() + z); + BlockData blockData = expected.getOrDefault(new LocalPosition(x, y, z), air); + target.setBlockData(blockData, false); + } + } + } + applyRenderedBayChunk(world, workcell, rendered, area.chunkX(), area.chunkZ(), connectorsVisible); + verifyMaterializedChunk(world, workcell, rendered, area, expected, connectorsVisible); + } + + private static Map materializedBlockData( + JigsawStudioGenerator.RenderedBay rendered, + boolean connectorsVisible + ) throws IOException { + Map expected = new HashMap<>(); + for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { + if (block.state().isCustom() || !(block.state().nativeHandle() instanceof BlockData blockData)) { + throw new IOException("Rendered block '" + block.state().key() + + "' cannot be placed directly in Bukkit Studio"); + } + expected.put(new LocalPosition(block.x(), block.y(), block.z()), blockData); + } + for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { + if (!connectorsVisible && expected.containsKey( + new LocalPosition(connector.x(), connector.y(), connector.z()))) { + continue; + } + BlockData marker; + try { + marker = Bukkit.createBlockData(connectorsVisible + ? "minecraft:jigsaw[orientation=" + connector.orientation() + "]" + : connector.connector().getFinalState()); + } catch (IllegalArgumentException exception) { + throw new IOException("Invalid rendered connector orientation '" + + connector.orientation() + "'", exception); + } + expected.put(new LocalPosition(connector.x(), connector.y(), connector.z()), marker); + } + return expected; + } + + private static void verifyMaterializedChunk( + World world, + JigsawStudioBay workcell, + JigsawStudioGenerator.RenderedBay rendered, + ChunkCaptureArea area, + Map expected, + boolean connectorsVisible + ) throws IOException { + JigsawStudioBounds bounds = workcell.bounds(); + BlockData air = Material.AIR.createBlockData(); + for (int x = area.minimumX(); x < area.maximumX(); x++) { + for (int y = 0; y < bounds.dimensions().height(); y++) { + for (int z = area.minimumZ(); z < area.maximumZ(); z++) { + Block target = world.getBlockAt( + bounds.originX() + x, + bounds.originY() + y, + bounds.originZ() + z); + BlockData expectedData = expected.getOrDefault(new LocalPosition(x, y, z), air); + if (!target.getBlockData().equals(expectedData)) { + throw new IOException("Workcell block did not materialize at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + } + } + } + verifyRenderedBayChunk(world, workcell, rendered, area.chunkX(), area.chunkZ(), connectorsVisible); + } + + static boolean hydrateChunk( + ActiveStudio studio, + World world, + int chunkX, + int chunkZ + ) { + long key = chunkKey(chunkX, chunkZ); + boolean verificationRequired = false; + for (JigsawStudioBay bay : studio.generator().getLayout().bays()) { + BayPopulation population = studio.population(bay); + if (!population.needsApplication(key) && !population.needsVerification(key)) { + continue; + } + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); + if (!rendered.valid()) { + population.fail(rendered.failure()); + continue; + } + try { + if (population.needsApplication(key)) { + applyRenderedBayChunk( + world, + bay, + rendered, + chunkX, + chunkZ, + studio.generator().getSession().workcellSnapshot(bay.stableId()).connectorsVisible()); + population.markApplied(key); + verificationRequired = true; + } else { + verifyRenderedBayChunk( + world, + bay, + rendered, + chunkX, + chunkZ, + studio.generator().getSession().workcellSnapshot(bay.stableId()).connectorsVisible()); + population.markHydrated(key); + } + } catch (Throwable exception) { + if (population.fail("chunk " + chunkX + "," + chunkZ + + " could not hydrate: " + failureMessage(exception))) { + IrisLogging.reportError(exception); + } + } + } + return verificationRequired; + } + + static void applyRenderedBayChunk( + World world, + JigsawStudioBay bay, + JigsawStudioGenerator.RenderedBay rendered, + int chunkX, + int chunkZ, + boolean connectorsVisible + ) throws IOException { + JigsawStudioBounds bounds = bay.bounds(); + Set connectorPositions = new HashSet<>(rendered.connectors().size()); + if (connectorsVisible) { + for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { + connectorPositions.add(new LocalPosition(connector.x(), connector.y(), connector.z())); + } + } + for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { + TileData tileData = block.tileData(); + if (tileData == null + || connectorPositions.contains(new LocalPosition(block.x(), block.y(), block.z()))) { + continue; + } + int worldX = bounds.originX() + block.x(); + int worldZ = bounds.originZ() + block.z(); + if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { + continue; + } + Block target = world.getBlockAt(worldX, bounds.originY() + block.y(), worldZ); + if (!tileData.isApplicable(target.getBlockData())) { + throw new IOException("source tile state does not match rendered block at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + if (!tileData.toBukkitTry(target)) { + throw new IOException("source tile state could not hydrate at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + } + if (!connectorsVisible) { + return; + } + for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { + int worldX = bounds.originX() + renderedConnector.x(); + int worldZ = bounds.originZ() + renderedConnector.z(); + if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { + continue; + } + Block target = world.getBlockAt( + worldX, + bounds.originY() + renderedConnector.y(), + worldZ); + BlockData blockData = target.getBlockData(); + if (!(blockData instanceof Jigsaw jigsaw)) { + throw new IOException("expected a jigsaw marker at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + String actualOrientation = jigsaw.getOrientation().name().toLowerCase(Locale.ROOT); + if (!actualOrientation.equals(renderedConnector.orientation())) { + throw new IOException("jigsaw marker orientation at " + + target.getX() + "," + target.getY() + "," + target.getZ() + + " is " + actualOrientation + " instead of " + renderedConnector.orientation()); + } + KMap expected = markerNbt(renderedConnector.connector()); + BukkitPlatform.deserializeTile(expected, target.getLocation()); + } + } + + static void verifyRenderedBayChunk( + World world, + JigsawStudioBay bay, + JigsawStudioGenerator.RenderedBay rendered, + int chunkX, + int chunkZ, + boolean connectorsVisible + ) throws IOException { + JigsawStudioBounds bounds = bay.bounds(); + Set connectorPositions = new HashSet<>(rendered.connectors().size()); + if (connectorsVisible) { + for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { + connectorPositions.add(new LocalPosition(connector.x(), connector.y(), connector.z())); + } + } + for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { + TileData tileData = block.tileData(); + if (tileData == null + || connectorPositions.contains(new LocalPosition(block.x(), block.y(), block.z()))) { + continue; + } + int worldX = bounds.originX() + block.x(); + int worldZ = bounds.originZ() + block.z(); + if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { + continue; + } + Block target = world.getBlockAt(worldX, bounds.originY() + block.y(), worldZ); + if (!tileData.isApplicable(target.getBlockData())) { + throw new IOException("hydrated tile state no longer matches its block at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + KMap hydrated = BukkitPlatform.serializeTile(target.getLocation()); + if (hydrated == null + || tileData.getProperties() != null + && !nbtContains(tileData.getProperties(), hydrated)) { + throw new IOException("the active NMS binding did not preserve source tile NBT at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + } + if (!connectorsVisible) { + return; + } + for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { + int worldX = bounds.originX() + renderedConnector.x(); + int worldZ = bounds.originZ() + renderedConnector.z(); + if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { + continue; + } + Block target = world.getBlockAt( + worldX, + bounds.originY() + renderedConnector.y(), + worldZ); + BlockData blockData = target.getBlockData(); + if (!(blockData instanceof Jigsaw jigsaw) + || !jigsaw.getOrientation().name().toLowerCase(Locale.ROOT) + .equals(renderedConnector.orientation())) { + throw new IOException("jigsaw marker changed before hydration completed at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + KMap expected = markerNbt(renderedConnector.connector()); + KMap hydrated = BukkitPlatform.serializeTile(target.getLocation()); + if (!markerNbtMatches(expected, hydrated)) { + throw new IOException("the active NMS binding did not preserve jigsaw marker NBT at " + + target.getX() + "," + target.getY() + "," + target.getZ()); + } + } + } + + static KMap markerNbt(IrisJigsawConnector connector) { + IrisJigsawConnector activeConnector = Objects.requireNonNull(connector, "Jigsaw Studio connector"); + KMap nbt = new KMap<>(); + nbt.put("name", studioIdentifier(activeConnector.getName())); + nbt.put("target", studioIdentifier(activeConnector.getTargetName())); + nbt.put("pool", JigsawStudioMarkerKeyCodec.encodePool(activeConnector.getPool())); + nbt.put("final_state", activeConnector.getFinalState()); + nbt.put("joint", activeConnector.getJoint().name().toLowerCase(Locale.ROOT)); + nbt.put("selection_priority", activeConnector.getSelectionPriority()); + nbt.put("placement_priority", activeConnector.getPlacementPriority()); + return nbt; + } + + private static boolean markerNbtMatches( + Map expected, + Map hydrated + ) { + if (hydrated == null) { + return false; + } + for (Map.Entry entry : expected.entrySet()) { + Object actual = hydrated.get(entry.getKey()); + if (entry.getValue() instanceof Number expectedNumber) { + if (!(actual instanceof Number actualNumber) + || expectedNumber.longValue() != actualNumber.longValue()) { + return false; + } + } else if (!Objects.equals(entry.getValue(), actual)) { + return false; + } + } + return true; + } + + private static boolean nbtContains(Object expected, Object actual) { + if (expected instanceof Number expectedNumber) { + if (!(actual instanceof Number actualNumber)) { + return false; + } + if (isIntegral(expectedNumber) && isIntegral(actualNumber)) { + return expectedNumber.longValue() == actualNumber.longValue(); + } + return Double.compare(expectedNumber.doubleValue(), actualNumber.doubleValue()) == 0; + } + if (expected instanceof Map expectedMap) { + if (!(actual instanceof Map actualMap)) { + return false; + } + for (Map.Entry entry : expectedMap.entrySet()) { + if (!actualMap.containsKey(entry.getKey()) + || !nbtContains(entry.getValue(), actualMap.get(entry.getKey()))) { + return false; + } + } + return true; + } + if (expected instanceof List expectedList) { + if (!(actual instanceof List actualList) || expectedList.size() != actualList.size()) { + return false; + } + for (int index = 0; index < expectedList.size(); index++) { + if (!nbtContains(expectedList.get(index), actualList.get(index))) { + return false; + } + } + return true; + } + return Objects.equals(expected, actual); + } + + private static boolean isIntegral(Number number) { + return number instanceof Byte + || number instanceof Short + || number instanceof Integer + || number instanceof Long; + } + + static void restoreCapturedMetadata( + IrisJigsawConnector captured, + IrisJigsawPiece sourcePiece + ) { + IrisJigsawConnector activeCaptured = Objects.requireNonNull(captured, "Captured jigsaw connector"); + IrisJigsawConnector original = connectorAt(sourcePiece, activeCaptured.getPosition()); + if (original == null) { + return; + } + activeCaptured.setName(restoreIdentifier(activeCaptured.getName(), original.getName())); + activeCaptured.setTargetName(restoreIdentifier( + activeCaptured.getTargetName(), + original.getTargetName())); + activeCaptured.setChannel(original.getChannel() == null ? "" : original.getChannel()); + } + + static void restoreCapturedMetadataForDisplay( + IrisJigsawConnector captured, + IrisJigsawPiece sourcePiece, + JigsawStudioCellDimensions displayDimensions, + int displayRotationQuarterTurns + ) { + if (Math.floorMod(displayRotationQuarterTurns, 4) == 0) { + restoreCapturedMetadata(captured, sourcePiece); + return; + } + int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); + int sourceWidth = (quarterTurns & 1) == 0 + ? displayDimensions.width() + : displayDimensions.depth(); + int sourceDepth = (quarterTurns & 1) == 0 + ? displayDimensions.depth() + : displayDimensions.width(); + LocalPosition position = inversePosition( + captured.getPosition().getX(), + captured.getPosition().getY(), + captured.getPosition().getZ(), + sourceWidth, + sourceDepth, + quarterTurns); + IrisObjectRotation inverseRotation = IrisObjectRotation.of(0, 90.0D * quarterTurns, 0); + IrisJigsawConnector sourceOriented = CapturedConnector.from(captured).toConnector() + .setPosition(new IrisPosition(position.x(), position.y(), position.z())) + .setDirection(inverseRotation.rotate(captured.getDirection())) + .setTop(inverseRotation.rotate(captured.getTop())); + restoreCapturedMetadata(sourceOriented, sourcePiece); + captured.setName(sourceOriented.getName()); + captured.setTargetName(sourceOriented.getTargetName()); + captured.setChannel(sourceOriented.getChannel()); + } + + private static IrisJigsawConnector connectorAt(IrisJigsawPiece piece, IrisPosition position) { + if (piece == null || piece.getConnectors() == null || position == null) { + return null; + } + for (IrisJigsawConnector connector : piece.getConnectors()) { + if (connector != null && position.equals(connector.getPosition())) { + return connector; + } + } + return null; + } + + private static String restoreIdentifier(String captured, String original) { + if (original != null && studioIdentifier(original).equals(captured)) { + return original; + } + return captured; + } + + private static String studioIdentifier(String value) { + String normalized = Objects.requireNonNull(value, "Jigsaw Studio marker identifier").trim(); + return normalized.indexOf(':') < 0 ? "iris:" + normalized : normalized; + } + + static final class BayPopulation { + private final Set requiredChunks; + private final Set generatedChunks = ConcurrentHashMap.newKeySet(); + private final Set appliedChunks = ConcurrentHashMap.newKeySet(); + private final Set hydratedChunks = ConcurrentHashMap.newKeySet(); + private volatile String failure; + + BayPopulation(Set requiredChunks, String failure) { + this.requiredChunks = Set.copyOf(requiredChunks); + this.failure = failure == null ? "" : failure; + } + + boolean markGenerated(long chunk) { + if (!requiredChunks.contains(chunk)) { + return false; + } + generatedChunks.add(chunk); + return !hydratedChunks.contains(chunk) && failure.isEmpty(); + } + + boolean needsApplication(long chunk) { + return failure.isEmpty() + && requiredChunks.contains(chunk) + && generatedChunks.contains(chunk) + && !appliedChunks.contains(chunk); + } + + boolean needsVerification(long chunk) { + return failure.isEmpty() + && requiredChunks.contains(chunk) + && generatedChunks.contains(chunk) + && appliedChunks.contains(chunk) + && !hydratedChunks.contains(chunk); + } + + void markApplied(long chunk) { + if (requiredChunks.contains(chunk)) { + appliedChunks.add(chunk); + } + } + + void markHydrated(long chunk) { + if (requiredChunks.contains(chunk)) { + hydratedChunks.add(chunk); + } + } + + void markFullyReady() { + generatedChunks.addAll(requiredChunks); + appliedChunks.addAll(requiredChunks); + hydratedChunks.addAll(requiredChunks); + } + + synchronized boolean fail(String reason) { + if (!failure.isEmpty()) { + return false; + } + failure = reason == null || reason.isBlank() ? "unknown hydration failure" : reason; + return true; + } + + BayReadiness readiness() { + boolean ready = failure.isEmpty() + && !requiredChunks.isEmpty() + && generatedChunks.containsAll(requiredChunks) + && hydratedChunks.containsAll(requiredChunks); + return new BayReadiness( + ready, + failure, + requiredChunks.size(), + generatedChunks.size(), + hydratedChunks.size()); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDirtyTracker.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDirtyTracker.java new file mode 100644 index 000000000..927bf25c3 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioDirtyTracker.java @@ -0,0 +1,118 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import org.bukkit.World; +import org.bukkit.block.Block; +import org.bukkit.inventory.Inventory; + +import java.util.List; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioAutosaveScheduler.AUTOSAVE_DEBOUNCE_TICKS; +import static art.arcane.iris.core.service.JigsawStudioProtection.inventoryBlocks; + +final class JigsawStudioDirtyTracker { + private final JigsawStudioService service; + + JigsawStudioDirtyTracker(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean markDirty(World world, int worldX, int worldY, int worldZ) { + if (world == null) { + return false; + } + ActiveStudio studio = service.studios.get(world.getUID()); + if (studio == null) { + return false; + } + if (service.saveLifecycle.reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay bay = session.layout().findAt(worldX, worldY, worldZ); + if (bay == null) { + return false; + } + JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); + if (activeVariant == null || !activeVariant.owned()) { + return false; + } + JigsawStudioSession.DirtyMark dirtyMark = session.markWorkcellDirty(bay.stableId()); + if (dirtyMark.status() != JigsawStudioSession.DirtyStatus.MARKED) { + return false; + } + service.autosaveScheduler.scheduleAutosave( + studio, + bay, + dirtyMark.identity().orElseThrow(), + AUTOSAVE_DEBOUNCE_TICKS); + service.markEvaluationStale(studio); + if (dirtyMark.newlyDirty()) { + service.playerContext.refreshWorkcellContext(studio.worldId(), bay.stableId()); + } + return true; + } + + int markAllDirty(World world) { + if (world == null) { + return 0; + } + ActiveStudio studio = service.studios.get(world.getUID()); + return studio == null ? 0 : markAllDirty(studio); + } + + void markDirty(Block block) { + if (block != null) { + markDirty(block.getWorld(), block.getX(), block.getY(), block.getZ()); + } + } + + void markDirty(List blocks) { + for (Block block : blocks) { + markDirty(block); + } + } + + void markDirty(Inventory inventory) { + for (Block block : inventoryBlocks(inventory)) { + markDirty(block); + } + } + + void markAllDirty() { + for (ActiveStudio studio : service.studios.values()) { + markAllDirty(studio); + } + } + + int markAllDirty(ActiveStudio studio) { + int changed = 0; + JigsawStudioSession session = studio.generator().getSession(); + for (JigsawStudioBay bay : session.layout().bays()) { + JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); + if (activeVariant == null || !activeVariant.owned()) { + continue; + } + JigsawStudioSession.DirtyMark dirtyMark = session.markWorkcellDirty(bay.stableId()); + if (dirtyMark.status() == JigsawStudioSession.DirtyStatus.MARKED) { + service.autosaveScheduler.scheduleAutosave( + studio, + bay, + dirtyMark.identity().orElseThrow(), + AUTOSAVE_DEBOUNCE_TICKS); + changed++; + } + } + if (changed > 0) { + service.markEvaluationStale(studio); + for (JigsawStudioBay bay : session.layout().bays()) { + service.playerContext.refreshWorkcellContext(studio.worldId(), bay.stableId()); + } + } + return changed; + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioEvaluator.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioEvaluator.java new file mode 100644 index 000000000..041be6ee9 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioEvaluator.java @@ -0,0 +1,308 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.framework.PlacedStructurePiece; +import art.arcane.iris.engine.framework.StructureAssembler; +import art.arcane.iris.engine.framework.structure.StructureAssemblyResult; +import art.arcane.iris.engine.framework.structure.StructureGraphCompilation; +import art.arcane.iris.engine.framework.structure.StructureGraphCompiler; +import art.arcane.iris.engine.framework.structure.StructureGraphDiagnostic; +import art.arcane.iris.engine.framework.structure.StructureGraphResolver; +import art.arcane.iris.engine.object.IrisPosition; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import art.arcane.volmlib.util.math.RNG; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicLong; + +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; + +final class JigsawStudioEvaluator { + private static final long PREVIEW_SEED = 1337L; + private static final int SPATIAL_PREVIEW_BASE_Y = JigsawStudioLayout.FLOOR_Y + 48; + + private final JigsawStudioService service; + final Map evaluations = new ConcurrentHashMap<>(); + + JigsawStudioEvaluator(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + void scheduleInitialEvaluation(ActiveStudio studio) { + if (studio == null) { + return; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + UUID requestId = request.requestId(); + if (!claimInitialEvaluation( + studio.evaluationGeneration(), + service.isCurrentRequest(studio, requestId))) { + return; + } + publishEvaluation(studio, requestId, 1L); + } + + static boolean claimInitialEvaluation(AtomicLong generation, boolean currentRequest) { + return currentRequest + && Objects.requireNonNull(generation, "Jigsaw Studio evaluation generation") + .compareAndSet(0L, 1L); + } + + void scheduleEvaluation(ActiveStudio studio) { + if (studio == null) { + return; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + UUID requestId = request.requestId(); + if (!service.isCurrentRequest(studio, requestId)) { + return; + } + publishEvaluation(studio, requestId, studio.evaluationGeneration().incrementAndGet()); + } + + private void publishEvaluation(ActiveStudio studio, UUID requestId, long generation) { + JigsawStudioGraphEvaluation previous = evaluations.get(requestId); + JigsawStudioPreviewRenderer.PreviewBounds previousBounds = previous == null + ? JigsawStudioPreviewRenderer.PreviewBounds.empty() + : previous.previewBounds(); + evaluations.put(requestId, new JigsawStudioGraphEvaluation( + requestId, + generation, + PREVIEW_SEED, + JigsawStudioEvaluationState.PENDING, + previous == null ? "" : previous.selectedTheme(), + previous == null ? 0 : previous.pieceCount(), + "Compiling the committed graph and assembling seed 1337", + previousBounds)); + service.playerContext.refreshAllWorkcellContexts(studio); + J.a(() -> evaluateGraph(studio, requestId, generation)); + } + + private void evaluateGraph(ActiveStudio studio, UUID requestId, long generation) { + EvaluationComputation computation; + try { + JigsawStudioActivation.Request request = studio.generator().getRequest(); + IrisStructure structure = request.source().load( + IrisStructure.class, + request.structureKey(), + false); + if (structure == null) { + throw new IOException("The active structure resource no longer exists"); + } + StructureGraphCompilation compilation = StructureGraphCompiler.compile( + structure, + StructureGraphResolver.forData(request.source())); + StructureGraphDiagnostic firstError = firstDiagnostic( + compilation, + StructureGraphDiagnostic.Severity.ERROR); + if (firstError != null) { + computation = invalidEvaluation( + requestId, + generation, + firstError.code() + ": " + firstError.message()); + } else { + IrisPosition origin = previewOrigin(studio.generator().getLayout(), structure); + StructureAssembler assembler = StructureAssembler.forCompilation(compilation, origin); + StructureAssemblyResult assembly = assembler.assemble(new RNG(PREVIEW_SEED)); + computation = evaluationForAssembly( + requestId, + generation, + compilation, + assembly, + studio.generator().getLayout().mode()); + } + } catch (Throwable exception) { + IrisLogging.reportError(exception); + computation = invalidEvaluation(requestId, generation, failureMessage(exception)); + } + completeEvaluation(studio, computation); + } + + private EvaluationComputation evaluationForAssembly( + UUID requestId, + long generation, + StructureGraphCompilation compilation, + StructureAssemblyResult assembly, + JigsawStudioMode mode + ) throws IOException { + if (assembly.status().isFailure()) { + return invalidEvaluation( + requestId, + generation, + assembly.status().name().toLowerCase(Locale.ROOT) + ": " + assembly.detail()); + } + if (!assembly.hasOutput()) { + return new EvaluationComputation( + new JigsawStudioGraphEvaluation( + requestId, + generation, + PREVIEW_SEED, + JigsawStudioEvaluationState.WARNING, + assembly.selectedTheme(), + 0, + assembly.detail().isEmpty() + ? "Seed 1337 intentionally generated no structure" + : assembly.detail(), + JigsawStudioPreviewRenderer.PreviewBounds.empty()), + JigsawStudioPreviewRenderer.PreviewPlan.empty()); + } + List aligned = alignPreviewPieces(assembly.pieces(), mode); + JigsawStudioPreviewRenderer.PreviewPlan plan = JigsawStudioPreviewRenderer.plan(aligned); + StructureGraphDiagnostic firstWarning = firstDiagnostic( + compilation, + StructureGraphDiagnostic.Severity.WARNING); + JigsawStudioEvaluationState state = firstWarning == null + ? JigsawStudioEvaluationState.VALID + : JigsawStudioEvaluationState.WARNING; + String detail = firstWarning == null + ? "Seed 1337 assembled " + aligned.size() + " piece(s)" + : firstWarning.code() + ": " + firstWarning.message(); + return new EvaluationComputation( + new JigsawStudioGraphEvaluation( + requestId, + generation, + PREVIEW_SEED, + state, + assembly.selectedTheme(), + aligned.size(), + detail, + plan.bounds()), + plan); + } + + private void completeEvaluation(ActiveStudio studio, EvaluationComputation computation) { + JigsawStudioGraphEvaluation evaluated = computation.evaluation(); + UUID requestId = evaluated.requestId(); + if (!isCurrentEvaluation(studio, requestId, evaluated.generation())) { + return; + } + service.previewRenderer.render( + studio.world(), + requestId, + evaluated.generation(), + computation.plan(), + result -> { + if (!isCurrentEvaluation(studio, requestId, evaluated.generation())) { + return; + } + JigsawStudioGraphEvaluation completed = result.successful() + ? evaluated + : new JigsawStudioGraphEvaluation( + requestId, + evaluated.generation(), + PREVIEW_SEED, + JigsawStudioEvaluationState.WARNING, + evaluated.selectedTheme(), + evaluated.pieceCount(), + evaluated.detail() + "; " + result.failure(), + evaluated.previewBounds()); + evaluations.put(requestId, completed); + service.playerContext.refreshAllWorkcellContexts(studio); + }); + } + + private boolean isCurrentEvaluation(ActiveStudio studio, UUID requestId, long generation) { + if (!service.isCurrentRequest(studio, requestId) + || studio.evaluationGeneration().get() != generation) { + return false; + } + JigsawStudioGraphEvaluation current = evaluations.get(requestId); + return current != null && current.generation() == generation; + } + + private static EvaluationComputation invalidEvaluation( + UUID requestId, + long generation, + String detail + ) { + return new EvaluationComputation( + new JigsawStudioGraphEvaluation( + requestId, + generation, + PREVIEW_SEED, + JigsawStudioEvaluationState.INVALID, + "", + 0, + detail, + JigsawStudioPreviewRenderer.PreviewBounds.empty()), + JigsawStudioPreviewRenderer.PreviewPlan.empty()); + } + + private static StructureGraphDiagnostic firstDiagnostic( + StructureGraphCompilation compilation, + StructureGraphDiagnostic.Severity severity + ) { + for (StructureGraphDiagnostic diagnostic : compilation.getDiagnostics()) { + if (diagnostic.severity() == severity) { + return diagnostic; + } + } + return null; + } + + private static IrisPosition previewOrigin(JigsawStudioLayout layout, IrisStructure structure) { + int radius = Math.max(1, structure.getMaxSizeChunks()) * 16; + return new IrisPosition( + -radius - 32, + 0, + Math.max(16, layout.extentZ() / 2)); + } + + static List alignPreviewPieces( + List pieces, + JigsawStudioMode mode + ) { + int minimumY = Integer.MAX_VALUE; + for (PlacedStructurePiece piece : pieces) { + minimumY = Math.min(minimumY, piece.getMinY()); + } + int baseY = mode == JigsawStudioMode.SPATIAL_JIGSAW + ? SPATIAL_PREVIEW_BASE_Y + : JigsawStudioLayout.FLOOR_Y + 1; + int shiftY = baseY - minimumY; + List aligned = new ArrayList<>(pieces.size()); + for (PlacedStructurePiece piece : pieces) { + aligned.add(new PlacedStructurePiece( + piece.getPiece(), + piece.getObject(), + piece.getX(), + piece.getY() + shiftY, + piece.getZ(), + piece.getRotation(), + piece.getMinX(), + piece.getMinY() + shiftY, + piece.getMinZ(), + piece.getMaxX(), + piece.getMaxY() + shiftY, + piece.getMaxZ())); + } + return List.copyOf(aligned); + } + + static IrisStructure loadStudioStructure(ActiveStudio studio) { + JigsawStudioActivation.Request request = studio.generator().getRequest(); + return request.source().load(IrisStructure.class, request.structureKey(), false); + } + + private record EvaluationComputation( + JigsawStudioGraphEvaluation evaluation, + JigsawStudioPreviewRenderer.PreviewPlan plan + ) { + private EvaluationComputation { + Objects.requireNonNull(evaluation, "Jigsaw Studio graph evaluation"); + Objects.requireNonNull(plan, "Jigsaw Studio evaluation preview plan"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioGraphMutations.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioGraphMutations.java new file mode 100644 index 000000000..735bed61f --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioGraphMutations.java @@ -0,0 +1,417 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.loader.IrisData; +import art.arcane.iris.core.nms.INMS; +import art.arcane.iris.core.runtime.InPlaceChunkRegenerator; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphMapper; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutation; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutationResult; +import art.arcane.iris.engine.data.chunk.TerrainChunk; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.Chunk; +import org.bukkit.World; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.util.HashSet; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.applyRenderedBayChunk; +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.verifyRenderedBayChunk; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioGraphMutations { + private final JigsawStudioService service; + final Set graphMutationsInProgress = new HashSet<>(); + + JigsawStudioGraphMutations(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + String beginGraphMutation( + ActiveStudio studio, + JigsawStudioSession session + ) { + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + synchronized (service.saveLifecycleLock) { + if (service.saveLifecycle.closingRequests.contains(requestId)) { + return "This Jigsaw Studio is closing and cannot update its graph."; + } + if (service.saveLifecycle.savesInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio save to finish."; + } + if (graphMutationsInProgress.contains(requestId)) { + return "A Jigsaw Studio graph update is already running."; + } + if (service.saveLifecycle.exportsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio export to finish."; + } + if (service.materializer.materializationsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio variant load or rollback to finish."; + } + if (session.operationInProgress()) { + return "Wait for the current workcell operation to finish."; + } + if (service.saveLifecycle.reopenRequiredRequests.contains(requestId)) { + return "Close and reopen Jigsaw Studio before making another graph change."; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return "Finish or close the open vanilla jigsaw-block editor before changing graph metadata."; + } + if (session.isDirty()) { + return "Wait for every dirty workcell to finish autosaving before changing graph metadata."; + } + graphMutationsInProgress.add(requestId); + return ""; + } + } + + boolean runCommandGraphMutation( + Player player, + UUID expectedRequestId, + CommandGraphMutation task + ) { + Objects.requireNonNull(expectedRequestId, "Jigsaw Studio command graph request ID"); + Objects.requireNonNull(task, "Jigsaw Studio command graph mutation"); + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> runCommandGraphMutation(player, expectedRequestId, task)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null + || !studio.generator().getRequest().requestId().equals(expectedRequestId)) { + message(player, "This Jigsaw Studio session is no longer active."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + String reservationFailure = beginGraphMutation(studio, studio.generator().getSession()); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return scheduleGraphMutation(player, studio, task); + } + + boolean scheduleGraphMutation( + Player player, + ActiveStudio studio, + CommandGraphMutation task + ) { + UUID requestId = studio.generator().getRequest().requestId(); + J.a(() -> { + CommandGraphMutationResult result = null; + Throwable failure = null; + try { + result = task.run(); + } catch (Throwable exception) { + failure = exception; + } + CommandGraphMutationResult completedResult = result; + Throwable completedFailure = failure; + boolean scheduled = J.runEntity( + player, + () -> completeGraphMutation( + player, + studio, + requestId, + completedResult, + completedFailure), + 0, + () -> finishGraphMutation(requestId)); + if (!scheduled) { + finishGraphMutation(requestId); + if (completedFailure != null) { + IrisLogging.reportError(completedFailure); + } + } + }); + return true; + } + + private void completeGraphMutation( + Player player, + ActiveStudio studio, + UUID requestId, + CommandGraphMutationResult result, + Throwable failure + ) { + try { + if (failure != null) { + IrisLogging.reportError(failure); + message(player, "Graph update failed: " + failureMessage(failure)); + finishGraphMutation(requestId); + return; + } + if (result == null) { + message(player, "Graph update completed without a result; no Studio state changed."); + finishGraphMutation(requestId); + return; + } + if (!service.isCurrentRequest(studio, requestId)) { + message(player, "The graph updated on disk after this Studio session changed; reopen it to continue."); + finishGraphMutation(requestId); + return; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioLayout previousLayout = session.layout(); + if (result.rebindActiveVariants().isEmpty()) { + session.replaceLayout(result.layout()); + } else { + session.replaceLayoutAndRebind(result.layout(), result.rebindActiveVariants()); + } + for (JigsawStudioBay workcell : result.layout().bays()) { + studio.generator().invalidateRender(workcell.stableId()); + } + if (layoutGeometryChanged(previousLayout, result.layout())) { + scheduleLiveRelayout(player, studio, requestId, previousLayout, result); + return; + } + finishGraphMutationSuccess(player, studio, requestId, result); + } catch (Throwable exception) { + IrisLogging.reportError(exception); + message(player, "The graph updated on disk, but Studio could not refresh: " + + failureMessage(exception) + ". Reopen this project before editing further."); + service.saveLifecycle.reopenRequiredRequests.add(requestId); + finishGraphMutation(requestId); + } + } + + private void finishGraphMutationSuccess( + Player player, + ActiveStudio studio, + UUID requestId, + CommandGraphMutationResult result + ) { + for (JigsawStudioBay workcell : result.layout().bays()) { + service.playerContext.refreshWorkcellContext(studio.worldId(), workcell.stableId()); + } + service.evaluator.scheduleEvaluation(studio); + message(player, result.message()); + finishGraphMutation(requestId); + if (!result.activatePieceKey().isEmpty()) { + service.variantEditor.switchVariant( + player, + result.activateWorkcellId(), + result.activatePieceKey(), + false); + } else if (result.reload().isPresent()) { + service.variantEditor.reloadActiveVariant(player, studio, result.reload().orElseThrow()); + } + } + + private void scheduleLiveRelayout( + Player player, + ActiveStudio studio, + UUID requestId, + JigsawStudioLayout previousLayout, + CommandGraphMutationResult result + ) { + Set chunks = relayoutChunks(previousLayout, result.layout()); + AtomicInteger remaining = new AtomicInteger(chunks.size()); + AtomicReference failure = new AtomicReference<>(""); + AtomicReference cause = new AtomicReference<>(); + if (chunks.isEmpty()) { + completeLiveRelayout(player, studio, requestId, result, "", null); + return; + } + for (long chunkKey : chunks) { + int chunkX = (int) (chunkKey >> 32); + int chunkZ = (int) chunkKey; + boolean scheduled = J.runRegion(studio.world(), chunkX, chunkZ, () -> { + try { + repaintStudioChunk(studio, chunkX, chunkZ); + } catch (Throwable exception) { + failure.compareAndSet("", "chunk " + chunkX + "," + chunkZ + + " could not regenerate: " + failureMessage(exception)); + cause.compareAndSet(null, exception); + } + if (remaining.decrementAndGet() == 0) { + scheduleLiveRelayoutCompletion( + player, + studio, + requestId, + result, + failure.get(), + cause.get()); + } + }); + if (!scheduled) { + failure.compareAndSet("", "chunk " + chunkX + "," + chunkZ + + " could not be scheduled on its owning region"); + if (remaining.decrementAndGet() == 0) { + scheduleLiveRelayoutCompletion( + player, + studio, + requestId, + result, + failure.get(), + cause.get()); + } + } + } + } + + private void scheduleLiveRelayoutCompletion( + Player player, + ActiveStudio studio, + UUID requestId, + CommandGraphMutationResult result, + String failure, + Throwable cause + ) { + boolean scheduled = J.runEntity( + player, + () -> completeLiveRelayout(player, studio, requestId, result, failure, cause)); + if (!scheduled) { + service.saveLifecycle.reopenRequiredRequests.add(requestId); + finishGraphMutation(requestId); + if (cause != null) { + IrisLogging.reportError(cause); + } + } + } + + private void completeLiveRelayout( + Player player, + ActiveStudio studio, + UUID requestId, + CommandGraphMutationResult result, + String failure, + Throwable cause + ) { + if (!failure.isEmpty() || !service.isCurrentRequest(studio, requestId)) { + service.saveLifecycle.reopenRequiredRequests.add(requestId); + studio.populations().clear(); + if (cause != null) { + IrisLogging.reportError(cause); + } + message(player, "The workcell size was saved, but live regeneration failed" + + (failure.isEmpty() ? "." : ": " + failure + ".") + + " Close and reopen this project before editing further."); + finishGraphMutation(requestId); + return; + } + studio.populations().clear(); + for (JigsawStudioBay workcell : result.layout().bays()) { + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(workcell); + studio.replacePopulation( + workcell, + rendered, + rendered.valid() ? "" : rendered.failure(), + rendered.valid()); + } + service.saveLifecycle.reopenRequiredRequests.remove(requestId); + finishGraphMutationSuccess(player, studio, requestId, result); + studio.generator().getSession().selectedBayId().ifPresent(workcellId -> service.teleportTo(player, workcellId)); + } + + static boolean layoutGeometryChanged( + JigsawStudioLayout previous, + JigsawStudioLayout current + ) { + if (previous.bays().size() != current.bays().size()) { + return true; + } + for (JigsawStudioBay previousBay : previous.bays()) { + JigsawStudioBay currentBay = current.get(previousBay.stableId()); + if (currentBay == null || !previousBay.bounds().equals(currentBay.bounds())) { + return true; + } + } + return false; + } + + static Set relayoutChunks( + JigsawStudioLayout previous, + JigsawStudioLayout current + ) { + Set chunks = new HashSet<>(); + addRelayoutChunks(chunks, previous); + addRelayoutChunks(chunks, current); + return Set.copyOf(chunks); + } + + private static void addRelayoutChunks(Set chunks, JigsawStudioLayout layout) { + for (JigsawStudioBay workcell : layout.bays()) { + JigsawStudioBounds bounds = workcell.bounds(); + int minimumChunkX = (bounds.originX() - 1) >> 4; + int maximumChunkX = (bounds.maxX() + 1) >> 4; + int minimumChunkZ = (bounds.originZ() - 1) >> 4; + int maximumChunkZ = (bounds.maxZ() + 1) >> 4; + for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { + for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { + chunks.add(JigsawStudioService.chunkKey(chunkX, chunkZ)); + } + } + } + } + + private static void repaintStudioChunk(ActiveStudio studio, int chunkX, int chunkZ) throws IOException { + World world = studio.world(); + Chunk chunk = world.getChunkAt(chunkX, chunkZ); + TerrainChunk generated = TerrainChunk.create(world); + studio.generator().paintChunk(generated, chunkX, chunkZ); + if (!INMS.get().applyChunkBlocks(chunk, generated)) { + InPlaceChunkRegenerator.applyBlockDiffs( + chunk, + generated.getChunkData(), + world.getMinHeight(), + world.getMaxHeight()); + } + for (JigsawStudioBay workcell : studio.generator().getLayout().bays()) { + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(workcell); + if (!rendered.valid()) { + continue; + } + boolean connectorsVisible = studio.generator().getSession() + .workcellSnapshot(workcell.stableId()) + .connectorsVisible(); + applyRenderedBayChunk(world, workcell, rendered, chunkX, chunkZ, connectorsVisible); + verifyRenderedBayChunk(world, workcell, rendered, chunkX, chunkZ, connectorsVisible); + } + world.refreshChunk(chunkX, chunkZ); + } + + boolean graphMutationInProgress(UUID requestId) { + synchronized (service.saveLifecycleLock) { + return graphMutationsInProgress.contains(requestId); + } + } + + private void finishGraphMutation(UUID requestId) { + synchronized (service.saveLifecycleLock) { + graphMutationsInProgress.remove(requestId); + } + } + + static JigsawStudioLayout loadMappedLayout(ActiveStudio studio) throws IOException { + JigsawStudioActivation.Request request = studio.generator().getRequest(); + IrisData source = request.source(); + source.invalidateStructureResources(); + IrisStructure structure = source.load(IrisStructure.class, request.structureKey(), false); + if (structure == null) { + throw new IOException("The structure could not be reloaded after the graph transaction"); + } + return JigsawStudioGraphMapper.map(source, structure); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMaterializer.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMaterializer.java new file mode 100644 index 000000000..9be122b41 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioMaterializer.java @@ -0,0 +1,632 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.service.JigsawStudioCapture.ChunkCaptureArea; +import art.arcane.iris.core.service.JigsawStudioCapture.LocalPosition; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.World; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static art.arcane.iris.core.service.JigsawStudioCapture.chunkIntersections; +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.hydrateChunk; +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.restoreConnectorChunk; +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.validateMaterialization; +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.writeMaterializedChunk; +import static art.arcane.iris.core.service.JigsawStudioService.chunkKey; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioMaterializer { + private static final int HYDRATION_RETRY_TICKS = 2; + private static final int MAX_HYDRATION_ATTEMPTS = 40; + + private final JigsawStudioService service; + final Set materializationsInProgress = new HashSet<>(); + + JigsawStudioMaterializer(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean scheduleMaterialization(MaterializationWork work) { + String validationFailure = validateMaterialization(work.target()); + if (!validationFailure.isEmpty()) { + work.studio().generator().getSession().abortVariantSwitch(work.token()); + service.playerContext.refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); + message(work.player(), "Variant '" + work.token().targetVariant().pieceKey() + + "' cannot load: " + validationFailure); + return false; + } + String reservationFailure = beginMaterialization(work); + if (!reservationFailure.isEmpty()) { + work.studio().generator().getSession().abortVariantSwitch(work.token()); + service.playerContext.refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); + message(work.player(), reservationFailure); + return false; + } + List areas = chunkIntersections(work.workcell().bounds()); + MaterializationCoordinator coordinator = new MaterializationCoordinator(work, areas); + for (ChunkCaptureArea area : areas) { + boolean scheduled = J.runRegion( + work.world(), + area.chunkX(), + area.chunkZ(), + () -> materializeCandidateChunk(coordinator, area)); + if (!scheduled) { + coordinator.candidateComplete( + area, + "Iris could not schedule workcell chunk " + + area.chunkX() + "," + area.chunkZ() + " on its owning region.", + null); + } else { + coordinator.markScheduled(); + } + } + return coordinator.scheduledAny(); + } + + private String beginMaterialization(MaterializationWork work) { + UUID requestId = work.studio().generator().getRequest().requestId(); + synchronized (service.saveLifecycleLock) { + if (!isCurrentVariantSwitch(work)) { + return "The Jigsaw Studio changed before the variant load could start."; + } + if (service.saveLifecycle.closingRequests.contains(requestId)) { + return "This Jigsaw Studio is closing and cannot load another variant."; + } + if (service.saveLifecycle.savesInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio save to finish."; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio graph update to finish."; + } + if (service.saveLifecycle.exportsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio export to finish."; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return "Finish or close the open vanilla jigsaw-block editor before loading another variant."; + } + if (!materializationsInProgress.add(requestId)) { + return "Another Jigsaw Studio variant load or rollback is already running."; + } + return ""; + } + } + + String beginConnectorRepair(ActiveStudio studio) { + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + synchronized (service.saveLifecycleLock) { + if (!service.isCurrentRequest(studio, requestId)) { + return "This Jigsaw Studio session is no longer active."; + } + if (service.saveLifecycle.closingRequests.contains(requestId)) { + return "This Jigsaw Studio is closing and cannot reset connector blocks."; + } + if (service.saveLifecycle.savesInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio save to finish."; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio graph update to finish."; + } + if (service.saveLifecycle.exportsInProgress.contains(requestId)) { + return "Wait for the current Jigsaw Studio export to finish."; + } + if (studio.generator().getSession().operationInProgress()) { + return "Wait for the current workcell operation to finish."; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return "Finish or close the open vanilla jigsaw-block editor before resetting connectors."; + } + if (!materializationsInProgress.add(requestId)) { + return "Another Jigsaw Studio variant load or repair is already running."; + } + return ""; + } + } + + boolean scheduleConnectorRepair( + Player player, + ActiveStudio studio, + JigsawStudioBay workcell, + JigsawStudioGenerator.RenderedBay rendered, + boolean connectorsVisible + ) { + Map> connectorsByChunk = new HashMap<>(); + JigsawStudioBounds bounds = workcell.bounds(); + for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { + int worldX = bounds.originX() + connector.x(); + int worldZ = bounds.originZ() + connector.z(); + connectorsByChunk.computeIfAbsent( + chunkKey(worldX >> 4, worldZ >> 4), + ignored -> new ArrayList<>()).add(connector); + } + AtomicInteger remaining = new AtomicInteger(connectorsByChunk.size()); + AtomicReference failure = new AtomicReference<>(""); + AtomicReference cause = new AtomicReference<>(); + AtomicBoolean scheduledAny = new AtomicBoolean(false); + Map renderedBlocks = new HashMap<>(); + for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { + renderedBlocks.put(new LocalPosition(block.x(), block.y(), block.z()), block); + } + for (Map.Entry> entry + : connectorsByChunk.entrySet()) { + int chunkX = (int) (entry.getKey() >> 32); + int chunkZ = (int) entry.getKey().longValue(); + boolean scheduled = J.runRegion(studio.world(), chunkX, chunkZ, () -> { + try { + if (!studio.world().isChunkLoaded(chunkX, chunkZ)) { + throw new IOException("connector chunk " + chunkX + "," + chunkZ + + " is not loaded"); + } + restoreConnectorChunk( + studio.world(), + workcell, + entry.getValue(), + renderedBlocks, + connectorsVisible); + } catch (Throwable exception) { + failure.compareAndSet("", failureMessage(exception)); + cause.compareAndSet(null, exception); + } + if (remaining.decrementAndGet() == 0) { + completeConnectorRepair( + player, + studio, + rendered.connectors().size(), + failure.get(), + cause.get()); + } + }); + if (scheduled) { + scheduledAny.set(true); + } else { + failure.compareAndSet("", "connector chunk " + chunkX + "," + chunkZ + + " could not be scheduled on its owning region"); + if (remaining.decrementAndGet() == 0) { + completeConnectorRepair( + player, + studio, + rendered.connectors().size(), + failure.get(), + cause.get()); + } + } + } + if (!scheduledAny.get()) { + finishMaterialization(studio.generator().getRequest().requestId()); + } + return scheduledAny.get(); + } + + private void completeConnectorRepair( + Player player, + ActiveStudio studio, + int connectorCount, + String failure, + Throwable cause + ) { + UUID requestId = studio.generator().getRequest().requestId(); + boolean scheduled = J.runEntity(player, () -> { + finishMaterialization(requestId); + if (cause != null) { + IrisLogging.reportError(cause); + } + if (!failure.isEmpty()) { + message(player, "Connector reset was incomplete: " + failure + ". Retry after visiting the workcell."); + return; + } + message(player, "Restored " + connectorCount + + " connector block(s) from the last saved iteration."); + }); + if (!scheduled) { + finishMaterialization(requestId); + if (cause != null) { + IrisLogging.reportError(cause); + } + } + } + + private void finishMaterialization(UUID requestId) { + synchronized (service.saveLifecycleLock) { + materializationsInProgress.remove(requestId); + } + } + + private void materializeCandidateChunk( + MaterializationCoordinator coordinator, + ChunkCaptureArea area + ) { + MaterializationWork work = coordinator.work(); + if (!isCurrentVariantSwitch(work)) { + coordinator.candidateComplete( + area, + "Jigsaw Studio changed before the variant could finish loading.", + null); + return; + } + if (!work.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { + coordinator.candidateComplete( + area, + "Workcell chunk " + area.chunkX() + "," + area.chunkZ() + + " is not loaded. Visit the whole workcell and try again.", + null); + return; + } + try { + coordinator.markCandidateTouched(area); + writeMaterializedChunk( + work.world(), + work.workcell(), + work.target(), + area, + work.targetConnectorsVisible()); + coordinator.candidateComplete(area, "", null); + } catch (Throwable exception) { + coordinator.candidateComplete( + area, + "Variant materialization failed in chunk " + + area.chunkX() + "," + area.chunkZ() + ": " + failureMessage(exception), + exception); + } + } + + private void materializeRollbackChunk( + MaterializationCoordinator coordinator, + ChunkCaptureArea area + ) { + MaterializationWork work = coordinator.work(); + if (!isRollbackVariantSwitch(work)) { + coordinator.rollbackComplete( + area, + "Jigsaw Studio changed before the previous variant could be restored.", + null); + return; + } + if (!work.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { + coordinator.rollbackComplete( + area, + "Rollback chunk " + area.chunkX() + "," + area.chunkZ() + " is not loaded.", + null); + return; + } + try { + writeMaterializedChunk( + work.world(), + work.workcell(), + work.previous(), + area, + work.previousConnectorsVisible()); + coordinator.rollbackComplete(area, "", null); + } catch (Throwable exception) { + coordinator.rollbackComplete( + area, + "Rollback failed in chunk " + area.chunkX() + "," + area.chunkZ() + + ": " + failureMessage(exception), + exception); + } + } + + private boolean isCurrentVariantSwitch(MaterializationWork work) { + return service.isCurrentRequest( + work.studio(), + work.studio().generator().getRequest().requestId()) + && work.studio().generator().getSession().isVariantSwitchCurrent(work.token()); + } + + private boolean isRollbackVariantSwitch(MaterializationWork work) { + return service.studios.get(work.studio().worldId()) == work.studio() + && service.protection.materializationInProgress(work.studio()); + } + + void scheduleHydration( + ActiveStudio studio, + World world, + int chunkX, + int chunkZ, + int attempt + ) { + if (!service.enabled || service.studios.get(world.getUID()) != studio) { + return; + } + long key = chunkKey(chunkX, chunkZ); + if (!studio.hydrationsInProgress().add(key)) { + return; + } + boolean scheduled = J.runRegion( + world, + chunkX, + chunkZ, + () -> runHydrationAttempt(studio, world, chunkX, chunkZ, attempt, key), + HYDRATION_RETRY_TICKS); + if (!scheduled) { + studio.hydrationsInProgress().remove(key); + } + } + + private void runHydrationAttempt( + ActiveStudio studio, + World world, + int chunkX, + int chunkZ, + int attempt, + long key + ) { + studio.hydrationsInProgress().remove(key); + if (!service.enabled || service.studios.get(world.getUID()) != studio) { + return; + } + if (!world.isChunkLoaded(chunkX, chunkZ)) { + if (attempt < MAX_HYDRATION_ATTEMPTS) { + scheduleHydration(studio, world, chunkX, chunkZ, attempt + 1); + } + return; + } + if (hydrateChunk(studio, world, chunkX, chunkZ)) { + scheduleHydration(studio, world, chunkX, chunkZ, 0); + } + } + + private final class MaterializationCoordinator { + private final MaterializationWork work; + private final List areas; + private final Set candidateCompleted = new HashSet<>(); + private final Set candidateTouched = new HashSet<>(); + private final Set rollbackCompleted = new HashSet<>(); + private int candidateRemaining; + private int rollbackRemaining; + private String candidateFailure = ""; + private String rollbackFailure = ""; + private boolean rollbackStarted; + private boolean finished; + private boolean leaseReleased; + private boolean scheduledAny; + + private MaterializationCoordinator( + MaterializationWork work, + List areas + ) { + this.work = Objects.requireNonNull(work, "Jigsaw Studio materialization work"); + this.areas = List.copyOf(areas); + candidateRemaining = this.areas.size(); + } + + private MaterializationWork work() { + return work; + } + + private synchronized void markScheduled() { + scheduledAny = true; + } + + private synchronized boolean scheduledAny() { + return scheduledAny; + } + + private synchronized void markCandidateTouched(ChunkCaptureArea area) { + candidateTouched.add(chunkKey(area.chunkX(), area.chunkZ())); + } + + private void candidateComplete( + ChunkCaptureArea area, + String failure, + Throwable exception + ) { + boolean finishSuccess = false; + boolean startRollback = false; + synchronized (this) { + if (finished || rollbackStarted + || !candidateCompleted.add(chunkKey(area.chunkX(), area.chunkZ()))) { + return; + } + if (failure != null && !failure.isBlank() && candidateFailure.isEmpty()) { + candidateFailure = failure; + } + candidateRemaining--; + if (candidateRemaining == 0) { + if (candidateFailure.isEmpty()) { + finishSuccess = true; + } else { + rollbackStarted = true; + startRollback = true; + } + } + } + if (exception != null) { + IrisLogging.reportError(exception); + } + if (finishSuccess) { + finishSuccess(); + } else if (startRollback) { + scheduleRollback(); + } + } + + private void finishSuccess() { + JigsawStudioSession session = work.studio().generator().getSession(); + if (!isCurrentVariantSwitch(work) || !session.completeVariantSwitch(work.token())) { + beginLateRollback("Jigsaw Studio changed before the loaded variant could be activated."); + return; + } + if (work.connectorVisibilityChange()) { + session.setConnectorsVisible(work.workcell().stableId(), work.targetConnectorsVisible()); + } + synchronized (this) { + if (finished) { + return; + } + finished = true; + } + try { + work.studio().generator().invalidateRender(work.workcell().stableId()); + work.studio().replacePopulation(work.workcell(), work.target(), "", true); + service.playerContext.refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); + message(work.player(), work.connectorVisibilityChange() + ? "Connector blocks are now " + + (work.targetConnectorsVisible() ? "visible." : "hidden.") + : "Loaded variant '" + work.token().targetVariant().pieceKey() + + "' into " + work.workcell().stableId() + "."); + } finally { + releaseLease(); + } + } + + private void beginLateRollback(String failure) { + synchronized (this) { + if (finished || rollbackStarted) { + return; + } + candidateFailure = failure; + rollbackStarted = true; + } + scheduleRollback(); + } + + private void scheduleRollback() { + List rollbackAreas = new ArrayList<>(); + synchronized (this) { + for (ChunkCaptureArea area : areas) { + if (candidateTouched.contains(chunkKey(area.chunkX(), area.chunkZ()))) { + rollbackAreas.add(area); + } + } + rollbackRemaining = rollbackAreas.size(); + if (rollbackRemaining == 0) { + finished = true; + } + } + if (rollbackAreas.isEmpty()) { + finishRollback(); + return; + } + for (ChunkCaptureArea area : rollbackAreas) { + boolean scheduled = J.runRegion( + work.world(), + area.chunkX(), + area.chunkZ(), + () -> materializeRollbackChunk(this, area)); + if (!scheduled) { + rollbackComplete( + area, + "Iris could not schedule rollback for workcell chunk " + + area.chunkX() + "," + area.chunkZ() + ".", + null); + } + } + } + + private void rollbackComplete( + ChunkCaptureArea area, + String failure, + Throwable exception + ) { + boolean finalizeRollback = false; + synchronized (this) { + if (finished || !rollbackStarted + || !rollbackCompleted.add(chunkKey(area.chunkX(), area.chunkZ()))) { + return; + } + if (failure != null && !failure.isBlank() && rollbackFailure.isEmpty()) { + rollbackFailure = failure; + } + rollbackRemaining--; + if (rollbackRemaining == 0) { + finished = true; + finalizeRollback = true; + } + } + if (exception != null) { + IrisLogging.reportError(exception); + } + if (finalizeRollback) { + finishRollback(); + } + } + + private void finishRollback() { + JigsawStudioSession session = work.studio().generator().getSession(); + boolean released = session.abortVariantSwitch(work.token()); + try { + work.studio().generator().invalidateRender(work.workcell().stableId()); + if (rollbackFailure.isEmpty() && released) { + work.studio().replacePopulation(work.workcell(), work.previous(), "", true); + service.playerContext.refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); + message(work.player(), candidateFailure + " The previous variant was restored."); + return; + } + String failure = rollbackFailure.isEmpty() + ? "The previous variant could not be restored because the Studio session changed." + : rollbackFailure; + work.studio().replacePopulation(work.workcell(), work.previous(), failure, false); + service.playerContext.refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); + message(work.player(), candidateFailure + " Automatic rollback also failed: " + failure + + " Do not save this workcell until it is reopened."); + } finally { + releaseLease(); + } + } + + private void releaseLease() { + synchronized (this) { + if (leaseReleased) { + return; + } + leaseReleased = true; + } + finishMaterialization(work.studio().generator().getRequest().requestId()); + } + } + + record MaterializationWork( + ActiveStudio studio, + World world, + Player player, + JigsawStudioBay workcell, + JigsawStudioSession.VariantSwitchToken token, + JigsawStudioGenerator.RenderedBay previous, + JigsawStudioGenerator.RenderedBay target, + boolean previousConnectorsVisible, + boolean targetConnectorsVisible, + boolean connectorVisibilityChange + ) { + MaterializationWork { + Objects.requireNonNull(studio, "Jigsaw Studio materialization studio"); + Objects.requireNonNull(world, "Jigsaw Studio materialization world"); + Objects.requireNonNull(player, "Jigsaw Studio materialization player"); + Objects.requireNonNull(workcell, "Jigsaw Studio materialization workcell"); + Objects.requireNonNull(token, "Jigsaw Studio materialization token"); + Objects.requireNonNull(previous, "Jigsaw Studio previous rendered variant"); + Objects.requireNonNull(target, "Jigsaw Studio target rendered variant"); + } + } + + public record VariantReloadRequest( + String workcellId, + JigsawStudioGenerator.RenderedBay previous + ) { + public VariantReloadRequest { + workcellId = workcellId == null ? "" : workcellId.trim(); + if (workcellId.isEmpty()) { + throw new IllegalArgumentException("Jigsaw Studio reload workcell ID cannot be blank"); + } + Objects.requireNonNull(previous, "Jigsaw Studio previous rendered variant"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioPlayerContext.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioPlayerContext.java new file mode 100644 index 000000000..a164ecb85 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioPlayerContext.java @@ -0,0 +1,191 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioSaveLifecycle.BayReadiness; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.Bukkit; +import org.bukkit.Location; +import org.bukkit.entity.Player; + +import java.util.Map; +import java.util.Objects; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +import static art.arcane.iris.core.service.JigsawStudioProtection.ownerMatches; + +final class JigsawStudioPlayerContext { + private final JigsawStudioService service; + final Map playerWorkcells = new ConcurrentHashMap<>(); + + JigsawStudioPlayerContext(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + void refreshAllWorkcellContexts(ActiveStudio studio) { + scheduleOnlinePlayers(studio.worldId()); + } + + void scheduleOnlinePlayers(UUID worldId) { + J.runGlobal(() -> { + for (Player player : Bukkit.getOnlinePlayers()) { + J.runEntity(player, () -> { + if (player.getWorld().getUID().equals(worldId)) { + service.visualization.ensureVisualizationLoop(player); + reconcilePlayerContext(player, player.getLocation()); + } + }); + } + }); + } + + void reconcilePlayerContext(Player player, Location location) { + if (player == null) { + return; + } + Location target = location == null ? player.getLocation() : location; + if (!J.isOwnedByCurrentRegion(player) + || target.getWorld() == null + || !target.getWorld().getUID().equals(player.getWorld().getUID())) { + J.runEntity(player, () -> reconcilePlayerContext(player, player.getLocation()), 1); + return; + } + ActiveStudio studio = service.studios.get(target.getWorld().getUID()); + if (studio == null) { + clearPlayerContext(player); + return; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().findAt( + target.getBlockX(), target.getBlockY(), target.getBlockZ()); + boolean owner = ownerMatches(player, studio); + selectEnteredWorkcell(session, workcell, owner); + String workcellId = workcell == null ? "" : workcell.stableId(); + playerWorkcells.put(player.getUniqueId(), new PlayerWorkcellContext( + studio.worldId(), + studio.generator().getRequest().requestId(), + workcellId)); + + JigsawStudioVariant variant = workcell == null + ? null + : session.activeVariant(workcell.stableId()).orElse(null); + JigsawStudioBoardState state = boardState(studio, session, workcell, variant); + String workcellRole = workcell == null ? "" : workcell.canonicalDisplayName(); + String workcellName = workcell == null ? "" : workcell.displayName(); + String variantName = variant == null ? "" : variant.resolvedDisplayName(); + String hint = "Triple-sneak for controls"; + boardService().applyJigsawContext(player, new JigsawStudioBoardContext( + studio.worldId(), + studio.generator().getRequest().requestId(), + studio.generator().getRequest().structureKey(), + session.layout().mode(), + workcellRole, + workcellName, + variantName, + state, + hint)); + } + + static boolean selectEnteredWorkcell( + JigsawStudioSession session, + JigsawStudioBay workcell, + boolean owner + ) { + return owner && workcell != null && session.selectBay(workcell.stableId()); + } + + void refreshWorkcellContext(UUID worldId, String workcellId) { + if (worldId == null || workcellId == null) { + return; + } + J.runGlobal(() -> { + for (Player player : Bukkit.getOnlinePlayers()) { + J.runEntity(player, () -> { + if (!player.getWorld().getUID().equals(worldId)) { + return; + } + PlayerWorkcellContext context = playerWorkcells.get(player.getUniqueId()); + if (context != null && workcellId.equals(context.workcellId())) { + reconcilePlayerContext(player, player.getLocation()); + } + }); + } + }); + } + + void clearWorldPlayerContexts(UUID worldId) { + J.runGlobal(() -> { + for (Player player : Bukkit.getOnlinePlayers()) { + J.runEntity(player, () -> { + PlayerWorkcellContext context = playerWorkcells.get(player.getUniqueId()); + if (context != null && context.worldId().equals(worldId)) { + service.toolbelt.closeMenu(player); + clearPlayerContext(player); + } + }); + } + }); + } + + private void clearPlayerContext(Player player) { + if (player == null) { + return; + } + playerWorkcells.remove(player.getUniqueId()); + boardService().clearJigsawContext(player); + } + + static BoardSVC boardService() { + return IrisServices.get(BoardSVC.class); + } + + private static JigsawStudioBoardState boardState( + ActiveStudio studio, + JigsawStudioSession session, + JigsawStudioBay workcell, + JigsawStudioVariant variant + ) { + if (workcell == null) { + return JigsawStudioBoardState.SAVED; + } + JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcell.stableId()); + if (snapshot.switchInProgress()) { + return JigsawStudioBoardState.LOADING; + } + if (snapshot.saveInProgress()) { + return JigsawStudioBoardState.SAVING; + } + if (!workcell.enabled()) { + return JigsawStudioBoardState.DISABLED; + } + if (variant != null && !variant.owned()) { + return JigsawStudioBoardState.READ_ONLY; + } + BayReadiness readiness = studio.population(workcell).readiness(); + if (!readiness.failure().isEmpty()) { + return JigsawStudioBoardState.INVALID; + } + return snapshot.dirty() ? JigsawStudioBoardState.UNSAVED : JigsawStudioBoardState.SAVED; + } + + private static String displayKey(String resourceKey) { + int separator = resourceKey.lastIndexOf('/'); + return separator < 0 ? resourceKey : resourceKey.substring(separator + 1); + } + + private record PlayerWorkcellContext( + UUID worldId, + UUID requestId, + String workcellId + ) { + PlayerWorkcellContext { + Objects.requireNonNull(worldId, "Jigsaw Studio player-context world ID"); + Objects.requireNonNull(requestId, "Jigsaw Studio player-context request ID"); + workcellId = workcellId == null ? "" : workcellId; + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtection.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtection.java new file mode 100644 index 000000000..b30bdf2fc --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtection.java @@ -0,0 +1,396 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioControlPosition; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import org.bukkit.Material; +import org.bukkit.block.Block; +import org.bukkit.block.BlockFace; +import org.bukkit.block.BlockState; +import org.bukkit.block.DoubleChest; +import org.bukkit.entity.Player; +import org.bukkit.inventory.BlockInventoryHolder; +import org.bukkit.inventory.Inventory; +import org.bukkit.inventory.InventoryHolder; + +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; + +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioProtection { + private static final Set MUTATING_COMMANDS = Set.of( + "biome", "brush", "chunk", "clone", "copy", "cut", "data", "deform", "drain", + "execute", "faces", "fill", "fillbiome", "fixlava", "fixwater", "flip", "flora", + "forest", "function", "gmask", "green", "hollow", "item", "load", "mask", "move", + "naturalize", "overlay", "paste", "place", "redo", "regen", "replace", "replacenear", + "restore", "rotate", "schedule", "schem", "schematic", "set", "setblock", "smooth", + "snow", "sphere", "stack", "thaw", "undo", "walls"); + + private static final Set SAFE_NON_OWNER_COMMANDS = Set.of( + "help", "list", "me", "msg", "ping", "pl", "plugins", "r", "reply", "rules", + "say", "tell", "ver", "version", "w", "whisper"); + + private final JigsawStudioService service; + + JigsawStudioProtection(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean blocksInventoryMutation(Inventory inventory, UUID actorId) { + for (Block block : inventoryBlocks(inventory)) { + StudioBlockMutationContext context = studioBlockMutationContext(block); + if (context != null && blocksStudioInventoryMutation( + true, + context.immutable(), + materializationInProgress(context.studio()), + service.saveLifecycle.reopenRequiredRequests.contains(context.requestId()), + context.ownerId(), + actorId)) { + return true; + } + } + return false; + } + + boolean blocksMachineMutation(Block block) { + StudioBlockMutationContext context = studioBlockMutationContext(block); + return context != null && blocksStudioInventoryMutation( + true, + context.immutable(), + materializationInProgress(context.studio()), + service.saveLifecycle.reopenRequiredRequests.contains(context.requestId()), + context.ownerId(), + null); + } + + private StudioBlockMutationContext studioBlockMutationContext(Block block) { + if (block == null) { + return null; + } + ActiveStudio studio = service.studios.get(block.getWorld().getUID()); + if (studio == null) { + return null; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + boolean preview = service.previewRenderer.contains( + request.requestId(), block.getX(), block.getY(), block.getZ()); + JigsawStudioControlPosition control = studio.generator().getLayout().controlPosition(); + boolean controlChest = block.getType() == Material.CHEST + && block.getX() == control.worldX() + && block.getY() == control.worldY() + && block.getZ() == control.worldZ(); + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay bay = session.layout().findAt( + block.getX(), block.getY(), block.getZ()); + boolean workcell = bay != null; + if (!preview && !controlChest && !workcell) { + return null; + } + JigsawStudioVariant variant = bay == null + ? null + : session.activeVariant(bay.stableId()).orElse(null); + boolean nonEditableWorkcell = bay != null && (variant == null || !variant.owned()); + return new StudioBlockMutationContext( + studio, + request.requestId(), + request.ownerId(), + preview || controlChest || nonEditableWorkcell); + } + + static List inventoryBlocks(Inventory inventory) { + if (inventory == null) { + return List.of(); + } + List blocks = new ArrayList<>(2); + InventoryHolder holder = inventory.getHolder(); + if (holder instanceof BlockInventoryHolder blockInventoryHolder) { + blocks.add(blockInventoryHolder.getBlock()); + } else if (holder instanceof DoubleChest doubleChest) { + addInventoryBlock(blocks, doubleChest.getLeftSide()); + addInventoryBlock(blocks, doubleChest.getRightSide()); + } + return blocks; + } + + private static void addInventoryBlock(List blocks, InventoryHolder holder) { + if (holder instanceof BlockInventoryHolder blockInventoryHolder + && !blocks.contains(blockInventoryHolder.getBlock())) { + blocks.add(blockInventoryHolder.getBlock()); + } + } + + static boolean isMutatingCommand(String commandLine) { + return MUTATING_COMMANDS.contains(commandLabel(commandLine)); + } + + static boolean blocksMutatingCommand(UUID ownerId, UUID actorId, String commandLine) { + return !ownerMatches(ownerId, actorId) + && !isSafeNonOwnerCommand(commandLine); + } + + static boolean blocksNonEditableWorkcellMutation( + boolean hasNonEditableWorkcell, + String commandLine + ) { + return hasNonEditableWorkcell && isMutatingCommand(commandLine); + } + + static boolean canToggleVariantRotation( + JigsawStudioCompatibilityTarget compatibilityTarget, + JigsawStudioVariant variant + ) { + JigsawStudioCompatibilityTarget target = Objects.requireNonNull( + compatibilityTarget, + "Jigsaw Studio compatibility target"); + JigsawStudioVariant activeVariant = Objects.requireNonNull(variant, "Jigsaw Studio variant"); + return activeVariant.owned() + && (target != JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + || !activeVariant.rotatable()); + } + + static boolean isSafeNonOwnerCommand(String commandLine) { + String normalized = normalizeCommandLine(commandLine); + String label = commandLabel(normalized); + if (SAFE_NON_OWNER_COMMANDS.contains(label)) { + return true; + } + int separator = normalized.indexOf(' '); + if (!label.equals("iris") || separator < 0) { + return false; + } + String arguments = normalized.substring(separator + 1).trim(); + return arguments.equals("jigsaw status") || arguments.startsWith("jigsaw status "); + } + + private static String commandLabel(String commandLine) { + String normalized = normalizeCommandLine(commandLine); + int separator = normalized.indexOf(' '); + String label = separator < 0 ? normalized : normalized.substring(0, separator); + int namespace = label.lastIndexOf(':'); + return namespace < 0 ? label : label.substring(namespace + 1); + } + + private static String normalizeCommandLine(String commandLine) { + if (commandLine == null) { + return ""; + } + String normalized = commandLine.trim().toLowerCase(Locale.ROOT); + while (normalized.startsWith("/")) { + normalized = normalized.substring(1); + } + return normalized; + } + + static boolean ownerMatches(Player player, ActiveStudio studio) { + if (player == null || studio == null) { + return false; + } + UUID ownerId = studio.generator().getRequest().ownerId(); + return ownerMatches(ownerId, player.getUniqueId()); + } + + static boolean canCreateVariants(JigsawStudioLayout layout) { + return Objects.requireNonNull(layout, "Jigsaw Studio layout") + .variantCatalog() + .editableGraph(); + } + + static String variantCreationSourceFailure( + JigsawStudioVariant activeVariant, + boolean duplicateActive + ) { + if (activeVariant == null) { + return duplicateActive + ? "This workcell has no active variant to duplicate." + : "This workcell has no active variant whose pool role can be copied. Use " + + "/iris jigsaw piece create to choose an owned pool explicitly."; + } + if (!activeVariant.owned()) { + return "Adopt or clone this graph before creating from its read-only variant."; + } + if (activeVariant.memberships().isEmpty()) { + return "The active variant has no owned pool membership to copy. Use " + + "/iris jigsaw piece create to choose an owned pool explicitly."; + } + return ""; + } + + static boolean ownerMatches(UUID ownerId, UUID actorId) { + return ownerId == null || ownerId.equals(actorId); + } + + static boolean authorizeOwner(Player player, ActiveStudio studio) { + if (ownerMatches(player, studio)) { + return true; + } + message(player, "This Jigsaw Studio is owned by another player session."); + return false; + } + + boolean isUnauthorizedStudioEdit(Player player, Block block) { + if (player == null || block == null) { + return false; + } + ActiveStudio studio = service.studios.get(block.getWorld().getUID()); + if (studio == null) { + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + if (service.previewRenderer.contains(requestId, block.getX(), block.getY(), block.getZ())) { + message(player, "The seed-1337 Jigsaw preview is read-only and refreshes automatically."); + return true; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay bay = session.layout().findAt(block.getX(), block.getY(), block.getZ()); + JigsawStudioVariant variant = bay == null + ? null + : session.activeVariant(bay.stableId()).orElse(null); + if (bay != null && (variant == null || !variant.owned())) { + message(player, variant == null + ? "This empty Jigsaw Studio workcell has no loaded editable variant. Load one before editing it." + : "This Jigsaw Studio variant is read-only. Adopt or clone its graph before editing it."); + return true; + } + if (service.saveLifecycle.reopenRequiredRequests.contains(requestId)) { + message(player, "Close and reopen Jigsaw Studio before editing the resized layout."); + return true; + } + if (materializationInProgress(studio)) { + message(player, "Wait for the current Jigsaw Studio variant load or rollback to finish."); + return true; + } + if (!blocksStudioEdit(studio.generator().getRequest().ownerId(), player.getUniqueId())) { + return false; + } + message(player, "This Jigsaw Studio is owned by another player session."); + return true; + } + + boolean materializationInProgress(ActiveStudio studio) { + if (studio == null) { + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + synchronized (service.saveLifecycleLock) { + return service.materializer.materializationsInProgress.contains(requestId); + } + } + + boolean anyMaterializationInProgress() { + synchronized (service.saveLifecycleLock) { + return !service.materializer.materializationsInProgress.isEmpty(); + } + } + + boolean anyNonEditableWorkcell() { + for (ActiveStudio studio : service.studios.values()) { + if (hasNonEditableWorkcell(studio)) { + return true; + } + } + return false; + } + + static boolean hasNonEditableWorkcell(ActiveStudio studio) { + JigsawStudioSession session = studio.generator().getSession(); + for (JigsawStudioBay bay : session.layout().bays()) { + JigsawStudioVariant variant = session.activeVariant(bay.stableId()).orElse(null); + if (variant == null || !variant.owned()) { + return true; + } + } + return false; + } + + static boolean blocksStudioEdit(UUID ownerId, UUID actorId) { + return !ownerMatches(ownerId, actorId); + } + + static boolean blocksStudioInventoryMutation( + boolean studioBlockInventory, + boolean immutable, + boolean materializing, + boolean reopenRequired, + UUID ownerId, + UUID actorId + ) { + return studioBlockInventory + && (immutable + || materializing + || reopenRequired + || actorId != null && blocksStudioEdit(ownerId, actorId)); + } + + boolean movesProtectedBlocks(List blocks, BlockFace direction) { + for (Block block : blocks) { + if (isImmutableStudioBlock(block) + || isImmutableStudioBlock(block.getRelative(direction)) + || isImmutableStudioBlock(block.getRelative(direction.getOppositeFace()))) { + return true; + } + } + return false; + } + + boolean containsImmutableStudioBlock(List states) { + for (BlockState state : states) { + if (isImmutableStudioBlock(state.getBlock())) { + return true; + } + } + return false; + } + + boolean isImmutableStudioBlock(Block block) { + StudioBlockMutationContext context = studioBlockMutationContext(block); + return context != null && context.immutable(); + } + + private boolean isPreviewBlock(Block block) { + if (block == null) { + return false; + } + ActiveStudio studio = service.studios.get(block.getWorld().getUID()); + if (studio == null) { + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + return service.previewRenderer.contains(requestId, block.getX(), block.getY(), block.getZ()); + } + + boolean isControlChest(Block block) { + if (block == null || block.getType() != Material.CHEST) { + return false; + } + ActiveStudio studio = service.studios.get(block.getWorld().getUID()); + if (studio == null) { + return false; + } + JigsawStudioControlPosition control = studio.generator().getLayout().controlPosition(); + return block.getX() == control.worldX() + && block.getY() == control.worldY() + && block.getZ() == control.worldZ(); + } + + private record StudioBlockMutationContext( + ActiveStudio studio, + UUID requestId, + UUID ownerId, + boolean immutable + ) { + private StudioBlockMutationContext { + Objects.requireNonNull(studio, "Jigsaw Studio block mutation studio"); + Objects.requireNonNull(requestId, "Jigsaw Studio block mutation request ID"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtectionListener.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtectionListener.java new file mode 100644 index 000000000..7e9b4990b --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioProtectionListener.java @@ -0,0 +1,710 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioTripleSneakTracker; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.spi.IrisLogging; +import org.bukkit.Material; +import org.bukkit.block.Block; +import org.bukkit.block.BlockState; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.EventPriority; +import org.bukkit.event.Listener; +import org.bukkit.event.block.Action; +import org.bukkit.event.block.BlockBreakEvent; +import org.bukkit.event.block.BlockBurnEvent; +import org.bukkit.event.block.BlockCookEvent; +import org.bukkit.event.block.BlockDispenseEvent; +import org.bukkit.event.block.BlockExplodeEvent; +import org.bukkit.event.block.BlockFadeEvent; +import org.bukkit.event.block.BlockFormEvent; +import org.bukkit.event.block.BlockFromToEvent; +import org.bukkit.event.block.BlockGrowEvent; +import org.bukkit.event.block.BlockMultiPlaceEvent; +import org.bukkit.event.block.BlockPistonExtendEvent; +import org.bukkit.event.block.BlockPistonRetractEvent; +import org.bukkit.event.block.BlockPlaceEvent; +import org.bukkit.event.block.BlockRedstoneEvent; +import org.bukkit.event.block.BlockSpreadEvent; +import org.bukkit.event.block.BrewingStartEvent; +import org.bukkit.event.block.CrafterCraftEvent; +import org.bukkit.event.entity.CreatureSpawnEvent; +import org.bukkit.event.entity.EntityChangeBlockEvent; +import org.bukkit.event.entity.EntityExplodeEvent; +import org.bukkit.event.inventory.BrewEvent; +import org.bukkit.event.inventory.BrewingStandFuelEvent; +import org.bukkit.event.inventory.FurnaceBurnEvent; +import org.bukkit.event.inventory.FurnaceStartSmeltEvent; +import org.bukkit.event.inventory.InventoryClickEvent; +import org.bukkit.event.inventory.InventoryCloseEvent; +import org.bukkit.event.inventory.InventoryDragEvent; +import org.bukkit.event.inventory.InventoryMoveItemEvent; +import org.bukkit.event.inventory.InventoryPickupItemEvent; +import org.bukkit.event.player.PlayerBucketEmptyEvent; +import org.bukkit.event.player.PlayerBucketFillEvent; +import org.bukkit.event.player.PlayerChangedWorldEvent; +import org.bukkit.event.player.PlayerCommandPreprocessEvent; +import org.bukkit.event.player.PlayerInteractEvent; +import org.bukkit.event.player.PlayerJoinEvent; +import org.bukkit.event.player.PlayerMoveEvent; +import org.bukkit.event.player.PlayerPortalEvent; +import org.bukkit.event.player.PlayerQuitEvent; +import org.bukkit.event.player.PlayerRespawnEvent; +import org.bukkit.event.player.PlayerTeleportEvent; +import org.bukkit.event.player.PlayerToggleSneakEvent; +import org.bukkit.event.server.ServerCommandEvent; +import org.bukkit.event.world.ChunkLoadEvent; +import org.bukkit.event.world.StructureGrowEvent; +import org.bukkit.event.world.WorldUnloadEvent; +import org.bukkit.inventory.EquipmentSlot; + +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; + +import static art.arcane.iris.core.service.JigsawStudioPlayerContext.boardService; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioProtection.blocksMutatingCommand; +import static art.arcane.iris.core.service.JigsawStudioProtection.blocksNonEditableWorkcellMutation; +import static art.arcane.iris.core.service.JigsawStudioProtection.hasNonEditableWorkcell; +import static art.arcane.iris.core.service.JigsawStudioProtection.isMutatingCommand; +import static art.arcane.iris.core.service.JigsawStudioProtection.isSafeNonOwnerCommand; +import static art.arcane.iris.core.service.JigsawStudioProtection.ownerMatches; +import static art.arcane.iris.core.service.JigsawStudioService.isNaturalStudioSpawn; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioService.sameBlockPosition; + +final class JigsawStudioProtectionListener implements Listener { + private final JigsawStudioService service; + + JigsawStudioProtectionListener(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onWorldUnload(WorldUnloadEvent event) { + ActiveStudio studio = service.studios.get(event.getWorld().getUID()); + if (studio != null) { + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + if (service.saveLifecycle.requiresLifecycleDrain(studio) + && !service.saveLifecycle.discardingRequest(requestId)) { + event.setCancelled(true); + service.autosaveScheduler.expediteAutosaves(requestId); + IrisLogging.warn("Jigsaw Studio kept world %s loaded while pending edits finish autosaving", + event.getWorld().getName()); + return; + } + } + service.registry.unregister(event.getWorld()); + } + + @EventHandler + public void onChunkLoad(ChunkLoadEvent event) { + ActiveStudio studio = service.studios.get(event.getWorld().getUID()); + if (studio != null) { + service.registry.markChunkAvailable(studio, event.getChunk().getX(), event.getChunk().getZ()); + } + } + + @EventHandler + public void onPlayerJoin(PlayerJoinEvent event) { + service.visualization.ensureVisualizationLoop(event.getPlayer()); + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getPlayer().getLocation()); + } + + @EventHandler + public void onPlayerChangedWorld(PlayerChangedWorldEvent event) { + service.toolbelt.closeMenu(event.getPlayer()); + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + service.tripleSneakTracker.clearPlayer(event.getPlayer().getUniqueId()); + service.visualization.visualizationLoops.remove(event.getPlayer().getUniqueId()); + service.visualization.assemblyPreviews.remove(event.getPlayer().getUniqueId()); + service.playerContext.playerWorkcells.remove(event.getPlayer().getUniqueId()); + service.visualization.ensureVisualizationLoop(event.getPlayer()); + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getPlayer().getLocation()); + } + + @EventHandler + public void onPlayerQuit(PlayerQuitEvent event) { + UUID playerId = event.getPlayer().getUniqueId(); + service.toolbelt.closeMenu(event.getPlayer()); + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(playerId); + service.tripleSneakTracker.clearPlayer(playerId); + service.toolbelt.toolConfirmations.remove(playerId); + service.visualization.visualizationLoops.remove(playerId); + service.particlesDisabled.remove(playerId); + service.visualization.assemblyPreviews.remove(playerId); + service.playerContext.playerWorkcells.remove(playerId); + service.toolbelt.deferredDuplications.entrySet().removeIf( + entry -> entry.getValue().playerId().equals(playerId)); + boardService().clearJigsawContext(event.getPlayer()); + } + + @EventHandler + public void onTripleSneak(PlayerToggleSneakEvent event) { + if (!event.isSneaking()) { + return; + } + Player player = event.getPlayer(); + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !ownerMatches(player, studio)) { + service.tripleSneakTracker.clearPlayer(player.getUniqueId()); + return; + } + JigsawStudioTripleSneakTracker.Progress progress = service.tripleSneakTracker.recordSneak( + player.getUniqueId(), + studio.worldId(), + studio.generator().getRequest().requestId(), + System.nanoTime()); + if (progress == JigsawStudioTripleSneakTracker.Progress.TRIGGERED) { + service.toolbelt.openControlMenu(player); + } + } + + @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) + public void onUseTool(PlayerInteractEvent event) { + if (event.getHand() != EquipmentSlot.HAND + || (event.getAction() != Action.RIGHT_CLICK_AIR + && event.getAction() != Action.RIGHT_CLICK_BLOCK)) { + return; + } + Optional decoded = service.toolbelt.toolCodec.decode(event.getItem()); + if (decoded.isEmpty()) { + return; + } + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + event.setCancelled(true); + service.toolbelt.useTool(event.getPlayer(), decoded.get(), event.getItem(), event.getPlayer().isSneaking()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPlayerMove(PlayerMoveEvent event) { + if (sameBlockPosition(event.getFrom(), event.getTo())) { + return; + } + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getTo()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPlayerTeleport(PlayerTeleportEvent event) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getTo()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPlayerPortal(PlayerPortalEvent event) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getTo()); + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onPlayerRespawn(PlayerRespawnEvent event) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + service.playerContext.reconcilePlayerContext(event.getPlayer(), event.getRespawnLocation()); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onNaturalCreatureSpawn(CreatureSpawnEvent event) { + if (service.studios.containsKey(event.getLocation().getWorld().getUID()) + && isNaturalStudioSpawn(event.getSpawnReason())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedBlockPlace(BlockPlaceEvent event) { + if (service.protection.isUnauthorizedStudioEdit(event.getPlayer(), event.getBlockPlaced())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedBlockMultiPlace(BlockMultiPlaceEvent event) { + for (BlockState state : event.getReplacedBlockStates()) { + if (service.protection.isUnauthorizedStudioEdit(event.getPlayer(), state.getBlock())) { + event.setCancelled(true); + return; + } + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockBreak(BlockBreakEvent event) { + if (service.protection.isControlChest(event.getBlock())) { + event.setCancelled(true); + message(event.getPlayer(), "The Jigsaw Studio control chest cannot be removed."); + return; + } + if (service.protection.isUnauthorizedStudioEdit(event.getPlayer(), event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedBucketEmpty(PlayerBucketEmptyEvent event) { + Block target = event.getBlockClicked().getRelative(event.getBlockFace()); + if (service.protection.isUnauthorizedStudioEdit(event.getPlayer(), target)) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedBucketFill(PlayerBucketFillEvent event) { + if (service.protection.isUnauthorizedStudioEdit(event.getPlayer(), event.getBlockClicked())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedInteract(PlayerInteractEvent event) { + if (event.getAction() == Action.RIGHT_CLICK_BLOCK + && !service.protection.isControlChest(event.getClickedBlock()) + && service.protection.isUnauthorizedStudioEdit(event.getPlayer(), event.getClickedBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockPlace(BlockPlaceEvent event) { + service.dirtyTracker.markDirty(event.getBlockPlaced()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockMultiPlace(BlockMultiPlaceEvent event) { + for (BlockState state : event.getReplacedBlockStates()) { + service.dirtyTracker.markDirty(state.getBlock()); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockBreak(BlockBreakEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBucketEmpty(PlayerBucketEmptyEvent event) { + service.dirtyTracker.markDirty(event.getBlockClicked().getRelative(event.getBlockFace())); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBucketFill(PlayerBucketFillEvent event) { + service.dirtyTracker.markDirty(event.getBlockClicked()); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onControlChest(PlayerInteractEvent event) { + if (event.getAction() != Action.RIGHT_CLICK_BLOCK + || event.getHand() != EquipmentSlot.HAND + || !service.protection.isControlChest(event.getClickedBlock())) { + return; + } + event.setCancelled(true); + ActiveStudio studio = service.studios.get(event.getPlayer().getWorld().getUID()); + if (!authorizeOwner(event.getPlayer(), studio)) { + return; + } + service.toolbelt.openControlMenu(event.getPlayer()); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockExplode(BlockExplodeEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID()))) { + event.blockList().clear(); + return; + } + event.blockList().removeIf(service.protection::isImmutableStudioBlock); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedEntityExplode(EntityExplodeEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getEntity().getWorld().getUID()))) { + event.blockList().clear(); + return; + } + event.blockList().removeIf(service.protection::isImmutableStudioBlock); + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedPistonExtend(BlockPistonExtendEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.movesProtectedBlocks(event.getBlocks(), event.getDirection())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedPistonRetract(BlockPistonRetractEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.movesProtectedBlocks(event.getBlocks(), event.getDirection())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedEntityChangeBlock(EntityChangeBlockEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockFromTo(BlockFromToEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock()) + || service.protection.isImmutableStudioBlock(event.getToBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockForm(BlockFormEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockGrow(BlockGrowEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockSpread(BlockSpreadEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock()) + || service.protection.isImmutableStudioBlock(event.getSource())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockFade(BlockFadeEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockBurn(BlockBurnEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST) + public void onProtectedBlockRedstone(BlockRedstoneEvent event) { + if (service.protection.materializationInProgress(service.studios.get(event.getBlock().getWorld().getUID())) + || service.protection.isImmutableStudioBlock(event.getBlock())) { + event.setNewCurrent(event.getOldCurrent()); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedStructureGrow(StructureGrowEvent event) { + if (event.getLocation().getWorld() != null + && (service.protection.materializationInProgress( + service.studios.get(event.getLocation().getWorld().getUID())) + || service.protection.containsImmutableStudioBlock(event.getBlocks()))) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedInventoryClick(InventoryClickEvent event) { + if (!service.protection.blocksInventoryMutation( + event.getView().getTopInventory(), + event.getWhoClicked().getUniqueId())) { + return; + } + event.setCancelled(true); + if (event.getWhoClicked() instanceof Player player) { + message(player, "This Jigsaw Studio container is read-only during the current operation or owner session."); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedInventoryDrag(InventoryDragEvent event) { + if (!service.protection.blocksInventoryMutation( + event.getView().getTopInventory(), + event.getWhoClicked().getUniqueId())) { + return; + } + event.setCancelled(true); + if (event.getWhoClicked() instanceof Player player) { + message(player, "This Jigsaw Studio container is read-only during the current operation or owner session."); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedInventoryMove(InventoryMoveItemEvent event) { + if (service.protection.blocksInventoryMutation(event.getSource(), null) + || service.protection.blocksInventoryMutation(event.getDestination(), null)) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedInventoryPickup(InventoryPickupItemEvent event) { + if (service.protection.blocksInventoryMutation(event.getInventory(), null)) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockCook(BlockCookEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedFurnaceBurn(FurnaceBurnEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBrew(BrewEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBrewingStandFuel(BrewingStandFuelEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedBlockDispense(BlockDispenseEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onProtectedCrafterCraft(CrafterCraftEvent event) { + if (service.protection.blocksMachineMutation(event.getBlock())) { + event.setCancelled(true); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPlayerInteract(PlayerInteractEvent event) { + if (event.getAction() != Action.RIGHT_CLICK_BLOCK && event.getAction() != Action.PHYSICAL) { + return; + } + Block clicked = event.getClickedBlock(); + if (clicked != null) { + if (event.getAction() == Action.RIGHT_CLICK_BLOCK) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + if (clicked.getType() == Material.JIGSAW) { + service.tileWatcher.startJigsawTileWatch(event.getPlayer(), clicked); + } + } + service.dirtyTracker.markDirty(clicked); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onInventoryClick(InventoryClickEvent event) { + service.dirtyTracker.markDirty(event.getView().getTopInventory()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onInventoryDrag(InventoryDragEvent event) { + service.dirtyTracker.markDirty(event.getView().getTopInventory()); + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onInventoryClose(InventoryCloseEvent event) { + service.dirtyTracker.markDirty(event.getView().getTopInventory()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onInventoryMove(InventoryMoveItemEvent event) { + service.dirtyTracker.markDirty(event.getSource()); + service.dirtyTracker.markDirty(event.getDestination()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onInventoryPickup(InventoryPickupItemEvent event) { + service.dirtyTracker.markDirty(event.getInventory()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockCook(BlockCookEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onFurnaceBurn(FurnaceBurnEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onFurnaceStartSmelt(FurnaceStartSmeltEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBrew(BrewEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onBrewingStart(BrewingStartEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBrewingStandFuel(BrewingStandFuelEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockDispense(BlockDispenseEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onCrafterCraft(CrafterCraftEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockExplode(BlockExplodeEvent event) { + service.dirtyTracker.markDirty(event.blockList()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onEntityExplode(EntityExplodeEvent event) { + service.dirtyTracker.markDirty(event.blockList()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onEntityChangeBlock(EntityChangeBlockEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockFromTo(BlockFromToEvent event) { + service.dirtyTracker.markDirty(event.getToBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockForm(BlockFormEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockGrow(BlockGrowEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockSpread(BlockSpreadEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockFade(BlockFadeEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockBurn(BlockBurnEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onBlockRedstone(BlockRedstoneEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPistonExtend(BlockPistonExtendEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + service.dirtyTracker.markDirty(event.getBlock().getRelative(event.getDirection())); + for (Block block : event.getBlocks()) { + service.dirtyTracker.markDirty(block); + service.dirtyTracker.markDirty(block.getRelative(event.getDirection())); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPistonRetract(BlockPistonRetractEvent event) { + service.dirtyTracker.markDirty(event.getBlock()); + service.dirtyTracker.markDirty(event.getBlock().getRelative(event.getDirection())); + for (Block block : event.getBlocks()) { + service.dirtyTracker.markDirty(block); + service.dirtyTracker.markDirty(block.getRelative(event.getDirection())); + } + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onStructureGrow(StructureGrowEvent event) { + for (BlockState state : event.getBlocks()) { + service.dirtyTracker.markDirty(state.getBlock()); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onUnauthorizedPlayerCommand(PlayerCommandPreprocessEvent event) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); + ActiveStudio studio = service.studios.get(event.getPlayer().getWorld().getUID()); + if (studio != null + && service.protection.materializationInProgress(studio) + && !isSafeNonOwnerCommand(event.getMessage())) { + event.setCancelled(true); + message(event.getPlayer(), "Wait for the current Jigsaw Studio variant load or rollback to finish."); + return; + } + if (studio != null && blocksNonEditableWorkcellMutation( + hasNonEditableWorkcell(studio), event.getMessage())) { + event.setCancelled(true); + message(event.getPlayer(), "Mutating commands are disabled while this Studio has an empty or read-only workcell."); + return; + } + UUID ownerId = studio == null ? null : studio.generator().getRequest().ownerId(); + if (!blocksMutatingCommand(ownerId, event.getPlayer().getUniqueId(), event.getMessage())) { + return; + } + event.setCancelled(true); + message(event.getPlayer(), "This Jigsaw Studio is owned by another player session."); + } + + @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) + public void onPlayerCommand(PlayerCommandPreprocessEvent event) { + if (isMutatingCommand(event.getMessage())) { + service.dirtyTracker.markAllDirty(event.getPlayer().getWorld()); + } + } + + @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) + public void onServerCommand(ServerCommandEvent event) { + if (!isSafeNonOwnerCommand(event.getCommand()) && service.protection.anyMaterializationInProgress()) { + event.setCancelled(true); + return; + } + if (isMutatingCommand(event.getCommand()) && service.protection.anyNonEditableWorkcell()) { + event.setCancelled(true); + return; + } + if (isMutatingCommand(event.getCommand())) { + service.dirtyTracker.markAllDirty(); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioRegistry.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioRegistry.java new file mode 100644 index 000000000..1667b2a46 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioRegistry.java @@ -0,0 +1,271 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.service.JigsawStudioChunkWriter.BayPopulation; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.framework.Engine; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.platform.bukkit.BukkitWorldBinding; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.World; + +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicLong; + +import static art.arcane.iris.core.service.JigsawStudioService.AUTOSAVE_RETRY_TICKS; +import static art.arcane.iris.core.service.JigsawStudioService.INSTANCE; +import static art.arcane.iris.core.service.JigsawStudioService.disableNaturalStudioSpawning; + +final class JigsawStudioRegistry { + private final JigsawStudioService service; + private final Set unregisterRetries = ConcurrentHashMap.newKeySet(); + private final Set unregisterDrainWarnings = ConcurrentHashMap.newKeySet(); + + JigsawStudioRegistry(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + void quiesceForServerShutdown() { + if (!service.disableStarted.compareAndSet(false, true)) { + return; + } + try { + service.tileWatcher.finalizeAllJigsawTileWatches(); + } catch (Throwable exception) { + IrisLogging.reportError("Failed to finalize Jigsaw Studio tile watches during shutdown.", exception); + } + try { + service.autosaveScheduler.drainAutosavesBeforeDisable(); + } catch (Throwable exception) { + IrisLogging.reportError("Failed to drain Jigsaw Studio autosaves during shutdown.", exception); + } + service.enabled = false; + JigsawStudioMenuController activeMenuController = service.toolbelt.menuController; + service.toolbelt.menuController = null; + if (activeMenuController != null) { + try { + activeMenuController.closeAll(); + } catch (Throwable exception) { + IrisLogging.reportError("Failed to close Jigsaw Studio menus during shutdown.", exception); + } + } + service.particlesDisabled.clear(); + service.visualization.visualizationLoops.clear(); + service.visualization.assemblyPreviews.clear(); + service.playerContext.playerWorkcells.clear(); + service.autosaveScheduler.autosaves.clear(); + service.toolbelt.deferredDuplications.clear(); + service.tileWatcher.jigsawTileWatches.clear(); + service.toolbelt.toolConfirmations.clear(); + service.tripleSneakTracker.clearAll(); + service.evaluator.evaluations.clear(); + try { + service.previewRenderer.removeAll(); + } catch (Throwable exception) { + IrisLogging.reportError("Failed to remove Jigsaw Studio previews during shutdown.", exception); + } + service.saveLifecycle.reopenRequiredRequests.clear(); + unregisterRetries.clear(); + unregisterDrainWarnings.clear(); + synchronized (service.saveLifecycleLock) { + service.studios.clear(); + service.saveLifecycle.savesInProgress.clear(); + service.graphMutations.graphMutationsInProgress.clear(); + service.materializer.materializationsInProgress.clear(); + service.saveLifecycle.exportsInProgress.clear(); + service.saveLifecycle.closingRequests.clear(); + service.saveLifecycle.discardingRequests.clear(); + } + INSTANCE = null; + } + + void register(Engine engine, JigsawStudioGenerator generator) { + if (!service.enabled || service.disableStarted.get()) { + return; + } + Engine activeEngine = Objects.requireNonNull(engine, "Jigsaw Studio engine"); + JigsawStudioGenerator activeGenerator = Objects.requireNonNull(generator, "Jigsaw Studio generator"); + World world = BukkitWorldBinding.world(activeEngine.getTarget().getWorld()); + if (world == null) { + return; + } + ActiveStudio existing = service.studios.get(world.getUID()); + if (existing != null && existing.generator() == activeGenerator) { + return; + } + if (existing != null) { + UUID existingRequestId = existing.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(existingRequestId); + service.autosaveScheduler.drainAutosavesBeforeRemoval(existing); + if (service.saveLifecycle.requiresLifecycleDrain(existing) + && !service.saveLifecycle.discardingRequest(existingRequestId)) { + IrisLogging.warn("Jigsaw Studio registration deferred while request %s finishes its final autosave drain", + existingRequestId); + return; + } + } + ActiveStudio next = new ActiveStudio( + world.getUID(), + world, + activeEngine, + activeGenerator, + new ConcurrentHashMap<>(), + ConcurrentHashMap.newKeySet(), + new AtomicLong()); + UUID displacedRequestId = null; + synchronized (service.saveLifecycleLock) { + if (!service.enabled || service.disableStarted.get()) { + return; + } + ActiveStudio previous = service.studios.get(world.getUID()); + if (previous != null && previous.generator() == activeGenerator) { + return; + } + ActiveStudio displaced = service.studios.put(world.getUID(), next); + if (displaced != null) { + displacedRequestId = displaced.generator().getRequest().requestId(); + service.saveLifecycle.savesInProgress.remove(displacedRequestId); + service.graphMutations.graphMutationsInProgress.remove(displacedRequestId); + service.materializer.materializationsInProgress.remove(displacedRequestId); + service.saveLifecycle.exportsInProgress.remove(displacedRequestId); + service.saveLifecycle.closingRequests.remove(displacedRequestId); + service.saveLifecycle.discardingRequests.remove(displacedRequestId); + service.saveLifecycle.reopenRequiredRequests.remove(displacedRequestId); + } + } + if (displacedRequestId != null) { + service.autosaveScheduler.clearAutosaves(displacedRequestId); + service.tileWatcher.clearJigsawTileWatches(displacedRequestId); + unregisterRetries.remove(displacedRequestId); + unregisterDrainWarnings.remove(displacedRequestId); + service.tripleSneakTracker.clearRequest(displacedRequestId); + service.evaluator.evaluations.remove(displacedRequestId); + service.previewRenderer.removeRequest(displacedRequestId); + } + IrisLogging.debug("Jigsaw Studio authoring registered: world=%s structure=%s bays=%d", + world.getName(), activeGenerator.getSession().structureKey(), activeGenerator.getLayout().bays().size()); + service.evaluator.scheduleInitialEvaluation(next); + service.playerContext.scheduleOnlinePlayers(world.getUID()); + } + + void activationCommitted(World world, UUID requestId) { + if (!service.enabled || service.disableStarted.get() || world == null || requestId == null) { + return; + } + ActiveStudio studio = service.studios.get(world.getUID()); + if (studio == null || !requestId.equals(studio.generator().getRequest().requestId())) { + return; + } + disableNaturalStudioSpawning(world); + service.evaluator.scheduleInitialEvaluation(studio); + } + + void markChunkGenerated( + Engine engine, + JigsawStudioGenerator generator, + int chunkX, + int chunkZ + ) { + if (!service.enabled || service.disableStarted.get() || engine == null || generator == null) { + return; + } + World world = BukkitWorldBinding.world(engine.getTarget().getWorld()); + if (world == null) { + return; + } + ActiveStudio studio = service.studios.get(world.getUID()); + if (!service.enabled || service.disableStarted.get() + || studio == null || studio.engine() != engine || studio.generator() != generator) { + return; + } + markChunkAvailable(studio, chunkX, chunkZ); + } + + void markChunkAvailable(ActiveStudio studio, int chunkX, int chunkZ) { + long chunkKey = JigsawStudioService.chunkKey(chunkX, chunkZ); + boolean relevant = false; + for (JigsawStudioBay bay : studio.generator().getLayout().bays()) { + BayPopulation population = studio.population(bay); + if (population.markGenerated(chunkKey)) { + relevant = true; + } + } + if (relevant) { + service.materializer.scheduleHydration(studio, studio.world(), chunkX, chunkZ, 0); + } + } + + void unregister(World world) { + if (world == null) { + return; + } + ActiveStudio active = service.studios.get(world.getUID()); + if (active != null) { + UUID activeRequestId = active.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(activeRequestId); + service.autosaveScheduler.drainAutosavesBeforeRemoval(active); + if (service.saveLifecycle.requiresLifecycleDrain(active) + && !service.saveLifecycle.discardingRequest(activeRequestId)) { + if (unregisterDrainWarnings.add(activeRequestId)) { + IrisLogging.warn("Jigsaw Studio unregister deferred while request %s finishes its final autosave drain", + activeRequestId); + } + scheduleUnregisterRetry(world, activeRequestId); + return; + } + } + ActiveStudio removed; + JigsawStudioActivation.Request request; + synchronized (service.saveLifecycleLock) { + removed = service.studios.remove(world.getUID()); + if (removed == null) { + return; + } + request = removed.generator().getRequest(); + service.saveLifecycle.savesInProgress.remove(request.requestId()); + service.graphMutations.graphMutationsInProgress.remove(request.requestId()); + service.materializer.materializationsInProgress.remove(request.requestId()); + service.saveLifecycle.exportsInProgress.remove(request.requestId()); + service.saveLifecycle.closingRequests.remove(request.requestId()); + service.saveLifecycle.discardingRequests.remove(request.requestId()); + service.saveLifecycle.reopenRequiredRequests.remove(request.requestId()); + } + service.autosaveScheduler.clearAutosaves(request.requestId()); + service.toolbelt.deferredDuplications.remove(request.requestId()); + service.tileWatcher.clearJigsawTileWatches(request.requestId()); + unregisterRetries.remove(request.requestId()); + unregisterDrainWarnings.remove(request.requestId()); + service.toolbelt.toolConfirmations.entrySet().removeIf( + entry -> entry.getValue().payload().requestId().equals(request.requestId())); + service.tripleSneakTracker.clearRequest(request.requestId()); + service.evaluator.evaluations.remove(request.requestId()); + service.previewRenderer.forgetRequest(request.requestId()); + JigsawStudioActivation.deactivate(request.packKey(), request.requestId()); + service.playerContext.clearWorldPlayerContexts(world.getUID()); + IrisLogging.debug("Jigsaw Studio authoring unregistered: world=%s", world.getName()); + } + + private void scheduleUnregisterRetry(World world, UUID requestId) { + if (!service.enabled || !unregisterRetries.add(requestId)) { + return; + } + try { + J.s(() -> { + unregisterRetries.remove(requestId); + ActiveStudio current = service.studios.get(world.getUID()); + if (current != null + && current.generator().getRequest().requestId().equals(requestId)) { + unregister(world); + } + }, AUTOSAVE_RETRY_TICKS); + } catch (Throwable exception) { + unregisterRetries.remove(requestId); + IrisLogging.reportError(exception); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioSaveLifecycle.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioSaveLifecycle.java new file mode 100644 index 000000000..1c58ccfd7 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioSaveLifecycle.java @@ -0,0 +1,512 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioAutosaveScheduler.AutosaveKey; +import art.arcane.iris.core.service.JigsawStudioAutosaveScheduler.AutosavePersistentFailure; +import art.arcane.iris.core.service.JigsawStudioCaptureScheduler.CaptureTarget; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CloseStart; +import art.arcane.iris.core.service.JigsawStudioService.ExportStart; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.Location; +import org.bukkit.World; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.util.HashSet; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; + +import static art.arcane.iris.core.service.JigsawStudioCaptureScheduler.resolveCaptureTarget; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioService.AUTOSAVE_RETRY_TICKS; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.findBay; +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioSaveLifecycle { + private static final int REPLACEMENT_CLOSE_WAIT_TICKS = 2_400; + + private final JigsawStudioService service; + final Set savesInProgress = new HashSet<>(); + final Set exportsInProgress = new HashSet<>(); + final Set closingRequests = new HashSet<>(); + final Set discardingRequests = new HashSet<>(); + final Set reopenRequiredRequests = ConcurrentHashMap.newKeySet(); + + JigsawStudioSaveLifecycle(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + CloseStart tryBeginClose(UUID requestId, UUID ownerId, boolean discard) { + if (requestId == null) { + return CloseStart.NOT_ACTIVE; + } + service.tileWatcher.finalizeJigsawTileWatches(requestId); + synchronized (service.saveLifecycleLock) { + JigsawStudioActivation.Request request = JigsawStudioActivation.getRequest(requestId); + JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); + if (request == null || session == null) { + return CloseStart.NOT_ACTIVE; + } + if (request.ownerId() != null && !request.ownerId().equals(ownerId)) { + return CloseStart.NOT_OWNER; + } + if (savesInProgress.contains(requestId)) { + return CloseStart.SAVE_IN_PROGRESS; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return CloseStart.OPERATION_IN_PROGRESS; + } + if (exportsInProgress.contains(requestId)) { + return CloseStart.OPERATION_IN_PROGRESS; + } + if (service.materializer.materializationsInProgress.contains(requestId)) { + return CloseStart.OPERATION_IN_PROGRESS; + } + if (session.operationInProgress()) { + return CloseStart.OPERATION_IN_PROGRESS; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return CloseStart.OPERATION_IN_PROGRESS; + } + if (session.isDirty() && !discard) { + return CloseStart.DIRTY; + } + closingRequests.add(requestId); + if (discard) { + discardingRequests.add(requestId); + } else { + discardingRequests.remove(requestId); + } + return CloseStart.STARTED; + } + } + + String closeProtectionFailure(UUID requestId) { + if (requestId == null) { + return null; + } + synchronized (service.saveLifecycleLock) { + if (closingRequests.contains(requestId) && !savesInProgress.contains(requestId)) { + return null; + } + if (savesInProgress.contains(requestId)) { + return "The active Jigsaw Studio is saving and cannot be closed or replaced yet."; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return "The active Jigsaw Studio is updating its graph and cannot be closed or replaced yet."; + } + if (exportsInProgress.contains(requestId)) { + return "The active Jigsaw Studio is exporting and cannot be closed or replaced yet."; + } + if (service.materializer.materializationsInProgress.contains(requestId)) { + return "The active Jigsaw Studio is loading or restoring a variant and cannot be closed yet."; + } + JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); + if (session != null && session.operationInProgress()) { + return "The active Jigsaw Studio is loading a variant and cannot be closed or replaced yet."; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return "The active Jigsaw Studio is finalizing an open vanilla jigsaw-block editor."; + } + if (session != null && session.isDirty()) { + return "The active Jigsaw Studio is waiting for autosave. Let it finish before closing."; + } + return "The active Jigsaw Studio is owner-controlled. Close it with /iris jigsaw close."; + } + } + + CompletableFuture awaitCloseForReplacement(UUID requestId, UUID ownerId) { + CompletableFuture readiness = new CompletableFuture<>(); + awaitCloseForReplacement(requestId, ownerId, readiness, 0); + return readiness; + } + + private void awaitCloseForReplacement( + UUID requestId, + UUID ownerId, + CompletableFuture readiness, + int waitedTicks + ) { + if (readiness.isDone()) { + return; + } + CloseStart closeStart = tryBeginClose(requestId, ownerId, false); + switch (closeStart) { + case STARTED, NOT_ACTIVE -> readiness.complete(null); + case NOT_OWNER -> readiness.completeExceptionally(new IllegalStateException( + "The active Jigsaw Studio is owned by another player session.")); + case DIRTY, SAVE_IN_PROGRESS, OPERATION_IN_PROGRESS -> { + if (waitedTicks == 0) { + service.autosaveScheduler.expediteAutosaves(requestId); + } + if (waitedTicks >= REPLACEMENT_CLOSE_WAIT_TICKS) { + String failure = closeProtectionFailure(requestId); + readiness.completeExceptionally(new IllegalStateException( + failure == null + ? "The active Jigsaw Studio did not become ready for replacement." + : failure)); + return; + } + try { + J.s(() -> awaitCloseForReplacement( + requestId, + ownerId, + readiness, + waitedTicks + AUTOSAVE_RETRY_TICKS), AUTOSAVE_RETRY_TICKS); + } catch (Throwable exception) { + readiness.completeExceptionally(exception); + } + } + } + } + + void cancelClose(UUID requestId) { + if (requestId == null) { + return; + } + synchronized (service.saveLifecycleLock) { + closingRequests.remove(requestId); + discardingRequests.remove(requestId); + } + } + + SaveStart tryBeginSave(UUID requestId) { + Objects.requireNonNull(requestId, "Jigsaw Studio save request ID"); + synchronized (service.saveLifecycleLock) { + if (closingRequests.contains(requestId)) { + return SaveStart.CLOSING; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return SaveStart.GRAPH_OPERATION; + } + if (exportsInProgress.contains(requestId)) { + return SaveStart.EXPORT_OPERATION; + } + if (service.materializer.materializationsInProgress.contains(requestId)) { + return SaveStart.VARIANT_OPERATION; + } + if (!savesInProgress.add(requestId)) { + return SaveStart.IN_PROGRESS; + } + return SaveStart.STARTED; + } + } + + void finishSave(UUID requestId) { + if (requestId == null) { + return; + } + synchronized (service.saveLifecycleLock) { + savesInProgress.remove(requestId); + } + } + + ExportStart tryBeginExport(UUID requestId, UUID ownerId) { + Objects.requireNonNull(requestId, "Jigsaw Studio export request ID"); + Objects.requireNonNull(ownerId, "Jigsaw Studio export owner ID"); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + synchronized (service.saveLifecycleLock) { + JigsawStudioActivation.Request request = JigsawStudioActivation.getRequest(requestId); + JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); + if (request == null || session == null) { + return ExportStart.NOT_ACTIVE; + } + if (request.ownerId() != null && !request.ownerId().equals(ownerId)) { + return ExportStart.NOT_OWNER; + } + if (closingRequests.contains(requestId)) { + return ExportStart.CLOSING; + } + if (savesInProgress.contains(requestId)) { + return ExportStart.SAVE_IN_PROGRESS; + } + if (service.graphMutations.graphMutationsInProgress.contains(requestId)) { + return ExportStart.OPERATION_IN_PROGRESS; + } + if (service.materializer.materializationsInProgress.contains(requestId) || session.operationInProgress()) { + return ExportStart.OPERATION_IN_PROGRESS; + } + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + return ExportStart.OPERATION_IN_PROGRESS; + } + if (session.isDirty()) { + return ExportStart.DIRTY; + } + if (!exportsInProgress.add(requestId)) { + return ExportStart.IN_PROGRESS; + } + return ExportStart.STARTED; + } + } + + void finishExport(UUID requestId) { + if (requestId == null) { + return; + } + synchronized (service.saveLifecycleLock) { + exportsInProgress.remove(requestId); + } + } + + boolean saveSelected(Player player) { + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> saveSelected(player)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + if (reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { + message(player, "Close and reopen Jigsaw Studio before loading variants in the resized layout."); + return false; + } + if (service.graphMutations.graphMutationInProgress(studio.generator().getRequest().requestId())) { + message(player, "Wait for the current Jigsaw Studio graph update to finish."); + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String selected = session.selectedBayId().orElse(null); + if (selected == null) { + Location location = player.getLocation(); + JigsawStudioBay underPlayer = session.layout().findAt( + location.getBlockX(), location.getBlockY(), location.getBlockZ()); + if (underPlayer != null) { + selected = underPlayer.stableId(); + session.selectBay(selected); + } + } + if (selected == null) { + message(player, "Stand inside or select a Jigsaw Studio workcell before saving."); + return false; + } + return saveBay(player, selected); + } + + boolean saveBay(Player player, String bayId) { + if (player == null || bayId == null || bayId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> saveBay(player, bayId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + JigsawStudioBay bay = findBay(studio.generator().getSession().layout(), bayId); + if (bay == null) { + message(player, "No Jigsaw Studio bay matches '" + bayId + "'."); + return false; + } + return startSave(studio, player.getWorld(), bay, player, true) == SaveAttempt.STARTED; + } + + SaveAttempt startSave( + ActiveStudio studio, + World world, + JigsawStudioBay bay, + Player player, + boolean report + ) { + UUID requestId = studio.generator().getRequest().requestId(); + if (reopenRequiredRequests.contains(requestId)) { + JigsawStudioService.report( + player, report, "Close and reopen Jigsaw Studio before saving the resized layout."); + return SaveAttempt.DEFERRED; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); + if (activeVariant == null) { + JigsawStudioService.report( + player, report, "Workcell '" + bay.stableId() + "' has no active variant to save."); + return SaveAttempt.DEFERRED; + } + if (!activeVariant.owned()) { + JigsawStudioService.report(player, report, "Variant '" + activeVariant.pieceKey() + + "' is read-only. Adopt or clone its graph before editing it."); + return SaveAttempt.DEFERRED; + } + BayReadiness readiness = studio.population(bay).readiness(); + if (!readiness.ready()) { + JigsawStudioService.report(player, report, readinessMessage(bay, readiness)); + return readiness.failure().isEmpty() ? SaveAttempt.RETRY : SaveAttempt.DEFERRED; + } + CaptureTarget captureTarget; + try { + captureTarget = resolveCaptureTarget(studio, bay, activeVariant); + } catch (IOException exception) { + String failure = "Jigsaw Studio cannot capture this workcell: " + failureMessage(exception); + JigsawStudioService.report(player, report, failure); + return service.autosaveScheduler.retainCurrentAutosaveFailure( + studio, + bay.stableId(), + new AutosavePersistentFailure(failure, exception)) + ? SaveAttempt.PERSISTENT_FAILURE + : SaveAttempt.DEFERRED; + } + JigsawStudioSession.SaveStart sessionSave = session.beginSave(bay.stableId()); + if (sessionSave.status() != JigsawStudioSession.SaveStatus.STARTED) { + JigsawStudioService.report(player, report, switch (sessionSave.status()) { + case SWITCH_IN_PROGRESS -> "This workcell is loading another variant."; + case SAVE_IN_PROGRESS -> "This workcell is already saving."; + case NO_ACTIVE_VARIANT -> "This workcell has no active variant."; + case UNKNOWN_WORKCELL -> "This workcell is no longer active."; + case STARTED -> "The workcell save could not start."; + }); + return sessionSave.status() == JigsawStudioSession.SaveStatus.SAVE_IN_PROGRESS + || sessionSave.status() == JigsawStudioSession.SaveStatus.SWITCH_IN_PROGRESS + ? SaveAttempt.RETRY + : SaveAttempt.DEFERRED; + } + JigsawStudioSession.SaveIdentity saveIdentity = sessionSave.identity().orElseThrow(); + SaveStart saveStart = tryBeginSave(requestId); + if (saveStart == SaveStart.CLOSING) { + session.abortSave(saveIdentity); + JigsawStudioService.report(player, report, "This Jigsaw Studio is closing and cannot start another save."); + return SaveAttempt.DEFERRED; + } + if (saveStart == SaveStart.IN_PROGRESS) { + session.abortSave(saveIdentity); + JigsawStudioService.report(player, report, "A save is already running for this Jigsaw Studio."); + return SaveAttempt.RETRY; + } + if (saveStart == SaveStart.GRAPH_OPERATION) { + session.abortSave(saveIdentity); + JigsawStudioService.report(player, report, "Wait for the current Jigsaw Studio graph update to finish."); + return SaveAttempt.RETRY; + } + if (saveStart == SaveStart.EXPORT_OPERATION) { + session.abortSave(saveIdentity); + JigsawStudioService.report(player, report, "Wait for the current Jigsaw Studio export to finish."); + return SaveAttempt.RETRY; + } + if (saveStart == SaveStart.VARIANT_OPERATION) { + session.abortSave(saveIdentity); + JigsawStudioService.report( + player, report, "Wait for the current Jigsaw Studio variant load or rollback to finish."); + return SaveAttempt.RETRY; + } + if (report) { + session.selectBay(bay.stableId()); + } + service.playerContext.refreshWorkcellContext(studio.worldId(), bay.stableId()); + JigsawStudioService.report(player, report, "Capturing variant '" + activeVariant.pieceKey() + "' from " + + bay.stableId() + "..."); + try { + boolean scheduled = service.captureScheduler.scheduleCapture( + studio, + world, + bay, + captureTarget, + player, + requestId, + saveIdentity, + service.autosaveScheduler.autosaveFailureState(studio, saveIdentity)); + return scheduled ? SaveAttempt.STARTED : SaveAttempt.DEFERRED; + } catch (Throwable exception) { + session.abortSave(saveIdentity); + finishSave(requestId); + service.playerContext.refreshWorkcellContext(studio.worldId(), bay.stableId()); + IrisLogging.reportError(exception); + JigsawStudioService.report(player, report, "Jigsaw Studio could not schedule the workcell capture: " + + failureMessage(exception)); + return SaveAttempt.DEFERRED; + } + } + + boolean requiresLifecycleDrain(ActiveStudio studio) { + UUID requestId = studio.generator().getRequest().requestId(); + if (service.tileWatcher.hasJigsawTileWatch(requestId) + || studio.generator().getSession().isDirty() + || studio.generator().getSession().operationInProgress()) { + return true; + } + for (AutosaveKey key : service.autosaveScheduler.autosaves.keySet()) { + if (requestId.equals(key.requestId())) { + return true; + } + } + synchronized (service.saveLifecycleLock) { + return savesInProgress.contains(requestId) + || service.graphMutations.graphMutationsInProgress.contains(requestId) + || service.materializer.materializationsInProgress.contains(requestId) + || exportsInProgress.contains(requestId); + } + } + + boolean discardingRequest(UUID requestId) { + synchronized (service.saveLifecycleLock) { + return discardingRequests.contains(requestId); + } + } + + boolean isCurrentSave( + ActiveStudio studio, + UUID requestId, + JigsawStudioSession.SaveIdentity identity + ) { + return service.isCurrentRequest(studio, requestId) + && studio.generator().getSession().isSaveCurrent(identity); + } + + private static String readinessMessage(JigsawStudioBay bay, BayReadiness readiness) { + if (!readiness.failure().isEmpty()) { + return "Bay '" + bay.stableId() + "' is invalid and cannot be saved: " + readiness.failure(); + } + return "Bay '" + bay.stableId() + "' is not ready to save: " + + readiness.generatedChunks() + "/" + readiness.requiredChunks() + " chunk(s) populated, " + + readiness.hydratedChunks() + "/" + readiness.requiredChunks() + + " chunk(s) hydrated. Visit the whole bay and wait for its markers to finish loading."; + } + + record BayReadiness( + boolean ready, + String failure, + int requiredChunks, + int generatedChunks, + int hydratedChunks + ) { + } + + enum SaveStart { + STARTED, + IN_PROGRESS, + CLOSING, + GRAPH_OPERATION, + EXPORT_OPERATION, + VARIANT_OPERATION + } + + enum SaveAttempt { + STARTED, + RETRY, + DEFERRED, + PERSISTENT_FAILURE + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java index 765459e03..f00936854 100644 --- a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioService.java @@ -1,147 +1,42 @@ package art.arcane.iris.core.service; -import art.arcane.iris.core.loader.IrisData; -import art.arcane.iris.core.nms.INMS; -import art.arcane.iris.core.runtime.InPlaceChunkRegenerator; import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarArchetype; -import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarDirection; import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarTopology; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioControlPosition; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphMapper; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMarkerKeyCodec; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolMembership; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioProjectDeletionService; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioStructureEditor; -import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolAction; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioTripleSneakTracker; import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; -import art.arcane.iris.core.structure.authoring.StructureTransactionWriter; -import art.arcane.iris.core.structure.authoring.StructureWriteOptions; +import art.arcane.iris.core.service.JigsawStudioChunkWriter.BayPopulation; +import art.arcane.iris.core.service.JigsawStudioMaterializer.VariantReloadRequest; import art.arcane.iris.core.structure.authoring.StructureWriteResult; import art.arcane.iris.engine.framework.Engine; -import art.arcane.iris.engine.data.chunk.TerrainChunk; import art.arcane.iris.engine.framework.PlacedStructurePiece; import art.arcane.iris.engine.framework.StructureAssembler; import art.arcane.iris.engine.framework.structure.StructureAssemblyResult; -import art.arcane.iris.engine.framework.structure.StructureGraphCompilation; -import art.arcane.iris.engine.framework.structure.StructureGraphCompiler; -import art.arcane.iris.engine.framework.structure.StructureGraphDiagnostic; -import art.arcane.iris.engine.framework.structure.StructureGraphResolver; -import art.arcane.iris.engine.framework.structure.StructureResourceBundleGraphCompiler; -import art.arcane.iris.engine.object.IrisDirection; -import art.arcane.iris.engine.object.IrisJigsawConnector; -import art.arcane.iris.engine.object.IrisJigsawPiece; -import art.arcane.iris.engine.object.IrisJigsawThemeSet; -import art.arcane.iris.engine.object.IrisObject; -import art.arcane.iris.engine.object.IrisObjectRotation; import art.arcane.iris.engine.object.IrisPosition; import art.arcane.iris.engine.object.IrisStructure; -import art.arcane.iris.engine.object.JigsawJoint; -import art.arcane.iris.engine.object.TileData; import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; -import art.arcane.iris.platform.bukkit.BukkitBlockState; import art.arcane.iris.platform.bukkit.BukkitPlatform; -import art.arcane.iris.platform.bukkit.BukkitWorldBinding; import art.arcane.iris.spi.IrisLogging; import art.arcane.iris.spi.IrisServices; -import art.arcane.iris.spi.PlatformBlockState; -import art.arcane.iris.util.common.data.B; import art.arcane.iris.util.common.plugin.IrisService; import art.arcane.iris.util.common.scheduling.J; -import art.arcane.volmlib.util.collection.KList; -import art.arcane.volmlib.util.collection.KMap; import art.arcane.volmlib.util.math.RNG; import art.arcane.volmlib.util.plugin.ComponentMessenger; -import org.bukkit.Bukkit; -import org.bukkit.ChatColor; -import org.bukkit.Chunk; -import org.bukkit.Color; import org.bukkit.GameRules; import org.bukkit.Location; -import org.bukkit.Material; -import org.bukkit.Particle; import org.bukkit.World; -import org.bukkit.block.Block; -import org.bukkit.block.BlockFace; -import org.bukkit.block.BlockState; -import org.bukkit.block.DoubleChest; -import org.bukkit.block.data.BlockData; -import org.bukkit.block.data.type.Jigsaw; import org.bukkit.entity.Player; -import org.bukkit.event.EventHandler; -import org.bukkit.event.EventPriority; -import org.bukkit.event.block.Action; -import org.bukkit.event.block.BlockBreakEvent; -import org.bukkit.event.block.BlockBurnEvent; -import org.bukkit.event.block.BlockCookEvent; -import org.bukkit.event.block.BlockDispenseEvent; -import org.bukkit.event.block.BlockExplodeEvent; -import org.bukkit.event.block.BlockFadeEvent; -import org.bukkit.event.block.BlockFormEvent; -import org.bukkit.event.block.BlockFromToEvent; -import org.bukkit.event.block.BlockGrowEvent; -import org.bukkit.event.block.BlockMultiPlaceEvent; -import org.bukkit.event.block.BlockPistonExtendEvent; -import org.bukkit.event.block.BlockPistonRetractEvent; -import org.bukkit.event.block.BlockPlaceEvent; -import org.bukkit.event.block.BlockRedstoneEvent; -import org.bukkit.event.block.BlockSpreadEvent; -import org.bukkit.event.block.BrewingStartEvent; -import org.bukkit.event.block.CrafterCraftEvent; -import org.bukkit.event.entity.EntityChangeBlockEvent; -import org.bukkit.event.entity.EntityExplodeEvent; import org.bukkit.event.entity.CreatureSpawnEvent; -import org.bukkit.event.inventory.BrewEvent; -import org.bukkit.event.inventory.BrewingStandFuelEvent; -import org.bukkit.event.inventory.FurnaceBurnEvent; -import org.bukkit.event.inventory.FurnaceStartSmeltEvent; -import org.bukkit.event.inventory.InventoryClickEvent; -import org.bukkit.event.inventory.InventoryCloseEvent; -import org.bukkit.event.inventory.InventoryDragEvent; -import org.bukkit.event.inventory.InventoryMoveItemEvent; -import org.bukkit.event.inventory.InventoryPickupItemEvent; -import org.bukkit.event.player.PlayerBucketEmptyEvent; -import org.bukkit.event.player.PlayerBucketFillEvent; -import org.bukkit.event.player.PlayerChangedWorldEvent; -import org.bukkit.event.player.PlayerCommandPreprocessEvent; -import org.bukkit.event.player.PlayerJoinEvent; -import org.bukkit.event.player.PlayerMoveEvent; -import org.bukkit.event.player.PlayerPortalEvent; -import org.bukkit.event.player.PlayerQuitEvent; -import org.bukkit.event.player.PlayerInteractEvent; -import org.bukkit.event.player.PlayerRespawnEvent; -import org.bukkit.event.player.PlayerTeleportEvent; -import org.bukkit.event.player.PlayerToggleSneakEvent; -import org.bukkit.event.server.ServerCommandEvent; -import org.bukkit.event.world.ChunkLoadEvent; -import org.bukkit.event.world.StructureGrowEvent; -import org.bukkit.event.world.WorldUnloadEvent; -import org.bukkit.inventory.EquipmentSlot; -import org.bukkit.inventory.BlockInventoryHolder; -import org.bukkit.inventory.Inventory; -import org.bukkit.inventory.InventoryHolder; import org.bukkit.inventory.ItemStack; -import java.io.ByteArrayOutputStream; import java.io.IOException; import java.nio.file.Path; -import java.util.ArrayList; -import java.util.Comparator; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; @@ -152,78 +47,44 @@ import java.util.UUID; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.atomic.AtomicBoolean; -import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.atomic.AtomicLong; -import java.util.concurrent.atomic.AtomicReference; + +import static art.arcane.iris.core.service.JigsawStudioCaptureScheduler.requiredChunks; +import static art.arcane.iris.core.service.JigsawStudioGraphMutations.loadMappedLayout; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioProtection.ownerMatches; public final class JigsawStudioService implements IrisService, JigsawStudioMenuActions { - private static final int AUTOSAVE_DEBOUNCE_TICKS = 40; - private static final int AUTOSAVE_RETRY_TICKS = 5; - private static final int REPLACEMENT_CLOSE_WAIT_TICKS = 2_400; - private static final List AUTOSAVE_PERSISTENT_RETRY_DELAYS = - List.of(40, 80, 160, 320, 600); - private static final long PREVIEW_SEED = 1337L; - private static final int SPATIAL_PREVIEW_BASE_Y = JigsawStudioLayout.FLOOR_Y + 48; - private static final JigsawStudioPieceRules DEFAULT_PIECE_RULES = + static final int AUTOSAVE_RETRY_TICKS = 5; + static final JigsawStudioPieceRules DEFAULT_PIECE_RULES = new JigsawStudioPieceRules(0, 30, 0, 0, false); - private static final long TOOL_CONFIRM_NANOS = 10_000_000_000L; - private static final int VISUAL_INTERVAL_TICKS = 8; - private static final int PARTICLE_BUDGET = 384; - private static final int HYDRATION_RETRY_TICKS = 2; - private static final int MAX_HYDRATION_ATTEMPTS = 40; - private static final int JIGSAW_TILE_WATCH_INTERVAL_TICKS = 5; - private static final double VISUAL_RANGE = 96.0D; - private static final double VISUAL_RANGE_SQUARED = VISUAL_RANGE * VISUAL_RANGE; - private static final Color SELECTED_COLOR = Color.AQUA; - private static final Color NEARBY_COLOR = Color.fromRGB(92, 102, 118); - private static final Color INVALID_BAY_COLOR = Color.RED; - private static final Color INVALID_CONNECTOR_COLOR = Color.RED; - private static final Color VALID_CONNECTOR_COLOR = Color.LIME; - private static final Color ASSEMBLY_PREVIEW_COLOR = Color.fromRGB(180, 90, 255); - private static final Color LIVE_PREVIEW_WARNING_COLOR = Color.fromRGB(255, 180, 55); - private static final long ASSEMBLY_PREVIEW_MILLIS = 10_000L; - private static final Set MUTATING_COMMANDS = Set.of( - "biome", "brush", "chunk", "clone", "copy", "cut", "data", "deform", "drain", - "execute", "faces", "fill", "fillbiome", "fixlava", "fixwater", "flip", "flora", - "forest", "function", "gmask", "green", "hollow", "item", "load", "mask", "move", - "naturalize", "overlay", "paste", "place", "redo", "regen", "replace", "replacenear", - "restore", "rotate", "schedule", "schem", "schematic", "set", "setblock", "smooth", - "snow", "sphere", "stack", "thaw", "undo", "walls"); - private static final Set SAFE_NON_OWNER_COMMANDS = Set.of( - "help", "list", "me", "msg", "ping", "pl", "plugins", "r", "reply", "rules", - "say", "tell", "ver", "version", "w", "whisper"); - private static final Comparator NEW_CONNECTOR_SOURCE_POSITION_ORDER = Comparator - .comparingInt((IrisJigsawConnector connector) -> connector.getPosition().getX()) - .thenComparingInt(connector -> connector.getPosition().getY()) - .thenComparingInt(connector -> connector.getPosition().getZ()); - private static JigsawStudioService INSTANCE; + static JigsawStudioService INSTANCE; - private final Map studios = new ConcurrentHashMap<>(); - private final Set particlesDisabled = ConcurrentHashMap.newKeySet(); - private final Set visualizationLoops = ConcurrentHashMap.newKeySet(); - private final Map assemblyPreviews = new ConcurrentHashMap<>(); - private final Map playerWorkcells = new ConcurrentHashMap<>(); - private final Map autosaves = new ConcurrentHashMap<>(); - private final Map deferredDuplications = new ConcurrentHashMap<>(); - private final Map jigsawTileWatches = new ConcurrentHashMap<>(); - private final Map toolConfirmations = new ConcurrentHashMap<>(); - private final Map evaluations = new ConcurrentHashMap<>(); - private final JigsawStudioTripleSneakTracker tripleSneakTracker = new JigsawStudioTripleSneakTracker(); - private final JigsawStudioToolCodec toolCodec = new JigsawStudioToolCodec(); - private final JigsawStudioPreviewRenderer previewRenderer = new JigsawStudioPreviewRenderer(); - private final AtomicBoolean disableStarted = new AtomicBoolean(); - private final Object saveLifecycleLock = new Object(); - private final Set savesInProgress = new HashSet<>(); - private final Set graphMutationsInProgress = new HashSet<>(); - private final Set materializationsInProgress = new HashSet<>(); - private final Set exportsInProgress = new HashSet<>(); - private final Set closingRequests = new HashSet<>(); - private final Set discardingRequests = new HashSet<>(); - private final Set reopenRequiredRequests = ConcurrentHashMap.newKeySet(); - private final Set unregisterRetries = ConcurrentHashMap.newKeySet(); - private final Set unregisterDrainWarnings = ConcurrentHashMap.newKeySet(); - private volatile JigsawStudioMenuController menuController; - private volatile boolean enabled; + final Map studios = new ConcurrentHashMap<>(); + final Set particlesDisabled = ConcurrentHashMap.newKeySet(); + final JigsawStudioTripleSneakTracker tripleSneakTracker = new JigsawStudioTripleSneakTracker(); + final JigsawStudioPreviewRenderer previewRenderer = new JigsawStudioPreviewRenderer(); + final AtomicBoolean disableStarted = new AtomicBoolean(); + final Object saveLifecycleLock = new Object(); + volatile boolean enabled; + + final JigsawStudioRegistry registry = new JigsawStudioRegistry(this); + final JigsawStudioSaveLifecycle saveLifecycle = new JigsawStudioSaveLifecycle(this); + final JigsawStudioVariantEditor variantEditor = new JigsawStudioVariantEditor(this); + final JigsawStudioVariantProperties variantProperties = new JigsawStudioVariantProperties(this); + final JigsawStudioWorkcellEditor workcellEditor = new JigsawStudioWorkcellEditor(this); + final JigsawStudioEvaluator evaluator = new JigsawStudioEvaluator(this); + final JigsawStudioToolbelt toolbelt = new JigsawStudioToolbelt(this); + final JigsawStudioGraphMutations graphMutations = new JigsawStudioGraphMutations(this); + final JigsawStudioProtectionListener protectionListener = new JigsawStudioProtectionListener(this); + final JigsawStudioProtection protection = new JigsawStudioProtection(this); + final JigsawStudioMaterializer materializer = new JigsawStudioMaterializer(this); + final JigsawStudioDirtyTracker dirtyTracker = new JigsawStudioDirtyTracker(this); + final JigsawStudioCaptureScheduler captureScheduler = new JigsawStudioCaptureScheduler(this); + final JigsawStudioAutosaveScheduler autosaveScheduler = new JigsawStudioAutosaveScheduler(this); + final JigsawStudioTileWatcher tileWatcher = new JigsawStudioTileWatcher(this); + final JigsawStudioVisualization visualization = new JigsawStudioVisualization(this); + final JigsawStudioPlayerContext playerContext = new JigsawStudioPlayerContext(this); public static JigsawStudioService get() { JigsawStudioService service = INSTANCE; @@ -238,641 +99,14 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA public void onEnable() { disableStarted.set(false); enabled = true; - menuController = new JigsawStudioMenuController(BukkitPlatform.volmitPlugin(), this); + toolbelt.menuController = new JigsawStudioMenuController(BukkitPlatform.volmitPlugin(), this); + BukkitPlatform.volmitPlugin().registerListener(protectionListener); INSTANCE = this; } @Override public void onDisable() { - quiesceForServerShutdown(); - } - - public void quiesceForServerShutdown() { - if (!disableStarted.compareAndSet(false, true)) { - return; - } - try { - finalizeAllJigsawTileWatches(); - } catch (Throwable exception) { - IrisLogging.reportError("Failed to finalize Jigsaw Studio tile watches during shutdown.", exception); - } - try { - drainAutosavesBeforeDisable(); - } catch (Throwable exception) { - IrisLogging.reportError("Failed to drain Jigsaw Studio autosaves during shutdown.", exception); - } - enabled = false; - JigsawStudioMenuController activeMenuController = menuController; - menuController = null; - if (activeMenuController != null) { - try { - activeMenuController.closeAll(); - } catch (Throwable exception) { - IrisLogging.reportError("Failed to close Jigsaw Studio menus during shutdown.", exception); - } - } - particlesDisabled.clear(); - visualizationLoops.clear(); - assemblyPreviews.clear(); - playerWorkcells.clear(); - autosaves.clear(); - deferredDuplications.clear(); - jigsawTileWatches.clear(); - toolConfirmations.clear(); - tripleSneakTracker.clearAll(); - evaluations.clear(); - try { - previewRenderer.removeAll(); - } catch (Throwable exception) { - IrisLogging.reportError("Failed to remove Jigsaw Studio previews during shutdown.", exception); - } - reopenRequiredRequests.clear(); - unregisterRetries.clear(); - unregisterDrainWarnings.clear(); - synchronized (saveLifecycleLock) { - studios.clear(); - savesInProgress.clear(); - graphMutationsInProgress.clear(); - materializationsInProgress.clear(); - exportsInProgress.clear(); - closingRequests.clear(); - discardingRequests.clear(); - } - INSTANCE = null; - } - - public void register(Engine engine, JigsawStudioGenerator generator) { - if (!enabled || disableStarted.get()) { - return; - } - Engine activeEngine = Objects.requireNonNull(engine, "Jigsaw Studio engine"); - JigsawStudioGenerator activeGenerator = Objects.requireNonNull(generator, "Jigsaw Studio generator"); - World world = BukkitWorldBinding.world(activeEngine.getTarget().getWorld()); - if (world == null) { - return; - } - ActiveStudio existing = studios.get(world.getUID()); - if (existing != null && existing.generator() == activeGenerator) { - return; - } - if (existing != null) { - UUID existingRequestId = existing.generator().getRequest().requestId(); - finalizeJigsawTileWatches(existingRequestId); - drainAutosavesBeforeRemoval(existing); - if (requiresLifecycleDrain(existing) && !discardingRequest(existingRequestId)) { - IrisLogging.warn("Jigsaw Studio registration deferred while request %s finishes its final autosave drain", - existingRequestId); - return; - } - } - ActiveStudio next = new ActiveStudio( - world.getUID(), - world, - activeEngine, - activeGenerator, - new ConcurrentHashMap<>(), - ConcurrentHashMap.newKeySet(), - new AtomicLong()); - UUID displacedRequestId = null; - synchronized (saveLifecycleLock) { - if (!enabled || disableStarted.get()) { - return; - } - ActiveStudio previous = studios.get(world.getUID()); - if (previous != null && previous.generator() == activeGenerator) { - return; - } - ActiveStudio displaced = studios.put(world.getUID(), next); - if (displaced != null) { - displacedRequestId = displaced.generator().getRequest().requestId(); - savesInProgress.remove(displacedRequestId); - graphMutationsInProgress.remove(displacedRequestId); - materializationsInProgress.remove(displacedRequestId); - exportsInProgress.remove(displacedRequestId); - closingRequests.remove(displacedRequestId); - discardingRequests.remove(displacedRequestId); - reopenRequiredRequests.remove(displacedRequestId); - } - } - if (displacedRequestId != null) { - clearAutosaves(displacedRequestId); - clearJigsawTileWatches(displacedRequestId); - unregisterRetries.remove(displacedRequestId); - unregisterDrainWarnings.remove(displacedRequestId); - tripleSneakTracker.clearRequest(displacedRequestId); - evaluations.remove(displacedRequestId); - previewRenderer.removeRequest(displacedRequestId); - } - IrisLogging.debug("Jigsaw Studio authoring registered: world=%s structure=%s bays=%d", - world.getName(), activeGenerator.getSession().structureKey(), activeGenerator.getLayout().bays().size()); - scheduleInitialEvaluation(next); - scheduleOnlinePlayers(world.getUID()); - } - - public void activationCommitted(World world, UUID requestId) { - if (!enabled || disableStarted.get() || world == null || requestId == null) { - return; - } - ActiveStudio studio = studios.get(world.getUID()); - if (studio == null || !requestId.equals(studio.generator().getRequest().requestId())) { - return; - } - disableNaturalStudioSpawning(world); - scheduleInitialEvaluation(studio); - } - - public void markChunkGenerated( - Engine engine, - JigsawStudioGenerator generator, - int chunkX, - int chunkZ - ) { - if (!enabled || disableStarted.get() || engine == null || generator == null) { - return; - } - World world = BukkitWorldBinding.world(engine.getTarget().getWorld()); - if (world == null) { - return; - } - ActiveStudio studio = studios.get(world.getUID()); - if (!enabled || disableStarted.get() - || studio == null || studio.engine() != engine || studio.generator() != generator) { - return; - } - markChunkAvailable(studio, chunkX, chunkZ); - } - - private void markChunkAvailable(ActiveStudio studio, int chunkX, int chunkZ) { - long chunkKey = chunkKey(chunkX, chunkZ); - boolean relevant = false; - for (JigsawStudioBay bay : studio.generator().getLayout().bays()) { - BayPopulation population = studio.population(bay); - if (population.markGenerated(chunkKey)) { - relevant = true; - } - } - if (relevant) { - scheduleHydration(studio, studio.world(), chunkX, chunkZ, 0); - } - } - - public void unregister(World world) { - if (world == null) { - return; - } - ActiveStudio active = studios.get(world.getUID()); - if (active != null) { - UUID activeRequestId = active.generator().getRequest().requestId(); - finalizeJigsawTileWatches(activeRequestId); - drainAutosavesBeforeRemoval(active); - if (requiresLifecycleDrain(active) && !discardingRequest(activeRequestId)) { - if (unregisterDrainWarnings.add(activeRequestId)) { - IrisLogging.warn("Jigsaw Studio unregister deferred while request %s finishes its final autosave drain", - activeRequestId); - } - scheduleUnregisterRetry(world, activeRequestId); - return; - } - } - ActiveStudio removed; - JigsawStudioActivation.Request request; - synchronized (saveLifecycleLock) { - removed = studios.remove(world.getUID()); - if (removed == null) { - return; - } - request = removed.generator().getRequest(); - savesInProgress.remove(request.requestId()); - graphMutationsInProgress.remove(request.requestId()); - materializationsInProgress.remove(request.requestId()); - exportsInProgress.remove(request.requestId()); - closingRequests.remove(request.requestId()); - discardingRequests.remove(request.requestId()); - reopenRequiredRequests.remove(request.requestId()); - } - clearAutosaves(request.requestId()); - deferredDuplications.remove(request.requestId()); - clearJigsawTileWatches(request.requestId()); - unregisterRetries.remove(request.requestId()); - unregisterDrainWarnings.remove(request.requestId()); - toolConfirmations.entrySet().removeIf(entry -> entry.getValue().payload().requestId().equals(request.requestId())); - tripleSneakTracker.clearRequest(request.requestId()); - evaluations.remove(request.requestId()); - previewRenderer.forgetRequest(request.requestId()); - JigsawStudioActivation.deactivate(request.packKey(), request.requestId()); - clearWorldPlayerContexts(world.getUID()); - IrisLogging.debug("Jigsaw Studio authoring unregistered: world=%s", world.getName()); - } - - private void scheduleUnregisterRetry(World world, UUID requestId) { - if (!enabled || !unregisterRetries.add(requestId)) { - return; - } - try { - J.s(() -> { - unregisterRetries.remove(requestId); - ActiveStudio current = studios.get(world.getUID()); - if (current != null - && current.generator().getRequest().requestId().equals(requestId)) { - unregister(world); - } - }, AUTOSAVE_RETRY_TICKS); - } catch (Throwable exception) { - unregisterRetries.remove(requestId); - IrisLogging.reportError(exception); - } - } - - public CloseStart tryBeginClose(UUID requestId, UUID ownerId, boolean discard) { - if (requestId == null) { - return CloseStart.NOT_ACTIVE; - } - finalizeJigsawTileWatches(requestId); - synchronized (saveLifecycleLock) { - JigsawStudioActivation.Request request = JigsawStudioActivation.getRequest(requestId); - JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); - if (request == null || session == null) { - return CloseStart.NOT_ACTIVE; - } - if (request.ownerId() != null && !request.ownerId().equals(ownerId)) { - return CloseStart.NOT_OWNER; - } - if (savesInProgress.contains(requestId)) { - return CloseStart.SAVE_IN_PROGRESS; - } - if (graphMutationsInProgress.contains(requestId)) { - return CloseStart.OPERATION_IN_PROGRESS; - } - if (exportsInProgress.contains(requestId)) { - return CloseStart.OPERATION_IN_PROGRESS; - } - if (materializationsInProgress.contains(requestId)) { - return CloseStart.OPERATION_IN_PROGRESS; - } - if (session.operationInProgress()) { - return CloseStart.OPERATION_IN_PROGRESS; - } - if (hasJigsawTileWatch(requestId)) { - return CloseStart.OPERATION_IN_PROGRESS; - } - if (session.isDirty() && !discard) { - return CloseStart.DIRTY; - } - closingRequests.add(requestId); - if (discard) { - discardingRequests.add(requestId); - } else { - discardingRequests.remove(requestId); - } - return CloseStart.STARTED; - } - } - - public String closeProtectionFailure(UUID requestId) { - if (requestId == null) { - return null; - } - synchronized (saveLifecycleLock) { - if (closingRequests.contains(requestId) && !savesInProgress.contains(requestId)) { - return null; - } - if (savesInProgress.contains(requestId)) { - return "The active Jigsaw Studio is saving and cannot be closed or replaced yet."; - } - if (graphMutationsInProgress.contains(requestId)) { - return "The active Jigsaw Studio is updating its graph and cannot be closed or replaced yet."; - } - if (exportsInProgress.contains(requestId)) { - return "The active Jigsaw Studio is exporting and cannot be closed or replaced yet."; - } - if (materializationsInProgress.contains(requestId)) { - return "The active Jigsaw Studio is loading or restoring a variant and cannot be closed yet."; - } - JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); - if (session != null && session.operationInProgress()) { - return "The active Jigsaw Studio is loading a variant and cannot be closed or replaced yet."; - } - if (hasJigsawTileWatch(requestId)) { - return "The active Jigsaw Studio is finalizing an open vanilla jigsaw-block editor."; - } - if (session != null && session.isDirty()) { - return "The active Jigsaw Studio is waiting for autosave. Let it finish before closing."; - } - return "The active Jigsaw Studio is owner-controlled. Close it with /iris jigsaw close."; - } - } - - public CompletableFuture awaitCloseForReplacement(UUID requestId, UUID ownerId) { - CompletableFuture readiness = new CompletableFuture<>(); - awaitCloseForReplacement(requestId, ownerId, readiness, 0); - return readiness; - } - - private void awaitCloseForReplacement( - UUID requestId, - UUID ownerId, - CompletableFuture readiness, - int waitedTicks - ) { - if (readiness.isDone()) { - return; - } - CloseStart closeStart = tryBeginClose(requestId, ownerId, false); - switch (closeStart) { - case STARTED, NOT_ACTIVE -> readiness.complete(null); - case NOT_OWNER -> readiness.completeExceptionally(new IllegalStateException( - "The active Jigsaw Studio is owned by another player session.")); - case DIRTY, SAVE_IN_PROGRESS, OPERATION_IN_PROGRESS -> { - if (waitedTicks == 0) { - expediteAutosaves(requestId); - } - if (waitedTicks >= REPLACEMENT_CLOSE_WAIT_TICKS) { - String failure = closeProtectionFailure(requestId); - readiness.completeExceptionally(new IllegalStateException( - failure == null - ? "The active Jigsaw Studio did not become ready for replacement." - : failure)); - return; - } - try { - J.s(() -> awaitCloseForReplacement( - requestId, - ownerId, - readiness, - waitedTicks + AUTOSAVE_RETRY_TICKS), AUTOSAVE_RETRY_TICKS); - } catch (Throwable exception) { - readiness.completeExceptionally(exception); - } - } - } - } - - public void cancelClose(UUID requestId) { - if (requestId == null) { - return; - } - synchronized (saveLifecycleLock) { - closingRequests.remove(requestId); - discardingRequests.remove(requestId); - } - } - - SaveStart tryBeginSave(UUID requestId) { - Objects.requireNonNull(requestId, "Jigsaw Studio save request ID"); - synchronized (saveLifecycleLock) { - if (closingRequests.contains(requestId)) { - return SaveStart.CLOSING; - } - if (graphMutationsInProgress.contains(requestId)) { - return SaveStart.GRAPH_OPERATION; - } - if (exportsInProgress.contains(requestId)) { - return SaveStart.EXPORT_OPERATION; - } - if (materializationsInProgress.contains(requestId)) { - return SaveStart.VARIANT_OPERATION; - } - if (!savesInProgress.add(requestId)) { - return SaveStart.IN_PROGRESS; - } - return SaveStart.STARTED; - } - } - - void finishSave(UUID requestId) { - if (requestId == null) { - return; - } - synchronized (saveLifecycleLock) { - savesInProgress.remove(requestId); - } - } - - public ExportStart tryBeginExport(UUID requestId, UUID ownerId) { - Objects.requireNonNull(requestId, "Jigsaw Studio export request ID"); - Objects.requireNonNull(ownerId, "Jigsaw Studio export owner ID"); - finalizeJigsawTileWatches(requestId); - synchronized (saveLifecycleLock) { - JigsawStudioActivation.Request request = JigsawStudioActivation.getRequest(requestId); - JigsawStudioSession session = JigsawStudioActivation.getSession(requestId); - if (request == null || session == null) { - return ExportStart.NOT_ACTIVE; - } - if (request.ownerId() != null && !request.ownerId().equals(ownerId)) { - return ExportStart.NOT_OWNER; - } - if (closingRequests.contains(requestId)) { - return ExportStart.CLOSING; - } - if (savesInProgress.contains(requestId)) { - return ExportStart.SAVE_IN_PROGRESS; - } - if (graphMutationsInProgress.contains(requestId)) { - return ExportStart.OPERATION_IN_PROGRESS; - } - if (materializationsInProgress.contains(requestId) || session.operationInProgress()) { - return ExportStart.OPERATION_IN_PROGRESS; - } - if (hasJigsawTileWatch(requestId)) { - return ExportStart.OPERATION_IN_PROGRESS; - } - if (session.isDirty()) { - return ExportStart.DIRTY; - } - if (!exportsInProgress.add(requestId)) { - return ExportStart.IN_PROGRESS; - } - return ExportStart.STARTED; - } - } - - public void finishExport(UUID requestId) { - if (requestId == null) { - return; - } - synchronized (saveLifecycleLock) { - exportsInProgress.remove(requestId); - } - } - - public boolean saveSelected(Player player) { - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> saveSelected(player)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - if (reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { - message(player, "Close and reopen Jigsaw Studio before loading variants in the resized layout."); - return false; - } - if (graphMutationInProgress(studio.generator().getRequest().requestId())) { - message(player, "Wait for the current Jigsaw Studio graph update to finish."); - return false; - } - UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - if (hasJigsawTileWatch(requestId)) { - message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String selected = session.selectedBayId().orElse(null); - if (selected == null) { - Location location = player.getLocation(); - JigsawStudioBay underPlayer = session.layout().findAt( - location.getBlockX(), location.getBlockY(), location.getBlockZ()); - if (underPlayer != null) { - selected = underPlayer.stableId(); - session.selectBay(selected); - } - } - if (selected == null) { - message(player, "Stand inside or select a Jigsaw Studio workcell before saving."); - return false; - } - return saveBay(player, selected); - } - - public boolean saveBay(Player player, String bayId) { - if (player == null || bayId == null || bayId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> saveBay(player, bayId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - JigsawStudioBay bay = findBay(studio.generator().getSession().layout(), bayId); - if (bay == null) { - message(player, "No Jigsaw Studio bay matches '" + bayId + "'."); - return false; - } - return startSave(studio, player.getWorld(), bay, player, true) == SaveAttempt.STARTED; - } - - private SaveAttempt startSave( - ActiveStudio studio, - World world, - JigsawStudioBay bay, - Player player, - boolean report - ) { - UUID requestId = studio.generator().getRequest().requestId(); - if (reopenRequiredRequests.contains(requestId)) { - report(player, report, "Close and reopen Jigsaw Studio before saving the resized layout."); - return SaveAttempt.DEFERRED; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); - if (activeVariant == null) { - report(player, report, "Workcell '" + bay.stableId() + "' has no active variant to save."); - return SaveAttempt.DEFERRED; - } - if (!activeVariant.owned()) { - report(player, report, "Variant '" + activeVariant.pieceKey() - + "' is read-only. Adopt or clone its graph before editing it."); - return SaveAttempt.DEFERRED; - } - BayReadiness readiness = studio.population(bay).readiness(); - if (!readiness.ready()) { - report(player, report, readinessMessage(bay, readiness)); - return readiness.failure().isEmpty() ? SaveAttempt.RETRY : SaveAttempt.DEFERRED; - } - CaptureTarget captureTarget; - try { - captureTarget = resolveCaptureTarget(studio, bay, activeVariant); - } catch (IOException exception) { - String failure = "Jigsaw Studio cannot capture this workcell: " + failureMessage(exception); - report(player, report, failure); - return retainCurrentAutosaveFailure( - studio, - bay.stableId(), - new AutosavePersistentFailure(failure, exception)) - ? SaveAttempt.PERSISTENT_FAILURE - : SaveAttempt.DEFERRED; - } - JigsawStudioSession.SaveStart sessionSave = session.beginSave(bay.stableId()); - if (sessionSave.status() != JigsawStudioSession.SaveStatus.STARTED) { - report(player, report, switch (sessionSave.status()) { - case SWITCH_IN_PROGRESS -> "This workcell is loading another variant."; - case SAVE_IN_PROGRESS -> "This workcell is already saving."; - case NO_ACTIVE_VARIANT -> "This workcell has no active variant."; - case UNKNOWN_WORKCELL -> "This workcell is no longer active."; - case STARTED -> "The workcell save could not start."; - }); - return sessionSave.status() == JigsawStudioSession.SaveStatus.SAVE_IN_PROGRESS - || sessionSave.status() == JigsawStudioSession.SaveStatus.SWITCH_IN_PROGRESS - ? SaveAttempt.RETRY - : SaveAttempt.DEFERRED; - } - JigsawStudioSession.SaveIdentity saveIdentity = sessionSave.identity().orElseThrow(); - SaveStart saveStart = tryBeginSave(requestId); - if (saveStart == SaveStart.CLOSING) { - session.abortSave(saveIdentity); - report(player, report, "This Jigsaw Studio is closing and cannot start another save."); - return SaveAttempt.DEFERRED; - } - if (saveStart == SaveStart.IN_PROGRESS) { - session.abortSave(saveIdentity); - report(player, report, "A save is already running for this Jigsaw Studio."); - return SaveAttempt.RETRY; - } - if (saveStart == SaveStart.GRAPH_OPERATION) { - session.abortSave(saveIdentity); - report(player, report, "Wait for the current Jigsaw Studio graph update to finish."); - return SaveAttempt.RETRY; - } - if (saveStart == SaveStart.EXPORT_OPERATION) { - session.abortSave(saveIdentity); - report(player, report, "Wait for the current Jigsaw Studio export to finish."); - return SaveAttempt.RETRY; - } - if (saveStart == SaveStart.VARIANT_OPERATION) { - session.abortSave(saveIdentity); - report(player, report, "Wait for the current Jigsaw Studio variant load or rollback to finish."); - return SaveAttempt.RETRY; - } - if (report) { - session.selectBay(bay.stableId()); - } - refreshWorkcellContext(studio.worldId(), bay.stableId()); - report(player, report, "Capturing variant '" + activeVariant.pieceKey() + "' from " - + bay.stableId() + "..."); - try { - boolean scheduled = scheduleCapture( - studio, - world, - bay, - captureTarget, - player, - requestId, - saveIdentity, - autosaveFailureState(studio, saveIdentity)); - return scheduled ? SaveAttempt.STARTED : SaveAttempt.DEFERRED; - } catch (Throwable exception) { - session.abortSave(saveIdentity); - finishSave(requestId); - refreshWorkcellContext(studio.worldId(), bay.stableId()); - IrisLogging.reportError(exception); - report(player, report, "Jigsaw Studio could not schedule the workcell capture: " - + failureMessage(exception)); - return SaveAttempt.DEFERRED; - } + registry.quiesceForServerShutdown(); } public boolean teleportTo(Player player, String bayId) { @@ -890,7 +124,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA if (!authorizeOwner(player, studio)) { return false; } - if (reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { + if (saveLifecycle.reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { message(player, "Close and reopen Jigsaw Studio before loading variants in the resized layout."); return false; } @@ -911,9 +145,9 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA studio.generator().getSession().selectBay(bay.stableId()); BukkitPlatform.teleportAsync(player, destination).thenRun(() -> J.runEntity( player, - () -> reconcilePlayerContext(player, player.getLocation()))); + () -> playerContext.reconcilePlayerContext(player, player.getLocation()))); message(player, "Selected Jigsaw Studio workcell '" + bay.stableId() + "'."); - ensureVisualizationLoop(player); + visualization.ensureVisualizationLoop(player); return true; } @@ -922,185 +156,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return teleportTo(player, workcellId); } - @Override - public boolean setConnectorBlocksVisible(Player player, String workcellId, boolean visible) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> setConnectorBlocksVisible(player, workcellId, visible)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcellId); - if (snapshot.connectorsVisible() == visible) { - message(player, "Connector blocks are already " + (visible ? "visible." : "hidden.")); - return false; - } - JigsawStudioSession.SwitchStart start = session.beginVariantReload(workcellId); - if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { - message(player, switch (start.status()) { - case DIRTY -> "Wait for this workcell to finish autosaving before changing connector visibility."; - case SAVE_IN_PROGRESS -> "Wait for the current workcell save to finish."; - case SWITCH_IN_PROGRESS -> "This workcell is already loading another view."; - case UNKNOWN_WORKCELL -> "The selected workcell no longer exists."; - case UNKNOWN_VARIANT -> "This workcell has no active variant."; - case ALREADY_ACTIVE, WRONG_WORKCELL, STARTED -> - "Connector visibility could not change: " + start.status() + "."; - }); - return false; - } - JigsawStudioSession.VariantSwitchToken token = start.token().orElseThrow(); - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderVariant( - workcell, - token.targetVariant()); - if (!rendered.valid()) { - session.abortVariantSwitch(token); - message(player, "Connector visibility cannot change: " + rendered.failure()); - return false; - } - message(player, (visible ? "Showing" : "Hiding") + " connector blocks in " + workcellId + "..."); - return scheduleMaterialization(new MaterializationWork( - studio, - player.getWorld(), - player, - workcell, - token, - rendered, - rendered, - snapshot.connectorsVisible(), - visible, - true)); - } - - @Override - public boolean resetConnectorBlocks(Player player, String workcellId) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> resetConnectorBlocks(player, workcellId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - JigsawStudioVariant activeVariant = session.activeVariant(workcellId).orElse(null); - if (activeVariant == null || !activeVariant.owned()) { - message(player, "Load an owned variant before resetting its connector blocks."); - return false; - } - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderVariant( - workcell, - activeVariant); - String validationFailure = validateMaterialization(rendered); - if (!validationFailure.isEmpty()) { - message(player, "Connector blocks cannot reset: " + validationFailure); - return false; - } - if (rendered.connectors().isEmpty()) { - message(player, "The active variant has no saved connectors to reset."); - return false; - } - String reservationFailure = beginConnectorRepair(studio); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - boolean connectorsVisible = session.workcellSnapshot(workcellId).connectorsVisible(); - message(player, "Resetting " + rendered.connectors().size() - + " connector block(s) from the last saved iteration..."); - return scheduleConnectorRepair( - player, - studio, - workcell, - rendered, - connectorsVisible); - } - - @Override - public boolean undoAutosave(Player player) { - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> undoAutosave(player)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - Map activeReloads = new HashMap<>(); - for (JigsawStudioBay workcell : session.layout().bays()) { - session.activeVariant(workcell.stableId()).ifPresent(variant -> activeReloads.put( - variant.pieceKey(), - new VariantReloadRequest( - workcell.stableId(), - studio.generator().renderBay(workcell)))); - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - message(player, "Restoring the previous Jigsaw Studio autosave iteration..."); - return scheduleGraphMutation( - player, - studio, - () -> { - Path packRoot = request.source().getDataFolder().toPath(); - JigsawStudioHistoryStore.UndoResult result = new JigsawStudioHistoryStore( - packRoot, - request.structureKey()).undoLatest(); - if (!result.available()) { - return new CommandGraphMutationResult( - session.layout(), - "", - "", - "No earlier autosave iteration is available."); - } - if (!result.successful()) { - throw new IOException("Jigsaw Studio undo failed: " - + writeFailure(result.writeResult())); - } - request.source().invalidateStructureResources(); - JigsawStudioLayout restoredLayout = loadMappedLayout(studio); - VariantReloadRequest reload = activeReloads.get(result.pieceKey()); - Optional activeReload = reload == null - || restoredLayout.get(reload.workcellId()) == null - ? Optional.empty() - : Optional.of(reload); - String warning = result.warning().isEmpty() - ? "" - : " History cleanup warning: " + result.warning(); - return new CommandGraphMutationResult( - restoredLayout, - "", - "", - Map.of(), - activeReload, - "Restored the previous autosave iteration. " - + result.remainingIterations() + " earlier iteration(s) remain." - + warning); - }); - } - public boolean setParticles(Player player, boolean visible) { if (player == null) { return false; @@ -1114,7 +169,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA } if (visible) { particlesDisabled.remove(player.getUniqueId()); - ensureVisualizationLoop(player); + visualization.ensureVisualizationLoop(player); } else { particlesDisabled.add(player.getUniqueId()); } @@ -1122,1333 +177,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return true; } - public boolean switchVariant( - Player player, - String workcellId, - String targetPieceKey, - boolean discardDirty - ) { - if (player == null || workcellId == null || targetPieceKey == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> switchVariant( - player, workcellId, targetPieceKey, discardDirty)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - if (graphMutationInProgress(studio.generator().getRequest().requestId())) { - message(player, "Wait for the current Jigsaw Studio graph update to finish."); - return false; - } - UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - if (hasJigsawTileWatch(requestId)) { - message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - JigsawStudioSession.SwitchStart start = session.beginVariantSwitch( - workcell.stableId(), targetPieceKey, discardDirty); - if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { - message(player, switch (start.status()) { - case DIRTY -> "Wait for the current variant to finish autosaving before switching."; - case SAVE_IN_PROGRESS -> "Wait for the current variant save to finish."; - case SWITCH_IN_PROGRESS -> "This workcell is already loading another variant."; - case ALREADY_ACTIVE -> "Variant '" + targetPieceKey + "' is already active."; - case WRONG_WORKCELL -> "Variant '" + targetPieceKey + "' belongs to another workcell."; - case UNKNOWN_VARIANT -> "No variant '" + targetPieceKey + "' exists in this Studio catalog."; - case UNKNOWN_WORKCELL -> "The selected workcell no longer exists."; - case STARTED -> "The variant switch could not start."; - }); - return false; - } - return materializeVariant(player, studio, workcell, start, null); - } - - private void reloadActiveVariant( - Player player, - ActiveStudio studio, - VariantReloadRequest reload - ) { - if (!isCurrentRequest(studio, studio.generator().getRequest().requestId())) { - return; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(reload.workcellId()); - if (workcell == null) { - message(player, "The resized variant was saved, but its workcell is no longer active. Reopen Studio."); - return; - } - JigsawStudioSession.SwitchStart start = session.beginVariantReload(workcell.stableId()); - if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { - reopenRequiredRequests.add(studio.generator().getRequest().requestId()); - message(player, "The resized variant was saved, but Studio could not reload it: " - + start.status() + ". Close and reopen this project before editing that workcell."); - return; - } - materializeVariant(player, studio, workcell, start, reload.previous()); - } - - private boolean materializeVariant( - Player player, - ActiveStudio studio, - JigsawStudioBay workcell, - JigsawStudioSession.SwitchStart start, - JigsawStudioGenerator.RenderedBay previousOverride - ) { - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioSession.VariantSwitchToken token = start.token().orElseThrow(); - String targetPieceKey = token.targetVariant().pieceKey(); - JigsawStudioGenerator.RenderedBay target = studio.generator().renderVariant( - workcell, - token.targetVariant()); - if (!target.valid()) { - session.abortVariantSwitch(token); - refreshWorkcellContext(studio.worldId(), workcell.stableId()); - message(player, "Variant '" + targetPieceKey + "' cannot load: " + target.failure()); - return false; - } - JigsawStudioGenerator.RenderedBay previous = previousOverride == null - ? token.previousVariant() - .map(variant -> studio.generator().renderVariant(workcell, variant)) - .orElseGet(() -> JigsawStudioGenerator.RenderedBay.empty(workcell.bounds().dimensions())) - : previousOverride; - if (!previous.valid()) { - session.abortVariantSwitch(token); - refreshWorkcellContext(studio.worldId(), workcell.stableId()); - message(player, "The current variant cannot be retained for rollback: " + previous.failure()); - return false; - } - JigsawStudioVariant previousVariant = token.previousVariant().orElse(null); - if (previousVariant != null) { - String rollbackFailure = validateMaterialization(previous); - if (!rollbackFailure.isEmpty()) { - session.abortVariantSwitch(token); - refreshWorkcellContext(studio.worldId(), workcell.stableId()); - message(player, "The current variant cannot be retained for rollback: " + rollbackFailure); - return false; - } - } - session.selectBay(workcell.stableId()); - refreshWorkcellContext(studio.worldId(), workcell.stableId()); - message(player, "Loading variant '" + targetPieceKey + "' into " + workcell.stableId() + "..."); - return scheduleMaterialization(new MaterializationWork( - studio, - player.getWorld(), - player, - workcell, - token, - previous, - target, - session.workcellSnapshot(workcell.stableId()).connectorsVisible(), - session.workcellSnapshot(workcell.stableId()).connectorsVisible(), - false)); - } - - public boolean createVariant( - Player player, - String workcellId, - boolean duplicateActive - ) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> createVariant(player, workcellId, duplicateActive)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - if (!canCreateVariants(session.layout())) { - message(player, "This Jigsaw Studio graph is read-only. " - + "Adopt or clone it before creating variants."); - return false; - } - JigsawStudioVariant activeVariant = session.activeVariant(workcellId).orElse(null); - String sourceFailure = variantCreationSourceFailure(activeVariant, duplicateActive); - if (!sourceFailure.isEmpty()) { - message(player, sourceFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (duplicateActive && deferDuplicationUntilAutosaved( - player, - studio, - DeferredDuplication.single( - request.requestId(), - session.sessionId(), - player, - studio.worldId(), - workcell.stableId(), - activeVariant.pieceKey()))) { - return true; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - String archetypeKey = workcell.archetype() - .map(archetype -> archetype.name().toLowerCase(Locale.ROOT)) - .orElse("spatial"); - String sourcePieceKey = activeVariant.pieceKey(); - message(player, duplicateActive ? "Duplicating the active variant..." : "Creating a new variant..."); - return scheduleGraphMutation( - player, - studio, - () -> { - Path packRoot = request.source().getDataFolder().toPath(); - String pieceKey = JigsawStudioGraphEditor.nextVariantKey( - packRoot, request.structureKey(), archetypeKey); - if (duplicateActive) { - JigsawStudioGraphEditor.duplicatePiece( - packRoot, - request.structureKey(), - sourcePieceKey, - pieceKey); - } else { - JigsawStudioGraphEditor.createBlankVariant( - packRoot, - request.structureKey(), - sourcePieceKey, - pieceKey); - } - JigsawStudioLayout updatedLayout = loadMappedLayout(studio); - String targetWorkcellId = updatedLayout.workcellForVariant(pieceKey) - .map(JigsawStudioBay::stableId) - .orElseThrow(() -> new IOException( - "Created variant '" + pieceKey + "' has no Studio workcell")); - if (updatedLayout.mode() == JigsawStudioMode.SPATIAL_JIGSAW) { - return new CommandGraphMutationResult( - updatedLayout, - "", - "", - (duplicateActive ? "Duplicated" : "Created") + " variant '" + pieceKey - + "' in " + targetWorkcellId + "."); - } - return new CommandGraphMutationResult( - updatedLayout, - targetWorkcellId, - pieceKey, - (duplicateActive ? "Duplicated" : "Created") + " variant '" + pieceKey + "'."); - }); - } - - @Override - public boolean setWorkcellEnabled(Player player, String workcellId, boolean enabled) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> setWorkcellEnabled(player, workcellId, enabled)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null || workcell.archetype().isEmpty()) { - message(player, "Only planar Jigsaw Studio workcells can be enabled or disabled."); - return false; - } - if (workcell.enabled() == enabled) { - message(player, "Workcell '" + workcellId + "' is already " - + (enabled ? "enabled." : "disabled.")); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - JigsawPlanarArchetype archetype = workcell.archetype().orElseThrow(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioStructureEditor.updateWorkcellEnabled( - request.source().getDataFolder().toPath(), - request.structureKey(), - archetype, - enabled); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Workcell '" + workcellId + "' is now " - + (enabled ? "enabled." : "disabled for assembly and export.")); - }); - } - - @Override - public boolean updateWorkcellDimensions( - Player player, - String workcellId, - JigsawStudioCellDimensions dimensions - ) { - if (player == null || workcellId == null || workcellId.isBlank() || dimensions == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateWorkcellDimensions(player, workcellId, dimensions)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - if (workcell.capacity().equals(dimensions)) { - message(player, "Workcell '" + workcellId + "' already has capacity " - + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "."); - return false; - } - if (workcell.archetype().isPresent() - && (dimensions.width() < 3 || dimensions.depth() < 3)) { - message(player, "Planar workcell width and depth must each be at least 3 blocks."); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - JigsawPlanarArchetype archetype = workcell.archetype().orElse(null); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.WorkcellCapacityResult capacityResult = null; - if (archetype == null) { - JigsawStudioStructureEditor.updateCellSize( - request.source().getDataFolder().toPath(), - request.structureKey(), - dimensions); - } else { - capacityResult = JigsawStudioGraphEditor.updatePlanarWorkcellCapacity( - request.source().getDataFolder().toPath(), - request.structureKey(), - archetype, - dimensions); - } - request.source().invalidateStructureResources(); - String resizeSummary = capacityResult == null - ? "" - : " Verified " + capacityResult.checkedVariants() + " existing variant" - + (capacityResult.checkedVariants() == 1 ? "" : "s") + "; no variant object was resized."; - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Updated '" + workcellId + "' capacity to " - + dimensions.width() + "x" + dimensions.height() + "x" - + dimensions.depth() + "." + resizeSummary - + " The live workcell layout was regenerated."); - }); - } - - @Override - public boolean setRequireCaps(Player player, boolean requireCaps) { - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> setRequireCaps(player, requireCaps)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - && requireCaps) { - message(player, "Mandatory caps are Iris-only and cannot be enabled for a vanilla-portable graph."); - return false; - } - IrisStructure structure = loadStudioStructure(studio); - if (structure == null) { - message(player, "The active jigsaw structure could not be loaded."); - return false; - } - if (structure.isRequireCaps() == requireCaps) { - message(player, "Mandatory caps are already " + (requireCaps ? "enabled." : "disabled.")); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioStructureEditor.updateRequireCaps( - request.source().getDataFolder().toPath(), - request.structureKey(), - requireCaps); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Mandatory physical caps are now " - + (requireCaps ? "enabled." : "disabled.")); - }); - } - - @Override - public boolean duplicateActiveFamily(Player player, String themeKey) { - if (player == null || themeKey == null || themeKey.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> duplicateActiveFamily(player, themeKey)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { - message(player, "Coherent variant families are Iris-only and cannot be added to a vanilla-portable graph."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - Map sourcePieces = new LinkedHashMap<>(); - for (JigsawStudioBay workcell : session.layout().bays()) { - if (!workcell.enabled()) { - continue; - } - JigsawStudioVariant active = session.activeVariant(workcell.stableId()).orElse(null); - if (active == null || !active.owned()) { - message(player, "Load an owned source variant in every enabled workcell before duplicating a family."); - return false; - } - sourcePieces.put(workcell.stableId(), active.pieceKey()); - } - if (deferDuplicationUntilAutosaved( - player, - studio, - DeferredDuplication.family( - request.requestId(), - session.sessionId(), - player, - studio.worldId(), - sourcePieces, - themeKey))) { - return true; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.VariantFamilyCreation creation = - JigsawStudioGraphEditor.duplicateActiveFamily( - request.source().getDataFolder().toPath(), - request.structureKey(), - sourcePieces, - themeKey); - if (!creation.writeResult().successful()) { - throw new IOException("Variant-family transaction failed with " - + creation.writeResult().status()); - } - JigsawStudioLayout updatedLayout = loadMappedLayout(studio); - Map rebinds = updatedLayout.mode() == JigsawStudioMode.SPATIAL_JIGSAW - ? Map.of() - : creation.pieceKeysByWorkcell(); - return new CommandGraphMutationResult( - updatedLayout, - "", - "", - rebinds, - Optional.empty(), - "Duplicated every enabled workcell as coherent family '" + themeKey + "' with " - + creation.pieceKeysByWorkcell().size() + " variant(s)."); - }); - } - - @Override - public boolean updateThemeSetWeight(Player player, String themeKey, int weight) { - if (player == null || themeKey == null || themeKey.isBlank() || weight < 1) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateThemeSetWeight(player, themeKey, weight)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { - message(player, "Coherent theme sets are Iris-only."); - return false; - } - IrisStructure structure = loadStudioStructure(studio); - if (structure == null || structure.getThemeSets() == null) { - message(player, "The active jigsaw structure has no theme sets."); - return false; - } - List updated = new ArrayList<>(structure.getThemeSets().size()); - boolean found = false; - for (IrisJigsawThemeSet theme : structure.getThemeSets()) { - if (theme != null && themeKey.equals(theme.getKey())) { - if (theme.getWeight() == weight) { - message(player, "Theme '" + themeKey + "' already has weight " + weight + "."); - return false; - } - updated.add(new IrisJigsawThemeSet(themeKey, weight)); - found = true; - } else if (theme != null) { - updated.add(new IrisJigsawThemeSet(theme.getKey(), theme.getWeight())); - } - } - if (!found) { - message(player, "Theme set '" + themeKey + "' no longer exists."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioStructureEditor.updateThemeSets( - request.source().getDataFolder().toPath(), - request.structureKey(), - updated); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Set theme '" + themeKey + "' weight to " + weight + "."); - }); - } - - @Override - public boolean updateVariantThemes( - Player player, - String workcellId, - String pieceKey, - List themes - ) { - if (player == null || pieceKey == null || themes == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateVariantThemes( - player, workcellId, pieceKey, themes)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId, pieceKey); - if (variant == null) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - List targetThemes = List.copyOf(themes); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - && !targetThemes.isEmpty()) { - message(player, "Piece themes are Iris-only and cannot be added to a vanilla-portable graph."); - return false; - } - IrisStructure structure = loadStudioStructure(studio); - Set declaredThemes = new HashSet<>(); - if (structure != null && structure.getThemeSets() != null) { - for (IrisJigsawThemeSet theme : structure.getThemeSets()) { - if (theme != null) { - declaredThemes.add(theme.getKey()); - } - } - } - if (!declaredThemes.containsAll(targetThemes)) { - message(player, "One or more selected theme sets no longer exist."); - return false; - } - if (variant.themes().equals(targetThemes)) { - message(player, "Variant theme membership is unchanged."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.updatePieceThemes( - request.source().getDataFolder().toPath(), - request.structureKey(), - variant.pieceKey(), - targetThemes); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Updated theme membership for '" + variant.pieceKey() + "'."); - }); - } - - @Override - public boolean updateVariantRules( - Player player, - String workcellId, - String pieceKey, - JigsawStudioPieceRules rules - ) { - if (player == null || pieceKey == null || rules == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateVariantRules( - player, workcellId, pieceKey, rules)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId, pieceKey); - if (variant == null) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - && !DEFAULT_PIECE_RULES.equals(rules)) { - message(player, "Piece placement rules are Iris-only for a vanilla-portable graph."); - return false; - } - if (variant.rules().equals(rules)) { - message(player, "Variant piece rules are unchanged."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.updatePieceRules( - request.source().getDataFolder().toPath(), - request.structureKey(), - variant.pieceKey(), - rules); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Updated placement rules for '" + variant.pieceKey() + "'."); - }); - } - - public boolean toggleVariantRotatable(Player player, String workcellId) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> toggleVariantRotatable(player, workcellId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null && !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId); - if (variant == null) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (!canToggleVariantRotation(request.compatibilityTarget(), variant)) { - message(player, "Vanilla-portable variants must remain rotatable."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - boolean rotatable = !variant.rotatable(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.updateRotatable( - request.source().getDataFolder().toPath(), - request.structureKey(), - variant.pieceKey(), - rotatable); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Variant rotation is now " + (rotatable ? "enabled." : "disabled.")); - }); - } - - public boolean expandVariantToCell(Player player, String workcellId) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> expandVariantToCell(player, workcellId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null && !authorizeOwner(player, studio)) { - return false; - } - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (variant == null || workcell == null) { - return false; - } - return resizeVariant(player, workcellId, variant.pieceKey(), workcell.capacity()); - } - - @Override - public boolean resizeVariant( - Player player, - String workcellId, - String pieceKey, - JigsawStudioCellDimensions dimensions - ) { - if (player == null || workcellId == null || workcellId.isBlank() - || pieceKey == null || pieceKey.isBlank() || dimensions == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> resizeVariant(player, workcellId, pieceKey, dimensions)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); - if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { - message(player, "Variant '" + pieceKey + "' does not belong to workcell '" + workcellId + "'."); - return false; - } - if (!variant.owned()) { - message(player, "Variant '" + pieceKey + "' is read-only. Duplicate it before resizing."); - return false; - } - if (dimensions.width() > workcell.capacity().width() - || dimensions.height() > workcell.capacity().height() - || dimensions.depth() > workcell.capacity().depth()) { - message(player, "Requested variant size " + dimensions.width() + "x" + dimensions.height() + "x" - + dimensions.depth() + " exceeds workcell capacity " + workcell.capacity().width() + "x" - + workcell.capacity().height() + "x" + workcell.capacity().depth() - + ". Increase the workcell capacity first."); - return false; - } - if (variant.mode() == JigsawStudioMode.PLANAR_JIGSAW - && (dimensions.width() < 3 || dimensions.depth() < 3)) { - message(player, "Planar variant width and depth must each be at least 3 blocks."); - return false; - } - if (variant.dimensions().filter(dimensions::equals).isPresent()) { - message(player, "Variant '" + variant.resolvedDisplayName() + "' already uses " - + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "."); - return false; - } - boolean active = session.activeVariant(workcellId) - .map(activeVariant -> activeVariant.pieceKey().equals(pieceKey)) - .orElse(false); - JigsawStudioGenerator.RenderedBay previous = active - ? studio.generator().renderVariant(workcell, variant) - : null; - if (previous != null && !previous.valid()) { - message(player, "The active variant cannot be retained for live resize rollback: " + previous.failure()); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - message(player, "Resizing variant '" + variant.resolvedDisplayName() + "' to " - + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "..."); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.VariantResizeResult resize = - JigsawStudioGraphEditor.resizePieceObject( - request.source().getDataFolder().toPath(), - request.structureKey(), - variant.pieceKey(), - dimensions); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - Map.of(), - active ? Optional.of(new VariantReloadRequest(workcellId, previous)) : Optional.empty(), - "Resized variant '" + variant.resolvedDisplayName() + "' from " - + resize.previousDimensions().width() + "x" - + resize.previousDimensions().height() + "x" - + resize.previousDimensions().depth() + " to " - + dimensions.width() + "x" + dimensions.height() + "x" - + dimensions.depth() + ". " + resize.relocatedConnectors() - + " connector(s) moved with the new bounds."); - }); - } - - @Override - public boolean updateVariantDisplayName( - Player player, - String workcellId, - String pieceKey, - String displayName - ) { - if (player == null || workcellId == null || pieceKey == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateVariantDisplayName( - player, workcellId, pieceKey, displayName)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); - if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { - message(player, "Variant '" + pieceKey + "' does not belong to workcell '" + workcellId + "'."); - return false; - } - if (!variant.owned()) { - message(player, "Variant '" + pieceKey + "' is read-only. Duplicate it before renaming."); - return false; - } - String normalizedName; - try { - normalizedName = JigsawStudioGraphEditor.normalizeDisplayName(displayName); - } catch (IllegalArgumentException exception) { - message(player, exception.getMessage()); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.updatePieceDisplayName( - request.source().getDataFolder().toPath(), - request.structureKey(), - pieceKey, - normalizedName); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - normalizedName.isEmpty() - ? "Reset the variant label to its resource-key fallback." - : "Renamed the variant to '" + normalizedName + "'."); - }); - } - - @Override - public boolean updateWorkcellDisplayName( - Player player, - String workcellId, - String displayName - ) { - if (player == null || workcellId == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> updateWorkcellDisplayName(player, workcellId, displayName)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - if (workcell == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - String normalizedName; - try { - normalizedName = JigsawStudioGraphEditor.normalizeDisplayName(displayName); - } catch (IllegalArgumentException exception) { - message(player, exception.getMessage()); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - JigsawPlanarArchetype archetype = workcell.archetype().orElse(null); - return scheduleGraphMutation( - player, - studio, - () -> { - if (archetype == null) { - JigsawStudioStructureEditor.updateSpatialWorkcellDisplayName( - request.source().getDataFolder().toPath(), - request.structureKey(), - normalizedName); - } else { - JigsawStudioStructureEditor.updateWorkcellDisplayName( - request.source().getDataFolder().toPath(), - request.structureKey(), - archetype, - normalizedName); - } - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - normalizedName.isEmpty() - ? "Reset the workcell label to '" + workcell.canonicalDisplayName() + "'." - : "Renamed the workcell to '" + normalizedName + "'."); - }); - } - - @Override - public boolean adjustVariantWeight( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex, - int delta - ) { - if (delta == 0) { - return false; - } - if (player == null || workcellId == null || pieceKey == null || poolKey == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> adjustVariantWeight( - player, workcellId, pieceKey, poolKey, entryIndex, delta)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null && !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId, pieceKey); - if (variant == null) { - return false; - } - JigsawStudioPoolMembership membership = findMembership( - variant, poolKey, entryIndex); - if (membership == null) { - message(player, "That exact pool membership is no longer present."); - return false; - } - int weight; - try { - weight = Math.addExact(membership.weight(), delta); - } catch (ArithmeticException exception) { - message(player, "The requested variant weight is outside the supported integer range."); - return false; - } - if (weight < 1) { - message(player, "Variant weights cannot be lower than 1; unlink the membership instead."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioPoolEditor.updateWeightAtIndex( - request.source().getDataFolder().toPath(), - request.structureKey(), - membership.poolKey(), - membership.entryIndex(), - variant.pieceKey(), - weight); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Set '" + variant.pieceKey() + "' weight to " + weight - + " in pool '" + membership.poolKey() + "'."); - }); - } - - @Override - public boolean adjustVariantChance( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex, - int deltaPercentagePoints - ) { - if (deltaPercentagePoints == 0 || player == null || workcellId == null - || pieceKey == null || poolKey == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> adjustVariantChance( - player, - workcellId, - pieceKey, - poolKey, - entryIndex, - deltaPercentagePoints)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null && !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId, pieceKey); - if (variant == null) { - return false; - } - JigsawStudioPoolMembership membership = findMembership(variant, poolKey, entryIndex); - if (membership == null) { - message(player, "That exact pool membership is no longer present."); - return false; - } - double chance = membership.chance() + deltaPercentagePoints / 100.0D; - if (!Double.isFinite(chance) || chance < 0.0D || chance > 1.0D) { - message(player, "Variant chance must stay between 0% and 100%."); - return false; - } - chance = Math.round(chance * 1_000_000.0D) / 1_000_000.0D; - JigsawStudioActivation.Request request = studio.generator().getRequest(); - if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - && chance != 1.0D) { - message(player, "Chance gates are Iris-only and cannot be added to a vanilla-portable graph."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - double targetChance = chance; - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioPoolEditor.updateChanceAtIndex( - request.source().getDataFolder().toPath(), - request.structureKey(), - membership.poolKey(), - membership.entryIndex(), - variant.pieceKey(), - targetChance); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Set '" + variant.pieceKey() + "' chance to " - + Math.round(targetChance * 100.0D) + "% in pool '" - + membership.poolKey() + "'."); - }); - } - - @Override - public boolean deleteVariant(Player player, String workcellId, String pieceKey) { - if (player == null || workcellId == null || workcellId.isBlank() - || pieceKey == null || pieceKey.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> deleteVariant(player, workcellId, pieceKey)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().get(workcellId); - JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); - if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { - message(player, "Variant '" + pieceKey + "' no longer belongs to workcell '" + workcellId + "'."); - return false; - } - if (!variant.owned()) { - message(player, "Variant '" + pieceKey + "' is read-only. Adopt or clone it before deletion."); - return false; - } - String activePieceKey = session.activeVariant(workcellId) - .map(JigsawStudioVariant::pieceKey) - .orElse(""); - if (session.layout().mode() == JigsawStudioMode.PLANAR_JIGSAW - && activePieceKey.equals(pieceKey)) { - message(player, "Load another variant in this workcell before deleting '" + pieceKey + "'."); - return false; - } - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioGraphEditor.PieceDeletionResult deletion = - JigsawStudioGraphEditor.deletePieceVariant( - request.source().getDataFolder().toPath(), - request.structureKey(), - pieceKey); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Deleted variant '" + pieceKey + "', removed " - + deletion.removedPoolMemberships() + " pool membership(s), and removed " - + deletion.removedObjectResources() + " unshared object(s)."); - }); - } - - public boolean deleteProject(Player player) { - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> deleteProject(player)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - CloseStart closeStart = tryBeginClose(request.requestId(), player.getUniqueId(), false); - if (closeStart != CloseStart.STARTED) { - message(player, switch (closeStart) { - case DIRTY -> "Wait for autosave to finish before deleting this project."; - case SAVE_IN_PROGRESS -> "Wait for the active autosave to finish before deleting this project."; - case OPERATION_IN_PROGRESS -> "Wait for the active Jigsaw Studio operation to finish."; - case NOT_OWNER -> "This Jigsaw Studio is owned by another player session."; - case NOT_ACTIVE -> "This Jigsaw Studio session is no longer active."; - case STARTED -> "Project deletion could not start."; - }); - return false; - } - Path packRoot = request.source().getDataFolder().toPath(); - message(player, "Inspecting owned resources and reverse references before project deletion..."); - J.a(() -> inspectProjectDeletion(player, studio, request, packRoot)); - return true; - } - - private void inspectProjectDeletion( - Player player, - ActiveStudio studio, - JigsawStudioActivation.Request request, - Path packRoot - ) { - JigsawStudioProjectDeletionService.DeletionPlan plan; - try { - plan = JigsawStudioProjectDeletionService.inspect(packRoot, request.structureKey()); - } catch (Throwable exception) { - cancelClose(request.requestId()); - IrisLogging.reportError(exception); - message(player, "Project deletion inspection failed: " + failureMessage(exception)); - return; - } - if (!plan.deletable()) { - cancelClose(request.requestId()); - message(player, "Project deletion is blocked by " + plan.blockers().size() - + " external reference(s). The first is " - + plan.blockers().getFirst().ownerPath() + " at " - + plan.blockers().getFirst().location() + "."); - return; - } - boolean scheduled = J.runEntity( - player, - () -> closeAndDeleteProject(player, studio, request, plan), - 0, - () -> cancelClose(request.requestId())); - if (!scheduled) { - cancelClose(request.requestId()); - message(player, "Project deletion stopped because the owner session ended."); - } - } - - private void closeAndDeleteProject( - Player player, - ActiveStudio studio, - JigsawStudioActivation.Request request, - JigsawStudioProjectDeletionService.DeletionPlan plan - ) { - if (!isCurrentRequest(studio, request.requestId())) { - cancelClose(request.requestId()); - message(player, "Project deletion stopped because the Jigsaw Studio session changed."); - return; - } - IrisServices.get(StudioSVC.class).close().whenComplete((result, throwable) -> { - Throwable failure = throwable != null - ? throwable - : result == null ? new IllegalStateException("Studio close completed without a result") - : result.failureCause(); - if (failure != null) { - cancelClose(request.requestId()); - IrisLogging.reportError(failure); - message(player, "Project deletion stopped because Studio could not close: " - + failureMessage(failure)); - return; - } - J.a(() -> applyProjectDeletion(player, request, plan)); - }); - } - - private void applyProjectDeletion( - Player player, - JigsawStudioActivation.Request request, - JigsawStudioProjectDeletionService.DeletionPlan plan - ) { - try { - JigsawStudioProjectDeletionService.ProjectDeletionResult result = - JigsawStudioProjectDeletionService.delete(plan); - try { - clearAutosaveHistory( - request.source().getDataFolder().toPath(), - request.structureKey()); - } catch (IOException historyFailure) { - IrisLogging.reportError(historyFailure); - message(player, "The project graph was deleted, but its autosave history could not be removed: " - + failureMessage(historyFailure)); - } - request.source().invalidateStructureResources(); - message(player, "Deleted Jigsaw project '" + request.structureKey() + "' and " - + result.removedResourceCount() + " owned resource(s)."); - IrisLogging.debug("Jigsaw Studio project deleted: structure=%s resources=%d", - request.structureKey(), result.removedResourceCount()); - } catch (Throwable exception) { - IrisLogging.reportError(exception); - message(player, "Studio closed, but the project was not deleted: " - + failureMessage(exception) + ". Its files remain recoverable on disk."); - } - } - - @Override - public boolean unlinkVariantMembership( - Player player, - String workcellId, - String pieceKey, - String poolKey, - int entryIndex - ) { - if (player == null || workcellId == null || pieceKey == null || poolKey == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> unlinkVariantMembership( - player, workcellId, pieceKey, poolKey, entryIndex)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null && !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId, pieceKey); - if (variant == null) { - return false; - } - JigsawStudioPoolMembership membership = findMembership(variant, poolKey, entryIndex); - if (membership == null) { - message(player, "That exact pool membership is no longer present."); - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String reservationFailure = beginGraphMutation(studio, session); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - return scheduleGraphMutation( - player, - studio, - () -> { - JigsawStudioPoolEditor.removeEntry( - request.source().getDataFolder().toPath(), - request.structureKey(), - membership.poolKey(), - membership.entryIndex(), - variant.pieceKey()); - return new CommandGraphMutationResult( - loadMappedLayout(studio), - "", - "", - "Unlinked '" + variant.pieceKey() + "' from pool '" - + membership.poolKey() + "'."); - }); - } - public boolean previewStudio(Player player, long seed) { if (player == null) { return false; @@ -2485,7 +213,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA List pieces = assembly.pieces(); if (!J.runEntity(player, () -> { if (isCurrentRequest(studio, request.requestId())) { - showAssemblyPreview(player, pieces); + visualization.showAssemblyPreview(player, pieces); message(player, "Showing a " + pieces.size() + "-piece particle preview for 10 seconds."); } @@ -2508,7 +236,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA if (studio == null || !ownerMatches(player, studio)) { return Optional.empty(); } - return Optional.ofNullable(evaluations.get(studio.generator().getRequest().requestId())); + return Optional.ofNullable(evaluator.evaluations.get(studio.generator().getRequest().requestId())); } public boolean goToPreview(Player player) { @@ -2525,7 +253,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA UUID requestId = studio.generator().getRequest().requestId(); JigsawStudioPreviewRenderer.PreviewBounds bounds = previewRenderer.bounds(requestId); if (bounds == null || bounds.isEmpty()) { - JigsawStudioGraphEvaluation evaluation = evaluations.get(requestId); + JigsawStudioGraphEvaluation evaluation = evaluator.evaluations.get(requestId); message(player, evaluation == null ? "The seed-1337 preview is still being evaluated." : "The seed-1337 preview has no generated blocks: " + evaluation.detail()); @@ -2544,407 +272,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return true; } - private void scheduleInitialEvaluation(ActiveStudio studio) { - if (studio == null) { - return; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - UUID requestId = request.requestId(); - if (!claimInitialEvaluation( - studio.evaluationGeneration(), - isCurrentRequest(studio, requestId))) { - return; - } - publishEvaluation(studio, requestId, 1L); - } - - static boolean claimInitialEvaluation(AtomicLong generation, boolean currentRequest) { - return currentRequest - && Objects.requireNonNull(generation, "Jigsaw Studio evaluation generation") - .compareAndSet(0L, 1L); - } - - private void scheduleEvaluation(ActiveStudio studio) { - if (studio == null) { - return; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - UUID requestId = request.requestId(); - if (!isCurrentRequest(studio, requestId)) { - return; - } - publishEvaluation(studio, requestId, studio.evaluationGeneration().incrementAndGet()); - } - - private void publishEvaluation(ActiveStudio studio, UUID requestId, long generation) { - JigsawStudioGraphEvaluation previous = evaluations.get(requestId); - JigsawStudioPreviewRenderer.PreviewBounds previousBounds = previous == null - ? JigsawStudioPreviewRenderer.PreviewBounds.empty() - : previous.previewBounds(); - evaluations.put(requestId, new JigsawStudioGraphEvaluation( - requestId, - generation, - PREVIEW_SEED, - JigsawStudioEvaluationState.PENDING, - previous == null ? "" : previous.selectedTheme(), - previous == null ? 0 : previous.pieceCount(), - "Compiling the committed graph and assembling seed 1337", - previousBounds)); - refreshAllWorkcellContexts(studio); - J.a(() -> evaluateGraph(studio, requestId, generation)); - } - - private void evaluateGraph(ActiveStudio studio, UUID requestId, long generation) { - EvaluationComputation computation; - try { - JigsawStudioActivation.Request request = studio.generator().getRequest(); - IrisStructure structure = request.source().load( - IrisStructure.class, - request.structureKey(), - false); - if (structure == null) { - throw new IOException("The active structure resource no longer exists"); - } - StructureGraphCompilation compilation = StructureGraphCompiler.compile( - structure, - StructureGraphResolver.forData(request.source())); - StructureGraphDiagnostic firstError = firstDiagnostic( - compilation, - StructureGraphDiagnostic.Severity.ERROR); - if (firstError != null) { - computation = invalidEvaluation( - requestId, - generation, - firstError.code() + ": " + firstError.message()); - } else { - IrisPosition origin = previewOrigin(studio.generator().getLayout(), structure); - StructureAssembler assembler = StructureAssembler.forCompilation(compilation, origin); - StructureAssemblyResult assembly = assembler.assemble(new RNG(PREVIEW_SEED)); - computation = evaluationForAssembly( - requestId, - generation, - compilation, - assembly, - studio.generator().getLayout().mode()); - } - } catch (Throwable exception) { - IrisLogging.reportError(exception); - computation = invalidEvaluation(requestId, generation, failureMessage(exception)); - } - completeEvaluation(studio, computation); - } - - private EvaluationComputation evaluationForAssembly( - UUID requestId, - long generation, - StructureGraphCompilation compilation, - StructureAssemblyResult assembly, - JigsawStudioMode mode - ) throws IOException { - if (assembly.status().isFailure()) { - return invalidEvaluation( - requestId, - generation, - assembly.status().name().toLowerCase(Locale.ROOT) + ": " + assembly.detail()); - } - if (!assembly.hasOutput()) { - return new EvaluationComputation( - new JigsawStudioGraphEvaluation( - requestId, - generation, - PREVIEW_SEED, - JigsawStudioEvaluationState.WARNING, - assembly.selectedTheme(), - 0, - assembly.detail().isEmpty() - ? "Seed 1337 intentionally generated no structure" - : assembly.detail(), - JigsawStudioPreviewRenderer.PreviewBounds.empty()), - JigsawStudioPreviewRenderer.PreviewPlan.empty()); - } - List aligned = alignPreviewPieces(assembly.pieces(), mode); - JigsawStudioPreviewRenderer.PreviewPlan plan = JigsawStudioPreviewRenderer.plan(aligned); - StructureGraphDiagnostic firstWarning = firstDiagnostic( - compilation, - StructureGraphDiagnostic.Severity.WARNING); - JigsawStudioEvaluationState state = firstWarning == null - ? JigsawStudioEvaluationState.VALID - : JigsawStudioEvaluationState.WARNING; - String detail = firstWarning == null - ? "Seed 1337 assembled " + aligned.size() + " piece(s)" - : firstWarning.code() + ": " + firstWarning.message(); - return new EvaluationComputation( - new JigsawStudioGraphEvaluation( - requestId, - generation, - PREVIEW_SEED, - state, - assembly.selectedTheme(), - aligned.size(), - detail, - plan.bounds()), - plan); - } - - private void completeEvaluation(ActiveStudio studio, EvaluationComputation computation) { - JigsawStudioGraphEvaluation evaluated = computation.evaluation(); - UUID requestId = evaluated.requestId(); - if (!isCurrentEvaluation(studio, requestId, evaluated.generation())) { - return; - } - previewRenderer.render( - studio.world(), - requestId, - evaluated.generation(), - computation.plan(), - result -> { - if (!isCurrentEvaluation(studio, requestId, evaluated.generation())) { - return; - } - JigsawStudioGraphEvaluation completed = result.successful() - ? evaluated - : new JigsawStudioGraphEvaluation( - requestId, - evaluated.generation(), - PREVIEW_SEED, - JigsawStudioEvaluationState.WARNING, - evaluated.selectedTheme(), - evaluated.pieceCount(), - evaluated.detail() + "; " + result.failure(), - evaluated.previewBounds()); - evaluations.put(requestId, completed); - refreshAllWorkcellContexts(studio); - }); - } - - private boolean isCurrentEvaluation(ActiveStudio studio, UUID requestId, long generation) { - if (!isCurrentRequest(studio, requestId) - || studio.evaluationGeneration().get() != generation) { - return false; - } - JigsawStudioGraphEvaluation current = evaluations.get(requestId); - return current != null && current.generation() == generation; - } - - private static EvaluationComputation invalidEvaluation( - UUID requestId, - long generation, - String detail - ) { - return new EvaluationComputation( - new JigsawStudioGraphEvaluation( - requestId, - generation, - PREVIEW_SEED, - JigsawStudioEvaluationState.INVALID, - "", - 0, - detail, - JigsawStudioPreviewRenderer.PreviewBounds.empty()), - JigsawStudioPreviewRenderer.PreviewPlan.empty()); - } - - private static StructureGraphDiagnostic firstDiagnostic( - StructureGraphCompilation compilation, - StructureGraphDiagnostic.Severity severity - ) { - for (StructureGraphDiagnostic diagnostic : compilation.getDiagnostics()) { - if (diagnostic.severity() == severity) { - return diagnostic; - } - } - return null; - } - - private static IrisPosition previewOrigin(JigsawStudioLayout layout, IrisStructure structure) { - int radius = Math.max(1, structure.getMaxSizeChunks()) * 16; - return new IrisPosition( - -radius - 32, - 0, - Math.max(16, layout.extentZ() / 2)); - } - - static List alignPreviewPieces( - List pieces, - JigsawStudioMode mode - ) { - int minimumY = Integer.MAX_VALUE; - for (PlacedStructurePiece piece : pieces) { - minimumY = Math.min(minimumY, piece.getMinY()); - } - int baseY = mode == JigsawStudioMode.SPATIAL_JIGSAW - ? SPATIAL_PREVIEW_BASE_Y - : JigsawStudioLayout.FLOOR_Y + 1; - int shiftY = baseY - minimumY; - List aligned = new ArrayList<>(pieces.size()); - for (PlacedStructurePiece piece : pieces) { - aligned.add(new PlacedStructurePiece( - piece.getPiece(), - piece.getObject(), - piece.getX(), - piece.getY() + shiftY, - piece.getZ(), - piece.getRotation(), - piece.getMinX(), - piece.getMinY() + shiftY, - piece.getMinZ(), - piece.getMaxX(), - piece.getMaxY() + shiftY, - piece.getMaxZ())); - } - return List.copyOf(aligned); - } - - private void refreshAllWorkcellContexts(ActiveStudio studio) { - scheduleOnlinePlayers(studio.worldId()); - } - - private static IrisStructure loadStudioStructure(ActiveStudio studio) { - JigsawStudioActivation.Request request = studio.generator().getRequest(); - return request.source().load(IrisStructure.class, request.structureKey(), false); - } - - private static boolean canResizeVariantToCapacity( - JigsawStudioBay workcell, - JigsawStudioVariant variant, - boolean active - ) { - if (!active || !variant.owned()) { - return false; - } - JigsawStudioCellDimensions canonical = variant.dimensions().orElse(null); - if (canonical == null) { - return false; - } - JigsawStudioCellDimensions target = workcell.capacity(); - return canonical.width() <= target.width() - && canonical.height() <= target.height() - && canonical.depth() <= target.depth() - && (canonical.width() < target.width() - || canonical.height() < target.height() - || canonical.depth() < target.depth()); - } - - public Optional menuState(Player player) { - if (player == null || !J.isOwnedByCurrentRegion(player)) { - return Optional.empty(); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - return Optional.empty(); - } - if (!ownerMatches(player, studio)) { - return Optional.empty(); - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioLayout layout = session.layout(); - IrisStructure structure = loadStudioStructure(studio); - List themeSets = new ArrayList<>(); - if (structure != null && structure.getThemeSets() != null) { - for (IrisJigsawThemeSet themeSet : structure.getThemeSets()) { - if (themeSet != null) { - themeSets.add(new JigsawStudioMenuState.ThemeSet( - themeSet.getKey(), - themeSet.getWeight())); - } - } - } - List workcells = new ArrayList<>(layout.bays().size()); - for (JigsawStudioBay workcell : layout.bays()) { - JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcell.stableId()); - List variants = new ArrayList<>(); - for (JigsawStudioVariant variant : layout.variants(workcell)) { - boolean active = variant.pieceKey().equals(snapshot.activeVariantKey()); - List memberships = new ArrayList<>( - variant.memberships().size()); - for (JigsawStudioPoolMembership membership : variant.memberships()) { - memberships.add(new JigsawStudioMenuState.Membership( - membership.poolKey(), - membership.entryIndex(), - membership.weight(), - membership.chance())); - } - variants.add(new JigsawStudioMenuState.Variant( - variant.pieceKey(), - variant.resolvedDisplayName(), - variant.dimensions(), - active, - variant.owned(), - variant.rotatable(), - canToggleVariantRotation(request.compatibilityTarget(), variant), - canResizeVariantToCapacity(workcell, variant, active), - variant.themes(), - variant.rules(), - memberships)); - } - workcells.add(new JigsawStudioMenuState.Workcell( - workcell.stableId(), - workcell.canonicalDisplayName(), - workcell.displayName(), - workcell.capacity(), - workcell.enabled(), - snapshot.activeVariantKey(), - snapshot.dirty(), - snapshot.saveInProgress(), - snapshot.switchInProgress(), - snapshot.connectorsVisible(), - variants)); - } - - return Optional.of(new JigsawStudioMenuState( - studio.worldId(), - request.requestId(), - request.structureKey(), - layout.mode(), - request.compatibilityTarget(), - structure != null && structure.isRequireCaps(), - themeSets, - session.selectedBayId().orElse(""), - Optional.ofNullable(evaluations.get(request.requestId())) - .map(JigsawStudioMenuState.Evaluation::from) - .orElseGet(JigsawStudioMenuState.Evaluation::pending), - workcells)); - } - - public boolean selectWorkcell(Player player, String workcellId) { - if (player == null || workcellId == null || workcellId.isBlank()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> selectWorkcell(player, workcellId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - if (!session.selectBay(workcellId)) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return false; - } - ensureVisualizationLoop(player); - return true; - } - - public boolean openControlMenu(Player player) { - if (player != null && J.isOwnedByCurrentRegion(player)) { - finalizeJigsawTileWatchesForPlayer(player.getUniqueId()); - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio != null - && reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { - message(player, "Close and reopen Jigsaw Studio to apply the resized workcell layout."); - return false; - } - } - JigsawStudioMenuController activeMenuController = menuController; - return activeMenuController != null && activeMenuController.open(player); - } - public boolean giveTool(Player player, JigsawStudioToolPayload payload) { if (player == null || payload == null) { return false; @@ -2959,7 +286,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA message(player, "This tool belongs to a different or closed Jigsaw Studio session."); return false; } - ItemStack tool = toolCodec.create(payload); + ItemStack tool = toolbelt.toolCodec.create(payload); Map rejected = player.getInventory().addItem(tool); if (!rejected.isEmpty()) { message(player, "Your inventory is full; no Jigsaw Studio tool was added."); @@ -2969,4033 +296,16 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return true; } - public boolean flushAutosave(Player player, String workcellId) { - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> flushAutosave(player, workcellId)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !authorizeOwner(player, studio)) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - String targetId = workcellId == null || workcellId.isBlank() - ? session.selectedBayId().orElse("") - : workcellId; - JigsawStudioBay bay = session.layout().get(targetId); - if (bay == null) { - message(player, "Select a Jigsaw Studio workcell before saving now."); - return false; - } + void markEvaluationStale(ActiveStudio studio) { UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - if (hasJigsawTileWatch(requestId)) { - message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); - return false; - } - SaveAttempt attempt = startSave(studio, studio.world(), bay, player, true); - if (attempt == SaveAttempt.STARTED) { - return true; - } - if (attempt == SaveAttempt.PERSISTENT_FAILURE) { - return false; - } - AutosaveTicket ticket = autosaves.get(new AutosaveKey(requestId, bay.stableId())); - if (ticket != null) { - expediteAutosave( - ticket, - attempt == SaveAttempt.RETRY - ? AUTOSAVE_RETRY_TICKS - : AUTOSAVE_DEBOUNCE_TICKS); - } - return false; - } - - public void closeMenu(Player player) { - JigsawStudioMenuController activeMenuController = menuController; - if (activeMenuController != null) { - activeMenuController.close(player); - } - } - - private boolean useTool( - Player player, - JigsawStudioToolPayload payload, - ItemStack tool, - boolean resetLabel - ) { - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> useTool(player, payload, tool, resetLabel)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null - || !studio.generator().getRequest().requestId().equals(payload.requestId()) - || !authorizeOwner(player, studio)) { - message(player, "This Jigsaw Studio tool is stale or belongs to another session."); - return false; - } - if (payload.action().destructive() && !confirmTool(player, payload)) { - message(player, "Right-click the same tool again within 10 seconds to confirm " - + payload.action().displayName() + "."); - return true; - } - return switch (payload.action()) { - case OPEN_MENU -> openControlMenu(player); - case SELECT_WORKCELL -> selectWorkcell(player, payload.workcellId()); - case LOAD_VARIANT -> switchVariant( - player, - payload.workcellId(), - payload.pieceKey(), - false); - case CREATE_VARIANT -> createVariant(player, payload.workcellId(), false); - case DUPLICATE_VARIANT -> createVariant(player, payload.workcellId(), true); - case DUPLICATE_FAMILY -> duplicateFamilyFromTool(player); - case PREVIEW_GRAPH -> goToPreview(player); - case FLUSH_AUTOSAVE -> flushAutosave(player, payload.workcellId()); - case TOGGLE_ROTATION -> toggleVariantRotatable(player, payload.workcellId()); - case EXPAND_TO_CELL -> expandVariantToCell(player, payload.workcellId()); - case RESIZE_VARIANT -> openVariantSizeSettingsFromTool(player, payload); - case RENAME_VARIANT -> renameVariantFromTool(player, payload, tool, resetLabel); - case ADJUST_VARIANT_WEIGHT -> adjustVariantWeight( - player, - payload.workcellId(), - payload.pieceKey(), - payload.poolKey(), - payload.entryIndex(), - payload.amount()); - case ADJUST_VARIANT_CHANCE -> adjustVariantChance( - player, - payload.workcellId(), - payload.pieceKey(), - payload.poolKey(), - payload.entryIndex(), - payload.amount()); - case UNLINK_MEMBERSHIP -> unlinkVariantMembership( - player, - payload.workcellId(), - payload.pieceKey(), - payload.poolKey(), - payload.entryIndex()); - case TOGGLE_WORKCELL -> toggleWorkcellFromTool(player, payload.workcellId()); - case RESIZE_WORKCELL -> openWorkcellSettingsFromTool(player, payload.workcellId()); - case RENAME_WORKCELL -> renameWorkcellFromTool(player, payload, tool, resetLabel); - case SET_THEME -> useThemeTool(player, payload); - case SET_PIECE_RULES -> openVariantSettingsFromTool(player, payload); - case DELETE_VARIANT -> deleteVariant(player, payload.workcellId(), payload.pieceKey()); - case DELETE_PROJECT -> deleteProject(player); - case TOGGLE_REQUIRE_CAPS -> toggleRequireCapsFromTool(player); - }; - } - - private boolean toggleWorkcellFromTool(Player player, String workcellId) { - Optional state = menuState(player); - JigsawStudioMenuState.Workcell workcell = state - .map(menu -> menu.workcell(workcellId)) - .orElse(null); - if (workcell == null) { - message(player, "This bound workcell no longer exists."); - return false; - } - return setWorkcellEnabled(player, workcellId, !workcell.enabled()); - } - - private boolean openWorkcellSettingsFromTool(Player player, String workcellId) { - JigsawStudioMenuController activeMenuController = menuController; - return activeMenuController != null - && activeMenuController.openWorkcellSettings(player, workcellId); - } - - private boolean openVariantSettingsFromTool(Player player, JigsawStudioToolPayload payload) { - JigsawStudioMenuController activeMenuController = menuController; - return activeMenuController != null - && activeMenuController.openVariantSettings( - player, - payload.workcellId(), - payload.pieceKey()); - } - - private boolean openVariantSizeSettingsFromTool(Player player, JigsawStudioToolPayload payload) { - JigsawStudioMenuController activeMenuController = menuController; - return activeMenuController != null - && activeMenuController.openVariantSizeSettings( - player, - payload.workcellId(), - payload.pieceKey()); - } - - private boolean renameVariantFromTool( - Player player, - JigsawStudioToolPayload payload, - ItemStack tool, - boolean resetLabel - ) { - Optional displayName = toolDisplayName(player, payload, tool, resetLabel); - return displayName.isPresent() && updateVariantDisplayName( - player, - payload.workcellId(), - payload.pieceKey(), - displayName.get()); - } - - private boolean renameWorkcellFromTool( - Player player, - JigsawStudioToolPayload payload, - ItemStack tool, - boolean resetLabel - ) { - Optional displayName = toolDisplayName(player, payload, tool, resetLabel); - return displayName.isPresent() && updateWorkcellDisplayName( - player, - payload.workcellId(), - displayName.get()); - } - - private static Optional toolDisplayName( - Player player, - JigsawStudioToolPayload payload, - ItemStack tool, - boolean resetLabel - ) { - if (resetLabel) { - return Optional.of(""); - } - String displayName = tool == null || !tool.hasItemMeta() || tool.getItemMeta() == null - ? "" - : tool.getItemMeta().getDisplayName(); - String normalized = ChatColor.stripColor(displayName); - normalized = normalized == null ? "" : normalized.trim(); - String defaultName = "Jigsaw Studio: " + payload.action().displayName(); - if (normalized.isEmpty() || normalized.equals(defaultName)) { - message(player, "Rename this bound stick in an anvil to the desired label, then right-click it. " - + "Sneak-right-click resets the label."); - return Optional.empty(); - } - return Optional.of(normalized); - } - - private boolean useThemeTool(Player player, JigsawStudioToolPayload payload) { - if (!payload.pieceKey().isBlank()) { - return openVariantSettingsFromTool(player, payload); - } - Optional state = menuState(player); - if (state.isEmpty()) { - return false; - } - return duplicateActiveFamily( - player, - JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); - } - - private boolean duplicateFamilyFromTool(Player player) { - Optional state = menuState(player); - return state.isPresent() && duplicateActiveFamily( - player, - JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); - } - - private boolean toggleRequireCapsFromTool(Player player) { - Optional state = menuState(player); - return state.isPresent() && setRequireCaps(player, !state.get().requireCaps()); - } - - private boolean confirmTool(Player player, JigsawStudioToolPayload payload) { - long now = System.nanoTime(); - ToolConfirmation previous = toolConfirmations.get(player.getUniqueId()); - if (previous != null - && previous.expiresAtNanos() >= now - && previous.payload().equals(payload)) { - toolConfirmations.remove(player.getUniqueId(), previous); - return true; - } - toolConfirmations.put( - player.getUniqueId(), - new ToolConfirmation(payload, now + TOOL_CONFIRM_NANOS)); - return false; - } - - private JigsawStudioVariant activeOwnedVariant( - Player player, - ActiveStudio studio, - String workcellId - ) { - if (studio == null) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return null; - } - JigsawStudioSession session = studio.generator().getSession(); - if (session.layout().get(workcellId) == null) { - message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); - return null; - } - JigsawStudioVariant variant = session.activeVariant(workcellId).orElse(null); - if (variant == null) { - message(player, "This workcell has no active variant."); - return null; - } - if (!variant.owned()) { - message(player, "Variant '" + variant.pieceKey() - + "' is read-only. Adopt or clone its graph before editing it."); - return null; - } - return variant; - } - - private JigsawStudioVariant activeOwnedVariant( - Player player, - ActiveStudio studio, - String workcellId, - String expectedPieceKey - ) { - JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId); - if (variant == null) { - return null; - } - if (!variant.pieceKey().equals(expectedPieceKey)) { - message(player, "The bound variant changed. Open the control menu or request a fresh tool."); - return null; - } - return variant; - } - - private static JigsawStudioPoolMembership findMembership( - JigsawStudioVariant variant, - String poolKey, - int entryIndex - ) { - for (JigsawStudioPoolMembership membership : variant.memberships()) { - if (membership.poolKey().equals(poolKey) && membership.entryIndex() == entryIndex) { - return membership; - } - } - return null; - } - - private boolean deferDuplicationUntilAutosaved( - Player player, - ActiveStudio studio, - DeferredDuplication requested - ) { - JigsawStudioSession session = studio.generator().getSession(); - UUID requestId = studio.generator().getRequest().requestId(); - boolean autosavePending; - synchronized (saveLifecycleLock) { - autosavePending = session.isDirty() || savesInProgress.contains(requestId); - } - if (!autosavePending) { - return false; - } - DeferredDuplication existing = deferredDuplications.putIfAbsent(requestId, requested); - if (existing == null) { - message(player, requested.kind() == DeferredDuplicationKind.SINGLE - ? "Autosave is finishing first; this cell's variant will duplicate automatically." - : "Autosave is finishing every edited cell first; the coherent family will duplicate automatically."); - expediteAutosaves(requestId); - scheduleDeferredDuplication(requested); - return true; - } - message(player, existing.sameIntent(requested) - ? "That duplicate action is already queued behind autosave." - : "Another duplicate action is already queued behind autosave for this Studio."); - return true; - } - - private void scheduleDeferredDuplication(DeferredDuplication deferred) { - if (deferredDuplications.get(deferred.requestId()) != deferred - || !deferred.scheduled().compareAndSet(false, true)) { - return; - } - try { - J.s(() -> { - deferred.scheduled().set(false); - if (deferredDuplications.get(deferred.requestId()) != deferred) { - return; - } - Player player = Bukkit.getPlayer(deferred.playerId()); - if (player == null) { - deferredDuplications.remove(deferred.requestId(), deferred); - return; - } - boolean scheduled = J.runEntity( - player, - () -> resumeDeferredDuplication(player, deferred), - 0, - () -> deferredDuplications.remove(deferred.requestId(), deferred)); - if (!scheduled) { - deferredDuplications.remove(deferred.requestId(), deferred); - } - }, AUTOSAVE_RETRY_TICKS); - } catch (Throwable exception) { - deferred.scheduled().set(false); - deferredDuplications.remove(deferred.requestId(), deferred); - IrisLogging.reportError(exception); - } - } - - private void resumeDeferredDuplication(Player player, DeferredDuplication deferred) { - if (deferredDuplications.get(deferred.requestId()) != deferred) { - return; - } - ActiveStudio studio = studios.get(deferred.worldId()); - JigsawStudioSession session = studio == null ? null : studio.generator().getSession(); - boolean currentRequest = studio != null - && studio.generator().getRequest().requestId().equals(deferred.requestId()) - && session.sessionId().equals(deferred.sessionId()) - && player.getWorld().getUID().equals(deferred.worldId()); - boolean sourcesCurrent = currentRequest && sourceBindingsCurrent(session, deferred.sourcePieces()); - boolean autosavePending; - boolean operationPending; - boolean terminal; - synchronized (saveLifecycleLock) { - autosavePending = currentRequest - && (session.isDirty() || savesInProgress.contains(deferred.requestId())); - operationPending = currentRequest - && (graphMutationsInProgress.contains(deferred.requestId()) - || materializationsInProgress.contains(deferred.requestId()) - || exportsInProgress.contains(deferred.requestId()) - || session.operationInProgress() - || hasJigsawTileWatch(deferred.requestId())); - terminal = !currentRequest - || closingRequests.contains(deferred.requestId()) - || reopenRequiredRequests.contains(deferred.requestId()); - } - DeferredDuplicationReadiness readiness = deferredDuplicationReadiness( - currentRequest, - sourcesCurrent, - autosavePending, - operationPending, - terminal); - if (readiness == DeferredDuplicationReadiness.STALE) { - deferredDuplications.remove(deferred.requestId(), deferred); - message(player, "The queued duplicate was cancelled because its Studio or source variant changed."); - return; - } - if (readiness == DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE) { - expediteAutosaves(deferred.requestId()); - scheduleDeferredDuplication(deferred); - return; - } - if (readiness == DeferredDuplicationReadiness.WAITING_FOR_OPERATION) { - scheduleDeferredDuplication(deferred); - return; - } - boolean started = deferred.kind() == DeferredDuplicationKind.SINGLE - ? createVariant(player, deferred.workcellId(), true) - : duplicateActiveFamily(player, deferred.themeKey()); - if (started) { - deferredDuplications.remove(deferred.requestId(), deferred); - return; - } - if (isCurrentRequest(studio, deferred.requestId()) - && sourceBindingsCurrent(session, deferred.sourcePieces())) { - scheduleDeferredDuplication(deferred); - } else { - deferredDuplications.remove(deferred.requestId(), deferred); - } - } - - static DeferredDuplicationReadiness deferredDuplicationReadiness( - boolean currentRequest, - boolean sourcesCurrent, - boolean autosavePending, - boolean operationPending, - boolean terminal - ) { - if (!currentRequest || !sourcesCurrent || terminal) { - return DeferredDuplicationReadiness.STALE; - } - if (autosavePending) { - return DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE; - } - if (operationPending) { - return DeferredDuplicationReadiness.WAITING_FOR_OPERATION; - } - return DeferredDuplicationReadiness.READY; - } - - private static boolean sourceBindingsCurrent( - JigsawStudioSession session, - Map expectedSources - ) { - if (session == null) { - return false; - } - for (Map.Entry source : expectedSources.entrySet()) { - if (session.activeVariant(source.getKey()) - .map(JigsawStudioVariant::pieceKey) - .filter(source.getValue()::equals) - .isEmpty()) { - return false; - } - } - return true; - } - - private String beginGraphMutation( - ActiveStudio studio, - JigsawStudioSession session - ) { - UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - synchronized (saveLifecycleLock) { - if (closingRequests.contains(requestId)) { - return "This Jigsaw Studio is closing and cannot update its graph."; - } - if (savesInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio save to finish."; - } - if (graphMutationsInProgress.contains(requestId)) { - return "A Jigsaw Studio graph update is already running."; - } - if (exportsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio export to finish."; - } - if (materializationsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio variant load or rollback to finish."; - } - if (session.operationInProgress()) { - return "Wait for the current workcell operation to finish."; - } - if (reopenRequiredRequests.contains(requestId)) { - return "Close and reopen Jigsaw Studio before making another graph change."; - } - if (hasJigsawTileWatch(requestId)) { - return "Finish or close the open vanilla jigsaw-block editor before changing graph metadata."; - } - if (session.isDirty()) { - return "Wait for every dirty workcell to finish autosaving before changing graph metadata."; - } - graphMutationsInProgress.add(requestId); - return ""; - } - } - - public boolean runCommandGraphMutation( - Player player, - UUID expectedRequestId, - CommandGraphMutation task - ) { - Objects.requireNonNull(expectedRequestId, "Jigsaw Studio command graph request ID"); - Objects.requireNonNull(task, "Jigsaw Studio command graph mutation"); - if (player == null) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> runCommandGraphMutation(player, expectedRequestId, task)); - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null - || !studio.generator().getRequest().requestId().equals(expectedRequestId)) { - message(player, "This Jigsaw Studio session is no longer active."); - return false; - } - if (!authorizeOwner(player, studio)) { - return false; - } - String reservationFailure = beginGraphMutation(studio, studio.generator().getSession()); - if (!reservationFailure.isEmpty()) { - message(player, reservationFailure); - return false; - } - return scheduleGraphMutation(player, studio, task); - } - - private boolean scheduleGraphMutation( - Player player, - ActiveStudio studio, - CommandGraphMutation task - ) { - UUID requestId = studio.generator().getRequest().requestId(); - J.a(() -> { - CommandGraphMutationResult result = null; - Throwable failure = null; - try { - result = task.run(); - } catch (Throwable exception) { - failure = exception; - } - CommandGraphMutationResult completedResult = result; - Throwable completedFailure = failure; - boolean scheduled = J.runEntity( - player, - () -> completeGraphMutation( - player, - studio, - requestId, - completedResult, - completedFailure), - 0, - () -> finishGraphMutation(requestId)); - if (!scheduled) { - finishGraphMutation(requestId); - if (completedFailure != null) { - IrisLogging.reportError(completedFailure); - } - } - }); - return true; - } - - private void completeGraphMutation( - Player player, - ActiveStudio studio, - UUID requestId, - CommandGraphMutationResult result, - Throwable failure - ) { - try { - if (failure != null) { - IrisLogging.reportError(failure); - message(player, "Graph update failed: " + failureMessage(failure)); - finishGraphMutation(requestId); - return; - } - if (result == null) { - message(player, "Graph update completed without a result; no Studio state changed."); - finishGraphMutation(requestId); - return; - } - if (!isCurrentRequest(studio, requestId)) { - message(player, "The graph updated on disk after this Studio session changed; reopen it to continue."); - finishGraphMutation(requestId); - return; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioLayout previousLayout = session.layout(); - if (result.rebindActiveVariants().isEmpty()) { - session.replaceLayout(result.layout()); - } else { - session.replaceLayoutAndRebind(result.layout(), result.rebindActiveVariants()); - } - for (JigsawStudioBay workcell : result.layout().bays()) { - studio.generator().invalidateRender(workcell.stableId()); - } - if (layoutGeometryChanged(previousLayout, result.layout())) { - scheduleLiveRelayout(player, studio, requestId, previousLayout, result); - return; - } - finishGraphMutationSuccess(player, studio, requestId, result); - } catch (Throwable exception) { - IrisLogging.reportError(exception); - message(player, "The graph updated on disk, but Studio could not refresh: " - + failureMessage(exception) + ". Reopen this project before editing further."); - reopenRequiredRequests.add(requestId); - finishGraphMutation(requestId); - } - } - - private void finishGraphMutationSuccess( - Player player, - ActiveStudio studio, - UUID requestId, - CommandGraphMutationResult result - ) { - for (JigsawStudioBay workcell : result.layout().bays()) { - refreshWorkcellContext(studio.worldId(), workcell.stableId()); - } - scheduleEvaluation(studio); - message(player, result.message()); - finishGraphMutation(requestId); - if (!result.activatePieceKey().isEmpty()) { - switchVariant( - player, - result.activateWorkcellId(), - result.activatePieceKey(), - false); - } else if (result.reload().isPresent()) { - reloadActiveVariant(player, studio, result.reload().orElseThrow()); - } - } - - private void scheduleLiveRelayout( - Player player, - ActiveStudio studio, - UUID requestId, - JigsawStudioLayout previousLayout, - CommandGraphMutationResult result - ) { - Set chunks = relayoutChunks(previousLayout, result.layout()); - AtomicInteger remaining = new AtomicInteger(chunks.size()); - AtomicReference failure = new AtomicReference<>(""); - AtomicReference cause = new AtomicReference<>(); - if (chunks.isEmpty()) { - completeLiveRelayout(player, studio, requestId, result, "", null); - return; - } - for (long chunkKey : chunks) { - int chunkX = (int) (chunkKey >> 32); - int chunkZ = (int) chunkKey; - boolean scheduled = J.runRegion(studio.world(), chunkX, chunkZ, () -> { - try { - repaintStudioChunk(studio, chunkX, chunkZ); - } catch (Throwable exception) { - failure.compareAndSet("", "chunk " + chunkX + "," + chunkZ - + " could not regenerate: " + failureMessage(exception)); - cause.compareAndSet(null, exception); - } - if (remaining.decrementAndGet() == 0) { - scheduleLiveRelayoutCompletion( - player, - studio, - requestId, - result, - failure.get(), - cause.get()); - } - }); - if (!scheduled) { - failure.compareAndSet("", "chunk " + chunkX + "," + chunkZ - + " could not be scheduled on its owning region"); - if (remaining.decrementAndGet() == 0) { - scheduleLiveRelayoutCompletion( - player, - studio, - requestId, - result, - failure.get(), - cause.get()); - } - } - } - } - - private void scheduleLiveRelayoutCompletion( - Player player, - ActiveStudio studio, - UUID requestId, - CommandGraphMutationResult result, - String failure, - Throwable cause - ) { - boolean scheduled = J.runEntity( - player, - () -> completeLiveRelayout(player, studio, requestId, result, failure, cause)); - if (!scheduled) { - reopenRequiredRequests.add(requestId); - finishGraphMutation(requestId); - if (cause != null) { - IrisLogging.reportError(cause); - } - } - } - - private void completeLiveRelayout( - Player player, - ActiveStudio studio, - UUID requestId, - CommandGraphMutationResult result, - String failure, - Throwable cause - ) { - if (!failure.isEmpty() || !isCurrentRequest(studio, requestId)) { - reopenRequiredRequests.add(requestId); - studio.populations().clear(); - if (cause != null) { - IrisLogging.reportError(cause); - } - message(player, "The workcell size was saved, but live regeneration failed" - + (failure.isEmpty() ? "." : ": " + failure + ".") - + " Close and reopen this project before editing further."); - finishGraphMutation(requestId); - return; - } - studio.populations().clear(); - for (JigsawStudioBay workcell : result.layout().bays()) { - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(workcell); - studio.replacePopulation( - workcell, - rendered, - rendered.valid() ? "" : rendered.failure(), - rendered.valid()); - } - reopenRequiredRequests.remove(requestId); - finishGraphMutationSuccess(player, studio, requestId, result); - studio.generator().getSession().selectedBayId().ifPresent(workcellId -> teleportTo(player, workcellId)); - } - - static boolean layoutGeometryChanged( - JigsawStudioLayout previous, - JigsawStudioLayout current - ) { - if (previous.bays().size() != current.bays().size()) { - return true; - } - for (JigsawStudioBay previousBay : previous.bays()) { - JigsawStudioBay currentBay = current.get(previousBay.stableId()); - if (currentBay == null || !previousBay.bounds().equals(currentBay.bounds())) { - return true; - } - } - return false; - } - - static Set relayoutChunks( - JigsawStudioLayout previous, - JigsawStudioLayout current - ) { - Set chunks = new HashSet<>(); - addRelayoutChunks(chunks, previous); - addRelayoutChunks(chunks, current); - return Set.copyOf(chunks); - } - - private static void addRelayoutChunks(Set chunks, JigsawStudioLayout layout) { - for (JigsawStudioBay workcell : layout.bays()) { - JigsawStudioBounds bounds = workcell.bounds(); - int minimumChunkX = (bounds.originX() - 1) >> 4; - int maximumChunkX = (bounds.maxX() + 1) >> 4; - int minimumChunkZ = (bounds.originZ() - 1) >> 4; - int maximumChunkZ = (bounds.maxZ() + 1) >> 4; - for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { - for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { - chunks.add(chunkKey(chunkX, chunkZ)); - } - } - } - } - - private static void repaintStudioChunk(ActiveStudio studio, int chunkX, int chunkZ) throws IOException { - World world = studio.world(); - Chunk chunk = world.getChunkAt(chunkX, chunkZ); - TerrainChunk generated = TerrainChunk.create(world); - studio.generator().paintChunk(generated, chunkX, chunkZ); - if (!INMS.get().applyChunkBlocks(chunk, generated)) { - InPlaceChunkRegenerator.applyBlockDiffs( - chunk, - generated.getChunkData(), - world.getMinHeight(), - world.getMaxHeight()); - } - for (JigsawStudioBay workcell : studio.generator().getLayout().bays()) { - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(workcell); - if (!rendered.valid()) { - continue; - } - boolean connectorsVisible = studio.generator().getSession() - .workcellSnapshot(workcell.stableId()) - .connectorsVisible(); - applyRenderedBayChunk(world, workcell, rendered, chunkX, chunkZ, connectorsVisible); - verifyRenderedBayChunk(world, workcell, rendered, chunkX, chunkZ, connectorsVisible); - } - world.refreshChunk(chunkX, chunkZ); - } - - private boolean graphMutationInProgress(UUID requestId) { - synchronized (saveLifecycleLock) { - return graphMutationsInProgress.contains(requestId); - } - } - - private void finishGraphMutation(UUID requestId) { - synchronized (saveLifecycleLock) { - graphMutationsInProgress.remove(requestId); - } - } - - private static JigsawStudioLayout loadMappedLayout(ActiveStudio studio) throws IOException { - JigsawStudioActivation.Request request = studio.generator().getRequest(); - IrisData source = request.source(); - source.invalidateStructureResources(); - IrisStructure structure = source.load(IrisStructure.class, request.structureKey(), false); - if (structure == null) { - throw new IOException("The structure could not be reloaded after the graph transaction"); - } - return JigsawStudioGraphMapper.map(source, structure); - } - - public boolean showAssemblyPreview(Player player, List pieces) { - if (player == null || pieces == null || pieces.isEmpty()) { - return false; - } - if (!J.isOwnedByCurrentRegion(player)) { - return J.runEntity(player, () -> showAssemblyPreview(player, pieces)); - } - if (!studios.containsKey(player.getWorld().getUID())) { - message(player, "Iris Jigsaw Studio is not active in this world."); - return false; - } - List bounds = new ArrayList<>(pieces.size()); - for (PlacedStructurePiece piece : pieces) { - bounds.add(new JigsawStudioPreviewRenderer.PreviewBounds( - piece.getMinX(), - piece.getMinY(), - piece.getMinZ(), - piece.getMaxX(), - piece.getMaxY(), - piece.getMaxZ())); - } - assemblyPreviews.put(player.getUniqueId(), new AssemblyPreview( - player.getWorld().getUID(), - System.currentTimeMillis() + ASSEMBLY_PREVIEW_MILLIS, - List.copyOf(bounds))); - particlesDisabled.remove(player.getUniqueId()); - ensureVisualizationLoop(player); - return true; - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onWorldUnload(WorldUnloadEvent event) { - ActiveStudio studio = studios.get(event.getWorld().getUID()); - if (studio != null) { - UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - if (requiresLifecycleDrain(studio) && !discardingRequest(requestId)) { - event.setCancelled(true); - expediteAutosaves(requestId); - IrisLogging.warn("Jigsaw Studio kept world %s loaded while pending edits finish autosaving", - event.getWorld().getName()); - return; - } - } - unregister(event.getWorld()); - } - - @EventHandler - public void onChunkLoad(ChunkLoadEvent event) { - ActiveStudio studio = studios.get(event.getWorld().getUID()); - if (studio != null) { - markChunkAvailable(studio, event.getChunk().getX(), event.getChunk().getZ()); - } - } - - @EventHandler - public void onPlayerJoin(PlayerJoinEvent event) { - ensureVisualizationLoop(event.getPlayer()); - reconcilePlayerContext(event.getPlayer(), event.getPlayer().getLocation()); - } - - @EventHandler - public void onPlayerChangedWorld(PlayerChangedWorldEvent event) { - closeMenu(event.getPlayer()); - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - tripleSneakTracker.clearPlayer(event.getPlayer().getUniqueId()); - visualizationLoops.remove(event.getPlayer().getUniqueId()); - assemblyPreviews.remove(event.getPlayer().getUniqueId()); - playerWorkcells.remove(event.getPlayer().getUniqueId()); - ensureVisualizationLoop(event.getPlayer()); - reconcilePlayerContext(event.getPlayer(), event.getPlayer().getLocation()); - } - - @EventHandler - public void onPlayerQuit(PlayerQuitEvent event) { - UUID playerId = event.getPlayer().getUniqueId(); - closeMenu(event.getPlayer()); - finalizeJigsawTileWatchesForPlayer(playerId); - tripleSneakTracker.clearPlayer(playerId); - toolConfirmations.remove(playerId); - visualizationLoops.remove(playerId); - particlesDisabled.remove(playerId); - assemblyPreviews.remove(playerId); - playerWorkcells.remove(playerId); - deferredDuplications.entrySet().removeIf(entry -> entry.getValue().playerId().equals(playerId)); - boardService().clearJigsawContext(event.getPlayer()); - } - - @EventHandler - public void onTripleSneak(PlayerToggleSneakEvent event) { - if (!event.isSneaking()) { - return; - } - Player player = event.getPlayer(); - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null || !ownerMatches(player, studio)) { - tripleSneakTracker.clearPlayer(player.getUniqueId()); - return; - } - JigsawStudioTripleSneakTracker.Progress progress = tripleSneakTracker.recordSneak( - player.getUniqueId(), - studio.worldId(), - studio.generator().getRequest().requestId(), - System.nanoTime()); - if (progress == JigsawStudioTripleSneakTracker.Progress.TRIGGERED) { - openControlMenu(player); - } - } - - @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) - public void onUseTool(PlayerInteractEvent event) { - if (event.getHand() != EquipmentSlot.HAND - || (event.getAction() != Action.RIGHT_CLICK_AIR - && event.getAction() != Action.RIGHT_CLICK_BLOCK)) { - return; - } - Optional decoded = toolCodec.decode(event.getItem()); - if (decoded.isEmpty()) { - return; - } - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - event.setCancelled(true); - useTool(event.getPlayer(), decoded.get(), event.getItem(), event.getPlayer().isSneaking()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPlayerMove(PlayerMoveEvent event) { - if (sameBlockPosition(event.getFrom(), event.getTo())) { - return; - } - reconcilePlayerContext(event.getPlayer(), event.getTo()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPlayerTeleport(PlayerTeleportEvent event) { - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - reconcilePlayerContext(event.getPlayer(), event.getTo()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPlayerPortal(PlayerPortalEvent event) { - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - reconcilePlayerContext(event.getPlayer(), event.getTo()); - } - - @EventHandler(priority = EventPriority.MONITOR) - public void onPlayerRespawn(PlayerRespawnEvent event) { - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - reconcilePlayerContext(event.getPlayer(), event.getRespawnLocation()); - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onNaturalCreatureSpawn(CreatureSpawnEvent event) { - if (studios.containsKey(event.getLocation().getWorld().getUID()) - && isNaturalStudioSpawn(event.getSpawnReason())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedBlockPlace(BlockPlaceEvent event) { - if (isUnauthorizedStudioEdit(event.getPlayer(), event.getBlockPlaced())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedBlockMultiPlace(BlockMultiPlaceEvent event) { - for (BlockState state : event.getReplacedBlockStates()) { - if (isUnauthorizedStudioEdit(event.getPlayer(), state.getBlock())) { - event.setCancelled(true); - return; - } - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockBreak(BlockBreakEvent event) { - if (isControlChest(event.getBlock())) { - event.setCancelled(true); - message(event.getPlayer(), "The Jigsaw Studio control chest cannot be removed."); - return; - } - if (isUnauthorizedStudioEdit(event.getPlayer(), event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedBucketEmpty(PlayerBucketEmptyEvent event) { - Block target = event.getBlockClicked().getRelative(event.getBlockFace()); - if (isUnauthorizedStudioEdit(event.getPlayer(), target)) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedBucketFill(PlayerBucketFillEvent event) { - if (isUnauthorizedStudioEdit(event.getPlayer(), event.getBlockClicked())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedInteract(PlayerInteractEvent event) { - if (event.getAction() == Action.RIGHT_CLICK_BLOCK - && !isControlChest(event.getClickedBlock()) - && isUnauthorizedStudioEdit(event.getPlayer(), event.getClickedBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockPlace(BlockPlaceEvent event) { - markDirty(event.getBlockPlaced()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockMultiPlace(BlockMultiPlaceEvent event) { - for (BlockState state : event.getReplacedBlockStates()) { - markDirty(state.getBlock()); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockBreak(BlockBreakEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBucketEmpty(PlayerBucketEmptyEvent event) { - markDirty(event.getBlockClicked().getRelative(event.getBlockFace())); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBucketFill(PlayerBucketFillEvent event) { - markDirty(event.getBlockClicked()); - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onControlChest(PlayerInteractEvent event) { - if (event.getAction() != Action.RIGHT_CLICK_BLOCK - || event.getHand() != EquipmentSlot.HAND - || !isControlChest(event.getClickedBlock())) { - return; - } - event.setCancelled(true); - ActiveStudio studio = studios.get(event.getPlayer().getWorld().getUID()); - if (!authorizeOwner(event.getPlayer(), studio)) { - return; - } - openControlMenu(event.getPlayer()); - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockExplode(BlockExplodeEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID()))) { - event.blockList().clear(); - return; - } - event.blockList().removeIf(this::isImmutableStudioBlock); - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedEntityExplode(EntityExplodeEvent event) { - if (materializationInProgress(studios.get(event.getEntity().getWorld().getUID()))) { - event.blockList().clear(); - return; - } - event.blockList().removeIf(this::isImmutableStudioBlock); - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedPistonExtend(BlockPistonExtendEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || movesProtectedBlocks(event.getBlocks(), event.getDirection())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedPistonRetract(BlockPistonRetractEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || movesProtectedBlocks(event.getBlocks(), event.getDirection())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedEntityChangeBlock(EntityChangeBlockEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockFromTo(BlockFromToEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock()) - || isImmutableStudioBlock(event.getToBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockForm(BlockFormEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockGrow(BlockGrowEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockSpread(BlockSpreadEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock()) - || isImmutableStudioBlock(event.getSource())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockFade(BlockFadeEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockBurn(BlockBurnEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST) - public void onProtectedBlockRedstone(BlockRedstoneEvent event) { - if (materializationInProgress(studios.get(event.getBlock().getWorld().getUID())) - || isImmutableStudioBlock(event.getBlock())) { - event.setNewCurrent(event.getOldCurrent()); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedStructureGrow(StructureGrowEvent event) { - if (event.getLocation().getWorld() != null - && (materializationInProgress(studios.get(event.getLocation().getWorld().getUID())) - || containsImmutableStudioBlock(event.getBlocks()))) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedInventoryClick(InventoryClickEvent event) { - if (!blocksInventoryMutation( - event.getView().getTopInventory(), - event.getWhoClicked().getUniqueId())) { - return; - } - event.setCancelled(true); - if (event.getWhoClicked() instanceof Player player) { - message(player, "This Jigsaw Studio container is read-only during the current operation or owner session."); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedInventoryDrag(InventoryDragEvent event) { - if (!blocksInventoryMutation( - event.getView().getTopInventory(), - event.getWhoClicked().getUniqueId())) { - return; - } - event.setCancelled(true); - if (event.getWhoClicked() instanceof Player player) { - message(player, "This Jigsaw Studio container is read-only during the current operation or owner session."); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedInventoryMove(InventoryMoveItemEvent event) { - if (blocksInventoryMutation(event.getSource(), null) - || blocksInventoryMutation(event.getDestination(), null)) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedInventoryPickup(InventoryPickupItemEvent event) { - if (blocksInventoryMutation(event.getInventory(), null)) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockCook(BlockCookEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedFurnaceBurn(FurnaceBurnEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBrew(BrewEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBrewingStandFuel(BrewingStandFuelEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedBlockDispense(BlockDispenseEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onProtectedCrafterCraft(CrafterCraftEvent event) { - if (blocksMachineMutation(event.getBlock())) { - event.setCancelled(true); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPlayerInteract(PlayerInteractEvent event) { - if (event.getAction() != Action.RIGHT_CLICK_BLOCK && event.getAction() != Action.PHYSICAL) { - return; - } - Block clicked = event.getClickedBlock(); - if (clicked != null) { - if (event.getAction() == Action.RIGHT_CLICK_BLOCK) { - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - if (clicked.getType() == Material.JIGSAW) { - startJigsawTileWatch(event.getPlayer(), clicked); - } - } - markDirty(clicked); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onInventoryClick(InventoryClickEvent event) { - markDirty(event.getView().getTopInventory()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onInventoryDrag(InventoryDragEvent event) { - markDirty(event.getView().getTopInventory()); - } - - @EventHandler(priority = EventPriority.MONITOR) - public void onInventoryClose(InventoryCloseEvent event) { - markDirty(event.getView().getTopInventory()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onInventoryMove(InventoryMoveItemEvent event) { - markDirty(event.getSource()); - markDirty(event.getDestination()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onInventoryPickup(InventoryPickupItemEvent event) { - markDirty(event.getInventory()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockCook(BlockCookEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onFurnaceBurn(FurnaceBurnEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR) - public void onFurnaceStartSmelt(FurnaceStartSmeltEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBrew(BrewEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR) - public void onBrewingStart(BrewingStartEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBrewingStandFuel(BrewingStandFuelEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockDispense(BlockDispenseEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onCrafterCraft(CrafterCraftEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockExplode(BlockExplodeEvent event) { - markDirty(event.blockList()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onEntityExplode(EntityExplodeEvent event) { - markDirty(event.blockList()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onEntityChangeBlock(EntityChangeBlockEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockFromTo(BlockFromToEvent event) { - markDirty(event.getToBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockForm(BlockFormEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockGrow(BlockGrowEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockSpread(BlockSpreadEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockFade(BlockFadeEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockBurn(BlockBurnEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onBlockRedstone(BlockRedstoneEvent event) { - markDirty(event.getBlock()); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPistonExtend(BlockPistonExtendEvent event) { - markDirty(event.getBlock()); - markDirty(event.getBlock().getRelative(event.getDirection())); - for (Block block : event.getBlocks()) { - markDirty(block); - markDirty(block.getRelative(event.getDirection())); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPistonRetract(BlockPistonRetractEvent event) { - markDirty(event.getBlock()); - markDirty(event.getBlock().getRelative(event.getDirection())); - for (Block block : event.getBlocks()) { - markDirty(block); - markDirty(block.getRelative(event.getDirection())); - } - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onStructureGrow(StructureGrowEvent event) { - for (BlockState state : event.getBlocks()) { - markDirty(state.getBlock()); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onUnauthorizedPlayerCommand(PlayerCommandPreprocessEvent event) { - finalizeJigsawTileWatchesForPlayer(event.getPlayer().getUniqueId()); - ActiveStudio studio = studios.get(event.getPlayer().getWorld().getUID()); - if (studio != null - && materializationInProgress(studio) - && !isSafeNonOwnerCommand(event.getMessage())) { - event.setCancelled(true); - message(event.getPlayer(), "Wait for the current Jigsaw Studio variant load or rollback to finish."); - return; - } - if (studio != null && blocksNonEditableWorkcellMutation( - hasNonEditableWorkcell(studio), event.getMessage())) { - event.setCancelled(true); - message(event.getPlayer(), "Mutating commands are disabled while this Studio has an empty or read-only workcell."); - return; - } - UUID ownerId = studio == null ? null : studio.generator().getRequest().ownerId(); - if (!blocksMutatingCommand(ownerId, event.getPlayer().getUniqueId(), event.getMessage())) { - return; - } - event.setCancelled(true); - message(event.getPlayer(), "This Jigsaw Studio is owned by another player session."); - } - - @EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true) - public void onPlayerCommand(PlayerCommandPreprocessEvent event) { - if (isMutatingCommand(event.getMessage())) { - markAllDirty(event.getPlayer().getWorld()); - } - } - - @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) - public void onServerCommand(ServerCommandEvent event) { - if (!isSafeNonOwnerCommand(event.getCommand()) && anyMaterializationInProgress()) { - event.setCancelled(true); - return; - } - if (isMutatingCommand(event.getCommand()) && anyNonEditableWorkcell()) { - event.setCancelled(true); - return; - } - if (isMutatingCommand(event.getCommand())) { - markAllDirty(); - } - } - - public boolean markDirty(World world, int worldX, int worldY, int worldZ) { - if (world == null) { - return false; - } - ActiveStudio studio = studios.get(world.getUID()); - if (studio == null) { - return false; - } - if (reopenRequiredRequests.contains(studio.generator().getRequest().requestId())) { - return false; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay bay = session.layout().findAt(worldX, worldY, worldZ); - if (bay == null) { - return false; - } - JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); - if (activeVariant == null || !activeVariant.owned()) { - return false; - } - JigsawStudioSession.DirtyMark dirtyMark = session.markWorkcellDirty(bay.stableId()); - if (dirtyMark.status() != JigsawStudioSession.DirtyStatus.MARKED) { - return false; - } - scheduleAutosave(studio, bay, dirtyMark.identity().orElseThrow(), AUTOSAVE_DEBOUNCE_TICKS); - markEvaluationStale(studio); - if (dirtyMark.newlyDirty()) { - refreshWorkcellContext(studio.worldId(), bay.stableId()); - } - return true; - } - - public int markAllDirty(World world) { - if (world == null) { - return 0; - } - ActiveStudio studio = studios.get(world.getUID()); - return studio == null ? 0 : markAllDirty(studio); - } - - private boolean scheduleCapture( - ActiveStudio studio, - World world, - JigsawStudioBay bay, - CaptureTarget captureTarget, - Player player, - UUID requestId, - JigsawStudioSession.SaveIdentity saveIdentity, - AutosaveFailureState autosaveFailureState - ) { - List areas = chunkIntersections(captureTarget.bounds()); - CaptureWork work = new CaptureWork( - studio, - world, - bay, - captureTarget, - player, - requestId, - saveIdentity, - autosaveFailureState); - CaptureCoordinator coordinator = new CaptureCoordinator( - work, - areas); - for (ChunkCaptureArea area : areas) { - if (coordinator.stopped()) { - return false; - } - boolean scheduled = J.runRegion( - world, - area.chunkX(), - area.chunkZ(), - () -> captureChunk(coordinator, area)); - if (!scheduled) { - coordinator.fail("Iris could not schedule bay chunk " - + area.chunkX() + "," + area.chunkZ() + " on its owning region.", null); - return false; - } - } - return !coordinator.stopped(); - } - - private boolean scheduleMaterialization(MaterializationWork work) { - String validationFailure = validateMaterialization(work.target()); - if (!validationFailure.isEmpty()) { - work.studio().generator().getSession().abortVariantSwitch(work.token()); - refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); - message(work.player(), "Variant '" + work.token().targetVariant().pieceKey() - + "' cannot load: " + validationFailure); - return false; - } - String reservationFailure = beginMaterialization(work); - if (!reservationFailure.isEmpty()) { - work.studio().generator().getSession().abortVariantSwitch(work.token()); - refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); - message(work.player(), reservationFailure); - return false; - } - List areas = chunkIntersections(work.workcell().bounds()); - MaterializationCoordinator coordinator = new MaterializationCoordinator(work, areas); - for (ChunkCaptureArea area : areas) { - boolean scheduled = J.runRegion( - work.world(), - area.chunkX(), - area.chunkZ(), - () -> materializeCandidateChunk(coordinator, area)); - if (!scheduled) { - coordinator.candidateComplete( - area, - "Iris could not schedule workcell chunk " - + area.chunkX() + "," + area.chunkZ() + " on its owning region.", - null); - } else { - coordinator.markScheduled(); - } - } - return coordinator.scheduledAny(); - } - - private String beginMaterialization(MaterializationWork work) { - UUID requestId = work.studio().generator().getRequest().requestId(); - synchronized (saveLifecycleLock) { - if (!isCurrentVariantSwitch(work)) { - return "The Jigsaw Studio changed before the variant load could start."; - } - if (closingRequests.contains(requestId)) { - return "This Jigsaw Studio is closing and cannot load another variant."; - } - if (savesInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio save to finish."; - } - if (graphMutationsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio graph update to finish."; - } - if (exportsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio export to finish."; - } - if (hasJigsawTileWatch(requestId)) { - return "Finish or close the open vanilla jigsaw-block editor before loading another variant."; - } - if (!materializationsInProgress.add(requestId)) { - return "Another Jigsaw Studio variant load or rollback is already running."; - } - return ""; - } - } - - private String beginConnectorRepair(ActiveStudio studio) { - UUID requestId = studio.generator().getRequest().requestId(); - finalizeJigsawTileWatches(requestId); - synchronized (saveLifecycleLock) { - if (!isCurrentRequest(studio, requestId)) { - return "This Jigsaw Studio session is no longer active."; - } - if (closingRequests.contains(requestId)) { - return "This Jigsaw Studio is closing and cannot reset connector blocks."; - } - if (savesInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio save to finish."; - } - if (graphMutationsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio graph update to finish."; - } - if (exportsInProgress.contains(requestId)) { - return "Wait for the current Jigsaw Studio export to finish."; - } - if (studio.generator().getSession().operationInProgress()) { - return "Wait for the current workcell operation to finish."; - } - if (hasJigsawTileWatch(requestId)) { - return "Finish or close the open vanilla jigsaw-block editor before resetting connectors."; - } - if (!materializationsInProgress.add(requestId)) { - return "Another Jigsaw Studio variant load or repair is already running."; - } - return ""; - } - } - - private boolean scheduleConnectorRepair( - Player player, - ActiveStudio studio, - JigsawStudioBay workcell, - JigsawStudioGenerator.RenderedBay rendered, - boolean connectorsVisible - ) { - Map> connectorsByChunk = new HashMap<>(); - JigsawStudioBounds bounds = workcell.bounds(); - for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { - int worldX = bounds.originX() + connector.x(); - int worldZ = bounds.originZ() + connector.z(); - connectorsByChunk.computeIfAbsent( - chunkKey(worldX >> 4, worldZ >> 4), - ignored -> new ArrayList<>()).add(connector); - } - AtomicInteger remaining = new AtomicInteger(connectorsByChunk.size()); - AtomicReference failure = new AtomicReference<>(""); - AtomicReference cause = new AtomicReference<>(); - AtomicBoolean scheduledAny = new AtomicBoolean(false); - Map renderedBlocks = new HashMap<>(); - for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { - renderedBlocks.put(new LocalPosition(block.x(), block.y(), block.z()), block); - } - for (Map.Entry> entry - : connectorsByChunk.entrySet()) { - int chunkX = (int) (entry.getKey() >> 32); - int chunkZ = (int) entry.getKey().longValue(); - boolean scheduled = J.runRegion(studio.world(), chunkX, chunkZ, () -> { - try { - if (!studio.world().isChunkLoaded(chunkX, chunkZ)) { - throw new IOException("connector chunk " + chunkX + "," + chunkZ - + " is not loaded"); - } - restoreConnectorChunk( - studio.world(), - workcell, - entry.getValue(), - renderedBlocks, - connectorsVisible); - } catch (Throwable exception) { - failure.compareAndSet("", failureMessage(exception)); - cause.compareAndSet(null, exception); - } - if (remaining.decrementAndGet() == 0) { - completeConnectorRepair( - player, - studio, - rendered.connectors().size(), - failure.get(), - cause.get()); - } - }); - if (scheduled) { - scheduledAny.set(true); - } else { - failure.compareAndSet("", "connector chunk " + chunkX + "," + chunkZ - + " could not be scheduled on its owning region"); - if (remaining.decrementAndGet() == 0) { - completeConnectorRepair( - player, - studio, - rendered.connectors().size(), - failure.get(), - cause.get()); - } - } - } - if (!scheduledAny.get()) { - finishMaterialization(studio.generator().getRequest().requestId()); - } - return scheduledAny.get(); - } - - private void completeConnectorRepair( - Player player, - ActiveStudio studio, - int connectorCount, - String failure, - Throwable cause - ) { - UUID requestId = studio.generator().getRequest().requestId(); - boolean scheduled = J.runEntity(player, () -> { - finishMaterialization(requestId); - if (cause != null) { - IrisLogging.reportError(cause); - } - if (!failure.isEmpty()) { - message(player, "Connector reset was incomplete: " + failure + ". Retry after visiting the workcell."); - return; - } - message(player, "Restored " + connectorCount - + " connector block(s) from the last saved iteration."); - }); - if (!scheduled) { - finishMaterialization(requestId); - if (cause != null) { - IrisLogging.reportError(cause); - } - } - } - - static void restoreConnectorChunk( - World world, - JigsawStudioBay workcell, - List connectors, - Map renderedBlocks, - boolean connectorsVisible - ) throws IOException { - JigsawStudioBounds bounds = workcell.bounds(); - for (JigsawStudioGenerator.RenderedConnector connector : connectors) { - LocalPosition position = new LocalPosition(connector.x(), connector.y(), connector.z()); - Block target = world.getBlockAt( - bounds.originX() + connector.x(), - bounds.originY() + connector.y(), - bounds.originZ() + connector.z()); - if (connectorsVisible) { - BlockData marker; - try { - marker = Bukkit.createBlockData( - "minecraft:jigsaw[orientation=" + connector.orientation() + "]"); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid saved connector orientation '" - + connector.orientation() + "'", exception); - } - target.setBlockData(marker, false); - BukkitPlatform.deserializeTile(markerNbt(connector.connector()), target.getLocation()); - continue; - } - JigsawStudioGenerator.RenderedBlock renderedBlock = renderedBlocks.get(position); - BlockData restored; - if (renderedBlock != null) { - if (renderedBlock.state().isCustom() - || !(renderedBlock.state().nativeHandle() instanceof BlockData blockData)) { - throw new IOException("Saved connector block '" + renderedBlock.state().key() - + "' cannot be restored directly in Bukkit Studio"); - } - restored = blockData; - } else { - try { - restored = Bukkit.createBlockData(connector.connector().getFinalState()); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid saved connector final state '" - + connector.connector().getFinalState() + "'", exception); - } - } - target.setBlockData(restored, false); - if (renderedBlock != null && renderedBlock.tileData() != null) { - TileData tileData = renderedBlock.tileData(); - if (!tileData.isApplicable(target.getBlockData()) || !tileData.toBukkitTry(target)) { - throw new IOException("Saved connector tile data could not be restored at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - } - } - } - - private void finishMaterialization(UUID requestId) { - synchronized (saveLifecycleLock) { - materializationsInProgress.remove(requestId); - } - } - - private void materializeCandidateChunk( - MaterializationCoordinator coordinator, - ChunkCaptureArea area - ) { - MaterializationWork work = coordinator.work(); - if (!isCurrentVariantSwitch(work)) { - coordinator.candidateComplete( - area, - "Jigsaw Studio changed before the variant could finish loading.", - null); - return; - } - if (!work.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { - coordinator.candidateComplete( - area, - "Workcell chunk " + area.chunkX() + "," + area.chunkZ() - + " is not loaded. Visit the whole workcell and try again.", - null); - return; - } - try { - coordinator.markCandidateTouched(area); - writeMaterializedChunk( - work.world(), - work.workcell(), - work.target(), - area, - work.targetConnectorsVisible()); - coordinator.candidateComplete(area, "", null); - } catch (Throwable exception) { - coordinator.candidateComplete( - area, - "Variant materialization failed in chunk " - + area.chunkX() + "," + area.chunkZ() + ": " + failureMessage(exception), - exception); - } - } - - private void materializeRollbackChunk( - MaterializationCoordinator coordinator, - ChunkCaptureArea area - ) { - MaterializationWork work = coordinator.work(); - if (!isRollbackVariantSwitch(work)) { - coordinator.rollbackComplete( - area, - "Jigsaw Studio changed before the previous variant could be restored.", - null); - return; - } - if (!work.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { - coordinator.rollbackComplete( - area, - "Rollback chunk " + area.chunkX() + "," + area.chunkZ() + " is not loaded.", - null); - return; - } - try { - writeMaterializedChunk( - work.world(), - work.workcell(), - work.previous(), - area, - work.previousConnectorsVisible()); - coordinator.rollbackComplete(area, "", null); - } catch (Throwable exception) { - coordinator.rollbackComplete( - area, - "Rollback failed in chunk " + area.chunkX() + "," + area.chunkZ() - + ": " + failureMessage(exception), - exception); - } - } - - static String validateMaterialization(JigsawStudioGenerator.RenderedBay rendered) { - if (!rendered.valid()) { - return rendered.failure(); - } - for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { - PlatformBlockState state = block.state(); - if (state.isCustom()) { - return "custom block '" + state.key() - + "' requires provider-owned placement and cannot be swapped live in Studio"; - } - if (!(state.nativeHandle() instanceof BlockData)) { - return "block '" + state.key() + "' has no Bukkit block-data representation"; - } - } - for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { - try { - BlockData data = Bukkit.createBlockData( - "minecraft:jigsaw[orientation=" + connector.orientation() + "]"); - if (!(data instanceof Jigsaw)) { - return "connector orientation '" + connector.orientation() - + "' did not resolve to a jigsaw marker"; - } - } catch (IllegalArgumentException exception) { - return "connector orientation '" + connector.orientation() + "' is invalid"; - } - } - return ""; - } - - private static void writeMaterializedChunk( - World world, - JigsawStudioBay workcell, - JigsawStudioGenerator.RenderedBay rendered, - ChunkCaptureArea area, - boolean connectorsVisible - ) throws IOException { - JigsawStudioBounds bounds = workcell.bounds(); - Map expected = materializedBlockData(rendered, connectorsVisible); - BlockData air = Material.AIR.createBlockData(); - for (int x = area.minimumX(); x < area.maximumX(); x++) { - for (int y = 0; y < bounds.dimensions().height(); y++) { - for (int z = area.minimumZ(); z < area.maximumZ(); z++) { - Block target = world.getBlockAt( - bounds.originX() + x, - bounds.originY() + y, - bounds.originZ() + z); - BlockData blockData = expected.getOrDefault(new LocalPosition(x, y, z), air); - target.setBlockData(blockData, false); - } - } - } - applyRenderedBayChunk(world, workcell, rendered, area.chunkX(), area.chunkZ(), connectorsVisible); - verifyMaterializedChunk(world, workcell, rendered, area, expected, connectorsVisible); - } - - private static Map materializedBlockData( - JigsawStudioGenerator.RenderedBay rendered, - boolean connectorsVisible - ) throws IOException { - Map expected = new HashMap<>(); - for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { - if (block.state().isCustom() || !(block.state().nativeHandle() instanceof BlockData blockData)) { - throw new IOException("Rendered block '" + block.state().key() - + "' cannot be placed directly in Bukkit Studio"); - } - expected.put(new LocalPosition(block.x(), block.y(), block.z()), blockData); - } - for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { - if (!connectorsVisible && expected.containsKey( - new LocalPosition(connector.x(), connector.y(), connector.z()))) { - continue; - } - BlockData marker; - try { - marker = Bukkit.createBlockData(connectorsVisible - ? "minecraft:jigsaw[orientation=" + connector.orientation() + "]" - : connector.connector().getFinalState()); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid rendered connector orientation '" - + connector.orientation() + "'", exception); - } - expected.put(new LocalPosition(connector.x(), connector.y(), connector.z()), marker); - } - return expected; - } - - private static void verifyMaterializedChunk( - World world, - JigsawStudioBay workcell, - JigsawStudioGenerator.RenderedBay rendered, - ChunkCaptureArea area, - Map expected, - boolean connectorsVisible - ) throws IOException { - JigsawStudioBounds bounds = workcell.bounds(); - BlockData air = Material.AIR.createBlockData(); - for (int x = area.minimumX(); x < area.maximumX(); x++) { - for (int y = 0; y < bounds.dimensions().height(); y++) { - for (int z = area.minimumZ(); z < area.maximumZ(); z++) { - Block target = world.getBlockAt( - bounds.originX() + x, - bounds.originY() + y, - bounds.originZ() + z); - BlockData expectedData = expected.getOrDefault(new LocalPosition(x, y, z), air); - if (!target.getBlockData().equals(expectedData)) { - throw new IOException("Workcell block did not materialize at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - } - } - } - verifyRenderedBayChunk(world, workcell, rendered, area.chunkX(), area.chunkZ(), connectorsVisible); - } - - private boolean isCurrentVariantSwitch(MaterializationWork work) { - return isCurrentRequest( - work.studio(), - work.studio().generator().getRequest().requestId()) - && work.studio().generator().getSession().isVariantSwitchCurrent(work.token()); - } - - private boolean isRollbackVariantSwitch(MaterializationWork work) { - return studios.get(work.studio().worldId()) == work.studio() - && materializationInProgress(work.studio()); - } - - private void markDirty(Block block) { - if (block != null) { - markDirty(block.getWorld(), block.getX(), block.getY(), block.getZ()); - } - } - - private void markDirty(List blocks) { - for (Block block : blocks) { - markDirty(block); - } - } - - private void markDirty(Inventory inventory) { - for (Block block : inventoryBlocks(inventory)) { - markDirty(block); - } - } - - private boolean blocksInventoryMutation(Inventory inventory, UUID actorId) { - for (Block block : inventoryBlocks(inventory)) { - StudioBlockMutationContext context = studioBlockMutationContext(block); - if (context != null && blocksStudioInventoryMutation( - true, - context.immutable(), - materializationInProgress(context.studio()), - reopenRequiredRequests.contains(context.requestId()), - context.ownerId(), - actorId)) { - return true; - } - } - return false; - } - - private boolean blocksMachineMutation(Block block) { - StudioBlockMutationContext context = studioBlockMutationContext(block); - return context != null && blocksStudioInventoryMutation( - true, - context.immutable(), - materializationInProgress(context.studio()), - reopenRequiredRequests.contains(context.requestId()), - context.ownerId(), - null); - } - - private StudioBlockMutationContext studioBlockMutationContext(Block block) { - if (block == null) { - return null; - } - ActiveStudio studio = studios.get(block.getWorld().getUID()); - if (studio == null) { - return null; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - boolean preview = previewRenderer.contains( - request.requestId(), block.getX(), block.getY(), block.getZ()); - JigsawStudioControlPosition control = studio.generator().getLayout().controlPosition(); - boolean controlChest = block.getType() == Material.CHEST - && block.getX() == control.worldX() - && block.getY() == control.worldY() - && block.getZ() == control.worldZ(); - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay bay = session.layout().findAt( - block.getX(), block.getY(), block.getZ()); - boolean workcell = bay != null; - if (!preview && !controlChest && !workcell) { - return null; - } - JigsawStudioVariant variant = bay == null - ? null - : session.activeVariant(bay.stableId()).orElse(null); - boolean nonEditableWorkcell = bay != null && (variant == null || !variant.owned()); - return new StudioBlockMutationContext( - studio, - request.requestId(), - request.ownerId(), - preview || controlChest || nonEditableWorkcell); - } - - private static List inventoryBlocks(Inventory inventory) { - if (inventory == null) { - return List.of(); - } - List blocks = new ArrayList<>(2); - InventoryHolder holder = inventory.getHolder(); - if (holder instanceof BlockInventoryHolder blockInventoryHolder) { - blocks.add(blockInventoryHolder.getBlock()); - } else if (holder instanceof DoubleChest doubleChest) { - addInventoryBlock(blocks, doubleChest.getLeftSide()); - addInventoryBlock(blocks, doubleChest.getRightSide()); - } - return blocks; - } - - private static void addInventoryBlock(List blocks, InventoryHolder holder) { - if (holder instanceof BlockInventoryHolder blockInventoryHolder - && !blocks.contains(blockInventoryHolder.getBlock())) { - blocks.add(blockInventoryHolder.getBlock()); - } - } - - private void startJigsawTileWatch(Player player, Block block) { - if (player == null || block == null || block.getType() != Material.JIGSAW) { - return; - } - World world = block.getWorld(); - int worldX = block.getX(); - int worldY = block.getY(); - int worldZ = block.getZ(); - UUID playerId = player.getUniqueId(); - if (J.isOwnedByCurrentRegion(world, worldX >> 4, worldZ >> 4)) { - initializeJigsawTileWatch(playerId, world, worldX, worldY, worldZ); - return; - } - boolean scheduled = J.runRegion( - world, - worldX >> 4, - worldZ >> 4, - () -> initializeJigsawTileWatch(playerId, world, worldX, worldY, worldZ)); - if (!scheduled) { - IrisLogging.warn("Jigsaw Studio could not watch jigsaw marker NBT at %d,%d,%d in %s", - worldX, worldY, worldZ, world.getName()); - } - } - - private void initializeJigsawTileWatch( - UUID playerId, - World world, - int worldX, - int worldY, - int worldZ - ) { - ActiveStudio studio = studios.get(world.getUID()); - if (!enabled || studio == null) { - return; - } - Block block = world.getBlockAt(worldX, worldY, worldZ); - if (block.getType() != Material.JIGSAW) { - return; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay bay = session.layout().findAt(worldX, worldY, worldZ); - JigsawStudioVariant variant = bay == null - ? null - : session.activeVariant(bay.stableId()).orElse(null); - if (bay == null || variant == null || !variant.owned()) { - return; - } - KMap snapshot; - try { - snapshot = BukkitPlatform.serializeTile(block.getLocation()); - } catch (Throwable exception) { - IrisLogging.reportError(exception); - return; - } - if (snapshot == null) { - IrisLogging.warn("Jigsaw Studio could not read jigsaw marker NBT at %d,%d,%d in %s", - worldX, worldY, worldZ, world.getName()); - return; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - JigsawTileWatchKey key = new JigsawTileWatchKey( - request.requestId(), world.getUID(), worldX, worldY, worldZ); - JigsawTileWatch watch = new JigsawTileWatch( - key, - studio, - playerId, - bay.stableId(), - snapshot, - new AtomicBoolean(false), - new AtomicBoolean(false)); - jigsawTileWatches.put(key, watch); - scheduleJigsawTileWatch(watch); - } - - private void scheduleJigsawTileWatch(JigsawTileWatch watch) { - boolean scheduled = J.runRegion( - watch.studio().world(), - watch.key().worldX() >> 4, - watch.key().worldZ() >> 4, - () -> runJigsawTileWatch(watch, false), - JIGSAW_TILE_WATCH_INTERVAL_TICKS); - if (!scheduled && jigsawTileWatches.get(watch.key()) == watch) { - warnJigsawTileWatchScheduleFailure(watch); - scheduleJigsawTileWatchReconciliation(watch, false); - } - } - - private void runJigsawTileWatch(JigsawTileWatch watch, boolean release) { - if (jigsawTileWatches.get(watch.key()) != watch) { - return; - } - ActiveStudio studio = studios.get(watch.key().worldId()); - if (!enabled || studio != watch.studio() - || !isCurrentRequest(studio, watch.key().requestId())) { - jigsawTileWatches.remove(watch.key(), watch); - return; - } - Block block = studio.world().getBlockAt( - watch.key().worldX(), watch.key().worldY(), watch.key().worldZ()); - JigsawStudioBay bay = studio.generator().getSession().layout().findAt( - watch.key().worldX(), watch.key().worldY(), watch.key().worldZ()); - if (block.getType() != Material.JIGSAW - || bay == null - || !bay.stableId().equals(watch.workcellId())) { - jigsawTileWatches.remove(watch.key(), watch); - return; - } - KMap snapshot; - try { - snapshot = BukkitPlatform.serializeTile(block.getLocation()); - } catch (Throwable exception) { - jigsawTileWatches.remove(watch.key(), watch); - IrisLogging.reportError(exception); - return; - } - if (snapshot == null) { - jigsawTileWatches.remove(watch.key(), watch); - IrisLogging.warn("Jigsaw Studio stopped watching unreadable jigsaw marker NBT at %d,%d,%d in %s", - watch.key().worldX(), - watch.key().worldY(), - watch.key().worldZ(), - studio.world().getName()); - return; - } - JigsawTilePollDecision decision = jigsawTilePollDecision( - watch.snapshot(), snapshot, release); - if (decision.changed()) { - markDirty( - studio.world(), - watch.key().worldX(), - watch.key().worldY(), - watch.key().worldZ()); - } - if (!decision.continueWatching()) { - jigsawTileWatches.remove(watch.key(), watch); - return; - } - JigsawTileWatch next = new JigsawTileWatch( - watch.key(), - watch.studio(), - watch.playerId(), - watch.workcellId(), - snapshot, - watch.scheduleFailureLogged(), - new AtomicBoolean(false)); - if (jigsawTileWatches.replace(watch.key(), watch, next)) { - scheduleJigsawTileWatch(next); - } - } - - private boolean hasJigsawTileWatch(UUID requestId) { - if (requestId == null) { - return false; - } - for (JigsawTileWatchKey key : jigsawTileWatches.keySet()) { - if (requestId.equals(key.requestId())) { - return true; - } - } - return false; - } - - private void clearJigsawTileWatches(UUID requestId) { - if (requestId != null) { - jigsawTileWatches.keySet().removeIf(key -> requestId.equals(key.requestId())); - } - } - - private void finalizeJigsawTileWatchesForPlayer(UUID playerId) { - if (playerId == null) { - return; - } - for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { - if (playerId.equals(watch.playerId())) { - finalizeJigsawTileWatch(watch); - } - } - } - - private void finalizeJigsawTileWatches(UUID requestId) { - if (requestId == null) { - return; - } - for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { - if (requestId.equals(watch.key().requestId())) { - finalizeJigsawTileWatch(watch); - } - } - } - - private void finalizeAllJigsawTileWatches() { - for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { - try { - finalizeJigsawTileWatch(watch); - } catch (Throwable exception) { - IrisLogging.reportError("Failed to finalize a Jigsaw Studio tile watch during shutdown.", exception); - } - } - } - - private void finalizeJigsawTileWatch(JigsawTileWatch watch) { - if (jigsawTileWatches.get(watch.key()) != watch) { - return; - } - World world = watch.studio().world(); - int chunkX = watch.key().worldX() >> 4; - int chunkZ = watch.key().worldZ() >> 4; - if (J.isOwnedByCurrentRegion(world, chunkX, chunkZ)) { - runJigsawTileWatch(watch, true); - return; - } - boolean scheduled = J.runRegion( - world, - chunkX, - chunkZ, - () -> runJigsawTileWatch(watch, true)); - if (!scheduled) { - warnJigsawTileWatchScheduleFailure(watch); - scheduleJigsawTileWatchReconciliation(watch, true); - } - } - - private void warnJigsawTileWatchScheduleFailure(JigsawTileWatch watch) { - if (watch.scheduleFailureLogged().compareAndSet(false, true)) { - IrisLogging.warn("Jigsaw Studio could not schedule jigsaw marker NBT at %d,%d,%d in %s; Iris will keep retrying", - watch.key().worldX(), - watch.key().worldY(), - watch.key().worldZ(), - watch.studio().world().getName()); - } - } - - private void scheduleJigsawTileWatchReconciliation(JigsawTileWatch watch, boolean release) { - if (!watch.reconciliationScheduled().compareAndSet(false, true)) { - return; - } - try { - J.s(() -> { - watch.reconciliationScheduled().set(false); - if (jigsawTileWatches.get(watch.key()) != watch) { - return; - } - if (release) { - finalizeJigsawTileWatch(watch); - } else { - scheduleJigsawTileWatch(watch); - } - }, AUTOSAVE_RETRY_TICKS); - } catch (Throwable exception) { - watch.reconciliationScheduled().set(false); - IrisLogging.reportError(exception); - } - } - - static boolean tileSnapshotChanged( - KMap previous, - KMap current - ) { - return !Objects.equals(previous, current); - } - - static JigsawTilePollDecision jigsawTilePollDecision( - KMap previous, - KMap current, - boolean release - ) { - return new JigsawTilePollDecision(tileSnapshotChanged(previous, current), !release); - } - - private void markAllDirty() { - for (ActiveStudio studio : studios.values()) { - markAllDirty(studio); - } - } - - private int markAllDirty(ActiveStudio studio) { - int changed = 0; - JigsawStudioSession session = studio.generator().getSession(); - for (JigsawStudioBay bay : session.layout().bays()) { - JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); - if (activeVariant == null || !activeVariant.owned()) { - continue; - } - JigsawStudioSession.DirtyMark dirtyMark = session.markWorkcellDirty(bay.stableId()); - if (dirtyMark.status() == JigsawStudioSession.DirtyStatus.MARKED) { - scheduleAutosave( - studio, - bay, - dirtyMark.identity().orElseThrow(), - AUTOSAVE_DEBOUNCE_TICKS); - changed++; - } - } - if (changed > 0) { - markEvaluationStale(studio); - for (JigsawStudioBay bay : session.layout().bays()) { - refreshWorkcellContext(studio.worldId(), bay.stableId()); - } - } - return changed; - } - - private void scheduleAutosave( - ActiveStudio studio, - JigsawStudioBay bay, - JigsawStudioSession.DirtyIdentity identity, - int delayTicks - ) { - UUID requestId = studio.generator().getRequest().requestId(); - AutosaveKey key = new AutosaveKey(requestId, bay.stableId()); - AutosaveTicket ticket = new AutosaveTicket( - key, - studio, - identity, - new AtomicBoolean(false), - new AtomicBoolean(false)); - autosaves.put(key, ticket); - scheduleAutosave(ticket, delayTicks); - } - - private void scheduleAutosave(AutosaveTicket ticket, int delayTicks) { - if (autosaves.get(ticket.key()) != ticket - || !ticket.scheduled().compareAndSet(false, true)) { - return; - } - JigsawStudioBay bay = resolveAutosaveBay(ticket); - if (bay == null) { - ticket.scheduled().set(false); - return; - } - JigsawStudioBounds bounds = bay.bounds(); - boolean scheduled = J.runRegion( - ticket.studio().world(), - bounds.originX() >> 4, - bounds.originZ() >> 4, - () -> runAutosave(ticket), - delayTicks); - if (!scheduled) { - ticket.scheduled().set(false); - if (ticket.scheduleFailureLogged().compareAndSet(false, true)) { - IrisLogging.warn("Jigsaw Studio autosave could not schedule workcell %s for request %s; Iris will keep retrying", - ticket.key().workcellId(), ticket.key().requestId()); - } - scheduleAutosaveReconciliation(ticket); - } - } - - private JigsawStudioBay resolveAutosaveBay(AutosaveTicket ticket) { - if (autosaves.get(ticket.key()) != ticket) { - return null; - } - JigsawStudioBay bay = resolveCurrentAutosaveBay( - ticket.studio().generator().getSession(), - ticket.key().workcellId()); - if (bay != null) { - return bay; - } - if (autosaves.remove(ticket.key(), ticket)) { - reportAutosaveFailure( - ticket, - new AutosavePersistentFailure( - "workcell is absent from the current Studio layout; pending ticket retired", - null)); - } - return null; - } - - static JigsawStudioBay resolveCurrentAutosaveBay( - JigsawStudioSession session, - String workcellId - ) { - JigsawStudioSession activeSession = Objects.requireNonNull( - session, - "Jigsaw Studio autosave session"); - return activeSession.layout().get(Objects.requireNonNull( - workcellId, - "Jigsaw Studio autosave workcell ID")); - } - - private boolean retainCurrentAutosaveFailure( - ActiveStudio studio, - String workcellId, - AutosavePersistentFailure failure - ) { - AutosaveKey key = new AutosaveKey( - studio.generator().getRequest().requestId(), - workcellId); - AutosaveTicket ticket = autosaves.get(key); - return ticket != null && retainPersistentAutosaveFailure(ticket, failure); - } - - private AutosaveFailureState autosaveFailureState( - ActiveStudio studio, - JigsawStudioSession.SaveIdentity saveIdentity - ) { - AutosaveKey key = new AutosaveKey( - studio.generator().getRequest().requestId(), - saveIdentity.workcellId()); - AutosaveTicket ticket = autosaves.get(key); - return ticket != null && matchesSaveIdentity(ticket.identity(), saveIdentity) - ? ticket.failureState() - : new AutosaveFailureState(); - } - - private boolean retainPersistentAutosaveFailure( - AutosaveTicket ticket, - AutosavePersistentFailure failure - ) { - if (autosaves.get(ticket.key()) != ticket - || !isCurrentRequest(ticket.studio(), ticket.key().requestId()) - || !ticket.studio().generator().getSession().isDirtyCurrent(ticket.identity())) { - return false; - } - AutosaveFailureDecision decision = reportAutosaveFailure(ticket, failure); - expediteAutosave(ticket, decision.retryTicks()); - return true; - } - - private static AutosaveFailureDecision reportAutosaveFailure( - AutosaveTicket ticket, - AutosavePersistentFailure failure - ) { - JigsawStudioActivation.Request request = ticket.studio().generator().getRequest(); - return recordPersistentAutosaveFailure( - ticket.failureState(), - ticket.key().requestId(), - request.structureKey(), - ticket.key().workcellId(), - ticket.identity().variantKey(), - failure.detail(), - failure.cause()); - } - - private static void reportPersistentSaveFailure( - ActiveStudio studio, - JigsawStudioSession.SaveIdentity saveIdentity, - AutosaveFailureState failureState, - AutosavePersistentFailure failure - ) { - JigsawStudioActivation.Request request = studio.generator().getRequest(); - recordPersistentAutosaveFailure( - failureState, - request.requestId(), - request.structureKey(), - saveIdentity.workcellId(), - saveIdentity.variantKey(), - failure.detail(), - failure.cause()); - } - - static AutosaveFailureDecision recordPersistentAutosaveFailure( - AutosaveFailureState state, - UUID requestId, - String structureKey, - String workcellId, - String pieceKey, - String detail, - Throwable cause - ) { - AutosaveFailureState activeState = Objects.requireNonNull( - state, - "Jigsaw Studio autosave failure state"); - AutosaveFailureDecision decision = activeState.recordPersistentFailure(); - if (!decision.logFailure()) { - return decision; - } - String context = autosaveFailureContext( - requestId, - structureKey, - workcellId, - pieceKey, - detail); - if (cause == null) { - IrisLogging.warn("%s", context); - } else { - IrisLogging.reportError(context, cause); - } - return decision; - } - - static String autosaveFailureContext( - UUID requestId, - String structureKey, - String workcellId, - String pieceKey, - String detail - ) { - return "Jigsaw Studio save failure: request=" - + Objects.requireNonNull(requestId, "Jigsaw Studio autosave request ID") - + " structure=" - + Objects.requireNonNull(structureKey, "Jigsaw Studio autosave structure key") - + " workcell=" - + Objects.requireNonNull(workcellId, "Jigsaw Studio autosave workcell ID") - + " piece=" - + Objects.requireNonNull(pieceKey, "Jigsaw Studio autosave piece key") - + " failure=" - + Objects.requireNonNull(detail, "Jigsaw Studio autosave failure detail"); - } - - static int persistentAutosaveRetryTicks(int failureCount) { - int index = Math.max(0, Math.min( - failureCount - 1, - AUTOSAVE_PERSISTENT_RETRY_DELAYS.size() - 1)); - return AUTOSAVE_PERSISTENT_RETRY_DELAYS.get(index); - } - - private void scheduleAutosaveReconciliation(AutosaveTicket ticket) { - try { - J.s(() -> { - if (autosaves.get(ticket.key()) == ticket - && !ticket.scheduled().get()) { - scheduleAutosave(ticket, AUTOSAVE_RETRY_TICKS); - } - }, AUTOSAVE_RETRY_TICKS); - } catch (Throwable exception) { - IrisLogging.reportError(exception); - } - } - - private void runAutosave(AutosaveTicket ticket) { - if (autosaves.get(ticket.key()) != ticket) { - return; - } - ticket.scheduled().set(false); - ActiveStudio studio = ticket.studio(); - JigsawStudioSession session = studio.generator().getSession(); - if (!isCurrentRequest(studio, ticket.key().requestId())) { - autosaves.remove(ticket.key(), ticket); - return; - } - JigsawStudioBay bay = resolveAutosaveBay(ticket); - if (bay == null) { - return; - } - if (!session.isDirtyCurrent(ticket.identity())) { - autosaves.remove(ticket.key(), ticket); - return; - } - SaveAttempt attempt = startSave(studio, studio.world(), bay, null, false); - if (attempt == SaveAttempt.STARTED || attempt == SaveAttempt.PERSISTENT_FAILURE) { - return; - } - scheduleAutosave( - ticket, - attempt == SaveAttempt.RETRY - ? AUTOSAVE_RETRY_TICKS - : AUTOSAVE_DEBOUNCE_TICKS); - } - - private void completeAutosaveAttempt( - ActiveStudio studio, - JigsawStudioSession.SaveIdentity saveIdentity, - AutosaveFailureState failureState, - AutosavePersistentFailure persistentFailure - ) { - AutosaveKey key = new AutosaveKey( - studio.generator().getRequest().requestId(), - saveIdentity.workcellId()); - AutosaveTicket ticket = autosaves.get(key); - if (ticket == null || !matchesSaveIdentity(ticket.identity(), saveIdentity)) { - if (persistentFailure != null) { - reportPersistentSaveFailure(studio, saveIdentity, failureState, persistentFailure); - } - return; - } - if (resolveAutosaveBay(ticket) == null) { - return; - } - if (!studio.generator().getSession().isDirtyCurrent(ticket.identity())) { - autosaves.remove(key, ticket); - return; - } - if (persistentFailure != null) { - retainPersistentAutosaveFailure(ticket, persistentFailure); - return; - } - scheduleAutosave(ticket, AUTOSAVE_RETRY_TICKS); - } - - private static boolean matchesSaveIdentity( - JigsawStudioSession.DirtyIdentity dirtyIdentity, - JigsawStudioSession.SaveIdentity saveIdentity - ) { - return dirtyIdentity.sessionId().equals(saveIdentity.sessionId()) - && dirtyIdentity.workcellId().equals(saveIdentity.workcellId()) - && dirtyIdentity.variantKey().equals(saveIdentity.variantKey()) - && dirtyIdentity.loadGeneration() == saveIdentity.loadGeneration() - && dirtyIdentity.mutationGeneration() == saveIdentity.mutationGeneration(); - } - - private void drainAutosavesBeforeDisable() { - for (ActiveStudio studio : List.copyOf(studios.values())) { - try { - drainAutosavesBeforeRemoval(studio); - } catch (Throwable exception) { - IrisLogging.reportError( - "Failed to drain Jigsaw Studio autosaves in world " - + studio.worldId() + " during shutdown.", - exception); - } - } - if (!autosaves.isEmpty()) { - IrisLogging.warn("Jigsaw Studio disabled with %d autosave operation(s) still pending after the final drain attempt", - autosaves.size()); - } - } - - private void drainAutosavesBeforeRemoval(ActiveStudio studio) { - if (studio == null) { - return; - } - UUID requestId = studio.generator().getRequest().requestId(); - if (discardingRequest(requestId)) { - return; - } - if (J.isFolia() || !J.isPrimaryThread()) { - expediteAutosaves(requestId); - return; - } - for (AutosaveTicket ticket : List.copyOf(autosaves.values())) { - if (requestId.equals(ticket.key().requestId())) { - drainAutosaveSynchronously(ticket); - } - } - } - - private boolean drainAutosaveSynchronously(AutosaveTicket ticket) { - if (autosaves.get(ticket.key()) != ticket) { - return true; - } - ActiveStudio studio = ticket.studio(); - JigsawStudioSession session = studio.generator().getSession(); - if (!isCurrentRequest(studio, ticket.key().requestId())) { - autosaves.remove(ticket.key(), ticket); - return true; - } - JigsawStudioBay bay = resolveAutosaveBay(ticket); - if (bay == null) { - return false; - } - if (!session.isDirtyCurrent(ticket.identity())) { - autosaves.remove(ticket.key(), ticket); - return true; - } - JigsawStudioVariant activeVariant = session.activeVariant(bay.stableId()).orElse(null); - if (activeVariant == null || !activeVariant.owned()) { - return false; - } - BayReadiness readiness = studio.population(bay).readiness(); - if (!readiness.ready()) { - return false; - } - CaptureTarget captureTarget; - try { - captureTarget = resolveCaptureTarget(studio, bay, activeVariant); - } catch (IOException exception) { - retainPersistentAutosaveFailure( - ticket, - new AutosavePersistentFailure( - "Jigsaw Studio cannot capture this workcell: " + failureMessage(exception), - exception)); - return false; - } - JigsawStudioSession.SaveStart sessionSave = session.beginSave(bay.stableId()); - if (sessionSave.status() != JigsawStudioSession.SaveStatus.STARTED) { - return false; - } - JigsawStudioSession.SaveIdentity saveIdentity = sessionSave.identity().orElseThrow(); - if (tryBeginSave(ticket.key().requestId()) != SaveStart.STARTED) { - session.abortSave(saveIdentity); - return false; - } - List areas = chunkIntersections(captureTarget.bounds()); - CaptureWork work = new CaptureWork( - studio, - studio.world(), - bay, - captureTarget, - null, - ticket.key().requestId(), - saveIdentity, - ticket.failureState()); - CaptureCoordinator coordinator = new CaptureCoordinator(work, areas); - List snapshots = new ArrayList<>(areas.size()); - try { - for (ChunkCaptureArea area : areas) { - if (!studio.world().isChunkLoaded(area.chunkX(), area.chunkZ())) { - throw new IOException("Workcell chunk " + area.chunkX() + "," + area.chunkZ() - + " is not loaded during the final autosave drain"); - } - snapshots.add(captureChunkIntersection( - studio.world(), - captureTarget.bounds(), - captureTarget.piece(), - captureTarget.object(), - area, - captureTarget.displayRotationQuarterTurns(), - captureTarget.connectorsVisible())); - } - assembleAndPersist(coordinator, snapshots); - } catch (Throwable exception) { - coordinator.fail("Jigsaw Studio final autosave drain failed: " - + failureMessage(exception), exception); - } - return !session.isDirtyCurrent(ticket.identity()); - } - - private void expediteAutosaves(UUID requestId) { - if (requestId == null) { - return; - } - for (AutosaveTicket current : List.copyOf(autosaves.values())) { - if (!requestId.equals(current.key().requestId())) { - continue; - } - expediteAutosave(current, 0); - } - } - - private void expediteAutosave(AutosaveTicket current, int delayTicks) { - AutosaveTicket expedited = new AutosaveTicket( - current.key(), - current.studio(), - current.identity(), - new AtomicBoolean(false), - current.scheduleFailureLogged(), - current.failureState()); - if (autosaves.replace(current.key(), current, expedited)) { - scheduleAutosave(expedited, delayTicks); - } - } - - private boolean requiresLifecycleDrain(ActiveStudio studio) { - UUID requestId = studio.generator().getRequest().requestId(); - if (hasJigsawTileWatch(requestId) - || studio.generator().getSession().isDirty() - || studio.generator().getSession().operationInProgress()) { - return true; - } - for (AutosaveKey key : autosaves.keySet()) { - if (requestId.equals(key.requestId())) { - return true; - } - } - synchronized (saveLifecycleLock) { - return savesInProgress.contains(requestId) - || graphMutationsInProgress.contains(requestId) - || materializationsInProgress.contains(requestId) - || exportsInProgress.contains(requestId); - } - } - - private boolean discardingRequest(UUID requestId) { - synchronized (saveLifecycleLock) { - return discardingRequests.contains(requestId); - } - } - - private void clearAutosaves(UUID requestId) { - if (requestId != null) { - autosaves.keySet().removeIf(key -> key.requestId().equals(requestId)); - } - } - - private void markEvaluationStale(ActiveStudio studio) { - UUID requestId = studio.generator().getRequest().requestId(); - evaluations.computeIfPresent( + evaluator.evaluations.computeIfPresent( requestId, (ignored, current) -> current.state() == JigsawStudioEvaluationState.STALE ? current : current.stale("Autosave is pending for one or more edited workcells")); } - static boolean isMutatingCommand(String commandLine) { - return MUTATING_COMMANDS.contains(commandLabel(commandLine)); - } - - static boolean blocksMutatingCommand(UUID ownerId, UUID actorId, String commandLine) { - return !ownerMatches(ownerId, actorId) - && !isSafeNonOwnerCommand(commandLine); - } - - static boolean blocksNonEditableWorkcellMutation( - boolean hasNonEditableWorkcell, - String commandLine - ) { - return hasNonEditableWorkcell && isMutatingCommand(commandLine); - } - - static boolean canToggleVariantRotation( - JigsawStudioCompatibilityTarget compatibilityTarget, - JigsawStudioVariant variant - ) { - JigsawStudioCompatibilityTarget target = Objects.requireNonNull( - compatibilityTarget, - "Jigsaw Studio compatibility target"); - JigsawStudioVariant activeVariant = Objects.requireNonNull(variant, "Jigsaw Studio variant"); - return activeVariant.owned() - && (target != JigsawStudioCompatibilityTarget.VANILLA_PORTABLE - || !activeVariant.rotatable()); - } - - static boolean isSafeNonOwnerCommand(String commandLine) { - String normalized = normalizeCommandLine(commandLine); - String label = commandLabel(normalized); - if (SAFE_NON_OWNER_COMMANDS.contains(label)) { - return true; - } - int separator = normalized.indexOf(' '); - if (!label.equals("iris") || separator < 0) { - return false; - } - String arguments = normalized.substring(separator + 1).trim(); - return arguments.equals("jigsaw status") || arguments.startsWith("jigsaw status "); - } - - private static String commandLabel(String commandLine) { - String normalized = normalizeCommandLine(commandLine); - int separator = normalized.indexOf(' '); - String label = separator < 0 ? normalized : normalized.substring(0, separator); - int namespace = label.lastIndexOf(':'); - return namespace < 0 ? label : label.substring(namespace + 1); - } - - private static String normalizeCommandLine(String commandLine) { - if (commandLine == null) { - return ""; - } - String normalized = commandLine.trim().toLowerCase(Locale.ROOT); - while (normalized.startsWith("/")) { - normalized = normalized.substring(1); - } - return normalized; - } - - private void captureChunk(CaptureCoordinator coordinator, ChunkCaptureArea area) { - if (coordinator.stopped()) { - return; - } - ActiveStudio studio = coordinator.studio(); - World world = coordinator.world(); - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - coordinator.fail("Jigsaw Studio changed before every bay chunk could be captured; save cancelled.", null); - return; - } - if (!world.isChunkLoaded(area.chunkX(), area.chunkZ())) { - coordinator.fail("Bay chunk " + area.chunkX() + "," + area.chunkZ() - + " is not loaded. Visit the whole bay and try again.", null); - return; - } - try { - ChunkSnapshot snapshot = captureChunkIntersection( - world, - coordinator.captureTarget().bounds(), - coordinator.captureTarget().piece(), - coordinator.captureTarget().object(), - area, - coordinator.captureTarget().displayRotationQuarterTurns(), - coordinator.captureTarget().connectorsVisible()); - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - coordinator.fail("Jigsaw Studio changed while bay chunks were being captured; save cancelled.", null); - return; - } - coordinator.accept(snapshot); - } catch (Throwable exception) { - coordinator.fail("Jigsaw Studio capture failed in chunk " - + area.chunkX() + "," + area.chunkZ() + ": " + failureMessage(exception), exception); - } - } - - private void assembleAndPersist(CaptureCoordinator coordinator, List snapshots) { - if (coordinator.failed()) { - return; - } - ActiveStudio studio = coordinator.studio(); - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - coordinator.fail("Jigsaw Studio changed before captured chunks could be assembled; save cancelled.", null); - return; - } - try { - Capture capture = aggregateSnapshots( - coordinator.captureTarget().bounds(), - coordinator.areas(), - snapshots, - coordinator.captureTarget().displayRotationQuarterTurns()); - List connectors = preserveCapturedConnectorOrder( - coordinator.captureTarget().piece(), - capture.connectors()); - requireWorkcellTopology( - coordinator.bay(), - connectors, - coordinator.captureTarget().displayRotationQuarterTurns()); - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - coordinator.fail("Jigsaw Studio changed before the captured bay could be written; save cancelled.", null); - return; - } - message(coordinator.player(), "Captured " + connectors.size() - + " connector(s) from " + snapshots.size() - + " chunk(s); validating and writing the owned structure graph..."); - persistCapture(coordinator, capture, connectors); - } catch (WorkcellTopologyException exception) { - coordinator.failPersistent( - "Jigsaw Studio cannot autosave this planar workcell: " - + failureMessage(exception), - null); - } catch (Throwable exception) { - coordinator.failPersistent( - "Jigsaw Studio capture assembly failed: " + failureMessage(exception), - exception); - } - } - - private void persistCapture( - CaptureCoordinator coordinator, - Capture capture, - List connectors - ) { - ActiveStudio studio = coordinator.studio(); - JigsawStudioBay bay = coordinator.bay(); - Player player = coordinator.player(); - try { - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - message(player, "Jigsaw Studio changed before the captured bay could be written; save cancelled."); - return; - } - JigsawStudioActivation.Request request = studio.generator().getRequest(); - IrisData source = request.source(); - Path packRoot = source.getDataFolder().toPath(); - JigsawStudioResourceBundleAssembler.Assembly assembly = - JigsawStudioResourceBundleAssembler.assemble( - packRoot, - request.structureKey(), - coordinator.saveIdentity().variantKey(), - capture.objectContent(), - connectors, - capture.hasBlockEntities()); - StructureResourceBundleGraphCompiler.requireViable(assembly.bundle()); - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - message(player, "Jigsaw Studio changed during validation; save cancelled before writing."); - return; - } - JigsawStudioHistoryStore historyStore = new JigsawStudioHistoryStore( - packRoot, - request.structureKey()); - JigsawStudioHistoryStore.Snapshot previous = historyStore.snapshotCurrent( - coordinator.saveIdentity().variantKey()); - if (!previous.matches(assembly.bundle())) { - historyStore.append(previous); - } - StructureWriteResult result; - synchronized (saveLifecycleLock) { - if (!isCurrentSave(studio, coordinator.requestId(), coordinator.saveIdentity())) { - message(player, "Jigsaw Studio changed before the validated save entered the writer; save cancelled."); - return; - } - result = new StructureTransactionWriter(packRoot) - .write(assembly.bundle(), StructureWriteOptions.overwriteExpected( - assembly.expectedManifestHash())); - } - if (!result.successful()) { - String failure = writeFailure(result); - coordinator.recordPersistentFailure(failure, result.failure().orElse(null)); - message(player, failure); - return; - } - source.invalidateStructureResources(); - studio.generator().invalidateRender(bay.stableId(), coordinator.saveIdentity().variantKey()); - JigsawStudioSession session = studio.generator().getSession(); - boolean unchanged = session.markWorkcellSaved(coordinator.saveIdentity()); - try { - reloadSessionLayout(studio); - } catch (IOException | RuntimeException refreshFailure) { - IrisLogging.reportError(refreshFailure); - message(player, "The graph saved, but Studio could not refresh its variant catalog. " - + "Close and reopen this project before continuing: " - + failureMessage(refreshFailure)); - } - String cleanup = result.status() == StructureWriteResult.Status.COMMITTED_CLEANUP_REQUIRED - ? " The graph committed, but transaction cleanup requires operator attention in the console." - : ""; - String mutationNotice = unchanged ? "" : " Newer edits remain unsaved."; - message(player, "Saved piece '" + coordinator.saveIdentity().variantKey() + "' and object '" - + assembly.objectKey() + "' atomically." + mutationNotice + cleanup); - playSaveSound(player); - if (unchanged) { - scheduleEvaluation(studio); - } - IrisLogging.debug("Jigsaw Studio saved: structure=%s piece=%s object=%s connectors=%d status=%s", - request.structureKey(), coordinator.saveIdentity().variantKey(), assembly.objectKey(), - connectors.size(), result.status()); - } catch (Throwable exception) { - String failure = "Jigsaw Studio save failed: " + failureMessage(exception); - coordinator.recordPersistentFailure(failure, exception); - message(player, failure); - } finally { - coordinator.complete(); - } - } - - static List chunkIntersections(JigsawStudioBounds bounds) { - JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); - List areas = new ArrayList<>(); - int minimumChunkX = captureBounds.originX() >> 4; - int maximumChunkX = captureBounds.maxX() >> 4; - int minimumChunkZ = captureBounds.originZ() >> 4; - int maximumChunkZ = captureBounds.maxZ() >> 4; - for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { - int chunkOriginX = chunkX << 4; - int minimumX = Math.max(0, chunkOriginX - captureBounds.originX()); - int maximumX = Math.min( - captureBounds.dimensions().width(), - chunkOriginX + 16 - captureBounds.originX()); - for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { - int chunkOriginZ = chunkZ << 4; - int minimumZ = Math.max(0, chunkOriginZ - captureBounds.originZ()); - int maximumZ = Math.min( - captureBounds.dimensions().depth(), - chunkOriginZ + 16 - captureBounds.originZ()); - areas.add(new ChunkCaptureArea( - chunkX, - chunkZ, - minimumX, - maximumX, - minimumZ, - maximumZ)); - } - } - return List.copyOf(areas); - } - - static ChunkSnapshot captureChunkIntersection( - World world, - JigsawStudioBounds bounds, - IrisJigsawPiece sourcePiece, - IrisObject sourceObject, - ChunkCaptureArea area - ) throws IOException { - return captureChunkIntersection(world, bounds, sourcePiece, sourceObject, area, 0); - } - - static ChunkSnapshot captureChunkIntersection( - World world, - JigsawStudioBounds bounds, - IrisJigsawPiece sourcePiece, - IrisObject sourceObject, - ChunkCaptureArea area, - int displayRotationQuarterTurns - ) throws IOException { - return captureChunkIntersection( - world, - bounds, - sourcePiece, - sourceObject, - area, - displayRotationQuarterTurns, - true); - } - - static ChunkSnapshot captureChunkIntersection( - World world, - JigsawStudioBounds bounds, - IrisJigsawPiece sourcePiece, - IrisObject sourceObject, - ChunkCaptureArea area, - int displayRotationQuarterTurns, - boolean connectorsVisible - ) throws IOException { - World captureWorld = Objects.requireNonNull(world, "Jigsaw Studio capture world"); - JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); - IrisObject captureSource = Objects.requireNonNull(sourceObject, "Jigsaw Studio source object"); - ChunkCaptureArea captureArea = Objects.requireNonNull(area, "Jigsaw Studio chunk capture area"); - int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); - int sourceWidth = (quarterTurns & 1) == 0 - ? captureBounds.dimensions().width() - : captureBounds.dimensions().depth(); - int sourceDepth = (quarterTurns & 1) == 0 - ? captureBounds.dimensions().depth() - : captureBounds.dimensions().width(); - List blocks = new ArrayList<>(); - List connectors = new ArrayList<>(); - Map hiddenConnectors = connectorsVisible - ? Map.of() - : displayedSourceConnectors(sourcePiece, captureBounds.dimensions(), quarterTurns); - for (int x = captureArea.minimumX(); x < captureArea.maximumX(); x++) { - for (int y = 0; y < bounds.dimensions().height(); y++) { - for (int z = captureArea.minimumZ(); z < captureArea.maximumZ(); z++) { - Block block = captureWorld.getBlockAt( - captureBounds.originX() + x, - captureBounds.originY() + y, - captureBounds.originZ() + z); - BlockData blockData = block.getBlockData(); - IrisJigsawConnector hiddenConnector = hiddenConnectors.get(new LocalPosition(x, y, z)); - if (hiddenConnector != null) { - hiddenConnector.setFinalState(blockData.getAsString()); - connectors.add(CapturedConnector.from(hiddenConnector)); - } - if (hiddenConnector == null && blockData instanceof Jigsaw jigsaw) { - KMap nbt = BukkitPlatform.serializeTile(block.getLocation()); - if (nbt == null) { - throw new IOException("Cannot read jigsaw marker NBT at " - + block.getX() + "," + block.getY() + "," + block.getZ() - + ". The active NMS binding must support tile serialization."); - } - IrisJigsawConnector connector; - try { - connector = JigsawStudioMarkerParser.parse(nbt, jigsaw.getOrientation(), x, y, z); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid jigsaw marker at " - + block.getX() + "," + block.getY() + "," + block.getZ() - + ": " + failureMessage(exception), exception); - } - restoreCapturedMetadataForDisplay( - connector, - sourcePiece, - captureBounds.dimensions(), - quarterTurns); - BlockData finalData; - try { - finalData = Bukkit.createBlockData(connector.getFinalState()); - } catch (IllegalArgumentException exception) { - throw new IOException("Invalid final_state '" + connector.getFinalState() - + "' at " + block.getX() + "," + block.getY() + "," + block.getZ(), exception); - } - connector.setFinalState(finalData.getAsString()); - connectors.add(CapturedConnector.from(connector)); - if (finalData.getMaterial() != Material.STRUCTURE_VOID) { - blocks.add(new CapturedBlock( - x, - y, - z, - BukkitBlockState.of(finalData), - null)); - } - continue; - } - if (isAir(blockData.getMaterial())) { - LocalPosition sourcePosition = inversePosition( - x, - y, - z, - sourceWidth, - sourceDepth, - quarterTurns); - PlatformBlockState retainedAir = retainedSourceAir( - captureSource, - sourcePosition.x(), - sourcePosition.y(), - sourcePosition.z(), - blockData); - if (retainedAir != null) { - blocks.add(new CapturedBlock(x, y, z, retainedAir, null)); - } - continue; - } - if (blockData.getMaterial() == Material.STRUCTURE_VOID) { - continue; - } - blocks.add(new CapturedBlock( - x, - y, - z, - BukkitBlockState.of(blockData), - TileData.getTileState(block, false))); - } - } - } - return new ChunkSnapshot(captureArea, blocks, connectors); - } - - private static Map displayedSourceConnectors( - IrisJigsawPiece sourcePiece, - JigsawStudioCellDimensions displayDimensions, - int displayRotationQuarterTurns - ) throws IOException { - IrisJigsawPiece source = Objects.requireNonNull(sourcePiece, "Jigsaw Studio source piece"); - if (source.getConnectors() == null) { - throw new IOException("Jigsaw Studio source piece has no connector list"); - } - int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); - int sourceWidth = (quarterTurns & 1) == 0 - ? displayDimensions.width() - : displayDimensions.depth(); - int sourceDepth = (quarterTurns & 1) == 0 - ? displayDimensions.depth() - : displayDimensions.width(); - IrisObjectRotation rotation = IrisObjectRotation.of(0, -90.0D * quarterTurns, 0); - Map displayed = new HashMap<>(source.getConnectors().size()); - for (IrisJigsawConnector sourceConnector : source.getConnectors()) { - LocalPosition sourcePosition = connectorPosition(sourceConnector, "source piece"); - LocalPosition position = forwardPosition( - sourcePosition.x(), - sourcePosition.y(), - sourcePosition.z(), - sourceWidth, - sourceDepth, - quarterTurns); - IrisJigsawConnector connector = CapturedConnector.from(sourceConnector).toConnector() - .setPosition(new IrisPosition(position.x(), position.y(), position.z())) - .setDirection(rotation.rotate(sourceConnector.getDirection())) - .setTop(rotation.rotate(sourceConnector.getTop())); - if (displayed.put(position, connector) != null) { - throw new IOException("Jigsaw Studio source piece has duplicate displayed connector position " - + connectorLocation(position)); - } - } - return Map.copyOf(displayed); - } - - static PlatformBlockState retainedSourceAir( - IrisObject sourceObject, - int x, - int y, - int z, - BlockData current - ) { - IrisObject source = Objects.requireNonNull(sourceObject, "Jigsaw Studio source object"); - BlockData currentState = Objects.requireNonNull(current, "Jigsaw Studio current block state"); - if (!isAir(currentState.getMaterial()) - || x < 0 - || y < 0 - || z < 0 - || x >= source.getW() - || y >= source.getH() - || z >= source.getD()) { - return null; - } - PlatformBlockState original = source.getBlocks().get(source.getSigned(x, y, z)); - return original != null && original.isAir() ? original : null; - } - - private static boolean isAir(Material material) { - return material == Material.AIR || material == Material.CAVE_AIR || material == Material.VOID_AIR; - } - - static Capture aggregateSnapshots( - JigsawStudioBounds bounds, - List expectedAreas, - List snapshots - ) throws IOException { - return aggregateSnapshots(bounds, expectedAreas, snapshots, 0); - } - - static Capture aggregateSnapshots( - JigsawStudioBounds bounds, - List expectedAreas, - List snapshots, - int displayRotationQuarterTurns - ) throws IOException { - JigsawStudioBounds captureBounds = Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); - int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); - List requiredAreas = List.copyOf(expectedAreas); - List capturedSnapshots = List.copyOf(snapshots); - Map requiredByChunk = new HashMap<>(); - for (ChunkCaptureArea area : requiredAreas) { - if (requiredByChunk.put(chunkKey(area.chunkX(), area.chunkZ()), area) != null) { - throw new IOException("Duplicate required bay chunk " + area.chunkX() + "," + area.chunkZ()); - } - } - if (capturedSnapshots.size() != requiredByChunk.size()) { - throw new IOException("Expected " + requiredByChunk.size() + " bay chunk snapshot(s), received " - + capturedSnapshots.size()); - } - Map capturedByChunk = new HashMap<>(); - for (ChunkSnapshot snapshot : capturedSnapshots) { - ChunkCaptureArea area = snapshot.area(); - long key = chunkKey(area.chunkX(), area.chunkZ()); - ChunkCaptureArea required = requiredByChunk.get(key); - if (!area.equals(required)) { - throw new IOException("Unexpected bay chunk intersection for " - + area.chunkX() + "," + area.chunkZ()); - } - if (capturedByChunk.put(key, snapshot) != null) { - throw new IOException("Duplicate bay chunk snapshot " + area.chunkX() + "," + area.chunkZ()); - } - } - if (!capturedByChunk.keySet().containsAll(requiredByChunk.keySet())) { - throw new IOException("One or more required bay chunk snapshots are missing"); - } - - List ordered = new ArrayList<>(capturedSnapshots); - ordered.sort(Comparator - .comparingInt((ChunkSnapshot snapshot) -> snapshot.area().chunkX()) - .thenComparingInt(snapshot -> snapshot.area().chunkZ())); - int sourceWidth = (quarterTurns & 1) == 0 - ? captureBounds.dimensions().width() - : captureBounds.dimensions().depth(); - int sourceDepth = (quarterTurns & 1) == 0 - ? captureBounds.dimensions().depth() - : captureBounds.dimensions().width(); - IrisObject object = new IrisObject( - sourceWidth, - captureBounds.dimensions().height(), - sourceDepth); - IrisObjectRotation inverseRotation = IrisObjectRotation.of(0, 90.0D * quarterTurns, 0); - List connectors = new ArrayList<>(); - Set capturedBlocks = new HashSet<>(); - Set capturedConnectors = new HashSet<>(); - boolean hasBlockEntities = false; - for (ChunkSnapshot snapshot : ordered) { - ChunkCaptureArea area = snapshot.area(); - for (CapturedBlock block : snapshot.blocks()) { - if (!area.contains(block.x(), block.z()) - || block.y() < 0 - || block.y() >= captureBounds.dimensions().height()) { - throw new IOException("Captured block falls outside bay chunk " - + area.chunkX() + "," + area.chunkZ()); - } - LocalPosition position = inversePosition( - block.x(), block.y(), block.z(), sourceWidth, sourceDepth, quarterTurns); - if (!capturedBlocks.add(position)) { - throw new IOException("Duplicate captured block at " - + block.x() + "," + block.y() + "," + block.z()); - } - PlatformBlockState sourceState = quarterTurns == 0 - ? block.state() - : inverseRotation.rotate(block.state(), 0, 0, 0); - if (sourceState == null) { - throw new IOException("Captured block state cannot be inverse-rotated at " - + block.x() + "," + block.y() + "," + block.z()); - } - object.setUnsigned(position.x(), position.y(), position.z(), sourceState); - TileData tileData = block.tileData(); - if (tileData != null) { - object.setUnsignedTile(position.x(), position.y(), position.z(), tileData.clone()); - hasBlockEntities = true; - } - } - for (CapturedConnector capturedConnector : snapshot.connectors()) { - if (!area.contains(capturedConnector.x(), capturedConnector.z()) - || capturedConnector.y() < 0 - || capturedConnector.y() >= captureBounds.dimensions().height()) { - throw new IOException("Captured connector falls outside bay chunk " - + area.chunkX() + "," + area.chunkZ()); - } - LocalPosition position = inversePosition( - capturedConnector.x(), - capturedConnector.y(), - capturedConnector.z(), - sourceWidth, - sourceDepth, - quarterTurns); - if (!capturedConnectors.add(position)) { - throw new IOException("Duplicate captured connector at " - + capturedConnector.x() + "," + capturedConnector.y() + "," - + capturedConnector.z()); - } - IrisJigsawConnector connector = capturedConnector.toConnector(); - if (quarterTurns != 0) { - connector.setPosition(new IrisPosition(position.x(), position.y(), position.z())); - connector.setDirection(inverseRotation.rotate(connector.getDirection())); - connector.setTop(inverseRotation.rotate(connector.getTop())); - PlatformBlockState finalState = B.getStateOrNull(connector.getFinalState(), false); - if (finalState == null) { - throw new IOException("Captured connector final state cannot be parsed at " - + capturedConnector.x() + "," + capturedConnector.y() + "," - + capturedConnector.z()); - } - PlatformBlockState sourceFinalState = inverseRotation.rotate(finalState, 0, 0, 0); - if (sourceFinalState == null) { - throw new IOException("Captured connector final state cannot be inverse-rotated at " - + capturedConnector.x() + "," + capturedConnector.y() + "," - + capturedConnector.z()); - } - connector.setFinalState(sourceFinalState.key()); - } - connectors.add(connector); - } - } - try (ByteArrayOutputStream output = new ByteArrayOutputStream()) { - object.write(output); - return new Capture(output.toByteArray(), connectors, hasBlockEntities); - } - } - - static List preserveCapturedConnectorOrder( - IrisJigsawPiece sourcePiece, - List capturedConnectors - ) throws IOException { - IrisJigsawPiece source = Objects.requireNonNull(sourcePiece, "Jigsaw Studio source piece"); - List sourceConnectors = source.getConnectors(); - if (sourceConnectors == null) { - throw new IOException("Jigsaw Studio source piece has no connector list"); - } - List captured = new ArrayList<>(Objects.requireNonNull( - capturedConnectors, - "Jigsaw Studio captured connectors")); - Map capturedByPosition = new HashMap<>(captured.size()); - for (IrisJigsawConnector connector : captured) { - LocalPosition position = connectorPosition(connector, "captured"); - if (capturedByPosition.put(position, connector) != null) { - throw new IOException("Jigsaw Studio capture has duplicate connector position " - + connectorLocation(position)); - } - } - - List ordered = new ArrayList<>(captured.size()); - Set sourcePositions = new HashSet<>(sourceConnectors.size()); - for (IrisJigsawConnector connector : sourceConnectors) { - LocalPosition position = connectorPosition(connector, "source piece"); - if (!sourcePositions.add(position)) { - throw new IOException("Jigsaw Studio source piece has duplicate connector position " - + connectorLocation(position)); - } - IrisJigsawConnector matched = capturedByPosition.remove(position); - if (matched != null) { - ordered.add(matched); - } - } - - List appended = new ArrayList<>(capturedByPosition.values()); - appended.sort(NEW_CONNECTOR_SOURCE_POSITION_ORDER); - ordered.addAll(appended); - return List.copyOf(ordered); - } - - private static LocalPosition connectorPosition(IrisJigsawConnector connector, String owner) throws IOException { - if (connector == null || connector.getPosition() == null) { - throw new IOException("Jigsaw Studio " + owner + " contains a connector without a position"); - } - IrisPosition position = connector.getPosition(); - return new LocalPosition(position.getX(), position.getY(), position.getZ()); - } - - private static String connectorLocation(LocalPosition position) { - return position.x() + "," + position.y() + "," + position.z(); - } - - private static LocalPosition inversePosition( - int x, - int y, - int z, - int sourceWidth, - int sourceDepth, - int displayRotationQuarterTurns - ) { - return switch (Math.floorMod(displayRotationQuarterTurns, 4)) { - case 0 -> new LocalPosition(x, y, z); - case 1 -> new LocalPosition(z, y, sourceDepth - 1 - x); - case 2 -> new LocalPosition(sourceWidth - 1 - x, y, sourceDepth - 1 - z); - case 3 -> new LocalPosition(sourceWidth - 1 - z, y, x); - default -> throw new IllegalStateException("Unreachable Jigsaw Studio inverse rotation"); - }; - } - - private static LocalPosition forwardPosition( - int x, - int y, - int z, - int sourceWidth, - int sourceDepth, - int displayRotationQuarterTurns - ) { - return switch (Math.floorMod(displayRotationQuarterTurns, 4)) { - case 0 -> new LocalPosition(x, y, z); - case 1 -> new LocalPosition(sourceDepth - 1 - z, y, x); - case 2 -> new LocalPosition(sourceWidth - 1 - x, y, sourceDepth - 1 - z); - case 3 -> new LocalPosition(z, y, sourceWidth - 1 - x); - default -> throw new IllegalStateException("Unreachable Jigsaw Studio display rotation"); - }; - } - - static void requireWorkcellTopology( - JigsawStudioBay workcell, - List connectors, - int displayRotationQuarterTurns - ) throws IOException { - JigsawPlanarArchetype expected = workcell.archetype().orElse(null); - if (expected == null) { - return; - } - int mask = 0; - for (IrisJigsawConnector connector : connectors) { - mask |= switch (connector.getDirection()) { - case NORTH_NEGATIVE_Z -> JigsawPlanarDirection.NORTH.bit(); - case EAST_POSITIVE_X -> JigsawPlanarDirection.EAST.bit(); - case SOUTH_POSITIVE_Z -> JigsawPlanarDirection.SOUTH.bit(); - case WEST_NEGATIVE_X -> JigsawPlanarDirection.WEST.bit(); - case UP_POSITIVE_Y, DOWN_NEGATIVE_Y -> throw new WorkcellTopologyException( - "Planar workcell '" + workcell.stableId() - + "' cannot save a vertical connector. Remove it or use Reset Connector Blocks."); - }; - } - JigsawPlanarTopology sourceTopology = JigsawPlanarTopology.fromMask(mask); - JigsawPlanarTopology displayedTopology = sourceTopology.rotateClockwise(displayRotationQuarterTurns); - if (displayedTopology != expected.canonicalTopology()) { - throw new WorkcellTopologyException("Workcell '" + workcell.stableId() + "' requires " - + topologyDescription(expected.canonicalTopology()) - + ", but the edited markers form " - + topologyDescription(displayedTopology) - + ". Use Reset Connector Blocks to restore the saved topology, or edit the markers to match the floor glyph."); - } - } - - private static String topologyDescription(JigsawPlanarTopology topology) { - int connectorCount = topology.directions().size(); - return topology.name().toLowerCase(Locale.ROOT).replace('_', ' ') - + " (" + connectorCount + " horizontal connector" - + (connectorCount == 1 ? "" : "s") + ")"; - } - - static void storeConnectorFinalState( - IrisObject object, - int x, - int y, - int z, - BlockData finalData - ) { - Objects.requireNonNull(object, "Jigsaw Studio captured object"); - BlockData activeFinalData = Objects.requireNonNull(finalData, "Jigsaw connector final state"); - if (activeFinalData.getMaterial() != Material.STRUCTURE_VOID) { - object.setUnsigned(x, y, z, BukkitBlockState.of(activeFinalData)); - } - } - - private void scheduleHydration( - ActiveStudio studio, - World world, - int chunkX, - int chunkZ, - int attempt - ) { - if (!enabled || studios.get(world.getUID()) != studio) { - return; - } - long key = chunkKey(chunkX, chunkZ); - if (!studio.hydrationsInProgress().add(key)) { - return; - } - boolean scheduled = J.runRegion( - world, - chunkX, - chunkZ, - () -> runHydrationAttempt(studio, world, chunkX, chunkZ, attempt, key), - HYDRATION_RETRY_TICKS); - if (!scheduled) { - studio.hydrationsInProgress().remove(key); - } - } - - private void runHydrationAttempt( - ActiveStudio studio, - World world, - int chunkX, - int chunkZ, - int attempt, - long key - ) { - studio.hydrationsInProgress().remove(key); - if (!enabled || studios.get(world.getUID()) != studio) { - return; - } - if (!world.isChunkLoaded(chunkX, chunkZ)) { - if (attempt < MAX_HYDRATION_ATTEMPTS) { - scheduleHydration(studio, world, chunkX, chunkZ, attempt + 1); - } - return; - } - if (hydrateChunk(studio, world, chunkX, chunkZ)) { - scheduleHydration(studio, world, chunkX, chunkZ, 0); - } - } - - private static boolean hydrateChunk( - ActiveStudio studio, - World world, - int chunkX, - int chunkZ - ) { - long key = chunkKey(chunkX, chunkZ); - boolean verificationRequired = false; - for (JigsawStudioBay bay : studio.generator().getLayout().bays()) { - BayPopulation population = studio.population(bay); - if (!population.needsApplication(key) && !population.needsVerification(key)) { - continue; - } - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); - if (!rendered.valid()) { - population.fail(rendered.failure()); - continue; - } - try { - if (population.needsApplication(key)) { - applyRenderedBayChunk( - world, - bay, - rendered, - chunkX, - chunkZ, - studio.generator().getSession().workcellSnapshot(bay.stableId()).connectorsVisible()); - population.markApplied(key); - verificationRequired = true; - } else { - verifyRenderedBayChunk( - world, - bay, - rendered, - chunkX, - chunkZ, - studio.generator().getSession().workcellSnapshot(bay.stableId()).connectorsVisible()); - population.markHydrated(key); - } - } catch (Throwable exception) { - if (population.fail("chunk " + chunkX + "," + chunkZ - + " could not hydrate: " + failureMessage(exception))) { - IrisLogging.reportError(exception); - } - } - } - return verificationRequired; - } - - private static void applyRenderedBayChunk( - World world, - JigsawStudioBay bay, - JigsawStudioGenerator.RenderedBay rendered, - int chunkX, - int chunkZ, - boolean connectorsVisible - ) throws IOException { - JigsawStudioBounds bounds = bay.bounds(); - Set connectorPositions = new HashSet<>(rendered.connectors().size()); - if (connectorsVisible) { - for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { - connectorPositions.add(new LocalPosition(connector.x(), connector.y(), connector.z())); - } - } - for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { - TileData tileData = block.tileData(); - if (tileData == null - || connectorPositions.contains(new LocalPosition(block.x(), block.y(), block.z()))) { - continue; - } - int worldX = bounds.originX() + block.x(); - int worldZ = bounds.originZ() + block.z(); - if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { - continue; - } - Block target = world.getBlockAt(worldX, bounds.originY() + block.y(), worldZ); - if (!tileData.isApplicable(target.getBlockData())) { - throw new IOException("source tile state does not match rendered block at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - if (!tileData.toBukkitTry(target)) { - throw new IOException("source tile state could not hydrate at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - } - if (!connectorsVisible) { - return; - } - for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { - int worldX = bounds.originX() + renderedConnector.x(); - int worldZ = bounds.originZ() + renderedConnector.z(); - if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { - continue; - } - Block target = world.getBlockAt( - worldX, - bounds.originY() + renderedConnector.y(), - worldZ); - BlockData blockData = target.getBlockData(); - if (!(blockData instanceof Jigsaw jigsaw)) { - throw new IOException("expected a jigsaw marker at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - String actualOrientation = jigsaw.getOrientation().name().toLowerCase(Locale.ROOT); - if (!actualOrientation.equals(renderedConnector.orientation())) { - throw new IOException("jigsaw marker orientation at " - + target.getX() + "," + target.getY() + "," + target.getZ() - + " is " + actualOrientation + " instead of " + renderedConnector.orientation()); - } - KMap expected = markerNbt(renderedConnector.connector()); - BukkitPlatform.deserializeTile(expected, target.getLocation()); - } - } - - private static void verifyRenderedBayChunk( - World world, - JigsawStudioBay bay, - JigsawStudioGenerator.RenderedBay rendered, - int chunkX, - int chunkZ, - boolean connectorsVisible - ) throws IOException { - JigsawStudioBounds bounds = bay.bounds(); - Set connectorPositions = new HashSet<>(rendered.connectors().size()); - if (connectorsVisible) { - for (JigsawStudioGenerator.RenderedConnector connector : rendered.connectors()) { - connectorPositions.add(new LocalPosition(connector.x(), connector.y(), connector.z())); - } - } - for (JigsawStudioGenerator.RenderedBlock block : rendered.blocks()) { - TileData tileData = block.tileData(); - if (tileData == null - || connectorPositions.contains(new LocalPosition(block.x(), block.y(), block.z()))) { - continue; - } - int worldX = bounds.originX() + block.x(); - int worldZ = bounds.originZ() + block.z(); - if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { - continue; - } - Block target = world.getBlockAt(worldX, bounds.originY() + block.y(), worldZ); - if (!tileData.isApplicable(target.getBlockData())) { - throw new IOException("hydrated tile state no longer matches its block at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - KMap hydrated = BukkitPlatform.serializeTile(target.getLocation()); - if (hydrated == null - || tileData.getProperties() != null - && !nbtContains(tileData.getProperties(), hydrated)) { - throw new IOException("the active NMS binding did not preserve source tile NBT at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - } - if (!connectorsVisible) { - return; - } - for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { - int worldX = bounds.originX() + renderedConnector.x(); - int worldZ = bounds.originZ() + renderedConnector.z(); - if ((worldX >> 4) != chunkX || (worldZ >> 4) != chunkZ) { - continue; - } - Block target = world.getBlockAt( - worldX, - bounds.originY() + renderedConnector.y(), - worldZ); - BlockData blockData = target.getBlockData(); - if (!(blockData instanceof Jigsaw jigsaw) - || !jigsaw.getOrientation().name().toLowerCase(Locale.ROOT) - .equals(renderedConnector.orientation())) { - throw new IOException("jigsaw marker changed before hydration completed at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - KMap expected = markerNbt(renderedConnector.connector()); - KMap hydrated = BukkitPlatform.serializeTile(target.getLocation()); - if (!markerNbtMatches(expected, hydrated)) { - throw new IOException("the active NMS binding did not preserve jigsaw marker NBT at " - + target.getX() + "," + target.getY() + "," + target.getZ()); - } - } - } - - static KMap markerNbt(IrisJigsawConnector connector) { - IrisJigsawConnector activeConnector = Objects.requireNonNull(connector, "Jigsaw Studio connector"); - KMap nbt = new KMap<>(); - nbt.put("name", studioIdentifier(activeConnector.getName())); - nbt.put("target", studioIdentifier(activeConnector.getTargetName())); - nbt.put("pool", JigsawStudioMarkerKeyCodec.encodePool(activeConnector.getPool())); - nbt.put("final_state", activeConnector.getFinalState()); - nbt.put("joint", activeConnector.getJoint().name().toLowerCase(Locale.ROOT)); - nbt.put("selection_priority", activeConnector.getSelectionPriority()); - nbt.put("placement_priority", activeConnector.getPlacementPriority()); - return nbt; - } - - private static boolean markerNbtMatches( - Map expected, - Map hydrated - ) { - if (hydrated == null) { - return false; - } - for (Map.Entry entry : expected.entrySet()) { - Object actual = hydrated.get(entry.getKey()); - if (entry.getValue() instanceof Number expectedNumber) { - if (!(actual instanceof Number actualNumber) - || expectedNumber.longValue() != actualNumber.longValue()) { - return false; - } - } else if (!Objects.equals(entry.getValue(), actual)) { - return false; - } - } - return true; - } - - private static boolean nbtContains(Object expected, Object actual) { - if (expected instanceof Number expectedNumber) { - if (!(actual instanceof Number actualNumber)) { - return false; - } - if (isIntegral(expectedNumber) && isIntegral(actualNumber)) { - return expectedNumber.longValue() == actualNumber.longValue(); - } - return Double.compare(expectedNumber.doubleValue(), actualNumber.doubleValue()) == 0; - } - if (expected instanceof Map expectedMap) { - if (!(actual instanceof Map actualMap)) { - return false; - } - for (Map.Entry entry : expectedMap.entrySet()) { - if (!actualMap.containsKey(entry.getKey()) - || !nbtContains(entry.getValue(), actualMap.get(entry.getKey()))) { - return false; - } - } - return true; - } - if (expected instanceof List expectedList) { - if (!(actual instanceof List actualList) || expectedList.size() != actualList.size()) { - return false; - } - for (int index = 0; index < expectedList.size(); index++) { - if (!nbtContains(expectedList.get(index), actualList.get(index))) { - return false; - } - } - return true; - } - return Objects.equals(expected, actual); - } - - private static boolean isIntegral(Number number) { - return number instanceof Byte - || number instanceof Short - || number instanceof Integer - || number instanceof Long; - } - - static void restoreCapturedMetadata( - IrisJigsawConnector captured, - IrisJigsawPiece sourcePiece - ) { - IrisJigsawConnector activeCaptured = Objects.requireNonNull(captured, "Captured jigsaw connector"); - IrisJigsawConnector original = connectorAt(sourcePiece, activeCaptured.getPosition()); - if (original == null) { - return; - } - activeCaptured.setName(restoreIdentifier(activeCaptured.getName(), original.getName())); - activeCaptured.setTargetName(restoreIdentifier( - activeCaptured.getTargetName(), - original.getTargetName())); - activeCaptured.setChannel(original.getChannel() == null ? "" : original.getChannel()); - } - - private static void restoreCapturedMetadataForDisplay( - IrisJigsawConnector captured, - IrisJigsawPiece sourcePiece, - JigsawStudioCellDimensions displayDimensions, - int displayRotationQuarterTurns - ) { - if (Math.floorMod(displayRotationQuarterTurns, 4) == 0) { - restoreCapturedMetadata(captured, sourcePiece); - return; - } - int quarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); - int sourceWidth = (quarterTurns & 1) == 0 - ? displayDimensions.width() - : displayDimensions.depth(); - int sourceDepth = (quarterTurns & 1) == 0 - ? displayDimensions.depth() - : displayDimensions.width(); - LocalPosition position = inversePosition( - captured.getPosition().getX(), - captured.getPosition().getY(), - captured.getPosition().getZ(), - sourceWidth, - sourceDepth, - quarterTurns); - IrisObjectRotation inverseRotation = IrisObjectRotation.of(0, 90.0D * quarterTurns, 0); - IrisJigsawConnector sourceOriented = CapturedConnector.from(captured).toConnector() - .setPosition(new IrisPosition(position.x(), position.y(), position.z())) - .setDirection(inverseRotation.rotate(captured.getDirection())) - .setTop(inverseRotation.rotate(captured.getTop())); - restoreCapturedMetadata(sourceOriented, sourcePiece); - captured.setName(sourceOriented.getName()); - captured.setTargetName(sourceOriented.getTargetName()); - captured.setChannel(sourceOriented.getChannel()); - } - - private static IrisJigsawConnector connectorAt(IrisJigsawPiece piece, IrisPosition position) { - if (piece == null || piece.getConnectors() == null || position == null) { - return null; - } - for (IrisJigsawConnector connector : piece.getConnectors()) { - if (connector != null && position.equals(connector.getPosition())) { - return connector; - } - } - return null; - } - - private static String restoreIdentifier(String captured, String original) { - if (original != null && studioIdentifier(original).equals(captured)) { - return original; - } - return captured; - } - - private static String studioIdentifier(String value) { - String normalized = Objects.requireNonNull(value, "Jigsaw Studio marker identifier").trim(); - return normalized.indexOf(':') < 0 ? "iris:" + normalized : normalized; - } - - private boolean isCurrentRequest(ActiveStudio studio, UUID requestId) { + boolean isCurrentRequest(ActiveStudio studio, UUID requestId) { if (studio == null || requestId == null || studios.get(studio.worldId()) != studio @@ -7007,102 +317,11 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return active != null && active.requestId().equals(requestId); } - private boolean isCurrentSave( - ActiveStudio studio, - UUID requestId, - JigsawStudioSession.SaveIdentity identity - ) { - return isCurrentRequest(studio, requestId) - && studio.generator().getSession().isSaveCurrent(identity); - } - - private static String readinessMessage(JigsawStudioBay bay, BayReadiness readiness) { - if (!readiness.failure().isEmpty()) { - return "Bay '" + bay.stableId() + "' is invalid and cannot be saved: " + readiness.failure(); - } - return "Bay '" + bay.stableId() + "' is not ready to save: " - + readiness.generatedChunks() + "/" + readiness.requiredChunks() + " chunk(s) populated, " - + readiness.hydratedChunks() + "/" + readiness.requiredChunks() - + " chunk(s) hydrated. Visit the whole bay and wait for its markers to finish loading."; - } - - private static long chunkKey(int chunkX, int chunkZ) { + static long chunkKey(int chunkX, int chunkZ) { return ((long) chunkX << 32) ^ (chunkZ & 0xffffffffL); } - private static Set requiredChunks( - JigsawStudioBay bay, - JigsawStudioGenerator.RenderedBay rendered - ) { - Set chunks = new HashSet<>(); - if (!rendered.valid()) { - return chunks; - } - JigsawStudioBounds bounds = bay.bounds(); - int minimumChunkX = bounds.originX() >> 4; - int maximumChunkX = bounds.maxX() >> 4; - int minimumChunkZ = bounds.originZ() >> 4; - int maximumChunkZ = bounds.maxZ() >> 4; - for (int chunkX = minimumChunkX; chunkX <= maximumChunkX; chunkX++) { - for (int chunkZ = minimumChunkZ; chunkZ <= maximumChunkZ; chunkZ++) { - chunks.add(chunkKey(chunkX, chunkZ)); - } - } - return Set.copyOf(chunks); - } - - private static CaptureTarget resolveCaptureTarget( - ActiveStudio studio, - JigsawStudioBay bay, - JigsawStudioVariant variant - ) - throws IOException { - IrisData source = studio.generator().getRequest().source(); - JigsawStudioLayout currentLayout = studio.generator().getSession().layout(); - JigsawStudioBay currentBay = currentLayout.get(bay.stableId()); - if (currentBay == null) { - throw new IOException("workcell '" + bay.stableId() + "' is absent from the current Studio layout"); - } - JigsawStudioVariant activeVariant = Objects.requireNonNull(variant, "Jigsaw Studio capture variant"); - if (!currentLayout.accepts(currentBay, activeVariant)) { - throw new IOException("variant '" + activeVariant.pieceKey() - + "' does not belong to workcell '" + currentBay.stableId() + "'"); - } - IrisJigsawPiece piece = source.getJigsawPieceLoader().load(activeVariant.pieceKey(), false); - if (piece == null || piece.getObject() == null || piece.getObject().isBlank()) { - throw new IOException("piece '" + activeVariant.pieceKey() + "' is missing or has no object"); - } - IrisObject object = source.getObjectLoader().load(piece.getObject(), false); - if (object == null || object.getW() < 1 || object.getH() < 1 || object.getD() < 1) { - throw new IOException("object '" + piece.getObject() + "' is missing or has invalid dimensions"); - } - JigsawStudioBounds bayBounds = currentBay.bounds(); - JigsawStudioCellDimensions sourceDimensions = new JigsawStudioCellDimensions( - object.getW(), object.getH(), object.getD()); - JigsawStudioCellDimensions canonicalDimensions = activeVariant.canonicalDimensions(sourceDimensions); - if (canonicalDimensions.width() > bayBounds.dimensions().width() - || canonicalDimensions.height() > bayBounds.dimensions().height() - || canonicalDimensions.depth() > bayBounds.dimensions().depth()) { - throw new IOException("object '" + piece.getObject() + "' is " - + canonicalDimensions.width() + "x" + canonicalDimensions.height() + "x" - + canonicalDimensions.depth() + " in its displayed orientation" - + " but bay '" + currentBay.stableId() + "' is only " - + bayBounds.dimensions().width() + "x" + bayBounds.dimensions().height() + "x" - + bayBounds.dimensions().depth()); - } - return new CaptureTarget( - new JigsawStudioBounds( - bayBounds.originX(), - bayBounds.originY(), - bayBounds.originZ(), - canonicalDimensions), - piece, - object, - activeVariant.sourceToCanonicalQuarterTurns(), - studio.generator().getSession().workcellSnapshot(currentBay.stableId()).connectorsVisible()); - } - - private void reloadSessionLayout(ActiveStudio studio) throws IOException { + void reloadSessionLayout(ActiveStudio studio) throws IOException { JigsawStudioLayout layout = loadMappedLayout(studio); studio.generator().getSession().replaceLayout(layout); for (JigsawStudioBay workcell : layout.bays()) { @@ -7110,74 +329,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA } } - private void scheduleOnlinePlayers(UUID worldId) { - J.runGlobal(() -> { - for (Player player : Bukkit.getOnlinePlayers()) { - J.runEntity(player, () -> { - if (player.getWorld().getUID().equals(worldId)) { - ensureVisualizationLoop(player); - reconcilePlayerContext(player, player.getLocation()); - } - }); - } - }); - } - - public void reconcilePlayerContext(Player player, Location location) { - if (player == null) { - return; - } - Location target = location == null ? player.getLocation() : location; - if (!J.isOwnedByCurrentRegion(player) - || target.getWorld() == null - || !target.getWorld().getUID().equals(player.getWorld().getUID())) { - J.runEntity(player, () -> reconcilePlayerContext(player, player.getLocation()), 1); - return; - } - ActiveStudio studio = studios.get(target.getWorld().getUID()); - if (studio == null) { - clearPlayerContext(player); - return; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay workcell = session.layout().findAt( - target.getBlockX(), target.getBlockY(), target.getBlockZ()); - boolean owner = ownerMatches(player, studio); - selectEnteredWorkcell(session, workcell, owner); - String workcellId = workcell == null ? "" : workcell.stableId(); - playerWorkcells.put(player.getUniqueId(), new PlayerWorkcellContext( - studio.worldId(), - studio.generator().getRequest().requestId(), - workcellId)); - - JigsawStudioVariant variant = workcell == null - ? null - : session.activeVariant(workcell.stableId()).orElse(null); - JigsawStudioBoardState state = boardState(studio, session, workcell, variant); - String workcellRole = workcell == null ? "" : workcell.canonicalDisplayName(); - String workcellName = workcell == null ? "" : workcell.displayName(); - String variantName = variant == null ? "" : variant.resolvedDisplayName(); - String hint = "Triple-sneak for controls"; - boardService().applyJigsawContext(player, new JigsawStudioBoardContext( - studio.worldId(), - studio.generator().getRequest().requestId(), - studio.generator().getRequest().structureKey(), - session.layout().mode(), - workcellRole, - workcellName, - variantName, - state, - hint)); - } - - static boolean selectEnteredWorkcell( - JigsawStudioSession session, - JigsawStudioBay workcell, - boolean owner - ) { - return owner && workcell != null && session.selectBay(workcell.stableId()); - } - static boolean isNaturalStudioSpawn(CreatureSpawnEvent.SpawnReason reason) { return reason == CreatureSpawnEvent.SpawnReason.NATURAL; } @@ -7186,277 +337,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA Objects.requireNonNull(world, "world").setGameRule(GameRules.SPAWN_MOBS, false); } - public void refreshWorkcellContext(UUID worldId, String workcellId) { - if (worldId == null || workcellId == null) { - return; - } - J.runGlobal(() -> { - for (Player player : Bukkit.getOnlinePlayers()) { - J.runEntity(player, () -> { - if (!player.getWorld().getUID().equals(worldId)) { - return; - } - PlayerWorkcellContext context = playerWorkcells.get(player.getUniqueId()); - if (context != null && workcellId.equals(context.workcellId())) { - reconcilePlayerContext(player, player.getLocation()); - } - }); - } - }); - } - - private void clearWorldPlayerContexts(UUID worldId) { - J.runGlobal(() -> { - for (Player player : Bukkit.getOnlinePlayers()) { - J.runEntity(player, () -> { - PlayerWorkcellContext context = playerWorkcells.get(player.getUniqueId()); - if (context != null && context.worldId().equals(worldId)) { - closeMenu(player); - clearPlayerContext(player); - } - }); - } - }); - } - - private void clearPlayerContext(Player player) { - if (player == null) { - return; - } - playerWorkcells.remove(player.getUniqueId()); - boardService().clearJigsawContext(player); - } - - private static BoardSVC boardService() { - return IrisServices.get(BoardSVC.class); - } - - private static boolean ownerMatches(Player player, ActiveStudio studio) { - if (player == null || studio == null) { - return false; - } - UUID ownerId = studio.generator().getRequest().ownerId(); - return ownerMatches(ownerId, player.getUniqueId()); - } - - static boolean canCreateVariants(JigsawStudioLayout layout) { - return Objects.requireNonNull(layout, "Jigsaw Studio layout") - .variantCatalog() - .editableGraph(); - } - - static String variantCreationSourceFailure( - JigsawStudioVariant activeVariant, - boolean duplicateActive - ) { - if (activeVariant == null) { - return duplicateActive - ? "This workcell has no active variant to duplicate." - : "This workcell has no active variant whose pool role can be copied. Use " - + "/iris jigsaw piece create to choose an owned pool explicitly."; - } - if (!activeVariant.owned()) { - return "Adopt or clone this graph before creating from its read-only variant."; - } - if (activeVariant.memberships().isEmpty()) { - return "The active variant has no owned pool membership to copy. Use " - + "/iris jigsaw piece create to choose an owned pool explicitly."; - } - return ""; - } - - static boolean ownerMatches(UUID ownerId, UUID actorId) { - return ownerId == null || ownerId.equals(actorId); - } - - private static boolean authorizeOwner(Player player, ActiveStudio studio) { - if (ownerMatches(player, studio)) { - return true; - } - message(player, "This Jigsaw Studio is owned by another player session."); - return false; - } - - private boolean isUnauthorizedStudioEdit(Player player, Block block) { - if (player == null || block == null) { - return false; - } - ActiveStudio studio = studios.get(block.getWorld().getUID()); - if (studio == null) { - return false; - } - UUID requestId = studio.generator().getRequest().requestId(); - if (previewRenderer.contains(requestId, block.getX(), block.getY(), block.getZ())) { - message(player, "The seed-1337 Jigsaw preview is read-only and refreshes automatically."); - return true; - } - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioBay bay = session.layout().findAt(block.getX(), block.getY(), block.getZ()); - JigsawStudioVariant variant = bay == null - ? null - : session.activeVariant(bay.stableId()).orElse(null); - if (bay != null && (variant == null || !variant.owned())) { - message(player, variant == null - ? "This empty Jigsaw Studio workcell has no loaded editable variant. Load one before editing it." - : "This Jigsaw Studio variant is read-only. Adopt or clone its graph before editing it."); - return true; - } - if (reopenRequiredRequests.contains(requestId)) { - message(player, "Close and reopen Jigsaw Studio before editing the resized layout."); - return true; - } - if (materializationInProgress(studio)) { - message(player, "Wait for the current Jigsaw Studio variant load or rollback to finish."); - return true; - } - if (!blocksStudioEdit(studio.generator().getRequest().ownerId(), player.getUniqueId())) { - return false; - } - message(player, "This Jigsaw Studio is owned by another player session."); - return true; - } - - private boolean materializationInProgress(ActiveStudio studio) { - if (studio == null) { - return false; - } - UUID requestId = studio.generator().getRequest().requestId(); - synchronized (saveLifecycleLock) { - return materializationsInProgress.contains(requestId); - } - } - - private boolean anyMaterializationInProgress() { - synchronized (saveLifecycleLock) { - return !materializationsInProgress.isEmpty(); - } - } - - private boolean anyNonEditableWorkcell() { - for (ActiveStudio studio : studios.values()) { - if (hasNonEditableWorkcell(studio)) { - return true; - } - } - return false; - } - - private static boolean hasNonEditableWorkcell(ActiveStudio studio) { - JigsawStudioSession session = studio.generator().getSession(); - for (JigsawStudioBay bay : session.layout().bays()) { - JigsawStudioVariant variant = session.activeVariant(bay.stableId()).orElse(null); - if (variant == null || !variant.owned()) { - return true; - } - } - return false; - } - - static boolean blocksStudioEdit(UUID ownerId, UUID actorId) { - return !ownerMatches(ownerId, actorId); - } - - static boolean blocksStudioInventoryMutation( - boolean studioBlockInventory, - boolean immutable, - boolean materializing, - boolean reopenRequired, - UUID ownerId, - UUID actorId - ) { - return studioBlockInventory - && (immutable - || materializing - || reopenRequired - || actorId != null && blocksStudioEdit(ownerId, actorId)); - } - - private boolean movesProtectedBlocks(List blocks, BlockFace direction) { - for (Block block : blocks) { - if (isImmutableStudioBlock(block) - || isImmutableStudioBlock(block.getRelative(direction)) - || isImmutableStudioBlock(block.getRelative(direction.getOppositeFace()))) { - return true; - } - } - return false; - } - - private boolean containsImmutableStudioBlock(List states) { - for (BlockState state : states) { - if (isImmutableStudioBlock(state.getBlock())) { - return true; - } - } - return false; - } - - private boolean isImmutableStudioBlock(Block block) { - StudioBlockMutationContext context = studioBlockMutationContext(block); - return context != null && context.immutable(); - } - - private boolean isPreviewBlock(Block block) { - if (block == null) { - return false; - } - ActiveStudio studio = studios.get(block.getWorld().getUID()); - if (studio == null) { - return false; - } - UUID requestId = studio.generator().getRequest().requestId(); - return previewRenderer.contains(requestId, block.getX(), block.getY(), block.getZ()); - } - - private boolean isControlChest(Block block) { - if (block == null || block.getType() != Material.CHEST) { - return false; - } - ActiveStudio studio = studios.get(block.getWorld().getUID()); - if (studio == null) { - return false; - } - JigsawStudioControlPosition control = studio.generator().getLayout().controlPosition(); - return block.getX() == control.worldX() - && block.getY() == control.worldY() - && block.getZ() == control.worldZ(); - } - - private static JigsawStudioBoardState boardState( - ActiveStudio studio, - JigsawStudioSession session, - JigsawStudioBay workcell, - JigsawStudioVariant variant - ) { - if (workcell == null) { - return JigsawStudioBoardState.SAVED; - } - JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcell.stableId()); - if (snapshot.switchInProgress()) { - return JigsawStudioBoardState.LOADING; - } - if (snapshot.saveInProgress()) { - return JigsawStudioBoardState.SAVING; - } - if (!workcell.enabled()) { - return JigsawStudioBoardState.DISABLED; - } - if (variant != null && !variant.owned()) { - return JigsawStudioBoardState.READ_ONLY; - } - BayReadiness readiness = studio.population(workcell).readiness(); - if (!readiness.failure().isEmpty()) { - return JigsawStudioBoardState.INVALID; - } - return snapshot.dirty() ? JigsawStudioBoardState.UNSAVED : JigsawStudioBoardState.SAVED; - } - - private static String displayKey(String resourceKey) { - int separator = resourceKey.lastIndexOf('/'); - return separator < 0 ? resourceKey : resourceKey.substring(separator + 1); - } - - private static boolean sameBlockPosition(Location first, Location second) { + static boolean sameBlockPosition(Location first, Location second) { if (first == null || second == null || first.getWorld() == null || second.getWorld() == null) { return false; } @@ -7466,299 +347,7 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA && first.getBlockZ() == second.getBlockZ(); } - private void ensureVisualizationLoop(Player player) { - if (player == null) { - return; - } - if (!J.isOwnedByCurrentRegion(player)) { - J.runEntity(player, () -> ensureVisualizationLoop(player)); - return; - } - UUID playerId = player.getUniqueId(); - if (!enabled || particlesDisabled.contains(playerId) - || !studios.containsKey(player.getWorld().getUID()) - || !visualizationLoops.add(playerId)) { - return; - } - visualizationTick(player); - } - - private void visualizationTick(Player player) { - UUID playerId = player.getUniqueId(); - if (!enabled || particlesDisabled.contains(playerId)) { - visualizationLoops.remove(playerId); - return; - } - ActiveStudio studio = studios.get(player.getWorld().getUID()); - if (studio == null) { - visualizationLoops.remove(playerId); - return; - } - try { - renderVisualization(player, studio); - } catch (Throwable exception) { - visualizationLoops.remove(playerId); - IrisLogging.reportError(exception); - return; - } - boolean scheduled = J.runEntity( - player, - () -> visualizationTick(player), - VISUAL_INTERVAL_TICKS, - () -> visualizationLoops.remove(playerId)); - if (!scheduled) { - visualizationLoops.remove(playerId); - } - } - - private void renderVisualization(Player player, ActiveStudio studio) { - JigsawStudioSession session = studio.generator().getSession(); - JigsawStudioLayout layout = session.layout(); - Location playerLocation = player.getLocation(); - JigsawStudioBay focused = layout.findAt( - playerLocation.getBlockX(), - playerLocation.getBlockY(), - playerLocation.getBlockZ()); - ParticleBudget budget = new ParticleBudget(PARTICLE_BUDGET); - if (focused != null) { - Color focusedColor = bayValid(studio, focused) ? SELECTED_COLOR : INVALID_BAY_COLOR; - drawConnectors(player, playerLocation, studio, focused, budget); - drawBounds(player, playerLocation, focused.bounds(), focusedColor, 1.15F, 1.0D, budget); - } - drawLivePreview(player, playerLocation, studio, budget); - drawAssemblyPreview(player, playerLocation, budget); - for (JigsawStudioBay bay : layout.bays()) { - if (bay == focused || !isNearby(playerLocation, bay.bounds())) { - continue; - } - Color nearbyColor = bayValid(studio, bay) ? NEARBY_COLOR : INVALID_BAY_COLOR; - drawBounds(player, playerLocation, bay.bounds(), nearbyColor, 0.55F, 4.0D, budget); - if (budget.empty()) { - return; - } - } - } - - private void drawLivePreview( - Player player, - Location playerLocation, - ActiveStudio studio, - ParticleBudget budget - ) { - UUID requestId = studio.generator().getRequest().requestId(); - JigsawStudioGraphEvaluation evaluation = evaluations.get(requestId); - if (evaluation == null || evaluation.previewBounds().isEmpty()) { - return; - } - JigsawStudioPreviewRenderer.PreviewBounds preview = evaluation.previewBounds(); - Color color = switch (evaluation.state()) { - case VALID -> ASSEMBLY_PREVIEW_COLOR; - case PENDING, WARNING, STALE -> LIVE_PREVIEW_WARNING_COLOR; - case INVALID -> INVALID_BAY_COLOR; - }; - drawBounds( - player, - playerLocation, - preview, - color, - 0.85F, - 2.0D, - budget); - } - - private void drawAssemblyPreview( - Player player, - Location playerLocation, - ParticleBudget budget - ) { - AssemblyPreview preview = assemblyPreviews.get(player.getUniqueId()); - if (preview == null) { - return; - } - if (!preview.worldId().equals(player.getWorld().getUID()) - || preview.expiresAtMillis() < System.currentTimeMillis()) { - assemblyPreviews.remove(player.getUniqueId(), preview); - return; - } - for (JigsawStudioPreviewRenderer.PreviewBounds bounds : preview.bounds()) { - drawBounds(player, playerLocation, bounds, ASSEMBLY_PREVIEW_COLOR, 0.85F, 2.0D, budget); - if (budget.empty()) { - return; - } - } - } - - private static void drawConnectors( - Player player, - Location playerLocation, - ActiveStudio studio, - JigsawStudioBay bay, - ParticleBudget budget - ) { - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); - if (!rendered.valid()) { - return; - } - for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { - IrisJigsawConnector connector = renderedConnector.connector(); - IrisDirection direction = connector.getDirection(); - drawConnectorLine( - player, - playerLocation, - bay.bounds().originX() + renderedConnector.x() + 0.5D, - bay.bounds().originY() + renderedConnector.y() + 0.5D, - bay.bounds().originZ() + renderedConnector.z() + 0.5D, - direction, - connectorColor(connector), - budget); - if (budget.empty()) { - return; - } - } - } - - private static void drawConnectorLine( - Player player, - Location playerLocation, - double startX, - double startY, - double startZ, - IrisDirection direction, - Color color, - ParticleBudget budget - ) { - drawLine( - player, - playerLocation, - startX, - startY, - startZ, - startX + direction.x() * 1.75D, - startY + direction.y() * 1.75D, - startZ + direction.z() * 1.75D, - color, - 1.05F, - 0.35D, - budget); - } - - private static boolean bayValid(ActiveStudio studio, JigsawStudioBay bay) { - JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); - return rendered.valid() && studio.population(bay).readiness().failure().isEmpty(); - } - - private static Color connectorColor(IrisJigsawConnector connector) { - if (connector.getPool() == null || connector.getPool().isBlank() - || connector.getName() == null || connector.getName().isBlank() - || connector.getTargetName() == null || connector.getTargetName().isBlank()) { - return INVALID_CONNECTOR_COLOR; - } - String channel = connector.getChannel(); - if (channel == null || channel.isBlank()) { - return VALID_CONNECTOR_COLOR; - } - int hash = channel.toLowerCase(Locale.ROOT).hashCode(); - int red = 80 + (hash & 127); - int green = 80 + ((hash >>> 8) & 127); - int blue = 80 + ((hash >>> 16) & 127); - return Color.fromRGB(red, green, blue); - } - - private static void drawBounds( - Player player, - Location playerLocation, - JigsawStudioBounds bounds, - Color color, - float size, - double step, - ParticleBudget budget - ) { - drawBounds(player, playerLocation, new JigsawStudioPreviewRenderer.PreviewBounds( - bounds.originX(), bounds.originY(), bounds.originZ(), bounds.maxX(), bounds.maxY(), bounds.maxZ()), - color, size, step, budget); - } - - private static void drawBounds( - Player player, - Location playerLocation, - JigsawStudioPreviewRenderer.PreviewBounds bounds, - Color color, - float size, - double step, - ParticleBudget budget - ) { - double minX = bounds.minimumX(); - double minY = bounds.minimumY(); - double minZ = bounds.minimumZ(); - double maxX = bounds.maximumX() + 1.0D; - double maxY = bounds.maximumY() + 1.0D; - double maxZ = bounds.maximumZ() + 1.0D; - drawLine(player, playerLocation, minX, minY, minZ, maxX, minY, minZ, color, size, step, budget); - drawLine(player, playerLocation, minX, minY, maxZ, maxX, minY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, minX, maxY, minZ, maxX, maxY, minZ, color, size, step, budget); - drawLine(player, playerLocation, minX, maxY, maxZ, maxX, maxY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, minX, minY, minZ, minX, maxY, minZ, color, size, step, budget); - drawLine(player, playerLocation, maxX, minY, minZ, maxX, maxY, minZ, color, size, step, budget); - drawLine(player, playerLocation, minX, minY, maxZ, minX, maxY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, maxX, minY, maxZ, maxX, maxY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, minX, minY, minZ, minX, minY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, maxX, minY, minZ, maxX, minY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, minX, maxY, minZ, minX, maxY, maxZ, color, size, step, budget); - drawLine(player, playerLocation, maxX, maxY, minZ, maxX, maxY, maxZ, color, size, step, budget); - } - - private static void drawLine( - Player player, - Location playerLocation, - double startX, - double startY, - double startZ, - double endX, - double endY, - double endZ, - Color color, - float size, - double step, - ParticleBudget budget - ) { - if (budget.empty()) { - return; - } - double deltaX = endX - startX; - double deltaY = endY - startY; - double deltaZ = endZ - startZ; - double length = Math.sqrt(deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ); - int samples = Math.max(1, (int) Math.ceil(length / step)); - Particle.DustOptions dust = new Particle.DustOptions(color, size); - for (int index = 0; index <= samples; index++) { - double progress = (double) index / samples; - double x = startX + deltaX * progress; - double y = startY + deltaY * progress; - double z = startZ + deltaZ * progress; - double distanceX = playerLocation.getX() - x; - double distanceY = playerLocation.getY() - y; - double distanceZ = playerLocation.getZ() - z; - if (distanceX * distanceX + distanceY * distanceY + distanceZ * distanceZ > VISUAL_RANGE_SQUARED) { - continue; - } - if (!budget.consume()) { - return; - } - player.spawnParticle(Particle.DUST, x, y, z, 1, 0.0D, 0.0D, 0.0D, 0.0D, dust); - } - } - - private static boolean isNearby(Location location, JigsawStudioBounds bounds) { - double centerX = bounds.originX() + bounds.dimensions().width() / 2.0D; - double centerY = bounds.originY() + bounds.dimensions().height() / 2.0D; - double centerZ = bounds.originZ() + bounds.dimensions().depth() / 2.0D; - double deltaX = location.getX() - centerX; - double deltaY = location.getY() - centerY; - double deltaZ = location.getZ() - centerZ; - return deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ <= VISUAL_RANGE_SQUARED; - } - - private static JigsawStudioBay findBay(JigsawStudioLayout layout, String requested) { + static JigsawStudioBay findBay(JigsawStudioLayout layout, String requested) { String key = requested.trim(); JigsawStudioBay exact = layout.get(key); if (exact != null) { @@ -7802,12 +391,12 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA return "Jigsaw Studio atomic save failed: " + detail; } - private static String failureMessage(Throwable exception) { + static String failureMessage(Throwable exception) { String message = exception.getMessage(); return message == null || message.isBlank() ? exception.getClass().getSimpleName() : message; } - private static void message(Player player, String text) { + static void message(Player player, String text) { if (player != null) { J.runEntity(player, () -> ComponentMessenger.sendLiteral(player, "[Iris Jigsaw Studio] " + text)); } @@ -7823,25 +412,281 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA } } - private static void report(Player player, boolean enabled, String text) { + static void report(Player player, boolean enabled, String text) { if (enabled) { message(player, text); } } - private record StudioBlockMutationContext( - ActiveStudio studio, - UUID requestId, - UUID ownerId, - boolean immutable - ) { - private StudioBlockMutationContext { - Objects.requireNonNull(studio, "Jigsaw Studio block mutation studio"); - Objects.requireNonNull(requestId, "Jigsaw Studio block mutation request ID"); - } + public void quiesceForServerShutdown() { + registry.quiesceForServerShutdown(); } - private record ActiveStudio( + public void register(Engine engine, JigsawStudioGenerator generator) { + registry.register(engine, generator); + } + + public void activationCommitted(World world, UUID requestId) { + registry.activationCommitted(world, requestId); + } + + public void markChunkGenerated( + Engine engine, + JigsawStudioGenerator generator, + int chunkX, + int chunkZ + ) { + registry.markChunkGenerated(engine, generator, chunkX, chunkZ); + } + + public void unregister(World world) { + registry.unregister(world); + } + + public CloseStart tryBeginClose(UUID requestId, UUID ownerId, boolean discard) { + return saveLifecycle.tryBeginClose(requestId, ownerId, discard); + } + + public String closeProtectionFailure(UUID requestId) { + return saveLifecycle.closeProtectionFailure(requestId); + } + + public CompletableFuture awaitCloseForReplacement(UUID requestId, UUID ownerId) { + return saveLifecycle.awaitCloseForReplacement(requestId, ownerId); + } + + public void cancelClose(UUID requestId) { + saveLifecycle.cancelClose(requestId); + } + + public ExportStart tryBeginExport(UUID requestId, UUID ownerId) { + return saveLifecycle.tryBeginExport(requestId, ownerId); + } + + public void finishExport(UUID requestId) { + saveLifecycle.finishExport(requestId); + } + + public boolean saveSelected(Player player) { + return saveLifecycle.saveSelected(player); + } + + public boolean saveBay(Player player, String bayId) { + return saveLifecycle.saveBay(player, bayId); + } + + public boolean switchVariant( + Player player, + String workcellId, + String targetPieceKey, + boolean discardDirty + ) { + return variantEditor.switchVariant(player, workcellId, targetPieceKey, discardDirty); + } + + public boolean createVariant( + Player player, + String workcellId, + boolean duplicateActive + ) { + return variantEditor.createVariant(player, workcellId, duplicateActive); + } + + @Override + public boolean duplicateActiveFamily(Player player, String themeKey) { + return variantEditor.duplicateActiveFamily(player, themeKey); + } + + @Override + public boolean deleteVariant(Player player, String workcellId, String pieceKey) { + return variantEditor.deleteVariant(player, workcellId, pieceKey); + } + + public boolean deleteProject(Player player) { + return variantEditor.deleteProject(player); + } + + @Override + public boolean unlinkVariantMembership( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex + ) { + return variantEditor.unlinkVariantMembership(player, workcellId, pieceKey, poolKey, entryIndex); + } + + @Override + public boolean updateVariantThemes( + Player player, + String workcellId, + String pieceKey, + List themes + ) { + return variantProperties.updateVariantThemes(player, workcellId, pieceKey, themes); + } + + @Override + public boolean updateVariantRules( + Player player, + String workcellId, + String pieceKey, + JigsawStudioPieceRules rules + ) { + return variantProperties.updateVariantRules(player, workcellId, pieceKey, rules); + } + + public boolean toggleVariantRotatable(Player player, String workcellId) { + return variantProperties.toggleVariantRotatable(player, workcellId); + } + + public boolean expandVariantToCell(Player player, String workcellId) { + return variantProperties.expandVariantToCell(player, workcellId); + } + + @Override + public boolean resizeVariant( + Player player, + String workcellId, + String pieceKey, + JigsawStudioCellDimensions dimensions + ) { + return variantProperties.resizeVariant(player, workcellId, pieceKey, dimensions); + } + + @Override + public boolean updateVariantDisplayName( + Player player, + String workcellId, + String pieceKey, + String displayName + ) { + return variantProperties.updateVariantDisplayName(player, workcellId, pieceKey, displayName); + } + + @Override + public boolean adjustVariantWeight( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int delta + ) { + return variantProperties.adjustVariantWeight(player, workcellId, pieceKey, poolKey, entryIndex, delta); + } + + @Override + public boolean adjustVariantChance( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int deltaPercentagePoints + ) { + return variantProperties.adjustVariantChance( + player, workcellId, pieceKey, poolKey, entryIndex, deltaPercentagePoints); + } + + @Override + public boolean setConnectorBlocksVisible(Player player, String workcellId, boolean visible) { + return workcellEditor.setConnectorBlocksVisible(player, workcellId, visible); + } + + @Override + public boolean resetConnectorBlocks(Player player, String workcellId) { + return workcellEditor.resetConnectorBlocks(player, workcellId); + } + + @Override + public boolean setWorkcellEnabled(Player player, String workcellId, boolean enabled) { + return workcellEditor.setWorkcellEnabled(player, workcellId, enabled); + } + + @Override + public boolean updateWorkcellDimensions( + Player player, + String workcellId, + JigsawStudioCellDimensions dimensions + ) { + return workcellEditor.updateWorkcellDimensions(player, workcellId, dimensions); + } + + @Override + public boolean setRequireCaps(Player player, boolean requireCaps) { + return workcellEditor.setRequireCaps(player, requireCaps); + } + + @Override + public boolean updateThemeSetWeight(Player player, String themeKey, int weight) { + return workcellEditor.updateThemeSetWeight(player, themeKey, weight); + } + + @Override + public boolean updateWorkcellDisplayName( + Player player, + String workcellId, + String displayName + ) { + return workcellEditor.updateWorkcellDisplayName(player, workcellId, displayName); + } + + public Optional menuState(Player player) { + return toolbelt.menuState(player); + } + + public boolean selectWorkcell(Player player, String workcellId) { + return toolbelt.selectWorkcell(player, workcellId); + } + + public boolean openControlMenu(Player player) { + return toolbelt.openControlMenu(player); + } + + public void closeMenu(Player player) { + toolbelt.closeMenu(player); + } + + public boolean runCommandGraphMutation( + Player player, + UUID expectedRequestId, + CommandGraphMutation task + ) { + return graphMutations.runCommandGraphMutation(player, expectedRequestId, task); + } + + public boolean markDirty(World world, int worldX, int worldY, int worldZ) { + return dirtyTracker.markDirty(world, worldX, worldY, worldZ); + } + + public int markAllDirty(World world) { + return dirtyTracker.markAllDirty(world); + } + + @Override + public boolean undoAutosave(Player player) { + return autosaveScheduler.undoAutosave(player); + } + + public boolean flushAutosave(Player player, String workcellId) { + return autosaveScheduler.flushAutosave(player, workcellId); + } + + public boolean showAssemblyPreview(Player player, List pieces) { + return visualization.showAssemblyPreview(player, pieces); + } + + public void reconcilePlayerContext(Player player, Location location) { + playerContext.reconcilePlayerContext(player, location); + } + + public void refreshWorkcellContext(UUID worldId, String workcellId) { + playerContext.refreshWorkcellContext(worldId, workcellId); + } + + record ActiveStudio( UUID worldId, World world, Engine engine, @@ -7886,386 +731,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA } } - private final class MaterializationCoordinator { - private final MaterializationWork work; - private final List areas; - private final Set candidateCompleted = new HashSet<>(); - private final Set candidateTouched = new HashSet<>(); - private final Set rollbackCompleted = new HashSet<>(); - private int candidateRemaining; - private int rollbackRemaining; - private String candidateFailure = ""; - private String rollbackFailure = ""; - private boolean rollbackStarted; - private boolean finished; - private boolean leaseReleased; - private boolean scheduledAny; - - private MaterializationCoordinator( - MaterializationWork work, - List areas - ) { - this.work = Objects.requireNonNull(work, "Jigsaw Studio materialization work"); - this.areas = List.copyOf(areas); - candidateRemaining = this.areas.size(); - } - - private MaterializationWork work() { - return work; - } - - private synchronized void markScheduled() { - scheduledAny = true; - } - - private synchronized boolean scheduledAny() { - return scheduledAny; - } - - private synchronized void markCandidateTouched(ChunkCaptureArea area) { - candidateTouched.add(chunkKey(area.chunkX(), area.chunkZ())); - } - - private void candidateComplete( - ChunkCaptureArea area, - String failure, - Throwable exception - ) { - boolean finishSuccess = false; - boolean startRollback = false; - synchronized (this) { - if (finished || rollbackStarted - || !candidateCompleted.add(chunkKey(area.chunkX(), area.chunkZ()))) { - return; - } - if (failure != null && !failure.isBlank() && candidateFailure.isEmpty()) { - candidateFailure = failure; - } - candidateRemaining--; - if (candidateRemaining == 0) { - if (candidateFailure.isEmpty()) { - finishSuccess = true; - } else { - rollbackStarted = true; - startRollback = true; - } - } - } - if (exception != null) { - IrisLogging.reportError(exception); - } - if (finishSuccess) { - finishSuccess(); - } else if (startRollback) { - scheduleRollback(); - } - } - - private void finishSuccess() { - JigsawStudioSession session = work.studio().generator().getSession(); - if (!isCurrentVariantSwitch(work) || !session.completeVariantSwitch(work.token())) { - beginLateRollback("Jigsaw Studio changed before the loaded variant could be activated."); - return; - } - if (work.connectorVisibilityChange()) { - session.setConnectorsVisible(work.workcell().stableId(), work.targetConnectorsVisible()); - } - synchronized (this) { - if (finished) { - return; - } - finished = true; - } - try { - work.studio().generator().invalidateRender(work.workcell().stableId()); - work.studio().replacePopulation(work.workcell(), work.target(), "", true); - refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); - message(work.player(), work.connectorVisibilityChange() - ? "Connector blocks are now " - + (work.targetConnectorsVisible() ? "visible." : "hidden.") - : "Loaded variant '" + work.token().targetVariant().pieceKey() - + "' into " + work.workcell().stableId() + "."); - } finally { - releaseLease(); - } - } - - private void beginLateRollback(String failure) { - synchronized (this) { - if (finished || rollbackStarted) { - return; - } - candidateFailure = failure; - rollbackStarted = true; - } - scheduleRollback(); - } - - private void scheduleRollback() { - List rollbackAreas = new ArrayList<>(); - synchronized (this) { - for (ChunkCaptureArea area : areas) { - if (candidateTouched.contains(chunkKey(area.chunkX(), area.chunkZ()))) { - rollbackAreas.add(area); - } - } - rollbackRemaining = rollbackAreas.size(); - if (rollbackRemaining == 0) { - finished = true; - } - } - if (rollbackAreas.isEmpty()) { - finishRollback(); - return; - } - for (ChunkCaptureArea area : rollbackAreas) { - boolean scheduled = J.runRegion( - work.world(), - area.chunkX(), - area.chunkZ(), - () -> materializeRollbackChunk(this, area)); - if (!scheduled) { - rollbackComplete( - area, - "Iris could not schedule rollback for workcell chunk " - + area.chunkX() + "," + area.chunkZ() + ".", - null); - } - } - } - - private void rollbackComplete( - ChunkCaptureArea area, - String failure, - Throwable exception - ) { - boolean finalizeRollback = false; - synchronized (this) { - if (finished || !rollbackStarted - || !rollbackCompleted.add(chunkKey(area.chunkX(), area.chunkZ()))) { - return; - } - if (failure != null && !failure.isBlank() && rollbackFailure.isEmpty()) { - rollbackFailure = failure; - } - rollbackRemaining--; - if (rollbackRemaining == 0) { - finished = true; - finalizeRollback = true; - } - } - if (exception != null) { - IrisLogging.reportError(exception); - } - if (finalizeRollback) { - finishRollback(); - } - } - - private void finishRollback() { - JigsawStudioSession session = work.studio().generator().getSession(); - boolean released = session.abortVariantSwitch(work.token()); - try { - work.studio().generator().invalidateRender(work.workcell().stableId()); - if (rollbackFailure.isEmpty() && released) { - work.studio().replacePopulation(work.workcell(), work.previous(), "", true); - refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); - message(work.player(), candidateFailure + " The previous variant was restored."); - return; - } - String failure = rollbackFailure.isEmpty() - ? "The previous variant could not be restored because the Studio session changed." - : rollbackFailure; - work.studio().replacePopulation(work.workcell(), work.previous(), failure, false); - refreshWorkcellContext(work.studio().worldId(), work.workcell().stableId()); - message(work.player(), candidateFailure + " Automatic rollback also failed: " + failure - + " Do not save this workcell until it is reopened."); - } finally { - releaseLease(); - } - } - - private void releaseLease() { - synchronized (this) { - if (leaseReleased) { - return; - } - leaseReleased = true; - } - finishMaterialization(work.studio().generator().getRequest().requestId()); - } - } - - private final class CaptureCoordinator { - private final CaptureWork work; - private final List areas; - private final Map snapshots = new ConcurrentHashMap<>(); - private final AtomicInteger remaining; - private final AtomicBoolean failed = new AtomicBoolean(false); - private final AtomicBoolean assemblyStarted = new AtomicBoolean(false); - private final AtomicBoolean operationFinished = new AtomicBoolean(false); - private volatile AutosavePersistentFailure persistentFailure; - - private CaptureCoordinator(CaptureWork work, List areas) { - this.work = Objects.requireNonNull(work, "Jigsaw Studio capture work"); - this.areas = List.copyOf(areas); - this.remaining = new AtomicInteger(this.areas.size()); - } - - private ActiveStudio studio() { - return work.studio(); - } - - private World world() { - return work.world(); - } - - private JigsawStudioBay bay() { - return work.bay(); - } - - private CaptureTarget captureTarget() { - return work.captureTarget(); - } - - private Player player() { - return work.player(); - } - - private UUID requestId() { - return work.requestId(); - } - - private JigsawStudioSession.SaveIdentity saveIdentity() { - return work.saveIdentity(); - } - - private List areas() { - return areas; - } - - private boolean stopped() { - return failed.get(); - } - - private boolean failed() { - return failed.get(); - } - - private void accept(ChunkSnapshot snapshot) { - if (failed.get() || assemblyStarted.get()) { - return; - } - ChunkCaptureArea area = snapshot.area(); - long key = chunkKey(area.chunkX(), area.chunkZ()); - if (snapshots.putIfAbsent(key, snapshot) != null) { - fail("Jigsaw Studio received duplicate snapshot for bay chunk " - + area.chunkX() + "," + area.chunkZ() + ".", null); - return; - } - int incomplete = remaining.decrementAndGet(); - if (incomplete < 0) { - fail("Jigsaw Studio received more bay chunk snapshots than expected.", null); - return; - } - if (incomplete == 0 && assemblyStarted.compareAndSet(false, true)) { - List completed = List.copyOf(snapshots.values()); - J.a(() -> assembleAndPersist(this, completed)); - } - } - - private void fail(String failure, Throwable exception) { - if (!failed.compareAndSet(false, true)) { - return; - } - if (exception != null) { - IrisLogging.reportError(exception); - } - complete(); - message(player(), failure); - } - - private void failPersistent(String failure, Throwable exception) { - if (!failed.compareAndSet(false, true)) { - return; - } - recordPersistentFailure(failure, exception); - complete(); - message(player(), failure); - } - - private void recordPersistentFailure(String failure, Throwable exception) { - persistentFailure = new AutosavePersistentFailure(failure, exception); - } - - private void complete() { - if (operationFinished.compareAndSet(false, true)) { - studio().generator().getSession().abortSave(saveIdentity()); - finishSave(requestId()); - completeAutosaveAttempt( - studio(), - saveIdentity(), - work.autosaveFailureState(), - persistentFailure); - refreshWorkcellContext(studio().worldId(), saveIdentity().workcellId()); - } - } - } - - private record CaptureWork( - ActiveStudio studio, - World world, - JigsawStudioBay bay, - CaptureTarget captureTarget, - Player player, - UUID requestId, - JigsawStudioSession.SaveIdentity saveIdentity, - AutosaveFailureState autosaveFailureState - ) { - CaptureWork { - Objects.requireNonNull(studio, "Jigsaw Studio capture studio"); - Objects.requireNonNull(world, "Jigsaw Studio capture world"); - Objects.requireNonNull(bay, "Jigsaw Studio capture bay"); - Objects.requireNonNull(captureTarget, "Jigsaw Studio capture target"); - Objects.requireNonNull(requestId, "Jigsaw Studio capture request ID"); - Objects.requireNonNull(saveIdentity, "Jigsaw Studio capture save identity"); - Objects.requireNonNull(autosaveFailureState, "Jigsaw Studio capture autosave failure state"); - } - } - - private record EvaluationComputation( - JigsawStudioGraphEvaluation evaluation, - JigsawStudioPreviewRenderer.PreviewPlan plan - ) { - private EvaluationComputation { - Objects.requireNonNull(evaluation, "Jigsaw Studio graph evaluation"); - Objects.requireNonNull(plan, "Jigsaw Studio evaluation preview plan"); - } - } - - private record MaterializationWork( - ActiveStudio studio, - World world, - Player player, - JigsawStudioBay workcell, - JigsawStudioSession.VariantSwitchToken token, - JigsawStudioGenerator.RenderedBay previous, - JigsawStudioGenerator.RenderedBay target, - boolean previousConnectorsVisible, - boolean targetConnectorsVisible, - boolean connectorVisibilityChange - ) { - MaterializationWork { - Objects.requireNonNull(studio, "Jigsaw Studio materialization studio"); - Objects.requireNonNull(world, "Jigsaw Studio materialization world"); - Objects.requireNonNull(player, "Jigsaw Studio materialization player"); - Objects.requireNonNull(workcell, "Jigsaw Studio materialization workcell"); - Objects.requireNonNull(token, "Jigsaw Studio materialization token"); - Objects.requireNonNull(previous, "Jigsaw Studio previous rendered variant"); - Objects.requireNonNull(target, "Jigsaw Studio target rendered variant"); - } - } - @FunctionalInterface public interface CommandGraphMutation { CommandGraphMutationResult run() throws IOException; @@ -8311,112 +776,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA } } - public record VariantReloadRequest( - String workcellId, - JigsawStudioGenerator.RenderedBay previous - ) { - public VariantReloadRequest { - workcellId = workcellId == null ? "" : workcellId.trim(); - if (workcellId.isEmpty()) { - throw new IllegalArgumentException("Jigsaw Studio reload workcell ID cannot be blank"); - } - Objects.requireNonNull(previous, "Jigsaw Studio previous rendered variant"); - } - } - - static final class BayPopulation { - private final Set requiredChunks; - private final Set generatedChunks = ConcurrentHashMap.newKeySet(); - private final Set appliedChunks = ConcurrentHashMap.newKeySet(); - private final Set hydratedChunks = ConcurrentHashMap.newKeySet(); - private volatile String failure; - - BayPopulation(Set requiredChunks, String failure) { - this.requiredChunks = Set.copyOf(requiredChunks); - this.failure = failure == null ? "" : failure; - } - - boolean markGenerated(long chunk) { - if (!requiredChunks.contains(chunk)) { - return false; - } - generatedChunks.add(chunk); - return !hydratedChunks.contains(chunk) && failure.isEmpty(); - } - - boolean needsApplication(long chunk) { - return failure.isEmpty() - && requiredChunks.contains(chunk) - && generatedChunks.contains(chunk) - && !appliedChunks.contains(chunk); - } - - boolean needsVerification(long chunk) { - return failure.isEmpty() - && requiredChunks.contains(chunk) - && generatedChunks.contains(chunk) - && appliedChunks.contains(chunk) - && !hydratedChunks.contains(chunk); - } - - void markApplied(long chunk) { - if (requiredChunks.contains(chunk)) { - appliedChunks.add(chunk); - } - } - - void markHydrated(long chunk) { - if (requiredChunks.contains(chunk)) { - hydratedChunks.add(chunk); - } - } - - void markFullyReady() { - generatedChunks.addAll(requiredChunks); - appliedChunks.addAll(requiredChunks); - hydratedChunks.addAll(requiredChunks); - } - - synchronized boolean fail(String reason) { - if (!failure.isEmpty()) { - return false; - } - failure = reason == null || reason.isBlank() ? "unknown hydration failure" : reason; - return true; - } - - BayReadiness readiness() { - boolean ready = failure.isEmpty() - && !requiredChunks.isEmpty() - && generatedChunks.containsAll(requiredChunks) - && hydratedChunks.containsAll(requiredChunks); - return new BayReadiness( - ready, - failure, - requiredChunks.size(), - generatedChunks.size(), - hydratedChunks.size()); - } - } - - record BayReadiness( - boolean ready, - String failure, - int requiredChunks, - int generatedChunks, - int hydratedChunks - ) { - } - - enum SaveStart { - STARTED, - IN_PROGRESS, - CLOSING, - GRAPH_OPERATION, - EXPORT_OPERATION, - VARIANT_OPERATION - } - public enum ExportStart { STARTED, NOT_ACTIVE, @@ -8428,25 +787,6 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA IN_PROGRESS } - private enum SaveAttempt { - STARTED, - RETRY, - DEFERRED, - PERSISTENT_FAILURE - } - - enum DeferredDuplicationReadiness { - READY, - WAITING_FOR_AUTOSAVE, - WAITING_FOR_OPERATION, - STALE - } - - private enum DeferredDuplicationKind { - SINGLE, - FAMILY - } - public enum CloseStart { STARTED, NOT_ACTIVE, @@ -8456,380 +796,4 @@ public final class JigsawStudioService implements IrisService, JigsawStudioMenuA OPERATION_IN_PROGRESS } - private record CaptureTarget( - JigsawStudioBounds bounds, - IrisJigsawPiece piece, - IrisObject object, - int displayRotationQuarterTurns, - boolean connectorsVisible - ) { - CaptureTarget { - Objects.requireNonNull(bounds, "Jigsaw Studio capture bounds"); - Objects.requireNonNull(piece, "Jigsaw Studio capture piece"); - Objects.requireNonNull(object, "Jigsaw Studio capture object"); - displayRotationQuarterTurns = Math.floorMod(displayRotationQuarterTurns, 4); - } - } - - private record AutosaveKey(UUID requestId, String workcellId) { - private AutosaveKey { - Objects.requireNonNull(requestId, "Jigsaw Studio autosave request ID"); - Objects.requireNonNull(workcellId, "Jigsaw Studio autosave workcell ID"); - } - } - - private record JigsawTileWatchKey( - UUID requestId, - UUID worldId, - int worldX, - int worldY, - int worldZ - ) { - private JigsawTileWatchKey { - Objects.requireNonNull(requestId, "Jigsaw Studio tile watch request ID"); - Objects.requireNonNull(worldId, "Jigsaw Studio tile watch world ID"); - } - } - - record JigsawTilePollDecision(boolean changed, boolean continueWatching) { - } - - private record JigsawTileWatch( - JigsawTileWatchKey key, - ActiveStudio studio, - UUID playerId, - String workcellId, - KMap snapshot, - AtomicBoolean scheduleFailureLogged, - AtomicBoolean reconciliationScheduled - ) { - private JigsawTileWatch { - Objects.requireNonNull(key, "Jigsaw Studio tile watch key"); - Objects.requireNonNull(studio, "Jigsaw Studio tile watch studio"); - Objects.requireNonNull(playerId, "Jigsaw Studio tile watch player ID"); - Objects.requireNonNull(workcellId, "Jigsaw Studio tile watch workcell ID"); - Objects.requireNonNull(snapshot, "Jigsaw Studio tile watch snapshot"); - Objects.requireNonNull(scheduleFailureLogged, "Jigsaw Studio tile watch schedule warning state"); - Objects.requireNonNull(reconciliationScheduled, "Jigsaw Studio tile watch retry schedule state"); - } - } - - static final class AutosaveFailureState { - private final AtomicInteger persistentFailures = new AtomicInteger(); - private final AtomicBoolean failureLogged = new AtomicBoolean(false); - - AutosaveFailureDecision recordPersistentFailure() { - int failureCount = persistentFailures.incrementAndGet(); - return new AutosaveFailureDecision( - persistentAutosaveRetryTicks(failureCount), - failureLogged.compareAndSet(false, true)); - } - } - - record AutosaveFailureDecision(int retryTicks, boolean logFailure) { - } - - private record AutosavePersistentFailure(String detail, Throwable cause) { - private AutosavePersistentFailure { - Objects.requireNonNull(detail, "Jigsaw Studio persistent autosave failure detail"); - } - } - - private record AutosaveTicket( - AutosaveKey key, - ActiveStudio studio, - JigsawStudioSession.DirtyIdentity identity, - AtomicBoolean scheduled, - AtomicBoolean scheduleFailureLogged, - AutosaveFailureState failureState - ) { - private AutosaveTicket( - AutosaveKey key, - ActiveStudio studio, - JigsawStudioSession.DirtyIdentity identity, - AtomicBoolean scheduled, - AtomicBoolean scheduleFailureLogged - ) { - this( - key, - studio, - identity, - scheduled, - scheduleFailureLogged, - new AutosaveFailureState()); - } - - private AutosaveTicket { - Objects.requireNonNull(key, "Jigsaw Studio autosave key"); - Objects.requireNonNull(studio, "Jigsaw Studio autosave studio"); - Objects.requireNonNull(identity, "Jigsaw Studio autosave dirty identity"); - Objects.requireNonNull(scheduled, "Jigsaw Studio autosave schedule state"); - Objects.requireNonNull(scheduleFailureLogged, "Jigsaw Studio autosave schedule warning state"); - Objects.requireNonNull(failureState, "Jigsaw Studio autosave failure state"); - } - } - - private record DeferredDuplication( - UUID requestId, - UUID sessionId, - UUID playerId, - UUID worldId, - DeferredDuplicationKind kind, - String workcellId, - Map sourcePieces, - String themeKey, - AtomicBoolean scheduled - ) { - private DeferredDuplication { - Objects.requireNonNull(requestId, "Jigsaw Studio deferred duplicate request ID"); - Objects.requireNonNull(sessionId, "Jigsaw Studio deferred duplicate session ID"); - Objects.requireNonNull(playerId, "Jigsaw Studio deferred duplicate player ID"); - Objects.requireNonNull(worldId, "Jigsaw Studio deferred duplicate world ID"); - Objects.requireNonNull(kind, "Jigsaw Studio deferred duplicate kind"); - workcellId = workcellId == null ? "" : workcellId; - sourcePieces = Map.copyOf(Objects.requireNonNull( - sourcePieces, - "Jigsaw Studio deferred duplicate source pieces")); - themeKey = themeKey == null ? "" : themeKey; - Objects.requireNonNull(scheduled, "Jigsaw Studio deferred duplicate schedule state"); - if (sourcePieces.isEmpty()) { - throw new IllegalArgumentException("A deferred duplicate requires at least one source variant"); - } - if (kind == DeferredDuplicationKind.SINGLE && workcellId.isBlank()) { - throw new IllegalArgumentException("A deferred single duplicate requires a workcell"); - } - if (kind == DeferredDuplicationKind.FAMILY && themeKey.isBlank()) { - throw new IllegalArgumentException("A deferred family duplicate requires a theme key"); - } - } - - private static DeferredDuplication single( - UUID requestId, - UUID sessionId, - Player player, - UUID worldId, - String workcellId, - String sourcePiece - ) { - return new DeferredDuplication( - requestId, - sessionId, - player.getUniqueId(), - worldId, - DeferredDuplicationKind.SINGLE, - workcellId, - Map.of(workcellId, sourcePiece), - "", - new AtomicBoolean()); - } - - private static DeferredDuplication family( - UUID requestId, - UUID sessionId, - Player player, - UUID worldId, - Map sourcePieces, - String themeKey - ) { - return new DeferredDuplication( - requestId, - sessionId, - player.getUniqueId(), - worldId, - DeferredDuplicationKind.FAMILY, - "", - sourcePieces, - themeKey, - new AtomicBoolean()); - } - - private boolean sameIntent(DeferredDuplication other) { - return other != null - && playerId.equals(other.playerId) - && kind == other.kind - && workcellId.equals(other.workcellId) - && sourcePieces.equals(other.sourcePieces) - && themeKey.equals(other.themeKey); - } - } - - private record ToolConfirmation(JigsawStudioToolPayload payload, long expiresAtNanos) { - private ToolConfirmation { - Objects.requireNonNull(payload, "Jigsaw Studio tool confirmation payload"); - } - } - - private record AssemblyPreview( - UUID worldId, - long expiresAtMillis, - List bounds - ) { - AssemblyPreview { - Objects.requireNonNull(worldId, "Jigsaw Studio preview world"); - bounds = List.copyOf(bounds); - } - } - - private record PlayerWorkcellContext( - UUID worldId, - UUID requestId, - String workcellId - ) { - PlayerWorkcellContext { - Objects.requireNonNull(worldId, "Jigsaw Studio player-context world ID"); - Objects.requireNonNull(requestId, "Jigsaw Studio player-context request ID"); - workcellId = workcellId == null ? "" : workcellId; - } - } - - record ChunkCaptureArea( - int chunkX, - int chunkZ, - int minimumX, - int maximumX, - int minimumZ, - int maximumZ - ) { - ChunkCaptureArea { - if (minimumX < 0 || minimumZ < 0 || maximumX <= minimumX || maximumZ <= minimumZ) { - throw new IllegalArgumentException("Jigsaw Studio chunk capture intersection is invalid"); - } - } - - boolean contains(int x, int z) { - return x >= minimumX && x < maximumX && z >= minimumZ && z < maximumZ; - } - } - - record CapturedBlock( - int x, - int y, - int z, - PlatformBlockState state, - TileData tileData - ) { - CapturedBlock { - Objects.requireNonNull(state, "Jigsaw Studio captured block state"); - tileData = tileData == null ? null : tileData.clone(); - } - - @Override - public TileData tileData() { - return tileData == null ? null : tileData.clone(); - } - } - - record CapturedConnector( - int x, - int y, - int z, - IrisDirection direction, - IrisDirection top, - String pool, - String name, - String targetName, - String channel, - JigsawJoint joint, - String finalState, - int selectionPriority, - int placementPriority - ) { - CapturedConnector { - Objects.requireNonNull(direction, "Jigsaw Studio captured connector direction"); - Objects.requireNonNull(top, "Jigsaw Studio captured connector top"); - Objects.requireNonNull(pool, "Jigsaw Studio captured connector pool"); - Objects.requireNonNull(name, "Jigsaw Studio captured connector name"); - Objects.requireNonNull(targetName, "Jigsaw Studio captured connector target"); - channel = channel == null ? "" : channel; - Objects.requireNonNull(joint, "Jigsaw Studio captured connector joint"); - Objects.requireNonNull(finalState, "Jigsaw Studio captured connector final state"); - } - - static CapturedConnector from(IrisJigsawConnector connector) { - IrisJigsawConnector source = Objects.requireNonNull(connector, "Jigsaw Studio captured connector"); - IrisPosition position = source.getPosition(); - return new CapturedConnector( - position.getX(), - position.getY(), - position.getZ(), - source.getDirection(), - source.getTop(), - source.getPool(), - source.getName(), - source.getTargetName(), - source.getChannel(), - source.getJoint(), - source.getFinalState(), - source.getSelectionPriority(), - source.getPlacementPriority()); - } - - IrisJigsawConnector toConnector() { - return new IrisJigsawConnector() - .setPosition(new IrisPosition(x, y, z)) - .setDirection(direction) - .setTop(top) - .setPool(pool) - .setName(name) - .setTargetName(targetName) - .setChannel(channel) - .setJoint(joint) - .setFinalState(finalState) - .setSelectionPriority(selectionPriority) - .setPlacementPriority(placementPriority); - } - } - - record ChunkSnapshot( - ChunkCaptureArea area, - List blocks, - List connectors - ) { - ChunkSnapshot { - Objects.requireNonNull(area, "Jigsaw Studio captured chunk area"); - blocks = List.copyOf(blocks); - connectors = List.copyOf(connectors); - } - } - - record LocalPosition(int x, int y, int z) { - } - - record Capture(byte[] objectContent, List connectors, boolean hasBlockEntities) { - Capture { - objectContent = Objects.requireNonNull(objectContent, "Jigsaw Studio object content").clone(); - connectors = List.copyOf(connectors); - } - - @Override - public byte[] objectContent() { - return objectContent.clone(); - } - } - - static final class WorkcellTopologyException extends IOException { - WorkcellTopologyException(String message) { - super(message); - } - } - - private static final class ParticleBudget { - private int remaining; - - private ParticleBudget(int remaining) { - this.remaining = remaining; - } - - private boolean consume() { - if (remaining < 1) { - return false; - } - remaining--; - return true; - } - - private boolean empty() { - return remaining < 1; - } - } } diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioTileWatcher.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioTileWatcher.java new file mode 100644 index 000000000..7abc4c9a0 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioTileWatcher.java @@ -0,0 +1,340 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.platform.bukkit.BukkitPlatform; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import art.arcane.volmlib.util.collection.KMap; +import org.bukkit.Material; +import org.bukkit.World; +import org.bukkit.block.Block; +import org.bukkit.entity.Player; + +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicBoolean; + +import static art.arcane.iris.core.service.JigsawStudioService.AUTOSAVE_RETRY_TICKS; + +final class JigsawStudioTileWatcher { + private static final int JIGSAW_TILE_WATCH_INTERVAL_TICKS = 5; + + private final JigsawStudioService service; + final Map jigsawTileWatches = new ConcurrentHashMap<>(); + + JigsawStudioTileWatcher(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + void startJigsawTileWatch(Player player, Block block) { + if (player == null || block == null || block.getType() != Material.JIGSAW) { + return; + } + World world = block.getWorld(); + int worldX = block.getX(); + int worldY = block.getY(); + int worldZ = block.getZ(); + UUID playerId = player.getUniqueId(); + if (J.isOwnedByCurrentRegion(world, worldX >> 4, worldZ >> 4)) { + initializeJigsawTileWatch(playerId, world, worldX, worldY, worldZ); + return; + } + boolean scheduled = J.runRegion( + world, + worldX >> 4, + worldZ >> 4, + () -> initializeJigsawTileWatch(playerId, world, worldX, worldY, worldZ)); + if (!scheduled) { + IrisLogging.warn("Jigsaw Studio could not watch jigsaw marker NBT at %d,%d,%d in %s", + worldX, worldY, worldZ, world.getName()); + } + } + + private void initializeJigsawTileWatch( + UUID playerId, + World world, + int worldX, + int worldY, + int worldZ + ) { + ActiveStudio studio = service.studios.get(world.getUID()); + if (!service.enabled || studio == null) { + return; + } + Block block = world.getBlockAt(worldX, worldY, worldZ); + if (block.getType() != Material.JIGSAW) { + return; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay bay = session.layout().findAt(worldX, worldY, worldZ); + JigsawStudioVariant variant = bay == null + ? null + : session.activeVariant(bay.stableId()).orElse(null); + if (bay == null || variant == null || !variant.owned()) { + return; + } + KMap snapshot; + try { + snapshot = BukkitPlatform.serializeTile(block.getLocation()); + } catch (Throwable exception) { + IrisLogging.reportError(exception); + return; + } + if (snapshot == null) { + IrisLogging.warn("Jigsaw Studio could not read jigsaw marker NBT at %d,%d,%d in %s", + worldX, worldY, worldZ, world.getName()); + return; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + JigsawTileWatchKey key = new JigsawTileWatchKey( + request.requestId(), world.getUID(), worldX, worldY, worldZ); + JigsawTileWatch watch = new JigsawTileWatch( + key, + studio, + playerId, + bay.stableId(), + snapshot, + new AtomicBoolean(false), + new AtomicBoolean(false)); + jigsawTileWatches.put(key, watch); + scheduleJigsawTileWatch(watch); + } + + private void scheduleJigsawTileWatch(JigsawTileWatch watch) { + boolean scheduled = J.runRegion( + watch.studio().world(), + watch.key().worldX() >> 4, + watch.key().worldZ() >> 4, + () -> runJigsawTileWatch(watch, false), + JIGSAW_TILE_WATCH_INTERVAL_TICKS); + if (!scheduled && jigsawTileWatches.get(watch.key()) == watch) { + warnJigsawTileWatchScheduleFailure(watch); + scheduleJigsawTileWatchReconciliation(watch, false); + } + } + + private void runJigsawTileWatch(JigsawTileWatch watch, boolean release) { + if (jigsawTileWatches.get(watch.key()) != watch) { + return; + } + ActiveStudio studio = service.studios.get(watch.key().worldId()); + if (!service.enabled || studio != watch.studio() + || !service.isCurrentRequest(studio, watch.key().requestId())) { + jigsawTileWatches.remove(watch.key(), watch); + return; + } + Block block = studio.world().getBlockAt( + watch.key().worldX(), watch.key().worldY(), watch.key().worldZ()); + JigsawStudioBay bay = studio.generator().getSession().layout().findAt( + watch.key().worldX(), watch.key().worldY(), watch.key().worldZ()); + if (block.getType() != Material.JIGSAW + || bay == null + || !bay.stableId().equals(watch.workcellId())) { + jigsawTileWatches.remove(watch.key(), watch); + return; + } + KMap snapshot; + try { + snapshot = BukkitPlatform.serializeTile(block.getLocation()); + } catch (Throwable exception) { + jigsawTileWatches.remove(watch.key(), watch); + IrisLogging.reportError(exception); + return; + } + if (snapshot == null) { + jigsawTileWatches.remove(watch.key(), watch); + IrisLogging.warn("Jigsaw Studio stopped watching unreadable jigsaw marker NBT at %d,%d,%d in %s", + watch.key().worldX(), + watch.key().worldY(), + watch.key().worldZ(), + studio.world().getName()); + return; + } + JigsawTilePollDecision decision = jigsawTilePollDecision( + watch.snapshot(), snapshot, release); + if (decision.changed()) { + service.dirtyTracker.markDirty( + studio.world(), + watch.key().worldX(), + watch.key().worldY(), + watch.key().worldZ()); + } + if (!decision.continueWatching()) { + jigsawTileWatches.remove(watch.key(), watch); + return; + } + JigsawTileWatch next = new JigsawTileWatch( + watch.key(), + watch.studio(), + watch.playerId(), + watch.workcellId(), + snapshot, + watch.scheduleFailureLogged(), + new AtomicBoolean(false)); + if (jigsawTileWatches.replace(watch.key(), watch, next)) { + scheduleJigsawTileWatch(next); + } + } + + boolean hasJigsawTileWatch(UUID requestId) { + if (requestId == null) { + return false; + } + for (JigsawTileWatchKey key : jigsawTileWatches.keySet()) { + if (requestId.equals(key.requestId())) { + return true; + } + } + return false; + } + + void clearJigsawTileWatches(UUID requestId) { + if (requestId != null) { + jigsawTileWatches.keySet().removeIf(key -> requestId.equals(key.requestId())); + } + } + + void finalizeJigsawTileWatchesForPlayer(UUID playerId) { + if (playerId == null) { + return; + } + for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { + if (playerId.equals(watch.playerId())) { + finalizeJigsawTileWatch(watch); + } + } + } + + void finalizeJigsawTileWatches(UUID requestId) { + if (requestId == null) { + return; + } + for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { + if (requestId.equals(watch.key().requestId())) { + finalizeJigsawTileWatch(watch); + } + } + } + + void finalizeAllJigsawTileWatches() { + for (JigsawTileWatch watch : List.copyOf(jigsawTileWatches.values())) { + try { + finalizeJigsawTileWatch(watch); + } catch (Throwable exception) { + IrisLogging.reportError("Failed to finalize a Jigsaw Studio tile watch during shutdown.", exception); + } + } + } + + private void finalizeJigsawTileWatch(JigsawTileWatch watch) { + if (jigsawTileWatches.get(watch.key()) != watch) { + return; + } + World world = watch.studio().world(); + int chunkX = watch.key().worldX() >> 4; + int chunkZ = watch.key().worldZ() >> 4; + if (J.isOwnedByCurrentRegion(world, chunkX, chunkZ)) { + runJigsawTileWatch(watch, true); + return; + } + boolean scheduled = J.runRegion( + world, + chunkX, + chunkZ, + () -> runJigsawTileWatch(watch, true)); + if (!scheduled) { + warnJigsawTileWatchScheduleFailure(watch); + scheduleJigsawTileWatchReconciliation(watch, true); + } + } + + private void warnJigsawTileWatchScheduleFailure(JigsawTileWatch watch) { + if (watch.scheduleFailureLogged().compareAndSet(false, true)) { + IrisLogging.warn("Jigsaw Studio could not schedule jigsaw marker NBT at %d,%d,%d in %s; Iris will keep retrying", + watch.key().worldX(), + watch.key().worldY(), + watch.key().worldZ(), + watch.studio().world().getName()); + } + } + + private void scheduleJigsawTileWatchReconciliation(JigsawTileWatch watch, boolean release) { + if (!watch.reconciliationScheduled().compareAndSet(false, true)) { + return; + } + try { + J.s(() -> { + watch.reconciliationScheduled().set(false); + if (jigsawTileWatches.get(watch.key()) != watch) { + return; + } + if (release) { + finalizeJigsawTileWatch(watch); + } else { + scheduleJigsawTileWatch(watch); + } + }, AUTOSAVE_RETRY_TICKS); + } catch (Throwable exception) { + watch.reconciliationScheduled().set(false); + IrisLogging.reportError(exception); + } + } + + static boolean tileSnapshotChanged( + KMap previous, + KMap current + ) { + return !Objects.equals(previous, current); + } + + static JigsawTilePollDecision jigsawTilePollDecision( + KMap previous, + KMap current, + boolean release + ) { + return new JigsawTilePollDecision(tileSnapshotChanged(previous, current), !release); + } + + private record JigsawTileWatchKey( + UUID requestId, + UUID worldId, + int worldX, + int worldY, + int worldZ + ) { + private JigsawTileWatchKey { + Objects.requireNonNull(requestId, "Jigsaw Studio tile watch request ID"); + Objects.requireNonNull(worldId, "Jigsaw Studio tile watch world ID"); + } + } + + record JigsawTilePollDecision(boolean changed, boolean continueWatching) { + } + + private record JigsawTileWatch( + JigsawTileWatchKey key, + ActiveStudio studio, + UUID playerId, + String workcellId, + KMap snapshot, + AtomicBoolean scheduleFailureLogged, + AtomicBoolean reconciliationScheduled + ) { + private JigsawTileWatch { + Objects.requireNonNull(key, "Jigsaw Studio tile watch key"); + Objects.requireNonNull(studio, "Jigsaw Studio tile watch studio"); + Objects.requireNonNull(playerId, "Jigsaw Studio tile watch player ID"); + Objects.requireNonNull(workcellId, "Jigsaw Studio tile watch workcell ID"); + Objects.requireNonNull(snapshot, "Jigsaw Studio tile watch snapshot"); + Objects.requireNonNull(scheduleFailureLogged, "Jigsaw Studio tile watch schedule warning state"); + Objects.requireNonNull(reconciliationScheduled, "Jigsaw Studio tile watch retry schedule state"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolbelt.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolbelt.java new file mode 100644 index 000000000..9a81fc273 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioToolbelt.java @@ -0,0 +1,692 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolMembership; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioToolPayload; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.object.IrisJigsawThemeSet; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.Bukkit; +import org.bukkit.ChatColor; +import org.bukkit.entity.Player; +import org.bukkit.inventory.ItemStack; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.atomic.AtomicBoolean; + +import static art.arcane.iris.core.service.JigsawStudioEvaluator.loadStudioStructure; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioProtection.canToggleVariantRotation; +import static art.arcane.iris.core.service.JigsawStudioProtection.ownerMatches; +import static art.arcane.iris.core.service.JigsawStudioService.AUTOSAVE_RETRY_TICKS; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioVariantProperties.canResizeVariantToCapacity; + +final class JigsawStudioToolbelt { + private static final long TOOL_CONFIRM_NANOS = 10_000_000_000L; + + private final JigsawStudioService service; + final Map deferredDuplications = new ConcurrentHashMap<>(); + final Map toolConfirmations = new ConcurrentHashMap<>(); + final JigsawStudioToolCodec toolCodec = new JigsawStudioToolCodec(); + volatile JigsawStudioMenuController menuController; + + JigsawStudioToolbelt(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + Optional menuState(Player player) { + if (player == null || !J.isOwnedByCurrentRegion(player)) { + return Optional.empty(); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + return Optional.empty(); + } + if (!ownerMatches(player, studio)) { + return Optional.empty(); + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioLayout layout = session.layout(); + IrisStructure structure = loadStudioStructure(studio); + List themeSets = new ArrayList<>(); + if (structure != null && structure.getThemeSets() != null) { + for (IrisJigsawThemeSet themeSet : structure.getThemeSets()) { + if (themeSet != null) { + themeSets.add(new JigsawStudioMenuState.ThemeSet( + themeSet.getKey(), + themeSet.getWeight())); + } + } + } + List workcells = new ArrayList<>(layout.bays().size()); + for (JigsawStudioBay workcell : layout.bays()) { + JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcell.stableId()); + List variants = new ArrayList<>(); + for (JigsawStudioVariant variant : layout.variants(workcell)) { + boolean active = variant.pieceKey().equals(snapshot.activeVariantKey()); + List memberships = new ArrayList<>( + variant.memberships().size()); + for (JigsawStudioPoolMembership membership : variant.memberships()) { + memberships.add(new JigsawStudioMenuState.Membership( + membership.poolKey(), + membership.entryIndex(), + membership.weight(), + membership.chance())); + } + variants.add(new JigsawStudioMenuState.Variant( + variant.pieceKey(), + variant.resolvedDisplayName(), + variant.dimensions(), + active, + variant.owned(), + variant.rotatable(), + canToggleVariantRotation(request.compatibilityTarget(), variant), + canResizeVariantToCapacity(workcell, variant, active), + variant.themes(), + variant.rules(), + memberships)); + } + workcells.add(new JigsawStudioMenuState.Workcell( + workcell.stableId(), + workcell.canonicalDisplayName(), + workcell.displayName(), + workcell.capacity(), + workcell.enabled(), + snapshot.activeVariantKey(), + snapshot.dirty(), + snapshot.saveInProgress(), + snapshot.switchInProgress(), + snapshot.connectorsVisible(), + variants)); + } + + return Optional.of(new JigsawStudioMenuState( + studio.worldId(), + request.requestId(), + request.structureKey(), + layout.mode(), + request.compatibilityTarget(), + structure != null && structure.isRequireCaps(), + themeSets, + session.selectedBayId().orElse(""), + Optional.ofNullable(service.evaluator.evaluations.get(request.requestId())) + .map(JigsawStudioMenuState.Evaluation::from) + .orElseGet(JigsawStudioMenuState.Evaluation::pending), + workcells)); + } + + boolean selectWorkcell(Player player, String workcellId) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> selectWorkcell(player, workcellId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + if (!session.selectBay(workcellId)) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + service.visualization.ensureVisualizationLoop(player); + return true; + } + + boolean openControlMenu(Player player) { + if (player != null && J.isOwnedByCurrentRegion(player)) { + service.tileWatcher.finalizeJigsawTileWatchesForPlayer(player.getUniqueId()); + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null + && service.saveLifecycle.reopenRequiredRequests.contains( + studio.generator().getRequest().requestId())) { + message(player, "Close and reopen Jigsaw Studio to apply the resized workcell layout."); + return false; + } + } + JigsawStudioMenuController activeMenuController = menuController; + return activeMenuController != null && activeMenuController.open(player); + } + + void closeMenu(Player player) { + JigsawStudioMenuController activeMenuController = menuController; + if (activeMenuController != null) { + activeMenuController.close(player); + } + } + + boolean useTool( + Player player, + JigsawStudioToolPayload payload, + ItemStack tool, + boolean resetLabel + ) { + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> useTool(player, payload, tool, resetLabel)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null + || !studio.generator().getRequest().requestId().equals(payload.requestId()) + || !authorizeOwner(player, studio)) { + message(player, "This Jigsaw Studio tool is stale or belongs to another session."); + return false; + } + if (payload.action().destructive() && !confirmTool(player, payload)) { + message(player, "Right-click the same tool again within 10 seconds to confirm " + + payload.action().displayName() + "."); + return true; + } + return switch (payload.action()) { + case OPEN_MENU -> openControlMenu(player); + case SELECT_WORKCELL -> selectWorkcell(player, payload.workcellId()); + case LOAD_VARIANT -> service.variantEditor.switchVariant( + player, + payload.workcellId(), + payload.pieceKey(), + false); + case CREATE_VARIANT -> service.variantEditor.createVariant(player, payload.workcellId(), false); + case DUPLICATE_VARIANT -> service.variantEditor.createVariant(player, payload.workcellId(), true); + case DUPLICATE_FAMILY -> duplicateFamilyFromTool(player); + case PREVIEW_GRAPH -> service.goToPreview(player); + case FLUSH_AUTOSAVE -> service.autosaveScheduler.flushAutosave(player, payload.workcellId()); + case TOGGLE_ROTATION -> service.variantProperties.toggleVariantRotatable(player, payload.workcellId()); + case EXPAND_TO_CELL -> service.variantProperties.expandVariantToCell(player, payload.workcellId()); + case RESIZE_VARIANT -> openVariantSizeSettingsFromTool(player, payload); + case RENAME_VARIANT -> renameVariantFromTool(player, payload, tool, resetLabel); + case ADJUST_VARIANT_WEIGHT -> service.variantProperties.adjustVariantWeight( + player, + payload.workcellId(), + payload.pieceKey(), + payload.poolKey(), + payload.entryIndex(), + payload.amount()); + case ADJUST_VARIANT_CHANCE -> service.variantProperties.adjustVariantChance( + player, + payload.workcellId(), + payload.pieceKey(), + payload.poolKey(), + payload.entryIndex(), + payload.amount()); + case UNLINK_MEMBERSHIP -> service.variantEditor.unlinkVariantMembership( + player, + payload.workcellId(), + payload.pieceKey(), + payload.poolKey(), + payload.entryIndex()); + case TOGGLE_WORKCELL -> toggleWorkcellFromTool(player, payload.workcellId()); + case RESIZE_WORKCELL -> openWorkcellSettingsFromTool(player, payload.workcellId()); + case RENAME_WORKCELL -> renameWorkcellFromTool(player, payload, tool, resetLabel); + case SET_THEME -> useThemeTool(player, payload); + case SET_PIECE_RULES -> openVariantSettingsFromTool(player, payload); + case DELETE_VARIANT -> service.variantEditor.deleteVariant( + player, payload.workcellId(), payload.pieceKey()); + case DELETE_PROJECT -> service.variantEditor.deleteProject(player); + case TOGGLE_REQUIRE_CAPS -> toggleRequireCapsFromTool(player); + }; + } + + private boolean toggleWorkcellFromTool(Player player, String workcellId) { + Optional state = menuState(player); + JigsawStudioMenuState.Workcell workcell = state + .map(menu -> menu.workcell(workcellId)) + .orElse(null); + if (workcell == null) { + message(player, "This bound workcell no longer exists."); + return false; + } + return service.workcellEditor.setWorkcellEnabled(player, workcellId, !workcell.enabled()); + } + + private boolean openWorkcellSettingsFromTool(Player player, String workcellId) { + JigsawStudioMenuController activeMenuController = menuController; + return activeMenuController != null + && activeMenuController.openWorkcellSettings(player, workcellId); + } + + private boolean openVariantSettingsFromTool(Player player, JigsawStudioToolPayload payload) { + JigsawStudioMenuController activeMenuController = menuController; + return activeMenuController != null + && activeMenuController.openVariantSettings( + player, + payload.workcellId(), + payload.pieceKey()); + } + + private boolean openVariantSizeSettingsFromTool(Player player, JigsawStudioToolPayload payload) { + JigsawStudioMenuController activeMenuController = menuController; + return activeMenuController != null + && activeMenuController.openVariantSizeSettings( + player, + payload.workcellId(), + payload.pieceKey()); + } + + private boolean renameVariantFromTool( + Player player, + JigsawStudioToolPayload payload, + ItemStack tool, + boolean resetLabel + ) { + Optional displayName = toolDisplayName(player, payload, tool, resetLabel); + return displayName.isPresent() && service.variantProperties.updateVariantDisplayName( + player, + payload.workcellId(), + payload.pieceKey(), + displayName.get()); + } + + private boolean renameWorkcellFromTool( + Player player, + JigsawStudioToolPayload payload, + ItemStack tool, + boolean resetLabel + ) { + Optional displayName = toolDisplayName(player, payload, tool, resetLabel); + return displayName.isPresent() && service.workcellEditor.updateWorkcellDisplayName( + player, + payload.workcellId(), + displayName.get()); + } + + private static Optional toolDisplayName( + Player player, + JigsawStudioToolPayload payload, + ItemStack tool, + boolean resetLabel + ) { + if (resetLabel) { + return Optional.of(""); + } + String displayName = tool == null || !tool.hasItemMeta() || tool.getItemMeta() == null + ? "" + : tool.getItemMeta().getDisplayName(); + String normalized = ChatColor.stripColor(displayName); + normalized = normalized == null ? "" : normalized.trim(); + String defaultName = "Jigsaw Studio: " + payload.action().displayName(); + if (normalized.isEmpty() || normalized.equals(defaultName)) { + message(player, "Rename this bound stick in an anvil to the desired label, then right-click it. " + + "Sneak-right-click resets the label."); + return Optional.empty(); + } + return Optional.of(normalized); + } + + private boolean useThemeTool(Player player, JigsawStudioToolPayload payload) { + if (!payload.pieceKey().isBlank()) { + return openVariantSettingsFromTool(player, payload); + } + Optional state = menuState(player); + if (state.isEmpty()) { + return false; + } + return service.variantEditor.duplicateActiveFamily( + player, + JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); + } + + private boolean duplicateFamilyFromTool(Player player) { + Optional state = menuState(player); + return state.isPresent() && service.variantEditor.duplicateActiveFamily( + player, + JigsawStudioMenuFormat.nextThemeSetKey(state.get().themeSets())); + } + + private boolean toggleRequireCapsFromTool(Player player) { + Optional state = menuState(player); + return state.isPresent() && service.workcellEditor.setRequireCaps(player, !state.get().requireCaps()); + } + + private boolean confirmTool(Player player, JigsawStudioToolPayload payload) { + long now = System.nanoTime(); + ToolConfirmation previous = toolConfirmations.get(player.getUniqueId()); + if (previous != null + && previous.expiresAtNanos() >= now + && previous.payload().equals(payload)) { + toolConfirmations.remove(player.getUniqueId(), previous); + return true; + } + toolConfirmations.put( + player.getUniqueId(), + new ToolConfirmation(payload, now + TOOL_CONFIRM_NANOS)); + return false; + } + + JigsawStudioVariant activeOwnedVariant( + Player player, + ActiveStudio studio, + String workcellId + ) { + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return null; + } + JigsawStudioSession session = studio.generator().getSession(); + if (session.layout().get(workcellId) == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return null; + } + JigsawStudioVariant variant = session.activeVariant(workcellId).orElse(null); + if (variant == null) { + message(player, "This workcell has no active variant."); + return null; + } + if (!variant.owned()) { + message(player, "Variant '" + variant.pieceKey() + + "' is read-only. Adopt or clone its graph before editing it."); + return null; + } + return variant; + } + + JigsawStudioVariant activeOwnedVariant( + Player player, + ActiveStudio studio, + String workcellId, + String expectedPieceKey + ) { + JigsawStudioVariant variant = activeOwnedVariant(player, studio, workcellId); + if (variant == null) { + return null; + } + if (!variant.pieceKey().equals(expectedPieceKey)) { + message(player, "The bound variant changed. Open the control menu or request a fresh tool."); + return null; + } + return variant; + } + + static JigsawStudioPoolMembership findMembership( + JigsawStudioVariant variant, + String poolKey, + int entryIndex + ) { + for (JigsawStudioPoolMembership membership : variant.memberships()) { + if (membership.poolKey().equals(poolKey) && membership.entryIndex() == entryIndex) { + return membership; + } + } + return null; + } + + boolean deferDuplicationUntilAutosaved( + Player player, + ActiveStudio studio, + DeferredDuplication requested + ) { + JigsawStudioSession session = studio.generator().getSession(); + UUID requestId = studio.generator().getRequest().requestId(); + boolean autosavePending; + synchronized (service.saveLifecycleLock) { + autosavePending = session.isDirty() || service.saveLifecycle.savesInProgress.contains(requestId); + } + if (!autosavePending) { + return false; + } + DeferredDuplication existing = deferredDuplications.putIfAbsent(requestId, requested); + if (existing == null) { + message(player, requested.kind() == DeferredDuplicationKind.SINGLE + ? "Autosave is finishing first; this cell's variant will duplicate automatically." + : "Autosave is finishing every edited cell first; the coherent family will duplicate automatically."); + service.autosaveScheduler.expediteAutosaves(requestId); + scheduleDeferredDuplication(requested); + return true; + } + message(player, existing.sameIntent(requested) + ? "That duplicate action is already queued behind autosave." + : "Another duplicate action is already queued behind autosave for this Studio."); + return true; + } + + private void scheduleDeferredDuplication(DeferredDuplication deferred) { + if (deferredDuplications.get(deferred.requestId()) != deferred + || !deferred.scheduled().compareAndSet(false, true)) { + return; + } + try { + J.s(() -> { + deferred.scheduled().set(false); + if (deferredDuplications.get(deferred.requestId()) != deferred) { + return; + } + Player player = Bukkit.getPlayer(deferred.playerId()); + if (player == null) { + deferredDuplications.remove(deferred.requestId(), deferred); + return; + } + boolean scheduled = J.runEntity( + player, + () -> resumeDeferredDuplication(player, deferred), + 0, + () -> deferredDuplications.remove(deferred.requestId(), deferred)); + if (!scheduled) { + deferredDuplications.remove(deferred.requestId(), deferred); + } + }, AUTOSAVE_RETRY_TICKS); + } catch (Throwable exception) { + deferred.scheduled().set(false); + deferredDuplications.remove(deferred.requestId(), deferred); + IrisLogging.reportError(exception); + } + } + + private void resumeDeferredDuplication(Player player, DeferredDuplication deferred) { + if (deferredDuplications.get(deferred.requestId()) != deferred) { + return; + } + ActiveStudio studio = service.studios.get(deferred.worldId()); + JigsawStudioSession session = studio == null ? null : studio.generator().getSession(); + boolean currentRequest = studio != null + && studio.generator().getRequest().requestId().equals(deferred.requestId()) + && session.sessionId().equals(deferred.sessionId()) + && player.getWorld().getUID().equals(deferred.worldId()); + boolean sourcesCurrent = currentRequest && sourceBindingsCurrent(session, deferred.sourcePieces()); + boolean autosavePending; + boolean operationPending; + boolean terminal; + synchronized (service.saveLifecycleLock) { + autosavePending = currentRequest + && (session.isDirty() || service.saveLifecycle.savesInProgress.contains(deferred.requestId())); + operationPending = currentRequest + && (service.graphMutations.graphMutationsInProgress.contains(deferred.requestId()) + || service.materializer.materializationsInProgress.contains(deferred.requestId()) + || service.saveLifecycle.exportsInProgress.contains(deferred.requestId()) + || session.operationInProgress() + || service.tileWatcher.hasJigsawTileWatch(deferred.requestId())); + terminal = !currentRequest + || service.saveLifecycle.closingRequests.contains(deferred.requestId()) + || service.saveLifecycle.reopenRequiredRequests.contains(deferred.requestId()); + } + DeferredDuplicationReadiness readiness = deferredDuplicationReadiness( + currentRequest, + sourcesCurrent, + autosavePending, + operationPending, + terminal); + if (readiness == DeferredDuplicationReadiness.STALE) { + deferredDuplications.remove(deferred.requestId(), deferred); + message(player, "The queued duplicate was cancelled because its Studio or source variant changed."); + return; + } + if (readiness == DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE) { + service.autosaveScheduler.expediteAutosaves(deferred.requestId()); + scheduleDeferredDuplication(deferred); + return; + } + if (readiness == DeferredDuplicationReadiness.WAITING_FOR_OPERATION) { + scheduleDeferredDuplication(deferred); + return; + } + boolean started = deferred.kind() == DeferredDuplicationKind.SINGLE + ? service.variantEditor.createVariant(player, deferred.workcellId(), true) + : service.variantEditor.duplicateActiveFamily(player, deferred.themeKey()); + if (started) { + deferredDuplications.remove(deferred.requestId(), deferred); + return; + } + if (service.isCurrentRequest(studio, deferred.requestId()) + && sourceBindingsCurrent(session, deferred.sourcePieces())) { + scheduleDeferredDuplication(deferred); + } else { + deferredDuplications.remove(deferred.requestId(), deferred); + } + } + + static DeferredDuplicationReadiness deferredDuplicationReadiness( + boolean currentRequest, + boolean sourcesCurrent, + boolean autosavePending, + boolean operationPending, + boolean terminal + ) { + if (!currentRequest || !sourcesCurrent || terminal) { + return DeferredDuplicationReadiness.STALE; + } + if (autosavePending) { + return DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE; + } + if (operationPending) { + return DeferredDuplicationReadiness.WAITING_FOR_OPERATION; + } + return DeferredDuplicationReadiness.READY; + } + + private static boolean sourceBindingsCurrent( + JigsawStudioSession session, + Map expectedSources + ) { + if (session == null) { + return false; + } + for (Map.Entry source : expectedSources.entrySet()) { + if (session.activeVariant(source.getKey()) + .map(JigsawStudioVariant::pieceKey) + .filter(source.getValue()::equals) + .isEmpty()) { + return false; + } + } + return true; + } + + enum DeferredDuplicationReadiness { + READY, + WAITING_FOR_AUTOSAVE, + WAITING_FOR_OPERATION, + STALE + } + + private enum DeferredDuplicationKind { + SINGLE, + FAMILY + } + + record DeferredDuplication( + UUID requestId, + UUID sessionId, + UUID playerId, + UUID worldId, + DeferredDuplicationKind kind, + String workcellId, + Map sourcePieces, + String themeKey, + AtomicBoolean scheduled + ) { + DeferredDuplication { + Objects.requireNonNull(requestId, "Jigsaw Studio deferred duplicate request ID"); + Objects.requireNonNull(sessionId, "Jigsaw Studio deferred duplicate session ID"); + Objects.requireNonNull(playerId, "Jigsaw Studio deferred duplicate player ID"); + Objects.requireNonNull(worldId, "Jigsaw Studio deferred duplicate world ID"); + Objects.requireNonNull(kind, "Jigsaw Studio deferred duplicate kind"); + workcellId = workcellId == null ? "" : workcellId; + sourcePieces = Map.copyOf(Objects.requireNonNull( + sourcePieces, + "Jigsaw Studio deferred duplicate source pieces")); + themeKey = themeKey == null ? "" : themeKey; + Objects.requireNonNull(scheduled, "Jigsaw Studio deferred duplicate schedule state"); + if (sourcePieces.isEmpty()) { + throw new IllegalArgumentException("A deferred duplicate requires at least one source variant"); + } + if (kind == DeferredDuplicationKind.SINGLE && workcellId.isBlank()) { + throw new IllegalArgumentException("A deferred single duplicate requires a workcell"); + } + if (kind == DeferredDuplicationKind.FAMILY && themeKey.isBlank()) { + throw new IllegalArgumentException("A deferred family duplicate requires a theme key"); + } + } + + static DeferredDuplication single( + UUID requestId, + UUID sessionId, + Player player, + UUID worldId, + String workcellId, + String sourcePiece + ) { + return new DeferredDuplication( + requestId, + sessionId, + player.getUniqueId(), + worldId, + DeferredDuplicationKind.SINGLE, + workcellId, + Map.of(workcellId, sourcePiece), + "", + new AtomicBoolean()); + } + + static DeferredDuplication family( + UUID requestId, + UUID sessionId, + Player player, + UUID worldId, + Map sourcePieces, + String themeKey + ) { + return new DeferredDuplication( + requestId, + sessionId, + player.getUniqueId(), + worldId, + DeferredDuplicationKind.FAMILY, + "", + sourcePieces, + themeKey, + new AtomicBoolean()); + } + + private boolean sameIntent(DeferredDuplication other) { + return other != null + && playerId.equals(other.playerId) + && kind == other.kind + && workcellId.equals(other.workcellId) + && sourcePieces.equals(other.sourcePieces) + && themeKey.equals(other.themeKey); + } + } + + record ToolConfirmation(JigsawStudioToolPayload payload, long expiresAtNanos) { + ToolConfirmation { + Objects.requireNonNull(payload, "Jigsaw Studio tool confirmation payload"); + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantEditor.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantEditor.java new file mode 100644 index 000000000..91a783e40 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantEditor.java @@ -0,0 +1,590 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolMembership; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioProjectDeletionService; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioMaterializer.MaterializationWork; +import art.arcane.iris.core.service.JigsawStudioMaterializer.VariantReloadRequest; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CloseStart; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutationResult; +import art.arcane.iris.core.service.JigsawStudioToolbelt.DeferredDuplication; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.spi.IrisServices; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.entity.Player; + +import java.io.IOException; +import java.nio.file.Path; +import java.util.LinkedHashMap; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.UUID; + +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.validateMaterialization; +import static art.arcane.iris.core.service.JigsawStudioGraphMutations.loadMappedLayout; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioProtection.canCreateVariants; +import static art.arcane.iris.core.service.JigsawStudioProtection.variantCreationSourceFailure; +import static art.arcane.iris.core.service.JigsawStudioService.clearAutosaveHistory; +import static art.arcane.iris.core.service.JigsawStudioService.failureMessage; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioToolbelt.findMembership; + +final class JigsawStudioVariantEditor { + private final JigsawStudioService service; + + JigsawStudioVariantEditor(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean switchVariant( + Player player, + String workcellId, + String targetPieceKey, + boolean discardDirty + ) { + if (player == null || workcellId == null || targetPieceKey == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> switchVariant( + player, workcellId, targetPieceKey, discardDirty)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + if (service.graphMutations.graphMutationInProgress(studio.generator().getRequest().requestId())) { + message(player, "Wait for the current Jigsaw Studio graph update to finish."); + return false; + } + UUID requestId = studio.generator().getRequest().requestId(); + service.tileWatcher.finalizeJigsawTileWatches(requestId); + if (service.tileWatcher.hasJigsawTileWatch(requestId)) { + message(player, "Wait for the open vanilla jigsaw-block editor to finish its final snapshot."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + JigsawStudioSession.SwitchStart start = session.beginVariantSwitch( + workcell.stableId(), targetPieceKey, discardDirty); + if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { + message(player, switch (start.status()) { + case DIRTY -> "Wait for the current variant to finish autosaving before switching."; + case SAVE_IN_PROGRESS -> "Wait for the current variant save to finish."; + case SWITCH_IN_PROGRESS -> "This workcell is already loading another variant."; + case ALREADY_ACTIVE -> "Variant '" + targetPieceKey + "' is already active."; + case WRONG_WORKCELL -> "Variant '" + targetPieceKey + "' belongs to another workcell."; + case UNKNOWN_VARIANT -> "No variant '" + targetPieceKey + "' exists in this Studio catalog."; + case UNKNOWN_WORKCELL -> "The selected workcell no longer exists."; + case STARTED -> "The variant switch could not start."; + }); + return false; + } + return materializeVariant(player, studio, workcell, start, null); + } + + void reloadActiveVariant( + Player player, + ActiveStudio studio, + VariantReloadRequest reload + ) { + if (!service.isCurrentRequest(studio, studio.generator().getRequest().requestId())) { + return; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(reload.workcellId()); + if (workcell == null) { + message(player, "The resized variant was saved, but its workcell is no longer active. Reopen Studio."); + return; + } + JigsawStudioSession.SwitchStart start = session.beginVariantReload(workcell.stableId()); + if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { + service.saveLifecycle.reopenRequiredRequests.add(studio.generator().getRequest().requestId()); + message(player, "The resized variant was saved, but Studio could not reload it: " + + start.status() + ". Close and reopen this project before editing that workcell."); + return; + } + materializeVariant(player, studio, workcell, start, reload.previous()); + } + + private boolean materializeVariant( + Player player, + ActiveStudio studio, + JigsawStudioBay workcell, + JigsawStudioSession.SwitchStart start, + JigsawStudioGenerator.RenderedBay previousOverride + ) { + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioSession.VariantSwitchToken token = start.token().orElseThrow(); + String targetPieceKey = token.targetVariant().pieceKey(); + JigsawStudioGenerator.RenderedBay target = studio.generator().renderVariant( + workcell, + token.targetVariant()); + if (!target.valid()) { + session.abortVariantSwitch(token); + service.playerContext.refreshWorkcellContext(studio.worldId(), workcell.stableId()); + message(player, "Variant '" + targetPieceKey + "' cannot load: " + target.failure()); + return false; + } + JigsawStudioGenerator.RenderedBay previous = previousOverride == null + ? token.previousVariant() + .map(variant -> studio.generator().renderVariant(workcell, variant)) + .orElseGet(() -> JigsawStudioGenerator.RenderedBay.empty(workcell.bounds().dimensions())) + : previousOverride; + if (!previous.valid()) { + session.abortVariantSwitch(token); + service.playerContext.refreshWorkcellContext(studio.worldId(), workcell.stableId()); + message(player, "The current variant cannot be retained for rollback: " + previous.failure()); + return false; + } + JigsawStudioVariant previousVariant = token.previousVariant().orElse(null); + if (previousVariant != null) { + String rollbackFailure = validateMaterialization(previous); + if (!rollbackFailure.isEmpty()) { + session.abortVariantSwitch(token); + service.playerContext.refreshWorkcellContext(studio.worldId(), workcell.stableId()); + message(player, "The current variant cannot be retained for rollback: " + rollbackFailure); + return false; + } + } + session.selectBay(workcell.stableId()); + service.playerContext.refreshWorkcellContext(studio.worldId(), workcell.stableId()); + message(player, "Loading variant '" + targetPieceKey + "' into " + workcell.stableId() + "..."); + return service.materializer.scheduleMaterialization(new MaterializationWork( + studio, + player.getWorld(), + player, + workcell, + token, + previous, + target, + session.workcellSnapshot(workcell.stableId()).connectorsVisible(), + session.workcellSnapshot(workcell.stableId()).connectorsVisible(), + false)); + } + + boolean createVariant( + Player player, + String workcellId, + boolean duplicateActive + ) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> createVariant(player, workcellId, duplicateActive)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + if (!authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + if (!canCreateVariants(session.layout())) { + message(player, "This Jigsaw Studio graph is read-only. " + + "Adopt or clone it before creating variants."); + return false; + } + JigsawStudioVariant activeVariant = session.activeVariant(workcellId).orElse(null); + String sourceFailure = variantCreationSourceFailure(activeVariant, duplicateActive); + if (!sourceFailure.isEmpty()) { + message(player, sourceFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (duplicateActive && service.toolbelt.deferDuplicationUntilAutosaved( + player, + studio, + DeferredDuplication.single( + request.requestId(), + session.sessionId(), + player, + studio.worldId(), + workcell.stableId(), + activeVariant.pieceKey()))) { + return true; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + String archetypeKey = workcell.archetype() + .map(archetype -> archetype.name().toLowerCase(Locale.ROOT)) + .orElse("spatial"); + String sourcePieceKey = activeVariant.pieceKey(); + message(player, duplicateActive ? "Duplicating the active variant..." : "Creating a new variant..."); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + Path packRoot = request.source().getDataFolder().toPath(); + String pieceKey = JigsawStudioGraphEditor.nextVariantKey( + packRoot, request.structureKey(), archetypeKey); + if (duplicateActive) { + JigsawStudioGraphEditor.duplicatePiece( + packRoot, + request.structureKey(), + sourcePieceKey, + pieceKey); + } else { + JigsawStudioGraphEditor.createBlankVariant( + packRoot, + request.structureKey(), + sourcePieceKey, + pieceKey); + } + JigsawStudioLayout updatedLayout = loadMappedLayout(studio); + String targetWorkcellId = updatedLayout.workcellForVariant(pieceKey) + .map(JigsawStudioBay::stableId) + .orElseThrow(() -> new IOException( + "Created variant '" + pieceKey + "' has no Studio workcell")); + if (updatedLayout.mode() == JigsawStudioMode.SPATIAL_JIGSAW) { + return new CommandGraphMutationResult( + updatedLayout, + "", + "", + (duplicateActive ? "Duplicated" : "Created") + " variant '" + pieceKey + + "' in " + targetWorkcellId + "."); + } + return new CommandGraphMutationResult( + updatedLayout, + targetWorkcellId, + pieceKey, + (duplicateActive ? "Duplicated" : "Created") + " variant '" + pieceKey + "'."); + }); + } + + boolean duplicateActiveFamily(Player player, String themeKey) { + if (player == null || themeKey == null || themeKey.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> duplicateActiveFamily(player, themeKey)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { + message(player, "Coherent variant families are Iris-only and cannot be added to a vanilla-portable graph."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + Map sourcePieces = new LinkedHashMap<>(); + for (JigsawStudioBay workcell : session.layout().bays()) { + if (!workcell.enabled()) { + continue; + } + JigsawStudioVariant active = session.activeVariant(workcell.stableId()).orElse(null); + if (active == null || !active.owned()) { + message(player, "Load an owned source variant in every enabled workcell before duplicating a family."); + return false; + } + sourcePieces.put(workcell.stableId(), active.pieceKey()); + } + if (service.toolbelt.deferDuplicationUntilAutosaved( + player, + studio, + DeferredDuplication.family( + request.requestId(), + session.sessionId(), + player, + studio.worldId(), + sourcePieces, + themeKey))) { + return true; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.VariantFamilyCreation creation = + JigsawStudioGraphEditor.duplicateActiveFamily( + request.source().getDataFolder().toPath(), + request.structureKey(), + sourcePieces, + themeKey); + if (!creation.writeResult().successful()) { + throw new IOException("Variant-family transaction failed with " + + creation.writeResult().status()); + } + JigsawStudioLayout updatedLayout = loadMappedLayout(studio); + Map rebinds = updatedLayout.mode() == JigsawStudioMode.SPATIAL_JIGSAW + ? Map.of() + : creation.pieceKeysByWorkcell(); + return new CommandGraphMutationResult( + updatedLayout, + "", + "", + rebinds, + Optional.empty(), + "Duplicated every enabled workcell as coherent family '" + themeKey + "' with " + + creation.pieceKeysByWorkcell().size() + " variant(s)."); + }); + } + + boolean deleteVariant(Player player, String workcellId, String pieceKey) { + if (player == null || workcellId == null || workcellId.isBlank() + || pieceKey == null || pieceKey.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> deleteVariant(player, workcellId, pieceKey)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); + if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { + message(player, "Variant '" + pieceKey + "' no longer belongs to workcell '" + workcellId + "'."); + return false; + } + if (!variant.owned()) { + message(player, "Variant '" + pieceKey + "' is read-only. Adopt or clone it before deletion."); + return false; + } + String activePieceKey = session.activeVariant(workcellId) + .map(JigsawStudioVariant::pieceKey) + .orElse(""); + if (session.layout().mode() == JigsawStudioMode.PLANAR_JIGSAW + && activePieceKey.equals(pieceKey)) { + message(player, "Load another variant in this workcell before deleting '" + pieceKey + "'."); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.PieceDeletionResult deletion = + JigsawStudioGraphEditor.deletePieceVariant( + request.source().getDataFolder().toPath(), + request.structureKey(), + pieceKey); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Deleted variant '" + pieceKey + "', removed " + + deletion.removedPoolMemberships() + " pool membership(s), and removed " + + deletion.removedObjectResources() + " unshared object(s)."); + }); + } + + boolean deleteProject(Player player) { + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> deleteProject(player)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + CloseStart closeStart = service.saveLifecycle.tryBeginClose(request.requestId(), player.getUniqueId(), false); + if (closeStart != CloseStart.STARTED) { + message(player, switch (closeStart) { + case DIRTY -> "Wait for autosave to finish before deleting this project."; + case SAVE_IN_PROGRESS -> "Wait for the active autosave to finish before deleting this project."; + case OPERATION_IN_PROGRESS -> "Wait for the active Jigsaw Studio operation to finish."; + case NOT_OWNER -> "This Jigsaw Studio is owned by another player session."; + case NOT_ACTIVE -> "This Jigsaw Studio session is no longer active."; + case STARTED -> "Project deletion could not start."; + }); + return false; + } + Path packRoot = request.source().getDataFolder().toPath(); + message(player, "Inspecting owned resources and reverse references before project deletion..."); + J.a(() -> inspectProjectDeletion(player, studio, request, packRoot)); + return true; + } + + private void inspectProjectDeletion( + Player player, + ActiveStudio studio, + JigsawStudioActivation.Request request, + Path packRoot + ) { + JigsawStudioProjectDeletionService.DeletionPlan plan; + try { + plan = JigsawStudioProjectDeletionService.inspect(packRoot, request.structureKey()); + } catch (Throwable exception) { + service.saveLifecycle.cancelClose(request.requestId()); + IrisLogging.reportError(exception); + message(player, "Project deletion inspection failed: " + failureMessage(exception)); + return; + } + if (!plan.deletable()) { + service.saveLifecycle.cancelClose(request.requestId()); + message(player, "Project deletion is blocked by " + plan.blockers().size() + + " external reference(s). The first is " + + plan.blockers().getFirst().ownerPath() + " at " + + plan.blockers().getFirst().location() + "."); + return; + } + boolean scheduled = J.runEntity( + player, + () -> closeAndDeleteProject(player, studio, request, plan), + 0, + () -> service.saveLifecycle.cancelClose(request.requestId())); + if (!scheduled) { + service.saveLifecycle.cancelClose(request.requestId()); + message(player, "Project deletion stopped because the owner session ended."); + } + } + + private void closeAndDeleteProject( + Player player, + ActiveStudio studio, + JigsawStudioActivation.Request request, + JigsawStudioProjectDeletionService.DeletionPlan plan + ) { + if (!service.isCurrentRequest(studio, request.requestId())) { + service.saveLifecycle.cancelClose(request.requestId()); + message(player, "Project deletion stopped because the Jigsaw Studio session changed."); + return; + } + IrisServices.get(StudioSVC.class).close().whenComplete((result, throwable) -> { + Throwable failure = throwable != null + ? throwable + : result == null ? new IllegalStateException("Studio close completed without a result") + : result.failureCause(); + if (failure != null) { + service.saveLifecycle.cancelClose(request.requestId()); + IrisLogging.reportError(failure); + message(player, "Project deletion stopped because Studio could not close: " + + failureMessage(failure)); + return; + } + J.a(() -> applyProjectDeletion(player, request, plan)); + }); + } + + private void applyProjectDeletion( + Player player, + JigsawStudioActivation.Request request, + JigsawStudioProjectDeletionService.DeletionPlan plan + ) { + try { + JigsawStudioProjectDeletionService.ProjectDeletionResult result = + JigsawStudioProjectDeletionService.delete(plan); + try { + clearAutosaveHistory( + request.source().getDataFolder().toPath(), + request.structureKey()); + } catch (IOException historyFailure) { + IrisLogging.reportError(historyFailure); + message(player, "The project graph was deleted, but its autosave history could not be removed: " + + failureMessage(historyFailure)); + } + request.source().invalidateStructureResources(); + message(player, "Deleted Jigsaw project '" + request.structureKey() + "' and " + + result.removedResourceCount() + " owned resource(s)."); + IrisLogging.debug("Jigsaw Studio project deleted: structure=%s resources=%d", + request.structureKey(), result.removedResourceCount()); + } catch (Throwable exception) { + IrisLogging.reportError(exception); + message(player, "Studio closed, but the project was not deleted: " + + failureMessage(exception) + ". Its files remain recoverable on disk."); + } + } + + boolean unlinkVariantMembership( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex + ) { + if (player == null || workcellId == null || pieceKey == null || poolKey == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> unlinkVariantMembership( + player, workcellId, pieceKey, poolKey, entryIndex)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null && !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId, pieceKey); + if (variant == null) { + return false; + } + JigsawStudioPoolMembership membership = findMembership(variant, poolKey, entryIndex); + if (membership == null) { + message(player, "That exact pool membership is no longer present."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioPoolEditor.removeEntry( + request.source().getDataFolder().toPath(), + request.structureKey(), + membership.poolKey(), + membership.entryIndex(), + variant.pieceKey()); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Unlinked '" + variant.pieceKey() + "' from pool '" + + membership.poolKey() + "'."); + }); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantProperties.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantProperties.java new file mode 100644 index 000000000..fd4a601fe --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVariantProperties.java @@ -0,0 +1,550 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioMode; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPieceRules; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioPoolMembership; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioMaterializer.VariantReloadRequest; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutationResult; +import art.arcane.iris.engine.object.IrisJigsawThemeSet; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.entity.Player; + +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; + +import static art.arcane.iris.core.service.JigsawStudioEvaluator.loadStudioStructure; +import static art.arcane.iris.core.service.JigsawStudioGraphMutations.loadMappedLayout; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioProtection.canToggleVariantRotation; +import static art.arcane.iris.core.service.JigsawStudioService.DEFAULT_PIECE_RULES; +import static art.arcane.iris.core.service.JigsawStudioService.message; +import static art.arcane.iris.core.service.JigsawStudioToolbelt.findMembership; + +final class JigsawStudioVariantProperties { + private final JigsawStudioService service; + + JigsawStudioVariantProperties(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean updateVariantThemes( + Player player, + String workcellId, + String pieceKey, + List themes + ) { + if (player == null || pieceKey == null || themes == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateVariantThemes( + player, workcellId, pieceKey, themes)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId, pieceKey); + if (variant == null) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + List targetThemes = List.copyOf(themes); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + && !targetThemes.isEmpty()) { + message(player, "Piece themes are Iris-only and cannot be added to a vanilla-portable graph."); + return false; + } + IrisStructure structure = loadStudioStructure(studio); + Set declaredThemes = new HashSet<>(); + if (structure != null && structure.getThemeSets() != null) { + for (IrisJigsawThemeSet theme : structure.getThemeSets()) { + if (theme != null) { + declaredThemes.add(theme.getKey()); + } + } + } + if (!declaredThemes.containsAll(targetThemes)) { + message(player, "One or more selected theme sets no longer exist."); + return false; + } + if (variant.themes().equals(targetThemes)) { + message(player, "Variant theme membership is unchanged."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.updatePieceThemes( + request.source().getDataFolder().toPath(), + request.structureKey(), + variant.pieceKey(), + targetThemes); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Updated theme membership for '" + variant.pieceKey() + "'."); + }); + } + + boolean updateVariantRules( + Player player, + String workcellId, + String pieceKey, + JigsawStudioPieceRules rules + ) { + if (player == null || pieceKey == null || rules == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateVariantRules( + player, workcellId, pieceKey, rules)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId, pieceKey); + if (variant == null) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + && !DEFAULT_PIECE_RULES.equals(rules)) { + message(player, "Piece placement rules are Iris-only for a vanilla-portable graph."); + return false; + } + if (variant.rules().equals(rules)) { + message(player, "Variant piece rules are unchanged."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.updatePieceRules( + request.source().getDataFolder().toPath(), + request.structureKey(), + variant.pieceKey(), + rules); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Updated placement rules for '" + variant.pieceKey() + "'."); + }); + } + + boolean toggleVariantRotatable(Player player, String workcellId) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> toggleVariantRotatable(player, workcellId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null && !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId); + if (variant == null) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (!canToggleVariantRotation(request.compatibilityTarget(), variant)) { + message(player, "Vanilla-portable variants must remain rotatable."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + boolean rotatable = !variant.rotatable(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.updateRotatable( + request.source().getDataFolder().toPath(), + request.structureKey(), + variant.pieceKey(), + rotatable); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Variant rotation is now " + (rotatable ? "enabled." : "disabled.")); + }); + } + + boolean expandVariantToCell(Player player, String workcellId) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> expandVariantToCell(player, workcellId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null && !authorizeOwner(player, studio)) { + return false; + } + if (studio == null) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (variant == null || workcell == null) { + return false; + } + return resizeVariant(player, workcellId, variant.pieceKey(), workcell.capacity()); + } + + boolean resizeVariant( + Player player, + String workcellId, + String pieceKey, + JigsawStudioCellDimensions dimensions + ) { + if (player == null || workcellId == null || workcellId.isBlank() + || pieceKey == null || pieceKey.isBlank() || dimensions == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> resizeVariant(player, workcellId, pieceKey, dimensions)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); + if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { + message(player, "Variant '" + pieceKey + "' does not belong to workcell '" + workcellId + "'."); + return false; + } + if (!variant.owned()) { + message(player, "Variant '" + pieceKey + "' is read-only. Duplicate it before resizing."); + return false; + } + if (dimensions.width() > workcell.capacity().width() + || dimensions.height() > workcell.capacity().height() + || dimensions.depth() > workcell.capacity().depth()) { + message(player, "Requested variant size " + dimensions.width() + "x" + dimensions.height() + "x" + + dimensions.depth() + " exceeds workcell capacity " + workcell.capacity().width() + "x" + + workcell.capacity().height() + "x" + workcell.capacity().depth() + + ". Increase the workcell capacity first."); + return false; + } + if (variant.mode() == JigsawStudioMode.PLANAR_JIGSAW + && (dimensions.width() < 3 || dimensions.depth() < 3)) { + message(player, "Planar variant width and depth must each be at least 3 blocks."); + return false; + } + if (variant.dimensions().filter(dimensions::equals).isPresent()) { + message(player, "Variant '" + variant.resolvedDisplayName() + "' already uses " + + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "."); + return false; + } + boolean active = session.activeVariant(workcellId) + .map(activeVariant -> activeVariant.pieceKey().equals(pieceKey)) + .orElse(false); + JigsawStudioGenerator.RenderedBay previous = active + ? studio.generator().renderVariant(workcell, variant) + : null; + if (previous != null && !previous.valid()) { + message(player, "The active variant cannot be retained for live resize rollback: " + previous.failure()); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + message(player, "Resizing variant '" + variant.resolvedDisplayName() + "' to " + + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "..."); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.VariantResizeResult resize = + JigsawStudioGraphEditor.resizePieceObject( + request.source().getDataFolder().toPath(), + request.structureKey(), + variant.pieceKey(), + dimensions); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + Map.of(), + active ? Optional.of(new VariantReloadRequest(workcellId, previous)) : Optional.empty(), + "Resized variant '" + variant.resolvedDisplayName() + "' from " + + resize.previousDimensions().width() + "x" + + resize.previousDimensions().height() + "x" + + resize.previousDimensions().depth() + " to " + + dimensions.width() + "x" + dimensions.height() + "x" + + dimensions.depth() + ". " + resize.relocatedConnectors() + + " connector(s) moved with the new bounds."); + }); + } + + boolean updateVariantDisplayName( + Player player, + String workcellId, + String pieceKey, + String displayName + ) { + if (player == null || workcellId == null || pieceKey == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateVariantDisplayName( + player, workcellId, pieceKey, displayName)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + JigsawStudioVariant variant = session.layout().variantCatalog().find(pieceKey).orElse(null); + if (workcell == null || variant == null || !session.layout().accepts(workcell, variant)) { + message(player, "Variant '" + pieceKey + "' does not belong to workcell '" + workcellId + "'."); + return false; + } + if (!variant.owned()) { + message(player, "Variant '" + pieceKey + "' is read-only. Duplicate it before renaming."); + return false; + } + String normalizedName; + try { + normalizedName = JigsawStudioGraphEditor.normalizeDisplayName(displayName); + } catch (IllegalArgumentException exception) { + message(player, exception.getMessage()); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.updatePieceDisplayName( + request.source().getDataFolder().toPath(), + request.structureKey(), + pieceKey, + normalizedName); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + normalizedName.isEmpty() + ? "Reset the variant label to its resource-key fallback." + : "Renamed the variant to '" + normalizedName + "'."); + }); + } + + boolean adjustVariantWeight( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int delta + ) { + if (delta == 0) { + return false; + } + if (player == null || workcellId == null || pieceKey == null || poolKey == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> adjustVariantWeight( + player, workcellId, pieceKey, poolKey, entryIndex, delta)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null && !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId, pieceKey); + if (variant == null) { + return false; + } + JigsawStudioPoolMembership membership = findMembership( + variant, poolKey, entryIndex); + if (membership == null) { + message(player, "That exact pool membership is no longer present."); + return false; + } + int weight; + try { + weight = Math.addExact(membership.weight(), delta); + } catch (ArithmeticException exception) { + message(player, "The requested variant weight is outside the supported integer range."); + return false; + } + if (weight < 1) { + message(player, "Variant weights cannot be lower than 1; unlink the membership instead."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioPoolEditor.updateWeightAtIndex( + request.source().getDataFolder().toPath(), + request.structureKey(), + membership.poolKey(), + membership.entryIndex(), + variant.pieceKey(), + weight); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Set '" + variant.pieceKey() + "' weight to " + weight + + " in pool '" + membership.poolKey() + "'."); + }); + } + + boolean adjustVariantChance( + Player player, + String workcellId, + String pieceKey, + String poolKey, + int entryIndex, + int deltaPercentagePoints + ) { + if (deltaPercentagePoints == 0 || player == null || workcellId == null + || pieceKey == null || poolKey == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> adjustVariantChance( + player, + workcellId, + pieceKey, + poolKey, + entryIndex, + deltaPercentagePoints)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio != null && !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioVariant variant = service.toolbelt.activeOwnedVariant(player, studio, workcellId, pieceKey); + if (variant == null) { + return false; + } + JigsawStudioPoolMembership membership = findMembership(variant, poolKey, entryIndex); + if (membership == null) { + message(player, "That exact pool membership is no longer present."); + return false; + } + double chance = membership.chance() + deltaPercentagePoints / 100.0D; + if (!Double.isFinite(chance) || chance < 0.0D || chance > 1.0D) { + message(player, "Variant chance must stay between 0% and 100%."); + return false; + } + chance = Math.round(chance * 1_000_000.0D) / 1_000_000.0D; + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + && chance != 1.0D) { + message(player, "Chance gates are Iris-only and cannot be added to a vanilla-portable graph."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + double targetChance = chance; + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioPoolEditor.updateChanceAtIndex( + request.source().getDataFolder().toPath(), + request.structureKey(), + membership.poolKey(), + membership.entryIndex(), + variant.pieceKey(), + targetChance); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Set '" + variant.pieceKey() + "' chance to " + + Math.round(targetChance * 100.0D) + "% in pool '" + + membership.poolKey() + "'."); + }); + } + + static boolean canResizeVariantToCapacity( + JigsawStudioBay workcell, + JigsawStudioVariant variant, + boolean active + ) { + if (!active || !variant.owned()) { + return false; + } + JigsawStudioCellDimensions canonical = variant.dimensions().orElse(null); + if (canonical == null) { + return false; + } + JigsawStudioCellDimensions target = workcell.capacity(); + return canonical.width() <= target.width() + && canonical.height() <= target.height() + && canonical.depth() <= target.depth() + && (canonical.width() < target.width() + || canonical.height() < target.height() + || canonical.depth() < target.depth()); + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVisualization.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVisualization.java new file mode 100644 index 000000000..7d7d852ca --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioVisualization.java @@ -0,0 +1,404 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBounds; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioLayout; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.engine.framework.PlacedStructurePiece; +import art.arcane.iris.engine.object.IrisDirection; +import art.arcane.iris.engine.object.IrisJigsawConnector; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.spi.IrisLogging; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.Color; +import org.bukkit.Location; +import org.bukkit.Particle; +import org.bukkit.entity.Player; + +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; + +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioVisualization { + private static final int VISUAL_INTERVAL_TICKS = 8; + private static final int PARTICLE_BUDGET = 384; + private static final double VISUAL_RANGE = 96.0D; + private static final double VISUAL_RANGE_SQUARED = VISUAL_RANGE * VISUAL_RANGE; + private static final Color SELECTED_COLOR = Color.AQUA; + private static final Color NEARBY_COLOR = Color.fromRGB(92, 102, 118); + private static final Color INVALID_BAY_COLOR = Color.RED; + private static final Color INVALID_CONNECTOR_COLOR = Color.RED; + private static final Color VALID_CONNECTOR_COLOR = Color.LIME; + private static final Color ASSEMBLY_PREVIEW_COLOR = Color.fromRGB(180, 90, 255); + private static final Color LIVE_PREVIEW_WARNING_COLOR = Color.fromRGB(255, 180, 55); + private static final long ASSEMBLY_PREVIEW_MILLIS = 10_000L; + + private final JigsawStudioService service; + final Set visualizationLoops = ConcurrentHashMap.newKeySet(); + final Map assemblyPreviews = new ConcurrentHashMap<>(); + + JigsawStudioVisualization(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean showAssemblyPreview(Player player, List pieces) { + if (player == null || pieces == null || pieces.isEmpty()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> showAssemblyPreview(player, pieces)); + } + if (!service.studios.containsKey(player.getWorld().getUID())) { + message(player, "Iris Jigsaw Studio is not active in this world."); + return false; + } + List bounds = new ArrayList<>(pieces.size()); + for (PlacedStructurePiece piece : pieces) { + bounds.add(new JigsawStudioPreviewRenderer.PreviewBounds( + piece.getMinX(), + piece.getMinY(), + piece.getMinZ(), + piece.getMaxX(), + piece.getMaxY(), + piece.getMaxZ())); + } + assemblyPreviews.put(player.getUniqueId(), new AssemblyPreview( + player.getWorld().getUID(), + System.currentTimeMillis() + ASSEMBLY_PREVIEW_MILLIS, + List.copyOf(bounds))); + service.particlesDisabled.remove(player.getUniqueId()); + ensureVisualizationLoop(player); + return true; + } + + void ensureVisualizationLoop(Player player) { + if (player == null) { + return; + } + if (!J.isOwnedByCurrentRegion(player)) { + J.runEntity(player, () -> ensureVisualizationLoop(player)); + return; + } + UUID playerId = player.getUniqueId(); + if (!service.enabled || service.particlesDisabled.contains(playerId) + || !service.studios.containsKey(player.getWorld().getUID()) + || !visualizationLoops.add(playerId)) { + return; + } + visualizationTick(player); + } + + private void visualizationTick(Player player) { + UUID playerId = player.getUniqueId(); + if (!service.enabled || service.particlesDisabled.contains(playerId)) { + visualizationLoops.remove(playerId); + return; + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null) { + visualizationLoops.remove(playerId); + return; + } + try { + renderVisualization(player, studio); + } catch (Throwable exception) { + visualizationLoops.remove(playerId); + IrisLogging.reportError(exception); + return; + } + boolean scheduled = J.runEntity( + player, + () -> visualizationTick(player), + VISUAL_INTERVAL_TICKS, + () -> visualizationLoops.remove(playerId)); + if (!scheduled) { + visualizationLoops.remove(playerId); + } + } + + private void renderVisualization(Player player, ActiveStudio studio) { + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioLayout layout = session.layout(); + Location playerLocation = player.getLocation(); + JigsawStudioBay focused = layout.findAt( + playerLocation.getBlockX(), + playerLocation.getBlockY(), + playerLocation.getBlockZ()); + ParticleBudget budget = new ParticleBudget(PARTICLE_BUDGET); + if (focused != null) { + Color focusedColor = bayValid(studio, focused) ? SELECTED_COLOR : INVALID_BAY_COLOR; + drawConnectors(player, playerLocation, studio, focused, budget); + drawBounds(player, playerLocation, focused.bounds(), focusedColor, 1.15F, 1.0D, budget); + } + drawLivePreview(player, playerLocation, studio, budget); + drawAssemblyPreview(player, playerLocation, budget); + for (JigsawStudioBay bay : layout.bays()) { + if (bay == focused || !isNearby(playerLocation, bay.bounds())) { + continue; + } + Color nearbyColor = bayValid(studio, bay) ? NEARBY_COLOR : INVALID_BAY_COLOR; + drawBounds(player, playerLocation, bay.bounds(), nearbyColor, 0.55F, 4.0D, budget); + if (budget.empty()) { + return; + } + } + } + + private void drawLivePreview( + Player player, + Location playerLocation, + ActiveStudio studio, + ParticleBudget budget + ) { + UUID requestId = studio.generator().getRequest().requestId(); + JigsawStudioGraphEvaluation evaluation = service.evaluator.evaluations.get(requestId); + if (evaluation == null || evaluation.previewBounds().isEmpty()) { + return; + } + JigsawStudioPreviewRenderer.PreviewBounds preview = evaluation.previewBounds(); + Color color = switch (evaluation.state()) { + case VALID -> ASSEMBLY_PREVIEW_COLOR; + case PENDING, WARNING, STALE -> LIVE_PREVIEW_WARNING_COLOR; + case INVALID -> INVALID_BAY_COLOR; + }; + drawBounds( + player, + playerLocation, + preview, + color, + 0.85F, + 2.0D, + budget); + } + + private void drawAssemblyPreview( + Player player, + Location playerLocation, + ParticleBudget budget + ) { + AssemblyPreview preview = assemblyPreviews.get(player.getUniqueId()); + if (preview == null) { + return; + } + if (!preview.worldId().equals(player.getWorld().getUID()) + || preview.expiresAtMillis() < System.currentTimeMillis()) { + assemblyPreviews.remove(player.getUniqueId(), preview); + return; + } + for (JigsawStudioPreviewRenderer.PreviewBounds bounds : preview.bounds()) { + drawBounds(player, playerLocation, bounds, ASSEMBLY_PREVIEW_COLOR, 0.85F, 2.0D, budget); + if (budget.empty()) { + return; + } + } + } + + private static void drawConnectors( + Player player, + Location playerLocation, + ActiveStudio studio, + JigsawStudioBay bay, + ParticleBudget budget + ) { + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); + if (!rendered.valid()) { + return; + } + for (JigsawStudioGenerator.RenderedConnector renderedConnector : rendered.connectors()) { + IrisJigsawConnector connector = renderedConnector.connector(); + IrisDirection direction = connector.getDirection(); + drawConnectorLine( + player, + playerLocation, + bay.bounds().originX() + renderedConnector.x() + 0.5D, + bay.bounds().originY() + renderedConnector.y() + 0.5D, + bay.bounds().originZ() + renderedConnector.z() + 0.5D, + direction, + connectorColor(connector), + budget); + if (budget.empty()) { + return; + } + } + } + + private static void drawConnectorLine( + Player player, + Location playerLocation, + double startX, + double startY, + double startZ, + IrisDirection direction, + Color color, + ParticleBudget budget + ) { + drawLine( + player, + playerLocation, + startX, + startY, + startZ, + startX + direction.x() * 1.75D, + startY + direction.y() * 1.75D, + startZ + direction.z() * 1.75D, + color, + 1.05F, + 0.35D, + budget); + } + + private static boolean bayValid(ActiveStudio studio, JigsawStudioBay bay) { + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderBay(bay); + return rendered.valid() && studio.population(bay).readiness().failure().isEmpty(); + } + + private static Color connectorColor(IrisJigsawConnector connector) { + if (connector.getPool() == null || connector.getPool().isBlank() + || connector.getName() == null || connector.getName().isBlank() + || connector.getTargetName() == null || connector.getTargetName().isBlank()) { + return INVALID_CONNECTOR_COLOR; + } + String channel = connector.getChannel(); + if (channel == null || channel.isBlank()) { + return VALID_CONNECTOR_COLOR; + } + int hash = channel.toLowerCase(Locale.ROOT).hashCode(); + int red = 80 + (hash & 127); + int green = 80 + ((hash >>> 8) & 127); + int blue = 80 + ((hash >>> 16) & 127); + return Color.fromRGB(red, green, blue); + } + + private static void drawBounds( + Player player, + Location playerLocation, + JigsawStudioBounds bounds, + Color color, + float size, + double step, + ParticleBudget budget + ) { + drawBounds(player, playerLocation, new JigsawStudioPreviewRenderer.PreviewBounds( + bounds.originX(), bounds.originY(), bounds.originZ(), bounds.maxX(), bounds.maxY(), bounds.maxZ()), + color, size, step, budget); + } + + private static void drawBounds( + Player player, + Location playerLocation, + JigsawStudioPreviewRenderer.PreviewBounds bounds, + Color color, + float size, + double step, + ParticleBudget budget + ) { + double minX = bounds.minimumX(); + double minY = bounds.minimumY(); + double minZ = bounds.minimumZ(); + double maxX = bounds.maximumX() + 1.0D; + double maxY = bounds.maximumY() + 1.0D; + double maxZ = bounds.maximumZ() + 1.0D; + drawLine(player, playerLocation, minX, minY, minZ, maxX, minY, minZ, color, size, step, budget); + drawLine(player, playerLocation, minX, minY, maxZ, maxX, minY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, minX, maxY, minZ, maxX, maxY, minZ, color, size, step, budget); + drawLine(player, playerLocation, minX, maxY, maxZ, maxX, maxY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, minX, minY, minZ, minX, maxY, minZ, color, size, step, budget); + drawLine(player, playerLocation, maxX, minY, minZ, maxX, maxY, minZ, color, size, step, budget); + drawLine(player, playerLocation, minX, minY, maxZ, minX, maxY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, maxX, minY, maxZ, maxX, maxY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, minX, minY, minZ, minX, minY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, maxX, minY, minZ, maxX, minY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, minX, maxY, minZ, minX, maxY, maxZ, color, size, step, budget); + drawLine(player, playerLocation, maxX, maxY, minZ, maxX, maxY, maxZ, color, size, step, budget); + } + + private static void drawLine( + Player player, + Location playerLocation, + double startX, + double startY, + double startZ, + double endX, + double endY, + double endZ, + Color color, + float size, + double step, + ParticleBudget budget + ) { + if (budget.empty()) { + return; + } + double deltaX = endX - startX; + double deltaY = endY - startY; + double deltaZ = endZ - startZ; + double length = Math.sqrt(deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ); + int samples = Math.max(1, (int) Math.ceil(length / step)); + Particle.DustOptions dust = new Particle.DustOptions(color, size); + for (int index = 0; index <= samples; index++) { + double progress = (double) index / samples; + double x = startX + deltaX * progress; + double y = startY + deltaY * progress; + double z = startZ + deltaZ * progress; + double distanceX = playerLocation.getX() - x; + double distanceY = playerLocation.getY() - y; + double distanceZ = playerLocation.getZ() - z; + if (distanceX * distanceX + distanceY * distanceY + distanceZ * distanceZ > VISUAL_RANGE_SQUARED) { + continue; + } + if (!budget.consume()) { + return; + } + player.spawnParticle(Particle.DUST, x, y, z, 1, 0.0D, 0.0D, 0.0D, 0.0D, dust); + } + } + + private static boolean isNearby(Location location, JigsawStudioBounds bounds) { + double centerX = bounds.originX() + bounds.dimensions().width() / 2.0D; + double centerY = bounds.originY() + bounds.dimensions().height() / 2.0D; + double centerZ = bounds.originZ() + bounds.dimensions().depth() / 2.0D; + double deltaX = location.getX() - centerX; + double deltaY = location.getY() - centerY; + double deltaZ = location.getZ() - centerZ; + return deltaX * deltaX + deltaY * deltaY + deltaZ * deltaZ <= VISUAL_RANGE_SQUARED; + } + + private record AssemblyPreview( + UUID worldId, + long expiresAtMillis, + List bounds + ) { + AssemblyPreview { + Objects.requireNonNull(worldId, "Jigsaw Studio preview world"); + bounds = List.copyOf(bounds); + } + } + + private static final class ParticleBudget { + private int remaining; + + private ParticleBudget(int remaining) { + this.remaining = remaining; + } + + private boolean consume() { + if (remaining < 1) { + return false; + } + remaining--; + return true; + } + + private boolean empty() { + return remaining < 1; + } + } +} diff --git a/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellEditor.java b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellEditor.java new file mode 100644 index 000000000..9c44326f7 --- /dev/null +++ b/core/src/main/java/art/arcane/iris/core/service/JigsawStudioWorkcellEditor.java @@ -0,0 +1,434 @@ +package art.arcane.iris.core.service; + +import art.arcane.iris.core.runtime.jigsaw.JigsawPlanarArchetype; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioActivation; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioBay; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCellDimensions; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioCompatibilityTarget; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioGraphEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioSession; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioStructureEditor; +import art.arcane.iris.core.runtime.jigsaw.JigsawStudioVariant; +import art.arcane.iris.core.service.JigsawStudioMaterializer.MaterializationWork; +import art.arcane.iris.core.service.JigsawStudioService.ActiveStudio; +import art.arcane.iris.core.service.JigsawStudioService.CommandGraphMutationResult; +import art.arcane.iris.engine.object.IrisJigsawThemeSet; +import art.arcane.iris.engine.object.IrisStructure; +import art.arcane.iris.engine.platform.studio.generators.JigsawStudioGenerator; +import art.arcane.iris.util.common.scheduling.J; +import org.bukkit.entity.Player; + +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; + +import static art.arcane.iris.core.service.JigsawStudioChunkWriter.validateMaterialization; +import static art.arcane.iris.core.service.JigsawStudioEvaluator.loadStudioStructure; +import static art.arcane.iris.core.service.JigsawStudioGraphMutations.loadMappedLayout; +import static art.arcane.iris.core.service.JigsawStudioProtection.authorizeOwner; +import static art.arcane.iris.core.service.JigsawStudioService.message; + +final class JigsawStudioWorkcellEditor { + private final JigsawStudioService service; + + JigsawStudioWorkcellEditor(JigsawStudioService service) { + this.service = Objects.requireNonNull(service, "Jigsaw Studio service"); + } + + boolean setConnectorBlocksVisible(Player player, String workcellId, boolean visible) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> setConnectorBlocksVisible(player, workcellId, visible)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + JigsawStudioSession.WorkcellSnapshot snapshot = session.workcellSnapshot(workcellId); + if (snapshot.connectorsVisible() == visible) { + message(player, "Connector blocks are already " + (visible ? "visible." : "hidden.")); + return false; + } + JigsawStudioSession.SwitchStart start = session.beginVariantReload(workcellId); + if (start.status() != JigsawStudioSession.SwitchStatus.STARTED) { + message(player, switch (start.status()) { + case DIRTY -> "Wait for this workcell to finish autosaving before changing connector visibility."; + case SAVE_IN_PROGRESS -> "Wait for the current workcell save to finish."; + case SWITCH_IN_PROGRESS -> "This workcell is already loading another view."; + case UNKNOWN_WORKCELL -> "The selected workcell no longer exists."; + case UNKNOWN_VARIANT -> "This workcell has no active variant."; + case ALREADY_ACTIVE, WRONG_WORKCELL, STARTED -> + "Connector visibility could not change: " + start.status() + "."; + }); + return false; + } + JigsawStudioSession.VariantSwitchToken token = start.token().orElseThrow(); + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderVariant( + workcell, + token.targetVariant()); + if (!rendered.valid()) { + session.abortVariantSwitch(token); + message(player, "Connector visibility cannot change: " + rendered.failure()); + return false; + } + message(player, (visible ? "Showing" : "Hiding") + " connector blocks in " + workcellId + "..."); + return service.materializer.scheduleMaterialization(new MaterializationWork( + studio, + player.getWorld(), + player, + workcell, + token, + rendered, + rendered, + snapshot.connectorsVisible(), + visible, + true)); + } + + boolean resetConnectorBlocks(Player player, String workcellId) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> resetConnectorBlocks(player, workcellId)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + JigsawStudioVariant activeVariant = session.activeVariant(workcellId).orElse(null); + if (activeVariant == null || !activeVariant.owned()) { + message(player, "Load an owned variant before resetting its connector blocks."); + return false; + } + JigsawStudioGenerator.RenderedBay rendered = studio.generator().renderVariant( + workcell, + activeVariant); + String validationFailure = validateMaterialization(rendered); + if (!validationFailure.isEmpty()) { + message(player, "Connector blocks cannot reset: " + validationFailure); + return false; + } + if (rendered.connectors().isEmpty()) { + message(player, "The active variant has no saved connectors to reset."); + return false; + } + String reservationFailure = service.materializer.beginConnectorRepair(studio); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + boolean connectorsVisible = session.workcellSnapshot(workcellId).connectorsVisible(); + message(player, "Resetting " + rendered.connectors().size() + + " connector block(s) from the last saved iteration..."); + return service.materializer.scheduleConnectorRepair( + player, + studio, + workcell, + rendered, + connectorsVisible); + } + + boolean setWorkcellEnabled(Player player, String workcellId, boolean enabled) { + if (player == null || workcellId == null || workcellId.isBlank()) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> setWorkcellEnabled(player, workcellId, enabled)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null || workcell.archetype().isEmpty()) { + message(player, "Only planar Jigsaw Studio workcells can be enabled or disabled."); + return false; + } + if (workcell.enabled() == enabled) { + message(player, "Workcell '" + workcellId + "' is already " + + (enabled ? "enabled." : "disabled.")); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + JigsawPlanarArchetype archetype = workcell.archetype().orElseThrow(); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioStructureEditor.updateWorkcellEnabled( + request.source().getDataFolder().toPath(), + request.structureKey(), + archetype, + enabled); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Workcell '" + workcellId + "' is now " + + (enabled ? "enabled." : "disabled for assembly and export.")); + }); + } + + boolean updateWorkcellDimensions( + Player player, + String workcellId, + JigsawStudioCellDimensions dimensions + ) { + if (player == null || workcellId == null || workcellId.isBlank() || dimensions == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateWorkcellDimensions(player, workcellId, dimensions)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + if (workcell.capacity().equals(dimensions)) { + message(player, "Workcell '" + workcellId + "' already has capacity " + + dimensions.width() + "x" + dimensions.height() + "x" + dimensions.depth() + "."); + return false; + } + if (workcell.archetype().isPresent() + && (dimensions.width() < 3 || dimensions.depth() < 3)) { + message(player, "Planar workcell width and depth must each be at least 3 blocks."); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + JigsawPlanarArchetype archetype = workcell.archetype().orElse(null); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioGraphEditor.WorkcellCapacityResult capacityResult = null; + if (archetype == null) { + JigsawStudioStructureEditor.updateCellSize( + request.source().getDataFolder().toPath(), + request.structureKey(), + dimensions); + } else { + capacityResult = JigsawStudioGraphEditor.updatePlanarWorkcellCapacity( + request.source().getDataFolder().toPath(), + request.structureKey(), + archetype, + dimensions); + } + request.source().invalidateStructureResources(); + String resizeSummary = capacityResult == null + ? "" + : " Verified " + capacityResult.checkedVariants() + " existing variant" + + (capacityResult.checkedVariants() == 1 ? "" : "s") + "; no variant object was resized."; + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Updated '" + workcellId + "' capacity to " + + dimensions.width() + "x" + dimensions.height() + "x" + + dimensions.depth() + "." + resizeSummary + + " The live workcell layout was regenerated."); + }); + } + + boolean setRequireCaps(Player player, boolean requireCaps) { + if (player == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> setRequireCaps(player, requireCaps)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE + && requireCaps) { + message(player, "Mandatory caps are Iris-only and cannot be enabled for a vanilla-portable graph."); + return false; + } + IrisStructure structure = loadStudioStructure(studio); + if (structure == null) { + message(player, "The active jigsaw structure could not be loaded."); + return false; + } + if (structure.isRequireCaps() == requireCaps) { + message(player, "Mandatory caps are already " + (requireCaps ? "enabled." : "disabled.")); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioStructureEditor.updateRequireCaps( + request.source().getDataFolder().toPath(), + request.structureKey(), + requireCaps); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Mandatory physical caps are now " + + (requireCaps ? "enabled." : "disabled.")); + }); + } + + boolean updateThemeSetWeight(Player player, String themeKey, int weight) { + if (player == null || themeKey == null || themeKey.isBlank() || weight < 1) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateThemeSetWeight(player, themeKey, weight)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + if (request.compatibilityTarget() == JigsawStudioCompatibilityTarget.VANILLA_PORTABLE) { + message(player, "Coherent theme sets are Iris-only."); + return false; + } + IrisStructure structure = loadStudioStructure(studio); + if (structure == null || structure.getThemeSets() == null) { + message(player, "The active jigsaw structure has no theme sets."); + return false; + } + List updated = new ArrayList<>(structure.getThemeSets().size()); + boolean found = false; + for (IrisJigsawThemeSet theme : structure.getThemeSets()) { + if (theme != null && themeKey.equals(theme.getKey())) { + if (theme.getWeight() == weight) { + message(player, "Theme '" + themeKey + "' already has weight " + weight + "."); + return false; + } + updated.add(new IrisJigsawThemeSet(themeKey, weight)); + found = true; + } else if (theme != null) { + updated.add(new IrisJigsawThemeSet(theme.getKey(), theme.getWeight())); + } + } + if (!found) { + message(player, "Theme set '" + themeKey + "' no longer exists."); + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + JigsawStudioStructureEditor.updateThemeSets( + request.source().getDataFolder().toPath(), + request.structureKey(), + updated); + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + "Set theme '" + themeKey + "' weight to " + weight + "."); + }); + } + + boolean updateWorkcellDisplayName( + Player player, + String workcellId, + String displayName + ) { + if (player == null || workcellId == null) { + return false; + } + if (!J.isOwnedByCurrentRegion(player)) { + return J.runEntity(player, () -> updateWorkcellDisplayName(player, workcellId, displayName)); + } + ActiveStudio studio = service.studios.get(player.getWorld().getUID()); + if (studio == null || !authorizeOwner(player, studio)) { + return false; + } + JigsawStudioSession session = studio.generator().getSession(); + JigsawStudioBay workcell = session.layout().get(workcellId); + if (workcell == null) { + message(player, "Unknown Jigsaw Studio workcell '" + workcellId + "'."); + return false; + } + String normalizedName; + try { + normalizedName = JigsawStudioGraphEditor.normalizeDisplayName(displayName); + } catch (IllegalArgumentException exception) { + message(player, exception.getMessage()); + return false; + } + String reservationFailure = service.graphMutations.beginGraphMutation(studio, session); + if (!reservationFailure.isEmpty()) { + message(player, reservationFailure); + return false; + } + JigsawStudioActivation.Request request = studio.generator().getRequest(); + JigsawPlanarArchetype archetype = workcell.archetype().orElse(null); + return service.graphMutations.scheduleGraphMutation( + player, + studio, + () -> { + if (archetype == null) { + JigsawStudioStructureEditor.updateSpatialWorkcellDisplayName( + request.source().getDataFolder().toPath(), + request.structureKey(), + normalizedName); + } else { + JigsawStudioStructureEditor.updateWorkcellDisplayName( + request.source().getDataFolder().toPath(), + request.structureKey(), + archetype, + normalizedName); + } + return new CommandGraphMutationResult( + loadMappedLayout(studio), + "", + "", + normalizedName.isEmpty() + ? "Reset the workcell label to '" + workcell.canonicalDisplayName() + "'." + : "Renamed the workcell to '" + normalizedName + "'."); + }); + } +} diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java index 0ee4480e9..cd673fa87 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioLifecycleTest.java @@ -112,18 +112,18 @@ public class JigsawStudioLifecycleTest { assertTrue(service.closeProtectionFailure(request.requestId()).contains("loading a variant")); assertTrue(session.abortVariantSwitch(switchToken)); - assertEquals(JigsawStudioService.SaveStart.STARTED, service.tryBeginSave(request.requestId())); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.STARTED, service.saveLifecycle.tryBeginSave(request.requestId())); assertEquals( JigsawStudioService.CloseStart.SAVE_IN_PROGRESS, service.tryBeginClose(request.requestId(), OWNER, true)); assertTrue(service.closeProtectionFailure(request.requestId()).contains("saving")); - service.finishSave(request.requestId()); + service.saveLifecycle.finishSave(request.requestId()); assertEquals( JigsawStudioService.CloseStart.STARTED, service.tryBeginClose(request.requestId(), OWNER, true)); assertNull(service.closeProtectionFailure(request.requestId())); - assertEquals(JigsawStudioService.SaveStart.CLOSING, service.tryBeginSave(request.requestId())); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.CLOSING, service.saveLifecycle.tryBeginSave(request.requestId())); } @Test @@ -143,7 +143,7 @@ public class JigsawStudioLifecycleTest { retry.set(invocation.getArgument(0)); return null; }); - CompletableFuture readiness = service.awaitCloseForReplacement( + CompletableFuture readiness = service.saveLifecycle.awaitCloseForReplacement( request.requestId(), OWNER); assertFalse(readiness.isDone()); @@ -167,7 +167,7 @@ public class JigsawStudioLifecycleTest { JigsawStudioService service = new JigsawStudioService(); try (MockedStatic scheduling = mockStatic(J.class)) { - CompletableFuture readiness = service.awaitCloseForReplacement( + CompletableFuture readiness = service.saveLifecycle.awaitCloseForReplacement( request.requestId(), OTHER_OWNER); assertTrue(readiness.isCompletedExceptionally()); @@ -187,9 +187,9 @@ public class JigsawStudioLifecycleTest { baseline.put("name", "iris:start"); KMap updated = new KMap<>(); updated.put("name", "iris:hall"); - assertTrue(JigsawStudioService.tileSnapshotChanged(baseline, updated)); + assertTrue(JigsawStudioTileWatcher.tileSnapshotChanged(baseline, updated)); - Class keyType = Class.forName(JigsawStudioService.class.getName() + "$JigsawTileWatchKey"); + Class keyType = Class.forName(JigsawStudioTileWatcher.class.getName() + "$JigsawTileWatchKey"); Constructor constructor = keyType.getDeclaredConstructor( UUID.class, UUID.class, int.class, int.class, int.class); constructor.setAccessible(true); @@ -213,7 +213,7 @@ public class JigsawStudioLifecycleTest { new ConcurrentHashMap<>(), ConcurrentHashMap.newKeySet(), new AtomicLong()); - Class watchType = Class.forName(JigsawStudioService.class.getName() + "$JigsawTileWatch"); + Class watchType = Class.forName(JigsawStudioTileWatcher.class.getName() + "$JigsawTileWatch"); Constructor watchConstructor = watchType.getDeclaredConstructor( keyType, studioType, @@ -231,10 +231,10 @@ public class JigsawStudioLifecycleTest { baseline, new AtomicBoolean(), new AtomicBoolean()); - Field watchesField = JigsawStudioService.class.getDeclaredField("jigsawTileWatches"); + Field watchesField = JigsawStudioTileWatcher.class.getDeclaredField("jigsawTileWatches"); watchesField.setAccessible(true); @SuppressWarnings("unchecked") - Map watches = (Map) watchesField.get(service); + Map watches = (Map) watchesField.get(service.tileWatcher); watches.put(key, watch); try (MockedStatic scheduling = mockStatic(J.class)) { @@ -277,55 +277,55 @@ public class JigsawStudioLifecycleTest { JigsawStudioService.ExportStart.IN_PROGRESS, service.tryBeginExport(request.requestId(), OWNER)); assertEquals( - JigsawStudioService.SaveStart.EXPORT_OPERATION, - service.tryBeginSave(request.requestId())); + JigsawStudioSaveLifecycle.SaveStart.EXPORT_OPERATION, + service.saveLifecycle.tryBeginSave(request.requestId())); assertEquals( JigsawStudioService.CloseStart.OPERATION_IN_PROGRESS, service.tryBeginClose(request.requestId(), OWNER, false)); assertTrue(service.closeProtectionFailure(request.requestId()).contains("exporting")); service.finishExport(request.requestId()); - assertEquals(JigsawStudioService.SaveStart.STARTED, service.tryBeginSave(request.requestId())); - service.finishSave(request.requestId()); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.STARTED, service.saveLifecycle.tryBeginSave(request.requestId())); + service.saveLifecycle.finishSave(request.requestId()); } @Test public void immediateSingleAndFamilyDuplicatesWaitForAutosaveThenRunExactlyOnce() { assertEquals( - JigsawStudioService.DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE, - JigsawStudioService.deferredDuplicationReadiness( + JigsawStudioToolbelt.DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE, + JigsawStudioToolbelt.deferredDuplicationReadiness( true, true, true, false, false)); assertEquals( - JigsawStudioService.DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE, - JigsawStudioService.deferredDuplicationReadiness( + JigsawStudioToolbelt.DeferredDuplicationReadiness.WAITING_FOR_AUTOSAVE, + JigsawStudioToolbelt.deferredDuplicationReadiness( true, true, true, true, false)); assertEquals( - JigsawStudioService.DeferredDuplicationReadiness.WAITING_FOR_OPERATION, - JigsawStudioService.deferredDuplicationReadiness( + JigsawStudioToolbelt.DeferredDuplicationReadiness.WAITING_FOR_OPERATION, + JigsawStudioToolbelt.deferredDuplicationReadiness( true, true, false, true, false)); assertEquals( - JigsawStudioService.DeferredDuplicationReadiness.READY, - JigsawStudioService.deferredDuplicationReadiness( + JigsawStudioToolbelt.DeferredDuplicationReadiness.READY, + JigsawStudioToolbelt.deferredDuplicationReadiness( true, true, false, false, false)); assertEquals( - JigsawStudioService.DeferredDuplicationReadiness.STALE, - JigsawStudioService.deferredDuplicationReadiness( + JigsawStudioToolbelt.DeferredDuplicationReadiness.STALE, + JigsawStudioToolbelt.deferredDuplicationReadiness( true, false, false, false, false)); } @Test public void initialEvaluationWaitsForCommitAndSchedulesExactlyOnce() { AtomicLong registrationBeforeCommit = new AtomicLong(); - assertFalse(JigsawStudioService.claimInitialEvaluation(registrationBeforeCommit, false)); + assertFalse(JigsawStudioEvaluator.claimInitialEvaluation(registrationBeforeCommit, false)); assertEquals(0L, registrationBeforeCommit.get()); - assertTrue(JigsawStudioService.claimInitialEvaluation(registrationBeforeCommit, true)); + assertTrue(JigsawStudioEvaluator.claimInitialEvaluation(registrationBeforeCommit, true)); assertEquals(1L, registrationBeforeCommit.get()); - assertFalse(JigsawStudioService.claimInitialEvaluation(registrationBeforeCommit, true)); + assertFalse(JigsawStudioEvaluator.claimInitialEvaluation(registrationBeforeCommit, true)); AtomicLong registrationAfterCommit = new AtomicLong(); - assertTrue(JigsawStudioService.claimInitialEvaluation(registrationAfterCommit, true)); + assertTrue(JigsawStudioEvaluator.claimInitialEvaluation(registrationAfterCommit, true)); assertEquals(1L, registrationAfterCommit.get()); - assertFalse(JigsawStudioService.claimInitialEvaluation(registrationAfterCommit, true)); + assertFalse(JigsawStudioEvaluator.claimInitialEvaluation(registrationAfterCommit, true)); } @Test @@ -339,9 +339,9 @@ public class JigsawStudioLifecycleTest { JigsawStudioBay blank = layout.get("workcell/blank"); assertTrue(session.selectedBayId().isEmpty()); - assertTrue(JigsawStudioService.selectEnteredWorkcell(session, end, true)); + assertTrue(JigsawStudioPlayerContext.selectEnteredWorkcell(session, end, true)); assertEquals(end.stableId(), session.selectedBayId().orElseThrow()); - assertFalse(JigsawStudioService.selectEnteredWorkcell(session, blank, false)); + assertFalse(JigsawStudioPlayerContext.selectEnteredWorkcell(session, blank, false)); assertEquals(end.stableId(), session.selectedBayId().orElseThrow()); } diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java index 9b86e7ac7..3b6c389aa 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioMenuControllerTest.java @@ -571,14 +571,14 @@ public class JigsawStudioMenuControllerTest { when(world.getUID()).thenReturn(worldId); when(location.getWorld()).thenReturn(world); - Field menuField = JigsawStudioService.class.getDeclaredField("menuController"); + Field menuField = JigsawStudioToolbelt.class.getDeclaredField("menuController"); menuField.setAccessible(true); - menuField.set(service, menu); + menuField.set(service.toolbelt, menu); IrisServices.register(BoardSVC.class, board); try (MockedStatic scheduling = mockStatic(J.class)) { scheduling.when(() -> J.isOwnedByCurrentRegion(player)).thenReturn(true); - service.onPlayerChangedWorld(event); + service.protectionListener.onPlayerChangedWorld(event); verify(menu).close(player); verify(board).clearJigsawContext(player); diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPreviewRendererTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPreviewRendererTest.java index 17f56dc59..f7933ddc4 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPreviewRendererTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPreviewRendererTest.java @@ -79,10 +79,10 @@ public class JigsawStudioPreviewRendererTest { 10, IrisObjectRotation.of(0, 0, 0)); - PlacedStructurePiece planar = JigsawStudioService.alignPreviewPieces( + PlacedStructurePiece planar = JigsawStudioEvaluator.alignPreviewPieces( List.of(source), JigsawStudioMode.PLANAR_JIGSAW).getFirst(); - PlacedStructurePiece spatial = JigsawStudioService.alignPreviewPieces( + PlacedStructurePiece spatial = JigsawStudioEvaluator.alignPreviewPieces( List.of(source), JigsawStudioMode.SPATIAL_JIGSAW).getFirst(); diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java index 9567bd53e..f39fbc02d 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioServiceCaptureTest.java @@ -197,11 +197,11 @@ public class JigsawStudioServiceCaptureTest { when(state.isCustom()).thenReturn(false); when(state.nativeHandle()).thenReturn(blockData); - JigsawStudioService.restoreConnectorChunk( + JigsawStudioChunkWriter.restoreConnectorChunk( world, workcell, List.of(renderedConnector), - Map.of(new JigsawStudioService.LocalPosition(1, 2, 3), renderedBlock), + Map.of(new JigsawStudioCapture.LocalPosition(1, 2, 3), renderedBlock), false); verify(world).getBlockAt(11, 22, 33); @@ -229,9 +229,9 @@ public class JigsawStudioServiceCaptureTest { expandedSpecs, JigsawStudioVariantCatalog.empty()); - assertFalse(JigsawStudioService.layoutGeometryChanged(original, original)); - assertTrue(JigsawStudioService.layoutGeometryChanged(original, expanded)); - Set chunks = JigsawStudioService.relayoutChunks(original, expanded); + assertFalse(JigsawStudioGraphMutations.layoutGeometryChanged(original, original)); + assertTrue(JigsawStudioGraphMutations.layoutGeometryChanged(original, expanded)); + Set chunks = JigsawStudioGraphMutations.relayoutChunks(original, expanded); assertTrue(chunks.contains(0L)); assertTrue(chunks.contains(((long) 4 << 32))); } @@ -248,8 +248,8 @@ public class JigsawStudioServiceCaptureTest { dimensions, new JigsawStudioVariantCatalog(List.of(), false)); - assertTrue(JigsawStudioService.canCreateVariants(editable)); - assertFalse(JigsawStudioService.canCreateVariants(managed)); + assertTrue(JigsawStudioProtection.canCreateVariants(editable)); + assertFalse(JigsawStudioProtection.canCreateVariants(managed)); } @Test @@ -269,27 +269,27 @@ public class JigsawStudioServiceCaptureTest { new JigsawStudioPoolMembership("test/pieces", 0, 4, 0.35D), new JigsawStudioPoolMembership("test/caps", 0, 7, 0.8D))); - assertEquals("", JigsawStudioService.variantCreationSourceFailure(assigned, false)); - assertEquals("", JigsawStudioService.variantCreationSourceFailure(assigned, true)); - assertTrue(JigsawStudioService.variantCreationSourceFailure(null, false) + assertEquals("", JigsawStudioProtection.variantCreationSourceFailure(assigned, false)); + assertEquals("", JigsawStudioProtection.variantCreationSourceFailure(assigned, true)); + assertTrue(JigsawStudioProtection.variantCreationSourceFailure(null, false) .contains("piece create ")); - assertTrue(JigsawStudioService.variantCreationSourceFailure(planarVariant(true, true), false) + assertTrue(JigsawStudioProtection.variantCreationSourceFailure(planarVariant(true, true), false) .contains("no owned pool membership")); - assertTrue(JigsawStudioService.variantCreationSourceFailure(planarVariant(true, false), true) + assertTrue(JigsawStudioProtection.variantCreationSourceFailure(planarVariant(true, false), true) .contains("read-only variant")); } @Test public void recognizesVanillaNamespacedAndWorldEditMutationCommands() { - assertTrue(JigsawStudioService.isMutatingCommand("/fill 0 0 0 1 1 1 stone")); - assertTrue(JigsawStudioService.isMutatingCommand("minecraft:setblock 0 0 0 air")); - assertTrue(JigsawStudioService.isMutatingCommand("//paste -a")); - assertTrue(JigsawStudioService.isMutatingCommand("/execute as @s run setblock 0 0 0 stone")); - assertTrue(JigsawStudioService.isMutatingCommand("/function test:build")); - assertTrue(JigsawStudioService.isMutatingCommand("/data merge block 0 0 0 {}")); - assertTrue(JigsawStudioService.isMutatingCommand("/item replace block 0 0 0 container.0 with stone")); - assertFalse(JigsawStudioService.isMutatingCommand("/iris jigsaw status")); - assertFalse(JigsawStudioService.isMutatingCommand("/tp 0 80 0")); + assertTrue(JigsawStudioProtection.isMutatingCommand("/fill 0 0 0 1 1 1 stone")); + assertTrue(JigsawStudioProtection.isMutatingCommand("minecraft:setblock 0 0 0 air")); + assertTrue(JigsawStudioProtection.isMutatingCommand("//paste -a")); + assertTrue(JigsawStudioProtection.isMutatingCommand("/execute as @s run setblock 0 0 0 stone")); + assertTrue(JigsawStudioProtection.isMutatingCommand("/function test:build")); + assertTrue(JigsawStudioProtection.isMutatingCommand("/data merge block 0 0 0 {}")); + assertTrue(JigsawStudioProtection.isMutatingCommand("/item replace block 0 0 0 container.0 with stone")); + assertFalse(JigsawStudioProtection.isMutatingCommand("/iris jigsaw status")); + assertFalse(JigsawStudioProtection.isMutatingCommand("/tp 0 80 0")); } @Test @@ -297,28 +297,28 @@ public class JigsawStudioServiceCaptureTest { UUID ownerId = UUID.fromString("11111111-1111-1111-1111-111111111111"); UUID otherId = UUID.fromString("22222222-2222-2222-2222-222222222222"); - assertTrue(JigsawStudioService.ownerMatches(ownerId, ownerId)); - assertTrue(JigsawStudioService.ownerMatches(null, otherId)); - assertFalse(JigsawStudioService.ownerMatches(ownerId, otherId)); - assertTrue(JigsawStudioService.blocksStudioEdit(ownerId, otherId)); - assertFalse(JigsawStudioService.blocksStudioEdit(ownerId, ownerId)); - assertFalse(JigsawStudioService.blocksStudioEdit(null, otherId)); - assertTrue(JigsawStudioService.blocksMutatingCommand(ownerId, otherId, "//paste -a")); - assertFalse(JigsawStudioService.blocksMutatingCommand(ownerId, ownerId, "//paste -a")); - assertFalse(JigsawStudioService.blocksMutatingCommand(null, otherId, "//paste -a")); - assertFalse(JigsawStudioService.blocksMutatingCommand(ownerId, otherId, "/iris jigsaw status")); - assertFalse(JigsawStudioService.blocksMutatingCommand(ownerId, otherId, "/msg owner hello")); - assertTrue(JigsawStudioService.blocksMutatingCommand(ownerId, otherId, "/execute run say bypass")); - assertTrue(JigsawStudioService.blocksMutatingCommand(ownerId, otherId, "/unknownplugin mutate")); - assertTrue(JigsawStudioService.blocksNonEditableWorkcellMutation( + assertTrue(JigsawStudioProtection.ownerMatches(ownerId, ownerId)); + assertTrue(JigsawStudioProtection.ownerMatches(null, otherId)); + assertFalse(JigsawStudioProtection.ownerMatches(ownerId, otherId)); + assertTrue(JigsawStudioProtection.blocksStudioEdit(ownerId, otherId)); + assertFalse(JigsawStudioProtection.blocksStudioEdit(ownerId, ownerId)); + assertFalse(JigsawStudioProtection.blocksStudioEdit(null, otherId)); + assertTrue(JigsawStudioProtection.blocksMutatingCommand(ownerId, otherId, "//paste -a")); + assertFalse(JigsawStudioProtection.blocksMutatingCommand(ownerId, ownerId, "//paste -a")); + assertFalse(JigsawStudioProtection.blocksMutatingCommand(null, otherId, "//paste -a")); + assertFalse(JigsawStudioProtection.blocksMutatingCommand(ownerId, otherId, "/iris jigsaw status")); + assertFalse(JigsawStudioProtection.blocksMutatingCommand(ownerId, otherId, "/msg owner hello")); + assertTrue(JigsawStudioProtection.blocksMutatingCommand(ownerId, otherId, "/execute run say bypass")); + assertTrue(JigsawStudioProtection.blocksMutatingCommand(ownerId, otherId, "/unknownplugin mutate")); + assertTrue(JigsawStudioProtection.blocksNonEditableWorkcellMutation( true, "/fill 0 0 0 1 1 1 stone")); - assertTrue(JigsawStudioService.blocksNonEditableWorkcellMutation(true, "//paste -a")); - assertFalse(JigsawStudioService.blocksNonEditableWorkcellMutation( + assertTrue(JigsawStudioProtection.blocksNonEditableWorkcellMutation(true, "//paste -a")); + assertFalse(JigsawStudioProtection.blocksNonEditableWorkcellMutation( true, "/iris jigsaw variant load test/end")); - assertFalse(JigsawStudioService.blocksNonEditableWorkcellMutation( + assertFalse(JigsawStudioProtection.blocksNonEditableWorkcellMutation( false, "/fill 0 0 0 1 1 1 stone")); - Method method = JigsawStudioService.class.getMethod( + Method method = JigsawStudioProtectionListener.class.getMethod( "onUnauthorizedPlayerCommand", PlayerCommandPreprocessEvent.class); EventHandler handler = method.getAnnotation(EventHandler.class); @@ -340,21 +340,21 @@ public class JigsawStudioServiceCaptureTest { UUID ownerId = UUID.fromString("11111111-1111-1111-1111-111111111111"); UUID otherId = UUID.fromString("22222222-2222-2222-2222-222222222222"); - assertFalse(JigsawStudioService.blocksStudioInventoryMutation( + assertFalse(JigsawStudioProtection.blocksStudioInventoryMutation( false, false, true, true, ownerId, otherId)); - assertFalse(JigsawStudioService.blocksStudioInventoryMutation( + assertFalse(JigsawStudioProtection.blocksStudioInventoryMutation( true, false, false, false, ownerId, ownerId)); - assertTrue(JigsawStudioService.blocksStudioInventoryMutation( + assertTrue(JigsawStudioProtection.blocksStudioInventoryMutation( true, false, true, false, ownerId, ownerId)); - assertTrue(JigsawStudioService.blocksStudioInventoryMutation( + assertTrue(JigsawStudioProtection.blocksStudioInventoryMutation( true, false, false, true, ownerId, ownerId)); - assertTrue(JigsawStudioService.blocksStudioInventoryMutation( + assertTrue(JigsawStudioProtection.blocksStudioInventoryMutation( true, false, false, false, ownerId, otherId)); - assertFalse(JigsawStudioService.blocksStudioInventoryMutation( + assertFalse(JigsawStudioProtection.blocksStudioInventoryMutation( true, false, false, false, ownerId, null)); - assertTrue(JigsawStudioService.blocksStudioInventoryMutation( + assertTrue(JigsawStudioProtection.blocksStudioInventoryMutation( true, true, false, false, ownerId, null)); - assertTrue(JigsawStudioService.blocksStudioInventoryMutation( + assertTrue(JigsawStudioProtection.blocksStudioInventoryMutation( true, true, false, false, ownerId, ownerId)); } @@ -394,17 +394,17 @@ public class JigsawStudioServiceCaptureTest { KMap changedAgain = new KMap<>(); changedAgain.put("name", "iris:cap"); - assertFalse(JigsawStudioService.tileSnapshotChanged(baseline, unchanged)); - assertTrue(JigsawStudioService.tileSnapshotChanged(baseline, changed)); + assertFalse(JigsawStudioTileWatcher.tileSnapshotChanged(baseline, unchanged)); + assertTrue(JigsawStudioTileWatcher.tileSnapshotChanged(baseline, changed)); assertEquals( - new JigsawStudioService.JigsawTilePollDecision(true, true), - JigsawStudioService.jigsawTilePollDecision(baseline, changed, false)); + new JigsawStudioTileWatcher.JigsawTilePollDecision(true, true), + JigsawStudioTileWatcher.jigsawTilePollDecision(baseline, changed, false)); assertEquals( - new JigsawStudioService.JigsawTilePollDecision(true, true), - JigsawStudioService.jigsawTilePollDecision(changed, changedAgain, false)); + new JigsawStudioTileWatcher.JigsawTilePollDecision(true, true), + JigsawStudioTileWatcher.jigsawTilePollDecision(changed, changedAgain, false)); assertEquals( - new JigsawStudioService.JigsawTilePollDecision(false, false), - JigsawStudioService.jigsawTilePollDecision(changedAgain, changedAgain, true)); + new JigsawStudioTileWatcher.JigsawTilePollDecision(false, false), + JigsawStudioTileWatcher.jigsawTilePollDecision(changedAgain, changedAgain, true)); } @Test @@ -412,14 +412,14 @@ public class JigsawStudioServiceCaptureTest { UUID requestId = UUID.fromString("33333333-3333-3333-3333-333333333333"); IOException validationFailure = new IOException("closure rejected an empty piece entry"); String validationDetail = "Jigsaw Studio save failed: closure rejected an empty piece entry"; - String validationContext = JigsawStudioService.autosaveFailureContext( + String validationContext = JigsawStudioAutosaveScheduler.autosaveFailureContext( requestId, "qa/profile_final", "workcell/end", "qa/profile_final/end", validationDetail); - JigsawStudioService.AutosaveFailureState validationState = - new JigsawStudioService.AutosaveFailureState(); + JigsawStudioAutosaveScheduler.AutosaveFailureState validationState = + new JigsawStudioAutosaveScheduler.AutosaveFailureState(); StructureWriteResult writerResult = new StructureWriteResult( StructureWriteResult.Status.OWNERSHIP_CONFLICT, StructureWriteResult.Action.NONE, @@ -430,18 +430,18 @@ public class JigsawStudioServiceCaptureTest { "", Optional.empty()); String writerDetail = JigsawStudioService.writeFailure(writerResult); - String writerContext = JigsawStudioService.autosaveFailureContext( + String writerContext = JigsawStudioAutosaveScheduler.autosaveFailureContext( requestId, "qa/profile_final", "workcell/end", "qa/profile_final/end", writerDetail); - JigsawStudioService.AutosaveFailureState writerState = - new JigsawStudioService.AutosaveFailureState(); + JigsawStudioAutosaveScheduler.AutosaveFailureState writerState = + new JigsawStudioAutosaveScheduler.AutosaveFailureState(); try (MockedStatic logging = mockStatic(IrisLogging.class)) { - JigsawStudioService.AutosaveFailureDecision firstValidation = - JigsawStudioService.recordPersistentAutosaveFailure( + JigsawStudioAutosaveScheduler.AutosaveFailureDecision firstValidation = + JigsawStudioAutosaveScheduler.recordPersistentAutosaveFailure( validationState, requestId, "qa/profile_final", @@ -449,8 +449,8 @@ public class JigsawStudioServiceCaptureTest { "qa/profile_final/end", validationDetail, validationFailure); - JigsawStudioService.AutosaveFailureDecision secondValidation = - JigsawStudioService.recordPersistentAutosaveFailure( + JigsawStudioAutosaveScheduler.AutosaveFailureDecision secondValidation = + JigsawStudioAutosaveScheduler.recordPersistentAutosaveFailure( validationState, requestId, "qa/profile_final", @@ -460,7 +460,7 @@ public class JigsawStudioServiceCaptureTest { validationFailure); List writerDelays = new ArrayList<>(); for (int attempt = 0; attempt < 7; attempt++) { - writerDelays.add(JigsawStudioService.recordPersistentAutosaveFailure( + writerDelays.add(JigsawStudioAutosaveScheduler.recordPersistentAutosaveFailure( writerState, requestId, "qa/profile_final", @@ -481,8 +481,8 @@ public class JigsawStudioServiceCaptureTest { logging.verify(() -> IrisLogging.warn("%s", writerContext), times(1)); } - JigsawStudioService.AutosaveFailureDecision newIdentity = - new JigsawStudioService.AutosaveFailureState().recordPersistentFailure(); + JigsawStudioAutosaveScheduler.AutosaveFailureDecision newIdentity = + new JigsawStudioAutosaveScheduler.AutosaveFailureState().recordPersistentFailure(); assertEquals(40, newIdentity.retryTicks()); assertTrue(newIdentity.logFailure()); } @@ -545,11 +545,11 @@ public class JigsawStudioServiceCaptureTest { when(generator.getLayout()).thenAnswer(invocation -> session.layout()); World world = mock(World.class); when(world.getUID()).thenReturn(worldId); - ConcurrentHashMap populations = new ConcurrentHashMap<>(); - JigsawStudioService.BayPopulation endPopulation = - new JigsawStudioService.BayPopulation(Set.of(0L), ""); - JigsawStudioService.BayPopulation straightPopulation = - new JigsawStudioService.BayPopulation(Set.of(0L), ""); + ConcurrentHashMap populations = new ConcurrentHashMap<>(); + JigsawStudioChunkWriter.BayPopulation endPopulation = + new JigsawStudioChunkWriter.BayPopulation(Set.of(0L), ""); + JigsawStudioChunkWriter.BayPopulation straightPopulation = + new JigsawStudioChunkWriter.BayPopulation(Set.of(0L), ""); endPopulation.markFullyReady(); straightPopulation.markFullyReady(); populations.put(initialEnd.stableId(), endPopulation); @@ -572,7 +572,7 @@ public class JigsawStudioServiceCaptureTest { populations, ConcurrentHashMap.newKeySet(), new AtomicLong()); - Method scheduleAutosave = JigsawStudioService.class.getDeclaredMethod( + Method scheduleAutosave = JigsawStudioAutosaveScheduler.class.getDeclaredMethod( "scheduleAutosave", studioType, JigsawStudioBay.class, @@ -606,8 +606,8 @@ public class JigsawStudioServiceCaptureTest { anyInt(), any(Runnable.class))) .thenReturn(true); - scheduleAutosave.invoke(service, studio, initialEnd, endDirty, 40); - scheduleAutosave.invoke(service, studio, initialStraight, straightDirty, 40); + scheduleAutosave.invoke(service.autosaveScheduler, studio, initialEnd, endDirty, 40); + scheduleAutosave.invoke(service.autosaveScheduler, studio, initialStraight, straightDirty, 40); assertEquals(2, delayedAutosaves.size()); JigsawStudioSession.SaveIdentity committedEnd = session.beginSave(initialEnd.stableId()) @@ -619,7 +619,7 @@ public class JigsawStudioServiceCaptureTest { dimensions, catalog); assertTrue(session.replaceLayout(replacementLayout)); - JigsawStudioBay currentStraight = JigsawStudioService.resolveCurrentAutosaveBay( + JigsawStudioBay currentStraight = JigsawStudioAutosaveScheduler.resolveCurrentAutosaveBay( session, initialStraight.stableId()); assertNotSame(initialStraight, currentStraight); @@ -676,10 +676,10 @@ public class JigsawStudioServiceCaptureTest { when(player.getWorld()).thenReturn(world); JigsawStudioService service = new JigsawStudioService(); - ConcurrentHashMap populations = new ConcurrentHashMap<>(); + ConcurrentHashMap populations = new ConcurrentHashMap<>(); populations.put( bay.stableId(), - new JigsawStudioService.BayPopulation(Set.of(0L), "workcell hydration failed")); + new JigsawStudioChunkWriter.BayPopulation(Set.of(0L), "workcell hydration failed")); Class studioType = Class.forName(JigsawStudioService.class.getName() + "$ActiveStudio"); Constructor studioConstructor = studioType.getDeclaredConstructor( UUID.class, @@ -704,11 +704,11 @@ public class JigsawStudioServiceCaptureTest { Map studios = (Map) studiosField.get(service); studios.put(worldId, studio); - Class keyType = Class.forName(JigsawStudioService.class.getName() + "$AutosaveKey"); + Class keyType = Class.forName(JigsawStudioAutosaveScheduler.class.getName() + "$AutosaveKey"); Constructor keyConstructor = keyType.getDeclaredConstructor(UUID.class, String.class); keyConstructor.setAccessible(true); Object key = keyConstructor.newInstance(requestId, bay.stableId()); - Class ticketType = Class.forName(JigsawStudioService.class.getName() + "$AutosaveTicket"); + Class ticketType = Class.forName(JigsawStudioAutosaveScheduler.class.getName() + "$AutosaveTicket"); Constructor ticketConstructor = ticketType.getDeclaredConstructor( keyType, studioType, @@ -722,15 +722,15 @@ public class JigsawStudioServiceCaptureTest { identity, new AtomicBoolean(false), new AtomicBoolean(false)); - Field autosavesField = JigsawStudioService.class.getDeclaredField("autosaves"); + Field autosavesField = JigsawStudioAutosaveScheduler.class.getDeclaredField("autosaves"); autosavesField.setAccessible(true); @SuppressWarnings("unchecked") - Map autosaves = (Map) autosavesField.get(service); + Map autosaves = (Map) autosavesField.get(service.autosaveScheduler); autosaves.put(key, ticket); Method failureStateAccessor = ticketType.getDeclaredMethod("failureState"); failureStateAccessor.setAccessible(true); - JigsawStudioService.AutosaveFailureState failureState = - (JigsawStudioService.AutosaveFailureState) failureStateAccessor.invoke(ticket); + JigsawStudioAutosaveScheduler.AutosaveFailureState failureState = + (JigsawStudioAutosaveScheduler.AutosaveFailureState) failureStateAccessor.invoke(ticket); assertEquals(40, failureState.recordPersistentFailure().retryTicks()); try (MockedStatic scheduling = mockStatic(J.class)) { @@ -745,13 +745,13 @@ public class JigsawStudioServiceCaptureTest { populations.put( bay.stableId(), - new JigsawStudioService.BayPopulation(Set.of(0L), "")); + new JigsawStudioChunkWriter.BayPopulation(Set.of(0L), "")); assertFalse(service.flushAutosave(player, bay.stableId())); assertEquals(1, autosaves.size()); assertTrue(session.isDirtyCurrent(identity)); - JigsawStudioService.BayPopulation ready = - new JigsawStudioService.BayPopulation(Set.of(0L), ""); + JigsawStudioChunkWriter.BayPopulation ready = + new JigsawStudioChunkWriter.BayPopulation(Set.of(0L), ""); ready.markFullyReady(); populations.put(bay.stableId(), ready); JigsawStudioSession.SaveIdentity inProgress = session.beginSave(bay.stableId()) @@ -773,13 +773,13 @@ public class JigsawStudioServiceCaptureTest { JigsawStudioVariant fixed = planarVariant(false, true); JigsawStudioVariant readOnly = planarVariant(true, false); - assertFalse(JigsawStudioService.canToggleVariantRotation( + assertFalse(JigsawStudioProtection.canToggleVariantRotation( JigsawStudioCompatibilityTarget.VANILLA_PORTABLE, rotatable)); - assertTrue(JigsawStudioService.canToggleVariantRotation( + assertTrue(JigsawStudioProtection.canToggleVariantRotation( JigsawStudioCompatibilityTarget.VANILLA_PORTABLE, fixed)); - assertTrue(JigsawStudioService.canToggleVariantRotation( + assertTrue(JigsawStudioProtection.canToggleVariantRotation( JigsawStudioCompatibilityTarget.IRIS_EXTENDED, rotatable)); - assertFalse(JigsawStudioService.canToggleVariantRotation( + assertFalse(JigsawStudioProtection.canToggleVariantRotation( JigsawStudioCompatibilityTarget.IRIS_EXTENDED, readOnly)); } @@ -793,22 +793,22 @@ public class JigsawStudioServiceCaptureTest { IrisJigsawConnector eastSource = connector().setDirection(IrisDirection.EAST_POSITIVE_X); IrisJigsawConnector southDisplayed = connector().setDirection(IrisDirection.SOUTH_POSITIVE_Z); - JigsawStudioService.requireWorkcellTopology( + JigsawStudioCapture.requireWorkcellTopology( layout.get("workcell/end"), List.of(eastSource), 3); - JigsawStudioService.WorkcellTopologyException wrongDirection = assertThrows( - JigsawStudioService.WorkcellTopologyException.class, - () -> JigsawStudioService.requireWorkcellTopology( + JigsawStudioCapture.WorkcellTopologyException wrongDirection = assertThrows( + JigsawStudioCapture.WorkcellTopologyException.class, + () -> JigsawStudioCapture.requireWorkcellTopology( layout.get("workcell/end"), List.of(southDisplayed), 0)); assertTrue(wrongDirection.getMessage().contains("south end (1 horizontal connector)")); assertTrue(wrongDirection.getMessage().contains("Reset Connector Blocks")); - JigsawStudioService.WorkcellTopologyException missingTee = assertThrows( - JigsawStudioService.WorkcellTopologyException.class, - () -> JigsawStudioService.requireWorkcellTopology( + JigsawStudioCapture.WorkcellTopologyException missingTee = assertThrows( + JigsawStudioCapture.WorkcellTopologyException.class, + () -> JigsawStudioCapture.requireWorkcellTopology( layout.get("workcell/tee"), List.of(), 0)); @@ -823,13 +823,13 @@ public class JigsawStudioServiceCaptureTest { 64, 0, new JigsawStudioCellDimensions(3, 1, 3)); - List areas = JigsawStudioService.chunkIntersections(bounds); + List areas = JigsawStudioCapture.chunkIntersections(bounds); PlatformBlockState sourceState = BukkitBlockState.of(directionalBlockData(BlockFace.NORTH)); for (int quarterTurns = 1; quarterTurns <= 3; quarterTurns++) { IrisObjectRotation displayRotation = IrisObjectRotation.of(0, -90.0D * quarterTurns, 0); PlatformBlockState displayedState = displayRotation.rotate(sourceState, 0, 0, 0); IrisDirection displayedDirection = displayRotation.rotate(IrisDirection.NORTH_NEGATIVE_Z); - JigsawStudioService.CapturedConnector connector = new JigsawStudioService.CapturedConnector( + JigsawStudioCapture.CapturedConnector connector = new JigsawStudioCapture.CapturedConnector( 1, 0, 1, @@ -843,14 +843,14 @@ public class JigsawStudioServiceCaptureTest { displayedState.key(), -3, 7); - JigsawStudioService.ChunkSnapshot snapshot = new JigsawStudioService.ChunkSnapshot( + JigsawStudioCapture.ChunkSnapshot snapshot = new JigsawStudioCapture.ChunkSnapshot( areas.getFirst(), List.of(), List.of(connector)); try (MockedStatic blocks = mockStatic(B.class)) { blocks.when(() -> B.getStateOrNull( displayedState.key(), false)).thenReturn(displayedState); - JigsawStudioService.Capture capture = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture capture = JigsawStudioCapture.aggregateSnapshots( bounds, areas, List.of(snapshot), @@ -888,12 +888,12 @@ public class JigsawStudioServiceCaptureTest { when(block.getBlockData()).thenReturn(chestData); World world = mock(World.class); when(world.getBlockAt(0, 64, 0)).thenReturn(block); - JigsawStudioService.ChunkCaptureArea area = JigsawStudioService.chunkIntersections(bounds).getFirst(); + JigsawStudioCapture.ChunkCaptureArea area = JigsawStudioCapture.chunkIntersections(bounds).getFirst(); - JigsawStudioService.ChunkSnapshot snapshot; + JigsawStudioCapture.ChunkSnapshot snapshot; try (MockedStatic tiles = mockStatic(TileData.class)) { tiles.when(() -> TileData.getTileState(block, false)).thenReturn(tileData); - snapshot = JigsawStudioService.captureChunkIntersection( + snapshot = JigsawStudioCapture.captureChunkIntersection( world, bounds, piece, @@ -902,7 +902,7 @@ public class JigsawStudioServiceCaptureTest { 0, false); } - JigsawStudioService.Capture capture = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture capture = JigsawStudioCapture.aggregateSnapshots( bounds, List.of(area), List.of(snapshot)); @@ -945,7 +945,7 @@ public class JigsawStudioServiceCaptureTest { IrisJigsawPiece source = pieceWithPlanarConnectors(dimensions, authoredOrders.get(index)); List captured = planarConnectors(dimensions, captureOrders.get(index)); - List ordered = JigsawStudioService.preserveCapturedConnectorOrder( + List ordered = JigsawStudioCapture.preserveCapturedConnectorOrder( source, captured); @@ -974,7 +974,7 @@ public class JigsawStudioServiceCaptureTest { dimensions, IrisDirection.EAST_POSITIVE_X); - List ordered = JigsawStudioService.preserveCapturedConnectorOrder( + List ordered = JigsawStudioCapture.preserveCapturedConnectorOrder( source, List.of(capturedEast, capturedNorth)); @@ -998,7 +998,7 @@ public class JigsawStudioServiceCaptureTest { dimensions, IrisDirection.NORTH_NEGATIVE_Z); - List ordered = JigsawStudioService.preserveCapturedConnectorOrder( + List ordered = JigsawStudioCapture.preserveCapturedConnectorOrder( source, List.of(capturedWest, capturedNorth)); @@ -1020,7 +1020,7 @@ public class JigsawStudioServiceCaptureTest { IrisJigsawConnector highZ = connectorAt(2, 3, 10); IrisJigsawConnector lowZ = connectorAt(2, 3, 4); - List ordered = JigsawStudioService.preserveCapturedConnectorOrder( + List ordered = JigsawStudioCapture.preserveCapturedConnectorOrder( source, List.of(highY, capturedNorth, highZ, lowZ)); @@ -1040,10 +1040,10 @@ public class JigsawStudioServiceCaptureTest { duplicateSource.getConnectors().add(second); IrisJigsawPiece emptySource = new IrisJigsawPiece().setConnectors(new KList<>()); - assertThrows(IOException.class, () -> JigsawStudioService.preserveCapturedConnectorOrder( + assertThrows(IOException.class, () -> JigsawStudioCapture.preserveCapturedConnectorOrder( duplicateSource, List.of(first))); - assertThrows(IOException.class, () -> JigsawStudioService.preserveCapturedConnectorOrder( + assertThrows(IOException.class, () -> JigsawStudioCapture.preserveCapturedConnectorOrder( emptySource, List.of(first, second))); } @@ -1055,7 +1055,7 @@ public class JigsawStudioServiceCaptureTest { 64, 0, new JigsawStudioCellDimensions(5, 1, 3)); - List areas = JigsawStudioService.chunkIntersections(bounds); + List areas = JigsawStudioCapture.chunkIntersections(bounds); IrisJigsawConnector sourceFirst = connectorAt(0, 0, 1) .setDirection(IrisDirection.NORTH_NEGATIVE_Z); IrisJigsawConnector sourceSecond = connectorAt(2, 0, 2) @@ -1069,31 +1069,31 @@ public class JigsawStudioServiceCaptureTest { for (int quarterTurns = 1; quarterTurns <= 3; quarterTurns++) { IrisObjectRotation displayRotation = IrisObjectRotation.of(0, -90.0D * quarterTurns, 0); PlatformBlockState displayedState = displayRotation.rotate(sourceState, 0, 0, 0); - JigsawStudioService.CapturedConnector displayedFirst = displayedConnector( + JigsawStudioCapture.CapturedConnector displayedFirst = displayedConnector( sourceFirst, bounds.dimensions(), quarterTurns, displayRotation, displayedState.key()); - JigsawStudioService.CapturedConnector displayedSecond = displayedConnector( + JigsawStudioCapture.CapturedConnector displayedSecond = displayedConnector( sourceSecond, bounds.dimensions(), quarterTurns, displayRotation, displayedState.key()); - JigsawStudioService.ChunkSnapshot snapshot = new JigsawStudioService.ChunkSnapshot( + JigsawStudioCapture.ChunkSnapshot snapshot = new JigsawStudioCapture.ChunkSnapshot( areas.getFirst(), List.of(), List.of(displayedSecond, displayedFirst)); try (MockedStatic blocks = mockStatic(B.class)) { blocks.when(() -> B.getStateOrNull(displayedState.key(), false)).thenReturn(displayedState); - JigsawStudioService.Capture capture = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture capture = JigsawStudioCapture.aggregateSnapshots( bounds, areas, List.of(snapshot), quarterTurns); - List ordered = JigsawStudioService.preserveCapturedConnectorOrder( + List ordered = JigsawStudioCapture.preserveCapturedConnectorOrder( source, capture.connectors()); @@ -1110,7 +1110,7 @@ public class JigsawStudioServiceCaptureTest { 64, 0, new JigsawStudioCellDimensions(5, 2, 3)); - List areas = JigsawStudioService.chunkIntersections(bounds); + List areas = JigsawStudioCapture.chunkIntersections(bounds); KMap properties = new KMap<>(); properties.put("CustomName", "QA Chest"); properties.put("Lock", "iris:test"); @@ -1124,18 +1124,18 @@ public class JigsawStudioServiceCaptureTest { for (int quarterTurns = 1; quarterTurns <= 3; quarterTurns++) { BlockData displayedData = directionalBlockData(Material.CHEST, BlockFace.EAST); PlatformBlockState displayedState = BukkitBlockState.of(displayedData); - JigsawStudioService.CapturedBlock capturedBlock = new JigsawStudioService.CapturedBlock( + JigsawStudioCapture.CapturedBlock capturedBlock = new JigsawStudioCapture.CapturedBlock( 1, 1, 1, displayedState, tileData); - JigsawStudioService.ChunkSnapshot snapshot = new JigsawStudioService.ChunkSnapshot( + JigsawStudioCapture.ChunkSnapshot snapshot = new JigsawStudioCapture.ChunkSnapshot( areas.getFirst(), List.of(capturedBlock), List.of()); - JigsawStudioService.Capture capture = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture capture = JigsawStudioCapture.aggregateSnapshots( bounds, areas, List.of(snapshot), @@ -1163,7 +1163,7 @@ public class JigsawStudioServiceCaptureTest { List.of(new JigsawStudioGenerator.RenderedBlock(0, 0, 0, state, tileData)), List.of()); - assertEquals("", JigsawStudioService.validateMaterialization(rendered)); + assertEquals("", JigsawStudioChunkWriter.validateMaterialization(rendered)); } @Test @@ -1172,8 +1172,8 @@ public class JigsawStudioServiceCaptureTest { BlockData air = blockData(Material.AIR, "minecraft:air"); BlockData structureVoid = blockData(Material.STRUCTURE_VOID, "minecraft:structure_void"); - JigsawStudioService.storeConnectorFinalState(object, 0, 0, 0, air); - JigsawStudioService.storeConnectorFinalState(object, 1, 0, 0, structureVoid); + JigsawStudioCapture.storeConnectorFinalState(object, 0, 0, 0, air); + JigsawStudioCapture.storeConnectorFinalState(object, 1, 0, 0, structureVoid); IrisBlockVector airPosition = object.getSigned(0, 0, 0); IrisBlockVector structureVoidPosition = object.getSigned(1, 0, 0); @@ -1194,10 +1194,10 @@ public class JigsawStudioServiceCaptureTest { when(sourceAir.key()).thenReturn("minecraft:air"); source.setUnsigned(0, 0, 0, sourceAir); - PlatformBlockState retained = JigsawStudioService.retainedSourceAir(source, 0, 0, 0, air); + PlatformBlockState retained = JigsawStudioCapture.retainedSourceAir(source, 0, 0, 0, air); assertNotNull(retained); - assertNull(JigsawStudioService.retainedSourceAir(source, 1, 0, 0, air)); - assertNull(JigsawStudioService.retainedSourceAir(source, 0, 0, 0, structureVoid)); + assertNull(JigsawStudioCapture.retainedSourceAir(source, 1, 0, 0, air)); + assertNull(JigsawStudioCapture.retainedSourceAir(source, 0, 0, 0, structureVoid)); IrisObject captured = new IrisObject(2, 2, 2); captured.setUnsigned(0, 0, 0, retained); @@ -1239,7 +1239,7 @@ public class JigsawStudioServiceCaptureTest { IrisJigsawPiece piece = new IrisJigsawPiece().setConnectors(new KList<>()); piece.getConnectors().add(source); - KMap nbt = JigsawStudioService.markerNbt(source); + KMap nbt = JigsawStudioChunkWriter.markerNbt(source); assertEquals("iris:fort/start", nbt.get("pool")); assertEquals("iris:door", nbt.get("name")); assertEquals(-4, nbt.get("selection_priority")); @@ -1250,7 +1250,7 @@ public class JigsawStudioServiceCaptureTest { .setPool("fort/start") .setName("iris:door") .setTargetName("iris:door"); - JigsawStudioService.restoreCapturedMetadata(captured, piece); + JigsawStudioChunkWriter.restoreCapturedMetadata(captured, piece); assertEquals("fort/start", captured.getPool()); assertEquals("door", captured.getName()); @@ -1260,7 +1260,7 @@ public class JigsawStudioServiceCaptureTest { @Test public void authoredBayReadinessRequiresEveryChunkToPopulateAndHydrate() { - JigsawStudioService.BayPopulation population = new JigsawStudioService.BayPopulation( + JigsawStudioChunkWriter.BayPopulation population = new JigsawStudioChunkWriter.BayPopulation( Set.of(11L, 12L), ""); assertFalse(population.readiness().ready()); @@ -1275,7 +1275,7 @@ public class JigsawStudioServiceCaptureTest { population.markApplied(12L); population.markHydrated(12L); - JigsawStudioService.BayReadiness readiness = population.readiness(); + JigsawStudioSaveLifecycle.BayReadiness readiness = population.readiness(); assertTrue(readiness.ready()); assertEquals(2, readiness.requiredChunks()); assertEquals(2, readiness.generatedChunks()); @@ -1293,9 +1293,9 @@ public class JigsawStudioServiceCaptureTest { new JigsawStudioVariantCatalog(List.of(planarVariant(true, true)))); JigsawStudioBay blank = layout.get("workcell/blank"); long chunkKey = ((long) 1 << 32) ^ 1L; - JigsawStudioService.BayPopulation population = - new JigsawStudioService.BayPopulation(Set.of(chunkKey), ""); - ConcurrentHashMap populations = new ConcurrentHashMap<>(); + JigsawStudioChunkWriter.BayPopulation population = + new JigsawStudioChunkWriter.BayPopulation(Set.of(chunkKey), ""); + ConcurrentHashMap populations = new ConcurrentHashMap<>(); populations.put(blank.stableId(), population); World world = mock(World.class); @@ -1339,7 +1339,7 @@ public class JigsawStudioServiceCaptureTest { when(event.getWorld()).thenReturn(world); when(event.getChunk()).thenReturn(chunk); - service.onChunkLoad(event); + service.protectionListener.onChunkLoad(event); assertTrue(population.needsApplication(chunkKey)); assertEquals(1, population.readiness().generatedChunks()); @@ -1348,7 +1348,7 @@ public class JigsawStudioServiceCaptureTest { @Test public void hydrationFailurePermanentlyBlocksSaveReadiness() { - JigsawStudioService.BayPopulation population = new JigsawStudioService.BayPopulation( + JigsawStudioChunkWriter.BayPopulation population = new JigsawStudioChunkWriter.BayPopulation( Set.of(27L), ""); population.markGenerated(27L); population.markApplied(27L); @@ -1369,20 +1369,20 @@ public class JigsawStudioServiceCaptureTest { 9, new JigsawStudioCellDimensions(25, 3, 20)); - List areas = JigsawStudioService.chunkIntersections(bounds); + List areas = JigsawStudioCapture.chunkIntersections(bounds); assertEquals(List.of( - new JigsawStudioService.ChunkCaptureArea(-1, 0, 0, 5, 0, 7), - new JigsawStudioService.ChunkCaptureArea(-1, 1, 0, 5, 7, 20), - new JigsawStudioService.ChunkCaptureArea(0, 0, 5, 21, 0, 7), - new JigsawStudioService.ChunkCaptureArea(0, 1, 5, 21, 7, 20), - new JigsawStudioService.ChunkCaptureArea(1, 0, 21, 25, 0, 7), - new JigsawStudioService.ChunkCaptureArea(1, 1, 21, 25, 7, 20) + new JigsawStudioCapture.ChunkCaptureArea(-1, 0, 0, 5, 0, 7), + new JigsawStudioCapture.ChunkCaptureArea(-1, 1, 0, 5, 7, 20), + new JigsawStudioCapture.ChunkCaptureArea(0, 0, 5, 21, 0, 7), + new JigsawStudioCapture.ChunkCaptureArea(0, 1, 5, 21, 7, 20), + new JigsawStudioCapture.ChunkCaptureArea(1, 0, 21, 25, 0, 7), + new JigsawStudioCapture.ChunkCaptureArea(1, 1, 21, 25, 7, 20) ), areas); for (int x = 0; x < bounds.dimensions().width(); x++) { for (int z = 0; z < bounds.dimensions().depth(); z++) { int matches = 0; - for (JigsawStudioService.ChunkCaptureArea area : areas) { + for (JigsawStudioCapture.ChunkCaptureArea area : areas) { if (area.contains(x, z)) { matches++; } @@ -1399,28 +1399,28 @@ public class JigsawStudioServiceCaptureTest { 64, 0, new JigsawStudioCellDimensions(20, 2, 1)); - List areas = JigsawStudioService.chunkIntersections(bounds); + List areas = JigsawStudioCapture.chunkIntersections(bounds); PlatformBlockState stone = mock(PlatformBlockState.class); when(stone.key()).thenReturn("minecraft:stone"); - JigsawStudioService.ChunkSnapshot first = new JigsawStudioService.ChunkSnapshot( + JigsawStudioCapture.ChunkSnapshot first = new JigsawStudioCapture.ChunkSnapshot( areas.getFirst(), - List.of(new JigsawStudioService.CapturedBlock(0, 0, 0, stone, null)), + List.of(new JigsawStudioCapture.CapturedBlock(0, 0, 0, stone, null)), List.of()); - JigsawStudioService.ChunkSnapshot second = new JigsawStudioService.ChunkSnapshot( + JigsawStudioCapture.ChunkSnapshot second = new JigsawStudioCapture.ChunkSnapshot( areas.getLast(), - List.of(new JigsawStudioService.CapturedBlock(8, 1, 0, stone, null)), + List.of(new JigsawStudioCapture.CapturedBlock(8, 1, 0, stone, null)), List.of()); - JigsawStudioService.Capture forward = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture forward = JigsawStudioCapture.aggregateSnapshots( bounds, areas, List.of(first, second)); - JigsawStudioService.Capture reverse = JigsawStudioService.aggregateSnapshots( + JigsawStudioCapture.Capture reverse = JigsawStudioCapture.aggregateSnapshots( bounds, areas, List.of(second, first)); assertArrayEquals(forward.objectContent(), reverse.objectContent()); assertFalse(forward.hasBlockEntities()); assertTrue(forward.connectors().isEmpty()); assertThrows(IOException.class, - () -> JigsawStudioService.aggregateSnapshots(bounds, areas, List.of(first))); + () -> JigsawStudioCapture.aggregateSnapshots(bounds, areas, List.of(first))); } @Test @@ -1429,14 +1429,14 @@ public class JigsawStudioServiceCaptureTest { UUID firstRequest = UUID.fromString("44444444-4444-4444-4444-444444444444"); UUID secondRequest = UUID.fromString("55555555-5555-5555-5555-555555555555"); - assertEquals(JigsawStudioService.SaveStart.STARTED, service.tryBeginSave(firstRequest)); - assertEquals(JigsawStudioService.SaveStart.IN_PROGRESS, service.tryBeginSave(firstRequest)); - assertEquals(JigsawStudioService.SaveStart.STARTED, service.tryBeginSave(secondRequest)); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.STARTED, service.saveLifecycle.tryBeginSave(firstRequest)); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.IN_PROGRESS, service.saveLifecycle.tryBeginSave(firstRequest)); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.STARTED, service.saveLifecycle.tryBeginSave(secondRequest)); - service.finishSave(firstRequest); - assertEquals(JigsawStudioService.SaveStart.STARTED, service.tryBeginSave(firstRequest)); - service.finishSave(firstRequest); - service.finishSave(secondRequest); + service.saveLifecycle.finishSave(firstRequest); + assertEquals(JigsawStudioSaveLifecycle.SaveStart.STARTED, service.saveLifecycle.tryBeginSave(firstRequest)); + service.saveLifecycle.finishSave(firstRequest); + service.saveLifecycle.finishSave(secondRequest); } private static IrisJigsawConnector connector() { @@ -1496,7 +1496,7 @@ public class JigsawStudioServiceCaptureTest { return directions; } - private static JigsawStudioService.CapturedConnector displayedConnector( + private static JigsawStudioCapture.CapturedConnector displayedConnector( IrisJigsawConnector source, JigsawStudioCellDimensions displayDimensions, int displayRotationQuarterTurns, @@ -1507,7 +1507,7 @@ public class JigsawStudioServiceCaptureTest { source.getPosition(), displayDimensions, displayRotationQuarterTurns); - return new JigsawStudioService.CapturedConnector( + return new JigsawStudioCapture.CapturedConnector( displayedPosition.getX(), displayedPosition.getY(), displayedPosition.getZ(), @@ -1629,7 +1629,7 @@ public class JigsawStudioServiceCaptureTest { EventPriority priority, boolean ignoreCancelled ) throws NoSuchMethodException { - Method method = JigsawStudioService.class.getMethod(methodName, eventType); + Method method = JigsawStudioProtectionListener.class.getMethod(methodName, eventType); EventHandler annotation = method.getAnnotation(EventHandler.class); assertNotNull(annotation); assertEquals(priority, annotation.priority()); diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioVisualizationBoundsTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioVisualizationBoundsTest.java index d6f97d0b0..afd1ce3f2 100644 --- a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioVisualizationBoundsTest.java +++ b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioVisualizationBoundsTest.java @@ -81,10 +81,10 @@ public class JigsawStudioVisualizationBoundsTest { List preview = emissions(fixture.player()); clearInvocations(fixture.player()); - Method draw = JigsawStudioService.class.getDeclaredMethod("drawBounds", Player.class, Location.class, - JigsawStudioBounds.class, Color.class, float.class, double.class, nested("ParticleBudget")); + Method draw = JigsawStudioVisualization.class.getDeclaredMethod("drawBounds", Player.class, Location.class, + JigsawStudioBounds.class, Color.class, float.class, double.class, visualizationNested("ParticleBudget")); draw.setAccessible(true); - Field color = JigsawStudioService.class.getDeclaredField("ASSEMBLY_PREVIEW_COLOR"); + Field color = JigsawStudioVisualization.class.getDeclaredField("ASSEMBLY_PREVIEW_COLOR"); color.setAccessible(true); invoke(draw, null, fixture.player(), viewer, bounds, color.get(null), 0.85F, 2.0D, budget(384)); @@ -122,10 +122,10 @@ public class JigsawStudioVisualizationBoundsTest { assertTrue(fixture.service().showAssemblyPreview(fixture.player(), List.of(piece))); } - Method draw = JigsawStudioService.class.getDeclaredMethod("drawAssemblyPreview", Player.class, - Location.class, nested("ParticleBudget")); + Method draw = JigsawStudioVisualization.class.getDeclaredMethod("drawAssemblyPreview", Player.class, + Location.class, visualizationNested("ParticleBudget")); draw.setAccessible(true); - invoke(draw, fixture.service(), fixture.player(), new Location(fixture.world(), 201, 65, 201), budget(384)); + invoke(draw, fixture.service().visualization, fixture.player(), new Location(fixture.world(), 201, 65, 201), budget(384)); assertTrue(emissions(fixture.player()).stream().anyMatch(emission -> emission.x() == 201 && emission.y() == 65 && emission.z() == 201)); @@ -157,24 +157,24 @@ public class JigsawStudioVisualizationBoundsTest { Object studio = constructor.newInstance(worldId, world, mock(Engine.class), generator, new ConcurrentHashMap<>(), ConcurrentHashMap.newKeySet(), new AtomicLong()); JigsawStudioService service = new JigsawStudioService(); - map(service, "studios").put(worldId, studio); + map(service, JigsawStudioService.class, "studios").put(worldId, studio); return new Fixture(service, player, world, requestId, studio); } private static void evaluate(Fixture fixture, JigsawStudioPreviewRenderer.PreviewBounds bounds) throws Exception { - map(fixture.service(), "evaluations").put(fixture.requestId(), new JigsawStudioGraphEvaluation( + map(fixture.service().evaluator, JigsawStudioEvaluator.class, "evaluations").put(fixture.requestId(), new JigsawStudioGraphEvaluation( fixture.requestId(), 1, 1337, JigsawStudioEvaluationState.VALID, "", 2, "", bounds)); } private static void drawLive(Fixture fixture, Location viewer, int remaining) throws Exception { - Method draw = JigsawStudioService.class.getDeclaredMethod("drawLivePreview", Player.class, Location.class, - nested("ActiveStudio"), nested("ParticleBudget")); + Method draw = JigsawStudioVisualization.class.getDeclaredMethod("drawLivePreview", Player.class, Location.class, + nested("ActiveStudio"), visualizationNested("ParticleBudget")); draw.setAccessible(true); - invoke(draw, fixture.service(), fixture.player(), viewer, fixture.studio(), budget(remaining)); + invoke(draw, fixture.service().visualization, fixture.player(), viewer, fixture.studio(), budget(remaining)); } private static Object budget(int remaining) throws Exception { - Constructor constructor = nested("ParticleBudget").getDeclaredConstructor(int.class); + Constructor constructor = visualizationNested("ParticleBudget").getDeclaredConstructor(int.class); constructor.setAccessible(true); return constructor.newInstance(remaining); } @@ -184,10 +184,14 @@ public class JigsawStudioVisualizationBoundsTest { } @SuppressWarnings("unchecked") - private static Map map(JigsawStudioService service, String name) throws Exception { - Field field = JigsawStudioService.class.getDeclaredField(name); + private static Map map(Object target, Class owner, String name) throws Exception { + Field field = owner.getDeclaredField(name); field.setAccessible(true); - return (Map) field.get(service); + return (Map) field.get(target); + } + + private static Class visualizationNested(String name) throws ClassNotFoundException { + return Class.forName(JigsawStudioVisualization.class.getName() + "$" + name); } private static void invoke(Method method, Object target, Object... arguments) throws Exception { From cab35996f830e65a52c72d4d87171185df063668 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:17:12 -0400 Subject: [PATCH 30/35] Fix identity digest separator - Separate hashed studio project entries with a space instead of a null byte - Repin the scripted session digest for the corrected separator --- .../JigsawStudioPersistenceIdentityTest.java | Bin 9937 -> 9937 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPersistenceIdentityTest.java b/core/src/test/java/art/arcane/iris/core/service/JigsawStudioPersistenceIdentityTest.java index 78b623908c597465e38a5c89717568f29fbfada8..3666610c1ea9fb9011c162e22e1212beab203520 100644 GIT binary patch delta 84 zcmccUd(n486uX15p+$nQ@|tiGi7MvW01?sb!*Ns<}y;g_)&^xp9hFszI8e oX|l1Ik*Tqnp}A3-xw(;Xilv!BT4LhnS?u@37!@{G%0+Mh01i(V@c;k- delta 84 zcmV~$yAgmO3; Date: Tue, 8 Sep 2026 06:20:22 -0400 Subject: [PATCH 31/35] Drop stale artifact entry - Remove VectorNoiseKernels2D from requiredBukkitArtifactEntries; the class was deleted with the unwired 2D kernels and verifyBukkitArtifact failed on every build --- build.gradle | 1 - 1 file changed, 1 deletion(-) diff --git a/build.gradle b/build.gradle index c5a95e685..be95a213f 100644 --- a/build.gradle +++ b/build.gradle @@ -600,7 +600,6 @@ List requiredBukkitArtifactEntries = [ 'art/arcane/iris/engine/platform/PlatformChunkGenerator.class', 'art/arcane/iris/core/lifecycle/WorldLifecycleStaging.class', 'art/arcane/iris/util/simd/VectorSimdKernels.class', - 'art/arcane/iris/util/simd/VectorNoiseKernels2D.class', 'art/arcane/iris/util/project/agent/Agent.class', 'art/arcane/iris/util/common/misc/getHardware.class', 'art/arcane/volmlib/util/io/JarScanner.class', From 355d7f4132a322249bf1b42be08b591efa9f8f67 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:20:22 -0400 Subject: [PATCH 32/35] Delete dead util duplicates - Delete unused board BoardSettings and ScoreDirection wrappers around the VolmLib board types - Delete unused inventorygui UIStaticDecorator, Window and WindowResolution wrappers around the VolmLib inventorygui types - Delete unused VectorMath subclass of the VolmLib VectorMath - Delete unused InterpolationType enum and the IrisInterpolation blerp overload that keyed on it - Delete HunkFace and point Hunk.viewFace and Hunk.cropFace at the VolmLib HunkFace - Drop the iris board and inventorygui excludes from supersededVolmLibPackages and the VectorMath entry from unusedVolmLibClasses - Drop the deleted inventorygui files from the Bukkit purity allowlist --- core/build.gradle | 3 - core/purity-allowlist.txt | 3 - .../iris/util/common/board/BoardSettings.java | 51 ----------- .../util/common/board/ScoreDirection.java | 16 ---- .../inventorygui/UIStaticDecorator.java | 40 --------- .../iris/util/common/inventorygui/Window.java | 84 ------------------- .../common/inventorygui/WindowResolution.java | 43 ---------- .../iris/util/common/math/VectorMath.java | 78 ----------------- .../arcane/iris/util/project/hunk/Hunk.java | 1 + .../iris/util/project/hunk/HunkFace.java | 42 ---------- .../interpolation/InterpolationType.java | 27 ------ .../interpolation/IrisInterpolation.java | 20 ----- 12 files changed, 1 insertion(+), 407 deletions(-) delete mode 100644 core/src/main/java/art/arcane/iris/util/common/board/BoardSettings.java delete mode 100644 core/src/main/java/art/arcane/iris/util/common/board/ScoreDirection.java delete mode 100644 core/src/main/java/art/arcane/iris/util/common/inventorygui/UIStaticDecorator.java delete mode 100644 core/src/main/java/art/arcane/iris/util/common/inventorygui/Window.java delete mode 100644 core/src/main/java/art/arcane/iris/util/common/inventorygui/WindowResolution.java delete mode 100644 core/src/main/java/art/arcane/iris/util/common/math/VectorMath.java delete mode 100644 core/src/main/java/art/arcane/iris/util/project/hunk/HunkFace.java delete mode 100644 core/src/main/java/art/arcane/iris/util/project/interpolation/InterpolationType.java diff --git a/core/build.gradle b/core/build.gradle index 326c988fc..d46b89bbc 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -269,8 +269,6 @@ List supersededVolmLibPackages = [ 'art/arcane/volmlib/util/reflect/**', 'art/arcane/volmlib/util/documentation/**', 'art/arcane/iris/core/report/**', - 'art/arcane/iris/util/common/inventorygui/**', - 'art/arcane/iris/util/common/board/**', 'art/arcane/volmlib/integration/VaultEconomy*.class' ] @@ -398,7 +396,6 @@ List unusedVolmLibClasses = [ 'art/arcane/iris/engine/object/IPostBlockAccess', 'art/arcane/iris/engine/object/IrisPotionEffect', 'art/arcane/iris/engine/platform/DummyChunkGenerator', - 'art/arcane/iris/util/common/math/VectorMath', 'art/arcane/iris/util/common/parallel/GridLock', 'art/arcane/iris/util/common/reflect/W', 'art/arcane/iris/util/slimjar/BuildConstants', diff --git a/core/purity-allowlist.txt b/core/purity-allowlist.txt index 026c9fdc3..bb2dc80e8 100644 --- a/core/purity-allowlist.txt +++ b/core/purity-allowlist.txt @@ -188,9 +188,6 @@ art/arcane/iris/util/common/director/handlers/VectorHandler.java art/arcane/iris/util/common/director/handlers/WorldHandler.java art/arcane/iris/util/common/director/specialhandlers/NullablePlayerHandler.java art/arcane/iris/util/common/format/C.java -art/arcane/iris/util/common/inventorygui/UIStaticDecorator.java -art/arcane/iris/util/common/inventorygui/Window.java -art/arcane/iris/util/common/inventorygui/WindowResolution.java art/arcane/iris/util/common/math/AxisAlignedBB.java art/arcane/iris/util/common/math/Direction.java art/arcane/iris/util/common/math/VectorMath.java diff --git a/core/src/main/java/art/arcane/iris/util/common/board/BoardSettings.java b/core/src/main/java/art/arcane/iris/util/common/board/BoardSettings.java deleted file mode 100644 index 07d27d748..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/board/BoardSettings.java +++ /dev/null @@ -1,51 +0,0 @@ -package art.arcane.iris.util.common.board; - -import art.arcane.volmlib.util.board.BoardProvider; - -public class BoardSettings { - private final BoardProvider boardProvider; - private final ScoreDirection scoreDirection; - - private BoardSettings(BoardProvider boardProvider, ScoreDirection scoreDirection) { - this.boardProvider = boardProvider; - this.scoreDirection = scoreDirection; - } - - public BoardProvider getBoardProvider() { - return boardProvider; - } - - public ScoreDirection getScoreDirection() { - return scoreDirection; - } - - public art.arcane.volmlib.util.board.BoardSettings toShared() { - return art.arcane.volmlib.util.board.BoardSettings.builder() - .boardProvider(boardProvider) - .scoreDirection(scoreDirection.toShared()) - .build(); - } - - public static Builder builder() { - return new Builder(); - } - - public static class Builder { - private BoardProvider boardProvider; - private ScoreDirection scoreDirection; - - public Builder boardProvider(BoardProvider boardProvider) { - this.boardProvider = boardProvider; - return this; - } - - public Builder scoreDirection(ScoreDirection scoreDirection) { - this.scoreDirection = scoreDirection; - return this; - } - - public BoardSettings build() { - return new BoardSettings(boardProvider, scoreDirection); - } - } -} diff --git a/core/src/main/java/art/arcane/iris/util/common/board/ScoreDirection.java b/core/src/main/java/art/arcane/iris/util/common/board/ScoreDirection.java deleted file mode 100644 index 20119cde6..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/board/ScoreDirection.java +++ /dev/null @@ -1,16 +0,0 @@ -package art.arcane.iris.util.common.board; - -public enum ScoreDirection { - UP, - DOWN; - - public art.arcane.volmlib.util.board.ScoreDirection toShared() { - return this == UP - ? art.arcane.volmlib.util.board.ScoreDirection.UP - : art.arcane.volmlib.util.board.ScoreDirection.DOWN; - } - - public static ScoreDirection fromShared(art.arcane.volmlib.util.board.ScoreDirection direction) { - return direction == art.arcane.volmlib.util.board.ScoreDirection.UP ? UP : DOWN; - } -} diff --git a/core/src/main/java/art/arcane/iris/util/common/inventorygui/UIStaticDecorator.java b/core/src/main/java/art/arcane/iris/util/common/inventorygui/UIStaticDecorator.java deleted file mode 100644 index 4bf5da6b0..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/inventorygui/UIStaticDecorator.java +++ /dev/null @@ -1,40 +0,0 @@ -/* - * Iris is a World Generator for Minecraft Bukkit Servers - * Copyright (c) 2022 Arcane Arts (Volmit Software) - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -package art.arcane.iris.util.common.inventorygui; - -import art.arcane.volmlib.util.inventorygui.WindowDecorator; - -import art.arcane.volmlib.util.inventorygui.Element; - -import art.arcane.volmlib.util.data.MaterialBlock; -import org.bukkit.Material; - -@SuppressWarnings("ClassCanBeRecord") -public class UIStaticDecorator implements WindowDecorator { - private final Element element; - - public UIStaticDecorator(Element element) { - this.element = element == null ? new art.arcane.volmlib.util.inventorygui.UIElement("bg").setMaterial(new MaterialBlock(Material.AIR)) : element; - } - - @Override - public Element onDecorateBackground(art.arcane.volmlib.util.inventorygui.Window window, int position, int row) { - return element; - } -} diff --git a/core/src/main/java/art/arcane/iris/util/common/inventorygui/Window.java b/core/src/main/java/art/arcane/iris/util/common/inventorygui/Window.java deleted file mode 100644 index fa88b247d..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/inventorygui/Window.java +++ /dev/null @@ -1,84 +0,0 @@ -package art.arcane.iris.util.common.inventorygui; - -import art.arcane.volmlib.util.inventorygui.WindowDecorator; - -import art.arcane.volmlib.util.inventorygui.Element; - -import org.bukkit.entity.Player; -import org.bukkit.inventory.ItemStack; - -public interface Window { - WindowDecorator getDecorator(); - - Window setDecorator(WindowDecorator decorator); - - art.arcane.volmlib.util.inventorygui.WindowResolution getResolution(); - - Window setResolution(art.arcane.volmlib.util.inventorygui.WindowResolution resolution); - - default Window setResolution(WindowResolution resolution) { - return setResolution(resolution.toShared()); - } - - default WindowResolution getLocalResolution() { - return WindowResolution.fromShared(getResolution()); - } - - Window clearElements(); - - Window close(); - - Window open(); - - Window callClosed(); - - Window updateInventory(); - - ItemStack computeItemStack(int viewportSlot); - - int getLayoutRow(int viewportSlottedPosition); - - int getLayoutPosition(int viewportSlottedPosition); - - int getRealLayoutPosition(int viewportSlottedPosition); - - int getRealPosition(int position, int row); - - int getRow(int realPosition); - - int getPosition(int realPosition); - - boolean isVisible(); - - Window setVisible(boolean visible); - - int getViewportPosition(); - - Window setViewportPosition(int position); - - int getViewportSlots(); - - int getMaxViewportPosition(); - - Window scroll(int direction); - - int getViewportHeight(); - - Window setViewportHeight(int height); - - String getTitle(); - - Window setTitle(String title); - - boolean hasElement(int position, int row); - - Window setElement(int position, int row, Element e); - - Element getElement(int position, int row); - - Player getViewer(); - - Window reopen(); - - Window onClosed(art.arcane.volmlib.util.scheduling.Callback window); -} diff --git a/core/src/main/java/art/arcane/iris/util/common/inventorygui/WindowResolution.java b/core/src/main/java/art/arcane/iris/util/common/inventorygui/WindowResolution.java deleted file mode 100644 index 5ddf3595e..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/inventorygui/WindowResolution.java +++ /dev/null @@ -1,43 +0,0 @@ -package art.arcane.iris.util.common.inventorygui; - -import org.bukkit.event.inventory.InventoryType; - -public enum WindowResolution { - W9_H6(9, 6, InventoryType.CHEST), - W5_H1(5, 1, InventoryType.HOPPER), - W3_H3(3, 3, InventoryType.DROPPER); - - private final int width; - private final int maxHeight; - private final InventoryType type; - - WindowResolution(int w, int h, InventoryType type) { - this.width = w; - this.maxHeight = h; - this.type = type; - } - - public int getMaxWidthOffset() { - return (getWidth() - 1) / 2; - } - - public int getWidth() { - return width; - } - - public int getMaxHeight() { - return maxHeight; - } - - public InventoryType getType() { - return type; - } - - public art.arcane.volmlib.util.inventorygui.WindowResolution toShared() { - return art.arcane.volmlib.util.inventorygui.WindowResolution.valueOf(name()); - } - - public static WindowResolution fromShared(art.arcane.volmlib.util.inventorygui.WindowResolution resolution) { - return valueOf(resolution.name()); - } -} diff --git a/core/src/main/java/art/arcane/iris/util/common/math/VectorMath.java b/core/src/main/java/art/arcane/iris/util/common/math/VectorMath.java deleted file mode 100644 index df7425321..000000000 --- a/core/src/main/java/art/arcane/iris/util/common/math/VectorMath.java +++ /dev/null @@ -1,78 +0,0 @@ -package art.arcane.iris.util.common.math; - -import org.bukkit.util.Vector; - -public class VectorMath extends art.arcane.volmlib.util.math.VectorMath { - public static Vector rotate(Direction current, Direction to, Vector v) { - if (current.equals(to)) { - return v; - } else if (current.equals(to.reverse())) { - if (current.isVertical()) { - return new Vector(v.getX(), -v.getY(), v.getZ()); - } else { - return new Vector(-v.getX(), v.getY(), -v.getZ()); - } - } else { - Vector c = current.toVector().clone().add(to.toVector()); - - if (c.getX() == 0) { - if (c.getY() != c.getZ()) { - return rotate90CX(v); - } - - return rotate90CCX(v); - } else if (c.getY() == 0) { - if (c.getX() != c.getZ()) { - return rotate90CY(v); - } - - return rotate90CCY(v); - } else if (c.getZ() == 0) { - if (c.getX() != c.getY()) { - return rotate90CZ(v); - } - - return rotate90CCZ(v); - } - } - - return v; - } - - public static Vector rotate(Direction current, Direction to, Vector v, int w, int h, int d) { - if (current.equals(to)) { - return v; - } else if (current.equals(to.reverse())) { - if (current.isVertical()) { - return new Vector(v.getX(), -v.getY() + h, v.getZ()); - } else { - return new Vector(-v.getX() + w, v.getY(), -v.getZ() + d); - } - } else { - Vector c = current.toVector().clone().add(to.toVector()); - - if (c.getX() == 0) { - if (c.getY() != c.getZ()) { - return rotate90CX(v, d); - } - - return rotate90CCX(v, h); - } else if (c.getY() == 0) { - if (c.getX() != c.getZ()) { - return rotate90CY(v, d); - } - - return rotate90CCY(v, w); - } else if (c.getZ() == 0) { - if (c.getX() != c.getY()) { - return rotate90CZ(v, w); - } - - return rotate90CCZ(v, h); - } - } - - return v; - } - -} diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/Hunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/Hunk.java index 57e10df6f..37eaac79f 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/Hunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/Hunk.java @@ -36,6 +36,7 @@ import art.arcane.volmlib.util.hunk.HunkCoreSupport; import art.arcane.volmlib.util.hunk.HunkInterpolationSupport; import art.arcane.volmlib.util.hunk.HunkMutationSupport; import art.arcane.volmlib.util.hunk.HunkSectionSupport; +import art.arcane.volmlib.util.hunk.HunkFace; import art.arcane.volmlib.util.hunk.HunkLike; import art.arcane.iris.util.project.hunk.storage.ArrayHunk; import art.arcane.iris.util.project.hunk.storage.AtomicDoubleHunk; diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/HunkFace.java b/core/src/main/java/art/arcane/iris/util/project/hunk/HunkFace.java deleted file mode 100644 index ec8e58a21..000000000 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/HunkFace.java +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Iris is a World Generator for Minecraft Bukkit Servers - * Copyright (c) 2022 Arcane Arts (Volmit Software) - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -package art.arcane.iris.util.project.hunk; - -public enum HunkFace { - TOP(art.arcane.volmlib.util.hunk.HunkFace.TOP), - BOTTOM(art.arcane.volmlib.util.hunk.HunkFace.BOTTOM), - EAST(art.arcane.volmlib.util.hunk.HunkFace.EAST), - WEST(art.arcane.volmlib.util.hunk.HunkFace.WEST), - NORTH(art.arcane.volmlib.util.hunk.HunkFace.NORTH), - SOUTH(art.arcane.volmlib.util.hunk.HunkFace.SOUTH); - - private final art.arcane.volmlib.util.hunk.HunkFace shared; - - HunkFace(art.arcane.volmlib.util.hunk.HunkFace shared) { - this.shared = shared; - } - - public art.arcane.volmlib.util.hunk.HunkFace shared() { - return shared; - } - - public static HunkFace fromShared(art.arcane.volmlib.util.hunk.HunkFace shared) { - return HunkFace.valueOf(shared.name()); - } -} diff --git a/core/src/main/java/art/arcane/iris/util/project/interpolation/InterpolationType.java b/core/src/main/java/art/arcane/iris/util/project/interpolation/InterpolationType.java deleted file mode 100644 index 03a3b8279..000000000 --- a/core/src/main/java/art/arcane/iris/util/project/interpolation/InterpolationType.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Iris is a World Generator for Minecraft Bukkit Servers - * Copyright (c) 2022 Arcane Arts (Volmit Software) - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -package art.arcane.iris.util.project.interpolation; - -public enum InterpolationType { - LINEAR, - PARAMETRIC_2, - PARAMETRIC_4, - BEZIER, - NONE -} \ No newline at end of file diff --git a/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java b/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java index 47bc6036e..93155996c 100644 --- a/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java +++ b/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java @@ -63,26 +63,6 @@ public class IrisInterpolation { return a + (parametric(f, v) * (b - a)); } - public static double blerp(double a, double b, double c, double d, double tx, double ty, InterpolationType type) { - if (type.equals(InterpolationType.LINEAR)) { - return blerp(a, b, c, d, tx, ty); - } - - if (type.equals(InterpolationType.BEZIER)) { - return blerpBezier(a, b, c, d, tx, ty); - } - - if (type.equals(InterpolationType.PARAMETRIC_2)) { - return blerpParametric(a, b, c, d, tx, ty, 2); - } - - if (type.equals(InterpolationType.PARAMETRIC_4)) { - return blerpParametric(a, b, c, d, tx, ty, 4); - } - - return 0; - } - public static double blerpBezier(double a, double b, double c, double d, double tx, double ty) { return lerpBezier(lerpBezier(a, b, tx), lerpBezier(c, d, tx), ty); } From 3551614088ba0d8f607809631af95d161c770859 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:22:18 -0400 Subject: [PATCH 33/35] Extend VolmLib storage hunks - Make StorageHunk, ArrayHunk, AtomicHunk, SynchronizedArrayHunk, AtomicDoubleHunk, AtomicIntegerHunk and AtomicLongHunk extend their VolmLib counterparts and only bind the Iris Hunk interface - Drop the Lombok data, equals and hashCode generation the duplicated storage hunks carried - Ship the VolmLib storage hunks by removing their unusedVolmLibClasses entries --- core/build.gradle | 5 --- .../util/project/hunk/storage/ArrayHunk.java | 33 +--------------- .../hunk/storage/AtomicDoubleHunk.java | 30 +-------------- .../util/project/hunk/storage/AtomicHunk.java | 37 +----------------- .../hunk/storage/AtomicIntegerHunk.java | 31 +-------------- .../project/hunk/storage/AtomicLongHunk.java | 31 +-------------- .../project/hunk/storage/StorageHunk.java | 22 +---------- .../hunk/storage/SynchronizedArrayHunk.java | 38 +------------------ 8 files changed, 8 insertions(+), 219 deletions(-) diff --git a/core/build.gradle b/core/build.gradle index d46b89bbc..72cb00b4b 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -332,11 +332,6 @@ List unusedVolmLibClasses = [ 'art/arcane/volmlib/util/board/BoardUpdateTask', 'art/arcane/volmlib/util/bukkit/Placeholders', 'art/arcane/volmlib/util/hunk/HunkFactory', - 'art/arcane/volmlib/util/hunk/storage/ArrayHunk', - 'art/arcane/volmlib/util/hunk/storage/AtomicDoubleHunk', - 'art/arcane/volmlib/util/hunk/storage/AtomicIntegerHunk', - 'art/arcane/volmlib/util/hunk/storage/AtomicLongHunk', - 'art/arcane/volmlib/util/hunk/storage/SynchronizedArrayHunk', 'art/arcane/volmlib/util/hunk/view/BiomeForceBridge', 'art/arcane/volmlib/util/hunk/view/BiomeGridForceSupport', 'art/arcane/volmlib/util/hunk/view/BiomeGridHunkHolder', diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/ArrayHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/ArrayHunk.java index 57a418f6d..132f4ce12 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/ArrayHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/ArrayHunk.java @@ -18,41 +18,10 @@ package art.arcane.iris.util.project.hunk.storage; -import art.arcane.iris.engine.data.cache.Cache; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; -import java.util.Arrays; - -@SuppressWarnings("Lombok") -@Data -@EqualsAndHashCode(callSuper = false) -public class ArrayHunk extends StorageHunk implements Hunk { - private final T[] data; - - @SuppressWarnings("unchecked") +public class ArrayHunk extends art.arcane.volmlib.util.hunk.storage.ArrayHunk implements Hunk { public ArrayHunk(int w, int h, int d) { super(w, h, d); - data = (T[]) new Object[w * h * d]; - } - - @Override - public void setRaw(int x, int y, int z, T t) { - data[index(x, y, z)] = t; - } - - @Override - public T getRaw(int x, int y, int z) { - return data[index(x, y, z)]; - } - - private int index(int x, int y, int z) { - return Cache.to1D(x, y, z, getWidth(), getHeight()); - } - - @Override - public void fill(T t) { - Arrays.fill(data, t); } } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicDoubleHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicDoubleHunk.java index 10b395a59..ebca42bcf 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicDoubleHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicDoubleHunk.java @@ -18,38 +18,10 @@ package art.arcane.iris.util.project.hunk.storage; -import com.google.common.util.concurrent.AtomicDoubleArray; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; - -@SuppressWarnings({"Lombok"}) -@Data -@EqualsAndHashCode(callSuper = false) -public class AtomicDoubleHunk extends StorageHunk implements Hunk { - private final AtomicDoubleArray data; +public class AtomicDoubleHunk extends art.arcane.volmlib.util.hunk.storage.AtomicDoubleHunk implements Hunk { public AtomicDoubleHunk(int w, int h, int d) { super(w, h, d); - data = new AtomicDoubleArray(w * h * d); - } - - @Override - public boolean isAtomic() { - return true; - } - - @Override - public void setRaw(int x, int y, int z, Double t) { - data.set(index(x, y, z), t); - } - - @Override - public Double getRaw(int x, int y, int z) { - return data.get(index(x, y, z)); - } - - private int index(int x, int y, int z) { - return (z * getWidth() * getHeight()) + (y * getWidth()) + x; } } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicHunk.java index 2df03cf79..56c6850ec 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicHunk.java @@ -19,44 +19,9 @@ package art.arcane.iris.util.project.hunk.storage; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; - -import java.util.concurrent.atomic.AtomicReferenceArray; - -@SuppressWarnings({"Lombok"}) -@Data -@EqualsAndHashCode(callSuper = false) -public class AtomicHunk extends StorageHunk implements Hunk { - private final AtomicReferenceArray data; - // index() runs per block access on the hottest paths; two final-field multiplies beat - // re-deriving the strides through the accessors every call. - private final int xStride; - private final int zStride; +public class AtomicHunk extends art.arcane.volmlib.util.hunk.storage.AtomicHunk implements Hunk { public AtomicHunk(int w, int h, int d) { super(w, h, d); - data = new AtomicReferenceArray<>(w * h * d); - xStride = w; - zStride = w * h; - } - - @Override - public boolean isAtomic() { - return true; - } - - @Override - public void setRaw(int x, int y, int z, T t) { - data.set(index(x, y, z), t); - } - - @Override - public T getRaw(int x, int y, int z) { - return data.get(index(x, y, z)); - } - - private int index(int x, int y, int z) { - return (z * zStride) + (y * xStride) + x; } } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicIntegerHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicIntegerHunk.java index 24672403b..c2f1883ea 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicIntegerHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicIntegerHunk.java @@ -19,38 +19,9 @@ package art.arcane.iris.util.project.hunk.storage; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; - -import java.util.concurrent.atomic.AtomicIntegerArray; - -@SuppressWarnings({"Lombok"}) -@Data -@EqualsAndHashCode(callSuper = false) -public class AtomicIntegerHunk extends StorageHunk implements Hunk { - private final AtomicIntegerArray data; +public class AtomicIntegerHunk extends art.arcane.volmlib.util.hunk.storage.AtomicIntegerHunk implements Hunk { public AtomicIntegerHunk(int w, int h, int d) { super(w, h, d); - data = new AtomicIntegerArray(w * h * d); - } - - @Override - public boolean isAtomic() { - return true; - } - - @Override - public void setRaw(int x, int y, int z, Integer t) { - data.set(index(x, y, z), t); - } - - @Override - public Integer getRaw(int x, int y, int z) { - return data.get(index(x, y, z)); - } - - private int index(int x, int y, int z) { - return (z * getWidth() * getHeight()) + (y * getWidth()) + x; } } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicLongHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicLongHunk.java index 89c76128f..913f36f32 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicLongHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/AtomicLongHunk.java @@ -19,38 +19,9 @@ package art.arcane.iris.util.project.hunk.storage; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; - -import java.util.concurrent.atomic.AtomicLongArray; - -@SuppressWarnings({"Lombok"}) -@Data -@EqualsAndHashCode(callSuper = false) -public class AtomicLongHunk extends StorageHunk implements Hunk { - private final AtomicLongArray data; +public class AtomicLongHunk extends art.arcane.volmlib.util.hunk.storage.AtomicLongHunk implements Hunk { public AtomicLongHunk(int w, int h, int d) { super(w, h, d); - data = new AtomicLongArray(w * h * d); - } - - @Override - public boolean isAtomic() { - return true; - } - - @Override - public void setRaw(int x, int y, int z, Long t) { - data.set(index(x, y, z), t); - } - - @Override - public Long getRaw(int x, int y, int z) { - return data.get(index(x, y, z)); - } - - private int index(int x, int y, int z) { - return (z * getWidth() * getHeight()) + (y * getWidth()) + x; } } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/StorageHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/StorageHunk.java index feac57805..74fb6a616 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/StorageHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/StorageHunk.java @@ -19,27 +19,9 @@ package art.arcane.iris.util.project.hunk.storage; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; - -@Data -public abstract class StorageHunk implements Hunk { - private final int width; - private final int height; - private final int depth; +public abstract class StorageHunk extends art.arcane.volmlib.util.hunk.storage.StorageHunk implements Hunk { public StorageHunk(int width, int height, int depth) { - if (width <= 0 || height <= 0 || depth <= 0) { - throw new RuntimeException("Unsupported size " + width + " " + height + " " + depth); - } - - this.width = width; - this.height = height; - this.depth = depth; + super(width, height, depth); } - - @Override - public abstract void setRaw(int x, int y, int z, T t); - - @Override - public abstract T getRaw(int x, int y, int z); } diff --git a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/SynchronizedArrayHunk.java b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/SynchronizedArrayHunk.java index 4395a1b5a..6f6f08893 100644 --- a/core/src/main/java/art/arcane/iris/util/project/hunk/storage/SynchronizedArrayHunk.java +++ b/core/src/main/java/art/arcane/iris/util/project/hunk/storage/SynchronizedArrayHunk.java @@ -19,45 +19,9 @@ package art.arcane.iris.util.project.hunk.storage; import art.arcane.iris.util.project.hunk.Hunk; -import lombok.Data; -import lombok.EqualsAndHashCode; -import java.util.Arrays; - -@SuppressWarnings({"Lombok"}) -@Data -@EqualsAndHashCode(callSuper = false) -public class SynchronizedArrayHunk extends StorageHunk implements Hunk { - private final T[] data; - - @SuppressWarnings("unchecked") +public class SynchronizedArrayHunk extends art.arcane.volmlib.util.hunk.storage.SynchronizedArrayHunk implements Hunk { public SynchronizedArrayHunk(int w, int h, int d) { super(w, h, d); - data = (T[]) new Object[w * h * d]; - } - - @Override - public void setRaw(int x, int y, int z, T t) { - synchronized (data) { - data[index(x, y, z)] = t; - } - } - - @Override - public T getRaw(int x, int y, int z) { - synchronized (data) { - return data[index(x, y, z)]; - } - } - - private int index(int x, int y, int z) { - return (z * getWidth() * getHeight()) + (y * getWidth()) + x; - } - - @Override - public void fill(T t) { - synchronized (data) { - Arrays.fill(data, t); - } } } From 114cc68a08ca44eefda2fd39a7c655f72abb477c Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:24:20 -0400 Subject: [PATCH 34/35] Extend VolmLib interpolation - Make IrisInterpolation extend the VolmLib IrisInterpolation and delete the nine numerically identical statics it duplicated: hermite, cubic, bicubic, bihermite, trihermite, tricubic, lerp, blerp and trilerp - Keep the Iris rangeScale because the VolmLib copy short-circuits bmax == bmin and generation output must not move - Ship the VolmLib IrisInterpolation and InterpolationMethod by removing their unusedVolmLibClasses entries --- core/build.gradle | 2 - .../interpolation/IrisInterpolation.java | 126 +----------------- 2 files changed, 1 insertion(+), 127 deletions(-) diff --git a/core/build.gradle b/core/build.gradle index 72cb00b4b..9b3772ca3 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -321,8 +321,6 @@ List unusedVolmLibClasses = [ 'art/arcane/volmlib/util/director/DirectorNodeBase', 'art/arcane/volmlib/util/director/DirectorParameterBase', 'art/arcane/volmlib/util/director/theme/DirectorThemes', - 'art/arcane/volmlib/util/interpolation/InterpolationMethod', - 'art/arcane/volmlib/util/interpolation/IrisInterpolation', 'art/arcane/volmlib/util/math/INode', 'art/arcane/volmlib/util/math/IrisMathHelper', 'art/arcane/volmlib/util/math/KochanekBartelsInterpolation', diff --git a/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java b/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java index 93155996c..5103379b0 100644 --- a/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java +++ b/core/src/main/java/art/arcane/iris/util/project/interpolation/IrisInterpolation.java @@ -24,7 +24,7 @@ import art.arcane.volmlib.util.function.NoiseProvider; import art.arcane.volmlib.util.math.RNG; import art.arcane.iris.util.project.noise.CNG; -public class IrisInterpolation { +public class IrisInterpolation extends art.arcane.volmlib.util.interpolation.IrisInterpolation { private static final double[][] STARCAST_OFFSETS = createStarcastOffsets(); public static CNG cng = NoiseStyle.SIMPLEX.create(new RNG()); private static final ThreadLocal NOISE_SAMPLE_CACHE_2D = ThreadLocal.withInitial(() -> new NoiseSampleCache2D(64)); @@ -113,130 +113,6 @@ public class IrisInterpolation { return parametric(cubic(p0, p1, p2, p3, mu), a); } - public static double hermite(double p0, double p1, double p2, double p3, double mu, double tension, double bias) { - double m0, m1, mu2, mu3; - double a0, a1, a2, a3; - - mu2 = mu * mu; - mu3 = mu2 * mu; - m0 = (p1 - p0) * (1 + bias) * (1 - tension) / 2; - m0 += (p2 - p1) * (1 - bias) * (1 - tension) / 2; - m1 = (p2 - p1) * (1 + bias) * (1 - tension) / 2; - m1 += (p3 - p2) * (1 - bias) * (1 - tension) / 2; - a0 = 2 * mu3 - 3 * mu2 + 1; - a1 = mu3 - 2 * mu2 + mu; - a2 = mu3 - mu2; - a3 = -2 * mu3 + 3 * mu2; - - return (a0 * p1 + a1 * m0 + a2 * m1 + a3 * p2); - } - - public static double cubic(double p0, double p1, double p2, double p3, double mu) { - double a0, a1, a2, a3, mu2; - - mu2 = mu * mu; - a0 = p3 - p2 - p0 + p1; - a1 = p0 - p1 - a0; - a2 = p2 - p0; - a3 = p1; - - return a0 * mu * mu2 + a1 * mu2 + a2 * mu + a3; - } - - public static double bicubic(double p00, double p01, double p02, double p03, double p10, double p11, double p12, double p13, double p20, double p21, double p22, double p23, double p30, double p31, double p32, double p33, double mux, double muy) { - //@builder - return cubic( - cubic(p00, p01, p02, p03, muy), - cubic(p10, p11, p12, p13, muy), - cubic(p20, p21, p22, p23, muy), - cubic(p30, p31, p32, p33, muy), - mux); - //@done - } - - public static double bihermite(double p00, double p01, double p02, double p03, double p10, double p11, double p12, double p13, double p20, double p21, double p22, double p23, double p30, double p31, double p32, double p33, double mux, double muy, double tension, double bias) { - //@builder - return hermite( - hermite(p00, p01, p02, p03, muy, tension, bias), - hermite(p10, p11, p12, p13, muy, tension, bias), - hermite(p20, p21, p22, p23, muy, tension, bias), - hermite(p30, p31, p32, p33, muy, tension, bias), - mux, tension, bias); - //@done - } - - public static double trihermite(double p000, double p001, double p002, double p003, double p010, double p011, double p012, double p013, double p020, double p021, double p022, double p023, double p030, double p031, double p032, double p033, double p100, double p101, double p102, double p103, double p110, double p111, double p112, double p113, double p120, double p121, double p122, double p123, double p130, double p131, double p132, double p133, double p200, double p201, double p202, double p203, double p210, double p211, double p212, double p213, double p220, double p221, double p222, double p223, double p230, double p231, double p232, double p233, double p300, double p301, double p302, double p303, double p310, double p311, double p312, double p313, double p320, double p321, double p322, double p323, double p330, double p331, double p332, double p333, double mux, double muy, double muz, double tension, double bias) { - //@builder - return hermite( - bihermite(p000, p001, p002, p003, - p010, p011, p012, p013, - p020, p021, p022, p023, - p030, p031, p032, p033, - mux, muy, tension, bias), - bihermite(p100, p101, p102, p103, - p110, p111, p112, p113, - p120, p121, p122, p123, - p130, p131, p132, p133, - mux, muy, tension, bias), - bihermite(p200, p201, p202, p203, - p210, p211, p212, p213, - p220, p221, p222, p223, - p230, p231, p232, p233, - mux, muy, tension, bias), - bihermite(p300, p301, p302, p303, - p310, p311, p312, p313, - p320, p321, p322, p323, - p330, p331, p332, p333, - mux, muy, tension, bias), - muz, tension, bias); - //@done - } - - public static double tricubic(double p000, - double p001, - double p002, - double p003, - double p010, - double p011, - double p012, double p013, double p020, double p021, double p022, double p023, double p030, double p031, double p032, double p033, double p100, double p101, double p102, double p103, double p110, double p111, double p112, double p113, double p120, double p121, double p122, double p123, double p130, double p131, double p132, double p133, double p200, double p201, double p202, double p203, double p210, double p211, double p212, double p213, double p220, double p221, double p222, double p223, double p230, double p231, double p232, double p233, double p300, double p301, double p302, double p303, double p310, double p311, double p312, double p313, double p320, double p321, double p322, double p323, double p330, double p331, double p332, double p333, double mux, double muy, double muz) { - //@builder - return cubic( - bicubic(p000, p001, p002, p003, - p010, p011, p012, p013, - p020, p021, p022, p023, - p030, p031, p032, p033, - mux, muy), - bicubic(p100, p101, p102, p103, - p110, p111, p112, p113, - p120, p121, p122, p123, - p130, p131, p132, p133, - mux, muy), - bicubic(p200, p201, p202, p203, - p210, p211, p212, p213, - p220, p221, p222, p223, - p230, p231, p232, p233, - mux, muy), - bicubic(p300, p301, p302, p303, - p310, p311, p312, p313, - p320, p321, p322, p323, - p330, p331, p332, p333, - mux, muy), - muz); - //@done - } - - public static double lerp(double a, double b, double f) { - return a + (f * (b - a)); - } - - public static double blerp(double a, double b, double c, double d, double tx, double ty) { - return lerp(lerp(a, b, tx), lerp(c, d, tx), ty); - } - - public static double trilerp(double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double x, double y, double z) { - return lerp(blerp(v1, v2, v3, v4, x, y), blerp(v5, v6, v7, v8, x, y), z); - } - public static double bicubicBezier(double p00, double p01, double p02, double p03, double p10, double p11, double p12, double p13, double p20, double p21, double p22, double p23, double p30, double p31, double p32, double p33, double mux, double muy) { //@builder return cubicBezier( From 425d305d0b7cfbc61362acde81ae28090f6f7ca3 Mon Sep 17 00:00:00 2001 From: Brian Neumann-Fopiano Date: Tue, 8 Sep 2026 06:36:17 -0400 Subject: [PATCH 35/35] Drop JIT-bound allocation assertion - Remove the accessor allocation comparison whose per-call byte counts depend on escape analysis timing and failed under load, keeping the three behavioral accessor tests --- .../HydrologyColumnSampleAccessorTest.java | 70 ------------------- 1 file changed, 70 deletions(-) diff --git a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java index 23f1af2cc..bda5d348e 100644 --- a/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java +++ b/core/src/test/java/art/arcane/iris/engine/hydrology/HydrologyColumnSampleAccessorTest.java @@ -1,13 +1,9 @@ package art.arcane.iris.engine.hydrology; -import org.junit.Assume; import org.junit.Test; -import java.lang.management.ManagementFactory; -import java.lang.management.ThreadMXBean; import java.util.ArrayList; import java.util.List; -import java.util.function.Supplier; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; @@ -16,9 +12,6 @@ import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; public class HydrologyColumnSampleAccessorTest { - private static final int WARMUP = 20_000; - private static final int ROUNDS = 20_000; - private static final int PASSES = 5; @Test public void theNullableSurfaceAccessorsAgreeWithTheOptionalOnes() { @@ -48,21 +41,6 @@ public class HydrologyColumnSampleAccessorTest { assertEquals(sample.primarySurfaceLayerOrNull().bedY(), sample.terrainHeight()); } - @Test - public void theNullableAccessorNeverAllocatesMoreThanTheOptionalOne() { - HydrologyColumnSample sample = sample(); - - Measurement nullable = best(() -> sample.primarySurfaceLayerOrNull()); - Measurement optional = best(() -> sample.primarySurfaceLayer().orElse(null)); - - System.out.println("[bench] primarySurfaceLayer nullable=" + nullable + " optional=" + optional); - - Assume.assumeTrue("per-thread allocation counters are unavailable on this JVM", nullable.bytes() >= 0L); - assertTrue("the nullable accessor allocated " + nullable.bytes() - + " bytes against " + optional.bytes() + " for the Optional accessor", - nullable.bytes() <= optional.bytes()); - } - private static HydrologyColumnSample sample() { List layers = new ArrayList<>(); layers.add(layer(1L, HydrologyFeatureType.RIFFLE, 66, 68, true, false, true, true)); @@ -102,52 +80,4 @@ public class HydrologyColumnSampleAccessorTest { "overworld/river-bank", "overworld/river-cave"); } - - private static Measurement best(Supplier work) { - for (int round = 0; round < WARMUP; round++) { - work.get(); - } - - long bytes = Long.MAX_VALUE; - long nanos = Long.MAX_VALUE; - for (int pass = 0; pass < PASSES; pass++) { - Measurement measured = measure(work); - if (measured.bytes() < 0L) { - return measured; - } - bytes = Math.min(bytes, measured.bytes()); - nanos = Math.min(nanos, measured.nanos()); - } - return new Measurement(bytes, nanos); - } - - private static Measurement measure(Supplier work) { - HydrologyColumnLayer sink = null; - long startBytes = allocatedBytes(); - long startNanos = System.nanoTime(); - for (int round = 0; round < ROUNDS; round++) { - sink = work.get(); - } - long elapsedNanos = System.nanoTime() - startNanos; - long endBytes = allocatedBytes(); - assertNotNull(sink); - long bytes = startBytes < 0L || endBytes < 0L ? -1L : (endBytes - startBytes) / ROUNDS; - - return new Measurement(bytes, elapsedNanos / ROUNDS); - } - - private static long allocatedBytes() { - ThreadMXBean threads = ManagementFactory.getThreadMXBean(); - if (!(threads instanceof com.sun.management.ThreadMXBean hotspot) || !hotspot.isThreadAllocatedMemoryEnabled()) { - return -1L; - } - return hotspot.getThreadAllocatedBytes(Thread.currentThread().threadId()); - } - - private record Measurement(long bytes, long nanos) { - @Override - public String toString() { - return "{bytes/op=" + bytes + ", ns/op=" + nanos + "}"; - } - } }