introduce scoped registry holder using PhaseTracker

Faithcaio · Faithcaio · commit 3c92e3e8fab6 · 2025-03-29T09:11:05.000+01:00
diff --git a/SpongeAPI b/SpongeAPI
@@ -1 +1 @@
-Subproject commit cb1550649db77878cfc511dfa7c48ae76cf4c164
+Subproject commit 53b9cfebe8aa1151286781bfdc52790792830716
diff --git a/generator/src/main/java/org/spongepowered/vanilla/generator/RegistryScope.java b/generator/src/main/java/org/spongepowered/vanilla/generator/RegistryScope.java
@@ -63,7 +63,7 @@ void populateRegistryGetter(final Builder builder, final CodeBlock registryType)
     SERVER {
         @Override
         protected CodeBlock registryKeyToReference() {
-            return CodeBlock.of("asDefaultedReference($T::server)", Types.SPONGE);
+            return CodeBlock.of("asScopedReference()", Types.SPONGE);
         }
 
         @Override
diff --git a/src/main/java/org/spongepowered/common/SpongeCommon.java b/src/main/java/org/spongepowered/common/SpongeCommon.java
@@ -37,7 +37,9 @@
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.event.Event;
 import org.spongepowered.common.applaunch.config.core.SpongeConfigs;
+import org.spongepowered.common.event.tracking.PhaseTracker;
 import org.spongepowered.common.launch.Launch;
+import org.spongepowered.common.registry.SpongeRegistryHolder;
 import org.spongepowered.common.scheduler.AsyncScheduler;
 import org.spongepowered.common.scheduler.ServerScheduler;
 
@@ -100,8 +102,21 @@ public static RegistryAccess.Frozen vanillaRegistryAccess() {
         return SpongeCommon.server().registryAccess();
     }
 
+    public static SpongeRegistryHolder scopedHolder() {
+        var holder = PhaseTracker.getInstance().currentCause().first(SpongeRegistryHolder.class);
+        // If we have a holder in scope use it directly unless it is game
+        if (holder.isEmpty() || holder.get() == SpongeCommon.game()) {
+
+            if (SpongeCommon.game().isServerAvailable()) {
+                return (SpongeRegistryHolder) SpongeCommon.server();
+            }
+            return SpongeCommon.game();
+        }
+        return holder.get();
+    }
+
     public static <E> Registry<E> vanillaRegistry(ResourceKey<? extends Registry<? extends E>> key) {
-        return SpongeCommon.vanillaRegistryAccess().lookupOrThrow(key);
+        return (Registry<E>) SpongeCommon.scopedHolder().lookupOrThrow(key);
     }
 
     public static ServerScheduler serverScheduler() {
diff --git a/src/main/java/org/spongepowered/common/SpongeLifecycle.java b/src/main/java/org/spongepowered/common/SpongeLifecycle.java
@@ -212,13 +212,16 @@ public void beginEstablishServerRegistries(final RegistryHolder server) {
 
     @Override
     public void processServerRegistries(final RegistryHolder server, final Stream<? extends org.spongepowered.api.registry.Registry<?>> registries) {
-        final Map<RegistryType<?>, org.spongepowered.api.registry.Registry<?>> map =
-            registries.collect(Collectors.toMap(org.spongepowered.api.registry.Registry::type, Function.identity()));
-        if (!map.isEmpty()) {
-            map.values().forEach(r -> ((WritableRegistryBridge<?>) r).bridge$setRegistryHolder(server));
-            this.game.eventManager().post(AbstractRegisterRegistryValueEvent.EngineScopedImpl.server(Cause.of(EventContext.empty(), this.game), this.game, server, map));
-            map.values().forEach(r -> ((WritableRegistryBridge<?>) r).bridge$markEventCalled());
-            ((SpongeRegistryHolder) server).registryHolder().freezeSpongeDynamicRegistries(false);
+        try (var frame = PhaseTracker.getInstance().pushCauseFrame()) {
+            frame.pushCause(server);
+            final Map<RegistryType<?>, org.spongepowered.api.registry.Registry<?>> map =
+                    registries.collect(Collectors.toMap(org.spongepowered.api.registry.Registry::type, Function.identity()));
+            if (!map.isEmpty()) {
+                map.values().forEach(r -> ((WritableRegistryBridge<?>) r).bridge$setRegistryHolder(server));
+                this.game.eventManager().post(AbstractRegisterRegistryValueEvent.EngineScopedImpl.server(Cause.of(EventContext.empty(), this.game), this.game, server, map));
+                map.values().forEach(r -> ((WritableRegistryBridge<?>) r).bridge$markEventCalled());
+                ((SpongeRegistryHolder) server).registryHolder().freezeSpongeDynamicRegistries(false);
+            }
         }
     }
 
diff --git a/src/main/java/org/spongepowered/common/data/provider/entity/PaintingData.java b/src/main/java/org/spongepowered/common/data/provider/entity/PaintingData.java
@@ -53,7 +53,7 @@ public static void register(final DataProviderRegistrator registrator) {
                         .setAnd((h, v) -> {
                             if (!h.level().isClientSide) {
                                 final Holder<PaintingVariant> oldArt = h.getVariant();
-                                var newArt = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.PAINTING_VARIANT).wrapAsHolder((PaintingVariant) (Object) v);
+                                var newArt = SpongeCommon.vanillaRegistry(Registries.PAINTING_VARIANT).wrapAsHolder((PaintingVariant) (Object) v);
                                 h.setVariant(newArt);
                                 ((HangingEntityAccessor) h).invoker$setDirection(h.getDirection());
                                 if (!h.survives()) {
diff --git a/src/main/java/org/spongepowered/common/data/provider/item/stack/BookPagesItemStackData.java b/src/main/java/org/spongepowered/common/data/provider/item/stack/BookPagesItemStackData.java
@@ -71,7 +71,7 @@ private static boolean set(final ItemStack holder, final List<Enchantment> value
         if (value.isEmpty()) {
             return BookPagesItemStackData.delete(holder, component);
         }
-        final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.ENCHANTMENT);
+        final var registry = SpongeCommon.vanillaRegistry(Registries.ENCHANTMENT);
         holder.update(component, ItemEnchantments.EMPTY, ench -> {
             final ItemEnchantments.Mutable mutable = new ItemEnchantments.Mutable(ench);
             mutable.keySet().clear();
diff --git a/src/main/java/org/spongepowered/common/data/provider/item/stack/ItemStackData.java b/src/main/java/org/spongepowered/common/data/provider/item/stack/ItemStackData.java
@@ -112,7 +112,13 @@ public static void register(final DataProviderRegistrator registrator) {
         registrator
                 .asMutable(ItemStack.class)
                     .create(Keys.BURN_TIME)
-                        .get(h -> SpongeCommon.server().fuelValues().burnDuration(h))
+                        .get(h -> {
+                            if (SpongeCommon.game().isServerAvailable()) {
+                                return SpongeCommon.server().fuelValues().burnDuration(h);
+                            } else {
+                                return null;
+                            }
+                        })
                     .create(Keys.CONTAINER_ITEM)
                         .get(h -> (ItemType) h.getItem().getCraftingRemainder().getItem())
                     .create(Keys.DISPLAY_NAME)
@@ -395,12 +401,12 @@ private static DataTransactionResult deleteAndTransactUseCooldown(final ItemStac
             return DataTransactionResult.successNoData();
         }
         return cooldown.cooldownGroup()
-            .map(group -> DataTransactionResult.successRemove(List.of(
-                Value.immutableOf(Keys.COOLDOWN, Ticks.of(cooldown.ticks())),
-                Value.immutableOf(Keys.COOLDOWN_GROUP, (ResourceKey) (Object) group)
-            ))).orElseGet(() -> DataTransactionResult.successRemove(List.of(
-                Value.immutableOf(Keys.COOLDOWN, Ticks.of(cooldown.ticks()))
-            )));
+                .map(group -> DataTransactionResult.successRemove(List.of(
+                        Value.immutableOf(Keys.COOLDOWN, Ticks.of(cooldown.ticks())),
+                        Value.immutableOf(Keys.COOLDOWN_GROUP, (ResourceKey) (Object) group)
+                ))).orElseGet(() -> DataTransactionResult.successRemove(List.of(
+                        Value.immutableOf(Keys.COOLDOWN, Ticks.of(cooldown.ticks()))
+                )));
     }
 
 }
diff --git a/src/main/java/org/spongepowered/common/event/cause/entity/damage/SpongeDamageSourceBuilder.java b/src/main/java/org/spongepowered/common/event/cause/entity/damage/SpongeDamageSourceBuilder.java
@@ -63,7 +63,7 @@ public DamageSource build() throws IllegalStateException {
 
     @Override
     public DamageSource.Builder type(final DamageType damageType) {
-        final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.DAMAGE_TYPE);
+        final var registry = SpongeCommon.vanillaRegistry(Registries.DAMAGE_TYPE);
         this.damageType = registry.wrapAsHolder((net.minecraft.world.damagesource.DamageType) (Object) damageType);
         return this;
     }
diff --git a/src/main/java/org/spongepowered/common/item/enchantment/SpongeRandomEnchantmentListBuilder.java b/src/main/java/org/spongepowered/common/item/enchantment/SpongeRandomEnchantmentListBuilder.java
@@ -93,7 +93,7 @@ public List<Enchantment> build() throws IllegalStateException {
         if (this.pool == null || this.pool.isEmpty()) {
             Objects.requireNonNull(this.item, "The item cannot be null");
             this.randomSource.setSeed(this.seed + this.option);
-            final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.ENCHANTMENT);
+            final var registry = SpongeCommon.vanillaRegistry(Registries.ENCHANTMENT);
             var stream = registry.listElements().map($$0x -> (Holder<net.minecraft.world.item.enchantment.Enchantment>)$$0x);
             enchantments = EnchantmentHelper.selectEnchantment(this.randomSource, ItemStackUtil.toNative(this.item), this.level, stream);
         } else {
@@ -139,7 +139,7 @@ public static List<Enchantment> fromNative(final List<EnchantmentInstance> list)
     }
 
     public static List<EnchantmentInstance> toNative(final List<Enchantment> list) {
-        final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.ENCHANTMENT);
+        final var registry = SpongeCommon.vanillaRegistry(Registries.ENCHANTMENT);
         return list.stream().map(ench -> {
                     var mcEnch = registry.wrapAsHolder((net.minecraft.world.item.enchantment.Enchantment) (Object) ench.type());
                     return new EnchantmentInstance(mcEnch, ench.level());
diff --git a/src/main/java/org/spongepowered/common/registry/SpongeRegistryKey.java b/src/main/java/org/spongepowered/common/registry/SpongeRegistryKey.java
@@ -30,6 +30,7 @@
 import org.spongepowered.api.registry.RegistryKey;
 import org.spongepowered.api.registry.RegistryReference;
 import org.spongepowered.api.registry.RegistryType;
+import org.spongepowered.common.SpongeCommon;
 
 import java.util.Objects;
 import java.util.StringJoiner;
@@ -65,6 +66,11 @@ public final <V extends T> DefaultedRegistryReference<V> asDefaultedReference(fi
         return new SpongeDefaultedRegistryReference<>((RegistryKey<V>) this, defaultHolder);
     }
 
+    @Override
+    public final <V extends T> DefaultedRegistryReference<V> asScopedReference() {
+        return new SpongeDefaultedRegistryReference<>((RegistryKey<V>) this, SpongeCommon::scopedHolder);
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(this.registry, this.location);
diff --git a/src/main/java/org/spongepowered/common/registry/SpongeRegistryType.java b/src/main/java/org/spongepowered/common/registry/SpongeRegistryType.java
@@ -28,6 +28,7 @@
 import org.spongepowered.api.registry.DefaultedRegistryType;
 import org.spongepowered.api.registry.RegistryHolder;
 import org.spongepowered.api.registry.RegistryType;
+import org.spongepowered.common.SpongeCommon;
 
 import java.util.Objects;
 import java.util.StringJoiner;
@@ -58,6 +59,11 @@ public final <V extends T> DefaultedRegistryType<V> asDefaultedType(final Suppli
         return new SpongeDefaultedRegistryType<>(this.root, this.location, Objects.requireNonNull(defaultHolder, "defaultHolder"));
     }
 
+    @Override
+    public <V> DefaultedRegistryType<V> asScopedType() {
+        return new SpongeDefaultedRegistryType<>(this.root, this.location, SpongeCommon::scopedHolder);
+    }
+
     @Override
     public boolean equals(final Object o) {
         if (this == o) {
diff --git a/src/main/java/org/spongepowered/common/world/schematic/SchematicTranslator.java b/src/main/java/org/spongepowered/common/world/schematic/SchematicTranslator.java
@@ -327,7 +327,7 @@ private static void deserializeBiomeContainer(
             .orElseThrow(() -> new InvalidDataException("Missing BiomePalette as required by the schematic spec"));
 
         final Set<DataQuery> biomeKeys = biomeMap.keys(false);
-        final Registry<Biome> biomeRegistry = VolumeStreamUtils.nativeToSpongeRegistry(SpongeCommon.server().registryAccess().lookupOrThrow(Registries.BIOME));
+        final Registry<Biome> biomeRegistry = VolumeStreamUtils.nativeToSpongeRegistry(SpongeCommon.vanillaRegistry(Registries.BIOME));
         biomePalette = new MutableBimapPalette<>(
             PaletteTypes.BIOME_PALETTE.get(),
             biomeRegistry,
@@ -454,7 +454,7 @@ public DataView addTo(final Schematic schematic, final DataView data) {
 
 
             final Registry<BlockType> blockRegistry = VolumeStreamUtils.nativeToSpongeRegistry(
-                    SpongeCommon.server().registryAccess().lookupOrThrow(Registries.BLOCK));
+                    SpongeCommon.vanillaRegistry(Registries.BLOCK));
 
             SchematicTranslator.writePaletteToView(
                 blockData, palette, blockRegistry, Constants.Sponge.Schematic.BLOCK_PALETTE, BlockState::type,
@@ -506,7 +506,7 @@ public DataView addTo(final Schematic schematic, final DataView data) {
                 // Should never reach here.
             }
 
-            final Registry<Biome> biomeRegistry = VolumeStreamUtils.nativeToSpongeRegistry(SpongeCommon.server().registryAccess().lookupOrThrow(Registries.BIOME));
+            final Registry<Biome> biomeRegistry = VolumeStreamUtils.nativeToSpongeRegistry(SpongeCommon.vanillaRegistry(Registries.BIOME));
 
             SchematicTranslator.writePaletteToView(
                 biomeContainer, biomePalette, biomeRegistry, Constants.Sponge.Schematic.BIOME_PALETTE,

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ void populateRegistryGetter(final Builder builder, final CodeBlock registryType)`
`63`	`63`	`SERVER {`
`64`	`64`	`@Override`
`65`	`65`	`protected CodeBlock registryKeyToReference() {`
`66`		`- return CodeBlock.of("asDefaultedReference($T::server)", Types.SPONGE);`
	`66`	`+ return CodeBlock.of("asScopedReference()", Types.SPONGE);`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ private static boolean set(final ItemStack holder, final List<Enchantment> value`
`71`	`71`	`if (value.isEmpty()) {`
`72`	`72`	`return BookPagesItemStackData.delete(holder, component);`
`73`	`73`	`}`
`74`		`- final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.ENCHANTMENT);`
	`74`	`+ final var registry = SpongeCommon.vanillaRegistry(Registries.ENCHANTMENT);`
`75`	`75`	`holder.update(component, ItemEnchantments.EMPTY, ench -> {`
`76`	`76`	`final ItemEnchantments.Mutable mutable = new ItemEnchantments.Mutable(ench);`
`77`	`77`	`mutable.keySet().clear();`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public DamageSource build() throws IllegalStateException {`
`63`	`63`
`64`	`64`	`@Override`
`65`	`65`	`public DamageSource.Builder type(final DamageType damageType) {`
`66`		`- final var registry = SpongeCommon.server().registryAccess().lookupOrThrow(Registries.DAMAGE_TYPE);`
	`66`	`+ final var registry = SpongeCommon.vanillaRegistry(Registries.DAMAGE_TYPE);`
`67`	`67`	`this.damageType = registry.wrapAsHolder((net.minecraft.world.damagesource.DamageType) (Object) damageType);`
`68`	`68`	`return this;`
`69`	`69`	`}`