[Miner] feat: add events query client #64

bryanchriswhite · 2023-10-14T18:42:01Z

@Reviewer

This PR may be more digestible / reviewable on a commit-by-commit basis. Commits are organized logically and any given line is only modified in a single commit, with few exceptions*.

*(In the interest of preserving the git-time-continuum 👮🚨, this applies in batches of commits between comments or reviews by humans, only once "in review")

Summary

Adds EventsQueryClient interface and implementation.

---
title: Clients Dependency Tree
---
flowchart

sup[SupplierClient]
tx[TxClient]
bl[BlockClient]
evt[EventsQueryClient]

sup --"#SignAndBroadcast()"--> tx
tx --"#CommittedBlocksSequence()"--> bl
tx --"#EventsBytes()"--> evt
bl --"#EventsBytes()"--> evt

Issue

Relates to:

QueryClient is a nested dependency of Miner.

Type of change

Select one or more:

Testing

Run all unit tests: make go_test_integration
Verify Localnet manually: See the instructions [here](TODO: add link to instructions)

Sanity Checklist

I have tested my changes using the available tooling
I have performed a self-review of my own code
I have commented my code, updated documentation and left TODOs throughout the codebase

pkg/client/query/client_test.go

Makefile

pkg/client/query/client_test.go

pkg/client/events_query/client.go

(cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c)

* pokt/main: fix: RelayerProxy interface mismatch (#91) [RelayerProxy] feat: implement relayerProxy struct (#82) [AppGate] Scaffold undelegate-from-gateway message & nothing else (#86) [AppGate] Scaffold delegate-to-gateway message and nothing else (#85) [Supplier] Implement MsgUnstakeSupplier w/ Tests (#77) [Supplier] Implement MsgStakeSupplier & Add Extensive Tests (#76) [RelayerProxy] feat: add RelayerProxy interface (#80)

(cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e)

* feat/observable-map: feat: add the map channel observable operator

* merge/map_x_replay: fix: race chore: review improvements fix: comment typo fix: interface assertion test: improve and add tests chore: add warning log and improve comments [Miner] feat: add the map channel observable operator (#92)

…-client * pokt/feat/query-client: fix: interface assertions

Olshansk

@bryanchriswhite

Reviewed everything other than pkg/client/events_query/client_test.go
The base branch needs to be updated
Still wrapping my head around all the different clients/components but it's slowly coming together
I pushed some NITs to the README so please make sure to do a git pull
Great job!

internal/testclient/common.go

internal/testclient/testeventsquery/connection.go

pkg/client/events_query/client.go

pkg/client/events_query/client_integration_test.go

docs/pkg/client/events_query.md

(cherry picked from commit 31555cdc68211964358c43842e0581f565d1afff)

(cherry picked from commit ccb1d6981f67ab860cb65dde4da15d89bcf57875)

pkg/client/events_query/client.go

pkg/client/events_query/client_integration_test.go

Olshansk · 2023-10-26T21:13:31Z

pkg/client/events_query/websocket/connection.go


 import (
-	"github.com/gorilla/websocket"
+	gorillaws "github.com/gorilla/websocket"


I wasn't aware gorrilas have laws 🦍

pkg/client/events_query/client.go

Olshansk

A few minor nits plus a request to #PUC, but otherwise lgtm!

Co-authored-by: Daniel Olshansky <[email protected]>

All comments resolved.

* main: [Session] Implement the 1st iteration of the SessionHydrator (#78) Update pull_request_template.md [Test] Enforce `msg.ValidateBasic` in all the `keepers` and `msgServers` for redundancy (#100) test: add itest script and makefile target (#99)

* pokt/main: [Miner] feat: add events query client (#64)

* feat: add the map channel observable operator (cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c) * feat: add replay observable (cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e) * chore: add query client interface * chore: add query client errors * test: fix false positive, prevent regression, & add comments * chore: add godoc comment * feat: add query client implementation * chore: add connection & dialer wrapper implementations * test: query client & add testquery helper pkg * chore: add go_test_integration make target * chore: add internal mocks pkg * test: query client integration test * docs: add event query client docs * chore: update go.mod * chore: re-order `eventsQueryClient` methods to improve readability * chore: add godoc comments to testclient helpers * fix: comment formatting * chore: improve comment & naming in evt query client test * test: tune events query client parameters * chore: improve godoc comments * chore: review improvements * refactor: `replayObservable` as its own interface type * refactor: `replayObservable#Next() V` to `ReplayObservable#Last(ctx, n) []V` * chore: add constructor func for `ReplayObservable` * test: reorder to improve readibility * refactor: rename and add godoc comments * chore: improve naming & comments * chore: add warning log and improve comments * test: improve and add tests * fix: interface assertion * fix: comment typo * chore: review improvements * fix: race * fix: race on eventsBytesAndConns map * fix: interface assertions Co-authored-by: Redouane Lakrache <[email protected]> * fix: race * Small updates to the README * chore: review improvements (cherry picked from commit 31555cdc68211964358c43842e0581f565d1afff) * refactor: eliminate `EventsQueryClient#requestId` field (cherry picked from commit ccb1d6981f67ab860cb65dde4da15d89bcf57875) * refactor: eliminate `EventsQueryClient#requestId` field * refactor: move websocket dialer and connection to own pkg * chore: add comment * chore: move `EventsBytesObservable type above interfaces * chore: review improvements * fix: bug & improve naming & comments * chore: review improvements * chore: review improvements * chore: add comment Co-authored-by: Daniel Olshansky <[email protected]> * revert: replay observable, merged into previous base branch --------- Co-authored-by: Redouane Lakrache <[email protected]> Co-authored-by: Daniel Olshansky <[email protected]>

bryanchriswhite added the miner Changes related to the Miner label Oct 14, 2023

bryanchriswhite added this to the Shannon TestNet milestone Oct 14, 2023

bryanchriswhite self-assigned this Oct 14, 2023

bryanchriswhite changed the title ~~[Miner] feat: query client~~ [Miner] feat: add query client Oct 14, 2023

bryanchriswhite linked an issue Oct 14, 2023 that may be closed by this pull request

[Miner] Foundation for the Miner submodule #13

Closed

10 tasks

h5law reviewed Oct 14, 2023

View reviewed changes

pkg/client/query/client_test.go Outdated Show resolved Hide resolved

h5law reviewed Oct 14, 2023

View reviewed changes

Makefile Outdated Show resolved Hide resolved

bryanchriswhite force-pushed the feat/query-client branch from 65a5f43 to 97432bb Compare October 17, 2023 13:01

bryanchriswhite mentioned this pull request Oct 17, 2023

[Pkg] feat: add channel observable #31

Merged

10 tasks

bryanchriswhite force-pushed the feat/query-client branch from 97432bb to 7ebb5fb Compare October 17, 2023 19:25

bryanchriswhite commented Oct 17, 2023

View reviewed changes

pkg/client/query/client_test.go Outdated Show resolved Hide resolved

bryanchriswhite force-pushed the feat/query-client branch from 7ebb5fb to f7f9a32 Compare October 18, 2023 11:09

bryanchriswhite changed the base branch from wip/merge/observable_x_supplier-msgs to merge/observable_x_supplier-msgs October 18, 2023 11:09

bryanchriswhite force-pushed the feat/query-client branch 2 times, most recently from e9c47f9 to 0d73bd8 Compare October 18, 2023 12:09

bryanchriswhite mentioned this pull request Oct 18, 2023

[Experiment] repro: comet query client #74

Closed

10 tasks

bryanchriswhite force-pushed the feat/query-client branch 2 times, most recently from 6bc8e56 to 4f9f3ea Compare October 19, 2023 20:47

bryanchriswhite changed the title ~~[Miner] feat: add query client~~ [Miner] feat: add events query client Oct 20, 2023

bryanchriswhite force-pushed the feat/query-client branch 4 times, most recently from 0439247 to 015e5ef Compare October 20, 2023 11:09

h5law reviewed Oct 20, 2023

View reviewed changes

pkg/client/events_query/client.go Outdated Show resolved Hide resolved

feat: add the map channel observable operator

3f2971b

(cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c)

bryanchriswhite mentioned this pull request Oct 23, 2023

[Miner] feat: add the map channel observable operator #92

Merged

10 tasks

bryanchriswhite added 2 commits October 23, 2023 18:18

feat: add replay observable

4af6643

(cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e)

bryanchriswhite mentioned this pull request Oct 23, 2023

[Miner] feat: add replay observable #93

Merged

10 tasks

Merge branch 'feat/observable-map' into merge/map_x_replay

765b0c9

* feat/observable-map: feat: add the map channel observable operator

bryanchriswhite and others added 3 commits October 25, 2023 14:57

Merge remote-tracking branch 'pokt/feat/query-client' into feat/query…

a6d77b9

…-client * pokt/feat/query-client: fix: interface assertions

Small updates to the README

4419602

Olshansk requested changes Oct 25, 2023

View reviewed changes

bryanchriswhite added 6 commits October 26, 2023 16:38

chore: review improvements

c093488

(cherry picked from commit 31555cdc68211964358c43842e0581f565d1afff)

refactor: eliminate EventsQueryClient#requestId field

874d424

(cherry picked from commit ccb1d6981f67ab860cb65dde4da15d89bcf57875)

refactor: eliminate EventsQueryClient#requestId field

73dedf1

refactor: move websocket dialer and connection to own pkg

fab303f

chore: add comment

fe681f9

chore: move `EventsBytesObservable type above interfaces

4830c06

bryanchriswhite requested a review from Olshansk October 26, 2023 20:33

chore: review improvements

4762fa3

This comment was marked as outdated.

Sign in to view

fix: bug & improve naming & comments

27ed494

Olshansk reviewed Oct 26, 2023

View reviewed changes

Olshansk approved these changes Oct 26, 2023

View reviewed changes

bryanchriswhite and others added 3 commits October 27, 2023 12:22

chore: review improvements

676ff91

chore: review improvements

d7490ac

chore: add comment

a094a9f

Co-authored-by: Daniel Olshansky <[email protected]>

bryanchriswhite changed the base branch from merge/map_x_replay to main October 27, 2023 10:41

revert: replay observable, merged into previous base branch

74ec7e8

bryanchriswhite force-pushed the feat/query-client branch from f8a753d to 74ec7e8 Compare October 27, 2023 11:15

bryanchriswhite merged commit 2c78154 into main Oct 27, 2023

bryanchriswhite added a commit that referenced this pull request Oct 27, 2023

Merge remote-tracking branch 'pokt/main' into feat/block-client

b407e16

* pokt/main: [Miner] feat: add events query client (#64)

bryanchriswhite added a commit that referenced this pull request Oct 27, 2023

Merge remote-tracking branch 'pokt/main' into feat/replay-observable

e04177f

* pokt/main: [Miner] feat: add events query client (#64)

bryanchriswhite mentioned this pull request Oct 30, 2023

feat: add either.AsyncErr type & helpers #115

Merged

10 tasks

bryanchriswhite deleted the feat/query-client branch November 6, 2023 09:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Miner] feat: add events query client #64

[Miner] feat: add events query client #64

bryanchriswhite commented Oct 14, 2023 •

edited

Loading

Olshansk left a comment •

edited

Loading

This comment was marked as outdated.

Olshansk Oct 26, 2023

bryanchriswhite Oct 27, 2023

Olshansk left a comment

[Miner] feat: add events query client #64

[Miner] feat: add events query client #64

Conversation

bryanchriswhite commented Oct 14, 2023 • edited Loading

@Reviewer

Summary

Issue

Type of change

Testing

Sanity Checklist

Olshansk left a comment • edited Loading

Choose a reason for hiding this comment

This comment was marked as outdated.

Olshansk Oct 26, 2023

Choose a reason for hiding this comment

bryanchriswhite Oct 27, 2023

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

bryanchriswhite commented Oct 14, 2023 •

edited

Loading

Olshansk left a comment •

edited

Loading