Fix Object with 'length' key bug

This commit fixes a bug where SDK fails to serialize JavaScript Objects
if they contain key 'length' with number value.

The reason for this bug seems to be in lodash `_.reduce` function. See
lodash/lodash#5870

The solution is to use Object.entries + reduce instead of lodash reduce.

src/interceptors/multipart_request.js

@@ -1,4 +1,5 @@
 import _ from 'lodash';
+import { entries } from '../utils';
 
 /**
    Takes `params` from `ctx` and converts to `FormData`
@@ -17,14 +18,11 @@ export default class MultipartRequest {
         );
       }
 
-      const formDataObj = _.reduce(
-        params,
-        (fd, val, key) => {
-          fd.append(key, val);
-          return fd;
-        },
-        new FormData()
-      );
+      const formDataObj = entries(v).reduce((fd, entry) => {
+        const [val, key] = entry;
+        fd.append(key, val);
+        return fd;
+      }, new FormData());
       /* eslint-enable no-undef */
 
       return { params: formDataObj, ...ctx };

src/serializer.js

@@ -3,6 +3,7 @@
 import transit from 'transit-js';
 import _ from 'lodash';
 import { UUID, LatLng, Money, BigDecimal, toType } from './types';
+import { entries } from './utils';
 
 /**
    Composes two readers (sdk type and app type) so that:
@@ -168,14 +169,11 @@ const MapHandler = [
   transit.makeWriteHandler({
     tag: () => 'map',
     rep: v =>
-      _.reduce(
-        v,
-        (map, val, key) => {
-          map.set(transit.keyword(key), val);
-          return map;
-        },
-        transit.map()
-      ),
+      entries(v).reduce((map, entry) => {
+        const [key, val] = entry;
+        map.set(transit.keyword(key), val);
+        return map;
+      }, transit.map()),
   }),
 ];
 

src/serializer.test.js

@@ -19,6 +19,24 @@ describe('serializer', () => {
     expect(r.read(w.write(testData))).toEqual(testData);
   });
 
+  it('reads and writes Object with key length', () => {
+    // See: https://github.com/lodash/lodash/issues/5870
+    const testData = {
+      a: 1,
+      b: 2,
+      c: [3, 4, 5],
+      d: {
+        e: true,
+      },
+      length: 10,
+    };
+
+    const r = reader();
+    const w = writer();
+
+    expect(r.read(w.write(testData))).toEqual(testData);
+  });
+
   it('reads and writes transit JSON verbose', () => {
     const testData = {
       a: 1,

src/utils.js

@@ -1,5 +1,15 @@
 import _ from 'lodash';
 
+/**
+ Null-safe version of Object.entries
+ */
+export const entries = obj => {
+  if (obj == null) {
+    return [];
+  }
+  return Object.entries(obj);
+};
+
 /**
    Take URL and remove the trailing slashes.
 
@@ -17,14 +27,13 @@ export const fnPath = path =>
   _.without(path.split('/'), '').map(part => part.replace(/_\w/g, m => m[1].toUpperCase()));
 
 export const formData = params =>
-  _.reduce(
-    params,
-    (pairs, v, k) => {
+  entries(params)
+    .reduce((pairs, entry) => {
+      const [k, v] = entry;
       pairs.push(`${encodeURIComponent(k)}=${encodeURIComponent(v)}`);
       return pairs;
-    },
-    []
-  ).join('&');
+    }, [])
+    .join('&');
 
 /**
    Serialize a single attribute in an object query parameter.

src/utils.test.js

@@ -1,4 +1,10 @@
-import { fnPath, trimEndSlash, formData, objectQueryString, canonicalAssetPaths } from './utils';
+import {
+  fnPath,
+  trimEndSlash,
+  formData,
+  objectQueryString,
+  canonicalAssetPaths,
+} from './utils';
 
 describe('utils', () => {
   describe('pathToMethodName', () => {
@@ -33,6 +39,11 @@ describe('utils', () => {
         formData({ username: '[email protected]', password: '}4$3.872487=3&&]/6?.' })
       ).toEqual('username=joe.dunphy%40example.com&password=%7D4%243.872487%3D3%26%26%5D%2F6%3F.');
     });
+
+    it('encodes Object with key length', () => {
+      // See: https://github.com/lodash/lodash/issues/5870
+      expect(formData({ length: 10 })).toEqual('length=10');
+    });
   });
 
   describe('objectQueryString', () => {