Fix jsonapi.read omits include_methods when a single parameter is used
#1493
Conversation
When include_methods param is used in a read call with a single
parameter (instead of a list of more than one), the jsonapi does
not handle the value parameter properly and transforms it to
a list of characters instead.
A call like follows:
```
this.ajax_submit({
url: this.get_portal_url() + "/@@API/read",
data: {
catalog_name: "uid_catalog",
UID: widget.attr('data-uid'),
include_methods: ["getSomething"],
}
}).done(function(data) {
return deferred.resolveWith(this, [data.objects[0]["getSomething"]]);
});
```
fails. The function `get_include_methods` returns `getSomething`
instead of a list `[getSomething]`. Therefore, the function
`load_method_values` tries the following calls to the instance:
`g`, `e`, `t`, `S`, `o`, ...
If the call is like follows:
```
this.ajax_submit({
url: this.get_portal_url() + "/@@API/read",
data: {
catalog_name: "uid_catalog",
UID: widget.attr('data-uid'),
include_methods: ["getSomething", "getId"],
}
}).done(function(data) {
return deferred.resolveWith(this, [data.objects[0]["getSomething"]]);
});
```
the list is resolved properly.
| return include_methods | ||
| include_methods = request.get("include_methods[]") | ||
| if not include_methods: | ||
| include_methods = request.get("include_methods", []) |
There was a problem hiding this comment.
When is the variable named include_methods[] in the request?
There was a problem hiding this comment.
First of all, include_methods is not used as a parameter anywhere in the code, but I was playing around and found this issue. Nevertheless, include_fields from here:
senaite.core/bika/lims/browser/js/coffee/bika_widgets/remarkswidget.coffee
Lines 121 to 129 in 699f02f
is received as include_fields[]. Therefore, this trick here:
senaite.core/bika/lims/jsonapi/__init__.py
Lines 56 to 58 in 699f02f
Same happens if you use include_methods instead. Thus, I just followed same criteria and did not go any further. As a side note, the issue this PR addresses happens with include_fields too, but is a hidden "bug" because of:
senaite.core/bika/lims/jsonapi/__init__.py
Lines 88 to 89 in 699f02f
and this code will work even if include_fields is a string instead of a list.
There was a problem hiding this comment.
Ah, I think I got it. This means that either JQuery or the Zope Publisher is converting include_methods -> include_methods[]?
Anyhow, going to merge then.
Description of the issue/feature this PR addresses
When include_methods param is used in a read call with a single parameter (instead of a list of more than one), the jsonapi does not handle the value parameter properly and transforms it to a list of characters instead.
A call like follows:
fails. The function
get_include_methodsreturnsgetSomethinginstead of a list[getSomething]. Therefore, the functionload_method_valuestries the following calls to the instance:g,e,t,S,o, ...If the call is like follows:
the list is resolved properly.
Current behavior before PR
read call fails when using
include_methodsparam with a single valueDesired behavior after PR is merged
read calls does work when using
include_methodsparam with a single value--
I confirm I have tested this PR thoroughly and coded it according to PEP8
and Plone's Python styleguide standards.