OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-22 14:35:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Enchantment is data-driven, so not FeatureDependant (#11377)

Browse source
This commit is contained in:
Jake Potrebic 2024-09-08 10:42:44 -07:00 committed by GitHub
parent 925c3b9d2b
commit 426f9924a5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 32 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
patches/api/0488-Add-FeatureFlag-API.patch
View file

@ -6,10 +6,10 @@ Subject: [PATCH] Add FeatureFlag API
diff --git a/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java b/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java diff --git a/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java b/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..914dc0b655630dd835bb115a144206d7e3a02337 index 0000000000000000000000000000000000000000..0fda065100c17ee00060df16467c0f7f98984ea7
--- /dev/null --- /dev/null
+++ b/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java +++ b/src/main/java/io/papermc/paper/world/flag/FeatureDependant.java
@@ -0,0 +1,26 @@ @@ -0,0 +1,27 @@
+package io.papermc.paper.world.flag; +package io.papermc.paper.world.flag;
+ +
+import java.util.Set; +import java.util.Set;
@ -21,8 +21,9 @@ index 0000000000000000000000000000000000000000..914dc0b655630dd835bb115a144206d7
+/** +/**
+ * Implemented by types in built-in registries that are controlled by {@link FeatureFlag FeatureFlags}. + * Implemented by types in built-in registries that are controlled by {@link FeatureFlag FeatureFlags}.
+ * Types in data-driven registries that are controlled by feature flags just will not exist in that registry. + * Types in data-driven registries that are controlled by feature flags just will not exist in that registry.
+ * @apiNote When a type that currently implements this interface transitions to being data-drive, this
+ * interface will be removed from that type in the following major version.
+ */ + */
+@ApiStatus.Experimental
+@ApiStatus.NonExtendable +@ApiStatus.NonExtendable
+public interface FeatureDependant { +public interface FeatureDependant {
+ +
@ -63,10 +64,10 @@ index 0000000000000000000000000000000000000000..f64cbee35fd3c6fe7b5f7391f6d11816
+} +}
diff --git a/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java b/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java diff --git a/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java b/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..2d7bbc9b157ccbb02731ecf3ec6680681c9c0da8 index 0000000000000000000000000000000000000000..c4432ee20872eeb127852159cf89ed00809fb00e
--- /dev/null --- /dev/null
+++ b/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java +++ b/src/main/java/io/papermc/paper/world/flag/FeatureFlagSetHolder.java
@@ -0,0 +1,32 @@ @@ -0,0 +1,31 @@
+package io.papermc.paper.world.flag; +package io.papermc.paper.world.flag;
+ +
+import java.util.Set; +import java.util.Set;
@ -79,7 +80,6 @@ index 0000000000000000000000000000000000000000..2d7bbc9b157ccbb02731ecf3ec668068
+ * Implemented by types that hold {@link FeatureFlag FeatureFlags} like + * Implemented by types that hold {@link FeatureFlag FeatureFlags} like
+ * {@link org.bukkit.generator.WorldInfo} and {@link org.bukkit.RegionAccessor}. + * {@link org.bukkit.generator.WorldInfo} and {@link org.bukkit.RegionAccessor}.
+ */ + */
+@ApiStatus.Experimental
+@ApiStatus.NonExtendable +@ApiStatus.NonExtendable
+public interface FeatureFlagSetHolder { +public interface FeatureFlagSetHolder {
+ +
@ -100,10 +100,10 @@ index 0000000000000000000000000000000000000000..2d7bbc9b157ccbb02731ecf3ec668068
+ @Unmodifiable @NonNull Set<FeatureFlag> getFeatureFlags(); + @Unmodifiable @NonNull Set<FeatureFlag> getFeatureFlags();
+} +}
diff --git a/src/main/java/org/bukkit/FeatureFlag.java b/src/main/java/org/bukkit/FeatureFlag.java diff --git a/src/main/java/org/bukkit/FeatureFlag.java b/src/main/java/org/bukkit/FeatureFlag.java
index 026b1832bcd163ab89668c991bf002e608e36aef..d690ecf6eac753fab9d09514cfadae4c6a73e146 100644 index 026b1832bcd163ab89668c991bf002e608e36aef..8fab13dc12c8fd6181479ab6e31e2498a8a91ee5 100644
--- a/src/main/java/org/bukkit/FeatureFlag.java --- a/src/main/java/org/bukkit/FeatureFlag.java
+++ b/src/main/java/org/bukkit/FeatureFlag.java +++ b/src/main/java/org/bukkit/FeatureFlag.java
@@ -1,37 +1,57 @@ @@ -1,37 +1,56 @@
package org.bukkit; package org.bukkit;
+// Paper start - overhaul FeatureFlag API +// Paper start - overhaul FeatureFlag API
@ -121,7 +121,7 @@ index 026b1832bcd163ab89668c991bf002e608e36aef..d690ecf6eac753fab9d09514cfadae4c
- * Flags which are unavailable in the current version will be null and/or - * Flags which are unavailable in the current version will be null and/or
- * removed. - * removed.
*/ */
@ApiStatus.Experimental -@ApiStatus.Experimental
public interface FeatureFlag extends Keyed { public interface FeatureFlag extends Keyed {
- public static final FeatureFlag VANILLA = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("vanilla")); - public static final FeatureFlag VANILLA = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("vanilla"));
@ -253,19 +253,6 @@ index 8f430a4067fc722ebfbca846cccded4fb0a3a4e5..4aa79016eb5f7edf930c82d30ff25078
/** /**
* Typed represents a subtype of {@link BlockType}s that have a known block * Typed represents a subtype of {@link BlockType}s that have a known block
diff --git a/src/main/java/org/bukkit/enchantments/Enchantment.java b/src/main/java/org/bukkit/enchantments/Enchantment.java
index f38321c437b19125d57d25419e3cb564e3928d89..daf4eeed2881858f734c19471ad5dbc4e1f42def 100644
--- a/src/main/java/org/bukkit/enchantments/Enchantment.java
+++ b/src/main/java/org/bukkit/enchantments/Enchantment.java
@@ -15,7 +15,7 @@ import org.jetbrains.annotations.Nullable;
/**
* The various type of enchantments that may be added to armour or weapons
*/
-public abstract class Enchantment implements Keyed, Translatable, net.kyori.adventure.translation.Translatable { // Paper - Adventure translations
+public abstract class Enchantment implements Keyed, Translatable, net.kyori.adventure.translation.Translatable, io.papermc.paper.world.flag.FeatureDependant { // Paper - Adventure translations & feature flag API
/**
* Provides protection against environmental damage
*/
diff --git a/src/main/java/org/bukkit/entity/EntityType.java b/src/main/java/org/bukkit/entity/EntityType.java diff --git a/src/main/java/org/bukkit/entity/EntityType.java b/src/main/java/org/bukkit/entity/EntityType.java
index ba605ad75d4ed920c0dc4527529998041a58676b..a78e1c431a6ea46ba7c44880e25a871f473bef41 100644 index ba605ad75d4ed920c0dc4527529998041a58676b..a78e1c431a6ea46ba7c44880e25a871f473bef41 100644
--- a/src/main/java/org/bukkit/entity/EntityType.java --- a/src/main/java/org/bukkit/entity/EntityType.java

26
patches/server/1058-Add-FeatureFlag-API.patch
View file

@ -310,18 +310,20 @@ index 0000000000000000000000000000000000000000..c3e6b96013f6dd0b784bd867196552d9
+io.papermc.paper.world.flag.PaperFeatureFlagProviderImpl +io.papermc.paper.world.flag.PaperFeatureFlagProviderImpl
diff --git a/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java b/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java diff --git a/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java b/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..174efed9d0352066a146acb4ec0554d46f81df21 index 0000000000000000000000000000000000000000..1fd830b148468e1db84e0e27d54c4fd6449fa9d8
--- /dev/null --- /dev/null
+++ b/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java +++ b/src/test/java/io/papermc/paper/world/flag/FeatureFlagTest.java
@@ -0,0 +1,79 @@ @@ -0,0 +1,99 @@
+package io.papermc.paper.world.flag; +package io.papermc.paper.world.flag;
+ +
+import io.papermc.paper.adventure.PaperAdventure; +import io.papermc.paper.adventure.PaperAdventure;
+import io.papermc.paper.registry.PaperRegistries; +import io.papermc.paper.registry.PaperRegistries;
+import io.papermc.paper.registry.RegistryAccess; +import io.papermc.paper.registry.RegistryAccess;
+import io.papermc.paper.registry.RegistryKey; +import io.papermc.paper.registry.RegistryKey;
+import io.papermc.paper.registry.entry.RegistryEntry;
+import java.util.HashSet; +import java.util.HashSet;
+import java.util.Set; +import java.util.Set;
+import java.util.stream.Stream;
+import net.kyori.adventure.key.Key; +import net.kyori.adventure.key.Key;
+import net.minecraft.core.registries.Registries; +import net.minecraft.core.registries.Registries;
+import net.minecraft.resources.ResourceKey; +import net.minecraft.resources.ResourceKey;
@ -338,6 +340,7 @@ index 0000000000000000000000000000000000000000..174efed9d0352066a146acb4ec0554d4
+ +
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertInstanceOf;
+import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.fail; +import static org.junit.jupiter.api.Assertions.fail;
@ -385,11 +388,28 @@ index 0000000000000000000000000000000000000000..174efed9d0352066a146acb4ec0554d4
+ +
+ @MethodSource("featureFilteredRegistries") + @MethodSource("featureFilteredRegistries")
+ @ParameterizedTest + @ParameterizedTest
+ <T extends Keyed> void testFeatureDependent(final RegistryKey<T> registryKey) { + <T extends Keyed> void testApiImplementsFeatureDependant(final RegistryKey<T> registryKey) {
+ final org.bukkit.Registry<T> registry = RegistryAccess.registryAccess().getRegistry(registryKey); + final org.bukkit.Registry<T> registry = RegistryAccess.registryAccess().getRegistry(registryKey);
+ final T anyElement = registry.iterator().next(); + final T anyElement = registry.iterator().next();
+ assertInstanceOf(FeatureDependant.class, anyElement, "Registry " + registryKey + " doesn't have feature dependent elements"); + assertInstanceOf(FeatureDependant.class, anyElement, "Registry " + registryKey + " doesn't have feature dependent elements");
+ final FeatureDependant dependant = ((FeatureDependant) anyElement); + final FeatureDependant dependant = ((FeatureDependant) anyElement);
+ assertDoesNotThrow(dependant::requiredFeatures, "Failed to get required features for " + anyElement + " in " + registryKey); + assertDoesNotThrow(dependant::requiredFeatures, "Failed to get required features for " + anyElement + " in " + registryKey);
+ } + }
+
+ static Stream<RegistryKey<?>> nonFeatureFilteredRegistries() {
+ return AbstractTestingBase.REGISTRY_CUSTOM.registries().filter(r -> {
+ final RegistryEntry<?, ?> entry = PaperRegistries.getEntry(r.key());
+ // has an API registry and isn't a filtered registry
+ return entry != null && !FeatureElement.FILTERED_REGISTRIES.contains(r.key());
+ }).map(r -> PaperRegistries.getEntry(r.key()).apiKey());
+ }
+
+
+ @MethodSource("nonFeatureFilteredRegistries")
+ @ParameterizedTest
+ <T extends Keyed> void testApiDoesntImplementFeatureDependant(final RegistryKey<T> registryKey) {
+ final org.bukkit.Registry<T> registry = RegistryAccess.registryAccess().getRegistry(registryKey);
+ final T anyElement = registry.iterator().next();
+ assertFalse(anyElement instanceof FeatureDependant, "Registry " + registryKey + " has feature dependent elements");
+ }
+} +}