Merge pull request #131 from digitalsadhu/add_foreign_key_removal_configuration

Add foreign key removal configuration

Author: digitalsadhu

README.md

@@ -270,6 +270,55 @@ be output as attributes you can specify a whitelist of attributes for each type.
 #### note
 The attributes arrays are keyed by type not by model name. Type is the term used by JSON API to describe the resource type in question and while not required by JSON API it is usually plural. In `loopback-component-jsonapi` it is whatever the models `plural` is set to in `model.json`. So in our example above we defined: `"posts": ["title", "content"]` as the resource type for the `post` model is `posts`
 
+### foreignKeys
+Allows configuration of whether the component should expose foreign keys (which the jsonapi spec considers
+implementation details) from the attributes hash.
+
+#### examples
+
+Always expose foreign keys for all models
+```js
+{
+  ...
+  foreignKeys: true,
+  ...
+}
+```
+
+Never expose foreign keys for any models (default behaviour)
+```js
+{
+  ...
+  foreignKeys: false,
+  ...
+}
+```
+
+Only expose foreign keys for the commeht model
+```js
+{
+  ...
+  foreignKeys: [
+    {model: 'comment'}
+  ],
+  ...
+}
+```
+
+Only expose foreign keys for the comment model findById method. eg. `GET /api/comments/1`
+```js
+{
+  ...
+  foreignKeys: [
+    {model: 'comment', method: 'findById'}
+  ],
+  ...
+}
+```
+
+- Type: `boolean|array`
+- Default: `false`
+
 ## Custom Serialization
 For occasions where you need greater control over the serialization process, you can implement a custom serialization function for each model as needed. This function will be used instead of the regular serialization process.
 

lib/index.js

@@ -16,7 +16,8 @@ var debug = require('debug')('loopback-component-jsonapi')
 module.exports = function (app, options) {
   var defaultOptions = {
     restApiRoot: '/api',
-    enable: true
+    enable: true,
+    foreignKeys: false
   }
   options = options || {}
   options = _.defaults(options, defaultOptions)

lib/serializer.js

@@ -103,20 +103,34 @@ function parseResource (type, data, relations, options) {
     resource.relationships = relationships
   }
 
-  // Remove any foreign keys from this resource
-  options.app.models().forEach(function (model) {
-    _.each(model.relations, function (relation) {
-      var fkModel = relation.modelTo
-      var fkName = relation.keyTo
-      if (utils.relationFkOnModelFrom(relation)) {
-        fkModel = relation.modelFrom
-        fkName = relation.keyFrom
-      }
-      if (fkModel === options.model && fkName !== options.primaryKeyField) {
-        delete data[fkName]
-      }
+  if (options.foreignKeys !== true) {
+    // Remove any foreign keys from this resource
+    options.app.models().forEach(function (model) {
+      _.each(model.relations, function (relation) {
+        var fkModel = relation.modelTo
+        var fkName = relation.keyTo
+        if (utils.relationFkOnModelFrom(relation)) {
+          fkModel = relation.modelFrom
+          fkName = relation.keyFrom
+        }
+        if (fkModel === options.model && fkName !== options.primaryKeyField) {
+          // check options and decide whether to remove foreign keys.
+          if (options.foreignKeys !== false && Array.isArray(options.foreignKeys)) {
+            for (var i = 0; i < options.foreignKeys.length; i++) {
+              // if match on model
+              if (options.foreignKeys[i].model === fkModel.sharedClass.name) {
+                // if no method specified
+                if (!options.foreignKeys[i].method) return
+                // if method match
+                if (options.foreignKeys[i].method === options.method) return
+              }
+            }
+          }
+          delete data[fkName]
+        }
+      })
     })
-  })
+  }
 
   _.each(data, function (value, property) {
     if (property === options.primaryKeyField) {

package.json

@@ -39,7 +39,6 @@
     "type-is": "^1.6.9"
   },
   "devDependencies": {
-    "babel-eslint": "^6.1.0",
     "chai": "^3.3.0",
     "coveralls": "^2.11.9",
     "istanbul": "^0.4.2",

test/create.test.js

@@ -61,7 +61,7 @@ describe('loopback json api component create method', function () {
       // waiting on a fix
       // see https://github.com/visionmedia/superagent/issues/753
       query(app).post('/posts', data, options, function (err, res) {
-        if (err) console.log(err)
+        expect(err).to.equal(null)
         expect(res.headers['content-type']).to.match(/application\/vnd\.api\+json/)
         expect(res.statusCode).to.equal(201)
         expect(res.body).to.have.all.keys('data')

test/foreign-keys.test.js

@@ -0,0 +1,123 @@
+var request = require('supertest')
+var loopback = require('loopback')
+var expect = require('chai').expect
+var JSONAPIComponent = require('../')
+var app
+var Post
+var Comment
+
+describe('foreign key configuration', function () {
+  beforeEach(function (done) {
+    app = loopback()
+    app.set('legacyExplorer', false)
+    var ds = loopback.createDataSource('memory')
+
+    Post = ds.createModel('post', { title: String })
+    app.model(Post)
+
+    Comment = ds.createModel('comment', { comment: String })
+    app.model(Comment)
+
+    Comment.belongsTo(Post)
+    Post.hasMany(Comment)
+
+    app.use(loopback.rest())
+
+    Post.create({title: 'my post'}, function (err, post) {
+      if (err) throw err
+      post.comments.create({comment: 'my comment'}, done)
+    })
+  })
+
+  describe('by default, foreign keys are not exposed through the api', function () {
+    beforeEach(function () {
+      JSONAPIComponent(app)
+    })
+    it('should remove foreign keys from model before output', function (done) {
+      request(app).get('/comments/1')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data.attributes).to.not.include.key('postId')
+          done()
+        })
+    })
+  })
+
+  describe('configuring component to always expose foreign keys through the api', function () {
+    beforeEach(function () {
+      JSONAPIComponent(app, {
+        foreignKeys: true
+      })
+    })
+    it('should not remove foreign keys from models before output', function (done) {
+      request(app).get('/comments/1')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data.attributes).to.include.key('postId')
+          done()
+        })
+    })
+  })
+
+  describe('configuring component to expose foreign keys for post model through the api', function () {
+    beforeEach(function () {
+      JSONAPIComponent(app, {
+        foreignKeys: [
+          {model: 'post'}
+        ]
+      })
+    })
+    it('should not expose postId on comment model', function (done) {
+      request(app).get('/comments/1')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data.attributes).to.not.include.key('postId')
+          done()
+        })
+    })
+  })
+
+  describe('configuring component to expose foreign keys for comment model through the api', function () {
+    beforeEach(function () {
+      JSONAPIComponent(app, {
+        foreignKeys: [
+          {model: 'comment'}
+        ]
+      })
+    })
+    it('should expose postId on comment model', function (done) {
+      request(app).get('/comments/1')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data.attributes).to.include.key('postId')
+          done()
+        })
+    })
+  })
+
+  describe('configuring component to expose foreign keys for comment model method findById through the api', function () {
+    beforeEach(function () {
+      JSONAPIComponent(app, {
+        foreignKeys: [
+          {model: 'comment', method: 'findById'}
+        ]
+      })
+    })
+    it('should not expose foreign keys in find all', function (done) {
+      request(app).get('/comments')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data[0].attributes).to.not.include.key('postId')
+          done()
+        })
+    })
+    it('should expose foreign keys in find', function (done) {
+      request(app).get('/comments/1')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body.data.attributes).to.include.key('postId')
+          done()
+        })
+    })
+  })
+})