fix: jsonObj cannot have null value

lottamus · lottamus · commit f21d76ebdb37 · 2016-12-04T18:47:33.000-06:00
Swift and ObjC cannot handle JSON Obj with null value and would error out with "Uncaught TypeError: Cannot read property 'toString' of null". Added a fix for both, tests, and output tests for each code language.
diff --git a/src/targets/objc/helpers.js b/src/targets/objc/helpers.js
@@ -64,7 +64,11 @@ module.exports = {
       case '[object Boolean]':
         return value ? '@YES' : '@NO'
       default:
-        return '@"' + value.toString().replace(/"/g, '\\"') + '"'
+        try {
+          return '@"' + value.toString().replace(/"/g, '\\"') + '"'
+        } catch (e) {
+          return ''
+        }
     }
   }
 }
diff --git a/src/targets/swift/helpers.js b/src/targets/swift/helpers.js
@@ -74,7 +74,11 @@ module.exports = {
       case '[object Boolean]':
         return value.toString()
       default:
-        return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        try {
+          return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        } catch (e) {
+          return ''
+        }
     }
   }
 }
diff --git a/test/fixtures/output/c/libcurl/jsonObj-null-value.c b/test/fixtures/output/c/libcurl/jsonObj-null-value.c
@@ -0,0 +1,12 @@
+CURL *hnd = curl_easy_init();
+
+curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
+curl_easy_setopt(hnd, CURLOPT_URL, "http://mockbin.com/har");
+
+struct curl_slist *headers = NULL;
+headers = curl_slist_append(headers, "content-type: application/json");
+curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
+
+curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"foo\":null}");
+
+CURLcode ret = curl_easy_perform(hnd);
diff --git a/test/fixtures/output/csharp/restsharp/jsonObj-null-value.cs b/test/fixtures/output/csharp/restsharp/jsonObj-null-value.cs
@@ -0,0 +1,5 @@
+var client = new RestClient("http://mockbin.com/har");
+var request = new RestRequest(Method.POST);
+request.AddHeader("content-type", "application/json");
+request.AddParameter("application/json", "{\"foo\":null}", ParameterType.RequestBody);
+IRestResponse response = client.Execute(request);
diff --git a/test/fixtures/output/go/native/jsonObj-null-value.go b/test/fixtures/output/go/native/jsonObj-null-value.go
@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+	"strings"
+	"net/http"
+	"io/ioutil"
+)
+
+func main() {
+
+	url := "http://mockbin.com/har"
+
+	payload := strings.NewReader("{\"foo\":null}")
+
+	req, _ := http.NewRequest("POST", url, payload)
+
+	req.Header.Add("content-type", "application/json")
+
+	res, _ := http.DefaultClient.Do(req)
+
+	defer res.Body.Close()
+	body, _ := ioutil.ReadAll(res.Body)
+
+	fmt.Println(res)
+	fmt.Println(string(body))
+
+}
diff --git a/test/fixtures/output/java/okhttp/jsonObj-null-value.java b/test/fixtures/output/java/okhttp/jsonObj-null-value.java
@@ -0,0 +1,11 @@
+OkHttpClient client = new OkHttpClient();
+
+MediaType mediaType = MediaType.parse("application/json");
+RequestBody body = RequestBody.create(mediaType, "{\"foo\":null}");
+Request request = new Request.Builder()
+  .url("http://mockbin.com/har")
+  .post(body)
+  .addHeader("content-type", "application/json")
+  .build();
+
+Response response = client.newCall(request).execute();
diff --git a/test/fixtures/output/java/unirest/jsonObj-null-value.java b/test/fixtures/output/java/unirest/jsonObj-null-value.java
@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("http://mockbin.com/har")
+  .header("content-type", "application/json")
+  .body("{\"foo\":null}")
+  .asString();
diff --git a/test/fixtures/output/javascript/jquery/jsonObj-null-value.js b/test/fixtures/output/javascript/jquery/jsonObj-null-value.js
@@ -0,0 +1,15 @@
+var settings = {
+  "async": true,
+  "crossDomain": true,
+  "url": "http://mockbin.com/har",
+  "method": "POST",
+  "headers": {
+    "content-type": "application/json"
+  },
+  "processData": false,
+  "data": "{\"foo\":null}"
+}
+
+$.ajax(settings).done(function (response) {
+  console.log(response);
+});
diff --git a/test/fixtures/output/javascript/xhr/jsonObj-null-value.js b/test/fixtures/output/javascript/xhr/jsonObj-null-value.js
@@ -0,0 +1,17 @@
+var data = JSON.stringify({
+  "foo": null
+});
+
+var xhr = new XMLHttpRequest();
+xhr.withCredentials = true;
+
+xhr.addEventListener("readystatechange", function () {
+  if (this.readyState === this.DONE) {
+    console.log(this.responseText);
+  }
+});
+
+xhr.open("POST", "http://mockbin.com/har");
+xhr.setRequestHeader("content-type", "application/json");
+
+xhr.send(data);
diff --git a/test/fixtures/output/node/native/jsonObj-null-value.js b/test/fixtures/output/node/native/jsonObj-null-value.js
@@ -0,0 +1,27 @@
+var http = require("http");
+
+var options = {
+  "method": "POST",
+  "hostname": "mockbin.com",
+  "port": null,
+  "path": "/har",
+  "headers": {
+    "content-type": "application/json"
+  }
+};
+
+var req = http.request(options, function (res) {
+  var chunks = [];
+
+  res.on("data", function (chunk) {
+    chunks.push(chunk);
+  });
+
+  res.on("end", function () {
+    var body = Buffer.concat(chunks);
+    console.log(body.toString());
+  });
+});
+
+req.write(JSON.stringify({ foo: null }));
+req.end();
diff --git a/test/fixtures/output/node/request/jsonObj-null-value.js b/test/fixtures/output/node/request/jsonObj-null-value.js
@@ -0,0 +1,14 @@
+var request = require("request");
+
+var options = { method: 'POST',
+  url: 'http://mockbin.com/har',
+  headers: { 'content-type': 'application/json' },
+  body: { foo: null },
+  json: true };
+
+request(options, function (error, response, body) {
+  if (error) throw new Error(error);
+
+  console.log(body);
+});
+
diff --git a/test/fixtures/output/node/unirest/jsonObj-null-value.js b/test/fixtures/output/node/unirest/jsonObj-null-value.js
@@ -0,0 +1,19 @@
+var unirest = require("unirest");
+
+var req = unirest("POST", "http://mockbin.com/har");
+
+req.headers({
+  "content-type": "application/json"
+});
+
+req.type("json");
+req.send({
+  "foo": null
+});
+
+req.end(function (res) {
+  if (res.error) throw new Error(res.error);
+
+  console.log(res.body);
+});
+
diff --git a/test/fixtures/output/objc/nsurlsession/jsonObj-null-value.m b/test/fixtures/output/objc/nsurlsession/jsonObj-null-value.m
@@ -0,0 +1,25 @@
+#import <Foundation/Foundation.h>
+
+NSDictionary *headers = @{ @"content-type": @"application/json" };
+NSDictionary *parameters = @{ @"foo":  };
+
+NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
+
+NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://mockbin.com/har"]
+                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
+                                                   timeoutInterval:10.0];
+[request setHTTPMethod:@"POST"];
+[request setAllHTTPHeaderFields:headers];
+[request setHTTPBody:postData];
+
+NSURLSession *session = [NSURLSession sharedSession];
+NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
+                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
+                                                if (error) {
+                                                    NSLog(@"%@", error);
+                                                } else {
+                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
+                                                    NSLog(@"%@", httpResponse);
+                                                }
+                                            }];
+[dataTask resume];
diff --git a/test/fixtures/output/ocaml/cohttp/jsonObj-null-value.ml b/test/fixtures/output/ocaml/cohttp/jsonObj-null-value.ml
@@ -0,0 +1,11 @@
+open Cohttp_lwt_unix
+open Cohttp
+open Lwt
+
+let uri = Uri.of_string "http://mockbin.com/har" in
+let headers = Header.add (Header.init ()) "content-type" "application/json" in
+let body = Cohttp_lwt_body.of_string "{\"foo\":null}" in
+
+Client.call ~headers ~body `POST uri
+>>= fun (res, body_stream) ->
+  (* Do stuff with the result *)
diff --git a/test/fixtures/output/php/curl/jsonObj-null-value.php b/test/fixtures/output/php/curl/jsonObj-null-value.php
@@ -0,0 +1,28 @@
+<?php
+
+$curl = curl_init();
+
+curl_setopt_array($curl, array(
+  CURLOPT_URL => "http://mockbin.com/har",
+  CURLOPT_RETURNTRANSFER => true,
+  CURLOPT_ENCODING => "",
+  CURLOPT_MAXREDIRS => 10,
+  CURLOPT_TIMEOUT => 30,
+  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+  CURLOPT_CUSTOMREQUEST => "POST",
+  CURLOPT_POSTFIELDS => "{\"foo\":null}",
+  CURLOPT_HTTPHEADER => array(
+    "content-type: application/json"
+  ),
+));
+
+$response = curl_exec($curl);
+$err = curl_error($curl);
+
+curl_close($curl);
+
+if ($err) {
+  echo "cURL Error #:" . $err;
+} else {
+  echo $response;
+}
diff --git a/test/fixtures/output/php/http1/jsonObj-null-value.php b/test/fixtures/output/php/http1/jsonObj-null-value.php
@@ -0,0 +1,19 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('http://mockbin.com/har');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders(array(
+  'content-type' => 'application/json'
+));
+
+$request->setBody('{"foo":null}');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}
diff --git a/test/fixtures/output/php/http2/jsonObj-null-value.php b/test/fixtures/output/php/http2/jsonObj-null-value.php
@@ -0,0 +1,20 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append('{"foo":null}');
+
+$request->setRequestUrl('http://mockbin.com/har');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders(array(
+  'content-type' => 'application/json'
+));
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();
diff --git a/test/fixtures/output/python/python3/jsonObj-null-value.py b/test/fixtures/output/python/python3/jsonObj-null-value.py
@@ -0,0 +1,14 @@
+import http.client
+
+conn = http.client.HTTPConnection("mockbin.com")
+
+payload = "{\"foo\":null}"
+
+headers = { 'content-type': "application/json" }
+
+conn.request("POST", "/har", payload, headers)
+
+res = conn.getresponse()
+data = res.read()
+
+print(data.decode("utf-8"))
diff --git a/test/fixtures/output/python/requests/jsonObj-null-value.py b/test/fixtures/output/python/requests/jsonObj-null-value.py
@@ -0,0 +1,10 @@
+import requests
+
+url = "http://mockbin.com/har"
+
+payload = "{\"foo\":null}"
+headers = {'content-type': 'application/json'}
+
+response = requests.request("POST", url, data=payload, headers=headers)
+
+print(response.text)
diff --git a/test/fixtures/output/ruby/native/jsonObj-null-value.rb b/test/fixtures/output/ruby/native/jsonObj-null-value.rb
@@ -0,0 +1,13 @@
+require 'uri'
+require 'net/http'
+
+url = URI("http://mockbin.com/har")
+
+http = Net::HTTP.new(url.host, url.port)
+
+request = Net::HTTP::Post.new(url)
+request["content-type"] = 'application/json'
+request.body = "{\"foo\":null}"
+
+response = http.request(request)
+puts response.read_body
diff --git a/test/fixtures/output/shell/curl/jsonObj-null-value.sh b/test/fixtures/output/shell/curl/jsonObj-null-value.sh
@@ -0,0 +1,4 @@
+curl --request POST \
+  --url http://mockbin.com/har \
+  --header 'content-type: application/json' \
+  --data '{"foo":null}'
diff --git a/test/fixtures/output/shell/httpie/jsonObj-null-value.sh b/test/fixtures/output/shell/httpie/jsonObj-null-value.sh
@@ -0,0 +1,3 @@
+echo '{"foo":null}' |  \
+  http POST http://mockbin.com/har \
+  content-type:application/json
diff --git a/test/fixtures/output/shell/wget/jsonObj-null-value.sh b/test/fixtures/output/shell/wget/jsonObj-null-value.sh
@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: application/json' \
+  --body-data '{"foo":null}' \
+  --output-document \
+  - http://mockbin.com/har
diff --git a/test/fixtures/output/swift/nsurlsession/jsonObj-null-value.swift b/test/fixtures/output/swift/nsurlsession/jsonObj-null-value.swift
@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = ["content-type": "application/json"]
+let parameters = ["foo": ] as [String : Any]
+
+let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
+
+let request = NSMutableURLRequest(url: NSURL(string: "http://mockbin.com/har")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()
diff --git a/test/fixtures/requests/jsonObj-null-value.json b/test/fixtures/requests/jsonObj-null-value.json
@@ -0,0 +1,19 @@
+{
+  "url": "http://mockbin.com/har",
+  "method": "POST",
+  "headers": [{
+    "name": "content-type",
+    "value": "application/json"
+  }],
+  "postData": {
+    "params": [],
+    "text": "{\"foo\":null}",
+    "stored": true,
+    "mimeType": "application/json",
+    "size": 0,
+    "jsonObj": {
+      "foo":null
+    },
+    "paramsObj": false
+  }
+}
diff --git a/test/targets/objc/nsurlsession.js b/test/targets/objc/nsurlsession.js
diff --git a/test/targets/swift/nsurlsession.js b/test/targets/swift/nsurlsession.js

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,11 @@ module.exports = {`
`64`	`64`	`case '[object Boolean]':`
`65`	`65`	`return value ? '@YES' : '@NO'`
`66`	`66`	`default:`
`67`		`- return '@"' + value.toString().replace(/"/g, '\\"') + '"'`
	`67`	`+ try {`
	`68`	`+ return '@"' + value.toString().replace(/"/g, '\\"') + '"'`
	`69`	`+ } catch (e) {`
	`70`	`+ return ''`
	`71`	`+ }`
`68`	`72`	`}`
`69`	`73`	`}`
`70`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,11 @@ module.exports = {`
`74`	`74`	`case '[object Boolean]':`
`75`	`75`	`return value.toString()`
`76`	`76`	`default:`
`77`		`- return '"' + value.toString().replace(/"/g, '\\"') + '"'`
	`77`	`+ try {`
	`78`	`+ return '"' + value.toString().replace(/"/g, '\\"') + '"'`
	`79`	`+ } catch (e) {`
	`80`	`+ return ''`
	`81`	`+ }`
`78`	`82`	`}`
`79`	`83`	`}`
`80`	`84`	`}`