chore: introduce `Submodule` interface by bryanchriswhite · Pull Request #855 · pokt-network/pocket

bryanchriswhite · 2023-06-23T08:27:07Z

Description

Introduces the Submodule interface and applies it to the P2P module's peerstore provider.

Issue

Deliverables 1, 2, 3, & 5:

[Core] Improve dependency injection for submodules #810

Type of change

Please mark the relevant option(s):

List of changes

fixed typo; renamee IntegratableModule to IntegrableModule
renamed InitializableModule to InjectableModule
removed InjectableModule#Create() as Moudle also embeds ModuleFactoryWithConfig
added Submodule interface type
refactored peerstore providers as submodules
updated module README

Testing

make develop_test; if any code changes were made
make test_e2e on k8s LocalNet; if any code changes were made
e2e-devnet-test passes tests on DevNet; if any code was changed
Docker Compose LocalNet; if any major functionality was changed or introduced
k8s LocalNet; if any infrastructure or configuration changes were made

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 added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
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)

* pokt/main: [Persistence] TreeStore Refactor (#756) [General] Ignore false positive secret uncovered by `ggshield` on main (#848) [Utility] Add trustless relay to CLI (#778) Devlog 9 (#846) [Configs] Cleanup private keys and genesis file (#827)

* refactor/unicast-router: chore: cleanup TODOs [Persistence] TreeStore Refactor (#756) [General] Ignore false positive secret uncovered by `ggshield` on main (#848) [Utility] Add trustless relay to CLI (#778) Devlog 9 (#846) [Configs] Cleanup private keys and genesis file (#827)

p2p/providers/peerstore_provider/persistence/provider.go

p2p/providers/peerstore_provider/rpc/provider.go

* feat/integrate-bg-router: docs: clarify broadcast table docs: improve legend definitions chore: add TODO README docs: update TOC chore: add issue # to TECHDEBT comment chore: review feedback improvements chore: background router comment and var name cleanup docs: add architecture design language section docs: README improvements (review feedback)

Olshansk

@bryanchriswhite I pulled the branch and edited some formatting while reading through it.

I think there is still opportunity to simplify this in the future, but I've unfortunately reached the exhaustion level of reading about modules and submodules for now 😓

Co-authored-by: Daniel Olshansky <olshansk@pokt.network>

* pokt/main: [Utility] Update E2E feature path template doc (#870) [IBC] Add nil check on proof for membership and non-membership proof creation (#877) Added git diff state to devlog10 Devlog 10 (#872) [Documentation] Add IBC Module introduction as an example (#853) [Persistence][Bug] Fix Actor Schema Assignment for ValidatorActor in GetActor (#857) QOL: add bash completion for p1 to localnet client (#865)

* feat/integrate-bg-router: fix: goimports fix: unstaked actor bootstrapping FSM transition chore: add error log test: improve background router validation test docs: fix mistake in peer discovery section [Utility] Update E2E feature path template doc (#870) [IBC] Add nil check on proof for membership and non-membership proof creation (#877) Added git diff state to devlog10 Devlog 10 (#872) [Documentation] Add IBC Module introduction as an example (#853) [Persistence][Bug] Fix Actor Schema Assignment for ValidatorActor in GetActor (#857) QOL: add bash completion for p1 to localnet client (#865)

h5law · 2023-07-07T13:01:39Z

shared/modules/doc/README.md

dylanlott

LGTM 👍 Replacing providers with submodules seems worth an ADR, if you want help writing that up let's take a look at it @bryanchriswhite

* pokt/main: [P2P] Integrate background router (#732) Update main README.md [Bug] Fix CI linter errors (#885) [Tooling] Block `IN_THIS_*` comments from passing CI (#889)

gitguardian · 2023-07-11T09:01:18Z

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
5841025	Generic High Entropy Secret	`4b19d8f`	charts/pocket/templates/configmap-genesis.yaml	View secret
5841025	Generic High Entropy Secret	`cf886a7`	charts/pocket/templates/configmap-genesis.yaml	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

bryanchriswhite · 2023-07-11T09:01:57Z

LGTM +1 Replacing providers with submodules seems worth an ADR, if you want help writing that up let's take a look at it @bryanchriswhite

@dylanlott it's more like the providers need to become submodules.

bryanchriswhite · 2023-07-11T09:27:23Z

🚨 Please don't delete this branch! I will do so when all downstream branches have been rebased, thank you! 🚨

* pokt/main: chore: introduce `Submodule` interface (#855)

bryanchriswhite added 14 commits June 19, 2023 15:15

refactor: unicast router

fe24824

chore: cleanup TODOs

1277859

chore: add background message

871af48

chore: add Router#Close()

013c433

chore: separate raintree & bg protocol IDs

4f998ee

chore: generate PocketEnvelope nonce in PackMessage()

1c9c18c

refactor: add Handler to router config validation

f9a0c10

refactor: raintree router

0bdffbd

refactor: background router

2b40776

refactor: integrate bg router

213f294

refactor: staked actor router peer discovery

437afc8

test: post-refactor updates

43cf671

bryanchriswhite added core Core infrastructure - protocol related code health Nice to have code improvement labels Jun 23, 2023

bryanchriswhite added this to the M*: Pocket QoL (Quality of Life) milestone Jun 23, 2023

bryanchriswhite self-assigned this Jun 23, 2023

reviewpad bot added the medium Pull request is medium label Jun 23, 2023

bryanchriswhite changed the title ~~Chore/introduce submodule~~ chore: introduce submodule Jun 23, 2023

bryanchriswhite changed the title ~~chore: introduce submodule~~ chore: introduce Submodule interface Jun 23, 2023

reviewpad bot added large Pull request is large and removed medium Pull request is medium labels Jun 23, 2023

fix: gofmt

048e306