[Libp2p] Add Libp2p module (part 4) by bryanchriswhite · Pull Request #545 · pokt-network/pocket

bryanchriswhite · 2023-02-24T11:03:13Z

Description

This is another of a series of PRs split out from #500. Here we add a new modules.P2PModule implementation which utilizes the typesP2P.Network implementation which was added in #540. It will be utilized together with the config changes introduced by #535 in forthcoming changes to the node and debug CLI.

Issue

#347

Type of change

Please mark the relevant option(s):

List of changes

Added a new modules.P2PModule implementation to the libp2p module directory

Testing

make develop_test
LocalNet w/ all of the steps outlined in the README

Required Checklist

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have tested my changes using the available tooling
I have updated the corresponding CHANGELOG

If Applicable Checklist

I have updated the corresponding README(s); local and/or global
I have added tests that prove my fix is effective or that my feature works
I have added, or updated, mermaid.js diagrams in the corresponding README(s)
I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

bryanchriswhite · 2023-02-27T11:06:51Z

This PR is based off of the chore/libp2p-2 branch but is also dependent on the chore/config branch. As a result tests and linting will fail until #535 is merged.

libp2p/module.go

deblasis · 2023-02-28T20:03:39Z

libp2p/module.go

+func (mod *libp2pModule) Create(bus modules.Bus, options ...modules.ModuleOption) (modules.Module, error) {
+	logger.Global.Print("Creating libp2p-backed network module")
+
+	*mod = libp2pModule{
+		cfg: bus.GetRuntimeMgr().GetConfig().P2P,
+	}


How about:

Suggested change

func (mod *libp2pModule) Create(bus modules.Bus, options ...modules.ModuleOption) (modules.Module, error) {

logger.Global.Print("Creating libp2p-backed network module")

*mod = libp2pModule{

cfg: bus.GetRuntimeMgr().GetConfig().P2P,

}

func (*libp2pModule) Create(bus modules.Bus, options ...modules.ModuleOption) (modules.Module, error) {

logger.Global.Debug().Msg("Creating libp2p-backed network module")

mod := &libp2pModule{

cfg: bus.GetRuntimeMgr().GetConfig().P2P,

logger: logger.Global.CreateLoggerForModule(modules.P2PModuleName),

}

?

More consistent with other modules.

💯 agreed. We need to update the shared modules docs to reflect this new convention, as currently, it effectively says that logger initialization should happen in #Start():

When defining the start function for the module, it is essential to initialise a namespace logger as well:

Do you think this is covered by #509, specifically the first goal?:

Add godoc comments to the various interfaces, functions, methods involved in the module creation process

💯 agreed. We need to update the shared modules docs to reflect this new convention, as currently, it effectively says that logger initialization should happen in #Start():

When defining the start function for the module, it is essential to initialise a namespace logger as well:

Totally, thanks for pointing that out!

Do you think this is covered by #509, specifically the first goal?:

Add godoc comments to the various interfaces, functions, methods involved in the module creation process

Agreed, I have clarified the scope so I don't forget :) Thanks buddy!

libp2p/module.go

deblasis · 2023-02-28T20:16:21Z

libp2p/module.go

+
+	// NB: time out if no data is sent to free resources.
+	if err := stream.SetReadDeadline(newReadStreamDeadline()); err != nil {
+		mod.logger.Error().Err(err).Msg("setting stream read deadline")


It seems that we are settling on this pattern (Added the Bool(true)) for this kind of thing to help with 🪵 🔍

Suggested change

mod.logger.Error().Err(err).Msg("setting stream read deadline")

mod.logger.Error().Err(err).

Bool("TODO", true).

Msg("setting stream read deadline")

@deblasis can you elaborate on (or link to) the thinking behind this?

Of course.

We have a bunch of places in our codebase where we log a message and we also attach a TODO: true

Example:

As we mature our observability stack, it could be useful to search for these and also to inform the users that something is still in development and the log entries are merely placeholders for future real functionality

We also have #478

libp2p/module.go

deblasis

Good job @bryanchriswhite! 🚀
Some minor changes, nits, mostly for consistency

deblasis

LGTM👍

Olshansk

Easy to understand, a big step forward and great documentation in terms of what we have and what's next. Great job Bryan 👏

Olshansk · 2023-03-10T01:53:38Z

p2p/module.go

 	c := &messaging.PocketEnvelope{
 		Content: msg,
 	}
+	//TECHDEBT: use shared/codec for marshalling


Thank you for adding these

Olshansk · 2023-03-10T02:23:07Z

libp2p/module.go

+
+var _ modules.P2PModule = &libp2pModule{}
+
+type libp2pModule struct {


nice comments on the sattributes

Olshansk · 2023-03-10T02:25:08Z

libp2p/module.go

+		mod.listenAddrs = libp2p.NoListenAddrs
+	default:
+		return nil, fmt.Errorf(
+			// DISCUSS: rename to "transport protocol" instead.


Let's do it

Olshansk · 2023-03-10T02:25:14Z

libp2p/module.go

+}
+
+func (mod *libp2pModule) Start() error {
+	// IMPROVE: receive context in interface methods.


Olshansk · 2023-03-10T02:33:17Z

libp2p/module.go

+
+	// NB: time out if no data is sent to free resources.
+	if err := stream.SetReadDeadline(newReadStreamDeadline()); err != nil {
+		mod.logger.Error().Err(err).Msg("setting stream read deadline")


We also have #478

bryanchriswhite added the p2p P2P specific changes label Feb 24, 2023

bryanchriswhite added this to the M1: Pocket PoS (Proof of Stake) milestone Feb 24, 2023

bryanchriswhite self-assigned this Feb 24, 2023

bryanchriswhite force-pushed the chore/libp2p-3 branch 2 times, most recently from 9af1fb5 to 4f9f13f Compare February 24, 2023 11:24

bryanchriswhite marked this pull request as ready for review February 24, 2023 11:25

bryanchriswhite requested a review from Olshansk February 24, 2023 11:25

bryanchriswhite force-pushed the chore/libp2p-2 branch from a329579 to 0791d1a Compare February 27, 2023 10:43

bryanchriswhite force-pushed the chore/libp2p-3 branch from 4f9f13f to d4b0c6e Compare February 27, 2023 10:47

bryanchriswhite force-pushed the chore/libp2p-2 branch from 0791d1a to 77f2b78 Compare February 27, 2023 11:04

bryanchriswhite force-pushed the chore/libp2p-3 branch from d4b0c6e to 6074b77 Compare February 28, 2023 10:28

bryanchriswhite requested a review from deblasis February 28, 2023 11:05