fix!: make PublishError.InsufficientPeers more self-explanatory #487
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
People continually mistake the `InsufficientPeers` error for something that can be "worked around" by setting `allowPublishToZeroPeers` to true, and they then expect other network nodes to still recieve their messages. This PR renames the option to `allowPublishToZeroTopicPeers` - this makes it clear(er) that it's not that you don't have any peers, it's that no peers you have are listening on the topic. It also improves the JSDoc comment on the option and changes the `Error` message from `PublishError.InsufficientPeers` to `PublishError.NoPeersSubscribedToTopic` which (I hope) more accurately describes what's wrong. BREAKING CHANGE: The `allowPublishToZeroPeers` option has been renamed to `allowPublishToZeroTopicPeers` Fixes #472
Collaborator
Author
|
I'm not sure this is worth a major bump on it's own, maybe it should be batched up with #468? |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #487 +/- ##
==========================================
+ Coverage 81.40% 81.42% +0.02%
==========================================
Files 48 48
Lines 12325 12340 +15
Branches 1301 1301
==========================================
+ Hits 10033 10048 +15
Misses 2292 2292 ☔ View full report in Codecov by Sentry. |
wemeetagain
approved these changes
Feb 27, 2024
Closed
4 tasks
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.
People continually mistake the
InsufficientPeerserror for something that can be "worked around" by settingallowPublishToZeroPeersto true, and they then expect other network nodes to still recieve their messages.This PR renames the option to
allowPublishToZeroTopicPeers- this makes it clear(er) that it's not that you don't have any peers, it's that no peers you have are listening on the topic.It also improves the JSDoc comment on the option and changes the
Errormessage fromPublishError.InsufficientPeerstoPublishError.NoPeersSubscribedToTopicwhich (I hope) more accurately describes what's wrong.BREAKING CHANGE: The
allowPublishToZeroPeersoption has been renamed toallowPublishToZeroTopicPeersFixes #472