fix: Freeze only sys on returned objects

contentful · May 11, 2016 · b27897f · b27897f
1 parent 5978510
commit b27897f
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 8 deletions.
diff --git a/lib/entities/asset.js b/lib/entities/asset.js
@@ -1,5 +1,6 @@
 import {cloneDeep} from 'lodash/lang'
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
 
 /**
  * @memberof Entities
@@ -23,7 +24,7 @@ import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
  * @return {Asset} Wrapped asset data
  */
 export function wrapAsset (data) {
-  return Object.freeze(mixinToPlainObject(cloneDeep(data)))
+  return freezeSys(mixinToPlainObject(cloneDeep(data)))
 }
 
 /**
@@ -42,5 +43,5 @@ export function wrapAsset (data) {
  * @return {AssetCollection} Wrapped asset collection data
  */
 export function wrapAssetCollection (data) {
-  return Object.freeze(mixinToPlainObject(cloneDeep(data)))
+  return freezeSys(mixinToPlainObject(cloneDeep(data)))
 }
diff --git a/lib/entities/content-type.js b/lib/entities/content-type.js
@@ -1,5 +1,6 @@
 import {cloneDeep} from 'lodash/lang'
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
 
 /**
  * @memberof Entities
@@ -18,7 +19,7 @@ import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
  * @return {ContentType} Wrapped content type data
  */
 export function wrapContentType (data) {
-  return Object.freeze(mixinToPlainObject(cloneDeep(data)))
+  return freezeSys(mixinToPlainObject(cloneDeep(data)))
 }
 
 /**
@@ -37,5 +38,5 @@ export function wrapContentType (data) {
  * @return {ContentTypeCollection} Wrapped content type collection data
  */
 export function wrapContentTypeCollection (data) {
-  return Object.freeze(mixinToPlainObject(cloneDeep(data)))
+  return freezeSys(mixinToPlainObject(cloneDeep(data)))
 }
diff --git a/lib/entities/entry.js b/lib/entities/entry.js
@@ -1,6 +1,7 @@
 import {cloneDeep} from 'lodash/lang'
 import {uniq} from 'lodash/array'
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
 import mixinLinkGetters from '../mixins/link-getters'
 import mixinStringifySafe from '../mixins/stringify-safe'
 
@@ -75,7 +76,7 @@ import mixinStringifySafe from '../mixins/stringify-safe'
  * @return {Entry} Wrapped entry data
  */
 export function wrapEntry (data) {
-  return Object.freeze(mixinToPlainObject(cloneDeep(data)))
+  return freezeSys(mixinToPlainObject(cloneDeep(data)))
 }
 
 /**
@@ -103,7 +104,7 @@ export function wrapEntryCollection (data, resolveLinks) {
     const includes = prepareIncludes(wrappedData.includes, wrappedData.items)
     mixinLinkGetters(wrappedData.items, includes)
   }
-  return Object.freeze(wrappedData)
+  return freezeSys(wrappedData)
 }
 
 function prepareIncludes (includes = {}, items) {

diff --git a/lib/entities/space.js b/lib/entities/space.js
@@ -1,4 +1,5 @@
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
 
 /**
  * @memberof Entities
@@ -17,5 +18,5 @@ import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
  * @return {Space}
  */
 export function wrapSpace (data) {
-  return Object.freeze(mixinToPlainObject(data))
+  return freezeSys(mixinToPlainObject(data))
 }
diff --git a/lib/paged-sync.js b/lib/paged-sync.js
@@ -5,6 +5,7 @@
 import {filter} from 'lodash/collection'
 import {cloneDeep} from 'lodash/lang'
 import createRequestConfig from 'contentful-sdk-core/create-request-config'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
 import mixinLinkGetters from './mixins/link-getters'
 import mixinStringifySafe from './mixins/stringify-safe'
 import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
@@ -69,7 +70,7 @@ export default function pagedSync (http, query, resolveLinks) {
     // maps response items again after getters are attached
     const mappedResponseItems = mapResponseItems(response.items)
     mappedResponseItems.nextSyncToken = response.nextSyncToken
-    return Object.freeze(mixinStringifySafe(mixinToPlainObject(mappedResponseItems)))
+    return freezeSys(mixinStringifySafe(mixinToPlainObject(mappedResponseItems)))
   }, (error) => {
     throw error.data
   })

diff --git a/test/unit/contentful-test.js b/test/unit/contentful-test.js
@@ -30,6 +30,8 @@ test('Passes along HTTP client parameters', (t) => {
 })
 
 test('Returns a client instance', (t) => {
+  const createHttpClientStub = sinon.stub()
+  createClient.__Rewire__('createHttpClient', createHttpClientStub)
   const client = createClient(axios, {accessToken: 'accesstoken', space: 'spaceid'})
   t.ok(client.getSpace, 'getSpace')
   t.ok(client.getEntry, 'getEntry')
@@ -38,31 +40,41 @@ test('Returns a client instance', (t) => {
   t.ok(client.getContentTypes, 'getContentTypes')
   t.ok(client.getAsset, 'getAsset')
   t.ok(client.getAssets, 'getAssets')
+  createClient.__ResetDependency__('createHttpClient')
   t.end()
 })
 
 test('Initializes API with link resolution turned on by default', (t) => {
+  const createHttpClientStub = sinon.stub()
+  createClient.__Rewire__('createHttpClient', createHttpClientStub)
   const apiStub = sinon.stub().returns({})
   createClient.__Rewire__('createContentfulApi', apiStub)
   createClient(axios, {accessToken: 'accesstoken', space: 'spaceid'})
   t.ok(apiStub.args[0][0].shouldLinksResolve({}), 'not overriden by query')
   t.notOk(apiStub.args[0][0].shouldLinksResolve({resolveLinks: false}), 'overriden by query')
+  createClient.__ResetDependency__('createHttpClient')
   t.end()
 })
 
 test('Initializes API with link resolution turned on explicitly', (t) => {
+  const createHttpClientStub = sinon.stub()
+  createClient.__Rewire__('createHttpClient', createHttpClientStub)
   const apiStub = sinon.stub().returns({})
   createClient.__Rewire__('createContentfulApi', apiStub)
   createClient(axios, {accessToken: 'accesstoken', space: 'spaceid', resolveLinks: true})
   t.ok(apiStub.args[0][0].shouldLinksResolve({}), 'not overriden by query')
   t.notOk(apiStub.args[0][0].shouldLinksResolve({resolveLinks: false}), 'overriden by query')
+  createClient.__ResetDependency__('createHttpClient')
   t.end()
 })
 
 test('Initializes API with link resolution turned off explicitly', (t) => {
+  const createHttpClientStub = sinon.stub()
+  createClient.__Rewire__('createHttpClient', createHttpClientStub)
   const apiStub = sinon.stub().returns({})
   createClient.__Rewire__('createContentfulApi', apiStub)
   createClient(axios, {accessToken: 'accesstoken', space: 'spaceid', resolveLinks: false})
   t.notOk(apiStub.args[0][0].resolveLinksGlobalSetting)
+  createClient.__ResetDependency__('createHttpClient')
   t.end()
 })