logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-01-07 16:33:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make /debug endpoints /version and /info available as root (#3333)

Browse Source
This commit is contained in:
NagyZoltanPeter 2025-03-27 11:56:44 +01:00 committed by GitHub
parent 8876c2fc18
commit e62664cca0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tests/wakunode_rest/test_rest_debug.nim
View File

@ -33,7 +33,7 @@ proc testWakuNode(): WakuNode =
newTestWakuNode(privkey, bindIp, port, some(extIp), some(port)) newTestWakuNode(privkey, bindIp, port, some(extIp), some(port))
suite "Waku v2 REST API - Debug": suite "Waku v2 REST API - Debug":
asyncTest "Get node info - GET /debug/v1/info": asyncTest "Get node info - GET /info":
# Given # Given
let node = testWakuNode() let node = testWakuNode()
await node.start() await node.start()
@ -62,7 +62,7 @@ suite "Waku v2 REST API - Debug":
await restServer.closeWait() await restServer.closeWait()
await node.stop() await node.stop()
asyncTest "Get node version - GET /debug/v1/version": asyncTest "Get node version - GET /version":
# Given # Given
let node = testWakuNode() let node = testWakuNode()
await node.start() await node.start()

4
waku/waku_api/rest/debug/client.nim
View File

@ -11,10 +11,10 @@ logScope:
# TODO: Check how we can use a constant to set the method endpoint (improve "rest" pragma under nim-presto) # TODO: Check how we can use a constant to set the method endpoint (improve "rest" pragma under nim-presto)
proc debugInfoV1*(): RestResponse[DebugWakuInfo] {. proc debugInfoV1*(): RestResponse[DebugWakuInfo] {.
rest, endpoint: "/debug/v1/info", meth: HttpMethod.MethodGet rest, endpoint: "/info", meth: HttpMethod.MethodGet
.} .}
# TODO: Check how we can use a constant to set the method endpoint (improve "rest" pragma under nim-presto) # TODO: Check how we can use a constant to set the method endpoint (improve "rest" pragma under nim-presto)
proc debugVersionV1*(): RestResponse[string] {. proc debugVersionV1*(): RestResponse[string] {.
rest, endpoint: "/debug/v1/version", meth: HttpMethod.MethodGet rest, endpoint: "/version", meth: HttpMethod.MethodGet
.} .}

19
waku/waku_api/rest/debug/handlers.nim
View File

@ -8,10 +8,12 @@ export types
logScope: logScope:
topics = "waku node rest debug_api" topics = "waku node rest debug_api"
const ROUTE_DEBUG_INFOV1* = "/debug/v1/info" const ROUTE_INFOV1* = "/info"
# /debug route is deprecated, will be removed
const ROUTE_DEBUG_INFOV1 = "/debug/v1/info"
proc installDebugInfoV1Handler(router: var RestRouter, node: WakuNode) = proc installDebugInfoV1Handler(router: var RestRouter, node: WakuNode) =
router.api(MethodGet, ROUTE_DEBUG_INFOV1) do() -> RestApiResponse: let getInfo = proc(): RestApiResponse =
let info = node.info().toDebugWakuInfo() let info = node.info().toDebugWakuInfo()
let resp = RestApiResponse.jsonResponse(info, status = Http200) let resp = RestApiResponse.jsonResponse(info, status = Http200)
if resp.isErr(): if resp.isErr():
@ -20,11 +22,22 @@ proc installDebugInfoV1Handler(router: var RestRouter, node: WakuNode) =
return resp.get() return resp.get()
const ROUTE_DEBUG_VERSIONV1* = "/debug/v1/version" # /debug route is deprecated, will be removed
router.api(MethodGet, ROUTE_DEBUG_INFOV1) do() -> RestApiResponse:
return getInfo()
router.api(MethodGet, ROUTE_INFOV1) do() -> RestApiResponse:
return getInfo()
const ROUTE_VERSIONV1* = "/version"
# /debug route is deprecated, will be removed
const ROUTE_DEBUG_VERSIONV1 = "/debug/v1/version"
proc installDebugVersionV1Handler(router: var RestRouter, node: WakuNode) = proc installDebugVersionV1Handler(router: var RestRouter, node: WakuNode) =
# /debug route is deprecated, will be removed
router.api(MethodGet, ROUTE_DEBUG_VERSIONV1) do() -> RestApiResponse: router.api(MethodGet, ROUTE_DEBUG_VERSIONV1) do() -> RestApiResponse:
return RestApiResponse.textResponse(git_version, status = Http200) return RestApiResponse.textResponse(git_version, status = Http200)
router.api(MethodGet, ROUTE_VERSIONV1) do() -> RestApiResponse:
return RestApiResponse.textResponse(git_version, status = Http200)
proc installDebugApiHandlers*(router: var RestRouter, node: WakuNode) = proc installDebugApiHandlers*(router: var RestRouter, node: WakuNode) =
installDebugInfoV1Handler(router, node) installDebugInfoV1Handler(router, node)