nim-json-rpc/json_rpc/client.nim

import
  tables, json, macros,
  chronos,
  jsonmarshal, errors

from strutils import toLowerAscii

export
  chronos

type
  ClientId* = int64
  RpcClient* = ref object of RootRef
    awaiting*: Table[ClientId, Future[Response]]
    nextId: ClientId
    methodHandlers: Table[string, proc(j: JsonNode) {.gcsafe.}]
    onDisconnect*: proc() {.gcsafe.}

  Response* = tuple[error: bool, result: JsonNode]

proc initRpcClient*[T: RpcClient](client: var T) =
  client.nextId = 1

proc getNextId*(client: RpcClient): ClientId =
  result = client.nextId
  client.nextId.inc

proc rpcCallNode*(path: string, params: JsonNode, id: ClientId): JsonNode =
  %{"jsonrpc": %"2.0", "method": %path, "params": params, "id": %id}

method call*(client: RpcClient, name: string,
             params: JsonNode): Future[Response] {.gcsafe, async, base.} =
  discard

method close*(client: RpcClient) {.base, gcsafe, async.} = discard

template asyncRaise[T](fut: Future[T], errType: typedesc, msg: string) =
  fut.fail(newException(errType, msg))

macro checkGet(node: JsonNode, fieldName: string,
               jKind: static[JsonNodeKind]): untyped =
  let n = genSym(ident = "n") #`node`{`fieldName`}
  result = quote:
    let `n` = `node`{`fieldname`}
    if `n`.isNil or `n`.kind == JNull:
      raise newException(ValueError,
        "Message is missing required field \"" & `fieldName` & "\"")
    if `n`.kind != `jKind`.JsonNodeKind:
      raise newException(ValueError,
        "Expected " & $(`jKind`.JsonNodeKind) & ", got " & $`n`.kind)
  case jKind
  of JBool: result.add(quote do: `n`.getBool)
  of JInt: result.add(quote do: `n`.getInt)
  of JString: result.add(quote do: `n`.getStr)
  of JFloat: result.add(quote do: `n`.getFloat)
  of JObject: result.add(quote do: `n`.getObject)
  else: discard

proc processMessage*(self: RpcClient, line: string) {.gcsafe.} =
  # Note: this doesn't use any transport code so doesn't need to be
  # differentiated.
  let node = parseJson(line)

  if "id" in node:
    let id = checkGet(node, "id", JInt)

    var requestFut: Future[Response]
    if not self.awaiting.pop(id, requestFut):
      raise newException(ValueError,
        "Cannot find message id \"" & $node["id"].getInt & "\"")

    let version = checkGet(node, "jsonrpc", JString)
    if version != "2.0":
      self.awaiting[id].asyncRaise(ValueError,
        "Unsupported version of JSON, expected 2.0, received \"" & version & "\"")

    let errorNode = node{"error"}
    if errorNode.isNil or errorNode.kind == JNull:
      var res = node{"result"}
      if not res.isNil:
        requestFut.complete((false, res))
      else:
        requestFut.fail(newException(InvalidResponse, "Missing `result` field"))
    else:
      requestFut.fail(newException(ValueError, $errorNode))

  elif "method" in node:
    # This could be subscription notification
    let name = node["method"].getStr()
    let handler = self.methodHandlers.getOrDefault(name)
    if not handler.isNil:
      handler(node{"params"})
  else:
    raise newException(ValueError, "Invalid jsonrpc message: " & $node)

# Signature processing

proc createRpcProc(procName, parameters, callBody: NimNode): NimNode =
  # parameters come as a tree
  var paramList = newSeq[NimNode]()
  for p in parameters: paramList.add(p)

  # build proc
  result = newProc(procName, paramList, callBody)
  # make proc async
  result.addPragma ident"async"
  # export this proc
  result[0] = nnkPostFix.newTree(ident"*", newIdentNode($procName))

proc toJsonArray(parameters: NimNode): NimNode =
  # outputs an array of jsonified parameters
  # ie; %[%a, %b, %c]
  parameters.expectKind nnkFormalParams
  var items = newNimNode(nnkBracket)
  for i in 2 ..< parameters.len:
    let curParam = parameters[i][0]
    if curParam.kind != nnkEmpty:
      items.add(nnkPrefix.newTree(ident"%", curParam))
  result = nnkPrefix.newTree(bindSym("%", brForceOpen), items)

proc createRpcFromSig*(clientType, rpcDecl: NimNode): NimNode =
  # Each input parameter in the rpc signature is converted
  # to json with `%`.
  # Return types are then converted back to native Nim types.
  let iJsonNode = newIdentNode("JsonNode")

  var parameters = rpcDecl.findChild(it.kind == nnkFormalParams).copy
  # ensure we have at least space for a return parameter
  if parameters.isNil or parameters.kind == nnkEmpty or parameters.len == 0:
    parameters = nnkFormalParams.newTree(iJsonNode)

  let
    procName = rpcDecl.name
    pathStr = $procName
    returnType =
      # if no return type specified, defaults to JsonNode
      if parameters[0].kind == nnkEmpty: iJsonNode
      else: parameters[0]
    customReturnType = returnType != iJsonNode

  # insert rpc client as first parameter
  parameters.insert(1, nnkIdentDefs.newTree(ident"client", ident($clientType),
                                            newEmptyNode()))

  let
    # variable used to send json to the server
    jsonParamIdent = genSym(nskVar, "jsonParam")
    # json array of marshalled parameters
    jsonParamArray = parameters.toJsonArray()
  var
    # populate json params - even rpcs with no parameters have an empty json
    # array node sent
    callBody = newStmtList().add(quote do:
      var `jsonParamIdent` = `jsonParamArray`
    )

  # convert return type to Future
  parameters[0] = nnkBracketExpr.newTree(ident"Future", returnType)
  # create rpc proc
  result = createRpcProc(procName, parameters, callBody)

  let
    # temporary variable to hold `Response` from rpc call
    rpcResult = genSym(nskLet, "res")
    clientIdent = newIdentNode("client")
    # proc return variable
    procRes = ident"result"
    # actual return value, `rpcResult`.result
    jsonRpcResult = nnkDotExpr.newTree(rpcResult, newIdentNode("result"))

  # perform rpc call
  callBody.add(quote do:
    # `rpcResult` is of type `Response`
    let `rpcResult` = await `clientIdent`.call(`pathStr`, `jsonParamIdent`)
    if `rpcResult`.error: raise newException(ValueError, $`rpcResult`.result)
  )

  if customReturnType:
    # marshal json to native Nim type
    callBody.add(jsonToNim(procRes, returnType, jsonRpcResult, "result"))
  else:
    # native json expected so no work
    callBody.add quote do:
      `procRes` = `rpcResult`.result

  when defined(nimDumpRpcs):
    echo pathStr, ":\n", result.repr

proc processRpcSigs(clientType, parsedCode: NimNode): NimNode =
  result = newStmtList()

  for line in parsedCode:
    if line.kind == nnkProcDef:
      var procDef = createRpcFromSig(clientType, line)
      result.add(procDef)

proc setMethodHandler*(cl: RpcClient, name: string, callback: proc(j: JsonNode) {.gcsafe.}) =
  cl.methodHandlers[name] = callback

proc delMethodHandler*(cl: RpcClient, name: string) =
  cl.methodHandlers.del(name)

macro createRpcSigs*(clientType: untyped, filePath: static[string]): untyped =
  ## Takes a file of forward declarations in Nim and builds them into RPC
  ## calls, based on their parameters.
  ## Inputs are marshalled to json, and results are put into the signature's
  ## Nim type.
  result = processRpcSigs(clientType, staticRead($filePath).parseStmt())