forked from bkniffler/sequelize-revisions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
244 lines (225 loc) · 7.42 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
var Sequelize = require("sequelize");
var diff = require("deep-diff").diff;
var jsdiff = require("diff");
var _ = require('lodash');
module.exports = function(sequelize, options){
if(!options){
options = {};
}
if(!options.exclude){
options.exclude = [
"id", "createdAt", "updatedAt"
];
}
if(!options.revisionAttribute){
options.revisionAttribute = "revision";
}
if(!options.revisionModel){
options.revisionModel = "revision";
}
if(!options.revisionChangeModel){
options.revisionChangeModel = "revision-change";
}
if(options.UUID === undefined){
options.UUID = false;
}
var log = options.log || console.log;
// Extend model prototype with "isRevisionable" function
// Call model.isRevisionable() to enable revisions for model
_.extend(sequelize.Model.prototype, {
enableRevisions: function () {
log("Enable revisions on " + this.name);
this.attributes["revision"] = {
type: Sequelize.INTEGER,
defaultValue: 0
}
this.revisionable = true;
this.refreshAttributes();
this.addHook("afterCreate", after);
this.addHook("afterUpdate", after);
this.addHook("beforeCreate", before);
this.addHook("beforeUpdate", before);
return this;
}
});
// Before create/update augment revision
var before = function(instance, opt){
var previousVersion = {};
var currentVersion = {};
opt.defaultFields.forEach(a => {
previousVersion[a] = instance._previousDataValues[a];
currentVersion[a] = instance.dataValues[a];
});
// Disallow change of revision
instance.set(options.revisionAttribute, instance._previousDataValues[options.revisionAttribute]);
// Get diffs
var diffs = getDifferences(previousVersion, currentVersion, options.exclude);
if(diffs && diffs.length > 0){
instance.set(options.revisionAttribute, (instance.get(options.revisionAttribute) || 0) + 1);
if(!instance.context){
instance.context = {};
}
instance.context.diffs = diffs;
}
};
// After create/update store diffs
var after = function(instance, opt){
if(instance.context && instance.context.diffs && instance.context.diffs.length > 0){
var Revision = sequelize.model(options.revisionModel);
var RevisionChange = sequelize.model(options.revisionChangeModel);
var diffs = instance.context.diffs;
var previousVersion = {};
var currentVersion = {};
opt.defaultFields.forEach(a => {
previousVersion[a] = instance._previousDataValues[a];
currentVersion[a] = instance.dataValues[a];
});
var user = opt.user;
if(!user && instance.context && instance.context.user){
user = instance.context.user;
}
// Build revision
var revision = Revision.build({
model: opt.model && opt.model.name || opt.instance && opt.instance.$modelOptions.name.singular || "undefined",
documentId: instance.get("id"),
revision: instance.get(options.revisionAttribute),
// Hacky, but necessary to get immutable current representation
document: JSON.parse(JSON.stringify(currentVersion)),
// Get user from instance.context, hacky workaround, any better idea?
userId: options.userModel && user ? user.id : null
});
// Save revision
revision.save().then(function(revision){
// Loop diffs and create a revision-diff for each
diffs.forEach(function(difference){
var o = convertToString(difference.item ? difference.item.lhs : difference.lhs);
var n = convertToString(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){
// Add diff to revision
revision.addChange(d);
}).catch(log);
});
}).catch(log);
}
};
return {
// Return defineModels()
defineModels: function(){
var attributes = {
model: {
type: Sequelize.TEXT,
allowNull: false
},
documentId: {
type: Sequelize.INTEGER,
allowNull: false
},
revision: {
type: Sequelize.INTEGER,
allowNull: false
},
document: {
type: Sequelize.JSON,
allowNull: false
}
};
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);
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);
// Set associations
Revision.hasMany(RevisionChange, {
foreignKey: "revisionId",
constraints: true,
as: "changes"
});
// Associate with user if necessary
if (options.userModel) {
Revision.belongsTo(sequelize.model(options.userModel), {
foreignKey: "userId",
constraints: true,
as: "user"
});
}
return Revision;
}
}
}
// Helper: Get differences between objects
var getDifferences = function(current, next, exclude){
var di = diff(current, next);
var diffs = di ? di.map(function(i){
var str = JSON.stringify(i).replace("\"__data\",", "");
return JSON.parse(str);
}).filter(function(i){
return i.path.join(",").indexOf("_") === -1;
}).filter(function(i){
return exclude.every(function(x){return i.path.indexOf(x) === -1; });
}) : [];
if(diffs.length > 0){
return diffs;
}
else{
return null;
}
}
// Helper: Convert value to some senseful string representation for storage
var convertToString = function(val){
if(typeof val === "undefined" || val === null){
return "";
}
else if(val === true){
return "1";
}
else if(val === false){
return "0";
}
else if(typeof val === "string"){
return val;
}
else if(!isNaN(val)){
return String(val) + "";
}
else if(typeof val === "object"){
return JSON.stringify(val) + "";
}
else if(Array.isArray(val)){
return JSON.stringify(val) + "";
}
return "";
};