loopback/test/relations.integration.js

var loopback = require('../');
var lt = require('loopback-testing');
var path = require('path');
var SIMPLE_APP = path.join(__dirname, 'fixtures', 'simple-integration-app');
var app = require(path.join(SIMPLE_APP, 'app.js'));
var assert = require('assert');
var expect = require('chai').expect;
var debug = require('debug')('loopback:test:relations.integration');
var async = require('async');

describe('relations - integration', function () {

  lt.beforeEach.withApp(app);

  lt.beforeEach.givenModel('store');
  beforeEach(function(done) {
    this.widgetName = 'foo';
    this.store.widgets.create({
      name: this.widgetName
    }, function() {
      done();
    });
  });
  afterEach(function(done) {
    this.app.models.widget.destroyAll(done);
  });

  describe('/store/:id/widgets', function () {
    beforeEach(function() {
      this.url = '/api/stores/' + this.store.id + '/widgets';
    });
    lt.describe.whenCalledRemotely('GET', '/api/stores/:id/widgets', function() {

      it('should succeed with statusCode 200', function() {
        assert.equal(this.res.statusCode, 200);
      });
      describe('widgets (response.body)', function() {
        beforeEach(function() {
          debug('GET /api/stores/:id/widgets response: %s' +
              '\nheaders: %j\nbody string: %s',
            this.res.statusCode,
            this.res.headers,
            this.res.text);
          this.widgets = this.res.body;
          this.widget = this.res.body && this.res.body[0];
        });      
        it('should be an array', function() {
          assert(Array.isArray(this.widgets));
        });
        it('should include a single widget', function() {
          assert(this.widgets.length === 1);
          assert(this.widget);
        });
        it('should be a valid widget', function() {
          assert(this.widget.id);
          assert.equal(this.widget.storeId, this.store.id);
          assert.equal(this.widget.name, this.widgetName);
        });
      });
    });
    describe('POST /api/store/:id/widgets', function() {
      beforeEach(function() {
        this.newWidgetName = 'baz';
        this.newWidget = {
          name: this.newWidgetName
        };
      });
      beforeEach(function(done) {
        this.http = this.post(this.url, this.newWidget);
        this.http.send(this.newWidget);
        this.http.end(function(err) {
          if(err) return done(err);
          this.req = this.http.req;
          this.res = this.http.res;
          done();
        }.bind(this));
      });
      it('should succeed with statusCode 200', function() {
        assert.equal(this.res.statusCode, 200);
      });
      describe('widget (response.body)', function() {
        beforeEach(function() {
          this.widget = this.res.body;
        });      
        it('should be an object', function() {
          assert(typeof this.widget === 'object');
          assert(!Array.isArray(this.widget));
        });
        it('should be a valid widget', function() {
          assert(this.widget.id);
          assert.equal(this.widget.storeId, this.store.id);
          assert.equal(this.widget.name, this.newWidgetName);
        });
      });
      it('should have a single widget with storeId', function (done) {
        this.app.models.widget.count({
          storeId: this.store.id
        }, function(err, count) {
          if(err) return done(err);
          assert.equal(count, 2);
          done();
        });
      });
    });
  });

  describe('/widgets/:id/store', function () {
    beforeEach(function (done) {
      var self = this;
      this.store.widgets.create({
        name: this.widgetName
      }, function(err, widget) {
        self.widget = widget;
        self.url = '/api/widgets/' + self.widget.id + '/store';
        done();
      });
    });
    lt.describe.whenCalledRemotely('GET', '/api/widgets/:id/store', function () {
      it('should succeed with statusCode 200', function () {
        assert.equal(this.res.statusCode, 200);
        assert.equal(this.res.body.id, this.store.id);
      });
    });
  });

  describe('hasMany through', function() {

    function setup(connecting, cb) {
      var root = {};

      async.series([
        // Clean up models
        function (done) {
          app.models.physician.destroyAll(function (err) {
            app.models.patient.destroyAll(function (err) {
              app.models.appointment.destroyAll(function (err) {
                done();
              });
            });
          });
        },

        // Create a physician
        function (done) {
          app.models.physician.create({
            name: 'ph1'
          }, function (err, physician) {
            root.physician = physician;
            done();
          });
        },

        // Create a patient
        connecting ? function (done) {
          root.physician.patients.create({
            name: 'pa1'
          }, function (err, patient) {
            root.patient = patient;
            root.relUrl = '/api/physicians/' + root.physician.id
              + '/patients/rel/' + root.patient.id;
            done();
          });
        } : function (done) {
          app.models.patient.create({
            name: 'pa1'
          }, function (err, patient) {
            root.patient = patient;
            root.relUrl = '/api/physicians/' + root.physician.id
              + '/patients/rel/' + root.patient.id;
            done();
          });
        }], function (err, done) {
        cb(err, root);
      });
    }

    describe('PUT /physicians/:id/patients/rel/:fk', function () {

      before(function (done) {
        var self = this;
        setup(false, function (err, root) {
          self.url = root.relUrl;
          self.patient = root.patient;
          self.physician = root.physician;
          done();
        });
      });

      lt.describe.whenCalledRemotely('PUT', '/api/physicians/:id/patients/rel/:fk', function () {
        it('should succeed with statusCode 200', function () {
          assert.equal(this.res.statusCode, 200);
          assert.equal(this.res.body.patientId, this.patient.id);
          assert.equal(this.res.body.physicianId, this.physician.id);
        });

        it('should create a record in appointment', function (done) {
          var self = this;
          app.models.appointment.find(function (err, apps) {
            assert.equal(apps.length, 1);
            assert.equal(apps[0].patientId, self.patient.id);
            done();
          });
        });

        it('should connect physician to patient', function (done) {
          var self = this;
          self.physician.patients(function (err, patients) {
            assert.equal(patients.length, 1);
            assert.equal(patients[0].id, self.patient.id);
            done();
          });
        });
      });
    });

    describe('DELETE /physicians/:id/patients/rel/:fk', function () {

      before(function (done) {
        var self = this;
        setup(true, function (err, root) {
          self.url = root.relUrl;
          self.patient = root.patient;
          self.physician = root.physician;
          done();
        });
      });

      it('should create a record in appointment', function (done) {
        var self = this;
        app.models.appointment.find(function (err, apps) {
          assert.equal(apps.length, 1);
          assert.equal(apps[0].patientId, self.patient.id);
          done();
        });
      });

      it('should connect physician to patient', function (done) {
        var self = this;
        self.physician.patients(function (err, patients) {
          assert.equal(patients.length, 1);
          assert.equal(patients[0].id, self.patient.id);
          done();
        });
      });

      lt.describe.whenCalledRemotely('DELETE', '/api/physicians/:id/patients/rel/:fk', function () {
        it('should succeed with statusCode 200', function () {
          assert.equal(this.res.statusCode, 200);
        });

        it('should remove the record in appointment', function (done) {
          var self = this;
          app.models.appointment.find(function (err, apps) {
            assert.equal(apps.length, 0);
            done();
          });
        });

        it('should remove the connection between physician and patient', function (done) {
          var self = this;
          // Need to refresh the cache
          self.physician.patients(true, function (err, patients) {
            assert.equal(patients.length, 0);
            done();
          });
        });
      });
    });

    describe('GET /physicians/:id/patients/:fk', function () {

      before(function (done) {
        var self = this;
        setup(true, function (err, root) {
          self.url = '/api/physicians/' + root.physician.id
            + '/patients/' + root.patient.id;
          self.patient = root.patient;
          self.physician = root.physician;
          done();
        });
      });

      lt.describe.whenCalledRemotely('GET', '/api/physicians/:id/patients/:fk', function () {
        it('should succeed with statusCode 200', function () {
          assert.equal(this.res.statusCode, 200);
          assert.equal(this.res.body.id, this.physician.id);
        });
      });
    });

    describe('DELETE /physicians/:id/patients/:fk', function () {

      before(function (done) {
        var self = this;
        setup(true, function (err, root) {
          self.url = '/api/physicians/' + root.physician.id
            + '/patients/' + root.patient.id;
          self.patient = root.patient;
          self.physician = root.physician;
          done();
        });
      });

      lt.describe.whenCalledRemotely('DELETE', '/api/physicians/:id/patients/:fk', function () {
        it('should succeed with statusCode 200', function () {
          assert.equal(this.res.statusCode, 200);
        });

        it('should remove the record in appointment', function (done) {
          var self = this;
          app.models.appointment.find(function (err, apps) {
            assert.equal(apps.length, 0);
            done();
          });
        });

        it('should remove the connection between physician and patient', function (done) {
          var self = this;
          // Need to refresh the cache
          self.physician.patients(true, function (err, patients) {
            assert.equal(patients.length, 0);
            done();
          });
        });

        it('should remove the record in patient', function (done) {
          var self = this;
          app.models.patient.find(function (err, patients) {
            assert.equal(patients.length, 0);
            done();
          });
        });

      });
    });
  });

  describe('hasAndBelongsToMany', function() {
    beforeEach(function defineProductAndCategoryModels() {
      var product = app.model(
        'product',
        { properties: { id: 'string', name: 'string' }, dataSource: 'db' }

      );
      var category = app.model(
        'category',
        { properties: { id: 'string', name: 'string' }, dataSource: 'db' }
      );
      product.hasAndBelongsToMany(category);
      category.hasAndBelongsToMany(product);
    });

    lt.beforeEach.givenModel('category');

    beforeEach(function createProductsInCategory(done) {
      var test = this;
      this.category.products.create({
        name: 'a-product'
      }, function(err, product) {
        if (err) return done(err);
        test.product = product;
        done();
      });
    });

    beforeEach(function createAnotherCategoryAndProduct(done) {
      app.models.category.create({ name: 'another-category' },
        function(err, cat) {
          if (err) return done(err);
          cat.products.create({ name: 'another-product' }, done);
        });
    });

    afterEach(function(done) {
      this.app.models.product.destroyAll(done);
    });

    it.skip('allows to find related objects via where filter', function(done) {
      //TODO https://github.com/strongloop/loopback-datasource-juggler/issues/94
      var expectedProduct = this.product;
      this.get('/api/products?filter[where][categoryId]=' + this.category.id)
        .expect(200, function(err, res) {
          if (err) return done(err);
          expect(res.body).to.eql([
            {
              id: expectedProduct.id,
              name: expectedProduct.name
            }
          ]);
          done();
        });
    });

    it('allows to find related object via URL scope', function(done) {
      var expectedProduct = this.product;
      this.get('/api/categories/' + this.category.id + '/products')
        .expect(200, function(err, res) {
          if (err) return done(err);
          expect(res.body).to.eql([
            {
              id: expectedProduct.id,
              name: expectedProduct.name
            }
          ]);
          done();
        });
    });

    it('includes requested related models in `find`', function(done) {
      var expectedProduct = this.product;
      var url = '/api/categories/findOne?filter[where][id]=' +
        this.category.id + '&filter[include]=products';

      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.have.property('products');
          expect(res.body.products).to.eql([
            {
              id: expectedProduct.id,
              name: expectedProduct.name
            }
          ]);
          done();
        });
    });

    it.skip('includes requested related models in `findById`', function(done) {
      //TODO https://github.com/strongloop/loopback-datasource-juggler/issues/93
      var expectedProduct = this.product;
      // Note: the URL format is not final
      var url = '/api/categories/' + this.category.id + '?include=products';

      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.have.property('products');
          expect(res.body.products).to.eql([
            {
              id: expectedProduct.id,
              name: expectedProduct.name
            }
          ]);
          done();
        });
    });
  });
  
  describe('embedsMany', function() {
    
    before(function defineProductAndCategoryModels() {
      var todoList = app.model(
        'todoList',
        { properties: { name: 'string' }, 
          dataSource: 'db',
          plural: 'todo-lists' 
        }
      );
      var todoItem = app.model(
        'todoItem',
        { properties: { content: 'string' }, dataSource: 'db' }
      );
      todoList.embedsMany(todoItem, { as: 'items' });
    });

    before(function createTodoList(done) {
      var test = this;
      app.models.todoList.create({ name: 'List A' },
        function(err, list) {
          if (err) return done(err);
          test.todoList = list;
          list.items.build({ content: 'Todo 1' });
          list.items.build({ content: 'Todo 2' });
          list.save(done);
        });
    });

    after(function(done) {
      this.app.models.todoList.destroyAll(done);
    });
    
    it('includes the embedded models', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id;

      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body.name).to.be.equal('List A');
          expect(res.body.todoItems).to.be.eql([ 
            { content: 'Todo 1', id: 1 },
            { content: 'Todo 2', id: 2 }
          ]);
          done();
        });
    });
    
    it('returns the embedded models', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items';
      
      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql([ 
            { content: 'Todo 1', id: 1 },
            { content: 'Todo 2', id: 2 }
          ]);
          done();
        });
    });
    
    it('filters the embedded models', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items';
      url += '?filter[where][id]=2';
      
      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql([ 
            { content: 'Todo 2', id: 2 }
          ]);
          done();
        });
    });
    
    it('creates embedded models', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items';
      var listId = this.todoList.id;
      
      var expected = [ 
        { content: 'Todo 1', id: 1 },
        { content: 'Todo 2', id: 2 },
        { content: 'Todo 3', id: 3 }
      ];
      
      this.post(url)
        .send({ content: 'Todo 3' })
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql(expected);
          done();
        });
    });
    
    it('returns the embedded models', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items';
      
      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql([ 
            { content: 'Todo 1', id: 1 },
            { content: 'Todo 2', id: 2 },
            { content: 'Todo 3', id: 3 }
          ]);
          done();
        });
    });
    
    it('returns an embedded model by (internal) id', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items/3';
      
      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql(
            { content: 'Todo 3', id: 3 }
          );
          done();
        });
    });
    
    it('removes an embedded model', function(done) {
      var expectedProduct = this.product;
      var url = '/api/todo-lists/' + this.todoList.id + '/items/2';
      
      this.del(url)
        .expect(200, function(err, res) {
          done();
        });
    });
    
    it('returns the embedded models - verify', function(done) {
      var url = '/api/todo-lists/' + this.todoList.id + '/items';
      
      this.get(url)
        .expect(200, function(err, res) {
          expect(res.body).to.be.eql([ 
            { content: 'Todo 1', id: 1 },
            { content: 'Todo 3', id: 3 }
          ]);
          done();
        });
    });
    
    // TODO - this.head is undefined
    
    it.skip('checks if an embedded model exists - ok', function(done) {
      var expectedProduct = this.product;
      var url = '/api/todo-lists/' + this.todoList.id + '/items/3';
      
      this.head(url)
        .expect(200, function(err, res) {
          done();
        });
    });
    
    it.skip('checks if an embedded model exists - fail', function(done) {
      var expectedProduct = this.product;
      var url = '/api/todo-lists/' + this.todoList.id + '/items/2';
      
      this.head(url)
        .expect(404, function(err, res) {
          done();
        });
    });
    
  });
  
});