Skip to content

Mongoose 7+ Callback Fix #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mongoose 7+ Callback Fix #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
var mongoose = require('mongoose'),
Schema = mongoose.Schema,
Model = mongoose.Model,
util = require('util');
Model = mongoose.Model;

/**
* This code is taken from official mongoose repository
Expand Down Expand Up @@ -84,6 +83,12 @@ module.exports = function (schema, options) {
var mainUpdateMethod = mongooseMajorVersion < 5 ? 'update' : 'updateMany';
var mainUpdateWithDeletedMethod = mainUpdateMethod + 'WithDeleted';

function adjustCallbackForMongooseVersion(callback) {
// Since Mongoose 7, callback support has been fully removed in favor of Promises and async/await.
// See: https://mongoosejs.com/docs/migrating_to_7.html#dropped-callback-support
return mongooseMajorVersion >= 7 ? undefined : callback;
}

function updateDocumentsByQuery(schema, conditions, updateQuery, callback) {
if (schema[mainUpdateWithDeletedMethod]) {
return schema[mainUpdateWithDeletedMethod](conditions, updateQuery, { multi: true }, callback);
Expand Down Expand Up @@ -228,12 +233,14 @@ module.exports = function (schema, options) {
});
}

schema.methods.delete = function (deletedBy, cb) {
schema.methods.delete = function (deletedBy, callback) {
if (typeof deletedBy === 'function') {
cb = deletedBy;
callback = deletedBy;
deletedBy = null;
}

callback = adjustCallbackForMongooseVersion(callback);

this.deleted = true;

if (schema.path('deletedAt')) {
Expand All @@ -245,10 +252,10 @@ module.exports = function (schema, options) {
}

if (options.validateBeforeDelete === false) {
return this.save({ validateBeforeSave: false }, cb);
return this.save({ validateBeforeSave: false }, callback);
}

return this.save(cb);
return this.save(callback);
};

schema.statics.delete = function (conditions, deletedBy, callback) {
Expand All @@ -262,6 +269,8 @@ module.exports = function (schema, options) {
deletedBy = null;
}

callback = adjustCallbackForMongooseVersion(callback);

var doc = {
deleted: true
};
Expand All @@ -283,6 +292,8 @@ module.exports = function (schema, options) {
throw new TypeError(msg);
}

callback = adjustCallbackForMongooseVersion(callback);

var conditions = {
_id: id
};
Expand All @@ -295,6 +306,8 @@ module.exports = function (schema, options) {
this.deletedAt = undefined;
this.deletedBy = undefined;

callback = adjustCallbackForMongooseVersion(callback);

if (options.validateBeforeRestore === false) {
return this.save({ validateBeforeSave: false }, callback);
}
Expand All @@ -308,6 +321,8 @@ module.exports = function (schema, options) {
conditions = {};
}

callback = adjustCallbackForMongooseVersion(callback);

var doc = {
$unset:{
deleted: true,
Expand All @@ -318,4 +333,4 @@ module.exports = function (schema, options) {

return updateDocumentsByQuery(this, conditions, doc, callback);
};
};
};
161 changes: 161 additions & 0 deletions test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,167 @@ describe("mongoose_delete plugin without options, using option: typeKey", functi
});
});

describe('mongoose_delete plugin with pre delete middleware', function () {
var Test1Schema = new Schema(
{ name: String },
{ collection: 'mongoose_delete_test1' }
);
Test1Schema.pre('delete', async function () {
if (this.save) {
this.name = 'masked-name';
await this.save();
}
});
Test1Schema.plugin(mongoose_delete);
var Test1 = mongoose.model('TestModelWithPreDeleteMiddleware', Test1Schema);

var puffy1 = null;
var puffy2 = null;

beforeEach(async function () {
const created = await Test1.create([
{ name: 'Puffy1' },
{ name: 'Puffy2' }
]);

puffy1 = { ...created[0]._doc };
puffy2 = { ...created[1]._doc };
});

afterEach(async function () {
await mongoose.connection.db.dropCollection('mongoose_delete_test1');
});

it('delete() -> should set deleted:true and name:masked-name', async function () {
try {
const puffy = await Test1.findOne({ name: 'Puffy1' });
const success = await puffy.delete('testman');
success.deleted.should.equal(true);
success.name.should.equal('masked-name');
} catch (err) {
should.not.exist(err);
}
});

it("delete() -> should not save 'deletedAt' value", async function () {
try {
const puffy = await Test1.findOne({ name: 'Puffy1' });
const success = await puffy.delete();
should.not.exist(success.deletedAt);
} catch (err) {
should.not.exist(err);
}
});

it("deleteById() -> should set deleted:true and not save 'deletedAt'", async function () {
try {
const documents = await Test1.deleteById(puffy2._id);
expect(documents).to.be.mongoose_ok();
expect(documents).to.be.mongoose_count(1);

const doc = await Test1.findOne({ name: 'Puffy2' });
doc.deleted.should.equal(true);
should.not.exist(doc.deletedAt);
} catch (err) {
should.not.exist(err);
}
});

it('deleteById() -> should throw an exception: first argument error', async function () {
try {
await Test1.deleteById();
} catch (error) {
expect(error.message).to.equal(
'First argument is mandatory and must not be a function.'
);
}
});

it('restoreMany() -> should set deleted:false', async function () {
try {
await Test1.restore({ name: 'Puffy1' });
const puffy = await Test1.findOne({ name: 'Puffy1' });

puffy.deleted.should.equal(false);
should.not.exist(puffy.deletedBy);
} catch (e) {
should.not.exist(e);
}
});
});

describe("mongoose_delete plugin with pre delete middleware and options: { deletedBy : true }", function () {

var TestSchema = new Schema({name: String}, {collection: 'mongoose_delete_test3'});
TestSchema.pre('delete', async function () {
if (this.save) {
this.name = 'masked-name';
await this.save();
}
});
TestSchema.plugin(mongoose_delete, { deletedBy: true });
var Test3 = mongoose.model('TestModelWithPreDeleteMiddlewareAndDeleteBy', TestSchema);

var puffy1 = null;
var puffy2 = null;

beforeEach(async function () {
const created = await Test3.create(
[
{ name: 'Puffy1' },
{ name: 'Puffy2' },
{ name: 'Puffy3', deleted: true, deletedBy: "53da93b16b4a6670076b16bf" }
]
);

puffy1 = { ...created[0]._doc };
puffy2 = { ...created[1]._doc };
});

afterEach(async function () {
await mongoose.connection.db.dropCollection("mongoose_delete_test3");
});

var userId = getNewObjectId("53da93b16b4a6670076b16bf");

it("delete() -> should save 'deletedBy' key and mask name", async function () {
try {
const puffy = await Test3.findOne({ name: 'Puffy1' });
const success = await puffy.delete(userId);
success.deletedBy.should.equal(userId);
success.name.should.equal('masked-name');
} catch (err) {
should.not.exist(err);
}
});

it("deleteById() -> should save `deletedBy` key", async function () {
try {
const documents = await Test3.deleteById(puffy2._id, userId)

expect(documents).to.be.mongoose_ok();
expect(documents).to.be.mongoose_count(1);

const doc = await Test3.findOne({name: 'Puffy2'});
doc.deleted.should.equal(true);
doc.deletedBy.toString().should.equal(userId.toString());
} catch (err) {
should.not.exist(err);
}
});

it("restore() -> should set deleted:false and delete `deletedBy` key", async function () {
try {
const puffy = await Test3.findOne({ name: 'Puffy3' });
const success = await puffy.restore();
success.deleted.should.equal(false);
should.not.exist(success.deletedBy);
} catch (err) {
should.not.exist(err);
}
});
});

describe("mongoose_delete with options: { deletedAt : true }", function () {
var Test2Schema = new Schema({name: String}, {collection: 'mongoose_delete_test2'});
Test2Schema.plugin(mongoose_delete, { deletedAt: true });
Expand Down