mirror of
https://github.com/fluencelabs/tendermint
synced 2025-04-25 06:42:16 +00:00
f6539737de
comment out failing consensus tests for now rewrite rpc httpclient to use new pubsub package import pubsub as tmpubsub, query as tmquery make event IDs constants EventKey -> EventTypeKey rename EventsPubsub to PubSub mempool does not use pubsub rename eventsSub to pubsub new subscribe API fix channel size issues and consensus tests bugs refactor rpc client add missing discardFromChan method add mutex rename pubsub to eventBus remove IsRunning from WSRPCConnection interface (not needed) add a comment in broadcastNewRoundStepsAndVotes rename registerEventCallbacks to broadcastNewRoundStepsAndVotes See https://dave.cheney.net/2014/03/19/channel-axioms stop eventBuses after reactor tests remove unnecessary Unsubscribe return subscribe helper function move discardFromChan to where it is used subscribe now returns an err this gives us ability to refuse to subscribe if pubsub is at its max capacity. use context for control overflow cache queries handle err when subscribing in replay_test rename testClientID to testSubscriber extract var set channel buffer capacity to 1 in replay_file fix byzantine_test unsubscribe from single event, not all events refactor httpclient to return events to appropriate channels return failing testReplayCrashBeforeWriteVote test fix TestValidatorSetChanges refactor code a bit fix testReplayCrashBeforeWriteVote add comment fix TestValidatorSetChanges fixes from Bucky's review update comment [ci skip] test TxEventBuffer update changelog fix TestValidatorSetChanges (2nd attempt) only do wg.Done when no errors benchmark event bus create pubsub server inside NewEventBus only expose config params (later if needed) set buffer capacity to 0 so we are not testing cache new tx event format: key = "Tx" plus a tag {"tx.hash": XYZ} This should allow to subscribe to all transactions! or a specific one using a query: "tm.events.type = Tx and tx.hash = '013ABF99434...'" use TimeoutCommit instead of afterPublishEventNewBlockTimeout TimeoutCommit is the time a node waits after committing a block, before it goes into the next height. So it will finish everything from the last block, but then wait a bit. The idea is this gives it time to hear more votes from other validators, to strengthen the commit it includes in the next block. But it also gives it time to hear about new transactions. waitForBlockWithUpdatedVals rewrite WAL crash tests Task: test that we can recover from any WAL crash. Solution: the old tests were relying on event hub being run in the same thread (we were injecting the private validator's last signature). when considering a rewrite, we considered two possible solutions: write a "fuzzy" testing system where WAL is crashing upon receiving a new message, or inject failures and trigger them in tests using something like https://github.com/coreos/gofail. remove sleep no cs.Lock around wal.Save test different cases (empty block, non-empty block, ...) comments add comments test 4 cases: empty block, non-empty block, non-empty block with smaller part size, many blocks fixes as per Bucky's last review reset subscriptions on UnsubscribeAll use a simple counter to track message for which we panicked also, set a smaller part size for all test cases
104 lines
2.4 KiB
Go
104 lines
2.4 KiB
Go
/*
|
|
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets
|
|
|
|
# Client Requests
|
|
|
|
Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.
|
|
|
|
## GET (URI)
|
|
|
|
As a GET request, it would have URI encoded parameters, and look like:
|
|
|
|
```
|
|
curl 'http://localhost:8008/hello_world?name="my_world"&num=5'
|
|
```
|
|
|
|
Note the `'` around the url, which is just so bash doesn't ignore the quotes in `"my_world"`.
|
|
This should also work:
|
|
|
|
```
|
|
curl http://localhost:8008/hello_world?name=\"my_world\"&num=5
|
|
```
|
|
|
|
A GET request to `/` returns a list of available endpoints.
|
|
For those which take arguments, the arguments will be listed in order, with `_` where the actual value should be.
|
|
|
|
## POST (JSONRPC)
|
|
|
|
As a POST request, we use JSONRPC. For instance, the same request would have this as the body:
|
|
|
|
```
|
|
{
|
|
"jsonrpc": "2.0",
|
|
"id": "anything",
|
|
"method": "hello_world",
|
|
"params": {
|
|
"name": "my_world",
|
|
"num": 5
|
|
}
|
|
}
|
|
```
|
|
|
|
With the above saved in file `data.json`, we can make the request with
|
|
|
|
```
|
|
curl --data @data.json http://localhost:8008
|
|
```
|
|
|
|
## WebSocket (JSONRPC)
|
|
|
|
All requests are exposed over websocket in the same form as the POST JSONRPC.
|
|
Websocket connections are available at their own endpoint, typically `/websocket`,
|
|
though this is configurable when starting the server.
|
|
|
|
# Server Definition
|
|
|
|
Define some types and routes:
|
|
|
|
```
|
|
type ResultStatus struct {
|
|
Value string
|
|
}
|
|
|
|
// Define some routes
|
|
var Routes = map[string]*rpcserver.RPCFunc{
|
|
"status": rpcserver.NewRPCFunc(Status, "arg"),
|
|
}
|
|
|
|
// an rpc function
|
|
func Status(v string) (*ResultStatus, error) {
|
|
return &ResultStatus{v}, nil
|
|
}
|
|
|
|
```
|
|
|
|
Now start the server:
|
|
|
|
```
|
|
mux := http.NewServeMux()
|
|
rpcserver.RegisterRPCFuncs(mux, Routes)
|
|
wm := rpcserver.NewWebsocketManager(Routes)
|
|
mux.HandleFunc("/websocket", wm.WebsocketHandler)
|
|
logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
|
|
go func() {
|
|
_, err := rpcserver.StartHTTPServer("0.0.0.0:8008", mux, logger)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}()
|
|
|
|
```
|
|
|
|
Note that unix sockets are supported as well (eg. `/path/to/socket` instead of `0.0.0.0:8008`)
|
|
|
|
Now see all available endpoints by sending a GET request to `0.0.0.0:8008`.
|
|
Each route is available as a GET request, as a JSONRPCv2 POST request, and via JSONRPCv2 over websockets.
|
|
|
|
|
|
# Examples
|
|
|
|
* [Tendermint](https://github.com/tendermint/tendermint/blob/master/rpc/core/routes.go)
|
|
* [tm-monitor](https://github.com/tendermint/tools/blob/master/tm-monitor/rpc.go)
|
|
*/
|
|
package rpc
|