forked from nielsgl/sequelize-paper-trail
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
455 lines (400 loc) · 12.3 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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
'use strict';
var Sequelize = require('sequelize');
var diff = require('deep-diff').diff;
var jsdiff = require('diff');
var _ = require('lodash');
var helpers = require('./helpers');
export default (sequelize: sequelize, options: object): object => {
// console.log(message); // eslint-disable-line
var defaultAttributes = {
documentId: 'documentId',
revisionId: 'revisionId'
};
// if no options are passed the function
if(!options){
options = {};
}
// enable debug logging
var debug = false;
if(options.debug) {
debug = options.debug;
}
// TODO: implement logging option
var log = options.log || console.log;
// show the current sequelize and options objects
if (debug) {
// log('sequelize object:');
// log(sequelize);
log('options object:');
log(options);
}
// attribute name for revision number in the models
if(!options.revisionAttribute){
options.revisionAttribute = "revision";
}
// fields we want to exclude from audit trails
if(!options.exclude){
options.exclude = [
"id",
"createdAt",
"updatedAt",
"deletedAt", // if the model is paranoid
"created_at",
"updated_at",
"deleted_at",
options.revisionAttribute
];
}
// model name for revision table
if(!options.revisionModel){
options.revisionModel = "Revision";
}
// model name for revision changes tables
if(!options.revisionChangeModel){
options.revisionChangeModel = "RevisionChange";
}
// support UUID for postgresql
if(options.UUID === undefined){
options.UUID = false;
}
// underscored created and updated attributes
if(!options.underscored) {
options.underscored = false;
}
if(!options.underscoredAttributes) {
options.underscoredAttributes = false;
options.defaultAttributes = defaultAttributes;
} else {
options.defaultAttributes = helpers.toUnderscored(defaultAttributes);
}
// HACK to track the user that made the changes
// TODO: needs to be implemented
if(!options.userModel) {
options.userModel = false;
}
// full revisions or compressed revisions (track only the difference in models)
// default: full revisions
if(!options.enableCompression) {
options.enableCompression = false;
}
// add the column to the database if it doesn't exist
if(!options.enableMigration) {
options.enableMigration = false;
}
// enable strict diff
// when true: 10 !== '10'
// when false: 10 == '10'
// default: true
if(!options.enableStrictDiff) {
options.enableStrictDiff = true;
}
if (debug) {
log('parsed options:');
log(options);
}
// order in which sequelize processes the hooks
// (1)
// beforeBulkCreate(instances, options, fn)
// beforeBulkDestroy(instances, options, fn)
// beforeBulkUpdate(instances, options, fn)
// (2)
// beforeValidate(instance, options, fn)
// (-)
// validate
// (3)
// afterValidate(instance, options, fn)
// - or -
// validationFailed(instance, options, error, fn)
// (4)
// beforeCreate(instance, options, fn)
// beforeDestroy(instance, options, fn)
// beforeUpdate(instance, options, fn)
// (-)
// create
// destroy
// update
// (5)
// afterCreate(instance, options, fn)
// afterDestroy(instance, options, fn)
// afterUpdate(instance, options, fn)
// (6)
// afterBulkCreate(instances, options, fn)
// afterBulkDestroy(instances, options, fn)
// afterBulkUpdate(instances, options, fn)
// Extend model prototype with "enableAuditTrails" function
// Call model.enableAuditTrails() to enable revisions for model
_.extend(sequelize.Model.prototype, {
hasPaperTrail: function () {
if(debug) { log('Enabling paper trail on', this.name); }
this.attributes[options.revisionAttribute] = {
type: Sequelize.INTEGER,
defaultValue: 0
}
this.revisionable = true;
this.refreshAttributes();
if(options.enableMigration) {
var tableName: string = this.getTableName();
sequelize.getQueryInterface().describeTable(tableName)
.then(function(attributes: any) {
if(!attributes[options.revisionAttribute]) {
if(debug) { log('adding revision attribute to the database'); }
sequelize.getQueryInterface().addColumn(
tableName,
options.revisionAttribute,
{
type: Sequelize.INTEGER,
defaultValue: 0
}
).then(() => {
return null;
}).catch((err: any) => {
log('something went really wrong..');
log(err);
return null;
});
}
return null;
});
}
this.addHook("beforeCreate", beforeHook);
this.addHook("beforeUpdate", beforeHook);
this.addHook("afterCreate", afterHook);
this.addHook("afterUpdate", afterHook);
// create association
this.hasMany(sequelize.models[options.revisionModel], {
foreignKey: "document_id",
constraints: false,
scope: {
model: this.name
}
});
return this;
}
});
var beforeHook = function(instance: object, opt: object) {
if(debug) {
log('beforeHook called');
log('instance:');
log(instance);
log('opt:');
log(opt);
}
if(options.enableCompression) {
var previousVersion = {};
var currentVersion = {};
_.forEach(opt.defaultFields, (a: string) => {
previousVersion[a] = instance._previousDataValues[a];
currentVersion[a] = instance.dataValues[a];
});
} else {
var previousVersion = instance._previousDataValues;
var currentVersion = instance.dataValues;
}
// Disallow change of revision
instance.set(options.revisionAttribute, instance._previousDataValues[options.revisionAttribute]);
// Get diffs
var delta = helpers.calcDelta(previousVersion, currentVersion, options.exclude, options.enableStrictDiff);
if(debug) {
log('delta:');
log(delta);
}
if(delta && delta.length > 0){
instance.set(options.revisionAttribute, (instance.get(options.revisionAttribute) || 0) + 1);
if(!instance.context){
instance.context = {};
}
instance.context.delta = delta;
}
if(debug) { log('end of beforeHook'); }
};
var afterHook = function(instance: object, opt: object) {
if(debug) {
log('afterHook called');
log('instance:', instance);
log('opt:', opt);
}
var ns = process.namespaces['current_user_request'];
if(instance.context && instance.context.delta && instance.context.delta.length > 0) {
var Revision = sequelize.model(options.revisionModel);
var RevisionChange = sequelize.model(options.revisionChangeModel);
var delta = instance.context.delta;
if(options.enableCompression) {
var previousVersion = {};
var currentVersion = {};
_.forEach(opt.defaultFields, (a: string) => {
previousVersion[a] = instance._previousDataValues[a];
currentVersion[a] = instance.dataValues[a];
});
} else {
var previousVersion = instance._previousDataValues;
var currentVersion = instance.dataValues;
}
// TODO: so we can also track who made the changes to the model
if (false) {
var user = opt.user;
if(!user && instance.context && instance.context.user){
user = instance.context.user;
}
}
// Build revision
var revision = Revision.build({
model: opt.model.name,
document_id: instance.get("id"),
// TODO: Hacky, but necessary to get immutable current representation
document: currentVersion,
user_id: ns.get('current_user_id')
});
revision[options.revisionAttribute] = instance.get(options.revisionAttribute);
// Save revision
return revision.save()
.then(function(revision: any) {
// Loop diffs and create a revision-diff for each
_.forEach(delta, function(difference: any) {
var o = helpers.diffToString(difference.item ? difference.item.lhs : difference.lhs);
var n = helpers.diffToString(difference.item ? difference.item.rhs : difference.rhs);
var d = RevisionChange.build({
path: difference.path[0],
document: difference,
//revisionId: data.id,
diff: o || n ? jsdiff.diffChars(o, n) : []
});
d.save()
.then(function(d: any){
// Add diff to revision
revision['add' + options.revisionChangeModel](d);
return null;
})
.catch((err: any) => {
log('RevisionChange save error');
log(err);
throw err;
});
});
return null;
})
.catch((err: object) => {
log('Revision save error');
log(err);
throw err;
});
}
if(debug) { log('end of afterHook'); }
};
return {
// Return defineModels()
defineModels: function(db: object) {
var attributes = {
model: {
type: Sequelize.TEXT,
allowNull: false
},
document: {
type: Sequelize.JSON,
allowNull: false
}
};
attributes[options.defaultAttributes.documentId] = {
type: Sequelize.INTEGER,
allowNull: false,
};
attributes[options.revisionAttribute] = {
type: Sequelize.INTEGER,
allowNull: false
};
if(debug) {
log('attributes');
log(attributes);
}
if(options.UUID){
attributes.id = {
primaryKey: true,
type: Sequelize.UUID,
defaultValue: Sequelize.UUIDV4
};
attributes.documentId.type = Sequelize.UUID;
}
// Revision model
var Revision = sequelize.define(options.revisionModel, attributes, {
classMethods: {
associate: function(models: any) {
Revision.belongsTo(sequelize.model(options.userModel));
}
},
underscored: options.underscored
});
attributes = {
path: {
type: Sequelize.TEXT,
allowNull: false
},
document: {
type: Sequelize.JSON,
allowNull: false
},
diff: {
type: Sequelize.JSON,
allowNull: false
}
};
if(options.UUID){
attributes.id = {
primaryKey: true,
type: Sequelize.UUID,
defaultValue: Sequelize.UUIDV4
};
}
// RevisionChange model
var RevisionChange = sequelize.define(options.revisionChangeModel, attributes, {
underscored: options.underscored
});
// Set associations
Revision.hasMany(RevisionChange, {
foreignKey: options.defaultAttributes.revisionId,
constraints: false
});
RevisionChange.belongsTo(Revision);
db[Revision.name] = Revision;
db[RevisionChange.name] = RevisionChange;
// TODO: Option to track the user that triggered the revision
if (false && options.userModel) {
Revision.belongsTo(sequelize.model(options.userModel), {
foreignKey: "user_id",
constraints: true,
as: "user"
});
}
return Revision;
},
enableUserRevisions: function(db: object) {
console.log('hello user');
console.log(options)
if(!db[options.revisionChangeModel].attributes['user_id']) {
console.log('adding user_id');
// sequelize.getQueryInterface().addColumn(
// 'Brokerages',
// 'id',
// {
// allowNull: false,
// autoIncrement: true,
// primaryKey: true,
// type: Sequelize.INTEGER
// }
// ).then(function (x) {
// // console.log(x);
// })
// console.log(db.sequelize)
db.sequelize.models[options.revisionChangeModel].belongsTo(sequelize.model(options.userModel), {
foreignKey: "user_id",
constraints: false,
as: "user"
});
}
console.log(db[options.revisionChangeModel].attributes)
// db[options.revisionChangeModel].belongsTo(db[options.userModel], {
// foreignKey: 'user_id',
// constraints: false
// });
// return db;
}
}
};