Pass nodes to Configuration instead of Manager #120
Merged
Conversation
This file contains 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
This is a major redesign of how we pass node lists and node maps to the system. This now happens only through the creation of a new configuration, but still using the WithNodeList and WithNodeMap options. These can no longer be passed to the manager. The manager still keeps the pool of all nodes in all configurations. A benefit from this change is that the manager can no longer fail with an error. As this is a relatively major change, and there were fair amount of usage examples that had to be updated, this also required a bit of associated clean up. When this rewrite was more or less finished I realized that we could also provide WithNodeIDs, which could have avoided many of the tricky rewrites. I plan to add WithNodeIDs in a follow up commit. Fixes #30.
This adds a WithNodeIDs option for the NewConfiguration function. This can be handy when creating a new configuration from a previous one. The Equal method on the Configuration type is handy for comparing two configurations, and also allows using the cmp package for comparing stuff.
|
@meling can you regenerate |
johningve
approved these changes
Feb 13, 2021
Done. It is ready to be reviewed, I guess. The caveat with this one is that it impacts the APIs, but I think now is the time to fix this, rather than later, when we have made a proper release. |
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.
This PR allows nodes to be passed to NewConfiguration instead of adding it to the manager first, and then adding it to the configuration. This makes it more intuitive and it also becomes easier to create new configurations from existing ones. We can now also compare two configurations via a new Equal method.
We provide tree ways to add nodes to NewConfiguration:
Also worth noting is that NewManager no longer returns an error, avoiding error handling until NewConfiguration is called.
Fixes #30.