When I call this:
return services_error(t('The username already exists.'), 406);

In a services callback function, and I ask for a JSON result (Accept: application/json), the webservice will output invalid JSON, in fact it will just output

"The username already exists."

Which is invalid JSON - this causes some of the web service clients to crash, since services are still telling that it has Content-type: application/json in the header.

CommentFileSizeAuthor
#7 services-invalid_json_with_simple_data-1660996-7.patch730 byteswwedding
#2 services-invalid_json_with_simple_data-1660996-2.patch735 byteswwedding
#1 services-error_message_invalid_json-1660996-0.patch406 bytesesbenvb

Comments

esbenvb’s picture

esbenvb commented
StatusFileSize
new services-error_message_invalid_json-1660996-0.patch406 bytes

Here is a patch for the current 7.x-3.x branch.

It might screw up other things in some installations, but fixes the issue for me.

wwedding’s picture

wwedding commented
Title: Invalid JSON returned by services_error() » Invalid JSON returned by services_error() or resources returning non-array/non-object values
StatusFileSize
new services-invalid_json_with_simple_data-1660996-2.patch735 bytes

This is a problem with pretty much any data that is being expressed that isn't in an array or object form already; strings, booleans, integers, etc. json_encode() doesn't really do what it seems like it should for these.

My fix was to just wrap the content in an array inside the REST server's render_json() function...

  private function render_json($data, $jsonp = FALSE) {
    //json_encode doesn't produce valid json with bools, strings, or other simple data
    if(!is_array($data) && !is_object($data)) {
      $data = array($data);
    }
    $json = str_replace('\\/', '/', json_encode($data));
    if ($jsonp && isset($_GET['callback'])) {
      return sprintf('%s(%s);', $_GET['callback'], $json);
    }
    return $json;
  }
wwedding’s picture

wwedding commented
Status: Active » Needs review

I guess my fix is specific to the built in REST server and the original poster's patch might be a more general fix? Maybe this isn't a problem with other server types.

@esbenvb are you using REST?

kylebrowning’s picture

kylebrowning commented

I like the patch in #1 better, but #2 raises a good point!

Anyone else want to chime in?

ygerasimov’s picture

ygerasimov commented

I think we should proceed with second patch as it breaks our APIs less that first one.

marcingy’s picture

marcingy commented
Status: Needs review » Needs work

Second one makes me happier but the code has a few style issues

Missing space after // and line is over characters long.

+    //json_encode doesn't produce valid json with bools, strings, or other simple data

Missing space after if

+    if(!is_array($data) && !is_object($data)) {
wwedding’s picture

wwedding commented
Status: Needs work » Needs review
StatusFileSize
new services-invalid_json_with_simple_data-1660996-7.patch730 bytes

Sorry about that, forgot to run the patch through code sniffer before submitting.

Shortened the comment, added a space, added a full stop, fixed the spacing around the conditional.

ygerasimov’s picture

ygerasimov commented
Status: Needs review » Reviewed & tested by the community

Looks good to me.

kylebrowning’s picture

kylebrowning commented
Status: Reviewed & tested by the community » Fixed
kylebrowning’s picture

kylebrowning commented

I hope this doesnt break anyones clients :(

wwedding’s picture

wwedding commented

It might, at least temporarily. But only because those clients had to be coded to handle improper non-JSON responses when they expected JSON responses in the first place, right?

kylebrowning’s picture

kylebrowning commented

Ill just make it apparent in the release notes that its a potential breaker.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.