Make module graph load order consistent #1108
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Pablete1234 <pabloherrerapalacio@gmail.com>
Electroid
approved these changes
Nov 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently PGM has a ModuleGraph to resolve dependencies, however, every so often a required dependency is forgotten by a developer, and then what? What happens is because module load order is arbitrary (hash maps), it may work or not work at random, based on server restarts. What makes it worse, is that because "most" dependencies are right, they will force the "right" module to load first most of the times, making it extremely difficult to debug or find the one missing link in the chain.
Example: modules B, C, D, E, F, G all rely on module A being loaded first. However, module F has forgotten to declare that dependency (the developer making the module forgot to declare it). If, arbitrarily, any of the modules A, B, C, D, E, or G are loaded before F, then the error will be completely hidden away, as any of them will force A to load first, and so, by the time F loads, A will already be present. However, in the one-in-a-thousand time, that F loads before them all, all pgm maps using F will fail to load.
This is extremely frustrating behavior to debug, so what this change does is make it so the order is no longer arbitrary, but instead, is consistent with the order modules are defined/registered in pgm. This means if a bug occurs, it will occur every time, and if it doesn't occur, it won't ever occur.
Additionally, i've cleaned-up the raw usages of MapModule without generics, and made the module factories immutable.