Resolves devour-js#263 added a means to disable attaching relationshi…

…p metadata on unresolved includes
ibustosatlegalzoom · Jul 18, 2024 · 9b06500 · 9b06500
1 parent 0ffa3df
commit 9b06500
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 7 deletions.
diff --git a/src/index.js b/src/index.js
@@ -70,7 +70,8 @@ class JsonApi {
       auth: {},
       bearer: null,
       trailingSlash: { collection: false, resource: false },
-      disableErrorsForMissingResourceDefinitions: false
+      disableErrorsForMissingResourceDefinitions: false,
+      attachRelationshipDataOnUnresolvedIncludes: true
     }
 
     const deprecatedConstructors = (args) => {
@@ -95,6 +96,7 @@ class JsonApi {
     this.apiUrl = options.apiUrl
     this.bearer = options.bearer
     this.disableErrorsForMissingResourceDefinitions = options.disableErrorsForMissingResourceDefinitions
+    this.attachRelationshipDataOnUnresolvedIncludes = options.attachRelationshipDataOnUnresolvedIncludes
     this.models = {}
     this.deserialize = deserialize
     this.serialize = serialize

diff --git a/src/middleware/json-api/_deserialize.js b/src/middleware/json-api/_deserialize.js
@@ -120,10 +120,13 @@ function attachHasOneFor (model, attribute, item, included, key) {
     return resource.call(this, relatedItems[0], included, true)
   }
 
-  const relationshipData = _get(item.relationships, [key, 'data'], false)
-  if (relationshipData) {
-    return relationshipData
+  if (this.attachRelationshipDataOnUnresolvedIncludes) {
+    const relationshipData = _get(item.relationships, [key, 'data'], false)
+    if (relationshipData) {
+      return relationshipData
+    }
   }
+
   return null
 }
 
@@ -137,9 +140,11 @@ function attachHasManyFor (model, attribute, item, included, key) {
     return collection.call(this, relatedItems, included, true)
   }
 
-  const relationshipData = _get(item.relationships, [key, 'data'], false)
-  if (relationshipData) {
-    return relationshipData
+  if (this.attachRelationshipDataOnUnresolvedIncludes) {
+    const relationshipData = _get(item.relationships, [key, 'data'], false)
+    if (relationshipData) {
+      return relationshipData
+    }
   }
 
   return []

diff --git a/test/api/deserialize-test.js b/test/api/deserialize-test.js
@@ -426,4 +426,81 @@ describe('deserialize', () => {
     expect(product.tags[1].id).to.eql('6')
     expect(product.tags[1].type).to.eql('tags')
   })
+
+  it('should not include relationship data on unresolved hasMany relationships if attachRelationshipDataOnUnresolvedIncludes flag is set to false', () => {
+    jsonApi = new JsonApi({
+      apiUrl: 'http://myapi.com',
+      attachRelationshipDataOnUnresolvedIncludes: false
+    })
+    jsonApi.define('product', {
+      title: '',
+      tags: {
+        jsonApi: 'hasMany',
+        type: 'tag'
+      }
+    })
+    jsonApi.define('tag', {
+      name: ''
+    })
+    const mockResponse = {
+      data: {
+        id: '1',
+        type: 'products',
+        attributes: {
+          title: 'hello'
+        },
+        relationships: {
+          tags: {
+            data: [
+              { id: '5', type: 'tags' },
+              { id: '6', type: 'tags' }
+            ]
+          }
+        }
+      }
+    }
+    const product = deserialize.resource.call(jsonApi, mockResponse.data, mockResponse.included)
+    expect(product.id).to.eql('1')
+    expect(product.type).to.eql('products')
+    expect(product.title).to.eql('hello')
+    expect(product.tags).to.be.an('array')
+    expect(product.tags).to.be.empty()
+  })
+
+  it('should not include relationship data on unresolved hasOne relationships if attachRelationshipDataOnUnresolvedIncludes flag is set to false', () => {
+    jsonApi = new JsonApi({
+      apiUrl: 'http://myapi.com',
+      attachRelationshipDataOnUnresolvedIncludes: false
+    })
+    jsonApi.define('product', {
+      title: '',
+      tag: {
+        jsonApi: 'hasOne',
+        type: 'tag'
+      }
+    })
+    jsonApi.define('tag', {
+      name: ''
+    })
+    const mockResponse = {
+      data: {
+        id: '1',
+        type: 'products',
+        attributes: {
+          title: 'hello'
+        },
+        relationships: {
+          tag: {
+            data: { id: '5', type: 'tag' }
+          }
+        }
+      }
+    }
+    const product = deserialize.resource.call(jsonApi, mockResponse.data, mockResponse.included)
+    expect(product.id).to.eql('1')
+    expect(product.type).to.eql('products')
+    expect(product.title).to.eql('hello')
+    expect(product.tag).to.not.be.an('array')
+    expect(product.tag).to.eql(null)
+  })
 })