Page MenuHomePhabricator
Differential D16783

[chronik-client] Support websocket subscriptions to plugins
ClosedPublic
Actions

Authored by bytesofman on Sep 18 2024, 19:00.

Details

Reviewers
tobias_ruck
Group Reviewers
Restricted Project
Commits
rABC87174b963d77: [chronik-client] Support websocket subscriptions to plugins
Summary

Support the chronik functionality introduced in D16696 in chronik-client

Test Plan

CI for chronik-client integration tests

Diff Detail

Event Timeline

bytesofman created this revision.Sep 18 2024, 19:00
Herald added a reviewer: Restricted Project. · View Herald TranscriptSep 18 2024, 19:00
Harbormaster completed remote builds in B30348: Diff 49718.Sep 18 2024, 19:00
bytesofman updated this revision to Diff 49719.Sep 18 2024, 19:01

Correct diff link for change log

Harbormaster completed remote builds in B30349: Diff 49719.Sep 18 2024, 19:31
bytesofman updated this revision to Diff 49724.Sep 18 2024, 21:14

correct test script to match resolved mempool bugs, add validation for plugin subs, test plugin subs and unsubs, clean up logs

bytesofman updated this revision to Diff 49725.Sep 18 2024, 21:21

clean up comments

Harbormaster completed remote builds in B30353: Diff 49724.Sep 18 2024, 21:37
Harbormaster completed remote builds in B30354: Diff 49725.Sep 18 2024, 21:50
bytesofman published this revision for review.Sep 18 2024, 21:53
bytesofman added a child revision: D16786: [chronik-client] Support history, confirmedTxs, unconfirmedTxs for plugins endpoints.Sep 18 2024, 23:36
tobias_ruck accepted this revision.Sep 19 2024, 09:05
tobias_ruck added a subscriber: tobias_ruck.

otherwise lgtm

modules/chronik-client/src/ChronikClient.ts
765

eventually we should abstract this for all subscription types but not in this diff

modules/chronik-client/src/validation.ts
75

is there a reason for the "first parameter"? since it's an object and not a list

83

same here

89

and here

This revision is now accepted and ready to land.Sep 19 2024, 09:05
bytesofman marked 4 inline comments as done.Sep 19 2024, 12:47
bytesofman added inline comments.
modules/chronik-client/src/validation.ts
75

In this case, the user only sees this error msg by calling subscribeToPlugin(pluginName, group)

case to be made that all subscription functions should be more like subscribeTo<Thing>(objectOfExpectedShape), e.g. in this case subscribeToPlugin({pluginName: <name>, group: <group>}) -- that is not currently the API tho (subscribeToScript is like this as well).

That said ... yeah I don't think "first parameter" is really helping. If we do truly need it, good sign the API needs to be changed.

Closed by commit rABC87174b963d77: [chronik-client] Support websocket subscriptions to plugins (authored by bytesofman). · Explain WhySep 19 2024, 12:51
This revision was automatically updated to reflect the committed changes.
bytesofman marked an inline comment as done.
bytesofman added a commit: rABC87174b963d77: [chronik-client] Support websocket subscriptions to plugins.

Revision Contents
Changeset List

PathSize
modules/
chronik-client/
3 lines
4 lines
2 lines
proto/
115 lines
src/
82 lines
27 lines
test/
integration/
159 lines
test/
functional/
setup_scripts/
41 lines

Diff 49725

View Options

modules/chronik-client/README.md

Loading...
View Options

modules/chronik-client/package-lock.json

Loading...
View Options

modules/chronik-client/package.json

Loading...
View Options

modules/chronik-client/proto/chronik.ts

Loading...
View Options

modules/chronik-client/src/ChronikClient.ts

Loading...
View Options

modules/chronik-client/src/validation.ts

Loading...
View Options

modules/chronik-client/test/integration/plugins.ts

Loading...
View Options

test/functional/setup_scripts/chronik-client_plugins.py

Loading...