Skip to content

Commit 01c1a0e

Browse files
devinivydevinivy
committed
Merge pull request balderdashy#211 from eddieajau/issue-173
Standardise query logging.
2 parents 2181cc9 + 433dd92 commit 01c1a0e

File tree

2 files changed

+47
-27
lines changed

2 files changed

+47
-27
lines changed

‎.editorconfig

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true

‎lib/adapter.js

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ var STRINGFILE = {
2727
};
2828

2929
// Hack for development - in future versions, allow
30-
// string queries to be elegantly displayed (see wl2
30+
// logger to be injected (see wl2
3131
// or tweet @mikermcneil for status of this feature or
3232
// to help out)
33-
var LOG_QUERIES = process.env.LOG_QUERIES === 'true';
33+
var log = (process.env.LOG_QUERIES === 'true') ? console.log : function () {};
3434

3535
module.exports = (function() {
3636

@@ -100,6 +100,8 @@ module.exports = (function() {
100100
function __QUERY__(connection, cb) {
101101

102102
// Run query
103+
log('MySQL.query: ', query);
104+
103105
if (data) connection.query(query, data, cb);
104106
else connection.query(query, cb);
105107

@@ -130,10 +132,9 @@ module.exports = (function() {
130132
var pkQuery = 'SHOW INDEX FROM ' + tableName;
131133

132134
// Run query
133-
if (LOG_QUERIES) {
134-
console.log('\nExecuting MySQL query: ',query);
135-
console.log('and: ',pkQuery);
136-
}
135+
log('MySQL.describe: ', query);
136+
log('MySQL.describe(pk): ', pkQuery);
137+
137138
connection.query(query, function __DESCRIBE__(err, schema) {
138139
if (err) {
139140
if (err.code === 'ER_NO_SUCH_TABLE') {
@@ -221,9 +222,8 @@ module.exports = (function() {
221222

222223

223224
// Run query
224-
if (LOG_QUERIES) {
225-
console.log('\nExecuting MySQL query: ',query);
226-
}
225+
log('MYSQL.define: ', query);
226+
227227
connection.query(query, function __DEFINE__(err, result) {
228228
if (err) return cb(err);
229229

@@ -269,11 +269,9 @@ module.exports = (function() {
269269
// Build query
270270
var query = 'DROP TABLE ' + tableName;
271271

272-
if (LOG_QUERIES) {
273-
console.log('\nExecuting MySQL query: ',query);
274-
}
275-
276272
// Run query
273+
log('MYSQL.drop: ', query);
274+
277275
connection.query(query, function __DROP__(err, result) {
278276
if (err) {
279277
if (err.code !== 'ER_BAD_TABLE_ERROR' && err.code !== 'ER_NO_SUCH_TABLE') return next(err);
@@ -310,11 +308,8 @@ module.exports = (function() {
310308
var query = sql.addColumn(tableName, attrName, attrDef);
311309

312310
// Run query
313-
if (LOG_QUERIES) {
314-
console.log('\nExecuting MySQL query: ',query);
315-
}
311+
log('MYSQL.addAttribute: ', query);
316312

317-
// Run query
318313
connection.query(query, function(err, result) {
319314
if (err) return cb(err);
320315

@@ -342,11 +337,9 @@ module.exports = (function() {
342337

343338
var query = sql.removeColumn(tableName, attrName);
344339

345-
if (LOG_QUERIES) {
346-
console.log('\nExecuting MySQL query: ',query);
347-
}
348-
349340
// Run query
341+
log('MYSQL.removeAttribute: ', query);
342+
350343
connection.query(query, function(err, result) {
351344
if (err) return cb(err);
352345

@@ -396,6 +389,8 @@ module.exports = (function() {
396389
}
397390

398391
// Run query
392+
log('MySQL.create: ', _query.query);
393+
399394
connection.query(_query.query, function(err, result) {
400395
if (err) return cb( handleQueryError(err) );
401396

@@ -458,6 +453,8 @@ module.exports = (function() {
458453
}
459454

460455
// Run query
456+
log('MySQL.createEach: ', _query.query);
457+
461458
connection.query(_query.query, function(err, results) {
462459
if (err) return cb( handleQueryError(err) );
463460
records.push(results.insertId);
@@ -483,9 +480,8 @@ module.exports = (function() {
483480
var query = 'SELECT * FROM ' + mysql.escapeId(tableName) + ' WHERE ' + mysql.escapeId(pk) + ' IN (' + records + ');';
484481

485482
// Run Query returing results
486-
if (LOG_QUERIES) {
487-
console.log('\ncreateEach() :: Executing MySQL query: ',query);
488-
}
483+
log('MYSQL.createEach: ', query);
484+
489485
connection.query(query, function(err, results) {
490486
if(err) return cb(err);
491487
cb(null, results);
@@ -585,6 +581,8 @@ module.exports = (function() {
585581
async.auto({
586582

587583
processParent: function(next) {
584+
log('MySQL.populateBuffers: ', _query.query[0]);
585+
588586
client.query(_query.query[0], function __FIND__(err, result) {
589587
if(err) return next(err);
590588

@@ -734,6 +732,8 @@ module.exports = (function() {
734732
}
735733
}
736734

735+
log('MySQL.processChildren: ', qs);
736+
737737
client.query(qs, function __FIND__(err, result) {
738738
if(err) return next(err);
739739

@@ -829,9 +829,7 @@ module.exports = (function() {
829829
}
830830

831831
// Run query
832-
if (LOG_QUERIES) {
833-
console.log('\nExecuting MySQL query: ',_query);
834-
}
832+
log('MYSQL.find: ', _query.query[0]);
835833

836834
connection.query(_query.query[0], function(err, result) {
837835
if(err) return cb(err);
@@ -875,6 +873,8 @@ module.exports = (function() {
875873
var query = sql.countQuery(tableName, options, localSchema);
876874

877875
// Run query
876+
log('MySQL.count: ', query);
877+
878878
connection.query(query, function(err, result) {
879879
if(err) return cb(err);
880880
// Return the count from the simplified query
@@ -904,6 +904,8 @@ module.exports = (function() {
904904
var query = sql.selectQuery(tableName, options);
905905

906906
// Run query
907+
log('MySQL.stream: ', query);
908+
907909
var dbStream = connection.query(query);
908910

909911
// Handle error, an 'end' event will be emitted after this as well
@@ -958,6 +960,8 @@ module.exports = (function() {
958960
return cb(e);
959961
}
960962

963+
log('MySQL.update(before): ', _query.query[0]);
964+
961965
connection.query(_query.query[0], function(err, results) {
962966
if(err) return cb(err);
963967

@@ -991,6 +995,8 @@ module.exports = (function() {
991995
}
992996

993997
// Run query
998+
log('MySQL.update: ', _query.query);
999+
9941000
connection.query(_query.query, function(err, result) {
9951001
if (err) return cb( handleQueryError(err) );
9961002

@@ -1011,6 +1017,8 @@ module.exports = (function() {
10111017
}
10121018

10131019
// Run query
1020+
log('MySQL.update(after): ', _query.query[0]);
1021+
10141022
connection.query(_query.query[0], function(err, result) {
10151023
if(err) return cb(err);
10161024
cb(null, result);
@@ -1057,6 +1065,8 @@ module.exports = (function() {
10571065
},
10581066

10591067
destroyRecords: ['findRecords', function(next) {
1068+
log('MySQL.destroy: ', _query.query);
1069+
10601070
connection.query(_query.query, next);
10611071
}]
10621072
},

0 commit comments

Comments
 (0)