bookshelf-soft-delete/test/index.js

Soft Delete for Bookshelf.js

'use strict';

var lib = require('./lib'),
  knex = require('knex')(require('../knexfile').development),
  fs = require('fs'),
  path = require('path'),
  Collection = lib.Collection,
  Collection2 = lib.Collection2,
  Collection4 = lib.Collection4,
  should = require('should'),
  BPromise = require('bluebird'),
  Model = lib.Model,
  Model2 = lib.Model2,
  Model3 = lib.Model3,
  Model4 = lib.Model4,
  Model5 = lib.Model5;

describe('bookshelf soft delete', function () {
  before(function () {
    try {
      // delete if exists, we want to do this before the tests
      // if we delete after, can't use file for debugging
      fs.unlinkSync(path.join(__dirname, '../dev.sqlite3'));
    } catch (e) {}
    return knex.migrate.latest();
  });

  describe('given a few models', function () {
    var ids;
    var model4Ids;

    beforeEach(function () {
      return BPromise.all([
        Model.forge().save(),
        Model.forge().save(),
        Model.forge().save()
      ])
        .then(function (models) {
          ids = models.map(function (model) {
            return model.id;
          });

          return Model3
            .forge({ model1: ids[1] })
            .save();
        })
        .then(function () {
          return BPromise.all([
            Model4.forge({ foo: 'bar', qux: 'qix' }).save(),
            Model4.forge({ foo: 'bar' }).save(),
            Model4.forge().save()
          ]);
        })
        .then(function (models) {
          model4Ids = models.map(function (model) {
            return model.id;
          });
        });
    });

    afterEach(function () {
      return BPromise.map(ids, function (id) {
        return Model.forge({ id: id }).destroy({ softDelete: false });
      })
        .then(function () {
          return BPromise.map(model4Ids, function (id) {
            return Model4.forge({ id: id }).destroy({ softDelete: false });
          });
        });
    });

    it('should not affect model.fetch()', function () {
      return Model.forge({ id: ids[1] })
        .fetch()
        .then(function (model) {
          should.exist(model);
          model.id.should.equal(ids[1]);
        });
    });

    it('should not affect model.fetch() after a join query', function () {
      return Model
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': ids[1]
          });
        })
        .fetch()
        .then(function (model) {
          should.exist(model);
          model.id.should.equal(ids[1]);
        });
    });

    it('should not affect model count with no arguments', function () {
      return Model4
        .count()
        .then(function (count) {
          count.should.equal(3);
        });
    });

    it('should not affect model count', function () {
      return Model4
        .count('foo')
        .then(function (count) {
          count.should.equal(2);
        });
    });

    it('should not affect count after model where', function () {
      return Model4
        .where({ foo: 'bar' })
        .count('qux')
        .then(function (count) {
          count.should.equal(1);
        });
    });

    it('should not affect count after model query', function () {
      return Model4
        .query({ where: { foo: 'bar' } })
        .count('qux')
        .then(function (count) {
          count.should.equal(1);
        });
    });

    it('should not affect collection count with no arguments', function () {
      return (new Collection4())
        .count()
        .then(function (count) {
          count.should.equal(3);
        });
    });

    it('should not affect collection count', function () {
      return (new Collection4())
        .count('foo')
        .then(function (count) {
          count.should.equal(2);
        });
    });

    it('should not affect count after collection query', function () {
      return (new Collection4())
        .query({ where: { foo: 'bar' } })
        .count('qux')
        .then(function (count) {
          count.should.equal(1);
        });
    });
  });

  describe('A softDeleted model', function () {
    var id;
    var model4Ids;

    before(function () {
      var model = Model.forge();
      return model
        .save()
        .then(function () {
          id = model.id;
          return model.destroy();
        })
        .then(function () {
          return Model3
            .forge({ model1: id })
            .save();
        })
        .then(function () {
          return BPromise.all([
            Model4.forge({ foo: 'bar', qux: 'qix' }).save(),
            Model4.forge({ foo: 'bar' }).save(),
            Model4.forge().save()
          ]);
        })
        .then(function (models) {
          model4Ids = models.map(function (model4) {
            return model4.id;
          });

          return BPromise.map(model4Ids, function (model4Id) {
            return Model4.forge({ id: model4Id }).destroy();
          });
        });
    });

    it('should not be visible in model fetch', function () {
      return Model
        .forge({ id: id })
        .fetch()
        .then(function (model) {
          should.not.exist(model);
        });
    });

    it('should not be visible in model fetch after a join query', function () {
      return Model
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetch()
        .then(function (model) {
          should.not.exist(model);
        });
    });

    it('should not be visible in model count with no arguments', function () {
      return Model4
        .count()
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in model count', function () {
      return Model4
        .count('foo')
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in count after model where', function () {
      return Model4
        .where({ foo: 'bar' })
        .count('qux')
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in count after model query', function () {
      return Model4
        .query({ where: { foo: 'bar' } })
        .count('qux')
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in model fetchAll', function () {
      return Model
        .forge()
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(0);
        });
    });

    it('should not be visible in model fetchAll after a join query', function () {
      return Model
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(0);
        });
    });

    it('should be visible in model fetch with softDelete: false', function () {
      return Model
        .forge({ id: id })
        .fetch({ softDelete: false })
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be visible in model fetch after a join query with softDelete: false', function () {
      return Model
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetch({ softDelete: false })
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be visible in model count with no column argument and softDelete: false', function () {
      return Model4
        .count({ softDelete: false })
        .then(function (count) {
          count.should.equal(3);
        });
    });

    it('should be visible in model count with softDelete: false', function () {
      return Model4
        .count('foo', { softDelete: false })
        .then(function (count) {
          count.should.equal(2);
        });
    });

    it('should be visible in count with softDelete: false after model where', function () {
      return Model4
        .where({ foo: 'bar' })
        .count('qux', { softDelete: false })
        .then(function (count) {
          count.should.equal(1);
        });
    });

    it('should be visible in count with softDelete: false after model query', function () {
      return Model4
        .query({ where: { foo: 'bar' } })
        .count('qux', { softDelete: false })
        .then(function (count) {
          count.should.equal(1);
        });
    });

    it('should be visible in model fetchAll with softDelete: false', function () {
      return Model
        .forge()
        .fetchAll({ softDelete: false })
        .then(function (results) {
          results.length.should.equal(1);
        });
    });

    it('should be visible in model fetchAll after a join query with softDelete: false', function () {
      return Model
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetchAll({ softDelete: false })
        .then(function (results) {
          results.length.should.equal(1);
        });
    });

    it('should not be visible in fetches', function () {
      return (new Collection())
        .fetch()
        .then(function (results) {
          results.models.length.should.equal(0);
        });
    });

    it('should not be visible in fetches after a join query', function () {
      return (new Collection())
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetch()
        .then(function (results) {
          results.models.length.should.equal(0);
        });
    });

    it('should not be visible in fetchOne', function () {
      return (new Collection())
        .fetchOne()
        .then(function (result) {
          should.not.exist(result);
        });
    });

    it('should not be visible in fetchOne after a join query', function () {
      return (new Collection())
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetchOne()
        .then(function (result) {
          should.not.exist(result);
        });
    });

    it('should not be visible in collection count with no arguments', function () {
      return (new Collection4())
        .count()
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in collection count', function () {
      return (new Collection4())
        .count('foo')
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should not be visible in count after collection query', function () {
      return (new Collection4())
        .query({ where: { foo: 'bar' } })
        .count('qux')
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should be visible in fetchOne with softDelete: false', function () {
      return (new Collection())
        .fetchOne({ softDelete: false })
        .then(function (result) {
          should.exist(result);
        });
    });

    it('should be visible in fetchOne after a join query with softDelete: false', function () {
      return (new Collection())
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetchOne({ softDelete: false })
        .then(function (result) {
          should.exist(result);
        });
    });

    it('should be visible in fetches with softDelete: false', function () {
      return (new Collection())
        .fetch({ softDelete: false })
        .then(function (results) {
          results.models.length.should.equal(1);
        });
    });

    it('should be visible in fetches after a join query with softDelete: false', function () {
      return (new Collection())
        .query(function (qb) {
          qb.join('test3', 'test.id', 'test3.model1').where({
            'test3.model1': id
          });
        })
        .fetch({ softDelete: false })
        .then(function (results) {
          results.models.length.should.equal(1);
        });
    });

    it('should be visible in collection count with no column argument and softDelete: false', function () {
      return (new Collection4())
        .count({ softDelete: false })
        .then(function (count) {
          count.should.equal(3);
        });
    });

    it('should be visible in collection count with softDelete: false', function () {
      return (new Collection4())
        .count('foo', { softDelete: false })
        .then(function (count) {
          count.should.equal(2);
        });
    });

    it('should be visible in count with softDelete: false after collection query', function () {
      return (new Collection4())
        .query({ where: { foo: 'bar' } })
        .count('qux', { softDelete: false })
        .then(function (count) {
          count.should.equal(1);
        });
    });

    describe('when restored', function () {
      before(function () {
        return Model
          .forge({ id: id })
          .fetch({ softDelete: false })
          .then(function (model) {
            return model.restore();
          })
          .then(function () {
            return BPromise.map(model4Ids, function (model4Id) {
              return Model4
                .forge({ id: model4Id })
                .fetch({ softDelete: false })
                .then(function (model4) {
                  return model4.restore();
                });
            });
          });
      });

      it('should be visible in fetches', function () {
        return (new Collection())
          .fetch()
          .then(function (results) {
            results.models.length.should.equal(1);
          });
      });

      it('should be visible in fetches after a join query', function () {
        return (new Collection())
          .query(function (qb) {
            qb.join('test3', 'test.id', 'test3.model1').where({
              'test3.model1': id
            });
          })
          .fetch()
          .then(function (results) {
            results.models.length.should.equal(1);
          });
      });

      it('should be visible in fetchOne', function () {
        return (new Collection())
          .fetchOne()
          .then(function (result) {
            should.exist(result);
          });
      });

      it('should be visible in fetchOne after a join query', function () {
        return (new Collection())
          .query(function (qb) {
            qb.join('test3', 'test.id', 'test3.model1').where({
              'test3.model1': id
            });
          })
          .fetchOne()
          .then(function (result) {
            should.exist(result);
          });
      });

      it('should be visible in model count with no arguments', function () {
        return Model4
          .count()
          .then(function (count) {
            count.should.equal(3);
          });
      });

      it('should be visible in model count', function () {
        return Model4
          .count('foo')
          .then(function (count) {
            count.should.equal(2);
          });
      });

      it('should be visible in count after model where', function () {
        return Model4
          .where({ foo: 'bar' })
          .count('qux')
          .then(function (count) {
            count.should.equal(1);
          });
      });

      it('should be visible in count after model query', function () {
        return Model4
          .query({ where: { foo: 'bar' } })
          .count('qux')
          .then(function (count) {
            count.should.equal(1);
          });
      });

      it('should be visible in collection count with no arguments', function () {
        return (new Collection4())
          .count()
          .then(function (count) {
            count.should.equal(3);
          });
      });

      it('should be visible in collection count', function () {
        return (new Collection4())
          .count('foo')
          .then(function (count) {
            count.should.equal(2);
          });
      });

      it('should be visible in count after collection query', function () {
        return (new Collection4())
          .query({ where: { foo: 'bar' } })
          .count('qux')
          .then(function (count) {
            count.should.equal(1);
          });
      });
    });
  });
});

describe('bookshelf soft delete with named fields', function () {
  describe('given a few models', function () {
    var ids;

    beforeEach(function () {
      return BPromise.all([
        Model2.forge().save(),
        Model2.forge().save(),
        Model2.forge().save()
      ])
        .then(function (models) {
          ids = models.map(function (model) {
            return model.id;
          });

          return Model3
            .forge({ model2: ids[1] })
            .save();
        });
    });

    afterEach(function () {
      return BPromise.map(ids, function (id) {
        return Model2.forge({ id: id }).destroy({ softDelete: false });
      });
    });

    it('should not affect model.fetch()', function () {
      return Model2.forge({ id: ids[1] })
        .fetch()
        .then(function (model) {
          should.exist(model);
          model.id.should.equal(ids[1]);
        });
    });

    it('should not affect model.fetch() after a join query', function () {
      return Model2
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': ids[1]
          });
        })
        .fetch()
        .then(function (model) {
          should.exist(model);
          model.id.should.equal(ids[1]);
        });
    });
  });

  describe('A softDeleted model', function () {
    var id;

    before(function () {
      var model = Model2.forge();
      return model
        .save()
        .then(function () {
          id = model.id;
          return model.destroy();
        })
        .then(function () {
          return Model3
            .forge({ model2: id })
            .save();
        });
    });

    it('should not be visible in model fetch', function () {
      return Model2
        .forge({ id: id })
        .fetch()
        .then(function (model) {
          should.not.exist(model);
        });
    });

    it('should not be visible in model fetch after a join query', function () {
      return Model2
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetch()
        .then(function (model) {
          should.not.exist(model);
        });
    });

    it('should not be visible in model fetchAll', function () {
      return Model2
        .forge()
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(0);
        });
    });

    it('should not be visible in model fetchAll after a join query', function () {
      return Model2
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(0);
        });
    });

    it('should be visible in model fetch with softDelete: false', function () {
      return Model2
        .forge({ id: id })
        .fetch({ softDelete: false })
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be visible in model fetch after a join query with softDelete: false', function () {
      return Model2
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetch({ softDelete: false })
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be visible in model fetchAll with softDelete: false', function () {
      return Model2
        .forge()
        .fetchAll({ softDelete: false })
        .then(function (results) {
          results.length.should.equal(1);
        });
    });

    it('should be visible in model fetchAll after a join query with softDelete: false', function () {
      return Model2
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetchAll({ softDelete: false })
        .then(function (results) {
          results.length.should.equal(1);
        });
    });

    it('should not be visible in fetches', function () {
      return (new Collection2())
        .fetch()
        .then(function (results) {
          results.models.length.should.equal(0);
        });
    });

    it('should not be visible in fetches after a join query', function () {
      return (new Collection2())
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetch()
        .then(function (results) {
          results.models.length.should.equal(0);
        });
    });

    it('should not be visible in fetchOne', function () {
      return (new Collection2())
        .fetchOne()
        .then(function (result) {
          should.not.exist(result);
        });
    });

    it('should not be visible in fetchOne after a join query', function () {
      return (new Collection2())
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetchOne()
        .then(function (result) {
          should.not.exist(result);
        });
    });

    it('should be visible in fetchOne with softDelete: false', function () {
      return (new Collection2())
        .fetchOne({ softDelete: false })
        .then(function (result) {
          should.exist(result);
        });
    });

    it('should be visible in fetchOne after a join query with softDelete: false', function () {
      return (new Collection2())
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetchOne({ softDelete: false })
        .then(function (result) {
          should.exist(result);
        });
    });

    it('should be visible in fetches with softDelete: false', function () {
      return (new Collection2())
        .fetch({ softDelete: false })
        .then(function (results) {
          results.models.length.should.equal(1);
        });
    });

    it('should be visible in fetches after a join query with softDelete: false', function () {
      return (new Collection2())
        .query(function (qb) {
          qb.join('test3', 'test2.id', 'test3.model2').where({
            'test3.model2': id
          });
        })
        .fetch({ softDelete: false })
        .then(function (results) {
          results.models.length.should.equal(1);
        });
    });

    describe('when restored', function () {
      before(function () {
        return Model2
          .forge({ id: id })
          .fetch({ softDelete: false })
          .then(function (model) {
            return model.restore();
          });
      });

      it('should be visible in fetches', function () {
        return (new Collection2())
          .fetch()
          .then(function (results) {
            results.models.length.should.equal(1);
          });
      });

      it('should be visible in fetches after a join query', function () {
        return (new Collection2())
          .query(function (qb) {
            qb.join('test3', 'test2.id', 'test3.model2').where({
              'test3.model2': id
            });
          })
          .fetch()
          .then(function (results) {
            results.models.length.should.equal(1);
          });
      });

      it('should be visible in fetchOne', function () {
        return (new Collection2())
          .fetchOne()
          .then(function (result) {
            should.exist(result);
          });
      });

      it('should be visible in fetchOne after a join query', function () {
        return (new Collection2())
          .query(function (qb) {
            qb.join('test3', 'test2.id', 'test3.model2').where({
              'test3.model2': id
            });
          })
          .fetchOne()
          .then(function (result) {
            should.exist(result);
          });
      });
    });
  });
});

describe('bookshelf Model5 without restored at', function () {
  describe('when is not deleted', function () {
    var modelId;

    before(function () {
      return Model5.forge().save().then(function (model) {
        modelId = model.id;
      });
    });

    after(function () {
      return Model5
        .forge({ id: modelId })
        .destroy({softDelete: false });
    });

    it('should be visible in model fetch', function () {
      return Model5
        .forge({ id: modelId })
        .fetch()
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be visible in model fetchAll', function () {
      return Model5
        .forge()
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(1);
        });
    });

    it('should be visible in collection count', function () {
      return Model5
        .count()
        .then(function (count) {
          count.should.equal(1);
        });
    });
  });

  describe('when is deleted', function () {
    var modelId;

    before(function () {
      return Model5.forge().save().then(function (model) {
        model.destroy();
        modelId = model.id;
      });
    });

    it('should not be visible in model fetchAll', function () {
      return Model5
        .forge()
        .fetchAll()
        .then(function (results) {
          results.length.should.equal(0);
        });
    });

    it('should be visible in model fetchAll with softDelete: false', function () {
      return Model5
        .forge()
        .fetchAll({softDelete: false })
        .then(function (results) {
          results.at(0).get('id').should.equal(modelId);
        });
    });

    it('should not be visible in model fetch', function () {
      return Model5
        .forge({ id: modelId })
        .fetch()
        .then(function (model) {
          should.not.exist(model);
        });
    });

    it('should be visible in model fetch with softDelete: false', function () {
      return Model5
        .forge({ id: modelId })
        .fetch({softDelete: false })
        .then(function (model) {
          should.exist(model);
        });
    });

    it('should be invisible in collection count', function () {
      return Model5
        .count()
        .then(function (count) {
          count.should.equal(0);
        });
    });

    it('should be visible in collection count with softDelete: false', function () {
      return Model5
        .count({softDelete: false })
        .then(function (count) {
          count.should.equal(1);
        });
    });

    describe('when restored', function () {
      before(function () {
        return Model5
          .forge({ id: modelId })
          .fetch({softDelete: false })
          .then(function (model) {
            model.restore();
          });
      });
      it('should become visible in model fetch', function () {
        return Model5
          .forge({ id: modelId })
          .fetch()
          .then(function (model) {
            should.exist(model);
          });
      });
      it('should become visible in collection count', function () {
        return Model5
          .count()
          .then(function (count) {
            count.should.equal(1);
          });
      });
      it('should become visible in model fetchAll', function () {
        return Model5
          .forge()
          .fetchAll()
          .then(function (results) {
            results.at(0).get('id').should.equal(modelId);
          });
      });
    });
  });


  describe('A softDeleted model - transaction', function () {
    var id;

    before(function () {
      var model = Model.forge();
      return model
        .save()
        .then(function () {
          id = model.id;
        });
    });

    it('should not be visible in model fetch', function () {
      return knex.transaction(function (trx) {
        var opts = { transacting: trx };
        return Model
          .forge({ id: id })
          .fetch(opts)
          .then(function (model) {
            return model.destroy(opts);
          })
          .then(function () {
            return BPromise.all([
              Model.forge({ id: id }).fetch(opts),
              Model.forge({ id: id }).fetch()
            ]);
          })
          .spread(function (model1, model2) {
            should.not.exist(model1);
            should.exist(model2);
          });
      });
    });
  });
});