Merge pull request #235 from rocknrolla777/fix-include-filter

parse include filter

Author: digitalsadhu

lib/serialize.js

@@ -102,7 +102,7 @@ module.exports = function (app, defaults) {
 
     // If we're sideloading, we need to add the includes
     if (ctx.req.isSideloadingRelationships) {
-      requestedIncludes = ctx.req.remotingContext.args.filter.include
+      requestedIncludes = utils.setRequestedIncludes(ctx.req.remotingContext.args.filter.include)
     }
 
     if (model.definition.settings.scope) {
@@ -119,7 +119,7 @@ module.exports = function (app, defaults) {
       if (typeof include === 'string') {
         requestedIncludes.push(include)
       } else if (_.isArray(include)) {
-        requestedIncludes = requestedIncludes.concat(include)
+        requestedIncludes = requestedIncludes.concat(utils.setRequestedIncludes(include))
       }
     }
 

lib/utils.js

@@ -19,6 +19,7 @@ module.exports = {
   shouldNotApplyJsonApi: shouldNotApplyJsonApi,
   shouldApplyJsonApi: shouldApplyJsonApi,
   relationFkOnModelFrom: relationFkOnModelFrom,
+  setRequestedIncludes: setRequestedIncludes,
   setIncludedRelations: setIncludedRelations
 }
 
@@ -238,3 +239,23 @@ function setIncludedRelations (relations, app) {
   }
   return relations
 }
+
+function setRequestedIncludes (include) {
+  if (!include) return undefined
+
+  if (typeof include === 'string') {
+    return include
+  }
+  if (include instanceof Array) {
+    return include.map(function (inc) {
+      if (typeof inc === 'string') {
+        return inc
+      }
+
+      if (inc instanceof Object) {
+        return inc.relation
+      }
+    })
+  }
+  return include
+}

test/scopeInclude.test.js

@@ -127,6 +127,28 @@ describe('include option', function () {
             done()
           })
       })
+      it('should include comments', function (done) {
+        request(app)
+          .get('/posts/1?filter={"include":["comments"]}')
+          .end(function (err, res) {
+            expect(err).to.equal(null)
+            expect(res.body.included.length).equal(2)
+            expect(res.body.included[0].type).equal('comments')
+            expect(res.body.included[1].type).equal('comments')
+            done()
+          })
+      })
+      it('should include categories with empty attributes object', function (done) {
+        request(app)
+          .get('/posts/1?filter={"include":[{"relation":"category", "scope": {"fields": ["id"]}}]}')
+          .end(function (err, res) {
+            expect(err).to.equal(null)
+            expect(res.body.included.length).equal(3)
+            expect(res.body.included[0].type).equal('categories')
+            expect(res.body.included[0].attributes).to.include({})
+            done()
+          })
+      })
     })
   })
 })