From 3af05bb7346c22759523ad1116b58439b66294eb Mon Sep 17 00:00:00 2001 From: Raul Ochoa Date: Thu, 5 May 2016 12:17:33 +0200 Subject: [PATCH 1/3] Remove console usage --- test/acceptance/analysis/analysis-layers-use-cases.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/acceptance/analysis/analysis-layers-use-cases.js b/test/acceptance/analysis/analysis-layers-use-cases.js index e60c8e79..83c2f535 100644 --- a/test/acceptance/analysis/analysis-layers-use-cases.js +++ b/test/acceptance/analysis/analysis-layers-use-cases.js @@ -3,6 +3,7 @@ require('../../support/test_helper'); var assert = require('../../support/assert'); var TestClient = require('../../support/test-client'); var dot = require('dot'); +var debug = require('debug')('windshaft:cartodb:test'); describe('analysis-layers use cases', function() { @@ -649,7 +650,7 @@ describe('analysis-layers use cases', function() { useCases.forEach(function(useCase, imageIdx) { if (!!useCase.skip) { - console.log(JSON.stringify(useCase.mapConfig, null, 4)); + debug(JSON.stringify(useCase.mapConfig, null, 4)); } it.skip('should implement use case: "' + useCase.desc + '"', function(done) { From e3d6da06a71aa97fa371f4a8a9ed48e8b7b2ec16 Mon Sep 17 00:00:00 2001 From: Raul Ochoa Date: Thu, 5 May 2016 12:17:51 +0200 Subject: [PATCH 2/3] Remove console usage --- lib/cartodb/server.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/cartodb/server.js b/lib/cartodb/server.js index 7df6a69f..ed24f651 100644 --- a/lib/cartodb/server.js +++ b/lib/cartodb/server.js @@ -3,6 +3,7 @@ var bodyParser = require('body-parser'); var RedisPool = require('redis-mpool'); var cartodbRedis = require('cartodb-redis'); var _ = require('underscore'); +var debug = require('debug')('windshaft:cartodb'); var controller = require('./controllers'); @@ -231,7 +232,7 @@ function validateOptions(opts) { // Be nice and warn if configured mapnik version is != instaled mapnik version if (mapnik.versions.mapnik !== opts.grainstore.mapnik_version) { - console.warn('WARNING: detected mapnik version (' + mapnik.versions.mapnik + ')' + + debug('WARNING: detected mapnik version (' + mapnik.versions.mapnik + ')' + ' != configured mapnik version (' + opts.grainstore.mapnik_version + ')'); } } From 38d57533c2fda30439091c73a5ae898571189608 Mon Sep 17 00:00:00 2001 From: Raul Ochoa Date: Thu, 5 May 2016 12:18:22 +0200 Subject: [PATCH 3/3] Discourage console usage, global.logger should be used when required --- .jshintrc | 19 ++++++++++--------- app.js | 17 +++++++++++------ 2 files changed, 21 insertions(+), 15 deletions(-) diff --git a/.jshintrc b/.jshintrc index bb4333ba..00a59a27 100644 --- a/.jshintrc +++ b/.jshintrc @@ -82,13 +82,14 @@ // "wsh" : false, // Windows Scripting Host // "yui" : false, // Yahoo User Interface - // Custom Globals - "globals" : { // additional predefined global variables - "describe": true, - "before": true, - "after": true, - "beforeEach": true, - "afterEach": true, - "it": true - } + // Custom predefined global variables + "predef": [ + "-console", // disallows console, use debug + "beforeEach", + "afterEach", + "before", + "after", + "describe", + "it" + ] } diff --git a/app.js b/app.js index af094d56..d1fe3fb4 100755 --- a/app.js +++ b/app.js @@ -14,6 +14,11 @@ if ( process.argv[2] ) { ENVIRONMENT = 'development'; } +// jshint undef:false +var log = console.log.bind(console); +var logError = console.error.bind(console); +// jshint undef:true + var availableEnvironments = { production: true, staging: true, @@ -22,8 +27,8 @@ var availableEnvironments = { // sanity check if (!availableEnvironments[ENVIRONMENT]){ - console.error('node app.js [environment]'); - console.error('environments: %s', Object.keys(availableEnvironments).join(', ')); + logError('node app.js [environment]'); + logError('environments: %s', Object.keys(availableEnvironments).join(', ')); process.exit(1); } @@ -58,10 +63,10 @@ if ( global.environment.log_filename ) { // See cwd inlog4js.configure call below logdir = path.resolve(__dirname, logdir); if ( ! fs.existsSync(logdir) ) { - console.error("Log filename directory does not exist: " + logdir); + logError("Log filename directory does not exist: " + logdir); process.exit(1); } - console.log("Logs will be written to " + global.environment.log_filename); + log("Logs will be written to " + global.environment.log_filename); log4js_config.appenders.push( { type: "file", filename: global.environment.log_filename } ); @@ -94,7 +99,7 @@ var listener = server.listen(serverOptions.bind.port, serverOptions.bind.host, b var version = require("./package").version; listener.on('listening', function() { - console.log( + log( "Windshaft tileserver %s started on %s:%s PID=%d (%s)", version, serverOptions.bind.host, serverOptions.bind.port, process.pid, ENVIRONMENT ); @@ -111,7 +116,7 @@ process.on('SIGHUP', function() { global.log4js.clearAndShutdownAppenders(function() { global.log4js.configure(log4js_config); global.logger = global.log4js.getLogger(); - console.log('Log files reloaded'); + log('Log files reloaded'); }); });