forked from Masquerade-Circus/mongoose-history-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
331 lines (277 loc) · 10.2 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
let JsonDiffPatch = require('jsondiffpatch'),
semver = require('semver');
let historyPlugin = (options = {}) => {
let pluginOptions = {
modelName: '__histories', // Name of the collection for the histories
embeddedDocument: false, // Is this a sub document
embeddedModelName: '', // Name of model if used with embedded document
userCollection: 'users', // Collection to ref when you pass an user id
accountCollection: 'accounts', // Collection to ref when you pass an account id or the item has an account property
userFieldName: 'user', // Name of the property for the user
accountFieldName: 'account', // Name of the property of the account if any
timestampFieldName: 'timestamp', // Name of the property of the timestamp
methodFieldName: 'method', // Name of the property of the method
ignore: [], // List of fields to ignore when compare changes
noDiffSave: false, // Save event even if there are no changes
noDiffSaveOnMethods: [], // Save event even if there are no changes if method matches
noEventSave: true,
mongoose: false
};
Object.assign(pluginOptions, options);
if (pluginOptions.mongoose === false) {
throw new Error('You need to pass a mongoose instance');
}
let mongoose = pluginOptions.mongoose;
let Schema = new mongoose.Schema(
{
collectionName: String,
collectionId: { type: mongoose.Schema.Types.ObjectId },
diff: {},
event: String,
reason: String,
data: { type: mongoose.Schema.Types.Mixed },
[pluginOptions.userFieldName]: {
type: mongoose.Schema.Types.ObjectId,
ref: pluginOptions.userCollection
},
[pluginOptions.accountFieldName]: {
type: mongoose.Schema.Types.ObjectId,
ref: pluginOptions.accountCollection
},
version: { type: String, default: '0.0.0' },
[pluginOptions.timestampFieldName]: Date,
[pluginOptions.methodFieldName]: String
},
{
collection: pluginOptions.modelName
}
);
Schema.set('minimize', false);
Schema.set('versionKey', false);
Schema.set('strict', true);
Schema.pre('save', function (next) {
this[pluginOptions.timestampFieldName] = new Date();
next();
});
let Model = mongoose.model(pluginOptions.modelName, Schema);
let getModelName = (defaultName) => {
return pluginOptions.embeddedDocument ? pluginOptions.embeddedModelName : defaultName;
};
let jdf = JsonDiffPatch.create({
objectHash: function (obj, index) {
if (obj !== undefined) {
return (
(obj._id && obj._id.toString()) ||
obj.id ||
obj.key ||
'$$index:' + index
);
}
return '$$index:' + index;
},
arrays: {
detectMove: true
}
});
let query = (method = 'find', options = {}) => {
let query = Model[method](options.find || {});
if (options.select !== undefined) {
Object.assign(options.select, {
_id: 0,
collectionId: 0,
collectionName: 0
});
query.select(options.select);
}
options.sort && query.sort(options.sort);
options.populate && query.populate(options.populate);
options.limit && query.limit(options.limit);
return query.lean();
};
return function (schema) {
schema.add({
__history: { type: mongoose.Schema.Types.Mixed }
});
let preSave = function (forceSave) {
return function (next) {
if (this.__history !== undefined || pluginOptions.noEventSave) {
let getPrevious;
if (pluginOptions.embeddedDocument) {
// because the new version would have been saved already by the parent,
// get the older version from the history collection
getPrevious = this.getVersions().then(versions => {
return versions[0] ?
versions[0].object :
{};
});
} else {
getPrevious = this.constructor.findById(this._id);
}
return getPrevious
.then((previous) => {
let currentObject = JSON.parse(JSON.stringify(this)),
previousObject = previous
? JSON.parse(JSON.stringify(previous))
: {};
delete currentObject.__history;
delete previousObject.__history;
delete currentObject.__v;
delete previousObject.__v;
for (let i in pluginOptions.ignore) {
delete currentObject[pluginOptions.ignore[i]];
delete previousObject[pluginOptions.ignore[i]];
}
let diff = jdf.diff(previousObject, currentObject);
let saveWithoutDiff = false;
if (this.__history && pluginOptions.noDiffSaveOnMethods.length) {
let method = this.__history[pluginOptions.methodFieldName];
if (pluginOptions.noDiffSaveOnMethods.includes(method)) {
saveWithoutDiff = true;
if (forceSave) {
diff = previousObject;
}
}
}
if (diff || pluginOptions.noDiffSave || saveWithoutDiff) {
return Model.findOne({
collectionName: getModelName(this.constructor.modelName),
collectionId: this._id
})
.sort('-' + pluginOptions.timestampFieldName)
.select({ version: 1 })
.then((lastHistory) => {
let obj = {};
obj.collectionName = getModelName(this.constructor.modelName);
obj.collectionId = this._id;
obj.diff = diff || {};
if (this.__history) {
obj.event = this.__history.event;
obj[pluginOptions.userFieldName] = this.__history[
pluginOptions.userFieldName
];
obj[pluginOptions.accountFieldName] =
this[pluginOptions.accountFieldName] ||
this.__history[pluginOptions.accountFieldName];
obj.reason = this.__history.reason;
obj.data = this.__history.data;
obj[pluginOptions.methodFieldName] = this.__history[
pluginOptions.methodFieldName
];
}
let version;
if (lastHistory) {
let type =
this.__history && this.__history.type
? this.__history.type
: 'major';
version = semver.inc(lastHistory.version, type);
}
obj.version = version || '0.0.0';
for (let i in obj) {
if (obj[i] === undefined) {
delete obj[i];
}
}
let history = new Model(obj);
this.__history = undefined;
return history.save();
});
}
})
.then(() => next())
// Call next with error
.catch(next);
}
next();
};
};
schema.pre('save', preSave(false));
schema.pre('remove', preSave(true));
// diff.find
schema.methods.getDiffs = function (options = {}) {
options.find = options.find || {};
Object.assign(options.find, {
collectionName: getModelName(this.constructor.modelName),
collectionId: this._id
});
options.sort = options.sort || '-' + pluginOptions.timestampFieldName;
return query('find', options);
};
// diff.get
schema.methods.getDiff = function (version, options = {}) {
options.find = options.find || {};
Object.assign(options.find, {
collectionName: getModelName(this.constructor.modelName),
collectionId: this._id,
version: version
});
options.sort = options.sort || '-' + pluginOptions.timestampFieldName;
return query('findOne', options);
};
// versions.get
schema.methods.getVersion = function (version2get, includeObject = true) {
return this.getDiffs({
sort: pluginOptions.timestampFieldName
}).then((histories) => {
let lastVersion = histories[histories.length - 1],
firstVersion = histories[0],
history,
version = {};
if (semver.gt(version2get, lastVersion.version)) {
version2get = lastVersion.version;
}
if (semver.lt(version2get, firstVersion.version)) {
version2get = firstVersion.version;
}
histories.map((item) => {
if (item.version === version2get) {
history = item;
}
});
if (!includeObject) {
return history;
}
histories.map((item) => {
if (
semver.lt(item.version, version2get) ||
item.version === version2get
) {
version = jdf.patch(version, item.diff);
}
});
delete history.diff;
history.object = version;
return history;
});
};
// versions.compare
schema.methods.compareVersions = function (versionLeft, versionRight) {
return this.getVersion(versionLeft).then((versionLeft) => {
return this.getVersion(versionRight).then((versionRight) => {
return {
diff: jdf.diff(versionLeft.object, versionRight.object),
left: versionLeft.object,
right: versionRight.object
};
});
});
};
// versions.find
schema.methods.getVersions = function (options = {}, includeObject = true) {
options.sort = options.sort || pluginOptions.timestampFieldName;
return this.getDiffs(options).then((histories) => {
if (!includeObject) {
return histories;
}
let version = {};
for (let i = 0; i < histories.length; i++) {
version = jdf.patch(version, histories[i].diff);
histories[i].object = jdf.clone(version);
delete histories[i].diff;
}
return histories;
});
};
};
};
module.exports = historyPlugin;