diff --git a/README.md b/README.md index 9b6dba4a4..057d0b622 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,9 @@ Binary will be created as `.bin` under the `build` d make test/tests/common/test_enr_builder.nim ``` +### Testing against `js-waku` +Refer to [js-waku repo](https://github.com/waku-org/js-waku/tree/master/packages/tests) for instructions. + ## Formatting Nim files are expected to be formatted using the [`nph`](https://github.com/arnetheduck/nph) version present in `vendor/nph`. diff --git a/apps/liteprotocoltester/.env b/apps/liteprotocoltester/.env index 4f7c49976..0330284e1 100644 --- a/apps/liteprotocoltester/.env +++ b/apps/liteprotocoltester/.env @@ -12,16 +12,16 @@ MIN_MESSAGE_SIZE=15Kb MAX_MESSAGE_SIZE=145Kb ## for wakusim -#PUBSUB=/waku/2/rs/66/0 +#SHARD=0 #CONTENT_TOPIC=/tester/2/light-pubsub-test/wakusim #CLUSTER_ID=66 ## for status.prod -PUBSUB=/waku/2/rs/16/32 +#SHARDS=32 CONTENT_TOPIC=/tester/2/light-pubsub-test/fleet CLUSTER_ID=16 ## for TWN -#PUBSUB=/waku/2/rs/1/4 +#SHARD=4 #CONTENT_TOPIC=/tester/2/light-pubsub-test/twn #CLUSTER_ID=1 diff --git a/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile b/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile index cee1929ce..6d789ebd1 100644 --- a/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile +++ b/apps/liteprotocoltester/Dockerfile.liteprotocoltester.compile @@ -55,6 +55,8 @@ RUN chmod +x /usr/bin/liteprotocoltester FROM base_lpt AS standalone_lpt COPY --from=nim-build /app/apps/liteprotocoltester/run_tester_node.sh /usr/bin/ +COPY --from=nim-build /app/apps/liteprotocoltester/run_tester_node_on_fleet.sh /usr/bin/ + RUN chmod +x /usr/bin/run_tester_node.sh ENTRYPOINT ["/usr/bin/run_tester_node.sh", "/usr/bin/liteprotocoltester"] diff --git a/apps/liteprotocoltester/README.md b/apps/liteprotocoltester/README.md index eff025969..ea02ec1c1 100644 --- a/apps/liteprotocoltester/README.md +++ b/apps/liteprotocoltester/README.md @@ -127,7 +127,7 @@ Run a SENDER role liteprotocoltester and a RECEIVER role one on different termin | ---: | :--- | :--- | | NUM_MESSAGES | Number of message to publish, 0 means infinite | 120 | | MESSAGE_INTERVAL_MILLIS | Frequency of messages in milliseconds | 1000 | -| PUBSUB | Used pubsub_topic for testing | /waku/2/rs/66/0 | +| SHARD | Used shard for testing | 0 | | CONTENT_TOPIC | content_topic for testing | /tester/1/light-pubsub-example/proto | | CLUSTER_ID | cluster_id of the network | 16 | | START_PUBLISHING_AFTER_SECS | Delay in seconds before starting to publish to let service node connected | 5 | @@ -272,7 +272,7 @@ export NUM_MESSAGES=200 export MESSAGE_INTERVAL_MILLIS=1000 export MIN_MESSAGE_SIZE=15Kb export MAX_MESSAGE_SIZE=145Kb -export PUBSUB=/waku/2/rs/16/32 +export SHARD=32 export CONTENT_TOPIC=/tester/2/light-pubsub-test/fleet export CLUSTER_ID=16 @@ -307,7 +307,7 @@ export NUM_MESSAGES=300 export MESSAGE_INTERVAL_MILLIS=7000 export MIN_MESSAGE_SIZE=15Kb export MAX_MESSAGE_SIZE=145Kb -export PUBSUB=/waku/2/rs/1/4 +export SHARD=4 export CONTENT_TOPIC=/tester/2/light-pubsub-test/twn export CLUSTER_ID=1 diff --git a/apps/liteprotocoltester/docker-compose-on-simularor.yml b/apps/liteprotocoltester/docker-compose-on-simularor.yml index c63a294f2..9e899f78f 100644 --- a/apps/liteprotocoltester/docker-compose-on-simularor.yml +++ b/apps/liteprotocoltester/docker-compose-on-simularor.yml @@ -16,7 +16,7 @@ x-rln-environment: &rln_env x-test-running-conditions: &test_running_conditions NUM_MESSAGES: ${NUM_MESSAGES:-120} MESSAGE_INTERVAL_MILLIS: "${MESSAGE_INTERVAL_MILLIS:-1000}" - PUBSUB: ${PUBSUB:-/waku/2/rs/66/0} + SHARD: ${SHARD:-0} CONTENT_TOPIC: ${CONTENT_TOPIC:-/tester/2/light-pubsub-test/wakusim} CLUSTER_ID: ${CLUSTER_ID:-66} MIN_MESSAGE_SIZE: ${MIN_MESSAGE_SIZE:-1Kb} diff --git a/apps/liteprotocoltester/docker-compose.yml b/apps/liteprotocoltester/docker-compose.yml index afd2f1e72..0effbf8f0 100644 --- a/apps/liteprotocoltester/docker-compose.yml +++ b/apps/liteprotocoltester/docker-compose.yml @@ -16,7 +16,7 @@ x-rln-environment: &rln_env x-test-running-conditions: &test_running_conditions NUM_MESSAGES: ${NUM_MESSAGES:-120} MESSAGE_INTERVAL_MILLIS: "${MESSAGE_INTERVAL_MILLIS:-1000}" - PUBSUB: ${PUBSUB:-/waku/2/rs/66/0} + SHARD: ${SHARD:-0} CONTENT_TOPIC: ${CONTENT_TOPIC:-/tester/2/light-pubsub-test/wakusim} CLUSTER_ID: ${CLUSTER_ID:-66} MIN_MESSAGE_SIZE: ${MIN_MESSAGE_SIZE:-1Kb} diff --git a/apps/liteprotocoltester/filter_subscriber.nim b/apps/liteprotocoltester/filter_subscriber.nim index 143e0ca80..fbb11c92e 100644 --- a/apps/liteprotocoltester/filter_subscriber.nim +++ b/apps/liteprotocoltester/filter_subscriber.nim @@ -130,7 +130,9 @@ proc setupAndSubscribe*( var stats: PerPeerStatistics actualFilterPeer = servicePeer - let pushHandler = proc(pubsubTopic: PubsubTopic, message: WakuMessage) {.async.} = + let pushHandler = proc( + pubsubTopic: PubsubTopic, message: WakuMessage + ): Future[void] {.async, closure.} = let payloadStr = string.fromBytes(message.payload) let testerMessage = js.Json.decode(payloadStr, ProtocolTesterMessage) let msgHash = computeMessageHash(pubsubTopic, message).to0xHex @@ -163,7 +165,7 @@ proc setupAndSubscribe*( if conf.numMessages > 0 and waitFor stats.checkIfAllMessagesReceived(maxWaitForLastMessage): - waitFor unsubscribe(wakuNode, conf.pubsubTopics[0], conf.contentTopics[0]) + waitFor unsubscribe(wakuNode, conf.getPubsubTopic(), conf.contentTopics[0]) info "All messages received. Exiting." ## for gracefull shutdown through signal hooks @@ -176,5 +178,5 @@ proc setupAndSubscribe*( # Start maintaining subscription asyncSpawn maintainSubscription( - wakuNode, conf.pubsubTopics[0], conf.contentTopics[0], conf.fixedServicePeer + wakuNode, conf.getPubsubTopic(), conf.contentTopics[0], conf.fixedServicePeer ) diff --git a/apps/liteprotocoltester/infra.env b/apps/liteprotocoltester/infra.env index 6d4542eca..ebf614732 100644 --- a/apps/liteprotocoltester/infra.env +++ b/apps/liteprotocoltester/infra.env @@ -4,7 +4,7 @@ NUM_MESSAGES=300 MESSAGE_INTERVAL_MILLIS=1000 MIN_MESSAGE_SIZE=15Kb MAX_MESSAGE_SIZE=145Kb -PUBSUB=/waku/2/rs/16/32 +SHARD=32 CONTENT_TOPIC=/tester/2/light-pubsub-test-at-infra/status-prod CLUSTER_ID=16 LIGHTPUSH_BOOTSTRAP=enr:-QEKuED9AJm2HGgrRpVaJY2nj68ao_QiPeUT43sK-aRM7sMJ6R4G11OSDOwnvVacgN1sTw-K7soC5dzHDFZgZkHU0u-XAYJpZIJ2NIJpcISnYxMvim11bHRpYWRkcnO4WgAqNiVib290LTAxLmRvLWFtczMuc3RhdHVzLnByb2Quc3RhdHVzLmltBnZfACw2JWJvb3QtMDEuZG8tYW1zMy5zdGF0dXMucHJvZC5zdGF0dXMuaW0GAbveA4Jyc40AEAUAAQAgAEAAgAEAiXNlY3AyNTZrMaEC3rRtFQSgc24uWewzXaxTY8hDAHB8sgnxr9k8Rjb5GeSDdGNwgnZfg3VkcIIjKIV3YWt1Mg0 diff --git a/apps/liteprotocoltester/lightpush_publisher.nim b/apps/liteprotocoltester/lightpush_publisher.nim index 32f802fe4..d79e68590 100644 --- a/apps/liteprotocoltester/lightpush_publisher.nim +++ b/apps/liteprotocoltester/lightpush_publisher.nim @@ -145,13 +145,20 @@ proc publishMessages( lightpushContentTopic, renderMsgSize, ) + + let publishStartTime = Moment.now() + let wlpRes = await wakuNode.legacyLightpushPublish( some(lightpushPubsubTopic), message, actualServicePeer ) + let publishDuration = Moment.now() - publishStartTime + let msgHash = computeMessageHash(lightpushPubsubTopic, message).to0xHex if wlpRes.isOk(): + lpt_publish_duration_seconds.observe(publishDuration.milliseconds.float / 1000) + sentMessages[messagesSent] = (hash: msgHash, relayed: true) notice "published message using lightpush", index = messagesSent + 1, @@ -251,7 +258,7 @@ proc setupAndPublish*( asyncSpawn publishMessages( wakuNode, servicePeer, - conf.pubsubTopics[0], + conf.getPubsubTopic(), conf.contentTopics[0], conf.numMessages, (min: parsedMinMsgSize, max: parsedMaxMsgSize), diff --git a/apps/liteprotocoltester/liteprotocoltester.nim b/apps/liteprotocoltester/liteprotocoltester.nim index c23b80e72..ef63e6e7d 100644 --- a/apps/liteprotocoltester/liteprotocoltester.nim +++ b/apps/liteprotocoltester/liteprotocoltester.nim @@ -99,7 +99,7 @@ when isMainModule: wakuConf.dnsAddrs = true wakuConf.dnsAddrsNameServers = @[parseIpAddress("8.8.8.8"), parseIpAddress("1.1.1.1")] - wakuConf.pubsubTopics = conf.pubsubTopics + wakuConf.shards = @[conf.shard] wakuConf.contentTopics = conf.contentTopics wakuConf.clusterId = conf.clusterId ## TODO: Depending on the tester needs we might extend here with shards, clusterId, etc... @@ -118,6 +118,7 @@ when isMainModule: wakuConf.store = false wakuConf.rest = false + wakuConf.relayServiceRatio = "40:60" # NOTE: {.threadvar.} is used to make the global variable GC safe for the closure uses it # It will always be called from main thread anyway. @@ -202,10 +203,8 @@ when isMainModule: var codec = WakuLightPushCodec # mounting relevant client, for PX filter client must be mounted ahead if conf.testFunc == TesterFunctionality.SENDER: - wakuApp.node.mountLegacyLightPushClient() codec = WakuLightPushCodec else: - waitFor wakuApp.node.mountFilterClient() codec = WakuFilterSubscribeCodec var lookForServiceNode = false diff --git a/apps/liteprotocoltester/lpt_metrics.nim b/apps/liteprotocoltester/lpt_metrics.nim index e68164d13..8b30619de 100644 --- a/apps/liteprotocoltester/lpt_metrics.nim +++ b/apps/liteprotocoltester/lpt_metrics.nim @@ -47,3 +47,10 @@ declarePublicGauge lpt_px_peers, declarePublicGauge lpt_dialed_peers, "Number of peers successfully dialed", ["agent"] declarePublicGauge lpt_dial_failures, "Number of dial failures by cause", ["agent"] + +declarePublicHistogram lpt_publish_duration_seconds, + "duration to lightpush messages", + buckets = [ + 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0, + 15.0, 20.0, 30.0, Inf, + ] diff --git a/apps/liteprotocoltester/run_service_node.sh b/apps/liteprotocoltester/run_service_node.sh index 1d36292c1..07fdbe980 100755 --- a/apps/liteprotocoltester/run_service_node.sh +++ b/apps/liteprotocoltester/run_service_node.sh @@ -5,10 +5,10 @@ IP=$(ip a | grep "inet " | grep -Fv 127.0.0.1 | sed 's/.*inet \([^/]*\).*/\1/') echo "Service node IP: ${IP}" -if [ -n "${PUBSUB}" ]; then - PUBSUB=--pubsub-topic="${PUBSUB}" +if [ -n "${SHARD}" ]; then + SHARD=--shard="${SHARD}" else - PUBSUB=--pubsub-topic="/waku/2/rs/66/0" + SHARD=--shard="0" fi if [ -n "${CLUSTER_ID}" ]; then @@ -59,5 +59,5 @@ exec /usr/bin/wakunode\ --metrics-server-port=8003\ --metrics-server-address=0.0.0.0\ --nat=extip:${IP}\ - ${PUBSUB}\ + ${SHARD}\ ${CLUSTER_ID} diff --git a/apps/liteprotocoltester/run_tester_node.sh b/apps/liteprotocoltester/run_tester_node.sh index 8975fba91..4a80ca460 100755 --- a/apps/liteprotocoltester/run_tester_node.sh +++ b/apps/liteprotocoltester/run_tester_node.sh @@ -93,10 +93,10 @@ else FULL_NODE=--bootstrap-node="${SERIVCE_NODE_ADDR}" fi -if [ -n "${PUBSUB}" ]; then - PUBSUB=--pubsub-topic="${PUBSUB}" +if [ -n "${SHARD}" ]; then + SHARD=--shard="${SHARD}" else - PUBSUB=--pubsub-topic="/waku/2/rs/66/0" + SHARD=--shard="0" fi if [ -n "${CONTENT_TOPIC}" ]; then @@ -128,19 +128,25 @@ if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}" fi +if [ -n "${LOG_LEVEL}" ]; then + LOG_LEVEL=--log-level=${LOG_LEVEL} +else + LOG_LEVEL=--log-level=INFO +fi + echo "Running binary: ${BINARY_PATH}" echo "Tester node: ${FUNCTION}" echo "Using service node: ${SERIVCE_NODE_ADDR}" echo "My external IP: ${MY_EXT_IP}" exec "${BINARY_PATH}"\ - --log-level=INFO\ --nat=extip:${MY_EXT_IP}\ --test-peers\ + ${LOG_LEVEL}\ ${FULL_NODE}\ ${MESSAGE_INTERVAL_MILLIS}\ ${NUM_MESSAGES}\ - ${PUBSUB}\ + ${SHARD}\ ${CONTENT_TOPIC}\ ${CLUSTER_ID}\ ${FUNCTION}\ diff --git a/apps/liteprotocoltester/run_tester_node_at_infra.sh b/apps/liteprotocoltester/run_tester_node_at_infra.sh index 6cec4b006..e926875aa 100644 --- a/apps/liteprotocoltester/run_tester_node_at_infra.sh +++ b/apps/liteprotocoltester/run_tester_node_at_infra.sh @@ -48,10 +48,10 @@ fi MY_EXT_IP=$(wget -qO- --no-check-certificate https://api4.ipify.org) -if [ -n "${PUBSUB}" ]; then - PUBSUB=--pubsub-topic="${PUBSUB}" +if [ -n "${SHARD}" ]; then + SHARD=--shard="${SHARD}" else - PUBSUB=--pubsub-topic="/waku/2/rs/66/0" + SHARD=--shard="0" fi if [ -n "${CONTENT_TOPIC}" ]; then @@ -83,19 +83,25 @@ if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}" fi +if [ -n "${LOG_LEVEL}" ]; then + LOG_LEVEL=--log-level=${LOG_LEVEL} +else + LOG_LEVEL=--log-level=INFO +fi + echo "Running binary: ${BINARY_PATH}" echo "Node function is: ${FUNCTION}" echo "Using service/bootstrap node as: ${NODE_ARG}" echo "My external IP: ${MY_EXT_IP}" exec "${BINARY_PATH}"\ - --log-level=INFO\ --nat=extip:${MY_EXT_IP}\ --test-peers\ + ${LOG_LEVEL}\ ${NODE_ARG}\ ${MESSAGE_INTERVAL_MILLIS}\ ${NUM_MESSAGES}\ - ${PUBSUB}\ + ${SHARD}\ ${CONTENT_TOPIC}\ ${CLUSTER_ID}\ ${FUNCTION}\ diff --git a/apps/liteprotocoltester/run_tester_node_on_fleet.sh b/apps/liteprotocoltester/run_tester_node_on_fleet.sh index f0300cef2..538a890e6 100644 --- a/apps/liteprotocoltester/run_tester_node_on_fleet.sh +++ b/apps/liteprotocoltester/run_tester_node_on_fleet.sh @@ -48,10 +48,10 @@ fi MY_EXT_IP=$(wget -qO- --no-check-certificate https://api4.ipify.org) -if [ -n "${PUBSUB}" ]; then - PUBSUB=--pubsub-topic="${PUBSUB}" +if [ -n "${SHARD}" ]; then + SHARD=--shard=${SHARD} else - PUBSUB=--pubsub-topic="/waku/2/rs/66/0" + SHARD=--shard=0 fi if [ -n "${CONTENT_TOPIC}" ]; then @@ -79,8 +79,14 @@ if [ -n "${NUM_MESSAGES}" ]; then NUM_MESSAGES=--num-messages="${NUM_MESSAGES}" fi -if [ -n "${DELAY_MESSAGES}" ]; then - DELAY_MESSAGES=--delay-messages="${DELAY_MESSAGES}" +if [ -n "${MESSAGE_INTERVAL_MILLIS}" ]; then + MESSAGE_INTERVAL_MILLIS=--message-interval="${MESSAGE_INTERVAL_MILLIS}" +fi + +if [ -n "${LOG_LEVEL}" ]; then + LOG_LEVEL=--log-level=${LOG_LEVEL} +else + LOG_LEVEL=--log-level=INFO fi echo "Running binary: ${BINARY_PATH}" @@ -89,12 +95,12 @@ echo "Using service/bootstrap node as: ${NODE_ARG}" echo "My external IP: ${MY_EXT_IP}" exec "${BINARY_PATH}"\ - --log-level=INFO\ --nat=extip:${MY_EXT_IP}\ + ${LOG_LEVEL}\ ${NODE_ARG}\ - ${DELAY_MESSAGES}\ + ${MESSAGE_INTERVAL_MILLIS}\ ${NUM_MESSAGES}\ - ${PUBSUB}\ + ${SHARD}\ ${CONTENT_TOPIC}\ ${CLUSTER_ID}\ ${FUNCTION}\ diff --git a/apps/liteprotocoltester/service_peer_management.nim b/apps/liteprotocoltester/service_peer_management.nim index 83216ae3b..a303c3c58 100644 --- a/apps/liteprotocoltester/service_peer_management.nim +++ b/apps/liteprotocoltester/service_peer_management.nim @@ -189,14 +189,14 @@ proc pxLookupServiceNode*( if conf.testPeers: let peersOpt = - await tryCallAllPxPeers(node.peerManager, codec, conf.pubsubTopics[0]) + await tryCallAllPxPeers(node.peerManager, codec, conf.getPubsubTopic()) if peersOpt.isSome(): info "Found service peers for codec", codec = codec, peer_count = peersOpt.get().len() return ok(peersOpt.get().len > 0) else: let peerOpt = - await selectRandomCapablePeer(node.peerManager, codec, conf.pubsubTopics[0]) + await selectRandomCapablePeer(node.peerManager, codec, conf.getPubsubTopic()) if peerOpt.isSome(): info "Found service peer for codec", codec = codec, peer = peerOpt.get() return ok(true) diff --git a/apps/liteprotocoltester/tester_config.nim b/apps/liteprotocoltester/tester_config.nim index 115686be3..eccaafc06 100644 --- a/apps/liteprotocoltester/tester_config.nim +++ b/apps/liteprotocoltester/tester_config.nim @@ -18,6 +18,7 @@ import common/logging, factory/external_config, waku_core, + waku_core/topics/pubsub_topic, ] export confTomlDefs, confTomlNet, confEnvvarDefs, confEnvvarNet @@ -95,18 +96,9 @@ type LiteProtocolTesterConf* = object name: "message-interval" .}: uint32 - pubsubTopics* {. - desc: "Default pubsub topic to subscribe to. Argument may be repeated.", - defaultValue: @[LitePubsubTopic], - name: "pubsub-topic" - .}: seq[PubsubTopic] + shard* {.desc: "Shards index to subscribe to. ", defaultValue: 0, name: "shard".}: + uint16 - ## TODO: extend lite protocol tester configuration based on testing needs - # shards* {. - # desc: "Shards index to subscribe to [0..NUM_SHARDS_IN_NETWORK-1]. Argument may be repeated.", - # defaultValue: @[], - # name: "shard" - # .}: seq[uint16] contentTopics* {. desc: "Default content topic to subscribe to. Argument may be repeated.", defaultValue: @[LiteContentTopic], @@ -195,4 +187,7 @@ proc load*(T: type LiteProtocolTesterConf, version = ""): ConfResult[T] = except CatchableError: err(getCurrentExceptionMsg()) +proc getPubsubTopic*(conf: LiteProtocolTesterConf): PubsubTopic = + return $RelayShard(clusterId: conf.clusterId, shardId: conf.shard) + {.pop.} diff --git a/examples/cbindings/README.md b/examples/cbindings/README.md new file mode 100644 index 000000000..5465cf512 --- /dev/null +++ b/examples/cbindings/README.md @@ -0,0 +1,18 @@ +## App description +This is a very simple example that shows how to invoke libwaku functions from a C program. + +## Build +1. Open terminal +2. cd to nwaku root folder +3. make cwaku_example -j8 + +This will create libwaku.so and cwaku_example binary within the build folder. + +## Run +1. Open terminal +2. cd to nwaku root folder +3. export LD_LIBRARY_PATH=build +4. `./build/cwaku_example --host=0.0.0.0 --port=60001` + +Use `./build/cwaku_example --help` to see some other options. + diff --git a/examples/cbindings/waku_example.c b/examples/cbindings/waku_example.c index bbb76c862..b80b9af8f 100644 --- a/examples/cbindings/waku_example.c +++ b/examples/cbindings/waku_example.c @@ -14,7 +14,6 @@ #include "base64.h" #include "../../library/libwaku.h" - // Shared synchronization variables pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER; pthread_cond_t cond = PTHREAD_COND_INITIALIZER; @@ -29,7 +28,6 @@ void waitForCallback() { pthread_mutex_unlock(&mutex); } - #define WAKU_CALL(call) \ do { \ int ret = call; \ @@ -107,6 +105,13 @@ static error_t parse_opt(int key, char *arg, struct argp_state *state) { return 0; } +void signal_cond() { + pthread_mutex_lock(&mutex); + callback_executed = 1; + pthread_cond_signal(&cond); + pthread_mutex_unlock(&mutex); +} + static struct argp argp = { options, parse_opt, args_doc, doc, 0, 0, 0 }; void event_handler(int callerRet, const char* msg, size_t len, void* userData) { @@ -118,10 +123,7 @@ void event_handler(int callerRet, const char* msg, size_t len, void* userData) { printf("Receiving event: %s\n", msg); } - pthread_mutex_lock(&mutex); - callback_executed = 1; - pthread_cond_signal(&cond); - pthread_mutex_unlock(&mutex); + signal_cond(); } void on_event_received(int callerRet, const char* msg, size_t len, void* userData) { @@ -142,6 +144,7 @@ void handle_content_topic(int callerRet, const char* msg, size_t len, void* user contentTopic = malloc(len * sizeof(char) + 1); strcpy(contentTopic, msg); + signal_cond(); } char* publishResponse = NULL; @@ -158,33 +161,30 @@ void handle_publish_ok(int callerRet, const char* msg, size_t len, void* userDat #define MAX_MSG_SIZE 65535 -void publish_message(char* pubsubTopic, const char* msg) { +void publish_message(const char* msg) { char jsonWakuMsg[MAX_MSG_SIZE]; char *msgPayload = b64_encode(msg, strlen(msg)); - WAKU_CALL( waku_content_topic(RET_OK, + WAKU_CALL( waku_content_topic(ctx, "appName", 1, "contentTopicName", "encoding", handle_content_topic, userData) ); - snprintf(jsonWakuMsg, MAX_MSG_SIZE, - "{\"payload\":\"%s\",\"content_topic\":\"%s\"}", + "{\"payload\":\"%s\",\"contentTopic\":\"%s\"}", msgPayload, contentTopic); free(msgPayload); - WAKU_CALL( waku_relay_publish(&ctx, - pubsubTopic, + WAKU_CALL( waku_relay_publish(ctx, + "/waku/2/rs/16/32", jsonWakuMsg, 10000 /*timeout ms*/, event_handler, userData) ); - - printf("waku relay response [%s]\n", publishResponse); } void show_help_and_exit() { @@ -194,20 +194,12 @@ void show_help_and_exit() { void print_default_pubsub_topic(int callerRet, const char* msg, size_t len, void* userData) { printf("Default pubsub topic: %s\n", msg); - - pthread_mutex_lock(&mutex); - callback_executed = 1; - pthread_cond_signal(&cond); - pthread_mutex_unlock(&mutex); + signal_cond(); } void print_waku_version(int callerRet, const char* msg, size_t len, void* userData) { printf("Git Version: %s\n", msg); - - pthread_mutex_lock(&mutex); - callback_executed = 1; - pthread_cond_signal(&cond); - pthread_mutex_unlock(&mutex); + signal_cond(); } // Beginning of UI program logic @@ -236,9 +228,6 @@ void handle_user_input() { return; } - int c; - while ( (c = getchar()) != '\n' && c != EOF ) { } - switch (atoi(cmd)) { case SUBSCRIBE_TOPIC_MENU: @@ -247,7 +236,7 @@ void handle_user_input() { char pubsubTopic[128]; scanf("%127s", pubsubTopic); - WAKU_CALL( waku_relay_subscribe(&ctx, + WAKU_CALL( waku_relay_subscribe(ctx, pubsubTopic, event_handler, userData) ); @@ -262,21 +251,17 @@ void handle_user_input() { printf("e.g.: /ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\n"); char peerAddr[512]; scanf("%511s", peerAddr); - WAKU_CALL(waku_connect(&ctx, peerAddr, 10000 /* timeoutMs */, event_handler, userData)); + WAKU_CALL(waku_connect(ctx, peerAddr, 10000 /* timeoutMs */, event_handler, userData)); show_main_menu(); break; case PUBLISH_MESSAGE_MENU: { - printf("Indicate the Pubsubtopic:\n"); - char pubsubTopic[128]; - scanf("%127s", pubsubTopic); - - printf("Type the message tp publish:\n"); + printf("Type the message to publish:\n"); char msg[1024]; scanf("%1023s", msg); - publish_message(pubsubTopic, msg); + publish_message(msg); show_main_menu(); } @@ -311,24 +296,24 @@ int main(int argc, char** argv) { char jsonConfig[5000]; snprintf(jsonConfig, 5000, "{ \ + \"clusterId\": 16, \ + \"shards\": [ 1, 32, 64, 128, 256 ], \ \"listenAddress\": \"%s\", \ \"tcpPort\": %d, \ - \"nodekey\": \"%s\", \ \"relay\": %s, \ \"store\": %s, \ \"storeMessageDbUrl\": \"%s\", \ \"storeMessageRetentionPolicy\": \"%s\", \ \"storeMaxNumDbConnections\": %d , \ - \"logLevel\": \"DEBUG\", \ + \"logLevel\": \"FATAL\", \ \"discv5Discovery\": true, \ \"discv5BootstrapNodes\": \ [\"enr:-QESuEB4Dchgjn7gfAvwB00CxTA-nGiyk-aALI-H4dYSZD3rUk7bZHmP8d2U6xDiQ2vZffpo45Jp7zKNdnwDUx6g4o6XAYJpZIJ2NIJpcIRA4VDAim11bHRpYWRkcnO4XAArNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwAtNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQOvD3S3jUNICsrOILlmhENiWAMmMVlAl6-Q8wRB7hidY4N0Y3CCdl-DdWRwgiMohXdha3UyDw\", \"enr:-QEkuEBIkb8q8_mrorHndoXH9t5N6ZfD-jehQCrYeoJDPHqT0l0wyaONa2-piRQsi3oVKAzDShDVeoQhy0uwN1xbZfPZAYJpZIJ2NIJpcIQiQlleim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQKnGt-GSgqPSf3IAPM7bFgTlpczpMZZLF3geeoNNsxzSoN0Y3CCdl-DdWRwgiMohXdha3UyDw\"], \ \"discv5UdpPort\": 9999, \ - \"dnsDiscoveryUrl\": \"enrtree://AOGYWMBYOUIMOENHXCHILPKY3ZRFEULMFI4DOM442QSZ73TT2A7VI@test.waku.nodes.status.im\", \ + \"dnsDiscoveryUrl\": \"enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.prod.status.nodes.status.im\", \ \"dnsDiscoveryNameServers\": [\"8.8.8.8\", \"1.0.0.1\"] \ }", cfgNode.host, cfgNode.port, - cfgNode.key, cfgNode.relay ? "true":"false", cfgNode.store ? "true":"false", cfgNode.storeDbUrl, @@ -351,14 +336,6 @@ int main(int argc, char** argv) { WAKU_CALL( waku_listen_addresses(ctx, event_handler, userData) ); - printf("Establishing connection with: %s\n", cfgNode.peers); - - WAKU_CALL( waku_connect(ctx, - cfgNode.peers, - 10000 /* timeoutMs */, - event_handler, - userData) ); - WAKU_CALL( waku_relay_subscribe(ctx, "/waku/2/rs/0/0", event_handler, diff --git a/examples/cpp/README.md b/examples/cpp/README.md new file mode 100644 index 000000000..fa8d246e0 --- /dev/null +++ b/examples/cpp/README.md @@ -0,0 +1,18 @@ +## App description +This is a very simple example that shows how to invoke libwaku functions from a C++ program. + +## Build +1. Open terminal +2. cd to nwaku root folder +3. make cppwaku_example -j8 + +This will create libwaku.so and cppwaku_example binary within the build folder. + +## Run +1. Open terminal +2. cd to nwaku root folder +3. export LD_LIBRARY_PATH=build +4. `./build/cppwaku_example --host=0.0.0.0 --port=60001` + +Use `./build/cppwaku_example --help` to see some other options. + diff --git a/examples/cpp/waku.cpp b/examples/cpp/waku.cpp index 4b601c492..c47877d02 100644 --- a/examples/cpp/waku.cpp +++ b/examples/cpp/waku.cpp @@ -16,12 +16,34 @@ #include "base64.h" #include "../../library/libwaku.h" +// Shared synchronization variables +pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER; +pthread_cond_t cond = PTHREAD_COND_INITIALIZER; +int callback_executed = 0; + +void waitForCallback() { + pthread_mutex_lock(&mutex); + while (!callback_executed) { + pthread_cond_wait(&cond, &mutex); + } + callback_executed = 0; + pthread_mutex_unlock(&mutex); +} + +void signal_cond() { + pthread_mutex_lock(&mutex); + callback_executed = 1; + pthread_cond_signal(&cond); + pthread_mutex_unlock(&mutex); +} + #define WAKU_CALL(call) \ do { \ int ret = call; \ if (ret != 0) { \ std::cout << "Failed the call to: " << #call << ". Code: " << ret << "\n"; \ } \ + waitForCallback(); \ } while (0) struct ConfigNode { @@ -78,6 +100,24 @@ static error_t parse_opt(int key, char *arg, struct argp_state *state) { return 0; } +void event_handler(const char* msg, size_t len) { + printf("Receiving event: %s\n", msg); +} + +void handle_error(const char* msg, size_t len) { + printf("handle_error: %s\n", msg); + exit(1); +} + +template +auto cify(F&& f) { + static F fn = std::forward(f); + return [](int callerRet, const char* msg, size_t len, void* userData) { + signal_cond(); + return fn(msg, len); + }; +} + static struct argp argp = { options, parse_opt, args_doc, doc, 0, 0, 0 }; // Beginning of UI program logic @@ -98,7 +138,7 @@ void show_main_menu() { printf("\t3.) Publish a message\n"); } -void handle_user_input() { +void handle_user_input(void* ctx) { char cmd[1024]; memset(cmd, 0, 1024); int numRead = read(0, cmd, 1024); @@ -106,9 +146,6 @@ void handle_user_input() { return; } - int c; - while ( (c = getchar()) != '\n' && c != EOF ) { } - switch (atoi(cmd)) { case SUBSCRIBE_TOPIC_MENU: @@ -116,10 +153,14 @@ void handle_user_input() { printf("Indicate the Pubsubtopic to subscribe:\n"); char pubsubTopic[128]; scanf("%127s", pubsubTopic); - // if (!waku_relay_subscribe(pubsubTopic, &mResp)) { - // printf("Error subscribing to PubsubTopic: %s\n", mResp->data); - // } - // printf("Waku Relay subscription response: %s\n", mResp->data); + + WAKU_CALL( waku_relay_subscribe(ctx, + pubsubTopic, + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr) ); + printf("The subscription went well\n"); show_main_menu(); } @@ -130,41 +171,51 @@ void handle_user_input() { printf("e.g.: /ip4/127.0.0.1/tcp/60001/p2p/16Uiu2HAmVFXtAfSj4EiR7mL2KvL4EE2wztuQgUSBoj2Jx2KeXFLN\n"); char peerAddr[512]; scanf("%511s", peerAddr); - // if (!waku_connect(peerAddr, 10000 /* timeoutMs */, &mResp)) { - // printf("Couldn't connect to the remote peer: %s\n", mResp->data); - // } + WAKU_CALL( waku_connect(ctx, + peerAddr, + 10000 /* timeoutMs */, + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr)); show_main_menu(); break; case PUBLISH_MESSAGE_MENU: { - printf("Indicate the Pubsubtopic:\n"); - char pubsubTopic[128]; - scanf("%127s", pubsubTopic); - - printf("Type the message tp publish:\n"); + printf("Type the message to publish:\n"); char msg[1024]; scanf("%1023s", msg); - char jsonWakuMsg[1024]; + char jsonWakuMsg[2048]; std::vector msgPayload; b64_encode(msg, strlen(msg), msgPayload); - // waku_content_topic("appName", - // 1, - // "contentTopicName", - // "encoding", - // &mResp); + std::string contentTopic; + waku_content_topic(ctx, + "appName", + 1, + "contentTopicName", + "encoding", + cify([&contentTopic](const char* msg, size_t len) { + contentTopic = msg; + }), + nullptr); - // snprintf(jsonWakuMsg, - // 1024, - // "{\"payload\":\"%s\",\"content_topic\":\"%s\"}", - // msgPayload, mResp->data); + snprintf(jsonWakuMsg, + 2048, + "{\"payload\":\"%s\",\"contentTopic\":\"%s\"}", + msgPayload.data(), contentTopic.c_str()); - // free(msgPayload); + WAKU_CALL( waku_relay_publish(ctx, + "/waku/2/rs/16/32", + jsonWakuMsg, + 10000 /*timeout ms*/, + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr) ); - // waku_relay_publish(pubsubTopic, jsonWakuMsg, 10000 /*timeout ms*/, &mResp); - // printf("waku relay response [%s]\n", mResp->data); show_main_menu(); } break; @@ -181,23 +232,6 @@ void show_help_and_exit() { exit(1); } -void event_handler(const char* msg, size_t len) { - printf("Receiving message %s\n", msg); -} - -void handle_error(const char* msg, size_t len) { - printf("Error: %s\n", msg); - exit(1); -} - -template -auto cify(F&& f) { - static F fn = std::forward(f); - return [](const char* msg, size_t len) { - return fn(msg, len); - }; -} - int main(int argc, char** argv) { struct ConfigNode cfgNode; // default values @@ -212,60 +246,86 @@ int main(int argc, char** argv) { show_help_and_exit(); } - char jsonConfig[1024]; - snprintf(jsonConfig, 1024, "{ \ + char jsonConfig[2048]; + snprintf(jsonConfig, 2048, "{ \ \"host\": \"%s\", \ \"port\": %d, \ - \"key\": \"%s\", \ - \"relay\": %s, \ - \"logLevel\": \"DEBUG\" \ + \"relay\": true, \ + \"clusterId\": 16, \ + \"shards\": [ 1, 32, 64, 128, 256 ], \ + \"logLevel\": \"FATAL\", \ + \"discv5Discovery\": true, \ + \"discv5BootstrapNodes\": \ + [\"enr:-QESuEB4Dchgjn7gfAvwB00CxTA-nGiyk-aALI-H4dYSZD3rUk7bZHmP8d2U6xDiQ2vZffpo45Jp7zKNdnwDUx6g4o6XAYJpZIJ2NIJpcIRA4VDAim11bHRpYWRkcnO4XAArNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwAtNiZub2RlLTAxLmRvLWFtczMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQOvD3S3jUNICsrOILlmhENiWAMmMVlAl6-Q8wRB7hidY4N0Y3CCdl-DdWRwgiMohXdha3UyDw\", \"enr:-QEkuEBIkb8q8_mrorHndoXH9t5N6ZfD-jehQCrYeoJDPHqT0l0wyaONa2-piRQsi3oVKAzDShDVeoQhy0uwN1xbZfPZAYJpZIJ2NIJpcIQiQlleim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmdjLXVzLWNlbnRyYWwxLWEud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQKnGt-GSgqPSf3IAPM7bFgTlpczpMZZLF3geeoNNsxzSoN0Y3CCdl-DdWRwgiMohXdha3UyDw\"], \ + \"discv5UdpPort\": 9999, \ + \"dnsDiscoveryUrl\": \"enrtree://AMOJVZX4V6EXP7NTJPMAYJYST2QP6AJXYW76IU6VGJS7UVSNDYZG4@boot.prod.status.nodes.status.im\", \ + \"dnsDiscoveryNameServers\": [\"8.8.8.8\", \"1.0.0.1\"] \ }", cfgNode.host, - cfgNode.port, - cfgNode.key, - cfgNode.relay ? "true":"false"); + cfgNode.port); - WAKU_CALL(waku_new(jsonConfig, cify([](const char* msg, size_t len) { - std::cout << "Error: " << msg << std::endl; - exit(1); - }))); + void* ctx = + waku_new(jsonConfig, + cify([](const char* msg, size_t len) { + std::cout << "waku_new feedback: " << msg << std::endl; + } + ), + nullptr + ); + waitForCallback(); // example on how to retrieve a value from the `libwaku` callback. std::string defaultPubsubTopic; - WAKU_CALL(waku_default_pubsub_topic(cify([&defaultPubsubTopic](const char* msg, size_t len) { - defaultPubsubTopic = msg; - }))); + WAKU_CALL( + waku_default_pubsub_topic( + ctx, + cify([&defaultPubsubTopic](const char* msg, size_t len) { + defaultPubsubTopic = msg; + } + ), + nullptr)); std::cout << "Default pubsub topic: " << defaultPubsubTopic << std::endl; - WAKU_CALL(waku_version(cify([&](const char* msg, size_t len) { - std::cout << "Git Version: " << msg << std::endl; - }))); + WAKU_CALL(waku_version(ctx, + cify([&](const char* msg, size_t len) { + std::cout << "Git Version: " << msg << std::endl; + }), + nullptr)); printf("Bind addr: %s:%u\n", cfgNode.host, cfgNode.port); printf("Waku Relay enabled: %s\n", cfgNode.relay == 1 ? "YES": "NO"); std::string pubsubTopic; - WAKU_CALL(waku_pubsub_topic("example", cify([&](const char* msg, size_t len) { - pubsubTopic = msg; - }))); + WAKU_CALL(waku_pubsub_topic(ctx, + "example", + cify([&](const char* msg, size_t len) { + pubsubTopic = msg; + }), + nullptr)); std::cout << "Custom pubsub topic: " << pubsubTopic << std::endl; - waku_set_event_callback(event_handler); - waku_start(); + waku_set_event_callback(ctx, + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr); - WAKU_CALL( waku_connect(cfgNode.peers, - 10000 /* timeoutMs */, - handle_error) ); + WAKU_CALL( waku_start(ctx, + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr)); - WAKU_CALL( waku_relay_subscribe(defaultPubsubTopic.c_str(), - handle_error) ); - - std::cout << "Establishing connection with: " << cfgNode.peers << std::endl; - WAKU_CALL(waku_connect(cfgNode.peers, 10000 /* timeoutMs */, handle_error)); + WAKU_CALL( waku_relay_subscribe(ctx, + defaultPubsubTopic.c_str(), + cify([&](const char* msg, size_t len) { + event_handler(msg, len); + }), + nullptr) ); show_main_menu(); while(1) { - handle_user_input(); + handle_user_input(ctx); } } diff --git a/library/events/json_connection_change_event.nim b/library/events/json_connection_change_event.nim index 1a00237b6..ff2823640 100644 --- a/library/events/json_connection_change_event.nim +++ b/library/events/json_connection_change_event.nim @@ -9,9 +9,6 @@ type JsonConnectionChangeEvent* = ref object of JsonEvent proc new*( T: type JsonConnectionChangeEvent, peerId: string, peerEvent: PeerEventKind ): T = - # Returns a JsonConnectionChangeEvent event as indicated in - # https://rfc.vac.dev/spec/36/#jsonmessageevent-type - return JsonConnectionChangeEvent( eventType: "connection_change", peerId: peerId, peerEvent: peerEvent ) diff --git a/library/events/json_message_event.nim b/library/events/json_message_event.nim index 6f9dafa9f..f79fef86f 100644 --- a/library/events/json_message_event.nim +++ b/library/events/json_message_event.nim @@ -71,7 +71,7 @@ type JsonMessageEvent* = ref object of JsonEvent proc new*(T: type JsonMessageEvent, pubSubTopic: string, msg: WakuMessage): T = # Returns a WakuMessage event as indicated in - # https://rfc.vac.dev/spec/36/#jsonmessageevent-type + # https://github.com/vacp2p/rfc/blob/master/content/docs/rfcs/36/README.md#jsonmessageevent-type var payload = newSeq[byte](len(msg.payload)) if len(msg.payload) != 0: diff --git a/library/events/json_topic_health_change_event.nim b/library/events/json_topic_health_change_event.nim index c735eccbf..c194e890c 100644 --- a/library/events/json_topic_health_change_event.nim +++ b/library/events/json_topic_health_change_event.nim @@ -10,9 +10,6 @@ type JsonTopicHealthChangeEvent* = ref object of JsonEvent proc new*( T: type JsonTopicHealthChangeEvent, pubsubTopic: string, topicHealth: TopicHealth ): T = - # Returns a TopicHealthChange event as indicated in - # https://rfc.vac.dev/spec/36/#jsonmessageevent-type - return JsonTopicHealthChangeEvent( eventType: "relay_topic_health_change", pubsubTopic: pubsubTopic, diff --git a/library/libwaku.nim b/library/libwaku.nim index 23600aca4..48df3e2c6 100644 --- a/library/libwaku.nim +++ b/library/libwaku.nim @@ -42,7 +42,8 @@ import template checkLibwakuParams*( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ) = - ctx[].userData = userData + if not isNil(ctx): + ctx[].userData = userData if isNil(callback): return RET_MISSING_CALLBACK @@ -224,19 +225,11 @@ proc waku_content_topic( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let appStr = appName.alloc() - let ctnStr = contentTopicName.alloc() - let encodingStr = encoding.alloc() - - let contentTopic = fmt"/{$appStr}/{appVersion}/{$ctnStr}/{$encodingStr}" + let contentTopic = fmt"/{$appName}/{$appVersion}/{$contentTopicName}/{$encoding}" callback( RET_OK, unsafeAddr contentTopic[0], cast[csize_t](len(contentTopic)), userData ) - deallocShared(appStr) - deallocShared(ctnStr) - deallocShared(encodingStr) - return RET_OK proc waku_pubsub_topic( @@ -247,15 +240,11 @@ proc waku_pubsub_topic( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let topicNameStr = topicName.alloc() - - let outPubsubTopic = fmt"/waku/2/{$topicNameStr}" + let outPubsubTopic = fmt"/waku/2/{$topicName}" callback( RET_OK, unsafeAddr outPubsubTopic[0], cast[csize_t](len(outPubsubTopic)), userData ) - deallocShared(topicNameStr) - return RET_OK proc waku_default_pubsub_topic( @@ -288,12 +277,9 @@ proc waku_relay_publish( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let jwm = jsonWakuMessage.alloc() - defer: - deallocShared(jwm) var jsonMessage: JsonMessage try: - let jsonContent = parseJson($jwm) + let jsonContent = parseJson($jsonWakuMessage) jsonMessage = JsonMessage.fromJsonNode(jsonContent).valueOr: raise newException(JsonParsingError, $error) except JsonParsingError: @@ -306,14 +292,10 @@ proc waku_relay_publish( callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.PUBLISH, pst, nil, wakuMessage), + RelayRequest.createShared(RelayMsgType.PUBLISH, pubSubTopic, nil, wakuMessage), callback, userData, ) @@ -353,15 +335,12 @@ proc waku_relay_subscribe( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) var cb = onReceivedMessage(ctx) handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.SUBSCRIBE, pst, WakuRelayHandler(cb)), + RelayRequest.createShared(RelayMsgType.SUBSCRIBE, pubSubTopic, WakuRelayHandler(cb)), callback, userData, ) @@ -376,9 +355,6 @@ proc waku_relay_add_protected_shard( ): cint {.dynlib, exportc, cdecl.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pubk = publicKey.alloc() - defer: - deallocShared(pubk) handleRequest( ctx, @@ -387,7 +363,7 @@ proc waku_relay_add_protected_shard( RelayMsgType.ADD_PROTECTED_SHARD, clusterId = clusterId, shardId = shardId, - publicKey = pubk, + publicKey = publicKey, ), callback, userData, @@ -402,15 +378,11 @@ proc waku_relay_unsubscribe( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared( - RelayMsgType.UNSUBSCRIBE, pst, WakuRelayHandler(onReceivedMessage(ctx)) + RelayMsgType.UNSUBSCRIBE, pubSubTopic, WakuRelayHandler(onReceivedMessage(ctx)) ), callback, userData, @@ -425,14 +397,10 @@ proc waku_relay_get_num_connected_peers( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.NUM_CONNECTED_PEERS, pst), + RelayRequest.createShared(RelayMsgType.NUM_CONNECTED_PEERS, pubSubTopic), callback, userData, ) @@ -446,14 +414,10 @@ proc waku_relay_get_connected_peers( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.LIST_CONNECTED_PEERS, pst), + RelayRequest.createShared(RelayMsgType.LIST_CONNECTED_PEERS, pubSubTopic), callback, userData, ) @@ -467,14 +431,10 @@ proc waku_relay_get_num_peers_in_mesh( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.NUM_MESH_PEERS, pst), + RelayRequest.createShared(RelayMsgType.NUM_MESH_PEERS, pubSubTopic), callback, userData, ) @@ -488,14 +448,10 @@ proc waku_relay_get_peers_in_mesh( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let pst = pubSubTopic.alloc() - defer: - deallocShared(pst) - handleRequest( ctx, RequestType.RELAY, - RelayRequest.createShared(RelayMsgType.LIST_MESH_PEERS, pst), + RelayRequest.createShared(RelayMsgType.LIST_MESH_PEERS, pubSubTopic), callback, userData, ) @@ -565,15 +521,9 @@ proc waku_lightpush_publish( initializeLibrary() checkLibwakuParams(ctx, callback, userData) - let jwm = jsonWakuMessage.alloc() - let pst = pubSubTopic.alloc() - defer: - deallocShared(jwm) - deallocShared(pst) - var jsonMessage: JsonMessage try: - let jsonContent = parseJson($jwm) + let jsonContent = parseJson($jsonWakuMessage) jsonMessage = JsonMessage.fromJsonNode(jsonContent).valueOr: raise newException(JsonParsingError, $error) except JsonParsingError: @@ -589,7 +539,7 @@ proc waku_lightpush_publish( handleRequest( ctx, RequestType.LIGHTPUSH, - LightpushRequest.createShared(LightpushMsgType.PUBLISH, pst, wakuMessage), + LightpushRequest.createShared(LightpushMsgType.PUBLISH, pubSubTopic, wakuMessage), callback, userData, ) diff --git a/library/waku_thread/inter_thread_communication/requests/protocols/store_request.nim b/library/waku_thread/inter_thread_communication/requests/protocols/store_request.nim index aa4071fcf..57786a581 100644 --- a/library/waku_thread/inter_thread_communication/requests/protocols/store_request.nim +++ b/library/waku_thread/inter_thread_communication/requests/protocols/store_request.nim @@ -24,50 +24,49 @@ func fromJsonNode( T: type StoreRequest, jsonContent: JsonNode ): Result[StoreQueryRequest, string] = var contentTopics: seq[string] - if jsonContent.contains("content_topics"): + if jsonContent.contains("contentTopics"): contentTopics = collect(newSeq): - for cTopic in jsonContent["content_topics"].getElems(): + for cTopic in jsonContent["contentTopics"].getElems(): cTopic.getStr() var msgHashes: seq[WakuMessageHash] - if jsonContent.contains("message_hashes"): - for hashJsonObj in jsonContent["message_hashes"].getElems(): + if jsonContent.contains("messageHashes"): + for hashJsonObj in jsonContent["messageHashes"].getElems(): let hash = hashJsonObj.getStr().hexToHash().valueOr: return err("Failed converting message hash hex string to bytes: " & error) msgHashes.add(hash) let pubsubTopic = - if jsonContent.contains("pubsub_topic"): - some(jsonContent["pubsub_topic"].getStr()) + if jsonContent.contains("pubsubTopic"): + some(jsonContent["pubsubTopic"].getStr()) else: none(string) let paginationCursor = - if jsonContent.contains("pagination_cursor"): - let hash = jsonContent["pagination_cursor"].getStr().hexToHash().valueOr: - return - err("Failed converting pagination_cursor hex string to bytes: " & error) + if jsonContent.contains("paginationCursor"): + let hash = jsonContent["paginationCursor"].getStr().hexToHash().valueOr: + return err("Failed converting paginationCursor hex string to bytes: " & error) some(hash) else: none(WakuMessageHash) - let paginationForwardBool = jsonContent["pagination_forward"].getBool() + let paginationForwardBool = jsonContent["paginationForward"].getBool() let paginationForward = if paginationForwardBool: PagingDirection.FORWARD else: PagingDirection.BACKWARD let paginationLimit = - if jsonContent.contains("pagination_limit"): - some(uint64(jsonContent["pagination_limit"].getInt())) + if jsonContent.contains("paginationLimit"): + some(uint64(jsonContent["paginationLimit"].getInt())) else: none(uint64) - let startTime = ?jsonContent.getProtoInt64("time_start") - let endTime = ?jsonContent.getProtoInt64("time_end") + let startTime = ?jsonContent.getProtoInt64("timeStart") + let endTime = ?jsonContent.getProtoInt64("timeEnd") return ok( StoreQueryRequest( - requestId: jsonContent["request_id"].getStr(), - includeData: jsonContent["include_data"].getBool(), + requestId: jsonContent["requestId"].getStr(), + includeData: jsonContent["includeData"].getBool(), pubsubTopic: pubsubTopic, contentTopics: contentTopics, startTime: startTime, diff --git a/metrics/waku-fleet-dashboard.json b/metrics/waku-fleet-dashboard.json index ad9ef040a..1d8be0b1b 100644 --- a/metrics/waku-fleet-dashboard.json +++ b/metrics/waku-fleet-dashboard.json @@ -55,7 +55,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -139,7 +140,8 @@ "mode": "absolute", "steps": [ { - "color": "blue" + "color": "blue", + "value": null } ] }, @@ -209,7 +211,8 @@ "mode": "percentage", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -292,7 +295,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -310,7 +314,7 @@ "properties": [ { "id": "custom.width", - "value": 122 + "value": 166 } ] }, @@ -430,7 +434,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -445,7 +450,7 @@ "h": 9, "w": 12, "x": 0, - "y": 145 + "y": 1074 }, "id": 81, "options": { @@ -526,7 +531,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -541,7 +547,7 @@ "h": 9, "w": 12, "x": 12, - "y": 145 + "y": 1074 }, "id": 82, "options": { @@ -624,7 +630,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -640,7 +647,7 @@ "h": 9, "w": 12, "x": 0, - "y": 154 + "y": 1083 }, "id": 78, "interval": "15s", @@ -727,7 +734,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -743,7 +751,7 @@ "h": 9, "w": 12, "x": 12, - "y": 154 + "y": 1083 }, "id": 79, "options": { @@ -827,7 +835,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -843,7 +852,7 @@ "h": 10, "w": 12, "x": 0, - "y": 192 + "y": 1092 }, "id": 124, "options": { @@ -931,7 +940,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -947,7 +957,7 @@ "h": 10, "w": 12, "x": 12, - "y": 192 + "y": 1092 }, "id": 126, "options": { @@ -982,6 +992,204 @@ "title": "Relay traffic per shard (out) - average of all peers", "type": "timeseries" }, + { + "datasource": { + "type": "prometheus", + "uid": "P6693426190CB2316" + }, + "description": "", + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + }, + "unit": "none" + }, + "overrides": [] + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 0, + "y": 1102 + }, + "id": 169, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true, + "sortBy": "Mean", + "sortDesc": true + }, + "tooltip": { + "hideZeros": false, + "mode": "multi", + "sort": "none" + } + }, + "pluginVersion": "11.5.2", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "PBFA97CFB590B2093" + }, + "editorMode": "code", + "exemplar": false, + "expr": "avg by (protocol)(waku_connected_peers{direction=\"In\", instance=~\"[[host]].([[dc:pipe]]).([[fleet:pipe]])\"})", + "instant": false, + "legendFormat": "{{protocol}}", + "range": true, + "refId": "A" + } + ], + "title": "# peers per protocol (in)", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "P6693426190CB2316" + }, + "description": "", + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + }, + "unit": "none" + }, + "overrides": [] + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 12, + "y": 1102 + }, + "id": 170, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true, + "sortBy": "Mean", + "sortDesc": true + }, + "tooltip": { + "hideZeros": false, + "mode": "multi", + "sort": "none" + } + }, + "pluginVersion": "11.5.2", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "PBFA97CFB590B2093" + }, + "editorMode": "code", + "exemplar": false, + "expr": "avg by (protocol)(waku_connected_peers{direction=\"Out\", instance=~\"[[host]].([[dc:pipe]]).([[fleet:pipe]])\"})", + "instant": false, + "legendFormat": "{{protocol}}", + "range": true, + "refId": "A" + } + ], + "title": "# peers per protocol (out)", + "type": "timeseries" + }, { "datasource": { "type": "prometheus", @@ -1032,7 +1240,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1048,7 +1257,7 @@ "h": 9, "w": 12, "x": 0, - "y": 202 + "y": 1112 }, "id": 11, "options": { @@ -1131,7 +1340,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1146,7 +1356,7 @@ "h": 9, "w": 12, "x": 12, - "y": 202 + "y": 1112 }, "id": 54, "options": { @@ -1229,7 +1439,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1244,7 +1455,7 @@ "h": 8, "w": 12, "x": 0, - "y": 211 + "y": 1121 }, "id": 66, "options": { @@ -1325,7 +1536,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1340,7 +1552,7 @@ "h": 9, "w": 12, "x": 12, - "y": 211 + "y": 1121 }, "id": 122, "options": { @@ -1454,7 +1666,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1463,38 +1676,13 @@ ] } }, - "overrides": [ - { - "__systemRef": "hideSeriesFrom", - "matcher": { - "id": "byNames", - "options": { - "mode": "exclude", - "names": [ - "store-02.ac-cn-hongkong-c.status.staging:v0.34.0-rc.1" - ], - "prefix": "All except:", - "readOnly": true - } - }, - "properties": [ - { - "id": "custom.hideFrom", - "value": { - "legend": false, - "tooltip": false, - "viz": true - } - } - ] - } - ] + "overrides": [] }, "gridPos": { "h": 8, "w": 12, "x": 12, - "y": 220 + "y": 1130 }, "id": 68, "options": { @@ -1592,7 +1780,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1607,7 +1796,7 @@ "h": 6, "w": 12, "x": 0, - "y": 396 + "y": 2 }, "id": 48, "options": { @@ -1688,7 +1877,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1703,7 +1893,7 @@ "h": 6, "w": 12, "x": 12, - "y": 396 + "y": 2 }, "id": 50, "options": { @@ -1784,7 +1974,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1799,7 +1990,7 @@ "h": 6, "w": 12, "x": 0, - "y": 402 + "y": 670 }, "id": 60, "options": { @@ -1905,7 +2096,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -1920,7 +2112,7 @@ "h": 6, "w": 12, "x": 12, - "y": 402 + "y": 670 }, "id": 8, "options": { @@ -2004,7 +2196,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -2019,7 +2212,7 @@ "h": 6, "w": 12, "x": 0, - "y": 408 + "y": 676 }, "id": 2, "options": { @@ -2106,7 +2299,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -2122,7 +2316,7 @@ "h": 6, "w": 12, "x": 12, - "y": 408 + "y": 676 }, "id": 83, "options": { @@ -2205,7 +2399,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -2220,7 +2415,7 @@ "h": 6, "w": 12, "x": 0, - "y": 414 + "y": 682 }, "id": 3, "options": { @@ -2304,7 +2499,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -2319,7 +2515,7 @@ "h": 6, "w": 12, "x": 12, - "y": 414 + "y": 682 }, "id": 9, "options": { @@ -2444,7 +2640,7 @@ "h": 6, "w": 12, "x": 0, - "y": 420 + "y": 688 }, "id": 6, "options": { @@ -2541,7 +2737,7 @@ "h": 6, "w": 12, "x": 12, - "y": 420 + "y": 688 }, "id": 7, "options": { @@ -2666,7 +2862,7 @@ "h": 8, "w": 12, "x": 0, - "y": 426 + "y": 694 }, "id": 44, "options": { @@ -2788,7 +2984,7 @@ "h": 6, "w": 12, "x": 12, - "y": 426 + "y": 694 }, "id": 10, "options": { @@ -2881,38 +3077,13 @@ }, "unit": "decbytes" }, - "overrides": [ - { - "__systemRef": "hideSeriesFrom", - "matcher": { - "id": "byNames", - "options": { - "mode": "exclude", - "names": [ - "boot-01.ac-cn-hongkong-c.status.staging seq[byte]" - ], - "prefix": "All except:", - "readOnly": true - } - }, - "properties": [ - { - "id": "custom.hideFrom", - "value": { - "legend": false, - "tooltip": false, - "viz": true - } - } - ] - } - ] + "overrides": [] }, "gridPos": { "h": 8, "w": 12, "x": 12, - "y": 432 + "y": 700 }, "id": 64, "options": { @@ -3014,7 +3185,7 @@ "h": 6, "w": 12, "x": 0, - "y": 434 + "y": 702 }, "id": 4, "options": { @@ -3111,7 +3282,7 @@ "h": 6, "w": 12, "x": 12, - "y": 440 + "y": 708 }, "id": 5, "options": { @@ -3207,7 +3378,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3222,7 +3394,7 @@ "h": 8, "w": 8, "x": 0, - "y": 447 + "y": 3 }, "id": 159, "options": { @@ -3246,7 +3418,7 @@ "uid": "P6693426190CB2316" }, "editorMode": "code", - "expr": "waku_rln_proofs_generated_total{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"}", + "expr": "waku_rln_total_generated_proofs", "legendFormat": "{{instance}}", "range": true, "refId": "A" @@ -3303,7 +3475,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3318,7 +3491,7 @@ "h": 8, "w": 8, "x": 8, - "y": 447 + "y": 3 }, "id": 117, "options": { @@ -3400,7 +3573,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3415,7 +3589,7 @@ "h": 8, "w": 8, "x": 16, - "y": 447 + "y": 3 }, "id": 160, "options": { @@ -3439,7 +3613,7 @@ "uid": "P6693426190CB2316" }, "editorMode": "code", - "expr": "waku_rln_proofs_remaining{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"}", + "expr": "waku_rln_remaining_proofs_per_epoch", "legendFormat": "{{instance}}", "range": true, "refId": "A" @@ -3496,7 +3670,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3512,7 +3687,7 @@ "h": 8, "w": 12, "x": 0, - "y": 455 + "y": 27 }, "id": 119, "options": { @@ -3593,7 +3768,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3608,7 +3784,7 @@ "h": 8, "w": 12, "x": 12, - "y": 455 + "y": 27 }, "id": 121, "options": { @@ -3689,7 +3865,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3704,7 +3881,7 @@ "h": 8, "w": 8, "x": 0, - "y": 463 + "y": 35 }, "id": 113, "options": { @@ -3786,7 +3963,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3801,7 +3979,7 @@ "h": 8, "w": 8, "x": 8, - "y": 463 + "y": 35 }, "id": 115, "options": { @@ -3908,7 +4086,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -3923,7 +4102,7 @@ "h": 6, "w": 12, "x": 0, - "y": 472 + "y": 355 }, "id": 36, "options": { @@ -4004,7 +4183,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -4019,7 +4199,7 @@ "h": 6, "w": 12, "x": 12, - "y": 472 + "y": 355 }, "id": 38, "options": { @@ -4115,7 +4295,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -4130,7 +4311,7 @@ "h": 6, "w": 12, "x": 0, - "y": 478 + "y": 361 }, "id": 62, "options": { @@ -4213,7 +4394,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null }, { "color": "red", @@ -4228,7 +4410,7 @@ "h": 6, "w": 12, "x": 12, - "y": 478 + "y": 361 }, "id": 40, "options": { @@ -4329,7 +4511,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null } ] }, @@ -4341,7 +4524,7 @@ "h": 11, "w": 12, "x": 0, - "y": 484 + "y": 367 }, "id": 144, "options": { @@ -4433,7 +4616,8 @@ "mode": "absolute", "steps": [ { - "color": "green" + "color": "green", + "value": null } ] }, @@ -4445,7 +4629,7 @@ "h": 11, "w": 12, "x": 12, - "y": 484 + "y": 367 }, "id": 145, "options": { @@ -4550,7 +4734,7 @@ "h": 8, "w": 12, "x": 0, - "y": 495 + "y": 378 }, "id": 146, "options": { @@ -4654,7 +4838,7 @@ "h": 8, "w": 12, "x": 12, - "y": 495 + "y": 378 }, "id": 148, "options": { @@ -4758,7 +4942,7 @@ "h": 8, "w": 12, "x": 0, - "y": 503 + "y": 386 }, "id": 158, "options": { @@ -4861,7 +5045,7 @@ "h": 8, "w": 12, "x": 12, - "y": 503 + "y": 386 }, "id": 157, "options": { @@ -4963,7 +5147,7 @@ "h": 8, "w": 12, "x": 0, - "y": 511 + "y": 394 }, "id": 149, "options": { @@ -5086,7 +5270,7 @@ "h": 8, "w": 12, "x": 12, - "y": 511 + "y": 394 }, "id": 147, "options": { @@ -5148,7 +5332,7 @@ "h": 7, "w": 12, "x": 0, - "y": 519 + "y": 402 }, "id": 77, "maxDataPoints": 60, @@ -5247,7 +5431,7 @@ "h": 7, "w": 12, "x": 12, - "y": 519 + "y": 402 }, "id": 75, "maxDataPoints": 60, @@ -5409,7 +5593,7 @@ "h": 13, "w": 12, "x": 0, - "y": 526 + "y": 409 }, "id": 142, "options": { @@ -5510,7 +5694,7 @@ "h": 13, "w": 12, "x": 12, - "y": 526 + "y": 409 }, "id": 130, "options": { @@ -5558,11 +5742,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -5571,6 +5757,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -5608,7 +5795,7 @@ "h": 13, "w": 12, "x": 0, - "y": 539 + "y": 422 }, "id": 132, "options": { @@ -5624,10 +5811,12 @@ "sortDesc": false }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -5656,11 +5845,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -5669,6 +5860,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -5706,7 +5898,7 @@ "h": 13, "w": 12, "x": 12, - "y": 539 + "y": 422 }, "id": 143, "options": { @@ -5722,10 +5914,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -5754,11 +5948,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -5767,6 +5963,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -5804,7 +6001,7 @@ "h": 13, "w": 12, "x": 0, - "y": 552 + "y": 435 }, "id": 128, "options": { @@ -5820,10 +6017,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -5852,11 +6051,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -5865,6 +6066,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -5902,7 +6104,7 @@ "h": 13, "w": 12, "x": 12, - "y": 552 + "y": 435 }, "id": 141, "options": { @@ -5918,10 +6120,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -6006,14 +6210,10 @@ { "color": "green", "value": null - }, - { - "color": "red", - "value": 80 } ] }, - "unit": "binBps" + "unit": "deckbytes" }, "overrides": [] }, @@ -6046,7 +6246,7 @@ }, "disableTextWrap": false, "editorMode": "builder", - "expr": "sum by(direction, protocol) (rate(total_bytes_exchanged_sum[$__rate_interval]))", + "expr": "sum by(direction, protocol) (total_bytes_exchanged_total{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"})", "fullMetaSearch": false, "includeNullMetadata": false, "legendFormat": "__auto", @@ -6055,7 +6255,7 @@ "useBackend": false } ], - "title": "Bytes Exchanged Rate", + "title": "Bytes Exchanged", "type": "timeseries" }, { @@ -6063,7 +6263,7 @@ "type": "prometheus", "uid": "P6693426190CB2316" }, - "description": "the number of messages sent and received by the transfer protocol per second.", + "description": "the number of messages sent and received by the transfer protocol.", "fieldConfig": { "defaults": { "color": { @@ -6109,10 +6309,6 @@ { "color": "green", "value": null - }, - { - "color": "red", - "value": 80 } ] } @@ -6147,8 +6343,8 @@ "uid": "P6693426190CB2316" }, "disableTextWrap": false, - "editorMode": "builder", - "expr": "sum by(direction) (rate(total_transfer_messages_exchanged_total[$__rate_interval]))", + "editorMode": "code", + "expr": "sum by(direction) (total_transfer_messages_exchanged_total{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"})", "fullMetaSearch": false, "includeNullMetadata": true, "legendFormat": "__auto", @@ -6157,7 +6353,7 @@ "useBackend": false } ], - "title": "Messages Exchanged Rate", + "title": "Messages Exchanged", "type": "timeseries" }, { @@ -6225,7 +6421,7 @@ "disableTextWrap": false, "editorMode": "builder", "exemplar": false, - "expr": "sum by(le) (reconciliation_roundtrips_bucket)", + "expr": "sum by(le) (reconciliation_roundtrips_bucket{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"})", "format": "heatmap", "fullMetaSearch": false, "hide": false, @@ -6240,13 +6436,179 @@ "title": "Distribution of Round-Trips per Reconciliation", "type": "bargauge" }, + { + "datasource": { + "type": "prometheus", + "uid": "P6693426190CB2316" + }, + "fieldConfig": { + "defaults": { + "color": { + "mode": "thresholds" + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 13 + }, + "id": 171, + "options": { + "displayMode": "lcd", + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": false + }, + "maxVizHeight": 300, + "minVizHeight": 16, + "minVizWidth": 8, + "namePlacement": "left", + "orientation": "horizontal", + "reduceOptions": { + "calcs": [ + "lastNotNull" + ], + "fields": "", + "values": false + }, + "showUnfilled": true, + "sizing": "auto", + "valueMode": "hidden" + }, + "pluginVersion": "11.5.2", + "targets": [ + { + "disableTextWrap": false, + "editorMode": "builder", + "expr": "sum by(le) (reconciliation_differences_bucket{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"})", + "format": "heatmap", + "fullMetaSearch": false, + "includeNullMetadata": true, + "legendFormat": "__auto", + "range": true, + "refId": "A", + "useBackend": false + } + ], + "title": "Distribution of differences per reconciliation.", + "type": "bargauge" + }, + { + "datasource": { + "type": "prometheus", + "uid": "P6693426190CB2316" + }, + "description": "The total number of messages cached by nodes.", + "fieldConfig": { + "defaults": { + "color": { + "mode": "palette-classic" + }, + "custom": { + "axisBorderShow": false, + "axisCenteredZero": false, + "axisColorMode": "text", + "axisLabel": "", + "axisPlacement": "auto", + "barAlignment": 0, + "barWidthFactor": 0.6, + "drawStyle": "line", + "fillOpacity": 0, + "gradientMode": "none", + "hideFrom": { + "legend": false, + "tooltip": false, + "viz": false + }, + "insertNulls": false, + "lineInterpolation": "linear", + "lineWidth": 1, + "pointSize": 5, + "scaleDistribution": { + "type": "linear" + }, + "showPoints": "auto", + "spanNulls": false, + "stacking": { + "group": "A", + "mode": "none" + }, + "thresholdsStyle": { + "mode": "off" + } + }, + "mappings": [], + "thresholds": { + "mode": "absolute", + "steps": [ + { + "color": "green", + "value": null + } + ] + } + }, + "overrides": [] + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 21 + }, + "id": 172, + "options": { + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "hideZeros": false, + "mode": "single", + "sort": "none" + } + }, + "pluginVersion": "11.5.2", + "targets": [ + { + "disableTextWrap": false, + "editorMode": "code", + "expr": "total_messages_cached_total{instance=~\"[[host]].([[dc:pipe]]).*.([[fleet:pipe]])\"}", + "fullMetaSearch": false, + "includeNullMetadata": true, + "legendFormat": "__auto", + "range": true, + "refId": "A", + "useBackend": false + } + ], + "title": "Messages Cached", + "type": "timeseries" + }, { "collapsed": true, "gridPos": { "h": 1, "w": 24, "x": 0, - "y": 21 + "y": 29 }, "id": 87, "panels": [ @@ -6313,7 +6675,7 @@ "h": 8, "w": 8, "x": 0, - "y": 156 + "y": 2595 }, "id": 93, "options": { @@ -6412,7 +6774,7 @@ "h": 8, "w": 8, "x": 8, - "y": 156 + "y": 2595 }, "id": 89, "options": { @@ -6508,7 +6870,7 @@ "h": 8, "w": 8, "x": 16, - "y": 156 + "y": 2595 }, "id": 91, "options": { @@ -6565,7 +6927,7 @@ "h": 8, "w": 12, "x": 0, - "y": 164 + "y": 2603 }, "id": 95, "options": { @@ -6647,7 +7009,7 @@ "h": 8, "w": 12, "x": 12, - "y": 164 + "y": 2603 }, "id": 97, "options": { @@ -6763,39 +7125,13 @@ }, "unit": "reqps" }, - "overrides": [ - { - "__systemRef": "hideSeriesFrom", - "matcher": { - "id": "byNames", - "options": { - "mode": "exclude", - "names": [ - "boot-01.ac-cn-hongkong-c.status.prod - rejected", - "boot-01.ac-cn-hongkong-c.status.prod - served" - ], - "prefix": "All except:", - "readOnly": true - } - }, - "properties": [ - { - "id": "custom.hideFrom", - "value": { - "legend": false, - "tooltip": false, - "viz": true - } - } - ] - } - ] + "overrides": [] }, "gridPos": { "h": 13, "w": 12, "x": 0, - "y": 172 + "y": 2611 }, "id": 134, "options": { @@ -6898,7 +7234,7 @@ "h": 13, "w": 12, "x": 12, - "y": 172 + "y": 2611 }, "id": 136, "options": { @@ -6944,7 +7280,7 @@ "h": 1, "w": 24, "x": 0, - "y": 22 + "y": 30 }, "id": 28, "panels": [ @@ -7011,7 +7347,7 @@ "h": 8, "w": 12, "x": 0, - "y": 82 + "y": 2670 }, "id": 30, "options": { @@ -7107,7 +7443,7 @@ "h": 8, "w": 12, "x": 12, - "y": 82 + "y": 2670 }, "id": 32, "options": { @@ -7205,7 +7541,7 @@ "h": 12, "w": 12, "x": 0, - "y": 129 + "y": 2678 }, "id": 138, "options": { @@ -7308,7 +7644,7 @@ "h": 12, "w": 12, "x": 12, - "y": 129 + "y": 2678 }, "id": 140, "options": { @@ -7355,7 +7691,7 @@ "h": 1, "w": 24, "x": 0, - "y": 23 + "y": 31 }, "id": 151, "panels": [ @@ -7371,11 +7707,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -7384,6 +7722,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -7421,7 +7760,7 @@ "h": 12, "w": 12, "x": 0, - "y": 760 + "y": 2691 }, "id": 153, "options": { @@ -7437,10 +7776,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -7469,11 +7810,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -7482,6 +7825,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -7519,7 +7863,7 @@ "h": 12, "w": 12, "x": 12, - "y": 760 + "y": 2691 }, "id": 154, "options": { @@ -7535,10 +7879,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -7587,13 +7933,21 @@ "h": 12, "w": 12, "x": 0, - "y": 772 + "y": 2703 }, "id": 156, "options": { "displayMode": "basic", + "legend": { + "calcs": [], + "displayMode": "list", + "placement": "bottom", + "showLegend": false + }, + "maxVizHeight": 300, "minVizHeight": 10, "minVizWidth": 0, + "namePlacement": "auto", "orientation": "horizontal", "reduceOptions": { "calcs": [ @@ -7602,9 +7956,11 @@ "fields": "", "values": false }, - "showUnfilled": true + "showUnfilled": true, + "sizing": "auto", + "valueMode": "color" }, - "pluginVersion": "9.2.5", + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -7633,11 +7989,13 @@ "mode": "palette-classic" }, "custom": { + "axisBorderShow": false, "axisCenteredZero": false, "axisColorMode": "text", "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -7646,6 +8004,7 @@ "tooltip": false, "viz": false }, + "insertNulls": false, "lineInterpolation": "linear", "lineWidth": 1, "pointSize": 5, @@ -7683,7 +8042,7 @@ "h": 12, "w": 12, "x": 12, - "y": 772 + "y": 2703 }, "id": 155, "options": { @@ -7699,10 +8058,12 @@ "sortDesc": true }, "tooltip": { + "hideZeros": false, "mode": "single", "sort": "none" } }, + "pluginVersion": "11.5.2", "targets": [ { "datasource": { @@ -7729,7 +8090,7 @@ "h": 1, "w": 24, "x": 0, - "y": 24 + "y": 32 }, "id": 15, "panels": [ @@ -7797,7 +8158,7 @@ "h": 7, "w": 8, "x": 0, - "y": 84 + "y": 2716 }, "id": 13, "options": { @@ -7895,7 +8256,7 @@ "h": 7, "w": 8, "x": 8, - "y": 84 + "y": 2716 }, "id": 18, "options": { @@ -8071,7 +8432,7 @@ "h": 7, "w": 8, "x": 16, - "y": 84 + "y": 2716 }, "id": 42, "options": { @@ -8164,7 +8525,7 @@ "h": 8, "w": 12, "x": 0, - "y": 91 + "y": 2723 }, "id": 103, "options": { @@ -8260,7 +8621,7 @@ "h": 8, "w": 12, "x": 12, - "y": 91 + "y": 2723 }, "id": 102, "options": { @@ -8323,7 +8684,7 @@ "h": 8, "w": 24, "x": 0, - "y": 99 + "y": 2731 }, "id": 101, "options": { @@ -8397,7 +8758,7 @@ "h": 8, "w": 12, "x": 0, - "y": 107 + "y": 2739 }, "id": 105, "options": { @@ -8468,7 +8829,7 @@ "h": 8, "w": 12, "x": 12, - "y": 107 + "y": 2739 }, "id": 104, "options": { @@ -8522,7 +8883,7 @@ "h": 1, "w": 24, "x": 0, - "y": 25 + "y": 33 }, "id": 107, "panels": [ @@ -8590,7 +8951,7 @@ "h": 8, "w": 12, "x": 0, - "y": 116 + "y": 2748 }, "id": 109, "options": { @@ -8742,6 +9103,6 @@ "timezone": "browser", "title": "Nim-Waku V2", "uid": "qrp_ZCTGz", - "version": 169, + "version": 180, "weekStart": "" } \ No newline at end of file diff --git a/tests/all_tests_waku.nim b/tests/all_tests_waku.nim index f23f4249c..20da29fe2 100644 --- a/tests/all_tests_waku.nim +++ b/tests/all_tests_waku.nim @@ -99,6 +99,7 @@ import ./wakunode_rest/test_rest_relay_serdes, ./wakunode_rest/test_rest_serdes, ./wakunode_rest/test_rest_filter, + ./wakunode_rest/test_rest_lightpush, ./wakunode_rest/test_rest_lightpush_legacy, ./wakunode_rest/test_rest_admin, ./wakunode_rest/test_rest_cors, diff --git a/tests/common/test_base64_codec.nim b/tests/common/test_base64_codec.nim index fd3b23c76..1c2d04c45 100644 --- a/tests/common/test_base64_codec.nim +++ b/tests/common/test_base64_codec.nim @@ -1,6 +1,6 @@ {.used.} -import std/strutils, stew/[results, byteutils], testutils/unittests +import std/strutils, results, stew/byteutils, testutils/unittests import waku/common/base64 suite "Waku Common - stew base64 wrapper": diff --git a/tests/common/test_confutils_envvar.nim b/tests/common/test_confutils_envvar.nim index 6916f52a8..676a35ae1 100644 --- a/tests/common/test_confutils_envvar.nim +++ b/tests/common/test_confutils_envvar.nim @@ -2,7 +2,7 @@ import std/[os, options], - stew/results, + results, stew/shims/net as stewNet, testutils/unittests, confutils, diff --git a/tests/common/test_enr_builder.nim b/tests/common/test_enr_builder.nim index b95828bb4..9fe8f6807 100644 --- a/tests/common/test_enr_builder.nim +++ b/tests/common/test_enr_builder.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, stew/results, stew/shims/net, testutils/unittests +import std/options, results, stew/shims/net, testutils/unittests import waku/common/enr, ../testlib/wakucore suite "nim-eth ENR - builder and typed record": diff --git a/tests/common/test_parse_size.nim b/tests/common/test_parse_size.nim index dd1f2c7af..009cb9637 100644 --- a/tests/common/test_parse_size.nim +++ b/tests/common/test_parse_size.nim @@ -1,6 +1,6 @@ {.used.} -import testutils/unittests, stew/results +import testutils/unittests, results import waku/common/utils/parse_size_units suite "Size serialization test": diff --git a/tests/common/test_ratelimit_setting.nim b/tests/common/test_ratelimit_setting.nim index 6f6ac8d38..97d69e06a 100644 --- a/tests/common/test_ratelimit_setting.nim +++ b/tests/common/test_ratelimit_setting.nim @@ -10,7 +10,7 @@ import testutils/unittests import chronos, libp2p/stream/connection -import std/[sequtils, options, tables] +import std/[options, tables] import ../../waku/common/rate_limit/request_limiter import ../../waku/common/rate_limit/timed_map diff --git a/tests/common/test_requestratelimiter.nim b/tests/common/test_requestratelimiter.nim index 0b494c1be..be910b38e 100644 --- a/tests/common/test_requestratelimiter.nim +++ b/tests/common/test_requestratelimiter.nim @@ -10,7 +10,7 @@ import testutils/unittests import chronos, libp2p/stream/connection -import std/[sequtils, options] +import std/options import ../../waku/common/rate_limit/request_limiter import ../../waku/common/rate_limit/timed_map diff --git a/tests/common/test_sqlite_migrations.nim b/tests/common/test_sqlite_migrations.nim index 58708ce21..9e67fb9c8 100644 --- a/tests/common/test_sqlite_migrations.nim +++ b/tests/common/test_sqlite_migrations.nim @@ -1,6 +1,6 @@ {.used.} -import std/[strutils, os], stew/results, testutils/unittests +import std/[strutils, os], results, testutils/unittests import waku/common/databases/db_sqlite {.all.}, ../waku_archive/archive_utils template sourceDir(): string = diff --git a/tests/incentivization/test_poc_eligibility.nim b/tests/incentivization/test_poc_eligibility.nim index 7490c2304..be9018898 100644 --- a/tests/incentivization/test_poc_eligibility.nim +++ b/tests/incentivization/test_poc_eligibility.nim @@ -1,17 +1,9 @@ {.used.} -import - std/options, - testutils/unittests, - chronos, - web3, - stew/byteutils, - stint, - strutils, - tests/testlib/testasync +import std/options, testutils/unittests, chronos, web3, stint, tests/testlib/testasync import - waku/[node/peer_manager, waku_core], + waku/node/peer_manager, waku/incentivization/[rpc, eligibility_manager], ../waku_rln_relay/[utils_onchain, utils] diff --git a/tests/incentivization/test_poc_reputation.nim b/tests/incentivization/test_poc_reputation.nim index d601d1e24..0547b9744 100644 --- a/tests/incentivization/test_poc_reputation.nim +++ b/tests/incentivization/test_poc_reputation.nim @@ -1,17 +1,6 @@ -import - std/options, - testutils/unittests, - chronos, - web3, - stew/byteutils, - stint, - strutils, - tests/testlib/testasync +import std/options, testutils/unittests, chronos, web3 -import - waku/[node/peer_manager, waku_core], - waku/incentivization/[rpc, reputation_manager], - waku/waku_lightpush_legacy/rpc +import waku/incentivization/reputation_manager, waku/waku_lightpush_legacy/rpc suite "Waku Incentivization PoC Reputation": var manager {.threadvar.}: ReputationManager diff --git a/tests/node/peer_manager/peer_store/utils.nim b/tests/node/peer_manager/peer_store/utils.nim index b087dc471..891c5fdab 100644 --- a/tests/node/peer_manager/peer_store/utils.nim +++ b/tests/node/peer_manager/peer_store/utils.nim @@ -1,4 +1,4 @@ -import std/options, stew/results, libp2p/peerstore +import std/options, results import waku/node/peer_manager/[waku_peer_store, peer_store/waku_peer_storage], diff --git a/tests/node/test_wakunode_filter.nim b/tests/node/test_wakunode_filter.nim index c9ea12f17..83c486a7e 100644 --- a/tests/node/test_wakunode_filter.nim +++ b/tests/node/test_wakunode_filter.nim @@ -6,7 +6,6 @@ import testutils/unittests, chronos, chronicles, - os, libp2p/[peerstore, crypto/crypto] import diff --git a/tests/node/test_wakunode_legacy_lightpush.nim b/tests/node/test_wakunode_legacy_lightpush.nim index ab23921a0..4ff9c7f00 100644 --- a/tests/node/test_wakunode_legacy_lightpush.nim +++ b/tests/node/test_wakunode_legacy_lightpush.nim @@ -1,31 +1,24 @@ {.used.} import - std/[options, tables, sequtils, tempfiles, strutils], + std/[options, tempfiles], stew/shims/net as stewNet, testutils/unittests, chronos, - chronicles, std/strformat, - os, - libp2p/[peerstore, crypto/crypto] + libp2p/crypto/crypto import waku/[ waku_core, node/peer_manager, node/waku_node, - waku_filter_v2, - waku_filter_v2/client, - waku_filter_v2/subscriptions, waku_lightpush_legacy, waku_lightpush_legacy/common, - waku_lightpush_legacy/client, waku_lightpush_legacy/protocol_metrics, - waku_lightpush_legacy/rpc, waku_rln_relay, ], - ../testlib/[assertions, common, wakucore, wakunode, testasync, futures, testutils], + ../testlib/[wakucore, wakunode, testasync, futures], ../resources/payloads suite "Waku Legacy Lightpush - End To End": diff --git a/tests/node/test_wakunode_legacy_store.nim b/tests/node/test_wakunode_legacy_store.nim index 5b0409d86..8ede3f6f2 100644 --- a/tests/node/test_wakunode_legacy_store.nim +++ b/tests/node/test_wakunode_legacy_store.nim @@ -14,14 +14,11 @@ import node/peer_manager, waku_core, waku_store_legacy, - waku_store_legacy/client, waku_archive_legacy, - waku_archive_legacy/driver/sqlite_driver, - common/databases/db_sqlite, ], ../waku_store_legacy/store_utils, ../waku_archive_legacy/archive_utils, - ../testlib/[common, wakucore, wakunode, testasync, futures, testutils] + ../testlib/[wakucore, wakunode, testasync, testutils] suite "Waku Store - End to End - Sorted Archive": var pubsubTopic {.threadvar.}: PubsubTopic diff --git a/tests/node/test_wakunode_lightpush.nim b/tests/node/test_wakunode_lightpush.nim index 865fb38ff..2e785e368 100644 --- a/tests/node/test_wakunode_lightpush.nim +++ b/tests/node/test_wakunode_lightpush.nim @@ -1,27 +1,16 @@ {.used.} import - std/[options, tables, sequtils, tempfiles, strutils], + std/[options, tempfiles], stew/shims/net as stewNet, testutils/unittests, chronos, - chronicles, std/strformat, - os, - libp2p/[peerstore, crypto/crypto] + libp2p/crypto/crypto import - waku/[ - waku_core, - node/peer_manager, - node/waku_node, - waku_filter_v2, - waku_filter_v2/client, - waku_filter_v2/subscriptions, - waku_lightpush, - waku_rln_relay, - ], - ../testlib/[assertions, common, wakucore, wakunode, testasync, futures, testutils], + waku/[waku_core, node/peer_manager, node/waku_node, waku_lightpush, waku_rln_relay], + ../testlib/[wakucore, wakunode, testasync, futures], ../resources/payloads const PublishedToOnePeer = 1 diff --git a/tests/node/test_wakunode_peer_exchange.nim b/tests/node/test_wakunode_peer_exchange.nim index afd808a2c..26837869d 100644 --- a/tests/node/test_wakunode_peer_exchange.nim +++ b/tests/node/test_wakunode_peer_exchange.nim @@ -13,14 +13,8 @@ import eth/p2p/discoveryv5/enr import - waku/[ - waku_node, - discovery/waku_discv5, - waku_peer_exchange, - node/peer_manager, - waku_relay/protocol, - waku_core, - ], + waku/ + [waku_node, discovery/waku_discv5, waku_peer_exchange, node/peer_manager, waku_core], ../waku_peer_exchange/utils, ../testlib/[wakucore, wakunode, testasync] diff --git a/tests/node/test_wakunode_peer_manager.nim b/tests/node/test_wakunode_peer_manager.nim index 6b8fb2fa6..e37b3e108 100644 --- a/tests/node/test_wakunode_peer_manager.nim +++ b/tests/node/test_wakunode_peer_manager.nim @@ -18,18 +18,15 @@ import waku_core, node/peer_manager, node/waku_node, - waku_enr/sharding, discovery/waku_discv5, waku_filter_v2/common, waku_relay/protocol, ], - ../testlib/ - [wakucore, wakunode, testasync, testutils, assertions, comparisons, futures], + ../testlib/[wakucore, wakunode, testasync, testutils, comparisons], ../waku_enr/utils, ../waku_archive/archive_utils, ../waku_discv5/utils, - ./peer_manager/peer_store/utils, - ./utils + ./peer_manager/peer_store/utils const DEFAULT_PROTOCOLS: seq[string] = @["/ipfs/id/1.0.0", "/libp2p/autonat/1.0.0", "/libp2p/circuit/relay/0.2.0/hop"] diff --git a/tests/node/test_wakunode_store.nim b/tests/node/test_wakunode_store.nim index 49c24c6d8..622322d92 100644 --- a/tests/node/test_wakunode_store.nim +++ b/tests/node/test_wakunode_store.nim @@ -1,7 +1,7 @@ {.used.} import - std/[options, sequtils, algorithm, sets], + std/[options, sequtils, sets], stew/shims/net as stewNet, testutils/unittests, chronos, @@ -15,14 +15,11 @@ import waku_core, waku_core/message/digest, waku_store, - waku_store/client, waku_archive, - waku_archive/driver/sqlite_driver, - common/databases/db_sqlite, ], ../waku_store/store_utils, ../waku_archive/archive_utils, - ../testlib/[common, wakucore, wakunode, testasync, futures, testutils] + ../testlib/[wakucore, wakunode, testasync, testutils] suite "Waku Store - End to End - Sorted Archive": var pubsubTopic {.threadvar.}: PubsubTopic diff --git a/tests/test_message_cache.nim b/tests/test_message_cache.nim index b6bb91b86..cd2e882c1 100644 --- a/tests/test_message_cache.nim +++ b/tests/test_message_cache.nim @@ -1,6 +1,6 @@ {.used.} -import std/[sets, random], stew/[results, byteutils], testutils/unittests +import std/[sets, random], results, stew/byteutils, testutils/unittests import waku/waku_core, waku/waku_api/message_cache, ./testlib/wakucore randomize() diff --git a/tests/test_peer_manager.nim b/tests/test_peer_manager.nim index 4ca08e46f..d79c6b991 100644 --- a/tests/test_peer_manager.nim +++ b/tests/test_peer_manager.nim @@ -1,7 +1,7 @@ {.used.} import - std/[options, sequtils, times, sugar, net], + std/[sequtils, times, sugar, net], stew/shims/net as stewNet, testutils/unittests, chronos, @@ -27,7 +27,6 @@ import waku_relay/protocol, waku_filter_v2/common, waku_store/common, - waku_lightpush/common, waku_peer_exchange, waku_metadata, ], diff --git a/tests/test_peer_store_extended.nim b/tests/test_peer_store_extended.nim index aa5947181..16926c7c2 100644 --- a/tests/test_peer_store_extended.nim +++ b/tests/test_peer_store_extended.nim @@ -9,12 +9,8 @@ import libp2p/multiaddress, testutils/unittests import - waku/[ - node/peer_manager/peer_manager, - node/peer_manager/waku_peer_store, - waku_node, - waku_core/peers, - ], + waku/ + [node/peer_manager/peer_manager, node/peer_manager/waku_peer_store, waku_core/peers], ./testlib/wakucore suite "Extended nim-libp2p Peer Store": diff --git a/tests/test_relay_peer_exchange.nim b/tests/test_relay_peer_exchange.nim index 0be3c9193..e950cb015 100644 --- a/tests/test_relay_peer_exchange.nim +++ b/tests/test_relay_peer_exchange.nim @@ -4,10 +4,8 @@ import std/[sequtils, options], stew/shims/net, testutils/unittests, - chronicles, chronos, libp2p/peerid, - libp2p/crypto/crypto, libp2p/protocols/pubsub/gossipsub import waku/waku_core, waku/waku_node, ./testlib/wakucore, ./testlib/wakunode diff --git a/tests/test_waku_dnsdisc.nim b/tests/test_waku_dnsdisc.nim index cf0fd4007..fe29627d4 100644 --- a/tests/test_waku_dnsdisc.nim +++ b/tests/test_waku_dnsdisc.nim @@ -3,7 +3,8 @@ import std/[sequtils, tables], stew/shims/net, - stew/[base32, results], + results, + stew/base32, testutils/unittests, chronicles, chronos, diff --git a/tests/test_waku_enr.nim b/tests/test_waku_enr.nim index b6571b09f..2ffff5e57 100644 --- a/tests/test_waku_enr.nim +++ b/tests/test_waku_enr.nim @@ -1,6 +1,6 @@ {.used.} -import std/[options, sequtils], stew/results, testutils/unittests +import std/[options, sequtils], results, testutils/unittests import waku/waku_core, waku/waku_enr, ./testlib/wakucore suite "Waku ENR - Capabilities bitfield": diff --git a/tests/test_waku_keepalive.nim b/tests/test_waku_keepalive.nim index aebee13dc..c961773e5 100644 --- a/tests/test_waku_keepalive.nim +++ b/tests/test_waku_keepalive.nim @@ -1,7 +1,6 @@ {.used.} import - std/options, stew/shims/net as stewNet, testutils/unittests, chronos, diff --git a/tests/test_waku_noise_sessions.nim b/tests/test_waku_noise_sessions.nim index a02407e63..543653982 100644 --- a/tests/test_waku_noise_sessions.nim +++ b/tests/test_waku_noise_sessions.nim @@ -1,6 +1,6 @@ {.used.} -import std/tables, stew/[results, byteutils], testutils/unittests +import std/tables, results, stew/byteutils, testutils/unittests import waku/[ common/protobuf, diff --git a/tests/test_wakunode.nim b/tests/test_wakunode.nim index 2213b7f8e..df4b442d6 100644 --- a/tests/test_wakunode.nim +++ b/tests/test_wakunode.nim @@ -17,9 +17,7 @@ import libp2p/nameresolving/mockresolver, eth/p2p/discoveryv5/enr import - waku/[waku_core, waku_node, node/peer_manager, waku_relay, waku_peer_exchange], - ./testlib/wakucore, - ./testlib/wakunode + waku/[waku_core, waku_node, node/peer_manager], ./testlib/wakucore, ./testlib/wakunode suite "WakuNode": asyncTest "Protocol matcher works as expected": diff --git a/tests/testlib/simple_mock.nim b/tests/testlib/simple_mock.nim index 234647d33..91ec19261 100644 --- a/tests/testlib/simple_mock.nim +++ b/tests/testlib/simple_mock.nim @@ -9,9 +9,9 @@ type Instr {.union.} = object proc mockImpl*(target, replacement: pointer) = # YOLO who needs alignment #doAssert (cast[ByteAddress](target) and ByteAddress(0x07)) == 0 - var page = cast[pointer](cast[ByteAddress](target) and (not 0xfff)) + var page = cast[pointer](cast[uint](target) and (not 0xfff)) doAssert mprotect(page, 4096, PROT_WRITE or PROT_EXEC) == 0 - let rel = cast[ByteAddress](replacement) - cast[ByteAddress](target) - 5 + let rel = cast[uint](replacement) - cast[uint](target) - 5 var instr = Instr( bytes: [ 0xe9.byte, diff --git a/tests/testlib/wakucore.nim b/tests/testlib/wakucore.nim index d18a87e7d..c68a69deb 100644 --- a/tests/testlib/wakucore.nim +++ b/tests/testlib/wakucore.nim @@ -1,6 +1,7 @@ import std/[options, times], - stew/[results, byteutils], + results, + stew/byteutils, stew/shims/net, chronos, libp2p/switch, diff --git a/tests/testlib/wakunode.nim b/tests/testlib/wakunode.nim index 1c9b8ec83..d1df39b6b 100644 --- a/tests/testlib/wakunode.nim +++ b/tests/testlib/wakunode.nim @@ -1,6 +1,6 @@ import std/options, - stew/results, + results, stew/shims/net, chronos, libp2p/switch, diff --git a/tests/waku_archive/archive_utils.nim b/tests/waku_archive/archive_utils.nim index 48e23f41d..498855075 100644 --- a/tests/waku_archive/archive_utils.nim +++ b/tests/waku_archive/archive_utils.nim @@ -1,13 +1,12 @@ {.used.} -import std/options, stew/results, chronos, libp2p/crypto/crypto +import std/options, results, chronos, libp2p/crypto/crypto import waku/[ node/peer_manager, waku_core, waku_archive, - waku_archive/common, waku_archive/driver/sqlite_driver, waku_archive/driver/sqlite_driver/migrations, common/databases/db_sqlite, diff --git a/tests/waku_archive/test_driver_queue.nim b/tests/waku_archive/test_driver_queue.nim index 16c0163c7..584ea9d7e 100644 --- a/tests/waku_archive/test_driver_queue.nim +++ b/tests/waku_archive/test_driver_queue.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, stew/results, testutils/unittests +import std/options, results, testutils/unittests import waku/[ waku_archive, diff --git a/tests/waku_archive/test_driver_queue_index.nim b/tests/waku_archive/test_driver_queue_index.nim index c383a676c..f34e181af 100644 --- a/tests/waku_archive/test_driver_queue_index.nim +++ b/tests/waku_archive/test_driver_queue_index.nim @@ -1,6 +1,6 @@ {.used.} -import std/[times, random], stew/byteutils, testutils/unittests, nimcrypto +import std/random, testutils/unittests import waku/waku_core, waku/waku_archive/driver/queue_driver/index var rng = initRand() diff --git a/tests/waku_archive/test_driver_queue_pagination.nim b/tests/waku_archive/test_driver_queue_pagination.nim index dec3ccdee..45543c570 100644 --- a/tests/waku_archive/test_driver_queue_pagination.nim +++ b/tests/waku_archive/test_driver_queue_pagination.nim @@ -9,7 +9,6 @@ import waku_archive/driver/queue_driver/index, waku_core, ], - ../testlib/common, ../testlib/wakucore proc getTestQueueDriver(numMessages: int): QueueDriver = diff --git a/tests/waku_archive/test_driver_sqlite.nim b/tests/waku_archive/test_driver_sqlite.nim index 3ceae595d..5809a8492 100644 --- a/tests/waku_archive/test_driver_sqlite.nim +++ b/tests/waku_archive/test_driver_sqlite.nim @@ -2,12 +2,7 @@ import std/sequtils, testutils/unittests, chronos import - waku/[ - common/databases/db_sqlite, - waku_archive, - waku_archive/driver/sqlite_driver, - waku_core, - ], + waku/[waku_archive, waku_archive/driver/sqlite_driver, waku_core], ../waku_archive/archive_utils, ../testlib/wakucore diff --git a/tests/waku_archive/test_driver_sqlite_query.nim b/tests/waku_archive/test_driver_sqlite_query.nim index fc00a3be8..327ae17bb 100644 --- a/tests/waku_archive/test_driver_sqlite_query.nim +++ b/tests/waku_archive/test_driver_sqlite_query.nim @@ -4,13 +4,7 @@ import std/[options, sequtils, random, algorithm], testutils/unittests, chronos, chronicles import - waku/[ - common/databases/db_sqlite, - waku_archive, - waku_archive/driver/sqlite_driver, - waku_core, - waku_core/message/digest, - ], + waku/[waku_archive, waku_core, waku_core/message/digest], ../testlib/common, ../testlib/wakucore, ../waku_archive/archive_utils diff --git a/tests/waku_archive/test_retention_policy.nim b/tests/waku_archive/test_retention_policy.nim index 4686dda7e..ea86e1d69 100644 --- a/tests/waku_archive/test_retention_policy.nim +++ b/tests/waku_archive/test_retention_policy.nim @@ -1,13 +1,11 @@ {.used.} -import std/[sequtils, times], stew/results, testutils/unittests, chronos +import std/[sequtils, times], results, testutils/unittests, chronos import waku/[ - common/databases/db_sqlite, waku_core, waku_core/message/digest, waku_archive, - waku_archive/driver/sqlite_driver, waku_archive/retention_policy, waku_archive/retention_policy/retention_policy_capacity, waku_archive/retention_policy/retention_policy_size, diff --git a/tests/waku_archive/test_waku_archive.nim b/tests/waku_archive/test_waku_archive.nim index 9211b15e9..802473d64 100644 --- a/tests/waku_archive/test_waku_archive.nim +++ b/tests/waku_archive/test_waku_archive.nim @@ -4,12 +4,10 @@ import std/[options, sequtils], testutils/unittests, chronos, libp2p/crypto/cryp import waku/[ - common/databases/db_sqlite, common/databases/db_postgres/dbconn, common/paging, waku_core, waku_core/message/digest, - waku_archive/driver/sqlite_driver, waku_archive, ], ../waku_archive/archive_utils, diff --git a/tests/waku_archive_legacy/test_driver_queue.nim b/tests/waku_archive_legacy/test_driver_queue.nim index c69e5aa6a..aec9ad65d 100644 --- a/tests/waku_archive_legacy/test_driver_queue.nim +++ b/tests/waku_archive_legacy/test_driver_queue.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, stew/results, testutils/unittests +import std/options, results, testutils/unittests import waku/waku_archive_legacy, waku/waku_archive_legacy/driver/queue_driver/queue_driver {.all.}, diff --git a/tests/waku_archive_legacy/test_driver_sqlite.nim b/tests/waku_archive_legacy/test_driver_sqlite.nim index af043116f..9d8c4d14b 100644 --- a/tests/waku_archive_legacy/test_driver_sqlite.nim +++ b/tests/waku_archive_legacy/test_driver_sqlite.nim @@ -2,12 +2,10 @@ import std/sequtils, testutils/unittests, chronos import - waku/common/databases/db_sqlite, waku/waku_archive_legacy, waku/waku_archive_legacy/driver/sqlite_driver, waku/waku_core, ../waku_archive_legacy/archive_utils, - ../testlib/common, ../testlib/wakucore suite "SQLite driver": diff --git a/tests/waku_archive_legacy/test_driver_sqlite_query.nim b/tests/waku_archive_legacy/test_driver_sqlite_query.nim index ecf88e7c0..42f394891 100644 --- a/tests/waku_archive_legacy/test_driver_sqlite_query.nim +++ b/tests/waku_archive_legacy/test_driver_sqlite_query.nim @@ -4,9 +4,7 @@ import std/[options, sequtils, random, algorithm], testutils/unittests, chronos, chronicles import - waku/common/databases/db_sqlite, waku/waku_archive_legacy, - waku/waku_archive_legacy/driver/sqlite_driver, waku/waku_core, waku/waku_core/message/digest, ../testlib/common, diff --git a/tests/waku_archive_legacy/test_waku_archive.nim b/tests/waku_archive_legacy/test_waku_archive.nim index 181560a28..e58b2cfc9 100644 --- a/tests/waku_archive_legacy/test_waku_archive.nim +++ b/tests/waku_archive_legacy/test_waku_archive.nim @@ -1,21 +1,13 @@ {.used.} -import - std/[options, sequtils], - testutils/unittests, - chronicles, - chronos, - libp2p/crypto/crypto +import std/[options, sequtils], testutils/unittests, chronos, libp2p/crypto/crypto import - waku/common/databases/db_sqlite, waku/common/paging, waku/waku_core, waku/waku_core/message/digest, - waku/waku_archive_legacy/driver/sqlite_driver, waku/waku_archive_legacy, ../waku_archive_legacy/archive_utils, - ../testlib/common, ../testlib/wakucore suite "Waku Archive - message handling": diff --git a/tests/waku_core/test_peers.nim b/tests/waku_core/test_peers.nim index 3dc68fa1a..59ae2e2f3 100644 --- a/tests/waku_core/test_peers.nim +++ b/tests/waku_core/test_peers.nim @@ -1,7 +1,7 @@ {.used.} import - stew/results, + results, testutils/unittests, libp2p/multiaddress, libp2p/peerid, diff --git a/tests/waku_discv5/test_waku_discv5.nim b/tests/waku_discv5/test_waku_discv5.nim index edde80ab3..b2d59813a 100644 --- a/tests/waku_discv5/test_waku_discv5.nim +++ b/tests/waku_discv5/test_waku_discv5.nim @@ -2,7 +2,7 @@ import std/[sequtils, algorithm], - stew/results, + results, stew/shims/net, chronos, chronicles, diff --git a/tests/waku_discv5/utils.nim b/tests/waku_discv5/utils.nim index 679d206ea..422e13fd9 100644 --- a/tests/waku_discv5/utils.nim +++ b/tests/waku_discv5/utils.nim @@ -1,6 +1,5 @@ import std/options, - stew/results, stew/shims/net, chronos, libp2p/crypto/crypto as libp2p_keys, diff --git a/tests/waku_enr/utils.nim b/tests/waku_enr/utils.nim index 6dd017add..8f79b1d8f 100644 --- a/tests/waku_enr/utils.nim +++ b/tests/waku_enr/utils.nim @@ -1,15 +1,13 @@ import std/options, sequtils, - stew/results, + results, stew/shims/net, chronos, libp2p/crypto/crypto as libp2p_keys, eth/keys as eth_keys -import - waku/[waku_core/topics, waku_enr, discovery/waku_discv5, waku_enr/sharding], - ../testlib/[common, wakucore] +import waku/[waku_enr, discovery/waku_discv5, waku_enr/sharding], ../testlib/wakucore proc newTestEnrRecord*( privKey: libp2p_keys.PrivateKey, diff --git a/tests/waku_filter_v2/test_waku_client.nim b/tests/waku_filter_v2/test_waku_client.nim index dbfcd1c51..2c3e2f4ec 100644 --- a/tests/waku_filter_v2/test_waku_client.nim +++ b/tests/waku_filter_v2/test_waku_client.nim @@ -1,13 +1,6 @@ {.used.} -import - std/[options, tables, sequtils, strutils, json], - testutils/unittests, - stew/[results, byteutils], - chronos, - chronicles, - os, - libp2p/peerstore +import std/[options, sequtils, json], testutils/unittests, results, chronos import waku/node/[peer_manager, waku_node], diff --git a/tests/waku_filter_v2/test_waku_filter_dos_protection.nim b/tests/waku_filter_v2/test_waku_filter_dos_protection.nim index c751114c1..7c8c640ba 100644 --- a/tests/waku_filter_v2/test_waku_filter_dos_protection.nim +++ b/tests/waku_filter_v2/test_waku_filter_dos_protection.nim @@ -1,25 +1,18 @@ {.used.} import - std/[options, tables, sequtils, strutils, json], + std/[options, tables, json], testutils/unittests, - stew/[results, byteutils], + results, chronos, chronicles, - os, libp2p/peerstore import - waku/[ - node/peer_manager, - waku_core, - common/rate_limit/setting, - common/rate_limit/token_bucket, - ], - waku/waku_filter_v2/[common, client, subscriptions, protocol, rpc_codec], - ../testlib/[wakucore, testasync, testutils, futures, sequtils], - ./waku_filter_utils, - ../resources/payloads + waku/[node/peer_manager, waku_core], + waku/waku_filter_v2/[common, client, subscriptions, protocol], + ../testlib/[wakucore, testasync, futures], + ./waku_filter_utils type AFilterClient = ref object of RootObj clientSwitch*: Switch diff --git a/tests/waku_filter_v2/waku_filter_utils.nim b/tests/waku_filter_v2/waku_filter_utils.nim index 5698949c5..2f04ceb36 100644 --- a/tests/waku_filter_v2/waku_filter_utils.nim +++ b/tests/waku_filter_v2/waku_filter_utils.nim @@ -1,4 +1,4 @@ -import std/[options, tables, sets, sequtils, algorithm], chronos, chronicles, os +import std/[options, tables, sets, algorithm], chronos, chronicles, os import waku/[ diff --git a/tests/waku_lightpush/lightpush_utils.nim b/tests/waku_lightpush/lightpush_utils.nim index f3e94cb47..9b867c707 100644 --- a/tests/waku_lightpush/lightpush_utils.nim +++ b/tests/waku_lightpush/lightpush_utils.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, chronicles, chronos, libp2p/crypto/crypto +import std/options, chronos, chronicles, libp2p/crypto/crypto import waku/node/peer_manager, diff --git a/tests/waku_lightpush/test_client.nim b/tests/waku_lightpush/test_client.nim index 060a8c22b..d7a1b6b24 100644 --- a/tests/waku_lightpush/test_client.nim +++ b/tests/waku_lightpush/test_client.nim @@ -3,8 +3,8 @@ import std/[options, strscans], testutils/unittests, - chronicles, chronos, + chronicles, libp2p/crypto/crypto import @@ -15,7 +15,7 @@ import waku_lightpush/client, waku_lightpush/protocol_metrics, ], - ../testlib/[assertions, wakucore, testasync, futures, testutils], + ../testlib/[assertions, wakucore, testasync, futures], ./lightpush_utils, ../resources/[pubsub_topics, content_topics, payloads] @@ -312,6 +312,39 @@ suite "Waku Lightpush Client": # Cleanup await serverSwitch2.stop() + asyncTest "Check timestamp is not zero": + ## This test validates that, even the generated message has a timestamp of 0, + ## the node will eventually set a timestamp when publishing the message. + let + zeroTimestamp = 0 + meta = "TEST-META" + message = fakeWakuMessage( + payloads.ALPHABETIC, content_topics.CURRENT, meta, zeroTimestamp + ) + + # When publishing a valid payload + let publishResponse = + await client.publish(some(pubsubTopic), message, serverRemotePeerInfo) + + # Then the message is received by the server + discard await handlerFuture.withTimeout(FUTURE_TIMEOUT) + assertResultOk publishResponse + check handlerFuture.finished() + + # And the message is received with the correct topic and payload + let (readPubsubTopic, readMessage) = handlerFuture.read() + + check: + pubsubTopic == readPubsubTopic + message.payload == readMessage.payload + message.contentTopic == readMessage.contentTopic + message.meta == readMessage.meta + message.timestamp != readMessage.timestamp + message.ephemeral == readMessage.ephemeral + message.proof == readMessage.proof + message.version == readMessage.version + readMessage.timestamp > 0 + suite "Verification of PushResponse Payload": asyncTest "Positive Responses": # When sending a valid PushRequest diff --git a/tests/waku_lightpush/test_ratelimit.nim b/tests/waku_lightpush/test_ratelimit.nim index 7148be37a..0dd7913d1 100644 --- a/tests/waku_lightpush/test_ratelimit.nim +++ b/tests/waku_lightpush/test_ratelimit.nim @@ -1,24 +1,11 @@ {.used.} -import - std/[options, strscans], - testutils/unittests, - chronicles, - chronos, - libp2p/crypto/crypto +import std/options, testutils/unittests, chronos, libp2p/crypto/crypto import - waku/[ - node/peer_manager, - common/rate_limit/setting, - waku_core, - waku_lightpush, - waku_lightpush/client, - waku_lightpush/protocol_metrics, - ], - ../testlib/[assertions, wakucore, testasync, futures, testutils], - ./lightpush_utils, - ../resources/[pubsub_topics, content_topics, payloads] + waku/[node/peer_manager, waku_core, waku_lightpush, waku_lightpush/client], + ../testlib/wakucore, + ./lightpush_utils suite "Rate limited push service": asyncTest "push message with rate limit not violated": diff --git a/tests/waku_lightpush_legacy/lightpush_utils.nim b/tests/waku_lightpush_legacy/lightpush_utils.nim index 733fbc8b1..11c4bf929 100644 --- a/tests/waku_lightpush_legacy/lightpush_utils.nim +++ b/tests/waku_lightpush_legacy/lightpush_utils.nim @@ -1,10 +1,9 @@ {.used.} -import std/options, chronicles, chronos, libp2p/crypto/crypto +import std/options, chronos, libp2p/crypto/crypto import waku/node/peer_manager, - waku/waku_core, waku/waku_lightpush_legacy, waku/waku_lightpush_legacy/[client, common], waku/common/rate_limit/setting, diff --git a/tests/waku_lightpush_legacy/test_client.nim b/tests/waku_lightpush_legacy/test_client.nim index b71b7d5c3..1dcb466c9 100644 --- a/tests/waku_lightpush_legacy/test_client.nim +++ b/tests/waku_lightpush_legacy/test_client.nim @@ -1,11 +1,6 @@ {.used.} -import - std/[options, strscans], - testutils/unittests, - chronicles, - chronos, - libp2p/crypto/crypto +import std/[options, strscans], testutils/unittests, chronos, libp2p/crypto/crypto import waku/[ @@ -16,9 +11,8 @@ import waku_lightpush_legacy/common, waku_lightpush_legacy/protocol_metrics, waku_lightpush_legacy/rpc, - waku_lightpush_legacy/rpc_codec, ], - ../testlib/[assertions, wakucore, testasync, futures, testutils], + ../testlib/[assertions, wakucore, testasync, futures], ./lightpush_utils, ../resources/[pubsub_topics, content_topics, payloads] diff --git a/tests/waku_lightpush_legacy/test_ratelimit.nim b/tests/waku_lightpush_legacy/test_ratelimit.nim index 1d033302f..3df8d369d 100644 --- a/tests/waku_lightpush_legacy/test_ratelimit.nim +++ b/tests/waku_lightpush_legacy/test_ratelimit.nim @@ -1,27 +1,17 @@ {.used.} -import - std/[options, strscans], - testutils/unittests, - chronicles, - chronos, - libp2p/crypto/crypto +import std/options, testutils/unittests, chronos, libp2p/crypto/crypto import waku/[ node/peer_manager, - common/rate_limit/setting, waku_core, waku_lightpush_legacy, waku_lightpush_legacy/client, waku_lightpush_legacy/common, - waku_lightpush_legacy/protocol_metrics, - waku_lightpush_legacy/rpc, - waku_lightpush_legacy/rpc_codec, ], - ../testlib/[assertions, wakucore, testasync, futures, testutils], - ./lightpush_utils, - ../resources/[pubsub_topics, content_topics, payloads] + ../testlib/wakucore, + ./lightpush_utils suite "Rate limited push service": asyncTest "push message with rate limit not violated": diff --git a/tests/waku_peer_exchange/test_protocol.nim b/tests/waku_peer_exchange/test_protocol.nim index 11a61c4dc..8f7f20574 100644 --- a/tests/waku_peer_exchange/test_protocol.nim +++ b/tests/waku_peer_exchange/test_protocol.nim @@ -1,11 +1,10 @@ {.used.} import - std/[options, sequtils, tables, net], + std/[options, sequtils, net], testutils/unittests, chronos, - chronicles, - libp2p/[switch, peerId, crypto/crypto, multistream, muxers/muxer], + libp2p/[switch, peerId, crypto/crypto], eth/[keys, p2p/discoveryv5/enr] import @@ -18,14 +17,11 @@ import waku_peer_exchange/rpc_codec, waku_peer_exchange/protocol, node/peer_manager, - waku_relay/protocol, - waku_relay, waku_core, - waku_core/message/codec, common/enr/builder, waku_enr/sharding, ], - ../testlib/[wakucore, wakunode, simple_mock, assertions], + ../testlib/[wakucore, wakunode, assertions], ./utils.nim suite "Waku Peer Exchange": diff --git a/tests/waku_relay/test_message_id.nim b/tests/waku_relay/test_message_id.nim index b46554d17..633303120 100644 --- a/tests/waku_relay/test_message_id.nim +++ b/tests/waku_relay/test_message_id.nim @@ -1,10 +1,11 @@ import unittest, - stew/[shims/net, results, byteutils], + results, + stew/[shims/net, byteutils], nimcrypto/sha2, libp2p/protocols/pubsub/rpc/messages -import waku/waku_relay/message_id, ../testlib/sequtils +import waku/waku_relay/message_id suite "Message ID Provider": test "Non-empty string": diff --git a/tests/waku_relay/test_protocol.nim b/tests/waku_relay/test_protocol.nim index 399b55ea8..d0e8a7ed6 100644 --- a/tests/waku_relay/test_protocol.nim +++ b/tests/waku_relay/test_protocol.nim @@ -1,13 +1,12 @@ {.used.} import - std/[options, sequtils, strutils, strformat], + std/[options, strformat], stew/shims/net as stewNet, testutils/unittests, - chronicles, chronos, libp2p/protocols/pubsub/[pubsub, gossipsub], - libp2p/[multihash, stream/connection, switch], + libp2p/[stream/connection, switch], ./crypto_utils, std/json @@ -19,7 +18,7 @@ import waku_core, waku_core/message/codec, ], - ../testlib/[wakucore, testasync, testutils, futures, sequtils], + ../testlib/[wakucore, testasync, futures, sequtils], ./utils, ../resources/payloads diff --git a/tests/waku_relay/test_wakunode_relay.nim b/tests/waku_relay/test_wakunode_relay.nim index 398470163..8e028acdc 100644 --- a/tests/waku_relay/test_wakunode_relay.nim +++ b/tests/waku_relay/test_wakunode_relay.nim @@ -90,6 +90,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node3.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) @@ -279,6 +280,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node1.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) @@ -327,6 +329,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node1.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) @@ -379,6 +382,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node1.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) @@ -429,6 +433,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node1.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) @@ -487,6 +492,7 @@ suite "WakuNode - Relay": topic == $shard msg.contentTopic == contentTopic msg.payload == payload + msg.timestamp > 0 completionFut.complete(true) node1.subscribe((kind: PubsubSub, topic: $shard), some(relayHandler)) diff --git a/tests/waku_relay/utils.nim b/tests/waku_relay/utils.nim index c1a085b10..3e39294a1 100644 --- a/tests/waku_relay/utils.nim +++ b/tests/waku_relay/utils.nim @@ -4,7 +4,6 @@ import std/[strutils, sequtils, tempfiles], stew/byteutils, stew/shims/net as stewNet, - testutils/unittests, chronos, libp2p/switch, libp2p/protocols/pubsub/pubsub @@ -23,8 +22,7 @@ import ], ../waku_store/store_utils, ../waku_archive/archive_utils, - ../testlib/[wakucore, wakunode, testasync, futures], - ../resources/payloads + ../testlib/[wakucore, futures] proc noopRawHandler*(): WakuRelayHandler = var handler: WakuRelayHandler diff --git a/tests/waku_rln_relay/test_rln_group_manager_onchain.nim b/tests/waku_rln_relay/test_rln_group_manager_onchain.nim index 355b882b9..8d64723b6 100644 --- a/tests/waku_rln_relay/test_rln_group_manager_onchain.nim +++ b/tests/waku_rln_relay/test_rln_group_manager_onchain.nim @@ -3,8 +3,9 @@ {.push raises: [].} import - std/[options, os, osproc, sequtils, deques, streams, strutils, tempfiles, strformat], - stew/[results, byteutils], + std/[options, sequtils, deques], + results, + stew/byteutils, testutils/unittests, chronos, chronicles, @@ -17,19 +18,15 @@ import import waku/[ - waku_node, - node/waku_node, waku_rln_relay, waku_rln_relay/protocol_types, waku_rln_relay/constants, - waku_rln_relay/contract, waku_rln_relay/rln, waku_rln_relay/conversion_utils, waku_rln_relay/group_manager/on_chain/group_manager, ], - ../testlib/[wakucore, wakunode, common], - ./utils_onchain, - ./utils + ../testlib/wakucore, + ./utils_onchain suite "Onchain group manager": # We run Anvil diff --git a/tests/waku_rln_relay/test_rln_group_manager_static.nim b/tests/waku_rln_relay/test_rln_group_manager_static.nim index 56b5e8df1..5d1916f63 100644 --- a/tests/waku_rln_relay/test_rln_group_manager_static.nim +++ b/tests/waku_rln_relay/test_rln_group_manager_static.nim @@ -4,7 +4,7 @@ import testutils/unittests, - stew/results, + results, options, waku/[ waku_rln_relay/protocol_types, diff --git a/tests/waku_rln_relay/test_rln_serde.nim b/tests/waku_rln_relay/test_rln_serde.nim index 88badce97..1b1d8cd5f 100644 --- a/tests/waku_rln_relay/test_rln_serde.nim +++ b/tests/waku_rln_relay/test_rln_serde.nim @@ -2,7 +2,7 @@ {.push raises: [].} -import stew/results, stint +import results import ./rln/waku_rln_relay_utils, diff --git a/tests/waku_rln_relay/test_waku_rln_relay.nim b/tests/waku_rln_relay/test_waku_rln_relay.nim index 6768cd782..bc1c3f640 100644 --- a/tests/waku_rln_relay/test_waku_rln_relay.nim +++ b/tests/waku_rln_relay/test_waku_rln_relay.nim @@ -17,7 +17,6 @@ import waku_rln_relay/protocol_metrics, waku_keystore, ], - ../testlib/common, ./rln/waku_rln_relay_utils suite "Waku rln relay": diff --git a/tests/waku_rln_relay/test_wakunode_rln_relay.nim b/tests/waku_rln_relay/test_wakunode_rln_relay.nim index 1046bb80d..dd91e95bd 100644 --- a/tests/waku_rln_relay/test_wakunode_rln_relay.nim +++ b/tests/waku_rln_relay/test_wakunode_rln_relay.nim @@ -451,9 +451,9 @@ procSuite "WakuNode - RLN relay": completionFut1.complete(true) if msg == wm2: completionFut2.complete(true) - if msg == wm3: + if msg.payload == wm3.payload: completionFut3.complete(true) - if msg == wm4: + if msg.payload == wm4.payload: completionFut4.complete(true) # mount the relay handler for node3 @@ -490,6 +490,9 @@ procSuite "WakuNode - RLN relay": <<<<<<< HEAD ======= ## This is skipped because is flaky and made CI randomly fail but is useful to run manually +<<<<<<< HEAD +>>>>>>> deprecate_sync_strategy +======= >>>>>>> deprecate_sync_strategy # Given two nodes let diff --git a/tests/waku_rln_relay/utils.nim b/tests/waku_rln_relay/utils.nim index 7dfeffe65..a4247ab44 100644 --- a/tests/waku_rln_relay/utils.nim +++ b/tests/waku_rln_relay/utils.nim @@ -1,4 +1,4 @@ -import web3, chronos, options, stint, stew/byteutils +import web3, chronos, stew/byteutils proc deployContract*( web3: Web3, code: string, gasPrice = 0, contractInput = "" diff --git a/tests/waku_rln_relay/utils_onchain.nim b/tests/waku_rln_relay/utils_onchain.nim index 788d6742e..82eaf085e 100644 --- a/tests/waku_rln_relay/utils_onchain.nim +++ b/tests/waku_rln_relay/utils_onchain.nim @@ -3,8 +3,9 @@ {.push raises: [].} import - std/[options, os, osproc, sequtils, deques, streams, strutils, tempfiles, strformat], - stew/[results, byteutils], + std/[options, os, osproc, deques, streams, strutils, tempfiles, strformat], + results, + stew/byteutils, testutils/unittests, chronos, chronicles, diff --git a/tests/waku_store/store_utils.nim b/tests/waku_store/store_utils.nim index f652f24b6..779074d7e 100644 --- a/tests/waku_store/store_utils.nim +++ b/tests/waku_store/store_utils.nim @@ -1,10 +1,9 @@ {.used.} -import std/options, chronos, chronicles, libp2p/crypto/crypto +import std/options, chronos import - waku/[node/peer_manager, waku_core, waku_store, waku_store/client], - ../testlib/[common, wakucore] + waku/[node/peer_manager, waku_store, waku_store/client], ../testlib/[common, wakucore] proc newTestWakuStore*( switch: Switch, handler: StoreQueryRequestHandler diff --git a/tests/waku_store/test_client.nim b/tests/waku_store/test_client.nim index 53e95b83e..38b07bdf4 100644 --- a/tests/waku_store/test_client.nim +++ b/tests/waku_store/test_client.nim @@ -1,10 +1,10 @@ {.used.} -import std/options, testutils/unittests, chronos, chronicles, libp2p/crypto/crypto +import std/options, testutils/unittests, chronos, libp2p/crypto/crypto import waku/[node/peer_manager, waku_core, waku_store, waku_store/client, common/paging], - ../testlib/[common, wakucore, testasync, futures], + ../testlib/[wakucore, testasync, futures], ./store_utils suite "Store Client": diff --git a/tests/waku_store/test_waku_store.nim b/tests/waku_store/test_waku_store.nim index b21c66be0..815b3ac7d 100644 --- a/tests/waku_store/test_waku_store.nim +++ b/tests/waku_store/test_waku_store.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, testutils/unittests, chronos, chronicles, libp2p/crypto/crypto +import std/options, testutils/unittests, chronos, libp2p/crypto/crypto import waku/[ @@ -12,7 +12,7 @@ import waku_store/client, waku_store/common, ], - ../testlib/[common, wakucore], + ../testlib/wakucore, ./store_utils suite "Waku Store - query handler": diff --git a/tests/waku_store/test_wakunode_store.nim b/tests/waku_store/test_wakunode_store.nim index 1f48d18f2..1d5e4dcfd 100644 --- a/tests/waku_store/test_wakunode_store.nim +++ b/tests/waku_store/test_wakunode_store.nim @@ -18,10 +18,8 @@ import common/paging, waku_core, waku_core/message/digest, - waku_core/subscription, node/peer_manager, waku_archive, - waku_archive/driver/sqlite_driver, waku_filter_v2, waku_filter_v2/client, waku_store, diff --git a/tests/waku_store_legacy/store_utils.nim b/tests/waku_store_legacy/store_utils.nim index cd6236928..a70ca9376 100644 --- a/tests/waku_store_legacy/store_utils.nim +++ b/tests/waku_store_legacy/store_utils.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, chronos, chronicles, libp2p/crypto/crypto +import std/options, chronos import waku/[node/peer_manager, waku_core, waku_store_legacy, waku_store_legacy/client], diff --git a/tests/waku_store_legacy/test_client.nim b/tests/waku_store_legacy/test_client.nim index 9e403dc21..2a8616375 100644 --- a/tests/waku_store_legacy/test_client.nim +++ b/tests/waku_store_legacy/test_client.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, testutils/unittests, chronos, chronicles, libp2p/crypto/crypto +import std/options, testutils/unittests, chronos, libp2p/crypto/crypto import waku/[ @@ -10,7 +10,7 @@ import waku_store_legacy/client, common/paging, ], - ../testlib/[common, wakucore, testasync, futures], + ../testlib/[wakucore, testasync, futures], ./store_utils suite "Store Client": diff --git a/tests/waku_store_legacy/test_rpc_codec.nim b/tests/waku_store_legacy/test_rpc_codec.nim index dae738d01..6897bab41 100644 --- a/tests/waku_store_legacy/test_rpc_codec.nim +++ b/tests/waku_store_legacy/test_rpc_codec.nim @@ -9,7 +9,6 @@ import waku_store_legacy/rpc, waku_store_legacy/rpc_codec, ], - ../testlib/common, ../testlib/wakucore procSuite "Waku Store - RPC codec": diff --git a/tests/waku_store_legacy/test_waku_store.nim b/tests/waku_store_legacy/test_waku_store.nim index e5e38b208..b8dc835c8 100644 --- a/tests/waku_store_legacy/test_waku_store.nim +++ b/tests/waku_store_legacy/test_waku_store.nim @@ -1,6 +1,6 @@ {.used.} -import std/options, testutils/unittests, chronos, chronicles, libp2p/crypto/crypto +import testutils/unittests, chronos, libp2p/crypto/crypto import waku/[ @@ -10,7 +10,7 @@ import waku_store_legacy, waku_store_legacy/client, ], - ../testlib/[common, wakucore], + ../testlib/wakucore, ./store_utils suite "Waku Store - query handler legacy": diff --git a/tests/waku_store_legacy/test_wakunode_store.nim b/tests/waku_store_legacy/test_wakunode_store.nim index 496ab753e..549033e98 100644 --- a/tests/waku_store_legacy/test_wakunode_store.nim +++ b/tests/waku_store_legacy/test_wakunode_store.nim @@ -3,7 +3,6 @@ import std/net, testutils/unittests, - chronicles, chronos, libp2p/crypto/crypto, libp2p/peerid, diff --git a/tests/waku_store_sync/sync_utils.nim b/tests/waku_store_sync/sync_utils.nim index 20a6bdfb1..a81ad6e2f 100644 --- a/tests/waku_store_sync/sync_utils.nim +++ b/tests/waku_store_sync/sync_utils.nim @@ -1,4 +1,4 @@ -import std/[options, random], chronos, chronicles +import std/[options, random], chronos import waku/[ diff --git a/tests/waku_store_sync/test_protocol.nim b/tests/waku_store_sync/test_protocol.nim index f507ad95b..df14de6a1 100644 --- a/tests/waku_store_sync/test_protocol.nim +++ b/tests/waku_store_sync/test_protocol.nim @@ -1,11 +1,7 @@ {.used.} import - std/[options, sets, random, math], - testutils/unittests, - chronos, - libp2p/crypto/crypto, - stew/byteutils + std/[options, sets, random, math], testutils/unittests, chronos, libp2p/crypto/crypto import ../../waku/[ diff --git a/tests/waku_store_sync/test_storage.nim b/tests/waku_store_sync/test_storage.nim index 034eb260e..9e9a80b29 100644 --- a/tests/waku_store_sync/test_storage.nim +++ b/tests/waku_store_sync/test_storage.nim @@ -4,7 +4,6 @@ import std/[options, random], testutils/unittests, chronos import ../../waku/waku_core, - ../../waku/waku_core/message/digest, ../../waku/waku_store_sync/common, ../../waku/waku_store_sync/storage/seq_storage, ./sync_utils diff --git a/tests/wakunode_rest/test_rest_admin.nim b/tests/wakunode_rest/test_rest_admin.nim index fdb0cbc41..bdab61a75 100644 --- a/tests/wakunode_rest/test_rest_admin.nim +++ b/tests/wakunode_rest/test_rest_admin.nim @@ -2,10 +2,10 @@ import std/[sequtils, strformat, net], - stew/shims/net, testutils/unittests, presto, presto/client as presto_client, + presto /../ tests/helpers, libp2p/crypto/crypto import @@ -43,10 +43,11 @@ suite "Waku v2 Rest API - Admin": node3 = newTestWakuNode(generateSecp256k1Key(), getPrimaryIPAddr(), Port(60604)) await allFutures(node1.start(), node2.start(), node3.start()) + let shards = @[RelayShard(clusterId: 1, shardId: 0)] await allFutures( - node1.mountRelay(), - node2.mountRelay(), - node3.mountRelay(), + node1.mountRelay(shards = shards), + node2.mountRelay(shards = shards), + node3.mountRelay(shards = shards), node3.mountPeerExchange(), ) @@ -203,3 +204,96 @@ suite "Waku v2 Rest API - Admin": getRes.data.anyIt(it.origin == Discv5) # Check peer 3 getRes.data.anyIt(it.origin == PeerExchange) + + asyncTest "get peers by id": + # Connect to nodes 2 and 3 using the Admin API + let postRes = await client.postPeers( + @[constructMultiaddrStr(peerInfo2), constructMultiaddrStr(peerInfo3)] + ) + + check: + postRes.status == 200 + + let getRes = await client.getPeerById($peerInfo2.peerId) + + check: + getRes.status == 200 + $getRes.contentType == $MIMETYPE_JSON + getRes.data.protocols.find(WakuRelayCodec) >= 0 + getRes.data.multiaddr == constructMultiaddrStr(peerInfo2) + + ## nim-presto library's RestClient does not support text error case decode if + ## the RestResponse expects a JSON with complex type + # let getRes2 = await client.getPeerById("bad peer id") + let getRes2 = await httpClient( + restServer.httpServer.address, MethodGet, "/admin/v1/peer/bad+peer+id", "" + ) + check: + getRes2.status == 400 + getRes2.data == "Invalid argument:peerid: incorrect PeerId string" + + asyncTest "get connected peers": + # Connect to nodes 2 and 3 using the Admin API + let postRes = await client.postPeers( + @[constructMultiaddrStr(peerInfo2), constructMultiaddrStr(peerInfo3)] + ) + + check: + postRes.status == 200 + + let getRes = await client.getConnectedPeers() + + check: + getRes.status == 200 + $getRes.contentType == $MIMETYPE_JSON + getRes.data.len() == 2 + # Check peer 2 + getRes.data.anyIt(it.multiaddr == constructMultiaddrStr(peerInfo2)) + # Check peer 3 + getRes.data.anyIt(it.multiaddr == constructMultiaddrStr(peerInfo3)) + + # Seems shard info is not available in the peer manager + # let getRes2 = await client.getConnectedPeersByShard(0) + # check: + # getRes2.status == 200 + # $getRes2.contentType == $MIMETYPE_JSON + # getRes2.data.len() == 2 + + let getRes3 = await client.getConnectedPeersByShard(99) + check: + getRes3.status == 200 + $getRes3.contentType == $MIMETYPE_JSON + getRes3.data.len() == 0 + + asyncTest "get relay peers": + # Connect to nodes 2 and 3 using the Admin API + let postRes = await client.postPeers( + @[constructMultiaddrStr(peerInfo2), constructMultiaddrStr(peerInfo3)] + ) + + check: + postRes.status == 200 + + let getRes = await client.getConnectedRelayPeers() + + check: + getRes.status == 200 + $getRes.contentType == $MIMETYPE_JSON + require getRes.data.len() == 1 # Check peer 2 + check getRes.data[0].peers.anyIt(it.multiaddr == constructMultiaddrStr(peerInfo2)) + # Check peer 2 + check getRes.data[0].peers.anyIt(it.multiaddr == constructMultiaddrStr(peerInfo3)) + # Check peer 3 + + # Todo: investigate why the test setup missing remote peer's shard info + # let getRes2 = await client.getConnectedRelayPeersByShard(0) + # check: + # getRes2.status == 200 + # $getRes2.contentType == $MIMETYPE_JSON + # getRes2.data.peers.len() == 2 + + let getRes3 = await client.getConnectedRelayPeersByShard(99) + check: + getRes3.status == 200 + $getRes3.contentType == $MIMETYPE_JSON + getRes3.data.peers.len() == 0 diff --git a/tests/wakunode_rest/test_rest_cors.nim b/tests/wakunode_rest/test_rest_cors.nim index 49b05df16..fc32440d7 100644 --- a/tests/wakunode_rest/test_rest_cors.nim +++ b/tests/wakunode_rest/test_rest_cors.nim @@ -13,10 +13,7 @@ import waku_node, node/waku_node as waku_node2, waku_api/rest/server, - waku_api/rest/client, - waku_api/rest/responses, waku_api/rest/debug/handlers as debug_api, - waku_api/rest/debug/client as debug_api_client, ], ../testlib/common, ../testlib/wakucore, diff --git a/tests/wakunode_rest/test_rest_debug_serdes.nim b/tests/wakunode_rest/test_rest_debug_serdes.nim index bf007b8d2..13b791dc9 100644 --- a/tests/wakunode_rest/test_rest_debug_serdes.nim +++ b/tests/wakunode_rest/test_rest_debug_serdes.nim @@ -1,6 +1,6 @@ {.used.} -import stew/results, stew/byteutils, testutils/unittests, json_serialization +import results, stew/byteutils, testutils/unittests, json_serialization import waku/waku_api/rest/serdes, waku/waku_api/rest/debug/types suite "Waku v2 REST API - Debug - serialization": diff --git a/tests/wakunode_rest/test_rest_filter.nim b/tests/wakunode_rest/test_rest_filter.nim index 60252f92a..358872769 100644 --- a/tests/wakunode_rest/test_rest_filter.nim +++ b/tests/wakunode_rest/test_rest_filter.nim @@ -1,7 +1,6 @@ {.used.} import - std/os, chronos/timer, stew/byteutils, stew/shims/net, diff --git a/tests/wakunode_rest/test_rest_health.nim b/tests/wakunode_rest/test_rest_health.nim index f3b27906e..7d842a3eb 100644 --- a/tests/wakunode_rest/test_rest_health.nim +++ b/tests/wakunode_rest/test_rest_health.nim @@ -23,7 +23,6 @@ import node/health_monitor, ], ../testlib/common, - ../testlib/testutils, ../testlib/wakucore, ../testlib/wakunode diff --git a/tests/wakunode_rest/test_rest_lightpush.nim b/tests/wakunode_rest/test_rest_lightpush.nim new file mode 100644 index 000000000..2c4ec0959 --- /dev/null +++ b/tests/wakunode_rest/test_rest_lightpush.nim @@ -0,0 +1,282 @@ +{.used.} + +import + std/sequtils, + stew/byteutils, + stew/shims/net, + testutils/unittests, + presto, + presto/client as presto_client, + libp2p/crypto/crypto + +import + waku/[ + waku_api/message_cache, + waku_core, + waku_node, + node/peer_manager, + waku_lightpush/common, + waku_api/rest/server, + waku_api/rest/client, + waku_api/rest/responses, + waku_api/rest/lightpush/types, + waku_api/rest/lightpush/handlers as lightpush_api, + waku_api/rest/lightpush/client as lightpush_api_client, + waku_relay, + common/rate_limit/setting, + ], + ../testlib/wakucore, + ../testlib/wakunode + +proc testWakuNode(): WakuNode = + let + privkey = generateSecp256k1Key() + bindIp = parseIpAddress("0.0.0.0") + extIp = parseIpAddress("127.0.0.1") + port = Port(0) + + return newTestWakuNode(privkey, bindIp, port, some(extIp), some(port)) + +type RestLightPushTest = object + serviceNode: WakuNode + pushNode: WakuNode + consumerNode: WakuNode + restServer: WakuRestServerRef + restClient: RestClientRef + +proc init( + T: type RestLightPushTest, rateLimit: RateLimitSetting = (0, 0.millis) +): Future[T] {.async.} = + var testSetup = RestLightPushTest() + testSetup.serviceNode = testWakuNode() + testSetup.pushNode = testWakuNode() + testSetup.consumerNode = testWakuNode() + + await allFutures( + testSetup.serviceNode.start(), + testSetup.pushNode.start(), + testSetup.consumerNode.start(), + ) + + await testSetup.consumerNode.mountRelay() + await testSetup.serviceNode.mountRelay() + await testSetup.serviceNode.mountLightPush(rateLimit) + testSetup.pushNode.mountLightPushClient() + + testSetup.serviceNode.peerManager.addServicePeer( + testSetup.consumerNode.peerInfo.toRemotePeerInfo(), WakuRelayCodec + ) + + await testSetup.serviceNode.connectToNodes( + @[testSetup.consumerNode.peerInfo.toRemotePeerInfo()] + ) + + testSetup.pushNode.peerManager.addServicePeer( + testSetup.serviceNode.peerInfo.toRemotePeerInfo(), WakuLightPushCodec + ) + + var restPort = Port(0) + let restAddress = parseIpAddress("127.0.0.1") + testSetup.restServer = WakuRestServerRef.init(restAddress, restPort).tryGet() + restPort = testSetup.restServer.httpServer.address.port + # update with bound port for restClient use + + installLightPushRequestHandler(testSetup.restServer.router, testSetup.pushNode) + + testSetup.restServer.start() + + testSetup.restClient = newRestHttpClient(initTAddress(restAddress, restPort)) + + return testSetup + +proc shutdown(self: RestLightPushTest) {.async.} = + await self.restServer.stop() + await self.restServer.closeWait() + await allFutures( + self.serviceNode.stop(), self.pushNode.stop(), self.consumerNode.stop() + ) + +suite "Waku v2 Rest API - lightpush": + asyncTest "Push message with proof": + let restLightPushTest = await RestLightPushTest.init() + + let message: RelayWakuMessage = fakeWakuMessage( + contentTopic = DefaultContentTopic, + payload = toBytes("TEST-1"), + proof = toBytes("proof-test"), + ) + .toRelayWakuMessage() + + check message.proof.isSome() + + let requestBody = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: message) + + let response = + await restLightPushTest.restClient.sendPushRequest(body = requestBody) + + ## Validate that the push request failed because the node is not + ## connected to other node but, doesn't fail because of not properly + ## handling the proof message attribute within the REST request. + check: + response.status == 505 + response.data.statusDesc == some("No peers for topic, skipping publish") + response.data.relayPeerCount == none[uint32]() + + asyncTest "Push message request": + # Given + let restLightPushTest = await RestLightPushTest.init() + + restLightPushTest.consumerNode.subscribe( + (kind: PubsubSub, topic: DefaultPubsubTopic) + ) + restLightPushTest.serviceNode.subscribe( + (kind: PubsubSub, topic: DefaultPubsubTopic) + ) + require: + toSeq(restLightPushTest.serviceNode.wakuRelay.subscribedTopics).len == 1 + + # When + let message: RelayWakuMessage = fakeWakuMessage( + contentTopic = DefaultContentTopic, payload = toBytes("TEST-1") + ) + .toRelayWakuMessage() + + let requestBody = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: message) + let response = await restLightPushTest.restClient.sendPushRequest(requestBody) + + echo "response", $response + + # Then + check: + response.status == 200 + response.data.relayPeerCount == some(1.uint32) + + await restLightPushTest.shutdown() + + asyncTest "Push message bad-request": + # Given + let restLightPushTest = await RestLightPushTest.init() + + restLightPushTest.serviceNode.subscribe( + (kind: PubsubSub, topic: DefaultPubsubTopic) + ) + require: + toSeq(restLightPushTest.serviceNode.wakuRelay.subscribedTopics).len == 1 + + # When + let badMessage1: RelayWakuMessage = fakeWakuMessage( + contentTopic = DefaultContentTopic, payload = toBytes("") + ) + .toRelayWakuMessage() + let badRequestBody1 = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: badMessage1) + + let badMessage2: RelayWakuMessage = + fakeWakuMessage(contentTopic = "", payload = toBytes("Sthg")).toRelayWakuMessage() + let badRequestBody2 = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: badMessage2) + + let badRequestBody3 = + PushRequest(pubsubTopic: none(PubsubTopic), message: badMessage2) + + # var response: RestResponse[PushResponse] + + var response = await restLightPushTest.restClient.sendPushRequest(badRequestBody1) + + # Then + check: + response.status == 400 + response.data.statusDesc.isSome() + response.data.statusDesc.get().startsWith("Invalid push request") + + # when + response = await restLightPushTest.restClient.sendPushRequest(badRequestBody2) + + # Then + check: + response.status == 400 + response.data.statusDesc.isSome() + response.data.statusDesc.get().startsWith("Invalid push request") + + # when + response = await restLightPushTest.restClient.sendPushRequest(badRequestBody3) + + # Then + check: + response.data.statusDesc.isSome() + response.data.statusDesc.get().startsWith("Invalid push request") + + await restLightPushTest.shutdown() + + asyncTest "Request rate limit push message": + # Given + let budgetCap = 3 + let tokenPeriod = 500.millis + let restLightPushTest = await RestLightPushTest.init((budgetCap, tokenPeriod)) + + restLightPushTest.consumerNode.subscribe( + (kind: PubsubSub, topic: DefaultPubsubTopic) + ) + restLightPushTest.serviceNode.subscribe( + (kind: PubsubSub, topic: DefaultPubsubTopic) + ) + require: + toSeq(restLightPushTest.serviceNode.wakuRelay.subscribedTopics).len == 1 + + # When + let pushProc = proc() {.async.} = + let message: RelayWakuMessage = fakeWakuMessage( + contentTopic = DefaultContentTopic, payload = toBytes("TEST-1") + ) + .toRelayWakuMessage() + + let requestBody = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: message) + let response = await restLightPushTest.restClient.sendPushRequest(requestBody) + + echo "response", $response + + # Then + check: + response.status == 200 + response.data.relayPeerCount == some(1.uint32) + + let pushRejectedProc = proc() {.async.} = + let message: RelayWakuMessage = fakeWakuMessage( + contentTopic = DefaultContentTopic, payload = toBytes("TEST-1") + ) + .toRelayWakuMessage() + + let requestBody = + PushRequest(pubsubTopic: some(DefaultPubsubTopic), message: message) + let response = await restLightPushTest.restClient.sendPushRequest(requestBody) + + echo "response", $response + + # Then + check: + response.status == 429 + response.data.statusDesc.isSome() # Ensure error status description is present + response.data.statusDesc.get().startsWith( + "Request rejected due to too many requests" + ) # Check specific error message + + await pushProc() + await pushProc() + await pushProc() + await pushRejectedProc() + + await sleepAsync(tokenPeriod) + + for runCnt in 0 ..< 3: + let startTime = Moment.now() + for sendCnt in 0 ..< budgetCap: + await pushProc() + + let endTime = Moment.now() + let elapsed: Duration = (endTime - startTime) + await sleepAsync(tokenPeriod - elapsed + 10.millis) + + await restLightPushTest.shutdown() diff --git a/tests/wakunode_rest/test_rest_lightpush_legacy.nim b/tests/wakunode_rest/test_rest_lightpush_legacy.nim index 3490a5f80..8176aed7a 100644 --- a/tests/wakunode_rest/test_rest_lightpush_legacy.nim +++ b/tests/wakunode_rest/test_rest_lightpush_legacy.nim @@ -26,8 +26,7 @@ import common/rate_limit/setting, ], ../testlib/wakucore, - ../testlib/wakunode, - ../testlib/testutils + ../testlib/wakunode proc testWakuNode(): WakuNode = let @@ -275,28 +274,3 @@ suite "Waku v2 Rest API - lightpush": await sleepAsync(tokenPeriod - elapsed + 10.millis) await restLightPushTest.shutdown() - - ## TODO: Re-work this test when lightpush protocol change is done: https://github.com/waku-org/pm/issues/93 - ## This test is similar when no available peer exists for publish. Currently it is returning success, - ## that makes this test not useful. - # asyncTest "Push message request service not available": - # # Given - # let restLightPushTest = await RestLightPushTest.init() - - # # When - # let message : RelayWakuMessage = fakeWakuMessage(contentTopic = DefaultContentTopic, - # payload = toBytes("TEST-1")).toRelayWakuMessage() - - # let requestBody = PushRequest(pubsubTopic: some("NoExistTopic"), - # message: message) - # let response = await restLightPushTest.client.sendPushRequest(requestBody) - - # echo "response", $response - - # # Then - # check: - # response.status == 503 - # $response.contentType == $MIMETYPE_TEXT - # response.data == "Failed to request a message push: Can not publish to any peers" - - # await restLightPushTest.shutdown() diff --git a/tests/wakunode_rest/test_rest_relay_serdes.nim b/tests/wakunode_rest/test_rest_relay_serdes.nim index 8cc5835f0..086aba22b 100644 --- a/tests/wakunode_rest/test_rest_relay_serdes.nim +++ b/tests/wakunode_rest/test_rest_relay_serdes.nim @@ -1,6 +1,6 @@ {.used.} -import stew/[results, byteutils], chronicles, unittest2, json_serialization +import results, stew/byteutils, unittest2, json_serialization import waku/[common/base64, waku_api/rest/serdes, waku_api/rest/relay/types, waku_core] suite "Waku v2 Rest API - Relay - serialization": diff --git a/tests/wakunode_rest/test_rest_serdes.nim b/tests/wakunode_rest/test_rest_serdes.nim index c50bba983..719742bf8 100644 --- a/tests/wakunode_rest/test_rest_serdes.nim +++ b/tests/wakunode_rest/test_rest_serdes.nim @@ -1,6 +1,6 @@ {.used.} -import stew/[results, byteutils], chronicles, unittest2, json_serialization +import results, stew/byteutils, chronicles, unittest2, json_serialization import waku/waku_api/rest/serdes, waku/waku_api/rest/debug/types # TODO: Decouple this test suite from the `debug_api` module by defining diff --git a/waku.nimble b/waku.nimble index 9c0e819fb..9cf73295f 100644 --- a/waku.nimble +++ b/waku.nimble @@ -23,6 +23,7 @@ requires "nim >= 2.0.8", "web3", "presto", "regex", + "results", "db_connector", "minilru", "quic" diff --git a/waku/common/databases/db_postgres/dbconn.nim b/waku/common/databases/db_postgres/dbconn.nim index 0edb74ede..317cc3003 100644 --- a/waku/common/databases/db_postgres/dbconn.nim +++ b/waku/common/databases/db_postgres/dbconn.nim @@ -1,6 +1,5 @@ import - std/[times, strutils, asyncnet, os, sequtils, sets, strformat], - regex, + std/[times, strutils, os, sets, strformat], results, chronos, chronos/threadsync, diff --git a/waku/common/rate_limit/request_limiter.nim b/waku/common/rate_limit/request_limiter.nim index 7f33d0348..0ede20be4 100644 --- a/waku/common/rate_limit/request_limiter.nim +++ b/waku/common/rate_limit/request_limiter.nim @@ -78,14 +78,14 @@ template checkUsageLimit*( bodyWithinLimit, bodyRejected: untyped, ) = if t.checkUsage(proto, conn): - let requestStartTime = getTime().toUnixFloat() + let requestStartTime = Moment.now() waku_service_requests.inc(labelValues = [proto, "served"]) bodyWithinLimit - let requestDurationSec = getTime().toUnixFloat() - requestStartTime + let requestDuration = Moment.now() - requestStartTime waku_service_request_handling_duration_seconds.observe( - requestDurationSec, labelValues = [proto] + requestDuration.milliseconds.float / 1000, labelValues = [proto] ) else: waku_service_requests.inc(labelValues = [proto, "rejected"]) diff --git a/waku/common/rate_limit/service_metrics.nim b/waku/common/rate_limit/service_metrics.nim index 7d24d9530..bff91f622 100644 --- a/waku/common/rate_limit/service_metrics.nim +++ b/waku/common/rate_limit/service_metrics.nim @@ -1,8 +1,11 @@ {.push raises: [].} import std/options +import chronos/timer import metrics, setting +export metrics + declarePublicGauge waku_service_requests_limit, "Applied rate limit of non-relay service", ["service"] @@ -19,4 +22,9 @@ proc setServiceLimitMetric*(service: string, limit: Option[RateLimitSetting]) = ) declarePublicHistogram waku_service_request_handling_duration_seconds, - "duration of non-relay service handling", ["service"] + "duration of non-relay service handling", + labels = ["service"], + buckets = [ + 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0, + 15.0, 20.0, 30.0, Inf, + ] diff --git a/waku/common/rate_limit/single_token_limiter.nim b/waku/common/rate_limit/single_token_limiter.nim index da01f61bb..50fb2d64c 100644 --- a/waku/common/rate_limit/single_token_limiter.nim +++ b/waku/common/rate_limit/single_token_limiter.nim @@ -45,14 +45,14 @@ template checkUsageLimit*( bodyWithinLimit, bodyRejected: untyped, ) = if t.checkUsage(proto): - let requestStartTime = getTime().toUnixFloat() + let requestStartTime = Moment.now() waku_service_requests.inc(labelValues = [proto, "served"]) bodyWithinLimit - let requestDurationSec = getTime().toUnixFloat() - requestStartTime + let requestDuration = Moment.now() - requestStartTime waku_service_request_handling_duration_seconds.observe( - requestDurationSec, labelValues = [proto] + requestDuration.milliseconds.float / 1000, labelValues = [proto] ) else: waku_service_requests.inc(labelValues = [proto, "rejected"]) diff --git a/waku/factory/builder.nim b/waku/factory/builder.nim index e896ecdbb..caa84db63 100644 --- a/waku/factory/builder.nim +++ b/waku/factory/builder.nim @@ -8,7 +8,6 @@ import libp2p/builders, libp2p/nameresolving/nameresolver, libp2p/transports/wstransport, - libp2p/protocols/connectivity/relay/client, libp2p/protocols/connectivity/relay/relay import ../waku_enr, diff --git a/waku/factory/waku.nim b/waku/factory/waku.nim index 91f3cee2e..9760d1580 100644 --- a/waku/factory/waku.nim +++ b/waku/factory/waku.nim @@ -38,7 +38,6 @@ import ../waku_rln_relay, ../waku_store, ../waku_filter_v2, - ../factory/networks_config, ../factory/node_factory, ../factory/internal_config, ../factory/external_config, diff --git a/waku/incentivization/common.nim b/waku/incentivization/common.nim index 79fcf1645..071b4c18f 100644 --- a/waku/incentivization/common.nim +++ b/waku/incentivization/common.nim @@ -1,6 +1,6 @@ import std/options -import waku/incentivization/[rpc, eligibility_manager] +import waku/incentivization/rpc proc init*(T: type EligibilityStatus, isEligible: bool): T = if isEligible: diff --git a/waku/incentivization/eligibility_manager.nim b/waku/incentivization/eligibility_manager.nim index da8280da3..b10b293e1 100644 --- a/waku/incentivization/eligibility_manager.nim +++ b/waku/incentivization/eligibility_manager.nim @@ -1,6 +1,6 @@ import std/[options, sets], chronos, web3, stew/byteutils, stint, results, chronicles -import waku/incentivization/rpc, tests/waku_rln_relay/[utils_onchain, utils] +import waku/incentivization/rpc, tests/waku_rln_relay/utils_onchain const SimpleTransferGasUsed = Quantity(21000) const TxReceiptQueryTimeout = 3.seconds diff --git a/waku/incentivization/rpc_codec.nim b/waku/incentivization/rpc_codec.nim index 5d3ce48d5..9529ddffe 100644 --- a/waku/incentivization/rpc_codec.nim +++ b/waku/incentivization/rpc_codec.nim @@ -1,5 +1,5 @@ import std/options -import ../common/protobuf, ../waku_core, ./rpc +import ../common/protobuf, ./rpc # Codec for EligibilityProof diff --git a/waku/node/peer_manager/peer_manager.nim b/waku/node/peer_manager/peer_manager.nim index 39baeea3e..602718d5d 100644 --- a/waku/node/peer_manager/peer_manager.nim +++ b/waku/node/peer_manager/peer_manager.nim @@ -154,7 +154,7 @@ proc addPeer*( pm.storage.insertOrReplace(remotePeerInfo) -proc getPeer(pm: PeerManager, peerId: PeerId): RemotePeerInfo = +proc getPeer*(pm: PeerManager, peerId: PeerId): RemotePeerInfo = return pm.switch.peerStore.getPeer(peerId) proc loadFromStorage(pm: PeerManager) {.gcsafe.} = diff --git a/waku/node/waku_node.nim b/waku/node/waku_node.nim index ae08b503a..a544bdc80 100644 --- a/waku/node/waku_node.nim +++ b/waku/node/waku_node.nim @@ -15,8 +15,6 @@ import libp2p/protocols/ping, libp2p/protocols/pubsub/gossipsub, libp2p/protocols/pubsub/rpc/messages, - libp2p/protocols/connectivity/autonat/client, - libp2p/protocols/connectivity/autonat/service, libp2p/builders, libp2p/transports/transport, libp2p/transports/tcptransport, @@ -50,8 +48,7 @@ import ../waku_rln_relay, ./config, ./peer_manager, - ../common/rate_limit/setting, - ../discovery/autonat_service + ../common/rate_limit/setting declarePublicCounter waku_node_messages, "number of messages received", ["type"] declarePublicHistogram waku_histogram_message_size, @@ -516,6 +513,10 @@ proc mountFilterClient*(node: WakuNode) {.async: (raises: []).} = ## rely on node provided cache. - This only applies for v2 filter client info "mounting filter client" + if not node.wakuFilterClient.isNil(): + trace "Filter client already mounted." + return + node.wakuFilterClient = WakuFilterClient.new(node.peerManager, node.rng) try: @@ -1024,8 +1025,9 @@ proc mountLegacyLightPush*( proc mountLegacyLightPushClient*(node: WakuNode) = info "mounting legacy light push client" - node.wakuLegacyLightpushClient = - WakuLegacyLightPushClient.new(node.peerManager, node.rng) + if node.wakuLegacyLightpushClient.isNil(): + node.wakuLegacyLightpushClient = + WakuLegacyLightPushClient.new(node.peerManager, node.rng) proc legacyLightpushPublish*( node: WakuNode, @@ -1136,7 +1138,8 @@ proc mountLightPush*( proc mountLightPushClient*(node: WakuNode) = info "mounting light push client" - node.wakuLightpushClient = WakuLightPushClient.new(node.peerManager, node.rng) + if node.wakuLightpushClient.isNil(): + node.wakuLightpushClient = WakuLightPushClient.new(node.peerManager, node.rng) proc lightpushPublishHandler( node: WakuNode, diff --git a/waku/waku_api/rest/admin/client.nim b/waku/waku_api/rest/admin/client.nim index 1fd9fdfc8..4b46ca136 100644 --- a/waku/waku_api/rest/admin/client.nim +++ b/waku/waku_api/rest/admin/client.nim @@ -1,13 +1,8 @@ {.push raises: [].} -import - chronicles, - json_serialization, - json_serialization/std/options, - presto/[route, client], - stew/byteutils +import chronicles, json_serialization, presto/[route, client], stew/byteutils -import ../serdes, ../responses, ../rest_serdes, ./types +import ../serdes, ../rest_serdes, ./types export types @@ -27,6 +22,44 @@ proc postPeers*( rest, endpoint: "/admin/v1/peers", meth: HttpMethod.MethodPost .} +proc getPeerById*( + peerId: string +): RestResponse[WakuPeer] {. + rest, endpoint: "/admin/v1/peer/{peerId}", meth: HttpMethod.MethodGet +.} + +proc getConnectedPeers*(): RestResponse[seq[WakuPeer]] {. + rest, endpoint: "/admin/v1/peers/connected", meth: HttpMethod.MethodGet +.} + +proc getConnectedPeersByShard*( + shardId: uint16 +): RestResponse[seq[WakuPeer]] {. + rest, endpoint: "/admin/v1/peers/connected/on/{shardId}", meth: HttpMethod.MethodGet +.} + +proc getConnectedRelayPeers*(): RestResponse[PeersOfShards] {. + rest, endpoint: "/admin/v1/peers/connected/relay", meth: HttpMethod.MethodGet +.} + +proc getConnectedRelayPeersByShard*( + shardId: uint16 +): RestResponse[PeersOfShard] {. + rest, + endpoint: "/admin/v1/peers/connected/relay/on/{shardId}", + meth: HttpMethod.MethodGet +.} + +proc getMeshPeers*(): RestResponse[PeersOfShards] {. + rest, endpoint: "/admin/v1/peers/mesh", meth: HttpMethod.MethodGet +.} + +proc getMeshPeersByShard*( + shardId: uint16 +): RestResponse[PeersOfShard] {. + rest, endpoint: "/admin/v1/peers/mesh/on/{shardId}", meth: HttpMethod.MethodGet +.} + proc getFilterSubscriptions*(): RestResponse[seq[FilterSubscription]] {. rest, endpoint: "/admin/v1/filter/subscriptions", meth: HttpMethod.MethodGet .} diff --git a/waku/waku_api/rest/admin/handlers.nim b/waku/waku_api/rest/admin/handlers.nim index f2eb4a8ba..ada60e870 100644 --- a/waku/waku_api/rest/admin/handlers.nim +++ b/waku/waku_api/rest/admin/handlers.nim @@ -1,22 +1,26 @@ {.push raises: [].} import - std/[strformat, sequtils, tables], + std/[sets, strformat, sequtils, tables], chronicles, json_serialization, presto/route, - libp2p/[peerinfo, switch] + libp2p/[peerinfo, switch, peerid, protocols/pubsub/pubsubpeer] import - ../../../waku_core, - ../../../waku_store_legacy/common, - ../../../waku_store/common, - ../../../waku_filter_v2, - ../../../waku_lightpush_legacy/common, - ../../../waku_relay, - ../../../waku_peer_exchange, - ../../../waku_node, - ../../../node/peer_manager, + waku/[ + waku_core, + waku_core/topics/pubsub_topic, + waku_store_legacy/common, + waku_store/common, + waku_filter_v2, + waku_lightpush_legacy/common, + waku_relay, + waku_peer_exchange, + waku_node, + node/peer_manager, + waku_enr/sharding, + ], ../responses, ../serdes, ../rest_serdes, @@ -27,103 +31,260 @@ export types logScope: topics = "waku node rest admin api" -const ROUTE_ADMIN_V1_PEERS* = "/admin/v1/peers" +const ROUTE_ADMIN_V1_PEERS* = "/admin/v1/peers" # returns all peers +const ROUTE_ADMIN_V1_SINGLE_PEER* = "/admin/v1/peer/{peerId}" + +const ROUTE_ADMIN_V1_CONNECTED_PEERS* = "/admin/v1/peers/connected" +const ROUTE_ADMIN_V1_CONNECTED_PEERS_ON_SHARD* = + "/admin/v1/peers/connected/on/{shardId}" +const ROUTE_ADMIN_V1_CONNECTED_RELAY_PEERS* = "/admin/v1/peers/connected/relay" +const ROUTE_ADMIN_V1_CONNECTED_RELAY_PEERS_ON_SHARD* = + "/admin/v1/peers/connected/relay/on/{shardId}" +const ROUTE_ADMIN_V1_MESH_PEERS* = "/admin/v1/peers/mesh" +const ROUTE_ADMIN_V1_MESH_PEERS_ON_SHARD* = "/admin/v1/peers/mesh/on/{shardId}" + const ROUTE_ADMIN_V1_FILTER_SUBS* = "/admin/v1/filter/subscriptions" type PeerProtocolTuple = - tuple[multiaddr: string, protocol: string, connected: bool, origin: PeerOrigin] + tuple[ + multiaddr: string, + protocol: string, + shards: seq[uint16], + connected: Connectedness, + agent: string, + origin: PeerOrigin, + ] proc tuplesToWakuPeers(peers: var WakuPeers, peersTup: seq[PeerProtocolTuple]) = for peer in peersTup: - peers.add(peer.multiaddr, peer.protocol, peer.connected, peer.origin) + peers.add( + peer.multiaddr, peer.protocol, peer.shards, peer.connected, peer.agent, + peer.origin, + ) + +proc populateAdminPeerInfo(peers: var WakuPeers, node: WakuNode, codec: string) = + let peersForCodec = node.peerManager.switch.peerStore.peers(codec).mapIt( + ( + multiaddr: constructMultiaddrStr(it), + protocol: codec, + shards: it.getShards(), + connected: it.connectedness, + agent: it.agent, + origin: it.origin, + ) + ) + tuplesToWakuPeers(peers, peersForCodec) + +proc populateAdminPeerInfoForCodecs(node: WakuNode, codecs: seq[string]): WakuPeers = + var peers: WakuPeers = @[] + + for codec in codecs: + populateAdminPeerInfo(peers, node, codec) + + return peers proc installAdminV1GetPeersHandler(router: var RestRouter, node: WakuNode) = router.api(MethodGet, ROUTE_ADMIN_V1_PEERS) do() -> RestApiResponse: - var peers: WakuPeers = @[] - - let relayPeers = node.peerManager.switch.peerStore.peers(WakuRelayCodec).mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuRelayCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, relayPeers) - - let filterV2Peers = node.peerManager.switch.peerStore - .peers(WakuFilterSubscribeCodec) - .mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuFilterSubscribeCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, filterV2Peers) - - let storePeers = node.peerManager.switch.peerStore.peers(WakuStoreCodec).mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuStoreCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, storePeers) - - let legacyStorePeers = node.peerManager.switch.peerStore - .peers(WakuLegacyStoreCodec) - .mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuLegacyStoreCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, legacyStorePeers) - - let legacyLightpushPeers = node.peerManager.switch.peerStore - .peers(WakuLegacyLightPushCodec) - .mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuLegacyLightPushCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, legacyLightpushPeers) - - let lightpushPeers = node.peerManager.switch.peerStore - .peers(WakuLightPushCodec) - .mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuLightPushCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, lightpushPeers) - - let pxPeers = node.peerManager.switch.peerStore.peers(WakuPeerExchangeCodec).mapIt( - ( - multiaddr: constructMultiaddrStr(it), - protocol: WakuPeerExchangeCodec, - connected: it.connectedness == Connectedness.Connected, - origin: it.origin, - ) - ) - tuplesToWakuPeers(peers, pxPeers) + let peers = populateAdminPeerInfoForCodecs( + node, + @[ + WakuRelayCodec, WakuFilterSubscribeCodec, WakuStoreCodec, WakuLegacyStoreCodec, + WakuLegacyLightPushCodec, WakuLightPushCodec, WakuPeerExchangeCodec, + WakuReconciliationCodec, + ], + ) let resp = RestApiResponse.jsonResponse(peers, status = Http200) if resp.isErr(): - error "An error ocurred while building the json respose: ", error = resp.error + error "An error occurred while building the json response: ", error = resp.error return RestApiResponse.internalServerError( - fmt("An error ocurred while building the json respose: {resp.error}") + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_SINGLE_PEER) do( + peerId: string + ) -> RestApiResponse: + let peerIdString = peerId.valueOr: + return RestApiResponse.badRequest("Invalid argument:" & $error) + + let peerIdVal: PeerId = PeerId.init(peerIdString).valueOr: + return RestApiResponse.badRequest("Invalid argument:" & $error) + + if node.peerManager.switch.peerStore.peerExists(peerIdVal): + let peerInfo = node.peerManager.switch.peerStore.getPeer(peerIdVal) + let peer = WakuPeer.init(peerInfo) + let resp = RestApiResponse.jsonResponse(peer, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + else: + return RestApiResponse.notFound(fmt("Peer with ID {peerId} not found")) + + router.api(MethodGet, ROUTE_ADMIN_V1_CONNECTED_PEERS) do() -> RestApiResponse: + let allPeers = populateAdminPeerInfoForCodecs( + node, + @[ + WakuRelayCodec, WakuFilterSubscribeCodec, WakuStoreCodec, WakuLegacyStoreCodec, + WakuLegacyLightPushCodec, WakuLightPushCodec, WakuPeerExchangeCodec, + WakuReconciliationCodec, + ], + ) + + let connectedPeers = allPeers.filterIt(it.connected == Connectedness.Connected) + + let resp = RestApiResponse.jsonResponse(connectedPeers, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_CONNECTED_PEERS_ON_SHARD) do( + shardId: uint16 + ) -> RestApiResponse: + let shard = shardId.valueOr: + return RestApiResponse.badRequest(fmt("Invalid shardId: {error}")) + + let allPeers = populateAdminPeerInfoForCodecs( + node, + @[ + WakuRelayCodec, WakuFilterSubscribeCodec, WakuStoreCodec, WakuLegacyStoreCodec, + WakuLegacyLightPushCodec, WakuLightPushCodec, WakuPeerExchangeCodec, + WakuReconciliationCodec, + ], + ) + + let connectedPeers = allPeers.filterIt( + it.connected == Connectedness.Connected and it.shards.contains(shard) + ) + + let resp = RestApiResponse.jsonResponse(connectedPeers, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_CONNECTED_RELAY_PEERS) do() -> RestApiResponse: + if node.wakuRelay.isNil(): + return RestApiResponse.serviceUnavailable( + "Error: Relay Protocol is not mounted to the node" + ) + + var relayPeers: PeersOfShards = @[] + for topic in node.wakuRelay.getSubscribedTopics(): + let relayShard = RelayShard.parse(topic).valueOr: + error "Invalid subscribed topic", error = error, topic = topic + continue + let pubsubPeers = + node.wakuRelay.getConnectedPubSubPeers(topic).get(initHashSet[PubSubPeer](0)) + relayPeers.add( + PeersOfShard( + shard: relayShard.shardId, + peers: toSeq(pubsubPeers).mapIt(WakuPeer.init(it, node.peerManager)), + ) + ) + + let resp = RestApiResponse.jsonResponse(relayPeers, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_CONNECTED_RELAY_PEERS_ON_SHARD) do( + shardId: uint16 + ) -> RestApiResponse: + let shard = shardId.valueOr: + return RestApiResponse.badRequest(fmt("Invalid shardId: {error}")) + + if node.wakuRelay.isNil(): + return RestApiResponse.serviceUnavailable( + "Error: Relay Protocol is not mounted to the node" + ) + + let topic = + toPubsubTopic(RelayShard(clusterId: node.wakuSharding.clusterId, shardId: shard)) + let pubsubPeers = + node.wakuRelay.getConnectedPubSubPeers(topic).get(initHashSet[PubSubPeer](0)) + let relayPeer = PeersOfShard( + shard: shard, peers: toSeq(pubsubPeers).mapIt(WakuPeer.init(it, node.peerManager)) + ) + + let resp = RestApiResponse.jsonResponse(relayPeer, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_MESH_PEERS) do() -> RestApiResponse: + if node.wakuRelay.isNil(): + return RestApiResponse.serviceUnavailable( + "Error: Relay Protocol is not mounted to the node" + ) + + var relayPeers: PeersOfShards = @[] + for topic in node.wakuRelay.getSubscribedTopics(): + let relayShard = RelayShard.parse(topic).valueOr: + error "Invalid subscribed topic", error = error, topic = topic + continue + let peers = + node.wakuRelay.getPubSubPeersInMesh(topic).get(initHashSet[PubSubPeer](0)) + relayPeers.add( + PeersOfShard( + shard: relayShard.shardId, + peers: toSeq(peers).mapIt(WakuPeer.init(it, node.peerManager)), + ) + ) + + let resp = RestApiResponse.jsonResponse(relayPeers, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") + ) + + return resp.get() + + router.api(MethodGet, ROUTE_ADMIN_V1_MESH_PEERS_ON_SHARD) do( + shardId: uint16 + ) -> RestApiResponse: + let shard = shardId.valueOr: + return RestApiResponse.badRequest(fmt("Invalid shardId: {error}")) + + if node.wakuRelay.isNil(): + return RestApiResponse.serviceUnavailable( + "Error: Relay Protocol is not mounted to the node" + ) + + let topic = + toPubsubTopic(RelayShard(clusterId: node.wakuSharding.clusterId, shardId: shard)) + let peers = + node.wakuRelay.getPubSubPeersInMesh(topic).get(initHashSet[PubSubPeer](0)) + let relayPeer = PeersOfShard( + shard: shard, peers: toSeq(peers).mapIt(WakuPeer.init(it, node.peerManager)) + ) + + let resp = RestApiResponse.jsonResponse(relayPeer, status = Http200) + if resp.isErr(): + error "An error occurred while building the json response: ", error = resp.error + return RestApiResponse.internalServerError( + fmt("An error occurred while building the json response: {resp.error}") ) return resp.get() diff --git a/waku/waku_api/rest/admin/types.nim b/waku/waku_api/rest/admin/types.nim index bb7dd2b0c..0c0786e3d 100644 --- a/waku/waku_api/rest/admin/types.nim +++ b/waku/waku_api/rest/admin/types.nim @@ -4,22 +4,29 @@ import chronicles, json_serialization, json_serialization/std/options, - json_serialization/lexer -import ../serdes, ../../../waku_core + json_serialization/lexer, + results, + libp2p/protocols/pubsub/pubsubpeer +import waku/[waku_core, node/peer_manager], ../serdes #### Types - -type ProtocolState* = object - protocol*: string - connected*: bool - type WakuPeer* = object multiaddr*: string - protocols*: seq[ProtocolState] + protocols*: seq[string] + shards*: seq[uint16] + connected*: Connectedness + agent*: string origin*: PeerOrigin + score*: Option[float64] type WakuPeers* = seq[WakuPeer] +type PeersOfShard* = object + shard*: uint16 + peers*: WakuPeers + +type PeersOfShards* = seq[PeersOfShard] + type FilterTopic* = object pubsubTopic*: string contentTopic*: string @@ -29,22 +36,25 @@ type FilterSubscription* = object filterCriteria*: seq[FilterTopic] #### Serialization and deserialization - -proc writeValue*( - writer: var JsonWriter[RestJson], value: ProtocolState -) {.raises: [IOError].} = - writer.beginRecord() - writer.writeField("protocol", value.protocol) - writer.writeField("connected", value.connected) - writer.endRecord() - proc writeValue*( writer: var JsonWriter[RestJson], value: WakuPeer ) {.raises: [IOError].} = writer.beginRecord() writer.writeField("multiaddr", value.multiaddr) writer.writeField("protocols", value.protocols) + writer.writeField("shards", value.shards) + writer.writeField("connected", value.connected) + writer.writeField("agent", value.agent) writer.writeField("origin", value.origin) + writer.writeField("score", value.score) + writer.endRecord() + +proc writeValue*( + writer: var JsonWriter[RestJson], value: PeersOfShard +) {.raises: [IOError].} = + writer.beginRecord() + writer.writeField("shard", value.shard) + writer.writeField("peers", value.peers) writer.endRecord() proc writeValue*( @@ -63,43 +73,17 @@ proc writeValue*( writer.writeField("filterCriteria", value.filterCriteria) writer.endRecord() -proc readValue*( - reader: var JsonReader[RestJson], value: var ProtocolState -) {.gcsafe, raises: [SerializationError, IOError].} = - var - protocol: Option[string] - connected: Option[bool] - - for fieldName in readObjectFields(reader): - case fieldName - of "protocol": - if protocol.isSome(): - reader.raiseUnexpectedField("Multiple `protocol` fields found", "ProtocolState") - protocol = some(reader.readValue(string)) - of "connected": - if connected.isSome(): - reader.raiseUnexpectedField( - "Multiple `connected` fields found", "ProtocolState" - ) - connected = some(reader.readValue(bool)) - else: - unrecognizedFieldWarning(value) - - if connected.isNone(): - reader.raiseUnexpectedValue("Field `connected` is missing") - - if protocol.isNone(): - reader.raiseUnexpectedValue("Field `protocol` is missing") - - value = ProtocolState(protocol: protocol.get(), connected: connected.get()) - proc readValue*( reader: var JsonReader[RestJson], value: var WakuPeer ) {.gcsafe, raises: [SerializationError, IOError].} = var multiaddr: Option[string] - protocols: Option[seq[ProtocolState]] + protocols: Option[seq[string]] + shards: Option[seq[uint16]] + connected: Option[Connectedness] + agent: Option[string] origin: Option[PeerOrigin] + score: Option[float64] for fieldName in readObjectFields(reader): case fieldName @@ -110,11 +94,27 @@ proc readValue*( of "protocols": if protocols.isSome(): reader.raiseUnexpectedField("Multiple `protocols` fields found", "WakuPeer") - protocols = some(reader.readValue(seq[ProtocolState])) + protocols = some(reader.readValue(seq[string])) + of "shards": + if shards.isSome(): + reader.raiseUnexpectedField("Multiple `shards` fields found", "WakuPeer") + shards = some(reader.readValue(seq[uint16])) + of "connected": + if connected.isSome(): + reader.raiseUnexpectedField("Multiple `connected` fields found", "WakuPeer") + connected = some(reader.readValue(Connectedness)) + of "agent": + if agent.isSome(): + reader.raiseUnexpectedField("Multiple `agent` fields found", "WakuPeer") + agent = some(reader.readValue(string)) of "origin": if origin.isSome(): reader.raiseUnexpectedField("Multiple `origin` fields found", "WakuPeer") origin = some(reader.readValue(PeerOrigin)) + of "score": + if score.isSome(): + reader.raiseUnexpectedField("Multiple `score` fields found", "WakuPeer") + score = some(reader.readValue(float64)) else: unrecognizedFieldWarning(value) @@ -124,13 +124,56 @@ proc readValue*( if protocols.isNone(): reader.raiseUnexpectedValue("Field `protocols` are missing") + if shards.isNone(): + reader.raiseUnexpectedValue("Field `shards` is missing") + + if connected.isNone(): + reader.raiseUnexpectedValue("Field `connected` is missing") + + if agent.isNone(): + reader.raiseUnexpectedValue("Field `agent` is missing") + if origin.isNone(): reader.raiseUnexpectedValue("Field `origin` is missing") value = WakuPeer( - multiaddr: multiaddr.get(), protocols: protocols.get(), origin: origin.get() + multiaddr: multiaddr.get(), + protocols: protocols.get(), + shards: shards.get(), + connected: connected.get(), + agent: agent.get(), + origin: origin.get(), + score: score, ) +proc readValue*( + reader: var JsonReader[RestJson], value: var PeersOfShard +) {.gcsafe, raises: [SerializationError, IOError].} = + var + shard: Option[uint16] + peers: Option[WakuPeers] + + for fieldName in readObjectFields(reader): + case fieldName + of "shard": + if shard.isSome(): + reader.raiseUnexpectedField("Multiple `shard` fields found", "PeersOfShard") + shard = some(reader.readValue(uint16)) + of "peers": + if peers.isSome(): + reader.raiseUnexpectedField("Multiple `peers` fields found", "PeersOfShard") + peers = some(reader.readValue(WakuPeers)) + else: + unrecognizedFieldWarning(value) + + if shard.isNone(): + reader.raiseUnexpectedValue("Field `shard` is missing") + + if peers.isNone(): + reader.raiseUnexpectedValue("Field `peers` are missing") + + value = PeersOfShard(shard: shard.get(), peers: peers.get()) + proc readValue*( reader: var JsonReader[RestJson], value: var FilterTopic ) {.gcsafe, raises: [SerializationError, IOError].} = @@ -195,26 +238,47 @@ proc readValue*( value = FilterSubscription(peerId: peerId.get(), filterCriteria: filterCriteria.get()) -## Utility for populating WakuPeers and ProtocolState -func `==`*(a, b: ProtocolState): bool {.inline.} = - return a.protocol == b.protocol - -func `==`*(a: ProtocolState, b: string): bool {.inline.} = - return a.protocol == b - func `==`*(a, b: WakuPeer): bool {.inline.} = return a.multiaddr == b.multiaddr +proc init*(T: type WakuPeer, peerInfo: RemotePeerInfo): WakuPeer = + result = WakuPeer( + multiaddr: constructMultiaddrStr(peerInfo), + protocols: peerInfo.protocols, + shards: peerInfo.getShards(), + connected: peerInfo.connectedness, + agent: peerInfo.agent, + origin: peerInfo.origin, + score: none(float64), + ) + +proc init*(T: type WakuPeer, pubsubPeer: PubSubPeer, pm: PeerManager): WakuPeer = + let peerInfo = pm.getPeer(pubsubPeer.peerId) + result = WakuPeer( + multiaddr: constructMultiaddrStr(peerInfo), + protocols: peerInfo.protocols, + shards: peerInfo.getShards(), + connected: peerInfo.connectedness, + agent: peerInfo.agent, + origin: peerInfo.origin, + score: some(pubsubPeer.score), + ) + proc add*( peers: var WakuPeers, multiaddr: string, protocol: string, - connected: bool, + shards: seq[uint16], + connected: Connectedness, + agent: string, origin: PeerOrigin, ) = var peer: WakuPeer = WakuPeer( multiaddr: multiaddr, - protocols: @[ProtocolState(protocol: protocol, connected: connected)], + protocols: @[protocol], + shards: shards, + connected: connected, + agent: agent, origin: origin, ) let idx = peers.find(peer) @@ -222,4 +286,4 @@ proc add*( if idx < 0: peers.add(peer) else: - peers[idx].protocols.add(ProtocolState(protocol: protocol, connected: connected)) + peers[idx].protocols.add(protocol) diff --git a/waku/waku_api/rest/debug/client.nim b/waku/waku_api/rest/debug/client.nim index 7048ae98f..c2d588197 100644 --- a/waku/waku_api/rest/debug/client.nim +++ b/waku/waku_api/rest/debug/client.nim @@ -2,7 +2,7 @@ import chronicles, json_serialization, json_serialization/std/options, presto/[route, client] -import ../serdes, ../responses, ../rest_serdes, ./types +import ../serdes, ../rest_serdes, ./types export types diff --git a/waku/waku_api/rest/filter/client.nim b/waku/waku_api/rest/filter/client.nim index b674bc594..db1a6895e 100644 --- a/waku/waku_api/rest/filter/client.nim +++ b/waku/waku_api/rest/filter/client.nim @@ -2,20 +2,12 @@ import json, - std/sets, stew/byteutils, - strformat, chronicles, json_serialization, json_serialization/std/options, presto/[route, client, common] -import - ../../../common/base64, - ../../../waku_core, - ../serdes, - ../responses, - ../rest_serdes, - ./types +import ../../../common/base64, ../serdes, ../rest_serdes, ./types export types diff --git a/waku/waku_api/rest/health/client.nim b/waku/waku_api/rest/health/client.nim index c6f339006..97f4a2c6d 100644 --- a/waku/waku_api/rest/health/client.nim +++ b/waku/waku_api/rest/health/client.nim @@ -1,8 +1,7 @@ {.push raises: [].} -import - chronicles, json_serialization, json_serialization/std/options, presto/[route, client] -import ./types, ../serdes, ../responses, ../rest_serdes, waku/node/health_monitor +import chronicles, json_serialization, presto/[route, client] +import ./types, ../serdes, ../rest_serdes, waku/node/health_monitor logScope: topics = "waku node rest health_api" diff --git a/waku/waku_api/rest/legacy_lightpush/client.nim b/waku/waku_api/rest/legacy_lightpush/client.nim index f0932e99f..a1e442857 100644 --- a/waku/waku_api/rest/legacy_lightpush/client.nim +++ b/waku/waku_api/rest/legacy_lightpush/client.nim @@ -1,15 +1,7 @@ {.push raises: [].} -import - json, - std/sets, - stew/byteutils, - strformat, - chronicles, - json_serialization, - json_serialization/std/options, - presto/[route, client, common] -import ../../../waku_core, ../serdes, ../responses, ../rest_serdes, ./types +import chronicles, json_serialization, presto/[route, client, common] +import ../serdes, ../rest_serdes, ./types export types diff --git a/waku/waku_api/rest/lightpush/handlers.nim b/waku/waku_api/rest/lightpush/handlers.nim index 601aab74c..cafcd89d2 100644 --- a/waku/waku_api/rest/lightpush/handlers.nim +++ b/waku/waku_api/rest/lightpush/handlers.nim @@ -26,18 +26,15 @@ logScope: const FutTimeoutForPushRequestProcessing* = 5.seconds -const NoPeerNoDiscoError = - RestApiResponse.serviceUnavailable("No suitable service peer & no discovery method") - -const NoPeerNoneFoundError = - RestApiResponse.serviceUnavailable("No suitable service peer & none discovered") +const NoPeerNoDiscoError = "No suitable service peer & no discovery method" +const NoPeerNoneFoundError = "No suitable service peer & none discovered" proc useSelfHostedLightPush(node: WakuNode): bool = return node.wakuLightPush != nil and node.wakuLightPushClient == nil proc convertErrorKindToHttpStatus(statusCode: LightpushStatusCode): HttpCode = ## Lightpush status codes are matching HTTP status codes by design - return HttpCode(statusCode.int32) + return toHttpCode(statusCode.int).get(Http500) proc makeRestResponse(response: WakuLightPushResult): RestApiResponse = var httpStatus: HttpCode = Http200 @@ -72,10 +69,11 @@ proc installLightPushRequestHandler*( debug "post", ROUTE_LIGHTPUSH, contentBody let req: PushRequest = decodeRequestBody[PushRequest](contentBody).valueOr: - return RestApiResponse.badRequest("Invalid push request: " & $error) + return + makeRestResponse(lightpushResultBadRequest("Invalid push request! " & $error)) let msg = req.message.toWakuMessage().valueOr: - return RestApiResponse.badRequest("Invalid message: " & $error) + return makeRestResponse(lightpushResultBadRequest("Invalid message! " & $error)) var toPeer = none(RemotePeerInfo) if useSelfHostedLightPush(node): @@ -83,19 +81,23 @@ proc installLightPushRequestHandler*( else: let aPeer = node.peerManager.selectPeer(WakuLightPushCodec).valueOr: let handler = discHandler.valueOr: - return NoPeerNoDiscoError + return makeRestResponse(lightpushResultServiceUnavailable(NoPeerNoDiscoError)) let peerOp = (await handler()).valueOr: - return RestApiResponse.internalServerError("No value in peerOp: " & $error) + return makeRestResponse( + lightpushResultInternalError("No value in peerOp: " & $error) + ) peerOp.valueOr: - return NoPeerNoneFoundError + return + makeRestResponse(lightpushResultServiceUnavailable(NoPeerNoneFoundError)) toPeer = some(aPeer) let subFut = node.lightpushPublish(req.pubsubTopic, msg, toPeer) if not await subFut.withTimeout(FutTimeoutForPushRequestProcessing): error "Failed to request a message push due to timeout!" - return RestApiResponse.serviceUnavailable("Push request timed out") + return + makeRestResponse(lightpushResultServiceUnavailable("Push request timed out")) return makeRestResponse(subFut.value()) diff --git a/waku/waku_api/rest/relay/client.nim b/waku/waku_api/rest/relay/client.nim index 5e72bb609..6956a956d 100644 --- a/waku/waku_api/rest/relay/client.nim +++ b/waku/waku_api/rest/relay/client.nim @@ -1,13 +1,7 @@ {.push raises: [].} -import - std/sets, - stew/byteutils, - chronicles, - json_serialization, - json_serialization/std/options, - presto/[route, client, common] -import ../../../waku_core, ../serdes, ../responses, ../rest_serdes, ./types +import stew/byteutils, chronicles, json_serialization, presto/[route, client, common] +import ../../../waku_core, ../serdes, ../rest_serdes, ./types export types diff --git a/waku/waku_api/rest/serdes.nim b/waku/waku_api/rest/serdes.nim index eb6bc1545..d54d17e78 100644 --- a/waku/waku_api/rest/serdes.nim +++ b/waku/waku_api/rest/serdes.nim @@ -1,9 +1,9 @@ {.push raises: [].} import - std/typetraits, + std/[typetraits, parseutils], results, - stew/byteutils, + stew/[byteutils, base10], chronicles, serialization, json_serialization, @@ -100,3 +100,13 @@ proc encodeString*(value: string): RestResult[string] = proc decodeString*(t: typedesc[string], value: string): RestResult[string] = ok(value) + +proc encodeString*(value: SomeUnsignedInt): RestResult[string] = + ok(Base10.toString(value)) + +proc decodeString*(T: typedesc[SomeUnsignedInt], value: string): RestResult[T] = + let v = Base10.decode(T, value) + if v.isErr(): + return err(v.error()) + else: + return ok(v.get()) diff --git a/waku/waku_archive/driver/queue_driver/index.nim b/waku/waku_archive/driver/queue_driver/index.nim index 113d426d4..17783ebcc 100644 --- a/waku/waku_archive/driver/queue_driver/index.nim +++ b/waku/waku_archive/driver/queue_driver/index.nim @@ -1,6 +1,5 @@ {.push raises: [].} -import stew/byteutils import ../../../waku_core type Index* = object diff --git a/waku/waku_core/peers.nim b/waku/waku_core/peers.nim index fdd3d7948..883f266bd 100644 --- a/waku/waku_core/peers.nim +++ b/waku/waku_core/peers.nim @@ -18,7 +18,7 @@ import libp2p/routing_record, regex, json_serialization -import ../waku_enr/capabilities +import ../waku_enr type Connectedness* = enum @@ -231,7 +231,7 @@ proc parsePeerInfo*(maddrs: varargs[string]): Result[RemotePeerInfo, string] = parsePeerInfo(multiAddresses) -func getTransportProtocol(typedR: TypedRecord): Option[IpTransportProtocol] = +func getTransportProtocol(typedR: enr.TypedRecord): Option[IpTransportProtocol] = if typedR.tcp6.isSome() or typedR.tcp.isSome(): return some(IpTransportProtocol.tcpProtocol) @@ -255,9 +255,9 @@ proc parseUrlPeerAddr*( return ok(some(parsedPeerInfo.value)) -proc toRemotePeerInfo*(enr: enr.Record): Result[RemotePeerInfo, cstring] = +proc toRemotePeerInfo*(enrRec: enr.Record): Result[RemotePeerInfo, cstring] = ## Converts an ENR to dialable RemotePeerInfo - let typedR = TypedRecord.fromRecord(enr) + let typedR = enr.TypedRecord.fromRecord(enrRec) if not typedR.secp256k1.isSome(): return err("enr: no secp256k1 key in record") @@ -303,7 +303,7 @@ proc toRemotePeerInfo*(enr: enr.Record): Result[RemotePeerInfo, cstring] = return err("enr: no addresses in record") let protocolsRes = catch: - enr.getCapabilitiesCodecs() + enrRec.getCapabilitiesCodecs() var protocols: seq[string] if not protocolsRes.isErr(): @@ -312,7 +312,7 @@ proc toRemotePeerInfo*(enr: enr.Record): Result[RemotePeerInfo, cstring] = error "Could not retrieve supported protocols from enr", peerId = peerId, msg = protocolsRes.error.msg - return ok(RemotePeerInfo.init(peerId, addrs, some(enr), protocols)) + return ok(RemotePeerInfo.init(peerId, addrs, some(enrRec), protocols)) converter toRemotePeerInfo*(peerRecord: PeerRecord): RemotePeerInfo = ## Converts peer records to dialable RemotePeerInfo @@ -350,8 +350,8 @@ func hasUdpPort*(peer: RemotePeerInfo): bool = return false let - enr = peer.enr.get() - typedEnr = TypedRecord.fromRecord(enr) + enrRec = peer.enr.get() + typedEnr = enr.TypedRecord.fromRecord(enrRec) typedEnr.udp.isSome() or typedEnr.udp6.isSome() @@ -361,3 +361,18 @@ proc getAgent*(peer: RemotePeerInfo): string = return "unknown" return peer.agent + +proc getShards*(peer: RemotePeerInfo): seq[uint16] = + if peer.enr.isNone(): + return @[] + + let enrRec = peer.enr.get() + let typedRecord = enrRec.toTyped().valueOr: + trace "invalid ENR record", error = error + return @[] + + let shards = typedRecord.relaySharding() + if shards.isSome(): + return shards.get().shardIds + + return @[] diff --git a/waku/waku_enr/sharding.nim b/waku/waku_enr/sharding.nim index 88dc4e200..4ee77bf96 100644 --- a/waku/waku_enr/sharding.nim +++ b/waku/waku_enr/sharding.nim @@ -8,7 +8,7 @@ import eth/keys, libp2p/[multiaddress, multicodec], libp2p/crypto/crypto -import ../common/enr, ../waku_core +import ../common/enr, ../waku_core/topics/pubsub_topic logScope: topics = "waku enr sharding" diff --git a/waku/waku_filter_v2/protocol_metrics.nim b/waku/waku_filter_v2/protocol_metrics.nim index b19f612f3..2d9f63c63 100644 --- a/waku/waku_filter_v2/protocol_metrics.nim +++ b/waku/waku_filter_v2/protocol_metrics.nim @@ -11,7 +11,11 @@ declarePublicGauge waku_filter_subscriptions, "number of subscribed filter clien declarePublicHistogram waku_filter_request_duration_seconds, "duration of filter subscribe requests", ["type"] declarePublicHistogram waku_filter_handle_message_duration_seconds, - "duration to push message to filter subscribers" + "duration to push message to filter subscribers", + buckets = [ + 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0, + 15.0, 20.0, 30.0, Inf, + ] # Error types (metric label values) const diff --git a/waku/waku_filter_v2/subscriptions.nim b/waku/waku_filter_v2/subscriptions.nim index 6b22a94b9..8d3b8084f 100644 --- a/waku/waku_filter_v2/subscriptions.nim +++ b/waku/waku_filter_v2/subscriptions.nim @@ -7,12 +7,7 @@ import libp2p/peerid, libp2p/stream/connection, stew/shims/sets -import - ../waku_core, - ../utils/tableutils, - ../common/rate_limit/setting, - ../node/peer_manager, - ./common +import ../waku_core, ../utils/tableutils, ../node/peer_manager logScope: topics = "waku filter subscriptions" diff --git a/waku/waku_lightpush/callbacks.nim b/waku/waku_lightpush/callbacks.nim index d6700412f..3cfc3fe90 100644 --- a/waku/waku_lightpush/callbacks.nim +++ b/waku/waku_lightpush/callbacks.nim @@ -1,12 +1,11 @@ {.push raises: [].} -import stew/results +import results import ../waku_core, ../waku_relay, ./common, - ./protocol_metrics, ../waku_rln_relay, ../waku_rln_relay/protocol_types diff --git a/waku/waku_lightpush/client.nim b/waku/waku_lightpush/client.nim index 7aa2d9fa9..2f03b0847 100644 --- a/waku/waku_lightpush/client.nim +++ b/waku/waku_lightpush/client.nim @@ -65,9 +65,13 @@ proc sendPushRequest( proc publish*( wl: WakuLightPushClient, pubSubTopic: Option[PubsubTopic] = none(PubsubTopic), - message: WakuMessage, + wakuMessage: WakuMessage, peer: PeerId | RemotePeerInfo, ): Future[WakuLightPushResult] {.async, gcsafe.} = + var message = wakuMessage + if message.timestamp == 0: + message.timestamp = getNowInNanosecondTime() + when peer is PeerId: info "publish", peerId = shortLog(peer), @@ -88,11 +92,15 @@ proc publish*( return lightpushSuccessResult(publishedCount) proc publishToAny*( - wl: WakuLightPushClient, pubSubTopic: PubsubTopic, message: WakuMessage + wl: WakuLightPushClient, pubSubTopic: PubsubTopic, wakuMessage: WakuMessage ): Future[WakuLightPushResult] {.async, gcsafe.} = ## This proc is similar to the publish one but in this case ## we don't specify a particular peer and instead we get it from peer manager + var message = wakuMessage + if message.timestamp == 0: + message.timestamp = getNowInNanosecondTime() + info "publishToAny", msg_hash = computeMessageHash(pubsubTopic, message).to0xHex let peer = wl.peerManager.selectPeer(WakuLightPushCodec).valueOr: diff --git a/waku/waku_lightpush/common.nim b/waku/waku_lightpush/common.nim index c9f39cca2..4c2984e8f 100644 --- a/waku/waku_lightpush/common.nim +++ b/waku/waku_lightpush/common.nim @@ -42,6 +42,12 @@ func lightpushSuccessResult*(relayPeerCount: uint32): WakuLightPushResult = func lightpushResultInternalError*(msg: string): WakuLightPushResult = return err((LightpushStatusCode.INTERNAL_SERVER_ERROR, some(msg))) +func lightpushResultBadRequest*(msg: string): WakuLightPushResult = + return err((LightpushStatusCode.BAD_REQUEST, some(msg))) + +func lightpushResultServiceUnavailable*(msg: string): WakuLightPushResult = + return err((LightpushStatusCode.SERVICE_NOT_AVAILABLE, some(msg))) + func lighpushErrorResult*( statusCode: LightpushStatusCode, desc: Option[string] ): WakuLightPushResult = @@ -78,5 +84,3 @@ func mapPubishingErrorToPushResult*( some("Error generating message id, skipping publish"), ) ) - else: - return err((LightpushStatusCode.INTERNAL_SERVER_ERROR, none[string]())) diff --git a/waku/waku_lightpush/protocol.nim b/waku/waku_lightpush/protocol.nim index e2b096bc9..57a95e107 100644 --- a/waku/waku_lightpush/protocol.nim +++ b/waku/waku_lightpush/protocol.nim @@ -75,12 +75,13 @@ proc handleRequest*( waku_lightpush_v3_messages.inc(labelValues = ["PushRequest"]) + let msg_hash = pubsubTopic.computeMessageHash(pushRequest.message).to0xHex() notice "handling lightpush request", my_peer_id = wl.peerManager.switch.peerInfo.peerId, peer_id = peerId, requestId = pushRequest.requestId, pubsubTopic = pushRequest.pubsubTopic, - msg_hash = pubsubTopic.computeMessageHash(pushRequest.message).to0xHex(), + msg_hash = msg_hash, receivedTime = getNowInNanosecondTime() let handleRes = await wl.pushHandler(peerId, pubsubTopic, pushRequest.message) diff --git a/waku/waku_lightpush/self_req_handler.nim b/waku/waku_lightpush/self_req_handler.nim index fffced40a..06a0d3715 100644 --- a/waku/waku_lightpush/self_req_handler.nim +++ b/waku/waku_lightpush/self_req_handler.nim @@ -9,15 +9,8 @@ ## which spawn a full service Waku node ## that could be used also as a lightpush client, helping testing and development. -import results, chronos, chronicles, std/options, metrics, stew/byteutils -import - ../waku_core, - ./protocol, - ./common, - ./rpc, - ./rpc_codec, - ./protocol_metrics, - ../utils/requests +import results, chronos, std/options, metrics +import ../waku_core, ./protocol, ./common, ./rpc, ./rpc_codec, ../utils/requests proc handleSelfLightPushRequest*( self: WakuLightPush, pubSubTopic: Option[PubsubTopic], message: WakuMessage diff --git a/waku/waku_lightpush_legacy/client.nim b/waku/waku_lightpush_legacy/client.nim index c3b4a158e..503cbe1eb 100644 --- a/waku/waku_lightpush_legacy/client.nim +++ b/waku/waku_lightpush_legacy/client.nim @@ -72,10 +72,15 @@ proc sendPushRequest( proc publish*( wl: WakuLegacyLightPushClient, pubSubTopic: PubsubTopic, - message: WakuMessage, + wakuMessage: WakuMessage, peer: RemotePeerInfo, ): Future[WakuLightPushResult[string]] {.async, gcsafe.} = ## On success, returns the msg_hash of the published message + + var message = wakuMessage + if message.timestamp == 0: + message.timestamp = getNowInNanosecondTime() + let msg_hash_hex_str = computeMessageHash(pubsubTopic, message).to0xHex() let pushRequest = PushRequest(pubSubTopic: pubSubTopic, message: message) ?await wl.sendPushRequest(pushRequest, peer) diff --git a/waku/waku_lightpush_legacy/protocol.nim b/waku/waku_lightpush_legacy/protocol.nim index feb6a1320..5de25ead9 100644 --- a/waku/waku_lightpush_legacy/protocol.nim +++ b/waku/waku_lightpush_legacy/protocol.nim @@ -42,12 +42,14 @@ proc handleRequest*( pubSubTopic = request.get().pubSubTopic message = request.get().message + let msg_hash = pubsubTopic.computeMessageHash(message).to0xHex() waku_lightpush_messages.inc(labelValues = ["PushRequest"]) + notice "handling lightpush request", peer_id = peerId, requestId = requestId, pubsubTopic = pubsubTopic, - msg_hash = pubsubTopic.computeMessageHash(message).to0xHex(), + msg_hash = msg_hash, receivedTime = getNowInNanosecondTime() let handleRes = await wl.pushHandler(peerId, pubsubTopic, message) diff --git a/waku/waku_noise/noise_types.nim b/waku/waku_noise/noise_types.nim index 3d288a242..3b88c43e8 100644 --- a/waku/waku_noise/noise_types.nim +++ b/waku/waku_noise/noise_types.nim @@ -11,7 +11,7 @@ import std/[options, tables] import chronos import chronicles import bearssl -import nimcrypto/[sha2, hmac] +import nimcrypto/sha2 import libp2p/errors import libp2p/crypto/[crypto, chacha20poly1305, curve25519] diff --git a/waku/waku_noise/noise_utils.nim b/waku/waku_noise/noise_utils.nim index a612c0728..babab1ca4 100644 --- a/waku/waku_noise/noise_utils.nim +++ b/waku/waku_noise/noise_utils.nim @@ -9,8 +9,9 @@ import std/[algorithm, base64, oids, options, strutils, tables, sequtils] import chronos import chronicles import bearssl/rand -import stew/[results, endians2, byteutils] -import nimcrypto/[sha2, hmac] +import results +import stew/[endians2, byteutils] +import nimcrypto/sha2 import libp2p/crypto/[chacha20poly1305, curve25519, hkdf] diff --git a/waku/waku_relay/protocol.nim b/waku/waku_relay/protocol.nim index 126ff608c..4eeaf4607 100644 --- a/waku/waku_relay/protocol.nim +++ b/waku/waku_relay/protocol.nim @@ -323,31 +323,42 @@ proc addObserver*(w: WakuRelay, observer: PubSubObserver) {.gcsafe.} = proc getDHigh*(T: type WakuRelay): int = return GossipsubParameters.dHigh -proc getPeersInMesh*( +proc getPubSubPeersInMesh*( w: WakuRelay, pubsubTopic: PubsubTopic -): Result[seq[PeerId], string] = - ## Returns the list of peerIds in a mesh defined by the passed pubsub topic. +): Result[HashSet[PubSubPeer], string] = + ## Returns the list of PubSubPeers in a mesh defined by the passed pubsub topic. ## The 'mesh' atribute is defined in the GossipSub ref object. if not w.mesh.hasKey(pubsubTopic): - debug "getPeersInMesh - there is no mesh peer for the given pubsub topic", + debug "getPubSubPeersInMesh - there is no mesh peer for the given pubsub topic", pubsubTopic = pubsubTopic - return ok(newSeq[PeerId]()) + return ok(initHashSet[PubSubPeer]()) let peersRes = catch: w.mesh[pubsubTopic] let peers: HashSet[PubSubPeer] = peersRes.valueOr: - return err("getPeersInMesh - exception accessing " & pubsubTopic & ": " & error.msg) + return err( + "getPubSubPeersInMesh - exception accessing " & pubsubTopic & ": " & error.msg + ) - let peerIds = toSeq(peers).mapIt(it.peerId) + return ok(peers) + +proc getPeersInMesh*( + w: WakuRelay, pubsubTopic: PubsubTopic +): Result[seq[PeerId], string] = + ## Returns the list of peerIds in a mesh defined by the passed pubsub topic. + ## The 'mesh' atribute is defined in the GossipSub ref object. + let pubSubPeers = w.getPubSubPeersInMesh(pubsubTopic).valueOr: + return err(error) + let peerIds = toSeq(pubSubPeers).mapIt(it.peerId) return ok(peerIds) proc getNumPeersInMesh*(w: WakuRelay, pubsubTopic: PubsubTopic): Result[int, string] = ## Returns the number of peers in a mesh defined by the passed pubsub topic. - let peers = w.getPeersInMesh(pubsubTopic).valueOr: + let peers = w.getPubSubPeersInMesh(pubsubTopic).valueOr: return err( "getNumPeersInMesh - failed retrieving peers in mesh: " & pubsubTopic & ": " & error @@ -533,11 +544,15 @@ proc unsubscribe*(w: WakuRelay, pubsubTopic: PubsubTopic, handler: TopicHandler) procCall GossipSub(w).unsubscribe(pubsubTopic, handler) proc publish*( - w: WakuRelay, pubsubTopic: PubsubTopic, message: WakuMessage + w: WakuRelay, pubsubTopic: PubsubTopic, wakuMessage: WakuMessage ): Future[Result[int, PublishOutcome]] {.async.} = if pubsubTopic.isEmptyOrWhitespace(): return err(NoTopicSpecified) + var message = wakuMessage + if message.timestamp == 0: + message.timestamp = getNowInNanosecondTime() + let data = message.encode().buffer let msgHash = computeMessageHash(pubsubTopic, message).to0xHex() @@ -553,18 +568,17 @@ proc publish*( return ok(relayedPeerCount) -proc getConnectedPeers*( +proc getConnectedPubSubPeers*( w: WakuRelay, pubsubTopic: PubsubTopic -): Result[seq[PeerId], string] = +): Result[HashSet[PubsubPeer], string] = ## Returns the list of peerIds of connected peers and subscribed to the passed pubsub topic. ## The 'gossipsub' atribute is defined in the GossipSub ref object. if pubsubTopic == "": ## Return all the connected peers - var peerIds = newSeq[PeerId]() + var peerIds = initHashSet[PubsubPeer]() for k, v in w.gossipsub: - peerIds.add(toSeq(v).mapIt(it.peerId)) - # alternatively: peerIds &= toSeq(v).mapIt(it.peerId) + peerIds = peerIds + v return ok(peerIds) if not w.gossipsub.hasKey(pubsubTopic): @@ -580,6 +594,17 @@ proc getConnectedPeers*( return err("getConnectedPeers - exception accessing " & pubsubTopic & ": " & error.msg) + return ok(peers) + +proc getConnectedPeers*( + w: WakuRelay, pubsubTopic: PubsubTopic +): Result[seq[PeerId], string] = + ## Returns the list of peerIds of connected peers and subscribed to the passed pubsub topic. + ## The 'gossipsub' atribute is defined in the GossipSub ref object. + + let peers = w.getConnectedPubSubPeers(pubsubTopic).valueOr: + return err(error) + let peerIds = toSeq(peers).mapIt(it.peerId) return ok(peerIds) @@ -589,7 +614,7 @@ proc getNumConnectedPeers*( ## Returns the number of connected peers and subscribed to the passed pubsub topic. ## Return all the connected peers - let peers = w.getConnectedPeers(pubsubTopic).valueOr: + let peers = w.getConnectedPubSubPeers(pubsubTopic).valueOr: return err( "getNumConnectedPeers - failed retrieving peers in mesh: " & pubsubTopic & ": " & error diff --git a/waku/waku_rln_relay/conversion_utils.nim b/waku/waku_rln_relay/conversion_utils.nim index a9e7f1f11..91fef6e3e 100644 --- a/waku/waku_rln_relay/conversion_utils.nim +++ b/waku/waku_rln_relay/conversion_utils.nim @@ -78,6 +78,21 @@ proc serialize*( ) return output +proc serialize*(witness: RLNWitnessInput): seq[byte] = + ## Serializes the witness into a byte array according to the RLN protocol format + var buffer: seq[byte] + buffer.add(@(witness.identity_secret)) + buffer.add(@(witness.user_message_limit)) + buffer.add(@(witness.message_id)) + buffer.add(toBytes(uint64(witness.path_elements.len / 32), Endianness.littleEndian)) + for element in witness.path_elements: + buffer.add(element) + buffer.add(toBytes(uint64(witness.path_elements.len / 32), Endianness.littleEndian)) + buffer.add(witness.identity_path_index) + buffer.add(@(witness.x)) + buffer.add(@(witness.external_nullifier)) + return buffer + proc serialize*(proof: RateLimitProof, data: openArray[byte]): seq[byte] = ## a private proc to convert RateLimitProof and data to a byte seq ## this conversion is used in the proof verification proc diff --git a/waku/waku_rln_relay/group_manager/group_manager_base.nim b/waku/waku_rln_relay/group_manager/group_manager_base.nim index ae47f682c..454c9d67c 100644 --- a/waku/waku_rln_relay/group_manager/group_manager_base.nim +++ b/waku/waku_rln_relay/group_manager/group_manager_base.nim @@ -145,6 +145,7 @@ method validateRoot*( g: GroupManager, root: MerkleNode ): bool {.base, gcsafe, raises: [].} = ## validates the root against the valid roots queue +<<<<<<< HEAD # Print all validRoots in one line with square brackets var rootsStr = "[" var first = true @@ -156,6 +157,8 @@ method validateRoot*( rootsStr.add("]") debug "Valid Merkle roots in validateRoot", roots = rootsStr, root_to_validate = root # Check if the root is in the valid roots queue +======= +>>>>>>> deprecate_sync_strategy if g.indexOfRoot(root) >= 0: return true return false @@ -200,8 +203,6 @@ method generateProof*( if g.userMessageLimit.isNone(): return err("user message limit is not set") - debug "calling proofGen from generateProof from group_manager_base", data = data - waku_rln_proof_generation_duration_seconds.nanosecondTime: let proof = proofGen( rlnInstance = g.rlnInstance, diff --git a/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim b/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim index 8f1b37c08..19419ec00 100644 --- a/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim +++ b/waku/waku_rln_relay/group_manager/on_chain/group_manager.nim @@ -10,10 +10,9 @@ import nimcrypto/keccak as keccak, stint, json, - std/tables, + std/[strutils, tables, algorithm], stew/[byteutils, arrayops], - sequtils, - strutils + sequtils import ../../../waku_keystore, ../../rln, @@ -22,16 +21,13 @@ import ../group_manager_base, ./retry_wrapper -from strutils import parseHexInt - export group_manager_base logScope: topics = "waku rln_relay onchain_group_manager" -type EthereumUInt40* = StUint[40] -type EthereumUInt32* = StUint[32] -type EthereumUInt16* = StUint[16] +type UInt40* = StUint[40] +type UInt32* = StUint[32] # using the when predicate does not work within the contract macro, hence need to dupe contract(WakuRlnContract): @@ -68,7 +64,7 @@ type keystorePassword*: Option[string] registrationHandler*: Option[RegistrationHandler] latestProcessedBlock*: BlockNumber - merkleProofCache*: seq[array[32, byte]] + merkleProofCache*: seq[byte] proc setMetadata*( g: OnchainGroupManager, lastProcessedBlock = none(BlockNumber) @@ -93,47 +89,28 @@ proc setMetadata*( return err("failed to persist rln metadata: " & getCurrentExceptionMsg()) return ok() -proc toArray32LE*(x: UInt256): array[32, byte] {.inline.} = - ## Convert UInt256 to byte array without endianness conversion - when nimvm: - for i in 0 ..< 32: - result[i] = byte((x shr (i * 8)).truncate(uint8) and 0xff) - else: - copyMem(addr result, unsafeAddr x, 32) +proc uint64ToField*(n: uint64): array[32, byte] = + ## Converts uint64 to 32-byte little-endian array with zero padding + var bytes = toBytes(n, Endianness.littleEndian) + result[0 ..< bytes.len] = bytes -# Hashes arbitrary signal to the underlying prime field. -proc hash_to_field*(signal: seq[byte]): array[32, byte] = - var ctx: keccak256 - ctx.init() - ctx.update(signal) - var hash = ctx.finish() +proc UInt256ToField*(v: UInt256): array[32, byte] = + return cast[array[32, byte]](v) - var result: array[32, byte] - copyMem(result[0].addr, hash.data[0].addr, 32) - return result +proc seqToField*(s: seq[byte]): array[32, byte] = + result = default(array[32, byte]) + let len = min(s.len, 32) + for i in 0 ..< len: + result[i] = s[i] -proc toArray32LE*(x: array[32, byte]): array[32, byte] = - for i in 0 ..< 32: - result[i] = x[31 - i] - return result - -proc toArray32LE*(s: seq[byte]): array[32, byte] = - var output: array[32, byte] - for i in 0 ..< 32: - output[i] = 0 - for i in 0 ..< 32: - output[i] = s[31 - i] - return output - -proc toArray32LE*(v: uint64): array[32, byte] = - let bytes = toBytes(v, Endianness.littleEndian) - var output: array[32, byte] - discard output.copyFrom(bytes) - return output +proc uint64ToIndex(index: MembershipIndex, depth: int): seq[byte] = + result = newSeq[byte](depth) + for i in 0 ..< depth: + result[i] = byte((index shr i) and 1) # LSB-first bit decomposition proc fetchMerkleProofElements*( g: OnchainGroupManager -): Future[Result[seq[array[32, byte]], string]] {.async.} = +): Future[Result[seq[byte], string]] {.async.} = try: let membershipIndex = g.membershipIndex.get() let index40 = stuint(membershipIndex, 40) @@ -158,30 +135,7 @@ proc fetchMerkleProofElements*( let responseBytes = await g.ethRpc.get().provider.eth_call(tx, "latest") - debug "---- raw response ----", - total_bytes = responseBytes.len, # Should be 640 - non_zero_bytes = responseBytes.countIt(it != 0), - response = responseBytes - - var i = 0 - var merkleProof = newSeq[array[32, byte]]() - while (i * 32) + 31 < responseBytes.len: - var element: array[32, byte] - let startIndex = i * 32 - let endIndex = startIndex + 31 - element = responseBytes.toOpenArray(startIndex, endIndex) - merkleProof.add(element) - i += 1 - debug "---- element ----", - startIndex = startIndex, - startElement = responseBytes[startIndex], - endIndex = endIndex, - endElement = responseBytes[endIndex], - element = element - - # debug "merkleProof", responseBytes = responseBytes, merkleProof = merkleProof - - return ok(merkleProof) + return ok(responseBytes) except CatchableError: error "Failed to fetch Merkle proof elements", errMsg = getCurrentExceptionMsg(), index = g.membershipIndex.get() @@ -189,7 +143,7 @@ proc fetchMerkleProofElements*( proc fetchMerkleRoot*( g: OnchainGroupManager -): Future[Result[Uint256, string]] {.async.} = +): Future[Result[UInt256, string]] {.async.} = try: let merkleRootInvocation = g.wakuRlnContract.get().root() let merkleRoot = await merkleRootInvocation.call() @@ -217,18 +171,14 @@ proc updateRoots*(g: OnchainGroupManager): Future[bool] {.async.} = if rootRes.isErr(): return false - let merkleRoot = toArray32LE(rootRes.get()) + let merkleRoot = UInt256ToField(rootRes.get()) if g.validRoots.len == 0: g.validRoots.addLast(merkleRoot) return true - debug "--- validRoots ---", rootRes = rootRes.get(), validRoots = merkleRoot - if g.validRoots[g.validRoots.len - 1] != merkleRoot: - var overflow = g.validRoots.len - AcceptableRootWindowSize + 1 - while overflow > 0: + if g.validRoots.len > AcceptableRootWindowSize: discard g.validRoots.popFirst() - overflow = overflow - 1 g.validRoots.addLast(merkleRoot) return true @@ -244,16 +194,11 @@ proc trackRootChanges*(g: OnchainGroupManager) {.async.} = while true: let rootUpdated = await g.updateRoots() - let proofResult = await g.fetchMerkleProofElements() - if proofResult.isErr(): - error "Failed to fetch Merkle proof", error = proofResult.error - g.merkleProofCache = proofResult.get() - - debug "--- track update ---", - len = g.validRoots.len, - validRoots = g.validRoots, - merkleProof = g.merkleProofCache - + if rootUpdated: + let proofResult = await g.fetchMerkleProofElements() + if proofResult.isErr(): + error "Failed to fetch Merkle proof", error = proofResult.error + g.merkleProofCache = proofResult.get() await sleepAsync(rpcDelay) method atomicBatch*( @@ -357,69 +302,30 @@ method withdrawBatch*( ): Future[void] {.async: (raises: [Exception]).} = initializedGuard(g) -proc indexToPath*(membershipIndex: uint, tree_depth: int): seq[byte] = - result = newSeq[byte](tree_depth) - var idx = membershipIndex +proc getRootFromProofAndIndex( + g: OnchainGroupManager, elements: seq[byte], bits: seq[byte] +): GroupManagerResult[array[32, byte]] = + # Compute leaf hash from idCommitment and messageLimit + let messageLimitField = uint64ToField(g.userMessageLimit.get()) + let leafHashRes = poseidon(@[g.idCredentials.get().idCommitment, @messageLimitField]) + if leafHashRes.isErr(): + return err("Failed to compute leaf hash: " & leafHashRes.error) - for i in 0 ..< tree_depth: - let bit = (idx shr (tree_depth - 1 - i)) and 1 - result[i] = byte(bit) + var hash = leafHashRes.get() + for i in 0 ..< bits.len: + let sibling = elements[i * 32 .. (i + 1) * 32 - 1] - debug "indexToPath", index = membershipIndex, path = result + let hashRes = + if bits[i] == 0: + poseidon(@[@hash, sibling]) + else: + poseidon(@[sibling, @hash]) -proc createZerokitWitness( - g: OnchainGroupManager, - data: seq[byte], - epoch: Epoch, - messageId: MessageId, - extNullifier: array[32, byte], -): RLNWitnessInput = - let identitySecret = g.idCredentials.get().idSecretHash.toArray32LE() - # seq[byte] to array[32, byte] and convert to little-endian - let userMsgLimit = g.userMessageLimit.get().toArray32LE() - # uint64 to array[32, byte] and convert to little-endian - let msgId = messageId.toArray32LE() - # uint64 to array[32, byte] and convert to little-endian + hash = hashRes.valueOr: + return err("Failed to compute poseidon hash: " & error) + hash = hashRes.get() - try: - discard waitFor g.updateRoots() - except CatchableError: - error "Error updating roots", error = getCurrentExceptionMsg() - - try: - let proofResult = waitFor g.fetchMerkleProofElements() - if proofResult.isErr(): - error "Failed to fetch Merkle proof", error = proofResult.error - g.merkleProofCache = proofResult.get() - except CatchableError: - error "Error fetching Merkle proof", error = getCurrentExceptionMsg() - - var pathElements: seq[array[32, byte]] - for elem in g.merkleProofCache: - pathElements.add(toArray32LE(elem)) # convert every element to little-endian - - # Convert index to byte array (no endianness needed for path index) - let pathIndex = indexToPath(g.membershipIndex.get(), pathElements.len) - # uint to seq[byte] - - debug "---- pathElements & pathIndex -----", - pathElements = pathElements, - pathIndex = pathIndex, - pathElementsLength = pathElements.len, - pathIndexLength = pathIndex.len - - # Calculate hash using zerokit's hash_to_field equivalent - let x = hash_to_field(data).toArray32LE() # convert to little-endian - - RLNWitnessInput( - identity_secret: identitySecret, - user_message_limit: userMsgLimit, - message_id: msgId, - path_elements: pathElements, - identity_path_index: pathIndex, - x: x, - external_nullifier: extNullifier, - ) + return ok(hash) method generateProof*( g: OnchainGroupManager, @@ -437,39 +343,67 @@ method generateProof*( if g.userMessageLimit.isNone(): return err("user message limit is not set") - debug "calling generateProof from group_manager onchain", - data = data, - membershipIndex = g.membershipIndex.get(), - userMessageLimit = g.userMessageLimit.get() - - let externalNullifierRes = - poseidon(@[hash_to_field(@epoch).toSeq(), hash_to_field(@rlnIdentifier).toSeq()]) - let extNullifier = externalNullifierRes.get().toArray32LE() + try: + discard waitFor g.updateRoots() + except CatchableError: + error "Failed to update roots", error = getCurrentExceptionMsg() try: let proofResult = waitFor g.fetchMerkleProofElements() if proofResult.isErr(): - return err("Failed to fetch Merkle proof: " & proofResult.error) +<<<<<<< HEAD + error "Failed to fetch Merkle proof", error = proofResult.error g.merkleProofCache = proofResult.get() except CatchableError: - error "Failed to fetch merkle proof", error = getCurrentExceptionMsg() - let witness = createZerokitWitness(g, data, epoch, messageId, extNullifier) + if (g.merkleProofCache.len mod 32) != 0: + return err("Invalid merkle proof cache length") + + let identity_secret = seqToField(g.idCredentials.get().idSecretHash) + let user_message_limit = uint64ToField(g.userMessageLimit.get()) + let message_id = uint64ToField(messageId) + var path_elements = newSeq[byte](0) + + if (g.merkleProofCache.len mod 32) != 0: + return err("Invalid merkle proof cache length") + + let identity_path_index = uint64ToIndex(g.membershipIndex.get(), 20) + for i in 0 ..< g.merkleProofCache.len div 32: + let chunk = g.merkleProofCache[i * 32 .. (i + 1) * 32 - 1] + path_elements.add(chunk.reversed()) + + let x = keccak.keccak256.digest(data) + + let extNullifierRes = poseidon(@[@(epoch), @(rlnIdentifier)]) + if extNullifierRes.isErr(): + return err("Failed to compute external nullifier: " & extNullifierRes.error) + let extNullifier = extNullifierRes.get() + + let witness = RLNWitnessInput( + identity_secret: identity_secret, + user_message_limit: user_message_limit, + message_id: message_id, + path_elements: path_elements, + identity_path_index: identity_path_index, + x: x, + external_nullifier: extNullifier, + ) let serializedWitness = serialize(witness) - var inputBuffer = toBuffer(serializedWitness) + + var input_witness_buffer = toBuffer(serializedWitness) # Generate the proof using the zerokit API - var outputBuffer: Buffer - let success = - generate_proof_with_witness(g.rlnInstance, addr inputBuffer, addr outputBuffer) - if not success: + var output_witness_buffer: Buffer + let witness_success = generate_proof_with_witness( + g.rlnInstance, addr input_witness_buffer, addr output_witness_buffer + ) + + if not witness_success: return err("Failed to generate proof") - else: - debug "Proof generated successfully" # Parse the proof into a RateLimitProof object - var proofValue = cast[ptr array[320, byte]](outputBuffer.`ptr`) + var proofValue = cast[ptr array[320, byte]](output_witness_buffer.`ptr`) let proofBytes: array[320, byte] = proofValue[] ## parse the proof as [ proof<128> | root<32> | external_nullifier<32> | share_x<32> | share_y<32> | nullifier<32> ] @@ -506,49 +440,52 @@ method generateProof*( shareY: shareY, nullifier: nullifier, ) + + debug "Proof generated successfully" + waku_rln_remaining_proofs_per_epoch.dec() waku_rln_total_generated_proofs.inc() return ok(output) method verifyProof*( - g: OnchainGroupManager, input: openArray[byte], proof: RateLimitProof + g: OnchainGroupManager, # verifier context + input: seq[byte], # raw message data (signal) + proof: RateLimitProof, # proof received from the peer ): GroupManagerResult[bool] {.gcsafe, raises: [].} = - ## verifies the proof, returns an error if the proof verification fails - ## returns true if the proof is valid + ## -- Verifies an RLN rate-limit proof against the set of valid Merkle roots -- + var normalizedProof = proof - # when we do this, we ensure that we compute the proof for the derived value - # of the externalNullifier. The proof verification will fail if a malicious peer - # attaches invalid epoch+rlnidentifier pair + let extNullRes = poseidon(@[@(proof.epoch), @(proof.rlnIdentifier)]) + if extNullRes.isErr(): + return err("could not construct external nullifier: " & extNullRes.error) + normalizedProof.externalNullifier = extNullRes.get() - normalizedProof.externalNullifier = poseidon( - @[@(proof.epoch), @(proof.rlnIdentifier)] - ).valueOr: - return err("could not construct the external nullifier") - var - proofBytes = serialize(normalizedProof, input) - proofBuffer = proofBytes.toBuffer() - validProof: bool - rootsBytes = serialize(g.validRoots.items().toSeq()) - rootsBuffer = rootsBytes.toBuffer() + let proofBytes = serialize(normalizedProof, input) + let proofBuffer = proofBytes.toBuffer() - trace "serialized proof", proof = byteutils.toHex(proofBytes) + let rootsBytes = serialize(g.validRoots.items().toSeq()) + let rootsBuffer = rootsBytes.toBuffer() - let verifyIsSuccessful = verify_with_roots( - g.rlnInstance, addr proofBuffer, addr rootsBuffer, addr validProof + var validProof: bool # out-param + let ffiOk = verify_with_roots( + g.rlnInstance, # RLN context created at init() + addr proofBuffer, # (proof + signal) + addr rootsBuffer, # valid Merkle roots + addr validProof # will be set by the FFI call + , ) - if not verifyIsSuccessful: - # something went wrong in verification call - warn "could not verify validity of the proof", proof = proof - return err("could not verify the proof") - if not validProof: - return ok(false) + if not ffiOk: + warn "verify_with_roots() returned failure status", proof = proof + return err("could not verify the proof") else: - return ok(true) + debug "Proof verified successfully !" + + return ok(validProof) +>>>>>>> deprecate_sync_strategy method onRegister*(g: OnchainGroupManager, cb: OnRegisterCallback) {.gcsafe.} = g.registerCb = some(cb) - method onWithdraw*(g: OnchainGroupManager, cb: OnWithdrawCallback) {.gcsafe.} = g.withdrawCb = some(cb) diff --git a/waku/waku_rln_relay/protocol_types.nim b/waku/waku_rln_relay/protocol_types.nim index ec85de05f..41372bef3 100644 --- a/waku/waku_rln_relay/protocol_types.nim +++ b/waku/waku_rln_relay/protocol_types.nim @@ -59,7 +59,7 @@ type identity_secret*: Fr user_message_limit*: Fr message_id*: Fr - path_elements*: seq[Fr] + path_elements*: seq[byte] identity_path_index*: seq[byte] x*: Fr external_nullifier*: Fr diff --git a/waku/waku_rln_relay/rln_relay.nim b/waku/waku_rln_relay/rln_relay.nim index 5dba0ad65..8e64f2fde 100644 --- a/waku/waku_rln_relay/rln_relay.nim +++ b/waku/waku_rln_relay/rln_relay.nim @@ -250,6 +250,7 @@ proc validateMessage*( waku_rln_errors_total.inc(labelValues = ["proof_verification"]) warn "invalid message: proof verification failed", payloadLen = msg.payload.len return MessageValidationResult.Invalid + if not proofVerificationRes.value(): # invalid proof warn "invalid message: invalid proof", payloadLen = msg.payload.len diff --git a/waku/waku_store_sync/protocols_metrics.nim b/waku/waku_store_sync/protocols_metrics.nim index 2d2776674..53595f931 100644 --- a/waku/waku_store_sync/protocols_metrics.nim +++ b/waku/waku_store_sync/protocols_metrics.nim @@ -8,10 +8,17 @@ const declarePublicHistogram reconciliation_roundtrips, "the nubmer of roundtrips for each reconciliation", - buckets = [0.0, 1.0, 2.0, 3.0, 5.0, 10.0, Inf] + buckets = [1.0, 2.0, 3.0, 5.0, 8.0, 13.0, Inf] -declarePublicSummary total_bytes_exchanged, +declarePublicHistogram reconciliation_differences, + "the nubmer of differences for each reconciliation", + buckets = [0.0, 10.0, 50.0, 100.0, 500.0, 1000.0, 5000.0, Inf] + +declarePublicCounter total_bytes_exchanged, "the number of bytes sent and received by the protocols", ["protocol", "direction"] declarePublicCounter total_transfer_messages_exchanged, "the number of messages sent and received by the transfer protocol", ["direction"] + +declarePublicGauge total_messages_cached, + "the number of messages cached by the node after prunning" diff --git a/waku/waku_store_sync/reconciliation.nim b/waku/waku_store_sync/reconciliation.nim index 80c025140..c08a9e434 100644 --- a/waku/waku_store_sync/reconciliation.nim +++ b/waku/waku_store_sync/reconciliation.nim @@ -96,19 +96,23 @@ proc messageIngress*(self: SyncReconciliation, id: SyncID) = proc processRequest( self: SyncReconciliation, conn: Connection ): Future[Result[void, string]] {.async.} = - var roundTrips = 0 + var + roundTrips = 0 + diffs = 0 while true: let readRes = catch: await conn.readLp(int.high) let buffer: seq[byte] = readRes.valueOr: - return err("connection read error: " & error.msg) + await conn.close() + return err("remote " & $conn.peerId & " connection read error: " & error.msg) - total_bytes_exchanged.observe(buffer.len, labelValues = [Reconciliation, Receiving]) + total_bytes_exchanged.inc(buffer.len, labelValues = [Reconciliation, Receiving]) let recvPayload = RangesData.deltaDecode(buffer).valueOr: - return err("payload decoding error: " & error) + await conn.close() + return err("remote " & $conn.peerId & " payload decoding error: " & error) roundTrips.inc() @@ -136,21 +140,23 @@ proc processRequest( for hash in hashToSend: self.remoteNeedsTx.addLastNoWait((conn.peerId, hash)) + diffs.inc() for hash in hashToRecv: self.localWantsTx.addLastNoWait((conn.peerId, hash)) + diffs.inc() rawPayload = sendPayload.deltaEncode() - total_bytes_exchanged.observe( - rawPayload.len, labelValues = [Reconciliation, Sending] - ) + total_bytes_exchanged.inc(rawPayload.len, labelValues = [Reconciliation, Sending]) let writeRes = catch: await conn.writeLP(rawPayload) if writeRes.isErr(): - return err("connection write error: " & writeRes.error.msg) + await conn.close() + return + err("remote " & $conn.peerId & " connection write error: " & writeRes.error.msg) trace "sync payload sent", local = self.peerManager.switch.peerInfo.peerId, @@ -163,6 +169,7 @@ proc processRequest( continue reconciliation_roundtrips.observe(roundTrips) + reconciliation_differences.observe(diffs) await conn.close() @@ -188,20 +195,21 @@ proc initiate( let sendPayload = initPayload.deltaEncode() - total_bytes_exchanged.observe( - sendPayload.len, labelValues = [Reconciliation, Sending] - ) + total_bytes_exchanged.inc(sendPayload.len, labelValues = [Reconciliation, Sending]) let writeRes = catch: await connection.writeLP(sendPayload) if writeRes.isErr(): - return err("connection write error: " & writeRes.error.msg) + await connection.close() + return err( + "remote " & $connection.peerId & " connection write error: " & writeRes.error.msg + ) trace "sync payload sent", local = self.peerManager.switch.peerInfo.peerId, remote = connection.peerId, - payload = sendPayload + payload = initPayload ?await self.processRequest(connection) @@ -217,7 +225,7 @@ proc storeSynchronization*( let connOpt = await self.peerManager.dialPeer(peer, WakuReconciliationCodec) let conn: Connection = connOpt.valueOr: - return err("cannot establish sync connection") + return err("fail to dial remote " & $peer.peerId) debug "sync session initialized", local = self.peerManager.switch.peerInfo.peerId, remote = conn.peerId @@ -354,6 +362,8 @@ proc periodicPrune(self: SyncReconciliation) {.async.} = let count = self.storage.prune(time) + total_messages_cached.set(self.storage.length()) + debug "periodic prune done", elements_pruned = count proc idsReceiverLoop(self: SyncReconciliation) {.async.} = diff --git a/waku/waku_store_sync/transfer.nim b/waku/waku_store_sync/transfer.nim index 0ac959de0..5a52cac9c 100644 --- a/waku/waku_store_sync/transfer.nim +++ b/waku/waku_store_sync/transfer.nim @@ -51,13 +51,14 @@ proc sendMessage( ): Future[Result[void, string]] {.async.} = let rawPayload = payload.encode().buffer - total_bytes_exchanged.observe(rawPayload.len, labelValues = [Transfer, Sending]) + total_bytes_exchanged.inc(rawPayload.len, labelValues = [Transfer, Sending]) let writeRes = catch: await conn.writeLP(rawPayload) if writeRes.isErr(): - return err("connection write error: " & writeRes.error.msg) + return + err("remote " & $conn.peerId & " connection write error: " & writeRes.error.msg) total_transfer_messages_exchanged.inc(labelValues = [Sending]) @@ -69,7 +70,7 @@ proc openConnection( let connOpt = await self.peerManager.dialPeer(peerId, WakuTransferCodec) let conn: Connection = connOpt.valueOr: - return err("Cannot establish transfer connection") + return err("fail to dial remote " & $peerId) debug "transfer session initialized", local = self.peerManager.switch.peerInfo.peerId, remote = conn.peerId @@ -126,6 +127,8 @@ proc needsReceiverLoop(self: SyncTransfer) {.async.} = WakuMessageAndTopic(pubsub: response.topics[0], message: response.messages[0]) (await sendMessage(connection, msg)).isOkOr: + self.outSessions.del(peerId) + await connection.close() error "failed to send message", error = error continue @@ -141,7 +144,7 @@ proc initProtocolHandler(self: SyncTransfer) = # connection closed normally break - total_bytes_exchanged.observe(buffer.len, labelValues = [Transfer, Receiving]) + total_bytes_exchanged.inc(buffer.len, labelValues = [Transfer, Receiving]) let payload = WakuMessageAndTopic.decode(buffer).valueOr: error "decoding error", error = $error @@ -158,17 +161,16 @@ proc initProtocolHandler(self: SyncTransfer) = if value[].missingOrExcl(hash): error "unwanted hash received, disconnecting" self.inSessions.del(conn.peerId) - await conn.close() break do: error "unwanted hash received, disconnecting" self.inSessions.del(conn.peerId) - await conn.close() break #TODO verify msg RLN proof... (await self.wakuArchive.syncMessageIngress(hash, pubsub, msg)).isOkOr: + error "failed to archive message", error = $error continue let id = SyncID(time: msg.timestamp, hash: hash) @@ -176,6 +178,8 @@ proc initProtocolHandler(self: SyncTransfer) = continue + await conn.close() + debug "transfer session ended", local = self.peerManager.switch.peerInfo.peerId, remote = conn.peerId