feat: upgrade to Gestalt 8 (#5267)

* feat: upgrade to Gestalt 8 * fix: fix failing serialisation tests due to gestalt 8 changes
MovingBlocks · Jul 29, 2024 · 7f47891 · 7f47891
1 parent 07a4555
commit 7f47891
Show file tree

Hide file tree

Showing 305 changed files with 442 additions and 312 deletions.
diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts
@@ -44,7 +44,7 @@ dependencies {
     implementation("org.jgrapht:jgrapht-core:1.5.0")
 
     // for inspecting modules
-    implementation("org.terasology.gestalt:gestalt-module:7.2.0")
+    implementation("org.terasology.gestalt:gestalt-module:8.0.0-SNAPSHOT")
 
     // plugins we configure
     implementation("com.github.spotbugs.snom:spotbugs-gradle-plugin:5.2.3")

diff --git a/build-logic/src/main/kotlin/org/terasology/gradology/module_build.kt b/build-logic/src/main/kotlin/org/terasology/gradology/module_build.kt
@@ -66,8 +66,8 @@ class ModuleMetadataForGradle(private val moduleConfig: ModuleMetadata) {
     }
 
     private fun versionStringFromGestaltDependency(gestaltDependency: DependencyInfo): String {
-        val version = if (gestaltDependency.versionPredicate() is VersionRange) {
-            gestaltDependency.versionPredicate().toString()
+        val version = if (gestaltDependency.versionRange() is VersionRange) {
+            gestaltDependency.versionRange().toString()
         } else {
             // TODO: gradle-compatible version expressions for gestalt dependencies
             //     https://github.com/MovingBlocks/gestalt/issues/114

diff --git a/build-logic/src/main/kotlin/terasology-module.gradle.kts b/build-logic/src/main/kotlin/terasology-module.gradle.kts
@@ -54,6 +54,8 @@ dependencies {
     implementation(group = "org.terasology.engine", name = "engine", version = moduleMetadata.engineVersion())
     testImplementation(group = "org.terasology.engine", name = "engine-tests", version = moduleMetadata.engineVersion())
 
+    annotationProcessor("org.terasology.gestalt:gestalt-inject-java:8.0.0-SNAPSHOT")
+
     for ((gradleDep, optional) in moduleMetadata.moduleDependencies()) {
         if (optional) {
             // `optional` module dependencies are ones it does not require for runtime
@@ -144,8 +146,17 @@ tasks.named("processResources") {
     dependsOn("syncAssets", "syncOverrides", "syncDeltas", "syncModuleInfo")
 }
 
-tasks.named("compileJava") {
+tasks.named<JavaCompile>("compileJava") {
+    dependsOn("processResources")
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.main.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.main.get().resources.srcDirs.joinToString(File.pathSeparator)}")
+}
+tasks.named<JavaCompile>("compileTestJava") {
     dependsOn("processResources")
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.test.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.test.get().resources.srcDirs.joinToString(File.pathSeparator)}")
 }
 
 tasks.named<Test>("test") {

diff --git a/engine-tests/build.gradle.kts b/engine-tests/build.gradle.kts
@@ -56,6 +56,11 @@ dependencies {
     implementation("com.google.protobuf:protobuf-java:3.16.1")
     implementation("org.terasology:reflections:0.9.12-MB")
 
+    implementation("com.github.zafarkhaja:java-semver:0.10.2")
+
+    annotationProcessor("org.terasology.gestalt:gestalt-inject-java:8.0.0-SNAPSHOT")
+    testAnnotationProcessor("org.terasology.gestalt:gestalt-inject-java:8.0.0-SNAPSHOT")
+
     implementation("org.terasology.joml-ext:joml-test:0.1.0")
 
     testImplementation("ch.qos.logback:logback-classic:1.4.14") {
@@ -91,8 +96,17 @@ tasks.register<Copy>("copyResourcesToClasses") {
     into(sourceSets["main"].output.classesDirs.first())
 }
 
-tasks.named("compileJava") {
+tasks.named<JavaCompile>("compileJava") {
+    dependsOn("copyResourcesToClasses")
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.main.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.main.get().resources.srcDirs.joinToString(File.pathSeparator)}")
+}
+tasks.named<JavaCompile>("compileTestJava") {
     dependsOn("copyResourcesToClasses")
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.test.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.test.get().resources.srcDirs.joinToString(File.pathSeparator)}")
 }
 
 tasks.withType<Jar> {

diff --git a/engine-tests/src/main/java/org/terasology/unittest/ExampleClass.java b/engine-tests/src/main/java/org/terasology/unittest/ExampleClass.java
@@ -3,7 +3,7 @@
 
 package org.terasology.unittest;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 
 @API
 public class ExampleClass implements ExampleInterface {

diff --git a/engine-tests/src/main/java/org/terasology/unittest/ExampleInterface.java b/engine-tests/src/main/java/org/terasology/unittest/ExampleInterface.java
@@ -3,8 +3,10 @@
 
 package org.terasology.unittest;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
+import org.terasology.context.annotation.IndexInherited;
 
 @API
+@IndexInherited
 public interface ExampleInterface {
 }
diff --git a/engine-tests/src/main/java/org/terasology/unittest/stubs/package-info.java b/engine-tests/src/main/java/org/terasology/unittest/stubs/package-info.java
@@ -4,4 +4,4 @@
 @API
 package org.terasology.unittest.stubs;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
diff --git a/engine-tests/src/main/java/org/terasology/unittest/worlds/package-info.java b/engine-tests/src/main/java/org/terasology/unittest/worlds/package-info.java
@@ -4,4 +4,4 @@
 @API
 package org.terasology.unittest.worlds;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
diff --git a/engine-tests/src/test/java/org/terasology/documentation/ApiScraper.java b/engine-tests/src/test/java/org/terasology/documentation/ApiScraper.java
@@ -10,7 +10,7 @@
 import org.terasology.engine.core.module.ModuleManager;
 import org.terasology.engine.testUtil.ModuleManagerFactory;
 import org.terasology.gestalt.module.ModuleEnvironment;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 
 import java.net.URL;
 import java.util.HashMap;

diff --git a/engine-tests/src/test/java/org/terasology/documentation/apiScraper/CompleteApiScraper.java b/engine-tests/src/test/java/org/terasology/documentation/apiScraper/CompleteApiScraper.java
@@ -10,7 +10,7 @@
 import org.terasology.engine.core.module.ModuleManager;
 import org.terasology.engine.testUtil.ModuleManagerFactory;
 import org.terasology.gestalt.module.ModuleEnvironment;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Method;

diff --git a/...c/test/java/org/terasology/engine/core/module/ClasspathCompromisingModuleFactoryTest.java b/...c/test/java/org/terasology/engine/core/module/ClasspathCompromisingModuleFactoryTest.java
@@ -8,7 +8,7 @@
 import org.junit.jupiter.api.Test;
 import org.terasology.gestalt.module.Module;
 import org.terasology.gestalt.module.ModuleMetadata;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 import org.terasology.gestalt.naming.Name;
 import org.terasology.gestalt.naming.Version;
 import org.terasology.unittest.ExampleClass;
@@ -56,9 +56,13 @@ public void directoryModuleContainsClass() {
     public void archiveModuleContainsClass() throws IOException {
         Module module = factory.createArchiveModule(new File("FIXME.jar"));
 
-        Class<?> someClassInTheModule = module.getModuleManifest().getTypesAnnotatedWith(API.class).iterator().next();
+        String someClassInTheModule = module.getClassIndex().getTypesAnnotatedWith(API.class.getName()).iterator().next();
 
-        assertTrue(module.getClassPredicate().test(someClassInTheModule));
+        try {
+            assertTrue(module.getClassPredicate().test(Class.forName(someClassInTheModule)));
+        } catch (ClassNotFoundException e) {
+            throw new RuntimeException(e);
+        }
         assertFalse(module.getClassPredicate().test(SOME_CLASS_OUTSIDE_THE_MODULE));
     }
 

diff --git a/...ests/src/test/java/org/terasology/engine/core/module/ModuleDownloadListGeneratorTest.java b/...ests/src/test/java/org/terasology/engine/core/module/ModuleDownloadListGeneratorTest.java
@@ -4,8 +4,8 @@
 
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
-import org.reflections.Reflections;
 import org.terasology.engine.core.TerasologyConstants;
+import org.terasology.gestalt.di.index.CompoundClassIndex;
 import org.terasology.gestalt.module.Module;
 import org.terasology.gestalt.module.ModuleMetadata;
 import org.terasology.gestalt.module.ModuleRegistry;
@@ -86,7 +86,7 @@ private Module buildSimpleModule(String id, String version) {
         if (version != null) {
             metadata.setVersion(new Version(version));
         }
-        return new Module(metadata, new EmptyFileSource(), Collections.emptyList(), new Reflections(), (c) -> false);
+        return new Module(metadata, new EmptyFileSource(), Collections.emptyList(), new CompoundClassIndex(), (c) -> false);
     }
     private Module buildEngineModule(String version) {
         return buildSimpleModule(TerasologyConstants.ENGINE_MODULE.toString(), version);

diff --git a/engine-tests/src/test/java/org/terasology/engine/core/module/ModuleManagerTest.java b/engine-tests/src/test/java/org/terasology/engine/core/module/ModuleManagerTest.java
@@ -9,13 +9,13 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 import org.mockito.junit.jupiter.MockitoExtension;
-import org.reflections.Reflections;
 import org.terasology.engine.config.flexible.AutoConfig;
 import org.terasology.engine.core.PathManager;
 import org.terasology.engine.core.PathManagerProvider;
 import org.terasology.engine.core.subsystem.EngineSubsystem;
 import org.terasology.engine.logic.permission.PermissionSetComponent;
 import org.terasology.engine.world.block.structure.AttachSupportRequiredComponent;
+import org.terasology.gestalt.di.index.CompoundClassIndex;
 import org.terasology.gestalt.module.Module;
 import org.terasology.gestalt.module.ModuleEnvironment;
 import org.terasology.gestalt.module.ModuleMetadata;
@@ -59,7 +59,7 @@ private Module getEmptyTestModule() {
                 new ModuleMetadata(new Name("EmptyTestModule"), new Version("0.0.1")),
                 new EmptyFileSource(),
                 Collections.emptyList(),
-                new Reflections(),
+                new CompoundClassIndex(),
                 (clazz) -> false
         );
     }
@@ -127,7 +127,7 @@ public void engineModuleContainsSubsystems() {
         environment = manager.getEnvironment();
         engineModule = environment.get(ENGINE_MODULE);
 
-        assertThat(engineModule.getModuleManifest().getSubTypesOf(EngineSubsystem.class)).contains(subsystem);
+        assertThat(engineModule.getClassIndex().getSubtypesOf(EngineSubsystem.class.getName())).contains(subsystem.getName());
 
         assertThat(environment.getSubtypesOf(EngineSubsystem.class)).contains(subsystem);
 

diff --git a/...tests/src/test/java/org/terasology/engine/persistence/serializers/TypeSerializerTest.java b/...tests/src/test/java/org/terasology/engine/persistence/serializers/TypeSerializerTest.java
@@ -7,6 +7,7 @@
 import com.google.gson.Gson;
 import org.joml.Vector3f;
 import org.junit.jupiter.api.Test;
+import org.terasology.context.annotation.IndexInherited;
 import org.terasology.engine.ModuleEnvironmentTest;
 import org.terasology.engine.core.TerasologyConstants;
 import org.terasology.engine.core.module.ModuleContext;
@@ -31,7 +32,7 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.terasology.engine.testUtil.Assertions.assertNotEmpty;
 
-class TypeSerializerTest extends ModuleEnvironmentTest {
+public class TypeSerializerTest extends ModuleEnvironmentTest {
     private static final SomeClass<Integer> INSTANCE = new SomeClass<>(0xdeadbeef);
     private static final String INSTANCE_JSON = "{\"generic-t\":-559038737,\"list\":[50,51,-52,-53]," +
             "\"animals\":[{\"class\":\"org.terasology.engine.persistence.serializers.TypeSerializerTest$Dog\"," +
@@ -155,6 +156,7 @@ public String toString() {
     }
 
     @SuppressWarnings("checkstyle:FinalClass")
+    @IndexInherited
     public static class Animal<T> {
         public T data;
 
@@ -178,6 +180,11 @@ public boolean equals(Object o) {
         public int hashCode() {
             return Objects.hash(data);
         }
+
+        @Override
+        public String toString() {
+            return "Animal(data = " + data.toString() + ")";
+        }
     }
 
     public static final class Dog<T> extends Animal<T> {

diff --git a/engine/build.gradle.kts b/engine/build.gradle.kts
@@ -120,19 +120,25 @@ dependencies {
     }
     implementation("net.logstash.logback:logstash-logback-encoder:7.4")
 
+    // JSemVer (Semantic Versioning) - A dependency of Gestalt
+    implementation("com.github.zafarkhaja:java-semver:0.10.2")
+
     // Our developed libs
-    api("org.terasology.gestalt:gestalt-asset-core:7.2.1-SNAPSHOT")
-    api("org.terasology.gestalt:gestalt-module:7.2.1-SNAPSHOT")
-    api("org.terasology.gestalt:gestalt-entity-system:7.2.1-SNAPSHOT")
-    api("org.terasology.gestalt:gestalt-util:7.2.1-SNAPSHOT")
+    api("org.terasology.gestalt:gestalt-asset-core:8.0.0-SNAPSHOT")
+    api("org.terasology.gestalt:gestalt-module:8.0.0-SNAPSHOT")
+    api("org.terasology.gestalt:gestalt-entity-system:8.0.0-SNAPSHOT")
+    api("org.terasology.gestalt:gestalt-util:8.0.0-SNAPSHOT")
+    api("org.terasology.gestalt:gestalt-inject:8.0.0-SNAPSHOT")
+
+    annotationProcessor("org.terasology.gestalt:gestalt-inject-java:8.0.0-SNAPSHOT")
 
     api("org.terasology:TeraMath:1.5.0")
     api("org.terasology:splash-screen:1.1.1")
     api("org.terasology.jnlua:JNLua:0.1.0-SNAPSHOT")
     api("org.terasology.jnbullet:JNBullet:1.0.4")
-    api("org.terasology.nui:nui:3.0.0")
-    api("org.terasology.nui:nui-reflect:3.0.0")
-    api("org.terasology.nui:nui-gestalt7:3.0.0")
+    api("org.terasology.nui:nui:4.0.0-SNAPSHOT")
+    api("org.terasology.nui:nui-reflect:4.0.0-SNAPSHOT")
+    api("org.terasology.nui:nui-gestalt:4.0.0-SNAPSHOT")
 
 
     // Wildcard dependency to catch any libs provided with the project (remote repo preferred instead)
@@ -206,11 +212,23 @@ tasks.register<Copy>("copyResourcesToClasses") {
     into(sourceSets["main"].output.classesDirs.first())
 }
 
-tasks.named("compileJava") {
+tasks.named<JavaCompile>("compileJava") {
+    dependsOn(
+        tasks.named("copyResourcesToClasses"),
+        tasks.named("createVersionInfoFile")
+    )
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.main.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.main.get().resources.srcDirs.joinToString(File.pathSeparator)}")
+}
+tasks.named<JavaCompile>("compileTestJava") {
     dependsOn(
         tasks.named("copyResourcesToClasses"),
         tasks.named("createVersionInfoFile")
     )
+    // Create an asset list during compilation (needed for Gestalt 8)
+    inputs.files(sourceSets.test.get().resources.srcDirs)
+    options.compilerArgs = arrayListOf("-Aresource=${sourceSets.test.get().resources.srcDirs.joinToString(File.pathSeparator)}")
 }
 
 // Instructions for packaging a jar file for the engine

diff --git a/engine/src/main/java/org/terasology/engine/audio/Sound.java b/engine/src/main/java/org/terasology/engine/audio/Sound.java
@@ -22,7 +22,8 @@ public abstract class Sound<T extends AssetData> extends Asset<T> implements org
      * @param assetType The asset type this asset belongs to.
      */
     protected Sound(ResourceUrn urn, AssetType<?, T> assetType, DisposableResource resource) {
-        super(urn, assetType, resource);
+        super(urn, assetType);
+        setDisposableResource(resource);
     }
 
     /**

diff --git a/engine/src/main/java/org/terasology/engine/audio/events/package-info.java b/engine/src/main/java/org/terasology/engine/audio/events/package-info.java
@@ -17,4 +17,4 @@
  */
 @API package org.terasology.engine.audio.events;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
diff --git a/engine/src/main/java/org/terasology/engine/audio/package-info.java b/engine/src/main/java/org/terasology/engine/audio/package-info.java
@@ -3,4 +3,4 @@
 
 @API package org.terasology.engine.audio;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
diff --git a/engine/src/main/java/org/terasology/engine/config/Config.java b/engine/src/main/java/org/terasology/engine/config/Config.java
@@ -23,7 +23,7 @@
 import org.terasology.engine.utilities.gson.SetMultimapTypeAdapter;
 import org.terasology.engine.utilities.gson.UriTypeAdapterFactory;
 import org.terasology.gestalt.entitysystem.component.Component;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 import org.terasology.gestalt.naming.Name;
 import org.terasology.gestalt.naming.Version;
 import org.terasology.gestalt.naming.gson.NameTypeAdapter;

diff --git a/engine/src/main/java/org/terasology/engine/config/RenderingConfig.java b/engine/src/main/java/org/terasology/engine/config/RenderingConfig.java
@@ -4,7 +4,7 @@
 package org.terasology.engine.config;
 
 import org.terasology.engine.core.subsystem.Resolution;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 import org.terasology.engine.rendering.cameras.PerspectiveCameraSettings;
 import org.terasology.engine.rendering.nui.layers.mainMenu.videoSettings.DisplayModeSetting;
 import org.terasology.engine.rendering.nui.layers.mainMenu.videoSettings.ScreenshotSize;

diff --git a/engine/src/main/java/org/terasology/engine/config/RenderingDebugConfig.java b/engine/src/main/java/org/terasology/engine/config/RenderingDebugConfig.java
@@ -5,7 +5,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.terasology.engine.utilities.subscribables.AbstractSubscribable;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;

diff --git a/engine/src/main/java/org/terasology/engine/config/facade/TelemetryConfiguration.java b/engine/src/main/java/org/terasology/engine/config/facade/TelemetryConfiguration.java
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.terasology.engine.config.facade;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 
 /**
  * TelemetryConfiguration is a wrapper for {@link org.terasology.engine.config.TelemetryConfig}.

diff --git a/engine/src/main/java/org/terasology/engine/config/flexible/AutoConfig.java b/engine/src/main/java/org/terasology/engine/config/flexible/AutoConfig.java
@@ -4,6 +4,7 @@
 
 import com.google.common.collect.ImmutableList;
 import org.reflections.ReflectionUtils;
+import org.terasology.context.annotation.IndexInherited;
 import org.terasology.engine.config.flexible.internal.SettingBuilder;
 import org.terasology.engine.config.flexible.internal.SettingImplBuilder;
 import org.terasology.engine.core.SimpleUri;
@@ -18,6 +19,7 @@
  * Represents a config class that will be automatically initialized and rendered by the engine.
  * All settings must be contained in {@code public static} fields of type {@link Setting}.
  */
+@IndexInherited
 public abstract class AutoConfig {
     private SimpleUri id;
 

diff --git a/engine/src/main/java/org/terasology/engine/config/flexible/Setting.java b/engine/src/main/java/org/terasology/engine/config/flexible/Setting.java
@@ -3,7 +3,7 @@
 package org.terasology.engine.config.flexible;
 
 import org.terasology.engine.config.flexible.constraints.SettingConstraint;
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;
 import org.terasology.reflection.TypeInfo;
 
 /**

diff --git a/engine/src/main/java/org/terasology/engine/config/flexible/constraints/package-info.java b/engine/src/main/java/org/terasology/engine/config/flexible/constraints/package-info.java
@@ -2,4 +2,4 @@
 // SPDX-License-Identifier: Apache-2.0
 @API package org.terasology.engine.config.flexible.constraints;
 
-import org.terasology.gestalt.module.sandbox.API;
+import org.terasology.context.annotation.API;