GNU bug report logs - #72941
jsonrpc: Check if parameters are in line with the spec

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Felician Nemeth <nemethf <at> tmit.bme.hu>
Subject: bug#72941: closed (Re: bug#72941: jsonrpc: Check if parameters
 are in line with the spec)
Date: Sat, 12 Oct 2024 11:23:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#72941: jsonrpc: Check if parameters are in line with the spec

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 72941 <at> debbugs.gnu.org.

-- 
72941: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=72941
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Daniel Pettersson <daniel <at> dpettersson.net>
Cc: nemethf <at> tmit.bme.hu, 72941-done <at> debbugs.gnu.org, joaotavora <at> gmail.com
Subject: Re: bug#72941: jsonrpc: Check if parameters are in line with the spec
Date: Sat, 12 Oct 2024 14:21:42 +0300

> From: Daniel Pettersson <daniel <at> dpettersson.net>
> Cc: Felician Nemeth <nemethf <at> tmit.bme.hu>,  joaotavora <at> gmail.com,
>   72941 <at> debbugs.gnu.org
> Date: Sat, 28 Sep 2024 13:40:00 +0200
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> > So do we want to close this as wontfix?
> 
> Yes, if anybody would clarify the variable type expectations
> documentation that would be great but all in all this is would be
> wontfix.
> 
> >> From: Felician Nemeth <nemethf <at> tmit.bme.hu>
> 
> >> Maybe when the server responds with an error to a jsonrpc-request, then
> >> jsonrpc.el could create an additional warning if the params of the
> >> request was not structured.  Or maybe it is too much work for a very
> >> small gain.
> 
> It seams like something that would be a bit of mess and I would expect
> that an sane jsonrpc server would include the reason for error in the
> error response.

No further comments, so I'm now closing this bug.

[Message part 3 (message/rfc822, inline)]

From: Felician Nemeth <nemethf <at> tmit.bme.hu>
To: bug-gnu-emacs <at> gnu.org
Subject: jsonrpc: Check if parameters are in line with the spec
Date: Sun, 01 Sep 2024 18:26:02 +0200

I failed to implement an LSP extension to Eglot, because my function
sent a required parameter as a string instead of an array containing a
single element: the string.  In the end it turned out that this was my
fault, because according to the JSON specification: "If present,
parameters for the rpc call MUST be provided as a Structured
value. Either by-position through an Array or by-name through an
Object."  https://www.jsonrpc.org/specification#parameter_structures

Would it be possible to extend jsonrpc.el to check the params argument
of jsonrpc-request, jsonrpc-notify, and jsonrpc-async-request whether it
is a structured value?  And if it is not, then guide the programmer to
the above URL with a warning.

Thank you.

(Background: <https://github.com/ocaml/ocaml-lsp/issues/1330>)

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.