nim-json-rpc/json_rpc/server.nim
Jacek Sieka 98a5efba4d
Various error handling and processing fixes (#228)
* remove redundant gcsafe/raises
* rework async raises to chronos 4.0 where this was not yet done
* streamline logging between http/socket/ws
  * don't log error when raising exceptions (whoever handles should log)
  * debug-log requests in all variants of server and client
* unify ipv4/ipv6 address resolution, with preference for ipv6
* fix server start so that it consistently raises only when no addresses
could be bound
2024-10-22 21:58:46 +02:00

101 lines
3.0 KiB
Nim

# json-rpc
# Copyright (c) 2019-2023 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
# * MIT license ([LICENSE-MIT](LICENSE-MIT))
# at your option.
# This file may not be copied, modified, or distributed except according to
# those terms.
{.push raises: [], gcsafe.}
import
std/json,
chronos,
./router,
./jsonmarshal,
./private/jrpc_sys,
./private/shared_wrapper,
./errors
export
chronos,
jsonmarshal,
router
type
RpcServer* = ref object of RootRef
router*: RpcRouter
# ------------------------------------------------------------------------------
# Constructors
# ------------------------------------------------------------------------------
proc new*(T: type RpcServer): T =
T(router: RpcRouter.init())
# ------------------------------------------------------------------------------
# Public functions
# ------------------------------------------------------------------------------
template rpc*(server: RpcServer, path: string, body: untyped): untyped =
server.router.rpc(path, body)
template hasMethod*(server: RpcServer, methodName: string): bool =
server.router.hasMethod(methodName)
proc executeMethod*(server: RpcServer,
methodName: string,
params: RequestParamsTx): Future[JsonString] {.async: (raises: [CancelledError, JsonRpcError]).} =
let
req = requestTx(methodName, params, RequestId(kind: riNumber, num: 0))
reqData = JrpcSys.encode(req)
respData = await server.router.route(reqData)
resp = try:
JrpcSys.decode(respData, ResponseRx)
except CatchableError as exc:
raise (ref JsonRpcError)(msg: exc.msg)
if resp.error.isSome:
raise (ref JsonRpcError)(msg: $resp.error.get)
resp.result
proc executeMethod*(server: RpcServer,
methodName: string,
args: JsonNode): Future[JsonString] {.async: (raises: [CancelledError, JsonRpcError], raw: true).} =
let params = paramsTx(args)
server.executeMethod(methodName, params)
proc executeMethod*(server: RpcServer,
methodName: string,
args: JsonString): Future[JsonString] {.async: (raises: [CancelledError, JsonRpcError]).} =
let params = try:
let x = JrpcSys.decode(args.string, RequestParamsRx)
x.toTx
except SerializationError as exc:
raise newException(JsonRpcError, exc.msg)
await server.executeMethod(methodName, params)
# Wrapper for message processing
proc route*(server: RpcServer, line: string): Future[string] {.async: (raises: [], raw: true).} =
server.router.route(line)
proc route*(server: RpcServer, line: seq[byte]): Future[string] {.async: (raises: [], raw: true).} =
server.router.route(line)
# Server registration
proc register*(server: RpcServer, name: string, rpc: RpcProc) =
## Add a name/code pair to the RPC server.
server.router.register(name, rpc)
proc unRegisterAll*(server: RpcServer) =
# Remove all remote procedure calls from this server.
server.router.clear
{.pop.}