Defer sponge command registration #184
Open
+72
−20
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Problem
As it currently stands, trying to register sponge commands through
CommandRegistrar#EVENT
from either aClientModInitializer
or aDedicatedServerModInitializer
results in non-determinism as whether they are successfully registered depends on the order the initializers were invoked by fabric loader (becauseCommandRegistrar#EVENT
is also invoked from these entrypoints).The Solution
I added a
CommandRegistrationCallback#EVENT
event in the command api v1 library that is invoked before the vanilla command manager is filled with mod commands during theServerLifecycleEvents#SERVER_STARTING
callback. I then wrapped the sponge command registration event invocations in theImplInit
classes so that their registration is now deferred to theServerLifecycleEvents#SERVER_STARTING
callback rather than the mod initializers.This pull request ensures a strict load order between sponge commands and vanilla commands without breaking backwards compatibility.