Skip to content

Commit 79f097e

Browse files
authored
fix(gossipsub): remove duplicate config builder method
Noticed two methods which duplicated each other logic precisely, chose the one with more clear name, composed and improved the doc a tiny bit. Pull-Request: #6173.
1 parent e7fea6c commit 79f097e

File tree

3 files changed

+9
-15
lines changed

3 files changed

+9
-15
lines changed

protocols/gossipsub/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@
1414
- Fix incorrect default values in ConfigBuilder
1515
See [PR 6113](https://github.com/libp2p/rust-libp2p/pull/6113)
1616

17+
- Remove duplicated config `set_topic_max_transmit_size` method, prefer `max_transmit_size_for_topic`.
18+
See [PR 6173](https://github.com/libp2p/rust-libp2p/pull/6173).
19+
1720
## 0.49.2
1821

1922
- Relax `Behaviour::with_metrics` requirements, do not require DataTransform and TopicSubscriptionFilter to also impl Default

protocols/gossipsub/src/behaviour/tests.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6471,7 +6471,7 @@ fn test_publish_message_with_default_transmit_size_config() {
64716471
let topic_hash = topic.hash();
64726472

64736473
let config = ConfigBuilder::default()
6474-
.set_topic_max_transmit_size(topic_hash.clone(), Config::default_max_transmit_size())
6474+
.max_transmit_size_for_topic(Config::default_max_transmit_size(), topic_hash.clone())
64756475
.validation_mode(ValidationMode::Strict)
64766476
.build()
64776477
.unwrap();
@@ -6503,7 +6503,7 @@ fn test_publish_large_message_with_default_transmit_size_config() {
65036503
let topic_hash = topic.hash();
65046504

65056505
let config = ConfigBuilder::default()
6506-
.set_topic_max_transmit_size(topic_hash.clone(), Config::default_max_transmit_size())
6506+
.max_transmit_size_for_topic(Config::default_max_transmit_size(), topic_hash.clone())
65076507
.validation_mode(ValidationMode::Strict)
65086508
.build()
65096509
.unwrap();
@@ -6531,7 +6531,7 @@ fn test_publish_message_with_specific_transmit_size_config() {
65316531

65326532
let max_topic_transmit_size = 2000;
65336533
let config = ConfigBuilder::default()
6534-
.set_topic_max_transmit_size(topic_hash.clone(), max_topic_transmit_size)
6534+
.max_transmit_size_for_topic(max_topic_transmit_size, topic_hash.clone())
65356535
.validation_mode(ValidationMode::Strict)
65366536
.build()
65376537
.unwrap();
@@ -6564,7 +6564,7 @@ fn test_publish_large_message_with_specific_transmit_size_config() {
65646564

65656565
let max_topic_transmit_size = 2048;
65666566
let config = ConfigBuilder::default()
6567-
.set_topic_max_transmit_size(topic_hash.clone(), max_topic_transmit_size)
6567+
.max_transmit_size_for_topic(max_topic_transmit_size, topic_hash.clone())
65686568
.validation_mode(ValidationMode::Strict)
65696569
.build()
65706570
.unwrap();
@@ -6592,7 +6592,7 @@ fn test_validation_error_message_size_too_large_topic_specific() {
65926592
let max_size = 2048;
65936593

65946594
let config = ConfigBuilder::default()
6595-
.set_topic_max_transmit_size(topic_hash.clone(), max_size)
6595+
.max_transmit_size_for_topic(max_size, topic_hash.clone())
65966596
.validation_mode(ValidationMode::None)
65976597
.build()
65986598
.unwrap();
@@ -6696,7 +6696,7 @@ fn test_validation_message_size_within_topic_specific() {
66966696
let max_size = 2048;
66976697

66986698
let config = ConfigBuilder::default()
6699-
.set_topic_max_transmit_size(topic_hash.clone(), max_size)
6699+
.max_transmit_size_for_topic(max_size, topic_hash.clone())
67006700
.validation_mode(ValidationMode::None)
67016701
.build()
67026702
.unwrap();

protocols/gossipsub/src/config.rs

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,15 +1075,6 @@ impl ConfigBuilder {
10751075
self
10761076
}
10771077

1078-
/// The topic max size sets message sizes for a given topic.
1079-
pub fn set_topic_max_transmit_size(&mut self, topic: TopicHash, max_size: usize) -> &mut Self {
1080-
self.config
1081-
.protocol
1082-
.max_transmit_sizes
1083-
.insert(topic, max_size);
1084-
self
1085-
}
1086-
10871078
/// Constructs a [`Config`] from the given configuration and validates the settings.
10881079
pub fn build(&self) -> Result<Config, ConfigBuilderError> {
10891080
// check all constraints on config

0 commit comments

Comments
 (0)