Fix NPE with enchantable (#11557)

2024-11-09 23:26:01 +01:00
parent bbc8fc8fec
commit 16f8d0f984
41 changed files with 161 additions and 110 deletions
--- a/patches/api/Add-RegistryAccess-for-managing-registries.patch
+++ b/patches/api/Add-RegistryAccess-for-managing-registries.patch
@@ -223,11 +223,9 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
      * Attribute.
      *
      * @see Attribute
-+     * @deprecated use {@link io.papermc.paper.registry.RegistryAccess#getRegistry(io.papermc.paper.registry.RegistryKey)} with {@link io.papermc.paper.registry.RegistryKey#ATTRIBUTE}
      */
 -    Registry<Attribute> ATTRIBUTE = Objects.requireNonNull(Bukkit.getRegistry(Attribute.class), "No registry present for Attribute. This is a bug.");
-+    @Deprecated(since = "1.21.3") // Paper
-+    Registry<Attribute> ATTRIBUTE = Objects.requireNonNull(io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(Attribute.class), "No registry present for Attribute. This is a bug.");
+    Registry<Attribute> ATTRIBUTE = io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(io.papermc.paper.registry.RegistryKey.ATTRIBUTE); // Paper
     /**
      * Server banner patterns.
      *
@@ -277,11 +275,14 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
      * Server entity types.
      *
@@ -0,0 +0,0 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
+      * Server instruments.
      *
      * @see MusicInstrument
+     * @deprecated use {@link io.papermc.paper.registry.RegistryAccess#getRegistry(io.papermc.paper.registry.RegistryKey)} with {@link io.papermc.paper.registry.RegistryKey#INSTRUMENT}
      */
 -    Registry<MusicInstrument> INSTRUMENT = Objects.requireNonNull(Bukkit.getRegistry(MusicInstrument.class), "No registry present for MusicInstrument. This is a bug.");
-+    Registry<MusicInstrument> INSTRUMENT = io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(io.papermc.paper.registry.RegistryKey.INSTRUMENT); // Paper
+    @Deprecated(since = "1.21.2")
+    Registry<MusicInstrument> INSTRUMENT = Objects.requireNonNull(io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(MusicInstrument.class), "No registry present for Instruments. This is a bug."); // Paper
     /**
      * Server item types.
      *
@@ -389,14 +390,11 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
      * Memory Keys.
      *
@@ -0,0 +0,0 @@ public interface Registry<T extends Keyed> extends Iterable<T> {
-      * Server fluids.
      *
      * @see Fluid
-+     * @deprecated use {@link io.papermc.paper.registry.RegistryAccess#getRegistry(io.papermc.paper.registry.RegistryKey)} with {@link io.papermc.paper.registry.RegistryKey#FLUID}
      */
 -    Registry<Fluid> FLUID = Objects.requireNonNull(Bukkit.getRegistry(Fluid.class), "No registry present for Fluid. This is a bug.");
-+    @Deprecated(since = "1.21.3")
-+    Registry<Fluid> FLUID = Objects.requireNonNull(io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(Fluid.class), "No registry present for Fluid. This is a bug.");
+    Registry<Fluid> FLUID = io.papermc.paper.registry.RegistryAccess.registryAccess().getRegistry(io.papermc.paper.registry.RegistryKey.FLUID); // Paper
     /**
      * Frog variants.
      *
--- a/patches/api/Add-methods-to-get-translation-keys.patch
+++ b/patches/api/Add-methods-to-get-translation-keys.patch
@@ -204,12 +204,15 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
         return Registry.INSTRUMENT.getOrThrow(NamespacedKey.minecraft(key));
     }
 +
-+    // Paper start - translation key
+    // Paper start - mark translation key as deprecated
+    /**
+     * @deprecated this method assumes that the instrument description
+     * always be a translatable component which is not guaranteed.
+     */
 +    @Override
-+    public @NotNull String translationKey() {
-+        return "instrument.minecraft." + this.getKey().value();
-+    }
-+    // Paper end - translation key
+    @Deprecated(forRemoval = true)
+    public abstract @NotNull String translationKey();
+    // Paper end - mark translation key as deprecated
 }
 diff --git a/src/main/java/org/bukkit/Translatable.java b/src/main/java/org/bukkit/Translatable.java
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
--- a/patches/api/Code-Generation.patch
+++ b/patches/api/Code-Generation.patch
@@ -155,11 +155,6 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +     */
 +    RegistryKey<StructureType> STRUCTURE_TYPE = create("worldgen/structure_type");
 +    /**
-+     * Built-in registry for instruments.
-+     * @see io.papermc.paper.registry.keys.InstrumentKeys
-+     */
-+    RegistryKey<MusicInstrument> INSTRUMENT = create("instrument");
-+    /**
 +     * Built-in registry for potion effect types (mob effects).
 +     * @see io.papermc.paper.registry.keys.MobEffectKeys
 +     */
@@ -275,6 +270,11 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +     * @see io.papermc.paper.registry.keys.PaintingVariantKeys
 +     */
 +    RegistryKey<Art> PAINTING_VARIANT = create("painting_variant");
+    /**
+     * Data-driven registry for instruments.
+     * @see io.papermc.paper.registry.keys.InstrumentKeys
+     */
+    RegistryKey<MusicInstrument> INSTRUMENT = create("instrument");
 +
 +
 +    /* ******************* *
--- a/patches/api/Improve-Registry.patch
+++ b/patches/api/Improve-Registry.patch
@@ -40,17 +40,17 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 
 +    // Paper start - deprecate getKey
 +    /**
-+     * @deprecated use {@link Registry#getKey(Keyed)} and {@link Registry#INSTRUMENT}. MusicInstruments
-+     * can exist without a key.
+     * @deprecated use {@link Registry#getKey(Keyed)}, {@link io.papermc.paper.registry.RegistryAccess#getRegistry(io.papermc.paper.registry.RegistryKey)},
+     * and {@link io.papermc.paper.registry.RegistryKey#INSTRUMENT}. MusicInstruments can exist without a key.
 +     */
 +    @Deprecated(forRemoval = true, since = "1.20.5")
 +    @Override
 +    public abstract @NotNull NamespacedKey getKey();
 +    // Paper end - deprecate getKey
 +
-     // Paper start - translation key
-     @Override
-     public @NotNull String translationKey() {
+     // Paper start - mark translation key as deprecated
+     /**
+      * @deprecated this method assumes that the instrument description
 diff --git a/src/main/java/org/bukkit/Registry.java b/src/main/java/org/bukkit/Registry.java
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/org/bukkit/Registry.java
@@ -197,8 +197,8 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
     public abstract StructureType getStructureType();
 +    // Paper start - deprecate getKey
 +    /**
-+     * @deprecated use {@link Registry#getKey(Keyed)} and {@link Registry#STRUCTURE}. Structures
-+     * can exist without a key.
+     * @deprecated use {@link Registry#getKey(Keyed)}, {@link io.papermc.paper.registry.RegistryAccess#getRegistry(io.papermc.paper.registry.RegistryKey)},
+     * and {@link io.papermc.paper.registry.RegistryKey#STRUCTURE}. Structures can exist without a key.
 +     */
 +    @Override
 +    @Deprecated(since = "1.20.4")
--- a/patches/server/Add-RegistryAccess-for-managing-Registries.patch
+++ b/patches/server/Add-RegistryAccess-for-managing-Registries.patch
@@ -98,7 +98,6 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +            // built-ins
 +            entry(Registries.GAME_EVENT, RegistryKey.GAME_EVENT, GameEvent.class, CraftGameEvent::new),
 +            entry(Registries.STRUCTURE_TYPE, RegistryKey.STRUCTURE_TYPE, StructureType.class, CraftStructureType::new),
-+            entry(Registries.INSTRUMENT, RegistryKey.INSTRUMENT, MusicInstrument.class, CraftMusicInstrument::new),
 +            entry(Registries.MOB_EFFECT, RegistryKey.MOB_EFFECT, PotionEffectType.class, CraftPotionEffectType::new),
 +            entry(Registries.BLOCK, RegistryKey.BLOCK, BlockType.class, CraftBlockType::new),
 +            entry(Registries.ITEM, RegistryKey.ITEM, ItemType.class, CraftItemType::new),
@@ -123,6 +122,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +            entry(Registries.JUKEBOX_SONG, RegistryKey.JUKEBOX_SONG, JukeboxSong.class, CraftJukeboxSong::new).delayed(),
 +            entry(Registries.BANNER_PATTERN, RegistryKey.BANNER_PATTERN, PatternType.class, CraftPatternType::new).delayed(),
 +            entry(Registries.PAINTING_VARIANT, RegistryKey.PAINTING_VARIANT, Art.class, CraftArt::new).delayed(),
+            entry(Registries.INSTRUMENT, RegistryKey.INSTRUMENT, MusicInstrument.class, CraftMusicInstrument::new).delayed(),
 +
 +            // api-only
 +            apiOnly(Registries.ENTITY_TYPE, RegistryKey.ENTITY_TYPE, () -> org.bukkit.Registry.ENTITY_TYPE),
--- a/patches/server/Add-methods-to-get-translation-keys.patch
+++ b/patches/server/Add-methods-to-get-translation-keys.patch
@@ -10,6 +10,27 @@ public org.bukkit.craftbukkit.inventory.CraftMetaFirework getNBT(Lorg/bukkit/Fir

 Co-authored-by: MeFisto94 <MeFisto94@users.noreply.github.com>

+diff --git a/src/main/java/org/bukkit/craftbukkit/CraftMusicInstrument.java b/src/main/java/org/bukkit/craftbukkit/CraftMusicInstrument.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/craftbukkit/CraftMusicInstrument.java
+++ b/src/main/java/org/bukkit/craftbukkit/CraftMusicInstrument.java
+@@ -0,0 +0,0 @@ public class CraftMusicInstrument extends MusicInstrument implements Handleable<
+         return this.key;
+     }
+ 
+    // Paper start - add translationKey methods
+    @Override
+    public @NotNull String translationKey() {
+        if (!(this.getHandle().description().getContents() instanceof final net.minecraft.network.chat.contents.TranslatableContents translatableContents)) {
+            throw new UnsupportedOperationException("Description isn't translatable!"); // Paper
+        }
+        return translatableContents.getKey();
+    }
+    // Paper end - add translationKey methods
+
+     @Override
+     public boolean equals(Object other) {
+         if (this == other) {
 diff --git a/src/main/java/org/bukkit/craftbukkit/attribute/CraftAttribute.java b/src/main/java/org/bukkit/craftbukkit/attribute/CraftAttribute.java
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/org/bukkit/craftbukkit/attribute/CraftAttribute.java
@@ -205,14 +226,5 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +            org.bukkit.block.Biome bukkit = org.bukkit.block.Biome.valueOf(nms.getKey().location().getPath().toUpperCase(Locale.ROOT));
 +            Assertions.assertEquals(nms.getKey().location().toLanguageKey("biome"), bukkit.translationKey(), "translation key mismatch for " + bukkit);
 +        }
-+    }
-+
-+    @Test
-+    public void testMusicInstrument() {
-+        for (final ResourceLocation nms : RegistryHelper.getRegistry().lookupOrThrow(Registries.INSTRUMENT).keySet()) {
-+            final MusicInstrument bukkit = MusicInstrument.getByKey(CraftNamespacedKey.fromMinecraft(nms));
-+            Assertions.assertNotNull(bukkit, "Missing bukkit instrument for " + nms);
-+            Assertions.assertEquals(nms.toLanguageKey("instrument"), bukkit.translationKey(), "translation key mismatch for " + bukkit);
-+        }
 +    }
 }
--- a/patches/server/Add-registry-entry-and-builders.patch
+++ b/patches/server/Add-registry-entry-and-builders.patch
@@ -25,8 +25,8 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 -            entry(Registries.GAME_EVENT, RegistryKey.GAME_EVENT, GameEvent.class, CraftGameEvent::new),
 +            writable(Registries.GAME_EVENT, RegistryKey.GAME_EVENT, GameEvent.class, CraftGameEvent::new, PaperGameEventRegistryEntry.PaperBuilder::new),
             entry(Registries.STRUCTURE_TYPE, RegistryKey.STRUCTURE_TYPE, StructureType.class, CraftStructureType::new),
-             entry(Registries.INSTRUMENT, RegistryKey.INSTRUMENT, MusicInstrument.class, CraftMusicInstrument::new),
             entry(Registries.MOB_EFFECT, RegistryKey.MOB_EFFECT, PotionEffectType.class, CraftPotionEffectType::new),
+             entry(Registries.BLOCK, RegistryKey.BLOCK, BlockType.class, CraftBlockType::new),
@@ -0,0 +0,0 @@ public final class PaperRegistries {
             entry(Registries.TRIM_PATTERN, RegistryKey.TRIM_PATTERN, TrimPattern.class, CraftTrimPattern::new).delayed(),
             entry(Registries.DAMAGE_TYPE, RegistryKey.DAMAGE_TYPE, DamageType.class, CraftDamageType::new).delayed(),
--- a/patches/server/General-ItemMeta-fixes.patch
+++ b/patches/server/General-ItemMeta-fixes.patch
@@ -1181,7 +1181,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 
     @Override
     public void setEnchantable(Integer data) {
-+        Preconditions.checkArgument(data > 0, "Enchantability must be > 0");
+        Preconditions.checkArgument(data == null || data > 0, "Enchantability must be positive"); // Paper
         this.enchantableValue = data;
     }