Fix relation access via remote connector
This commit is contained in:
Krishna Raman
parent
bf82927186
commit
3db9e34cc4
|
|
@ -0,0 +1,217 @@
|
|||
/*!
|
||||
* Dependencies
|
||||
*/
|
||||
var relation = require('loopback-datasource-juggler/lib/relation-definition');
|
||||
var RelationDefinition = relation.RelationDefinition;
|
||||
|
||||
module.exports = RelationMixin;
|
||||
|
||||
/**
|
||||
* RelationMixin class. Use to define relationships between models.
|
||||
*
|
||||
* @class RelationMixin
|
||||
*/
|
||||
function RelationMixin() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Define a "one to many" relationship by specifying the model name
|
||||
*
|
||||
* Examples:
|
||||
* ```
|
||||
* User.hasMany(Post, {as: 'posts', foreignKey: 'authorId'});
|
||||
* ```
|
||||
*
|
||||
* ```
|
||||
* Book.hasMany(Chapter);
|
||||
* ```
|
||||
* Or, equivalently:
|
||||
* ```
|
||||
* Book.hasMany('chapters', {model: Chapter});
|
||||
* ```
|
||||
*
|
||||
* Query and create related models:
|
||||
*
|
||||
* ```js
|
||||
* Book.create(function(err, book) {
|
||||
*
|
||||
* // Create a chapter instance ready to be saved in the data source.
|
||||
* var chapter = book.chapters.build({name: 'Chapter 1'});
|
||||
*
|
||||
* // Save the new chapter
|
||||
* chapter.save();
|
||||
*
|
||||
* // you can also call the Chapter.create method with the `chapters` property which will build a chapter
|
||||
* // instance and save the it in the data source.
|
||||
* book.chapters.create({name: 'Chapter 2'}, function(err, savedChapter) {
|
||||
* // this callback is optional
|
||||
* });
|
||||
*
|
||||
* // Query chapters for the book
|
||||
* book.chapters(function(err, chapters) { // all chapters with bookId = book.id
|
||||
* console.log(chapters);
|
||||
* });
|
||||
*
|
||||
* book.chapters({where: {name: 'test'}, function(err, chapters) {
|
||||
* // All chapters with bookId = book.id and name = 'test'
|
||||
* console.log(chapters);
|
||||
* });
|
||||
* });
|
||||
*```
|
||||
* @param {Object|String} modelTo Model object (or String name of model) to which you are creating the relationship.
|
||||
* @options {Object} parameters Configuration parameters; see below.
|
||||
* @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model.
|
||||
* @property {String} foreignKey Property name of foreign key field.
|
||||
* @property {Object} model Model object
|
||||
*/
|
||||
RelationMixin.hasMany = function hasMany(modelTo, params) {
|
||||
var def = RelationDefinition.hasMany(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
/**
|
||||
* Declare "belongsTo" relation that sets up a one-to-one connection with another model, such that each
|
||||
* instance of the declaring model "belongs to" one instance of the other model.
|
||||
*
|
||||
* For example, if an application includes users and posts, and each post can be written by exactly one user.
|
||||
* The following code specifies that `Post` has a reference called `author` to the `User` model via the `userId` property of `Post`
|
||||
* as the foreign key.
|
||||
* ```
|
||||
* Post.belongsTo(User, {as: 'author', foreignKey: 'userId'});
|
||||
* ```
|
||||
* You can then access the author in one of the following styles.
|
||||
* Get the User object for the post author asynchronously:
|
||||
* ```
|
||||
* post.author(callback);
|
||||
* ```
|
||||
* Get the User object for the post author synchronously:
|
||||
* ```
|
||||
* post.author();
|
||||
* Set the author to be the given user:
|
||||
* ```
|
||||
* post.author(user)
|
||||
* ```
|
||||
* Examples:
|
||||
*
|
||||
* Suppose the model Post has a *belongsTo* relationship with User (the author of the post). You could declare it this way:
|
||||
* ```js
|
||||
* Post.belongsTo(User, {as: 'author', foreignKey: 'userId'});
|
||||
* ```
|
||||
*
|
||||
* When a post is loaded, you can load the related author with:
|
||||
* ```js
|
||||
* post.author(function(err, user) {
|
||||
* // the user variable is your user object
|
||||
* });
|
||||
* ```
|
||||
*
|
||||
* The related object is cached, so if later you try to get again the author, no additional request will be made.
|
||||
* But there is an optional boolean parameter in first position that set whether or not you want to reload the cache:
|
||||
* ```js
|
||||
* post.author(true, function(err, user) {
|
||||
* // The user is reloaded, even if it was already cached.
|
||||
* });
|
||||
* ```
|
||||
* This optional parameter default value is false, so the related object will be loaded from cache if available.
|
||||
*
|
||||
* @param {Class|String} modelTo Model object (or String name of model) to which you are creating the relationship.
|
||||
* @options {Object} params Configuration parameters; see below.
|
||||
* @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model.
|
||||
* @property {String} foreignKey Name of foreign key property.
|
||||
*
|
||||
*/
|
||||
RelationMixin.belongsTo = function(modelTo, params) {
|
||||
var def = RelationDefinition.belongsTo(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
/**
|
||||
* A hasAndBelongsToMany relation creates a direct many-to-many connection with another model, with no intervening model.
|
||||
* For example, if your application includes users and groups, with each group having many users and each user appearing
|
||||
* in many groups, you could declare the models this way:
|
||||
* ```
|
||||
* User.hasAndBelongsToMany('groups', {model: Group, foreignKey: 'groupId'});
|
||||
* ```
|
||||
* Then, to get the groups to which the user belongs:
|
||||
* ```
|
||||
* user.groups(callback);
|
||||
* ```
|
||||
* Create a new group and connect it with the user:
|
||||
* ```
|
||||
* user.groups.create(data, callback);
|
||||
* ```
|
||||
* Connect an existing group with the user:
|
||||
* ```
|
||||
* user.groups.add(group, callback);
|
||||
* ```
|
||||
* Remove the user from the group:
|
||||
* ```
|
||||
* user.groups.remove(group, callback);
|
||||
* ```
|
||||
*
|
||||
* @param {String|Object} modelTo Model object (or String name of model) to which you are creating the relationship.
|
||||
* the relation
|
||||
* @options {Object} params Configuration parameters; see below.
|
||||
* @property {String} as Name of the property in the referring model that corresponds to the foreign key field in the related model.
|
||||
* @property {String} foreignKey Property name of foreign key field.
|
||||
* @property {Object} model Model object
|
||||
*/
|
||||
RelationMixin.hasAndBelongsToMany =
|
||||
function hasAndBelongsToMany(modelTo, params) {
|
||||
var def = RelationDefinition.hasAndBelongsToMany(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
RelationMixin.hasOne = function hasOne(modelTo, params) {
|
||||
var def = RelationDefinition.hasOne(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
RelationMixin.referencesMany = function referencesMany(modelTo, params) {
|
||||
var def = RelationDefinition.referencesMany(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
RelationMixin.embedsOne = function embedsOne(modelTo, params) {
|
||||
var def = RelationDefinition.embedsOne(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
RelationMixin.embedsMany = function embedsMany(modelTo, params) {
|
||||
var def = RelationDefinition.embedsMany(this, modelTo, params);
|
||||
this.dataSource.adapter.resolve(this);
|
||||
defineRelationProperty(this, def);
|
||||
};
|
||||
|
||||
function defineRelationProperty(modelClass, def) {
|
||||
Object.defineProperty(modelClass.prototype, def.name, {
|
||||
get: function() {
|
||||
var that = this;
|
||||
var scope = function() {
|
||||
return that['__get__' + def.name].apply(that, arguments);
|
||||
};
|
||||
scope.count = function() {
|
||||
return that['__count__' + def.name].apply(that, arguments);
|
||||
};
|
||||
scope.create = function() {
|
||||
return that['__create__' + def.name].apply(that, arguments);
|
||||
};
|
||||
scope.deleteById = destroyById = function() {
|
||||
return that['__destroyById__' + def.name].apply(that, arguments);
|
||||
};
|
||||
scope.exists = function() {
|
||||
return that['__exists__' + def.name].apply(that, arguments);
|
||||
};
|
||||
scope.findById = function() {
|
||||
return that['__findById__' + def.name].apply(that, arguments);
|
||||
};
|
||||
return scope;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
|
@ -4,7 +4,8 @@
|
|||
|
||||
var assert = require('assert');
|
||||
var remoting = require('strong-remoting');
|
||||
var DataAccessObject = require('loopback-datasource-juggler/lib/dao');
|
||||
var jutil = require('loopback-datasource-juggler/lib/jutil');
|
||||
var RelationMixin = require('./relations');
|
||||
|
||||
/**
|
||||
* Export the RemoteConnector class.
|
||||
|
|
@ -27,8 +28,6 @@ function RemoteConnector(settings) {
|
|||
this.host = settings.host || 'localhost';
|
||||
this.port = settings.port || 3000;
|
||||
this.remotes = remoting.create();
|
||||
|
||||
// TODO(ritch) make sure this name works with Model.getSourceId()
|
||||
this.name = 'remote-connector';
|
||||
|
||||
if (settings.url) {
|
||||
|
|
@ -44,37 +43,37 @@ function RemoteConnector(settings) {
|
|||
|
||||
RemoteConnector.prototype.connect = function() {
|
||||
this.remotes.connect(this.url, this.adapter);
|
||||
}
|
||||
};
|
||||
|
||||
RemoteConnector.initialize = function(dataSource, callback) {
|
||||
var connector = dataSource.connector =
|
||||
new RemoteConnector(dataSource.settings);
|
||||
connector.connect();
|
||||
callback();
|
||||
}
|
||||
setImmediate(callback);
|
||||
};
|
||||
|
||||
RemoteConnector.prototype.define = function(definition) {
|
||||
var Model = definition.model;
|
||||
var remotes = this.remotes;
|
||||
var SharedClass;
|
||||
|
||||
assert(Model.sharedClass,
|
||||
'cannot attach ' +
|
||||
Model.modelName +
|
||||
' to a remote connector without a Model.sharedClass');
|
||||
|
||||
jutil.mixin(Model, RelationMixin);
|
||||
remotes.addClass(Model.sharedClass);
|
||||
};
|
||||
|
||||
RemoteConnector.prototype.resolve = function(Model) {
|
||||
var remotes = this.remotes;
|
||||
|
||||
Model.sharedClass.methods().forEach(function(remoteMethod) {
|
||||
// TODO(ritch) more elegant way of ignoring a nested shared class
|
||||
if (remoteMethod.name !==
|
||||
'Change' &&
|
||||
remoteMethod.name !==
|
||||
'Checkpoint') {
|
||||
createProxyMethod(Model, remotes, remoteMethod);
|
||||
}
|
||||
});
|
||||
}
|
||||
if (remoteMethod.name !== 'Change' && remoteMethod.name !== 'Checkpoint') {
|
||||
createProxyMethod(Model, remotes, remoteMethod);
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
function createProxyMethod(Model, remotes, remoteMethod) {
|
||||
var scope = remoteMethod.isStatic ? Model : Model.prototype;
|
||||
|
|
@ -88,7 +87,12 @@ function createProxyMethod(Model, remotes, remoteMethod) {
|
|||
callback = args.pop();
|
||||
}
|
||||
|
||||
remotes.invoke(remoteMethod.stringName, args, callback);
|
||||
if (remoteMethod.isStatic) {
|
||||
return remotes.invoke(remoteMethod.stringName, args, callback);
|
||||
}
|
||||
|
||||
var ctorArgs = [this.id];
|
||||
return remotes.invoke(remoteMethod.stringName, ctorArgs, args, callback);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue