Merge pull request #13 from holidayextras/FP-1042

dont include linked resources already present in the response

Author: Dave Butt

lib/pluginJsonapi.js

@@ -61,6 +61,7 @@ pluginJsonApi.alsoMakeItSo = function alsoMakeItSo (request, reply) {
     var stateObject = {
       request: request,
       resources: resources,
+      linked: result.linked,
       proxyableKeys: proxyableKeys
     }
 

lib/utilities.js

@@ -161,15 +161,17 @@ utilities.getSubResources = function getSubResources (stateObject) {
   }
 
   stateObject.subResourceRequests = {}
-
   // Loop the resources and pad out any required hrefs
   _.forEach(resourceArray, function (resource) {
     // If there's no links then there's no actions to take
     if (resource.links) {
-      // Loop all the includes and pad out our subResourceRequest array
+      // Loop all the includes and if required pad out our subResourceRequest array
       _.forEach(stateObject.includes, function (include) {
-        // If we have links to the requested include, chalk it up
-        if (resource.links && resource.links[include]) {
+        if (stateObject.linked && stateObject.linked[include]) {
+          // We already have these resources
+          return
+        }
+        if (resource.links[include]) {
           utilities._addSubResourceRequest(stateObject.subResourceRequests, resource.links[include])
         }
       })

package.json

@@ -1,7 +1,7 @@
 {
   "name": "plugin-jsonapi",
   "description": "A hapi plugin for a jsonapi style output according to our 'house rules'",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "homepage": "https://github.com/holidayextras/plugin-jsonapi",
   "author": {
     "name": "Shortbreaks",

test/lib/utilitiesTest.js

@@ -113,6 +113,63 @@ describe('utilities', function () {
 
       return expect(utilities.getSubResources(stateObject)).to.eventually.deep.equal(stateObject)
     })
+
+    it('should not attach any already linked sub resources', function () {
+      var stateObject = {
+        resources: [
+          {
+            id: 'ID',
+            links: {
+              LINK1: {
+                ids: ['LINK_ID1'],
+                type: 'LINK1'
+              }
+            }
+          }
+        ],
+        includes: ['LINK1'],
+        linked: {
+          LINK1: []
+        }
+      }
+
+      var expected = _.cloneDeep(stateObject)
+      expected.subResourceRequests = {}
+
+      return expect(utilities.getSubResources(stateObject)).to.eventually.deep.equal(expected)
+    })
+
+    it('should not attach any already linked sub resources, but still add unlinked ones', function () {
+      var stateObject = {
+        resources: [
+          {
+            id: 'ID',
+            links: {
+              LINK1: {
+                ids: ['LINK_ID1'],
+                type: 'LINK1'
+              },
+              LINK2: {
+                ids: ['LINK_ID2'],
+                type: 'LINK2'
+              }
+            }
+          }
+        ],
+        includes: ['LINK1', 'LINK2'],
+        linked: {
+          LINK1: []
+        }
+      }
+
+      var expected = _.cloneDeep(stateObject)
+      expected.subResourceRequests = {
+        LINK2: {
+          ids: ['LINK_ID2']
+        }
+      }
+      return expect(utilities.getSubResources(stateObject)).to.eventually.deep.equal(expected)
+    })
   })
 
   describe('#resolveLinkedData', function () {
@@ -356,7 +413,6 @@ describe('utilities', function () {
       expect(links).to.be.deep.equal(expected)
     })
   })
-  // _requestSubResource
 
   describe('#collectProxyableValues', function () {
     var stateObject = {