feat: Add stringifySafe method to entry collections

Entry collections can potentially have circular references when using Links. This method allows a
collection to be stringified safely.

Author: trodrigues

lib/entities/entry.js

@@ -2,6 +2,7 @@ import {cloneDeep} from 'lodash/lang'
 import {uniq} from 'lodash/array'
 import mixinToPlainObject from '../mixins/to-plain-object'
 import mixinLinkGetters from '../mixins/link-getters'
+import mixinStringifySafe from '../mixins/stringify-safe'
 
 /**
  * @memberof Entities
@@ -30,6 +31,7 @@ export function wrapEntry (data) {
  * @prop {number} limit
  * @prop {Array<Entities.Entry>} items
  * @prop {function(): Object} toPlainObject() - Returns this Entry collection as a plain JS object
+ * @prop {function(?function=, space=): Object} stringifySafe(replacer,space) - Stringifies the entry collection, accounting for circular references. Circular references will be replaced with just a Link object, with a <code>circular</code> property set to <code>true</code>. See <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">MDN</a> and <a href="https://www.npmjs.com/package/json-stringify-safe">json-stringify-safe</a> for more details on the arguments this method can take.
  */
 
 /**
@@ -39,7 +41,7 @@ export function wrapEntry (data) {
  * @return {EntryCollection} Wrapped entry collection data
  */
 export function wrapEntryCollection (data, resolveLinks) {
-  const wrappedData = mixinToPlainObject(cloneDeep(data))
+  const wrappedData = mixinStringifySafe(mixinToPlainObject(cloneDeep(data)))
   if (resolveLinks) {
     const includes = prepareIncludes(wrappedData.includes, wrappedData.items)
     mixinLinkGetters(wrappedData.items, includes)

lib/mixins/stringify-safe.js

@@ -0,0 +1,21 @@
+import jsonStringifySafe from 'json-stringify-safe'
+
+export default function mixinStringifySafe (data) {
+  return Object.defineProperty(data, 'stringifySafe', {
+    enumerable: false,
+    configurable: false,
+    writable: false,
+    value: function (serializer = null, indent = '') {
+      return jsonStringifySafe(this, serializer, indent, (key, value) => {
+        return {
+          sys: {
+            type: 'Link',
+            linkType: 'Entry',
+            id: value.sys.id,
+            circular: true
+          }
+        }
+      })
+    }
+  })
+}

package.json

@@ -49,6 +49,7 @@
   "dependencies": {
     "babel-runtime": "^6.3.19",
     "follow-redirects": "0.0.7",
+    "json-stringify-safe": "^5.0.1",
     "lodash": "^4.2.0"
   },
   "devDependencies": {

test/unit/entities/entry-test.js

@@ -37,7 +37,7 @@ test('Entry collection is wrapped', t => {
   t.end()
 })
 
-test.only('Entry collection links are resolved', t => {
+test('Entry collection links are resolved', t => {
   const entryCollection = {
     total: 1,
     skip: 0,
@@ -87,7 +87,9 @@ test.only('Entry collection links are resolved', t => {
     }
   }
 
-  const wrappedEntry = wrapEntryCollection(entryCollection, true).toPlainObject()
+  const wrappedCollection = wrapEntryCollection(entryCollection, true)
+  const wrappedEntry = wrappedCollection.toPlainObject()
+
   // first linked entry resolved from includes
   t.equals(wrappedEntry.items[0].fields.linked1.sys.type, 'Asset', 'first linked entity is resolved')
   t.ok(wrappedEntry.items[0].fields.linked1.fields, 'first linked entity has fields')
@@ -96,5 +98,6 @@ test.only('Entry collection links are resolved', t => {
   t.ok(wrappedEntry.items[0].fields.linked2.fields, 'second linked entity has fields')
   t.equals(wrappedEntry.items[1].fields.linked1.sys.type, 'Entry', 'third linked entity is resolved')
   t.ok(wrappedEntry.items[1].fields.linked1.fields, 'third linked entity has fields')
+  t.ok(wrappedCollection.stringifySafe(), 'stringifies safely')
   t.end()
 })