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

work around Nim 2.0.10 issue (#225)

Browse Source 
* work around Nim 2.0.10 issue

* adjust Json/JSON capitalization in tests
This commit is contained in:
tersec 2024-10-04 03:50:33 +00:00 committed by GitHub
parent 9da5b609bf
commit be16a6528a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
json_rpc/private/server_handler_wrapper.nim
View File

@ -41,7 +41,7 @@ template rpc_isOptional[T](_: options.Option[T]): bool = true
# Run time helpers # Run time helpers
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
proc unpackArg(args: JsonString, argName: string, argType: type): argType func unpackArg(args: JsonString, argName: string, argType: type): argType
{.gcsafe, raises: [JsonRpcError].} = {.gcsafe, raises: [JsonRpcError].} =
## This where input parameters are decoded from JSON into ## This where input parameters are decoded from JSON into
## Nim data types ## Nim data types
@ -89,8 +89,16 @@ template expectOptionalParamsLen(params: RequestParamsRx,
template expectParamsLen(params: RequestParamsRx, length: static[int]) = template expectParamsLen(params: RequestParamsRx, length: static[int]) =
## Make sure positional params meets the handler expectation ## Make sure positional params meets the handler expectation
# https://github.com/nim-lang/Nim/issues/24228 especially in a Chronos async
# context, with `{.compileTime.}` `$` `int`, `uint64`, and `int64` overloads
# https://github.com/nim-lang/Nim/blob/v2.0.10/lib/system/dollars.nim#L28-L34
# provides for for compile-time evaluation from, can cause JSON-RPC code not
# to compile. Explicitly choose the non-CTFE overloads, which do not trigger
# this Nim issue.
let let
expected = "Expected " & $length & " Json parameter(s) but got " nonConstLength = length
expected = "Expected " & $nonConstLength & " JSON parameter(s) but got "
if params.positional.len != length: if params.positional.len != length:
raise newException(RequestDecodeError, raise newException(RequestDecodeError,
@ -141,11 +149,11 @@ template unpackPositional(params: RequestParamsRx,
else: else:
# mandatory args # mandatory args
# A and C fall into this category # A and C fall into this category
# unpack Nim type and assign from json # unpack Nim type and assign from JSON
if params.notNull(pos): if params.notNull(pos):
innerNode() innerNode()
proc makeType(typeName, params: NimNode): NimNode = func makeType(typeName, params: NimNode): NimNode =
## Generate type section contains an object definition ## Generate type section contains an object definition
## with fields of handler params ## with fields of handler params
let typeSec = quote do: let typeSec = quote do:
@ -159,14 +167,14 @@ proc makeType(typeName, params: NimNode): NimNode =
obj[2] = recList obj[2] = recList
typeSec typeSec
proc makeParams(retType: NimNode, params: NimNode): seq[NimNode] = func makeParams(retType: NimNode, params: NimNode): seq[NimNode] =
## Convert rpc params into handler params ## Convert rpc params into handler params
result.add retType result.add retType
if params.len > 1: if params.len > 1:
for i in 1..<params.len: for i in 1..<params.len:
result.add params[i] result.add params[i]
proc makeHandler(procName, params, procBody, returnInner: NimNode): NimNode = func makeHandler(procName, params, procBody, returnInner: NimNode): NimNode =
## Generate rpc handler proc ## Generate rpc handler proc
let let
returnType = quote do: Future[`returnInner`] returnType = quote do: Future[`returnInner`]
@ -180,7 +188,7 @@ proc makeHandler(procName, params, procBody, returnInner: NimNode): NimNode =
pragmas = pragmas pragmas = pragmas
) )
proc ofStmt(x, paramsObj, paramName, paramType: NimNode): NimNode = func ofStmt(x, paramsObj, paramName, paramType: NimNode): NimNode =
let caseStr = $paramName let caseStr = $paramName
result = nnkOfBranch.newTree( result = nnkOfBranch.newTree(
quote do: `caseStr`, quote do: `caseStr`,
@ -188,7 +196,7 @@ proc ofStmt(x, paramsObj, paramName, paramType: NimNode): NimNode =
`paramsObj`.`paramName` = unpackArg(`x`.value, `caseStr`, `paramType`) `paramsObj`.`paramName` = unpackArg(`x`.value, `caseStr`, `paramType`)
) )
proc setupNamed(paramsObj, paramsIdent, params: NimNode): NimNode = func setupNamed(paramsObj, paramsIdent, params: NimNode): NimNode =
let x = ident"x" let x = ident"x"
var caseStmt = nnkCaseStmt.newTree( var caseStmt = nnkCaseStmt.newTree(
@ -206,7 +214,7 @@ proc setupNamed(paramsObj, paramsIdent, params: NimNode): NimNode =
for `x` in `paramsIdent`.named: for `x` in `paramsIdent`.named:
`caseStmt` `caseStmt`
proc wrapServerHandler*(methName: string, params, procBody, procWrapper: NimNode): NimNode = func wrapServerHandler*(methName: string, params, procBody, procWrapper: NimNode): NimNode =
## This proc generate something like this: ## This proc generate something like this:
## ##
## proc rpcHandler(paramA: ParamAType, paramB: ParamBType): Future[ReturnType] = ## proc rpcHandler(paramA: ParamAType, paramB: ParamBType): Future[ReturnType] =

2
tests/test_router_rpc.nim
View File

@ -123,7 +123,7 @@ suite "rpc router":
test "no params with params": test "no params with params":
let n = req("noParams", "[123]") let n = req("noParams", "[123]")
let res = waitFor server.route(n) let res = waitFor server.route(n)
check res == """{"jsonrpc":"2.0","id":0,"error":{"code":-32000,"message":"`noParams` raised an exception","data":"Expected 0 Json parameter(s) but got 1"}}""" check res == """{"jsonrpc":"2.0","id":0,"error":{"code":-32000,"message":"`noParams` raised an exception","data":"Expected 0 JSON parameter(s) but got 1"}}"""
test_optional("std_option") test_optional("std_option")
test_optional("results_opt") test_optional("results_opt")