Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit 04a778d2 by Mick Hansen
Options

Merge pull request #2173 from janmeier/findOrCreateTransaction 

Use a transaction internally in findOrCreate
2 parents b10a8ffd d51cc90e
Inline Side-by-side
Showing with 393 additions and 124 deletions
changelog.md
...@@ -19,6 +19,7 @@ Notice: All 1.7.x changes are present in 2.0.x aswell ...@@ -19,6 +19,7 @@ Notice: All 1.7.x changes are present in 2.0.x aswell
+ moment 2.5.0 -> 2.7.0 + moment 2.5.0 -> 2.7.0
+ generic-pool 2.0.4 -> 2.1.1 + generic-pool 2.0.4 -> 2.1.1
+ sql 0.35.0 -> 0.39.0 + sql 0.35.0 -> 0.39.0
- [INTERNALS] Use a transaction inside `findOrCreate`, and handle unique constraint errors if multiple calls are issues concurrently on the same transaction
#### Backwards compatability changes #### Backwards compatability changes
- We are using a new inflection library, which should make pluralization and singularization in general more robust. However, a couple of pluralizations have changed as a result: - We are using a new inflection library, which should make pluralization and singularization in general more robust. However, a couple of pluralizations have changed as a result:
...@@ -35,6 +36,7 @@ Notice: All 1.7.x changes are present in 2.0.x aswell ...@@ -35,6 +36,7 @@ Notice: All 1.7.x changes are present in 2.0.x aswell
Old: `err.validateCustom[0]` Old: `err.validateCustom[0]`
New: `err.get('validateCustom')[0]` New: `err.get('validateCustom')[0]`
- The syntax for findOrCreate has changed, to be more in line with the rest of the library. `Model.findOrCreate(where, defaults);` becomes `Model.findOrCreate({ where: where, defaults: defaults });`.
# v2.0.0-dev12 # v2.0.0-dev12
......
docs/markdox.js
...@@ -45,12 +45,13 @@ var options = { ...@@ -45,12 +45,13 @@ var options = {
docfile.members = []; docfile.members = [];
docfile.javadoc.forEach(function(javadoc){ docfile.javadoc.forEach(function(javadoc){
// Find constructor tags
javadoc.isConstructor = getTag(javadoc.raw.tags, 'constructor') !== undefined; javadoc.isConstructor = getTag(javadoc.raw.tags, 'constructor') !== undefined;
javadoc.isMixin = getTag(javadoc.raw.tags, 'mixin') !== undefined; javadoc.isMixin = getTag(javadoc.raw.tags, 'mixin') !== undefined;
javadoc.isProperty = getTag(javadoc.raw.tags, 'property') !== undefined; javadoc.isProperty = getTag(javadoc.raw.tags, 'property') !== undefined;
javadoc.private = getTag(javadoc.raw.tags, 'private') !== undefined; javadoc.private = getTag(javadoc.raw.tags, 'private') !== undefined;
javadoc.since = getTag(javadoc.raw.tags, 'since'); javadoc.since = getTag(javadoc.raw.tags, 'since');
javadoc.extends = getTag(javadoc.raw.tags, 'extends');
// Find constructor tags
// Only show params without a dot in them (dots means attributes of object, so no need to clutter the signature too much) // Only show params without a dot in them (dots means attributes of object, so no need to clutter the signature too much)
var params = [] ; var params = [] ;
......
docs/output.md.ejs
...@@ -66,6 +66,9 @@ ...@@ -66,6 +66,9 @@
<? if (comment.since) { ?> <? if (comment.since) { ?>
__Since:__ *<?= comment.since.string ?>* __Since:__ *<?= comment.since.string ?>*
<? } ?> <? } ?>
<? if (comment.extends) { ?>
__Extends:__ *<?= comment.extends.otherClass ?>*
<? } ?>
====== ======
<? } ?> <? } ?>
<? }) ?> <? }) ?>
......
lib/dialects/abstract/query-generator.js
...@@ -182,6 +182,12 @@ module.exports = (function() { ...@@ -182,6 +182,12 @@ module.exports = (function() {
emptyQuery += ' RETURNING *'; emptyQuery += ' RETURNING *';
} }
if (this._dialect.supports['EXCEPTION'] && options.exception) {
// Mostly for internal use, so we expect the user to know what he's doing!
// pg_temp functions are private per connection, so we never risk this function interfering with another one.
valueQuery = 'CREATE OR REPLACE FUNCTION pg_temp.testfunc() RETURNS SETOF <%= table %> AS $body$ BEGIN RETURN QUERY ' + valueQuery + '; EXCEPTION ' + options.exception + ' END; $body$ LANGUAGE plpgsql; SELECT * FROM pg_temp.testfunc()';
}
valueHash = Utils.removeNullValuesFromHash(valueHash, this.options.omitNull); valueHash = Utils.removeNullValuesFromHash(valueHash, this.options.omitNull);
for (key in valueHash) { for (key in valueHash) {
......
lib/dialects/abstract/query.js
...@@ -138,6 +138,10 @@ module.exports = (function() { ...@@ -138,6 +138,10 @@ module.exports = (function() {
AbstractQuery.prototype.isInsertQuery = function(results, metaData) { AbstractQuery.prototype.isInsertQuery = function(results, metaData) {
var result = true; var result = true;
if (this.options.type === QueryTypes.INSERT) {
return true;
}
// is insert query if sql contains insert into // is insert query if sql contains insert into
result = result && (this.sql.toLowerCase().indexOf('insert into') === 0); result = result && (this.sql.toLowerCase().indexOf('insert into') === 0);
......
lib/dialects/mariadb/query.js
...@@ -96,7 +96,7 @@ module.exports = (function() { ...@@ -96,7 +96,7 @@ module.exports = (function() {
errorDetected = true; errorDetected = true;
self.promise.emit('sql', self.sql); self.promise.emit('sql', self.sql);
err.sql = sql; err.sql = sql;
self.reject(err); self.reject(self.formatError(err));
}) })
.on('end', function(info) { .on('end', function(info) {
if (alreadyEnded || errorDetected) { if (alreadyEnded || errorDetected) {
......
lib/dialects/mysql/query.js
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
var Utils = require('../../utils') var Utils = require('../../utils')
, AbstractQuery = require('../abstract/query') , AbstractQuery = require('../abstract/query')
, uuid = require('node-uuid'); , uuid = require('node-uuid')
, sequelizeErrors = require('../../errors.js');
module.exports = (function() { module.exports = (function() {
var Query = function(connection, sequelize, callee, options) { var Query = function(connection, sequelize, callee, options) {
...@@ -35,7 +36,8 @@ module.exports = (function() { ...@@ -35,7 +36,8 @@ module.exports = (function() {
if (err) { if (err) {
err.sql = sql; err.sql = sql;
reject(err);
reject(self.formatError(err));
} else { } else {
resolve(self.formatResults(results)); resolve(self.formatResults(results));
} }
...@@ -46,6 +48,25 @@ module.exports = (function() { ...@@ -46,6 +48,25 @@ module.exports = (function() {
return promise; return promise;
}; };
Query.prototype.formatError = function (err) {
var match;
switch (err.errno || err.code) {
case 1062:
match = err.message.match(/Duplicate entry '(.*)' for key '(.*?)'$/);
return new sequelizeErrors.UniqueConstraintError({
fields: null,
index: match[2],
value: match[1],
parent: err
});
default:
return new sequelizeErrors.DatabaseError(err);
}
};
Query.prototype.isShowIndexesQuery = function () { Query.prototype.isShowIndexesQuery = function () {
return this.sql.toLowerCase().indexOf('show index from') === 0; return this.sql.toLowerCase().indexOf('show index from') === 0;
}; };
......
lib/dialects/postgres/index.js
...@@ -14,6 +14,7 @@ var PostgresDialect = function(sequelize) { ...@@ -14,6 +14,7 @@ var PostgresDialect = function(sequelize) {
PostgresDialect.prototype.supports = _.merge(_.cloneDeep(Abstract.prototype.supports), { PostgresDialect.prototype.supports = _.merge(_.cloneDeep(Abstract.prototype.supports), {
'RETURNING': true, 'RETURNING': true,
'DEFAULT VALUES': true, 'DEFAULT VALUES': true,
'EXCEPTION': true,
schemas: true, schemas: true,
lock: true, lock: true,
forShare: 'FOR SHARE', forShare: 'FOR SHARE',
......
lib/dialects/postgres/query.js
...@@ -5,7 +5,8 @@ var Utils = require('../../utils') ...@@ -5,7 +5,8 @@ var Utils = require('../../utils')
, DataTypes = require('../../data-types') , DataTypes = require('../../data-types')
, hstore = require('./hstore') , hstore = require('./hstore')
, QueryTypes = require('../../query-types') , QueryTypes = require('../../query-types')
, Promise = require('../../promise'); , Promise = require('../../promise')
, sequelizeErrors = require('../../errors.js');
// Parses hstore fields if the model has any hstore fields. // Parses hstore fields if the model has any hstore fields.
// This cannot be done in the 'pg' lib because hstore is a UDT. // This cannot be done in the 'pg' lib because hstore is a UDT.
...@@ -61,7 +62,7 @@ module.exports = (function() { ...@@ -61,7 +62,7 @@ module.exports = (function() {
receivedError = true; receivedError = true;
err.sql = sql; err.sql = sql;
promise.emit('sql', sql, self.client.uuid); promise.emit('sql', sql, self.client.uuid);
reject(err); reject(self.formatError(err));
}); });
query.on('end', function(result) { query.on('end', function(result) {
...@@ -221,6 +222,25 @@ module.exports = (function() { ...@@ -221,6 +222,25 @@ module.exports = (function() {
return this; return this;
}; };
Query.prototype.formatError = function (err) {
var match;
switch (err.code) {
case '23505':
match = err.detail.match(/Key \((.*?)\)=\((.*?)\) already exists/);
return new sequelizeErrors.UniqueConstraintError({
fields: match[1].split(', '),
value: match[2].split(', '),
index: null,
parent: err
});
default:
return new sequelizeErrors.DatabaseError(err);
}
};
Query.prototype.isShowIndexesQuery = function () { Query.prototype.isShowIndexesQuery = function () {
return this.sql.indexOf('pg_get_indexdef') !== -1; return this.sql.indexOf('pg_get_indexdef') !== -1;
}; };
......
lib/dialects/sqlite/query.js
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
var Utils = require('../../utils') var Utils = require('../../utils')
, AbstractQuery = require('../abstract/query') , AbstractQuery = require('../abstract/query')
, QueryTypes = require('../../query-types'); , QueryTypes = require('../../query-types')
, sequelizeErrors = require('../../errors.js');
module.exports = (function() { module.exports = (function() {
var Query = function(database, sequelize, callee, options) { var Query = function(database, sequelize, callee, options) {
...@@ -48,10 +49,9 @@ module.exports = (function() { ...@@ -48,10 +49,9 @@ module.exports = (function() {
self.database[self.getDatabaseMethod()](self.sql, function(err, results) { self.database[self.getDatabaseMethod()](self.sql, function(err, results) {
// allow clients to listen to sql to do their own logging or whatnot // allow clients to listen to sql to do their own logging or whatnot
promise.emit('sql', self.sql, self.options.uuid); promise.emit('sql', self.sql, self.options.uuid);
if (err) { if (err) {
err.sql = self.sql; err.sql = self.sql;
reject(err); reject(self.formatError(err));
} else { } else {
var metaData = this; var metaData = this;
metaData.columnTypes = columnTypes; metaData.columnTypes = columnTypes;
...@@ -173,6 +173,39 @@ module.exports = (function() { ...@@ -173,6 +173,39 @@ module.exports = (function() {
}); });
}; };
Query.prototype.formatError = function (err) {
var match;
switch (err.code) {
case 'SQLITE_CONSTRAINT':
match = err.message.match(/columns (.*?) are/); // Sqlite pre 2.2 behavior - Error: SQLITE_CONSTRAINT: columns x, y are not unique
if (match !== null && match.length >= 2) {
return new sequelizeErrors.UniqueConstraintError(match[1].split(', '),null, err);
}
match = err.message.match(/UNIQUE constraint failed: (.*)/); // Sqlite 2.2 behavior - Error: SQLITE_CONSTRAINT: UNIQUE constraint failed: table.x, table.y
if (match !== null && match.length >= 2) {
var fields = match[1].split(', ').map(function (columnWithTable) {
return columnWithTable.split('.')[1];
});
return new sequelizeErrors.UniqueConstraintError({
fields: fields,
index: null,
value: null,
parent: err
});
}
return err;
case 'SQLITE_BUSY':
return new sequelizeErrors.TimeoutError(err);
default:
return new sequelizeErrors.DatabaseError(err);
}
};
Query.prototype.handleShowIndexesQuery = function (data) { Query.prototype.handleShowIndexesQuery = function (data) {
var self = this; var self = this;
......
lib/errors.js
...@@ -33,6 +33,8 @@ util.inherits(error.BaseError, Error); ...@@ -33,6 +33,8 @@ util.inherits(error.BaseError, Error);
* *
* @param {string} message Error message * @param {string} message Error message
* @param {Array} [errors] Array of ValidationErrorItem objects describing the validation errors * @param {Array} [errors] Array of ValidationErrorItem objects describing the validation errors
*
* @extends BaseError
* @constructor * @constructor
*/ */
error.ValidationError = function(message, errors) { error.ValidationError = function(message, errors) {
...@@ -65,6 +67,87 @@ error.ValidationError.prototype.get = function(path) { ...@@ -65,6 +67,87 @@ error.ValidationError.prototype.get = function(path) {
error.ValidationError.prototype.errors; error.ValidationError.prototype.errors;
/** /**
* A base class for all database related errors.
* @extends BaseError
* @constructor
*/
error.DatabaseError = function (parent) {
error.BaseError.apply(this, arguments);
this.name = 'SequelizeDatabaseError';
this.parent = parent;
this.sql = parent.sql;
};
util.inherits(error.DatabaseError, error.BaseError);
/**
* The database specific error which triggered this one
* @property parent
* @name parent
*/
error.DatabaseError.prototype.parent;
/**
* The SQL that triggered the error
* @property sql
* @name sql
*/
error.DatabaseError.prototype.sql;
/**
* Thrown when a database query times out because of a deadlock
* @extends DatabaseError
* @constructor
*/
error.TimeoutError = function (parent) {
error.DatabaseError.call(this, parent);
this.name = 'SequelizeTimeoutError';
};
util.inherits(error.TimeoutError, error.BaseError);
/**
* Thrown when a unique constraint is violated in the database
* @extends DatabaseError
* @constructor
*/
error.UniqueConstraintError = function (options) {
options = options || {};
options.parent = options.parent || { sql: '' };
error.DatabaseError.call(this, options.parent);
this.name = 'SequelizeUniqueConstraintError';
this.message = options.message;
this.fields = options.fields;
this.value = options.value;
this.index = options.index;
};
util.inherits(error.UniqueConstraintError, error.DatabaseError);
/**
* The message from the DB.
* @property message
* @name message
*/
error.DatabaseError.prototype.message;
/**
* The fields of the unique constraint
* @property fields
* @name fields
*/
error.DatabaseError.prototype.fields;
/**
* The value(s) which triggered the error
* @property value
* @name value
*/
error.DatabaseError.prototype.value;
/**
* The name of the index that triggered the error
* @property index
* @name index
*/
error.DatabaseError.prototype.index;
/**
* Validation Error Item * Validation Error Item
* Instances of this class are included in the `ValidationError.errors` property. * Instances of this class are included in the `ValidationError.errors` property.
* *
......
lib/instance.js
...@@ -572,21 +572,25 @@ module.exports = (function() { ...@@ -572,21 +572,25 @@ module.exports = (function() {
}); });
} }
}).then(function() { }).then(function() {
return self.QueryInterface[query].apply(self.QueryInterface, args).catch(function(err) { return self.QueryInterface[query].apply(self.QueryInterface, args).catch(self.sequelize.UniqueConstraintError, function(err) {
if (!!self.__options.uniqueKeys && err.code && self.QueryInterface.QueryGenerator.uniqueConstraintMapping.code === err.code) { if (!!self.__options.uniqueKeys && self.QueryInterface.QueryGenerator.uniqueConstraintMapping.code === err.parent.code) {
var index = self.QueryInterface.QueryGenerator.uniqueConstraintMapping.map(err.toString()); var index = self.QueryInterface.QueryGenerator.uniqueConstraintMapping.map(err.parent.toString());
if (index !== false) { if (index !== false) {
var fields = index.fields.filter(function(f) { return f !== self.Model.tableName; }); var fields = index.fields.filter(function(f) { return f !== self.Model.tableName; });
Utils._.each(self.__options.uniqueKeys, function(uniqueKey) { Utils._.each(self.__options.uniqueKeys, function(uniqueKey) {
if (!!uniqueKey.msg && (Utils._.isEqual(uniqueKey.fields, fields)) || uniqueKey.name === index.indexName) { if (!!uniqueKey.msg && (Utils._.isEqual(uniqueKey.fields, fields)) || uniqueKey.name === index.indexName) {
err = new Error(uniqueKey.msg); err = new self.sequelize.UniqueConstraintError({
message: uniqueKey.msg,
fields: fields,
index: index.indexName,
parent: err.parent
});
} }
}); });
} }
} }
throw err; throw err;
}).tap(function(result) { }).tap(function(result) {
// Transfer database generated values (defaults, autoincrement, etc) // Transfer database generated values (defaults, autoincrement, etc)
......
lib/model.js
...@@ -1081,43 +1081,71 @@ module.exports = (function() { ...@@ -1081,43 +1081,71 @@ module.exports = (function() {
* Find a row that matches the query, or build and save the row if none is found * Find a row that matches the query, or build and save the row if none is found
* The successfull result of the promise will be (instance, created) - Make sure to use .spread() * The successfull result of the promise will be (instance, created) - Make sure to use .spread()
* *
* @param {Object} where A hash of search attributes. Note that this method differs from finders, in that the syntax is `{ attr1: 42 }` and NOT `{ where: { attr1: 42}}`. This is subject to change in 2.0 * If no transaction is passed in the `queryOptions` object, a new transaction will be created internally, to prevent the race condition where a matching row is created by another connection after the find but before the insert call.
* @param {Object} [defaults] Default values to use if creating a new instance * However, it is not always possible to handle this case in SQLite, specifically if one transaction inserts and another tries to select before the first one has comitted. In this case, an instance of sequelize.TimeoutError will be thrown instead.
* @param {Object} [options] Options passed to the find and create calls * If a transaction is created, a savepoint will be created instead, and any unique constraint violation will be handled internally.
* @deprecated The syntax is due for change, in order to make `where` more consistent with the rest of the API
* *
* @return {Promise<Instance>} * @param {Object} options
* @param {Object} options.where where A hash of search attributes.
* @param {Object} [options.defaults] Default values to use if creating a new instance
* @param {Object} [queryOptions] Options passed to the find and create calls
*
* @return {Promise<Instance,created>}
*/ */
Model.prototype.findOrCreate = function(where, defaults, options) { Model.prototype.findOrCreate = function(options, queryOptions) {
var self = this var self = this
, values = {}; , internalTransaction = !(queryOptions && queryOptions.transaction)
, values;
options = Utils._.extend({ queryOptions = queryOptions ? Utils._.clone(queryOptions) : {};
transaction: null
}, options || {});
if (!(where instanceof Utils.or) && !(where instanceof Utils.and) && !Array.isArray(where)) { if (!options || !options.where) {
for (var attrname in where) { throw new Error('Missing where attribute in the options parameter passed to findOrCreate. Please note that the API has changed, and is now options (an object with where and defaults keys), queryOptions (transaction etc.)');
values[attrname] = where[attrname];
}
} }
return self.find({ // Create a transaction or a savepoint, depending on whether a transaction was passed in
where: where return self.sequelize.transaction(queryOptions).bind({}).then(function (transaction) {
}, { this.transaction = transaction;
transaction: options.transaction queryOptions.transaction = transaction;
return self.find(options, {
transaction: transaction,
});
}).then(function(instance) { }).then(function(instance) {
if (instance === null) { if (instance !== null) {
for (var attrname in defaults) { return [instance, false];
values[attrname] = defaults[attrname];
} }
return self.create(values, options).then(function(instance) { values = Utils._.clone(options.defaults) || {};
return Promise.resolve([instance, true]); if (Utils._.isPlainObject(options.where)) {
}); values = Utils._.defaults(values, options.where);
} }
return Promise.resolve([instance, false]); // VERY PG specific
// If a unique constraint is triggered inside a transaction, we cannot execute further queries inside that transaction, short of rolling back or committing.
// To circumwent this, we add an EXCEPTION WHEN unique_violation clause, which always returns an empty result set
queryOptions.exception = 'WHEN unique_violation THEN RETURN QUERY SELECT * FROM <%= table %> WHERE 1 <> 1;';
return self.create(values, queryOptions).bind(this).then(function(instance) {
if (instance.get(self.primaryKeyAttribute, { raw: true }) === null) {
// If the query returned an empty result for the primary key, we know that this was actually a unique constraint violation
throw new self.sequelize.UniqueConstraintError();
}
return [instance, true];
}).catch(self.sequelize.UniqueConstraintError, function () {
// Someone must have created a matching instance inside the same transaction since we last did a find. Let's find it!
return self.find(options, {
transaction: internalTransaction ? null : this.transaction,
}).then(function(instance) {
return [instance, false];
});
});
}).tap(function () {
if (internalTransaction) {
// If we created a transaction internally, we should clean it up
return this.transaction.commit();
}
}); });
}; };
......
lib/query-interface.js
...@@ -434,6 +434,7 @@ module.exports = (function() { ...@@ -434,6 +434,7 @@ module.exports = (function() {
QueryInterface.prototype.insert = function(dao, tableName, values, options) { QueryInterface.prototype.insert = function(dao, tableName, values, options) {
var sql = this.QueryGenerator.insertQuery(tableName, values, dao.Model.rawAttributes, options); var sql = this.QueryGenerator.insertQuery(tableName, values, dao.Model.rawAttributes, options);
options.type = 'INSERT';
return this.sequelize.query(sql, dao, options).then(function(result) { return this.sequelize.query(sql, dao, options).then(function(result) {
result.isNewRecord = false; result.isNewRecord = false;
return result; return result;
......
lib/query-types.js
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
module.exports = { module.exports = {
SELECT: 'SELECT', SELECT: 'SELECT',
INSERT: 'INSERT',
BULKUPDATE: 'BULKUPDATE', BULKUPDATE: 'BULKUPDATE',
BULKDELETE: 'BULKDELETE' BULKDELETE: 'BULKDELETE'
}; };
lib/sequelize.js
...@@ -248,6 +248,27 @@ module.exports = (function() { ...@@ -248,6 +248,27 @@ module.exports = (function() {
sequelizeErrors.ValidationErrorItem; sequelizeErrors.ValidationErrorItem;
/** /**
* A base class for all database related errors.
* @see {Errors#DatabaseError}
*/
Sequelize.prototype.DatabaseError = Sequelize.DatabaseError =
sequelizeErrors.DatabaseError;
/**
* Thrown when a database query times out because of a deadlock
* @see {Errors#TimeoutError}
*/
Sequelize.prototype.TimeoutError = Sequelize.TimeoutError =
sequelizeErrors.TimeoutError;
/**
* Thrown when a unique constraint is violated in the database
* @see {Errors#UniqueConstraintError}
*/
Sequelize.prototype.UniqueConstraintError = Sequelize.UniqueConstraintError =
sequelizeErrors.UniqueConstraintError;
/**
* Returns the specified dialect. * Returns the specified dialect.
* *
* @return {String} The specified dialect. * @return {String} The specified dialect.
......
lib/transaction.js
...@@ -22,6 +22,7 @@ var Transaction = module.exports = function(sequelize, options) { ...@@ -22,6 +22,7 @@ var Transaction = module.exports = function(sequelize, options) {
this.id = this.options.transaction.id; this.id = this.options.transaction.id;
this.options.transaction.savepoints.push(this); this.options.transaction.savepoints.push(this);
this.name = this.id + '-savepoint-' + this.options.transaction.savepoints.length; this.name = this.id + '-savepoint-' + this.options.transaction.savepoints.length;
this.parent = this.options.transaction;
} else { } else {
this.id = this.name = Utils.generateUUID(); this.id = this.name = Utils.generateUUID();
} }
...@@ -146,5 +147,6 @@ Transaction.prototype.setIsolationLevel = function() { ...@@ -146,5 +147,6 @@ Transaction.prototype.setIsolationLevel = function() {
}; };
Transaction.prototype.cleanup = function() { Transaction.prototype.cleanup = function() {
this.connection.uuid = undefined;
return this.sequelize.connectionManager.releaseConnection(this.connection); return this.sequelize.connectionManager.releaseConnection(this.connection);
}; };
test/dao-factory.test.js
...@@ -312,7 +312,8 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -312,7 +312,8 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
it('allows us to customize the error message for unique constraint', function(done) { it('allows us to customize the error message for unique constraint', function(done) {
var User = this.sequelize.define('UserWithUniqueUsername', { var self = this
, User = this.sequelize.define('UserWithUniqueUsername', {
username: { type: Sequelize.STRING, unique: { name: 'user_and_email', msg: 'User and email must be unique' }}, username: { type: Sequelize.STRING, unique: { name: 'user_and_email', msg: 'User and email must be unique' }},
email: { type: Sequelize.STRING, unique: 'user_and_email' }, email: { type: Sequelize.STRING, unique: 'user_and_email' },
aCol: { type: Sequelize.STRING, unique: 'a_and_b' }, aCol: { type: Sequelize.STRING, unique: 'a_and_b' },
...@@ -321,7 +322,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -321,7 +322,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
User.sync({ force: true }).success(function() { User.sync({ force: true }).success(function() {
User.create({username: 'tobi', email: 'tobi@tobi.me'}).success(function() { User.create({username: 'tobi', email: 'tobi@tobi.me'}).success(function() {
User.create({username: 'tobi', email: 'tobi@tobi.me'}).error(function(err) { User.create({username: 'tobi', email: 'tobi@tobi.me'}).catch(self.sequelize.UniqueConstraintError, function(err) {
expect(err.message).to.equal('User and email must be unique') expect(err.message).to.equal('User and email must be unique')
done() done()
}) })
......
test/dao-factory/create.test.js
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
/* jshint expr: true */ /* jshint expr: true */
var chai = require('chai') var chai = require('chai')
, Sequelize = require('../../index') , Sequelize = require('../../index')
, Promise = Sequelize.Promise
, expect = chai.expect , expect = chai.expect
, Support = require(__dirname + '/../support') , Support = require(__dirname + '/../support')
, DataTypes = require(__dirname + "/../../lib/data-types") , DataTypes = require(__dirname + "/../../lib/data-types")
...@@ -14,7 +15,10 @@ chai.use(datetime) ...@@ -14,7 +15,10 @@ chai.use(datetime)
chai.config.includeStack = true chai.config.includeStack = true
describe(Support.getTestDialectTeaser("DAOFactory"), function () { describe(Support.getTestDialectTeaser("DAOFactory"), function () {
beforeEach(function(done) { beforeEach(function () {
return Support.prepareTransactionTest(this.sequelize).bind(this).then(function(sequelize) {
this.sequelize = sequelize;
this.User = this.sequelize.define('User', { this.User = this.sequelize.define('User', {
username: DataTypes.STRING, username: DataTypes.STRING,
secretValue: DataTypes.STRING, secretValue: DataTypes.STRING,
...@@ -25,28 +29,19 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -25,28 +29,19 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
uniqueName: { type: DataTypes.STRING, unique: true } uniqueName: { type: DataTypes.STRING, unique: true }
}) })
this.User.sync({ force: true }).success(function() { return this.User.sync({ force: true });
done() });
}) });
})
describe('findOrCreate', function () { describe('findOrCreate', function () {
it("supports transactions", function(done) { it("supports transactions", function(done) {
var self = this;
Support.prepareTransactionTest(this.sequelize, function(sequelize) { this.sequelize.transaction().then(function(t) {
var User = sequelize.define('user_with_transaction', { username: Sequelize.STRING, data: Sequelize.STRING }) self.User.findOrCreate({ where: { username: 'Username' }, defaults: { data: 'some data' }}, { transaction: t }).then(function() {
self.User.count().success(function(count) {
User
.sync({ force: true })
.success(function() {
sequelize.transaction().then(function(t) {
User.findOrCreate({ username: 'Username' }, { data: 'some data' }, { transaction: t }).complete(function(err) {
expect(err).to.be.null
User.count().success(function(count) {
expect(count).to.equal(0) expect(count).to.equal(0)
t.commit().success(function() { t.commit().success(function() {
User.count().success(function(count) { self.User.count().success(function(count) {
expect(count).to.equal(1) expect(count).to.equal(1)
done() done()
}) })
...@@ -55,8 +50,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -55,8 +50,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
}) })
}) })
})
})
it("returns instance if already existent. Single find field.", function(done) { it("returns instance if already existent. Single find field.", function(done) {
var self = this, var self = this,
...@@ -65,9 +58,9 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -65,9 +58,9 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}; };
this.User.create(data).success(function (user) { this.User.create(data).success(function (user) {
self.User.findOrCreate({ self.User.findOrCreate({ where: {
username: user.username username: user.username
}).spread(function (_user, created) { }}).spread(function (_user, created) {
expect(_user.id).to.equal(user.id) expect(_user.id).to.equal(user.id)
expect(_user.username).to.equal('Username') expect(_user.username).to.equal('Username')
expect(created).to.be.false expect(created).to.be.false
...@@ -84,7 +77,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -84,7 +77,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}; };
this.User.create(data).success(function (user) { this.User.create(data).success(function (user) {
self.User.findOrCreate(data).done(function (err, _user, created) { self.User.findOrCreate({where: data}).done(function (err, _user, created) {
expect(_user.id).to.equal(user.id) expect(_user.id).to.equal(user.id)
expect(_user.username).to.equal('Username') expect(_user.username).to.equal('Username')
expect(_user.data).to.equal('ThisIsData') expect(_user.data).to.equal('ThisIsData')
...@@ -102,7 +95,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -102,7 +95,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
data: 'ThisIsData' data: 'ThisIsData'
}; };
this.User.findOrCreate(data, default_values).success(function(user, created) { this.User.findOrCreate({ where: data, defaults: default_values}).success(function(user, created) {
expect(user.username).to.equal('Username') expect(user.username).to.equal('Username')
expect(user.data).to.equal('ThisIsData') expect(user.data).to.equal('ThisIsData')
expect(created).to.be.true expect(created).to.be.true
...@@ -111,10 +104,10 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -111,10 +104,10 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
it("supports .or() (only using default values)", function (done) { it("supports .or() (only using default values)", function (done) {
this.User.findOrCreate( this.User.findOrCreate({
Sequelize.or({username: 'Fooobzz'}, {secretValue: 'Yolo'}), where: Sequelize.or({username: 'Fooobzz'}, {secretValue: 'Yolo'}),
{username: 'Fooobzz', secretValue: 'Yolo'} defaults: {username: 'Fooobzz', secretValue: 'Yolo'}
).done(function (err, user, created) { }).done(function (err, user, created) {
expect(err).not.to.be.ok expect(err).not.to.be.ok
expect(user.username).to.equal('Fooobzz') expect(user.username).to.equal('Fooobzz')
expect(user.secretValue).to.equal('Yolo') expect(user.secretValue).to.equal('Yolo')
...@@ -123,7 +116,45 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -123,7 +116,45 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
done() done()
}) })
}) })
})
describe('several concurrent calls', function () {
it('works with a transaction', function () {
return this.sequelize.transaction().bind(this).then(function (transaction) {
return Promise.join(
this.User.findOrCreate({ where: { uniqueName: 'winner' }}, { transaction: transaction }),
this.User.findOrCreate({ where: { uniqueName: 'winner' }}, { transaction: transaction }),
function (first, second) {
expect(first[0]).to.be.ok;
expect(first[1]).to.be.ok;
expect(second[0]).to.be.ok;
expect(second[1]).not.to.be.ok;
expect(first[0].id).to.equal(second[0].id);
return transaction.commit();
}
);
});
});
// Creating two concurrent transactions and selecting / inserting from the same table throws sqlite off
(dialect !== 'sqlite' ? it : it.skip)('works without a transaction', function () {
return Promise.join(
this.User.findOrCreate({ where: { uniqueName: 'winner' }}),
this.User.findOrCreate({ where: { uniqueName: 'winner' }}),
function (first, second) {
expect(first[0]).to.be.ok;
expect(first[1]).to.be.ok;
expect(second[0]).to.be.ok;
expect(second[1]).not.to.be.ok;
expect(first[0].id).to.equal(second[0].id);
}
);
});
});
});
describe('create', function() { describe('create', function() {
it('works with non-integer primary keys with a default value', function (done) { it('works with non-integer primary keys with a default value', function (done) {
...@@ -178,17 +209,13 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -178,17 +209,13 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
it('supports transactions', function(done) { it('supports transactions', function(done) {
var self = this;
Support.prepareTransactionTest(this.sequelize, function(sequelize) { this.sequelize.transaction().then(function(t) {
var User = sequelize.define('user_with_transaction', { username: Sequelize.STRING }) self.User.create({ username: 'user' }, { transaction: t }).success(function() {
self.User.count().success(function(count) {
User.sync({ force: true }).success(function() {
sequelize.transaction().then(function(t) {
User.create({ username: 'user' }, { transaction: t }).success(function() {
User.count().success(function(count) {
expect(count).to.equal(0) expect(count).to.equal(0)
t.commit().success(function() { t.commit().success(function() {
User.count().success(function(count) { self.User.count().success(function(count) {
expect(count).to.equal(1) expect(count).to.equal(1)
done() done()
}) })
...@@ -197,8 +224,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -197,8 +224,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
}) })
}) })
})
})
it('is possible to use casting when creating an instance', function (done) { it('is possible to use casting when creating an instance', function (done) {
var self = this var self = this
...@@ -389,24 +414,14 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -389,24 +414,14 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
it("doesn't allow duplicated records with unique:true", function(done) { it("doesn't allow duplicated records with unique:true", function(done) {
var User = this.sequelize.define('UserWithUniqueUsername', { var self = this
, User = this.sequelize.define('UserWithUniqueUsername', {
username: { type: Sequelize.STRING, unique: true } username: { type: Sequelize.STRING, unique: true }
}) })
User.sync({ force: true }).success(function() { User.sync({ force: true }).success(function() {
User.create({ username:'foo' }).success(function() { User.create({ username:'foo' }).success(function() {
User.create({ username: 'foo' }).error(function(err) { User.create({ username: 'foo' }).catch(self.sequelize.UniqueConstraintError, function(err) {
expect(err).to.exist
if (dialect === "sqlite") {
expect(err.message).to.match(/.*SQLITE_CONSTRAINT.*/)
}
else if (Support.dialectIsMySQL()) {
expect(err.message).to.match(/.*Duplicate\ entry.*/)
} else {
expect(err.message).to.match(/.*duplicate\ key\ value.*/)
}
done() done()
}) })
}) })
...@@ -441,7 +456,8 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -441,7 +456,8 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
}) })
it("raises an error if created object breaks definition contraints", function(done) { it("raises an error if created object breaks definition contraints", function(done) {
var UserNull = this.sequelize.define('UserWithNonNullSmth', { var self = this
, UserNull = this.sequelize.define('UserWithNonNullSmth', {
username: { type: Sequelize.STRING, unique: true }, username: { type: Sequelize.STRING, unique: true },
smth: { type: Sequelize.STRING, allowNull: false } smth: { type: Sequelize.STRING, allowNull: false }
}) })
...@@ -450,16 +466,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -450,16 +466,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
UserNull.sync({ force: true }).success(function() { UserNull.sync({ force: true }).success(function() {
UserNull.create({ username: 'foo', smth: 'foo' }).success(function() { UserNull.create({ username: 'foo', smth: 'foo' }).success(function() {
UserNull.create({ username: 'foo', smth: 'bar' }).error(function(err) { UserNull.create({ username: 'foo', smth: 'bar' }).catch(self.sequelize.UniqueConstraintError, function(err) {
expect(err).to.exist
if (dialect === "sqlite") {
expect(err.message).to.match(/.*SQLITE_CONSTRAINT.*/)
}
else if (Support.dialectIsMySQL()) {
expect(err.message).to.match(/Duplicate entry 'foo' for key 'username'/)
} else {
expect(err.message).to.match(/.*duplicate key value violates unique constraint.*/)
}
done() done()
}) })
}) })
...@@ -876,16 +883,13 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -876,16 +883,13 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
describe('bulkCreate', function() { describe('bulkCreate', function() {
it("supports transactions", function(done) { it("supports transactions", function(done) {
Support.prepareTransactionTest(this.sequelize, function(sequelize) { var self = this;
var User = sequelize.define('User', { username: Sequelize.STRING }) this.sequelize.transaction().then(function(t) {
self.User
User.sync({ force: true }).success(function() {
sequelize.transaction().then(function(t) {
User
.bulkCreate([{ username: 'foo' }, { username: 'bar' }], { transaction: t }) .bulkCreate([{ username: 'foo' }, { username: 'bar' }], { transaction: t })
.success(function() { .success(function() {
User.count().success(function(count1) { self.User.count().success(function(count1) {
User.count({ transaction: t }).success(function(count2) { self.User.count({ transaction: t }).success(function(count2) {
expect(count1).to.equal(0) expect(count1).to.equal(0)
expect(count2).to.equal(2) expect(count2).to.equal(2)
t.rollback().success(function(){ done() }) t.rollback().success(function(){ done() })
...@@ -894,8 +898,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -894,8 +898,6 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}) })
}) })
}) })
})
})
it('properly handles disparate field lists', function(done) { it('properly handles disparate field lists', function(done) {
var self = this var self = this
......
test/dao-factory/scopes.test.js
...@@ -14,6 +14,8 @@ chai.config.includeStack = true; ...@@ -14,6 +14,8 @@ chai.config.includeStack = true;
describe(Support.getTestDialectTeaser("DAOFactory"), function () { describe(Support.getTestDialectTeaser("DAOFactory"), function () {
beforeEach(function() { beforeEach(function() {
return Support.prepareTransactionTest(this.sequelize).bind(this).then(function(sequelize) {
this.sequelize = sequelize;
this.User = this.sequelize.define('User', { this.User = this.sequelize.define('User', {
username: DataTypes.STRING, username: DataTypes.STRING,
secretValue: DataTypes.STRING, secretValue: DataTypes.STRING,
...@@ -25,6 +27,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -25,6 +27,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
return this.User.sync({ force: true }); return this.User.sync({ force: true });
}); });
});
describe('scopes', function() { describe('scopes', function() {
beforeEach(function() { beforeEach(function() {
...@@ -267,7 +270,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () { ...@@ -267,7 +270,7 @@ describe(Support.getTestDialectTeaser("DAOFactory"), function () {
}); });
it("should have no problem performing findOrCreate", function() { it("should have no problem performing findOrCreate", function() {
return this.ScopeMe.findOrCreate({username: 'fake'}).spread(function(user) { return this.ScopeMe.findOrCreate({ where: {username: 'fake'}}).spread(function(user) {
expect(user.username).to.equal('fake'); expect(user.username).to.equal('fake');
}); });
}); });
......
test/error.test.js
"use strict";
/* jshint camelcase: false */ /* jshint camelcase: false */
var chai = require('chai') var chai = require('chai')
, sinon = require('sinon')
, expect = chai.expect , expect = chai.expect
, Support = require(__dirname + '/support') , Support = require(__dirname + '/support')
, Sequelize = Support.Sequelize; , Sequelize = Support.Sequelize
, Promise = Sequelize.Promise;
chai.config.includeStack = true; chai.config.includeStack = true;
...@@ -49,7 +53,31 @@ describe(Support.getTestDialectTeaser("Sequelize Errors"), function () { ...@@ -49,7 +53,31 @@ describe(Support.getTestDialectTeaser("Sequelize Errors"), function () {
var matches = validationError.get('first_name'); var matches = validationError.get('first_name');
expect(matches).to.be.instanceOf(Array); expect(matches).to.be.instanceOf(Array);
expect(matches).to.have.lengthOf(1); expect(matches).to.have.lengthOf(1);
expect(matches[0]).to.have.property('message', 'invalid') expect(matches[0]).to.have.property('message', 'invalid');
});
});
describe('Constraint error', function () {
it('Can be intercepted using .catch', function () {
var spy = sinon.spy()
, User = this.sequelize.define('user', {
first_name: {
type: Sequelize.STRING,
unique: 'unique_name'
},
last_name: {
type: Sequelize.STRING,
unique: 'unique_name'
}
});
return this.sequelize.sync({ force: true }).bind(this).then(function () {
return User.create({ first_name: 'jan', last_name: 'meier' });
}).then(function () {
return User.create({ first_name: 'jan', last_name: 'meier' }).catch(this.sequelize.UniqueConstraintError, spy);
}).then(function () {
expect(spy).to.have.been.calledOnce;
});
});
}); });
})
}); });
test/promise.test.js
...@@ -10,7 +10,9 @@ var chai = require('chai') ...@@ -10,7 +10,9 @@ var chai = require('chai')
chai.config.includeStack = true chai.config.includeStack = true
describe(Support.getTestDialectTeaser("Promise"), function () { describe(Support.getTestDialectTeaser("Promise"), function () {
beforeEach(function(done) { beforeEach(function() {
return Support.prepareTransactionTest(this.sequelize).bind(this).then(function(sequelize) {
this.sequelize = sequelize;
this.User = this.sequelize.define('User', { this.User = this.sequelize.define('User', {
username: { type: DataTypes.STRING }, username: { type: DataTypes.STRING },
touchedAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW }, touchedAt: { type: DataTypes.DATE, defaultValue: DataTypes.NOW },
...@@ -34,8 +36,9 @@ describe(Support.getTestDialectTeaser("Promise"), function () { ...@@ -34,8 +36,9 @@ describe(Support.getTestDialectTeaser("Promise"), function () {
} }
}) })
this.User.sync({ force: true }).then(function() { done() }) return this.User.sync({ force: true })
}) })
});
describe('increment', function () { describe('increment', function () {
beforeEach(function(done) { beforeEach(function(done) {
...@@ -321,7 +324,7 @@ describe(Support.getTestDialectTeaser("Promise"), function () { ...@@ -321,7 +324,7 @@ describe(Support.getTestDialectTeaser("Promise"), function () {
describe('with spread', function () { describe('with spread', function () {
it('user not created', function (done) { it('user not created', function (done) {
this.User this.User
.findOrCreate({ id: 1}) .findOrCreate({ where: { id: 1}})
.spread(function(user, created) { .spread(function(user, created) {
expect(user.id).to.equal(1) expect(user.id).to.equal(1)
expect(created).to.equal(false) expect(created).to.equal(false)
...@@ -331,7 +334,7 @@ describe(Support.getTestDialectTeaser("Promise"), function () { ...@@ -331,7 +334,7 @@ describe(Support.getTestDialectTeaser("Promise"), function () {
}) })
it('user created', function (done) { it('user created', function (done) {
this.User this.User
.findOrCreate({ id: 2}) .findOrCreate({ where: { id: 2}})
.spread(function(user, created) { .spread(function(user, created) {
expect(user.id).to.equal(2) expect(user.id).to.equal(2)
expect(created).to.equal(true) expect(created).to.equal(true)
......
test/support.js
...@@ -188,7 +188,7 @@ var Support = { ...@@ -188,7 +188,7 @@ var Support = {
}; };
var sequelize = Support.createSequelizeInstance(); var sequelize = Support.createSequelizeInstance();
//
// For Postgres' HSTORE functionality and to properly execute it's commands we'll need this... // For Postgres' HSTORE functionality and to properly execute it's commands we'll need this...
before(function() { before(function() {
var dialect = Support.getTestDialect(); var dialect = Support.getTestDialect();
...@@ -205,4 +205,5 @@ beforeEach(function() { ...@@ -205,4 +205,5 @@ beforeEach(function() {
return Support.clearDatabase(this.sequelize); return Support.clearDatabase(this.sequelize);
}); });
module.exports = Support; module.exports = Support;
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!