57077cd3b4
* Add notifee interface * Add notify function to network interface * Implement notify feature * Add tests for notify * Make notifee functions all async * Fix linting issue * Fix linting issue * Scaffold pubsub router interface * Scaffold pubsub directory * Store peer_id in muxed connection * Implement pubsub notifee * Remove outdated files * Implement pubsub first attempt * Prepare pubsub for floodsub * Add mplex conn to net stream and add conn in notify tests * Implement floodsub * Use NetStream in generic protocol handler * Debugging async issues * Modify test to perform proper assert. Test passes * Remove callbacks. Reduce sleep time * Add simple three node test * Clean up code. Add message classes * Add test for two topics * Add conn to net stream and conn tests * Refactor test setup to remove duplicate code * Fix linting issues * Fix linting issue * Fix linting issue * Fix outstanding unrelated lint issue in multiselect_client * Add connect function * Remove debug prints * Remove debug prints from floodsub * Use MessageTalk in place of direct message breakdown * Remove extra prints * Remove outdated function * Add message to queues for all topics in message * Debugging * Add message self delivery * Increase read timeout to 5 to get pubsub tests passing * Refactor testing helper func. Add tests * Add tests and increase timeout to get tests passing * Add dummy account demo scaffolding * Attempt to use threads. Test fails * Implement basic dummy node tests using threads * Add generic testing function * Add simple seven node tree test * Add more complex seven node tree tests * Add five node ring tests * Remove unnecessary get_message_type func * Add documentation to classes * Add message id to messages * Add documentation to test helper func * Add docs to dummy account node helper func * Add more docs to dummy account node test helper func * fixed linting errors in floodsub * small notify bugfix * move pubsub into libp2p * fixed pubsub linting * fixing pubsub test failures * linting
99 lines
3.5 KiB
Python
99 lines
3.5 KiB
Python
from .pubsub_router_interface import IPubsubRouter
|
|
from .message import create_message_talk
|
|
|
|
class FloodSub(IPubsubRouter):
|
|
|
|
def __init__(self, protocols):
|
|
self.protocols = protocols
|
|
self.pubsub = None
|
|
|
|
def get_protocols(self):
|
|
"""
|
|
:return: the list of protocols supported by the router
|
|
"""
|
|
return self.protocols
|
|
|
|
def attach(self, pubsub):
|
|
"""
|
|
Attach is invoked by the PubSub constructor to attach the router to a
|
|
freshly initialized PubSub instance.
|
|
:param pubsub: pubsub instance to attach to
|
|
"""
|
|
self.pubsub = pubsub
|
|
|
|
def add_peer(self, peer_id, protocol_id):
|
|
"""
|
|
Notifies the router that a new peer has been connected
|
|
:param peer_id: id of peer to add
|
|
"""
|
|
|
|
def remove_peer(self, peer_id):
|
|
"""
|
|
Notifies the router that a peer has been disconnected
|
|
:param peer_id: id of peer to remove
|
|
"""
|
|
|
|
def handle_rpc(self, rpc):
|
|
"""
|
|
Invoked to process control messages in the RPC envelope.
|
|
It is invoked after subscriptions and payload messages have been processed
|
|
:param rpc: rpc message
|
|
"""
|
|
|
|
async def publish(self, sender_peer_id, message):
|
|
"""
|
|
Invoked to forward a new message that has been validated.
|
|
This is where the "flooding" part of floodsub happens
|
|
|
|
With flooding, routing is almost trivial: for each incoming message,
|
|
forward to all known peers in the topic. There is a bit of logic,
|
|
as the router maintains a timed cache of previous messages,
|
|
so that seen messages are not further forwarded.
|
|
It also never forwards a message back to the source
|
|
or the peer that forwarded the message.
|
|
:param sender_peer_id: peer_id of message sender
|
|
:param message: message to forward
|
|
"""
|
|
|
|
# Encode message
|
|
encoded_msg = message.encode()
|
|
|
|
# Get message sender, origin, and topics
|
|
msg_talk = create_message_talk(message)
|
|
msg_sender = str(sender_peer_id)
|
|
msg_origin = msg_talk.origin_id
|
|
topics = msg_talk.topics
|
|
|
|
# Deliver to self if self was origin
|
|
# Note: handle_talk checks if self is subscribed to topics in message
|
|
if msg_sender == msg_origin and msg_sender == str(self.pubsub.host.get_id()):
|
|
await self.pubsub.handle_talk(message)
|
|
|
|
# Deliver to self and peers
|
|
for topic in topics:
|
|
if topic in self.pubsub.peer_topics:
|
|
for peer_id_in_topic in self.pubsub.peer_topics[topic]:
|
|
# Forward to all known peers in the topic that are not the
|
|
# message sender and are not the message origin
|
|
if peer_id_in_topic not in (msg_sender, msg_origin):
|
|
stream = self.pubsub.peers[peer_id_in_topic]
|
|
await stream.write(encoded_msg)
|
|
else:
|
|
# Implies publish did not write
|
|
print("publish did not write")
|
|
|
|
def join(self, topic):
|
|
"""
|
|
Join notifies the router that we want to receive and
|
|
forward messages in a topic. It is invoked after the
|
|
subscription announcement
|
|
:param topic: topic to join
|
|
"""
|
|
|
|
def leave(self, topic):
|
|
"""
|
|
Leave notifies the router that we are no longer interested in a topic.
|
|
It is invoked after the unsubscription announcement.
|
|
:param topic: topic to leave
|
|
"""
|