Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Control Panel API #941

Open
stackdump opened this issue Dec 17, 2019 · 4 comments
Open

New Control Panel API #941

stackdump opened this issue Dec 17, 2019 · 4 comments

Comments

@stackdump
Copy link
Contributor

The existing control pane was removed in the Wax build.

It needs to be replaced w/ a new Admin Panel API

Eventually, we will adopt a javascript component library for Inc's Explorer so we will need to
develop a POC for how this front end will work.

Steps:

  • Create a new Control panel API
    • Async: It should have a browser-side event feed component were the UI monitors events from factomd maybe making use of https://github.com/alexandrevicenzi/go-sse ?
    • Synchronous: It may have a REST or similar type of synchronous api ( maybe graphQL is suitable? ) to handle synchronous calls for info
  • Integrate w/ new 'internal' pubsub framework
    • to monitor changes from various parts of the system
    • should allow for Admin user to dynamically subscribe/unsubscribe from any publisher

TODO: will add more notes about PubSub

Existing PubSub components use events are defined here https://github.com/FactomProject/factomd/blob/FD-1259_control_panel_rewrite/modules/event/event.go

FD-1259_control_panel_rewrite is the branch to use as a starting place

@stackdump
Copy link
Contributor Author

stackdump commented Jan 9, 2020

@Emyrk @factom-clay adding a note here

I think our understanding of how much is usable via pub/sub vs a synchronous query is evolving

we have a very simple/primitive directory to add hooks to query different objects in the new query architecture

Query module: https://github.com/FactomProject/factomd/blob/FD-1268_election_pubsub_integration/modules/query/query.go
Registered in the Elections constructor https://github.com/FactomProject/factomd/blob/FD-1268_election_pubsub_integration/elections/elections.go#L62
used by diagnostic api : https://github.com/FactomProject/factomd/blob/FD-1268_election_pubsub_integration/wsapi/wsapiV2.go#L1582 (edited)

@stackdump
Copy link
Contributor Author

Work-in progress from BIF was merged into wax.

Control panel in WAX build is still incomplete,
but the framework in place shows how to make use of Server Send Events 🥇

#974

@PaulBernier PaulBernier changed the title New Control Panel API For Wax New Control Panel API Aug 14, 2020
@PaulBernier
Copy link
Contributor

New control panel won't be in Wax, we are trying to reduce the scope of Wax to get it out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants