[+] Resources Remover - Add resources remover (bulk destroy) (#293)

Author: rap2hpoutre

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [Unreleased]
 ### Added
 - Technical - Add optional chaining plugin to babel.
+- Resources Remover - Add resources remover (bulk destroy).
 
 ### Changed
 - Technical - Upgrade to babel 7 stable.

src/index.js

@@ -63,6 +63,7 @@ exports.init = (opts) => {
   exports.ResourceUpdater = require('./services/resource-updater');
   exports.ResourceRemover = require('./services/resource-remover');
   exports.ResourcesExporter = require('./services/resources-exporter');
+  exports.ResourcesRemover = require('./services/resources-remover');
   exports.EmbeddedDocumentUpdater = require('./services/embedded-document-updater');
 
   exports.HasManyGetter = require('./services/has-many-getter');

src/services/errors.js

@@ -12,5 +12,13 @@ function InvalidFiltersFormatError(message) {
 }
 InvalidFiltersFormatError.prototype = new Error();
 
+function InvalidParameterError(message) {
+  this.name = 'InvalidParameterError';
+  this.message = message || 'The given parameter is invalid.';
+  this.stack = (new Error()).stack;
+}
+InvalidParameterError.prototype = new Error();
+
 exports.NoMatchingOperatorError = NoMatchingOperatorError;
 exports.InvalidFiltersFormatError = InvalidFiltersFormatError;
+exports.InvalidParameterError = InvalidParameterError;

src/services/resources-remover.js

@@ -0,0 +1,13 @@
+const { InvalidParameterError } = require('./errors');
+
+function ResourcesRemover(model, ids) {
+  this.perform = () => {
+    if (!Array.isArray(ids) || !ids.length) {
+      throw new InvalidParameterError('`ids` must be a non-empty array.');
+    }
+
+    return model.deleteMany({ _id: ids });
+  };
+}
+
+module.exports = ResourcesRemover;

test/tests/services/resources-remover.test.js

@@ -0,0 +1,75 @@
+import mongoose from 'mongoose';
+import loadFixture from 'mongoose-fixture-loader';
+import Interface from 'forest-express';
+import ResourcesRemover from '../../../src/services/resources-remover';
+import mongooseConnect from '../../utils/mongoose-connect';
+import { InvalidParameterError } from '../../../src/services/errors';
+
+describe('service > resources-remover', () => {
+  let IslandModel;
+
+  beforeAll(() => {
+    Interface.Schemas = {
+      schemas: {
+        Island: {
+          name: 'Island',
+          idField: '_id',
+          searchFields: ['name'],
+          fields: [
+            { field: '_id', type: 'String' },
+            { field: 'name', type: 'String' },
+          ],
+        },
+      },
+    };
+
+    return mongooseConnect()
+      .then(() => {
+        const IslandSchema = mongoose.Schema({
+          name: { type: String },
+        });
+
+        IslandModel = mongoose.model('Island', IslandSchema);
+        return IslandModel.remove({});
+      });
+  });
+
+  afterAll(() => mongoose.connection.close());
+
+  beforeEach(async () => {
+    await IslandModel.remove({});
+    await loadFixture(IslandModel, [
+      { name: 'Kauai', _id: '56cb91bdc3464f14678934ca' },
+      { name: 'Oahu', _id: '56cb91bdc3464f14678934cb' },
+    ]);
+  });
+
+
+  it('should throw error if ids is not an array or empty', () => {
+    expect.assertions(3);
+    expect(() => new ResourcesRemover(null, []).perform()).toThrow(InvalidParameterError);
+    expect(() => new ResourcesRemover(null, 'foo').perform()).toThrow(InvalidParameterError);
+    expect(() => new ResourcesRemover(null, {}).perform()).toThrow(InvalidParameterError);
+  });
+
+  it('should remove one resource with existing ID', async () => {
+    expect.assertions(1);
+    await new ResourcesRemover(IslandModel, ['56cb91bdc3464f14678934ca']).perform();
+    const documentsCount = await IslandModel.countDocuments();
+    expect(documentsCount).toStrictEqual(1);
+  });
+
+  it('should remove all resources with existing ID', async () => {
+    expect.assertions(1);
+    await new ResourcesRemover(IslandModel, ['56cb91bdc3464f14678934ca', '56cb91bdc3464f14678934cb']).perform();
+    const documentsCount = await IslandModel.countDocuments();
+    expect(documentsCount).toStrictEqual(0);
+  });
+
+  it('should not remove resource with not existing ID', async () => {
+    expect.assertions(1);
+    await new ResourcesRemover(IslandModel, ['56cb91bdc3464f14678934cd']).perform();
+    const documentsCount = await IslandModel.countDocuments();
+    expect(documentsCount).toStrictEqual(2);
+  });
+});