[Utility] Session Interface - `GetSession` Implementation (1st iteration) #683

Olshansk · 2023-04-15T03:14:58Z

Description

The first implementation of the session interface; the GetSession UtilityModule function.

Issue

Fixes #569

AI-Generated Summary

This pull request includes updates and improvements to various files related to the configuration of local environments, setting up sessions and actors, and enhancing the test suite for several modules. Significant changes include the addition of new parameters and properties for fishermen, introduction of the Session message in the session.proto file, a new test file module_test.go for the utility package, and multiple updates to the gov.go file.

Additional enhancements encompass renaming files, removing unnecessary functions, adding and updating tests and test artifacts, implementing new methods and functions, and making minor formatting and optimization changes. Furthermore, ideas for future improvements and optimizations have been marked with TechDebt, suggesting potential refactoring or redesign later in development. Overall, these changes aim to make the codebase more maintainable, readable and efficient, while also extending the functionality of several modules.

Type of change

Please mark the relevant option(s):

List of changes

Primary Changes

Added a new Session protobuf
Added a GetSession function to the Utility module interface
Implemented the GetSession function from the Utility module interface
Added a sessionHydrator structure used to populate a new session
Added a fisherman_per_session governance parameter

Supplementary Changes

Introduced testing helper to test the UtilityModule interface implementation
Added a GetActor function to the Persistence module interface
Implemented a new GetActor persistence modular function
Added an ability to add options to the NewGenesisState helper for more thorough testing

Secondary Changes

Updated the default blocks_per_session from 4 to 1
Consolidated files for defaults together
Minor code and comment cleanup

Testing

make develop_test; if any code changes were made
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)

github-actions

The changelog validation failed with the following output:

Missing changelog in module: build/

Missing changelog in module: persistence/

Missing changelog in module: runtime/

Missing changelog in module: shared/

Missing changelog in module: utility/

Changelog verification failed. See error messages for more detail.

Please update the relevant CHANGELOG.md files and ensure they follow the correct format.

github-actions

The changelog validation failed with the following output:

Missing changelog in module: build/

Missing changelog in module: persistence/

Missing changelog in module: runtime/

Missing changelog in module: shared/

Missing changelog in module: utility/

Changelog verification failed. See error messages for more detail.

Please update the relevant CHANGELOG.md files and ensure they follow the correct format.

…lability

github-actions

The changelog validation failed with the following output:

Missing changelog in module: build/

Missing changelog in module: persistence/

Missing changelog in module: runtime/

Missing changelog in module: shared/

Missing changelog in module: utility/

Changelog verification failed. See error messages for more detail.

Please update the relevant CHANGELOG.md files and ensure they follow the correct format.

github-actions

The changelog validation failed with the following output:

Missing changelog in module: build/

Missing changelog in module: persistence/

Missing changelog in module: runtime/

Missing changelog in module: shared/

Missing changelog in module: utility/

Changelog verification failed. See error messages for more detail.

Please update the relevant CHANGELOG.md files and ensure they follow the correct format.

Removes the unneeded `stdnetwork` package. Covers removal goal of #266. The simplification goal is tracked by #553. TLDR; should close #266. Please mark the relevant option(s): - [ ] New feature, functionality or library - [ ] Bug fix - [x] Code health or cleanup - [ ] Major breaking change - [ ] Documentation - [ ] Other  - Removed unneeded `stdnetwork` package - Removed unneeded `use_rain_tree` P2P config field - [ ] `make develop_test`; if any code changes were made - [x] [Docker Compose LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md); if any major functionality was changed or introduced - [x] [k8s LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md); if any infrastructure or configuration changes were made - [ ] 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](https://go.dev/blog/godoc) on touched members (see: [tip.golang.org/doc/comment](https://tip.golang.org/doc/comment)) - [ ] I have tested my changes using the available tooling - [ ] I have updated the corresponding CHANGELOG - [ ] 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](https://mermaid-js.github.io) diagrams in the corresponding README(s) - [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s)

## Description Refactors everything in the P2P module which previously referred to a "network" to instead be thought of as a "router". This begins with the `typesP2P.Network` interface and the changes propagates down from there, through implementations and into variable names, tests, etc. ## Issue Fixes #<issue_number> ## Type of change Please mark the relevant option(s): - [ ] New feature, functionality or library - [ ] Bug fix - [x] Code health or cleanup - [ ] Major breaking change - [ ] Documentation - [ ] Other  ## List of changes - Renamed `Network` interface to `Router` - Shortened `Router#NetworkBroadcast` to `#Broadcast` - Shortened `Router#NetworkSend` to `#Send` - Shortened `Router#networkSendInternal` to `#sendInternal` - Shortened `Router#networkBroadcastAtLevel` to `#broadcastAtLevel` - Renamed `rainTreeNetwork` to `rainTreeRouter` - Renamed `rainTreeNetwork` method receivers - Renamed `p2pModule#network` to `#router` - Renamed `p2pModule#setupNetwork()` to `#setupRouter()` - Renamed config var in `rainTreeRouter#Create` - Renamed router logger - Renamed `NewRainTreeNetwork()` to `NewRainTreeRouter()` - Refactored peers_manager_test.go - Refactored network_test.go - Simplified p2p module/router config handoff - Updated debug logging ## Testing - [ ] `make develop_test`; if any code changes were made - [ ] [Docker Compose LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md); if any major functionality was changed or introduced - [ ] [k8s LocalNet](https://github.com/pokt-network/pocket/blob/main/build/localnet/README.md); 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](https://go.dev/blog/godoc) on touched members (see: [tip.golang.org/doc/comment](https://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](https://mermaid-js.github.io) diagrams in the corresponding README(s) - [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s)

dylanlott

2 minor nits, nothing showstopping. Passes tests on my machine. ✅ Let's get this merged 🚀

Makefile

shared/core/types/proto/actor.proto

github-actions

The changelog validation failed with the following output:

Missing changelog in module: logger/

Missing changelog in module: p2p/

Changelog verification failed. See error messages for more detail.

Please update the relevant CHANGELOG.md files and ensure they follow the correct format.

The check succeeded, dismissing the review comment.

utility/session_test.go

don't want to block approval

Olshansk added 13 commits April 10, 2023 21:13

session.proto added - good starting point

c473aea

Got session to almost generate

c0f7269

Merge branch 'main' into issues/569/session_impl

11353f7

Snapshot before changing how we manage chains

363f4ac

Added fisherman_per_session_owner

fc0f1f5

Merge branch 'main' into issues/569/session_impl

7eff6f1

All unit tests pasing again

74f11be

Added TestSession_SessionHeight

4f4cbbc

Merge branch 'main' into issues/569/session_impl

4b096bf

Remove read ctx

0bf2d75

Refactor some tests

6c04122

Merge branch 'main' into issues/569/session_impl

c913c6d

Added a test validating num of servicers and fisherman is correct

bfceded

Olshansk self-assigned this Apr 15, 2023

reviewpad bot added the large label Apr 15, 2023

Olshansk added utility Utility specific changes and removed large labels Apr 15, 2023

reviewpad bot added the large label Apr 15, 2023

Olshansk added this to the M3: Pocket RoS (Relay or Slash) milestone Apr 15, 2023

github-actions bot previously requested changes Apr 15, 2023

View reviewed changes

Merge branch 'main' into issues/569/session_impl

96fe1a2

github-actions bot previously requested changes Apr 17, 2023

View reviewed changes

Olshansk removed the large label Apr 17, 2023

reviewpad bot added the large label Apr 17, 2023

Olshansk added 3 commits April 17, 2023 16:12

Unit tests passing before adding more complex ones

2eb3c62

Finished TestSession_GetSession_ServicersAndFishermenCounts_ChainAvai…

42c59ec

…lability

Finished TestSession_GetSession_InvalidFutureSession

ee5b3f4

github-actions bot previously requested changes Apr 18, 2023

View reviewed changes

Add tests for TestSession_GetSession_ServicersAndFishermanEntropy

50ccff3

github-actions bot previously requested changes Apr 18, 2023

View reviewed changes

Olshansk mentioned this pull request Apr 28, 2023

[Testing] Establish a pattern for how to use TestMain #709

Open

6 tasks

bryanchriswhite and others added 4 commits April 28, 2023 13:38

MInor NIT comments

66a8940

utility/module_test.go -> utility/main_test.go

e26608a

Olshansk requested a review from bryanchriswhite April 28, 2023 20:39

dylanlott approved these changes Apr 28, 2023

View reviewed changes

Makefile Outdated Show resolved Hide resolved

shared/core/types/proto/actor.proto Outdated Show resolved Hide resolved

Olshansk added 2 commits April 28, 2023 14:11

Typo

e4ac25e

Fix changelogs

50b92e5

github-actions bot previously requested changes Apr 28, 2023

View reviewed changes

Update all the changelogs

d06787e

bryanchriswhite reviewed Apr 28, 2023

View reviewed changes

utility/session_test.go Show resolved Hide resolved

bryanchriswhite reviewed Apr 28, 2023

View reviewed changes

utility/session_test.go Outdated Show resolved Hide resolved

Olshansk added 2 commits April 28, 2023 15:45

Merge with main

42d69bc

Add t.Helper in session_test.go

e2864b8

Olshansk merged commit fb245bc into main Apr 28, 2023

Olshansk deleted the issues/569/session_impl branch April 28, 2023 23:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Utility] Session Interface - `GetSession` Implementation (1st iteration) #683

[Utility] Session Interface - `GetSession` Implementation (1st iteration) #683

Olshansk commented Apr 15, 2023 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

dylanlott left a comment •

edited

Loading

github-actions bot left a comment

[Utility] Session Interface - GetSession Implementation (1st iteration) #683

[Utility] Session Interface - GetSession Implementation (1st iteration) #683

Conversation

Olshansk commented Apr 15, 2023 • edited Loading

Description

Issue

AI-Generated Summary

Type of change

List of changes

Testing

Required Checklist

If Applicable Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

dylanlott left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

[Utility] Session Interface - `GetSession` Implementation (1st iteration) #683

[Utility] Session Interface - `GetSession` Implementation (1st iteration) #683

Olshansk commented Apr 15, 2023 •

edited

Loading

dylanlott left a comment •

edited

Loading