This repository was archived by the owner on Sep 16, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata-object-junction.js
More file actions
616 lines (594 loc) · 22.9 KB
/
data-object-junction.js
File metadata and controls
616 lines (594 loc) · 22.9 KB
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/**
* MOST Web Framework
* A JavaScript Web Framework
* http://themost.io
* Created by Kyriakos Barbounakis<k.barbounakis@gmail.com> on 2014-10-13.
*
* Copyright (c) 2014, Kyriakos Barbounakis k.barbounakis@gmail.com
Anthi Oikonomou anthioikonomou@gmail.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of MOST Web Framework nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @ignore
*/
var util = require('util'),
_ = require('lodash'),
async = require('async'),
qry = require('most-query'),
types = require('./types'),
DataQueryable = require('./data-queryable').DataQueryable;
/**
* @classdesc Represents a many-to-many association between two data models.
* <p>
* This association may be defined in a field of a data model as follows:
* </p>
* <pre class="prettyprint"><code>
{
"name": "Group", "id": 91, "title": "User Group", "inherits":"Account", "hidden": false, "sealed": false, "abstract": false, "version": "1.1",
"fields": [
...
{
"name": "members",
"title": "Group Members",
"description": "Contains the collection of group members (users or groups).",
"type": "Account",
"mapping": {
"associationAdapter": "GroupMembers", "parentModel": "Group",
"parentField": "id", "childModel": "User", "childField": "id",
"associationType": "junction", "cascade": "delete",
"select": [
"id",
"name",
"alternateName"
]
}
}
...
]
}
</code></pre>
<p>
where model [Group] has a many-to-many association with model [User] in order to define the groups where a user belongs.
This association will produce a database table with name of the specified association adapter name. If this name is missing
then it will produce a table with a default name which comes of the concatenation of the model and the associated model.
</p>
<p>
An instance of DataObjectJunction class overrides DataQueryable methods for filtering associated objects:
</p>
<pre class="prettyprint"><code>
//check if a user belongs to Administrators group by querying user groups
var groups = context.model('Group');
groups.where('name').equal('Administrators')
.first().then(function(result) {
var group = groups.convert(result);
group.property('members').where('name').equal('alexis.rees@example.com').count().then(function(result) {
done(null, result);
});
}).catch(function(err) {
done(err);
});
</code></pre>
<p>
Connects two objects (by inserting an association between parent and child object):
</p>
<pre class="prettyprint"><code>
//add a user (by name) in Administrators group
var groups = context.model('Group');
groups.where('name').equal('Administrators')
.first().then(function(result) {
var group = groups.convert(result);
group.property('members').insert({ name: 'alexis.rees@example.com' }).then(function() {
done();
});
}).catch(function(err) {
done(err);
});
</code></pre>
<p>
Disconnects two objects (by removing an existing association):
</p>
<pre class="prettyprint"><code>
//remove a user (by name) from Administrators group
var groups = context.model('Group');
groups.where('name').equal('Administrators')
.first().then(function(result) {
var group = groups.convert(result);
group.property('members').remove({ name: 'alexis.rees@example.com' }).then(function() {
done();
});
}).catch(function(err) {
done(err);
});
</code></pre>
* @class
* @constructor
* @augments DataQueryable
* @param {DataObject} obj An object which represents the parent data object
* @param {String|*} association A string that represents the name of the field which holds association mapping or the association mapping itself.
* @property {DataModel} baseModel - The model associated with this data object junction
* @property {DataObject} parent - Gets or sets the parent data object associated with this instance of DataObjectJunction class.
* @property {DataAssociationMapping} mapping - Gets or sets the mapping definition of this data object association.
*/
function DataObjectJunction(obj, association) {
/**
* @type {DataObject}
* @private
*/
var parent_ = obj,
DataModel = require('./data-model').DataModel;
/**
* Gets or sets the parent data object
* @type DataObject
*/
Object.defineProperty(this, 'parent', { get: function () {
return parent_;
}, set: function (value) {
parent_ = value;
}, configurable: false, enumerable: false});
var self = this;
if (typeof association === 'string') {
//infer mapping from field name
//set relation mapping
if (self.parent!=null) {
var model = self.parent.getModel();
if (model!=null)
self.mapping = model.inferMapping(association);
}
}
else if (typeof association === 'object' && association !=null) {
//get the specified mapping
if (association instanceof types.DataAssociationMapping)
self.mapping = association;
else
self.mapping = _.assign(new types.DataAssociationMapping(), association);
}
//get related model
var relatedModel = this.parent.context.model(self.mapping.childModel);
//call super class constructor
DataObjectJunction.super_.call(this, relatedModel);
//modify query (add join model)
var adapter = relatedModel.viewAdapter;
var left = {}, right = {};
this.query.select(relatedModel.attributes.filter(function(x) {
return !x.many;
}).map(function(x) {
return qry.fields.select(x.name).from(adapter);
}));
left[adapter] = [ relatedModel.primaryKey ];
right[this.mapping.associationAdapter] = [qry.fields.select(DataObjectJunction.STR_VALUE_FIELD).from(this.mapping.associationAdapter).$name];
var field1 = qry.fields.select(DataObjectJunction.STR_OBJECT_FIELD).from(this.mapping.associationAdapter).$name;
this.query.join(this.mapping.associationAdapter, []).with([left, right]).where(field1).equal(obj[this.mapping.parentField]).prepare();
var baseModel;
Object.defineProperty(this, 'baseModel', {
get: function() {
if (baseModel)
return baseModel;
//get parent context
var context = self.parent.context, conf = context.getConfiguration();
//search in cache (configuration.current.cache)
if (conf.models[self.mapping.associationAdapter]) {
baseModel = new DataModel(conf.models[self.mapping.associationAdapter]);
baseModel.context = self.parent.context;
return baseModel;
}
//get parent and child field in order to get junction field types
var parentModel = self.parent.getModel();
var parentField = parentModel.field(self.mapping.parentField);
var childModel = self.parent.context.model(self.mapping.childModel);
var childField = childModel.field(self.mapping.childField);
var adapter = self.mapping.associationAdapter;
baseModel = self.parent.context.model(adapter);
if (_.isNil(baseModel)) {
conf.models[self.mapping.associationAdapter] = { name:adapter, title: adapter, source:adapter, type:"hidden", hidden:true, sealed:false, view:adapter, version:'1.0', fields:[
{ name: "id", type:"Counter", primary: true },
{ name: "parentId", indexed: true, nullable:false, type: (parentField.type=='Counter') ? 'Integer' : parentField.type },
{ name: "valueId", indexed: true, nullable:false, type: (childField.type=='Counter') ? 'Integer' : childField.type } ],
"constraints": [
{
"description": "The relation between two objects must be unique.",
"type":"unique",
"fields": [ "parentId", "valueId" ]
}
], "privileges":[
{ "mask":15, "type":"global" }
]};
//initialize base model
baseModel = new DataModel(conf.models[self.mapping.associationAdapter]);
baseModel.context = self.parent.context;
}
return baseModel;
},configurable:false, enumerable:false
});
/**
* Gets an instance of DataModel class which represents the data adapter of this association
* @returns {DataModel}
*/
this.getBaseModel = function() {
return this.baseModel;
};
this.getChildField = function() {
return _.find(this.getBaseModel().attributes, function(x) {
return x.name === DataObjectJunction.STR_VALUE_FIELD;
});
};
this.getParentField = function() {
return _.find(this.getBaseModel().attributes, function(x) {
return x.name === DataObjectJunction.STR_OBJECT_FIELD;
});
};
}
DataObjectJunction.STR_OBJECT_FIELD = 'parentId';
DataObjectJunction.STR_VALUE_FIELD = 'valueId';
util.inherits(DataObjectJunction, DataQueryable);
/**
* Migrates the underlying data association adapter.
* @param callback - A callback function where the first argument will contain the Error object if an error occured, or null otherwise.
*/
DataObjectJunction.prototype.migrate = function(callback) {
var model = this.getBaseModel();
model.migrate(function(err) {
if (err) {
return callback(err);
}
//migrate related model
var childModel = self.parent.context.model(self.mapping.childModel);
return childModel.migrate(callback);
});
};
/**
* Overrides DataQueryable.execute() method
* @param callback - A callback function where the first argument will contain the Error object if an error occured, or null otherwise.
* @ignore
*/
DataObjectJunction.prototype.execute = function(callback) {
var self = this;
self.migrate(function(err) {
if (err) { callback(err); return; }
DataObjectJunction.super_.prototype.execute.call(self, callback);
});
};
function insert_(obj, callback) {
var self = this, arr = [];
if (_.isArray(obj))
arr = obj;
else {
arr.push(obj);
}
self.migrate(function(err) {
if (err)
callback(err);
else {
async.eachSeries(arr, function(item, cb) {
var child = item;
if (typeof item !== 'object') {
child = {};
child[self.mapping.childField] = item;
}
//validate if child identifier exists
if (child.hasOwnProperty(self.mapping.childField)) {
insertSingleObject_.call(self, child, function(err) {
cb(err);
});
}
else {
/**
* Get related model. The related model is the model of any child object of this junction.
* @type {DataModel}
*/
var relatedModel = self.parent.context.model(self.mapping.childModel);
//find object by querying child object
relatedModel.find(child).select(self.mapping.childField).first(function (err, result) {
if (err) {
cb(err);
}
else {
/**
* Validates related object, inserts this object if does not exists
* and finally defines the relation between child and parent objects
*/
if (!result) {
//ensure silent mode
if (self.getBaseModel().$silent) { relatedModel.silent(); }
//insert related item if does not exists
relatedModel.save(child, function(err) {
if (err) {
cb(err);
}
else {
//insert relation between child and parent
insertSingleObject_.call(self, child, function(err) { cb(err); });
}
});
}
else {
//set primary key
child[self.mapping.childField] = result[self.mapping.childField];
//insert relation between child and parent
insertSingleObject_.call(self, child, function(err) { cb(err); });
}
}
});
}
}, callback);
}
});
}
/**
* Inserts an association between parent object and the given object or array of objects.
* @param {*|Array} obj - An object or an array of objects to be related with parent object
* @param {Function=} callback - A callback function where the first argument will contain the Error object if an error occured, or null otherwise.
* @returns {Promise<T>|*} - If callback parameter is missing then returns a Promise object.
* @example
//add a user (by name) in Administrators group
var groups = context.model('Group');
groups.where('name').equal('Administrators')
.first().then(function(result) {
var group = groups.convert(result);
group.property('members').insert({ name: 'alexis.rees@example.com' }).then(function() {
done();
});
}).catch(function(err) {
done(err);
});
*/
DataObjectJunction.prototype.insert = function(obj, callback) {
var self = this;
if (typeof callback !== 'function') {
var Q = require('q'), deferred = Q.defer();
insert_.call(self, obj, function(err) {
if (err) { return deferred.reject(err); }
deferred.resolve(null);
});
return deferred.promise;
}
else {
return insert_.call(self, obj, callback);
}
};
function clear_(callback) {
var self = this;
self.migrate(function(err) {
if (err) { return callback(); }
//get parent id
var parentId = self.parent[self.mapping.parentField];
//get relation model
var relationModel = self.getBaseModel();
//validate relation existence
relationModel.where(DataObjectJunction.STR_OBJECT_FIELD).equal(parentId).all(function(err, result) {
if (err) { return callback(); }
if (result.length==0) { return callback(); }
relationModel.remove(result, callback);
});
});
}
/**
* Removes all associations
* @param {Function=} callback
* @returns {Promise|*}
* @deprecated This method is deprecated. Use DataObjectJunction.removeAll() instead.
*/
DataObjectJunction.prototype.clear = function(callback) {
return this.removeAll(callback);
};
/**
* Removes all associations
* @param {Function=} callback
* @returns {Promise|*}
*/
DataObjectJunction.prototype.removeAll = function(callback) {
var self = this;
if (typeof callback !== 'function') {
var Q = require('q'), deferred = Q.defer();
clear_.call(self, function(err) {
if (err) { return deferred.reject(err); }
deferred.resolve();
});
return deferred.promise;
}
else {
return clear_.call(self, callback);
}
};
/**
* Inserts a new relation between a parent and a child object.
* @param {*} obj An object or an identifier that represents the child object
* @param {Function} callback
* @private
*/
function insertSingleObject_(obj, callback) {
var self = this;
//get parent and child
var child = obj;
if (typeof obj !== 'object') {
child = {};
child[self.mapping.childField] = obj;
}
var parentId = self.parent[self.mapping.parentField], childId = child[self.mapping.childField];
//get relation model
var relationModel = self.getBaseModel();
//validate relation existence
relationModel.where(DataObjectJunction.STR_OBJECT_FIELD).equal(parentId).and(DataObjectJunction.STR_VALUE_FIELD).equal(childId).first(function(err, result) {
if (err) {
//on error exit with error
return callback(err);
}
else {
if (result) {
//if relation already exists, do nothing
return callback(null);
}
else {
//otherwise create new item
var newItem = { };
newItem[DataObjectJunction.STR_OBJECT_FIELD] = parentId;
newItem[DataObjectJunction.STR_VALUE_FIELD] = childId;
//and insert it
relationModel.insert(newItem, callback);
}
}
});
};
/**
* Migrates current junction data storage
* @param {Function} callback
*/
DataObjectJunction.prototype.migrate = function(callback)
{
var self = this;
//get migration model
var migrationModel = self.parent.context.model("Migration");
//get related model
var relationModel = self.getBaseModel();
migrationModel.find({ appliesTo:relationModel.source, version: relationModel.version }).first(function(err, result) {
if (err) {
callback(err);
}
else {
if (!result) {
//migrate junction table
relationModel.migrate(function(err) {
if (err) {
callback(err);
}
else
callback(null);
})
}
else
callback(null);
}
});
};
function remove_(obj, callback) {
var self = this;
var arr = [];
if (_.isArray(obj))
arr = obj;
else {
arr.push(obj);
}
self.migrate(function(err) {
if (err)
callback(err);
else
{
async.eachSeries(arr, function(item, cb) {
var child = item;
if (typeof item !== 'object') {
child = {};
child[self.mapping.childField] = item;
}
//get related model
var relatedModel = self.parent.context.model(self.mapping.childModel);
//find object by querying child object
relatedModel.find(child).select([self.mapping.childField]).first(function (err, result) {
if (err) {
cb(null);
}
else {
if (!result) {
//child was not found (do nothing or throw exception)
cb(null);
}
else {
child[self.mapping.childField] = result[self.mapping.childField];
removeSingleObject_.call(self, child, function(err) {
cb(err);
});
}
}
});
}, callback);
}
});
}
/**
* Removes the association between parent object and the given object or array of objects.
* @param {*|Array} obj - An object or an array of objects to be disconnected from parent object
* @param {Function=} callback - A callback function where the first argument will contain the Error object if an error occured, or null otherwise.
* @returns {Promise<T>|*} - If callback parameter is missing then returns a Promise object.
* @example
//remove a user (by name) from Administrators group
var groups = context.model('Group');
groups.where('name').equal('Administrators')
.first().then(function(result) {
var group = groups.convert(result);
group.property('members').remove({ name: 'alexis.rees@example.com' }).then(function() {
done();
});
}).catch(function(err) {
done(err);
});
*/
DataObjectJunction.prototype.remove = function(obj, callback) {
var self = this;
if (typeof callback !== 'function') {
var Q = require('q'), deferred = Q.defer();
remove_.call(self, obj, function(err) {
if (err) { return deferred.reject(err); }
deferred.resolve(null);
});
return deferred.promise;
}
else {
return remove_.call(self, obj, callback);
}
};
/**
* Removes a relation between a parent and a child object.
* @param {*} obj An object or an identifier that represents the child object
* @param {Function} callback
* @private
*/
function removeSingleObject_(obj, callback) {
var self = this;
//get parent and child
var child = obj;
if (typeof obj !== 'object') {
child = {};
child[self.mapping.childField] = obj;
}
var parentId = self.parent[self.mapping.parentField], childId = child[self.mapping.childField];
//get relation model
var relationModel = self.getBaseModel();
relationModel.where(DataObjectJunction.STR_OBJECT_FIELD).equal(parentId).and(DataObjectJunction.STR_VALUE_FIELD).equal(childId).first(function(err, result) {
if (err) {
callback(err);
}
else {
if (!result) {
callback(null);
}
else {
//otherwise remove item
relationModel.remove(result, callback);
}
}
});
};
if (typeof exports !== 'undefined')
{
module.exports = {
DataObjectJunction:DataObjectJunction
};
}