Lib: Add log, warn, and error methods and remove old console.logs

Author: mdtusz

src/.eslintrc

@@ -9,6 +9,7 @@
     "Uint8Array": true
   },
   "rules": {
-    "strict": [2, "global"]
+    "strict": [2, "global"],
+    "no-console": [1]
   }
 }

src/components/drawing/index.js

@@ -122,7 +122,7 @@ drawing.fillGroupStyle = function(s) {
             shape.call(Color.fill, d[0].trace.fillcolor);
         }
         catch(e) {
-            console.log(e, s);
+            Lib.error(e, s);
             shape.remove();
         }
     });

src/components/rangeslider/range_plot.js

@@ -10,6 +10,7 @@
 
 var d3 = require('d3');
 
+var Lib = require('../../lib');
 var Symbols = require('../drawing/symbol_defs');
 var Drawing = require('../drawing');
 
@@ -53,7 +54,7 @@ module.exports = function rangePlot(gd, w, h) {
             pointPairs = [];
 
         if(allowedTypes.indexOf(trace.type) < 0) {
-            console.log('Trace type ' + trace.type + ' not supported for range slider!');
+            Lib.warn('Trace type ' + trace.type + ' not supported for range slider!');
             continue;
         }
 
@@ -161,7 +162,7 @@ function makeScatter(trace, pointPairs, w, h) {
                 break;
 
             default:
-                console.log('Fill type ' + trace.fill + ' not supported for range slider! (yet...)');
+                Lib.warn('Fill type ' + trace.fill + ' not supported for range slider! (yet...)');
                 break;
         }
 

src/components/shapes/index.js

@@ -351,7 +351,7 @@ function getShapeLayer(gd, index) {
         shapeLayer = gd._fullLayout._shapeUpperLayer;
 
     if(!shape) {
-        console.log('getShapeLayer: undefined shape: index', index);
+        Lib.log('getShapeLayer: undefined shape: index', index);
     }
     else if(shape.layer === 'below') {
         shapeLayer = (shape.xref === 'paper' && shape.yref === 'paper') ?
@@ -491,7 +491,7 @@ shapes.convertPath = function(pathIn, x2p, y2p) {
 
         if(paramNumber > nParams) {
             paramString = paramString.replace(/[\s,]*X.*/, '');
-            console.log('ignoring extra params in segment ' + segment);
+            Lib.log('Ignoring extra params in segment ' + segment);
         }
 
         return segmentType + paramString;

src/lib/dates.js

@@ -12,6 +12,8 @@
 var d3 = require('d3');
 var isNumeric = require('fast-isnumeric');
 
+var Lib = require('../lib');
+
 
 /**
  * dateTime2ms - turn a date object or string s of the form
@@ -122,7 +124,7 @@ function lpad(val, digits) {
  */
 exports.ms2DateTime = function(ms, r) {
     if(typeof(d3) === 'undefined') {
-        console.log('d3 is not defined');
+        Lib.error('d3 is not defined.');
         return;
     }
 

src/lib/geo_location_utils.js

@@ -10,7 +10,7 @@
 'use strict';
 
 var countryRegex = require('country-regex');
-var Lib = require('./');
+var Lib = require('../lib');
 
 
 // make list of all country iso3 ids from at runtime
@@ -32,8 +32,8 @@ exports.locationToFeature = function(locationmode, location, features) {
         if(feature.id === locationId) return feature;
     }
 
-    console.warn([
-        'location with id', locationId,
+    Lib.warn([
+        'Location with id', locationId,
         'does not have a matching topojson feature at this resolution.'
     ].join(' '));
 };
@@ -53,5 +53,5 @@ function countryNameToISO3(countryName) {
         if(regex.test(countryName.toLowerCase())) return iso3;
     }
 
-    console.warn('unrecognized country name: ' + countryName + '.');
+    Lib.warn('Unrecognized country name: ' + countryName + '.');
 }

src/lib/index.js

@@ -99,19 +99,36 @@ lib.pauseEvent = function(e) {
  * ------------------------------------------
  */
 
-// set VERBOSE to true to get a lot more logging and tracing
-lib.VERBOSE = false;
-// console.log that only runs if VERBOSE is on
+/* eslint-disable no-console */
 lib.log = function() {
-    if(lib.VERBOSE) console.log.apply(console, arguments);
     if(config.logging > 1) {
-        console.log.apply(console, arguments);
+        var messages = ['LOG:'];
+
+        for(var i = 0; i < arguments.length; i++) {
+            messages.push(arguments[i]);
+        }
+
+        if(console.trace) {
+            console.trace.apply(console, messages);
+        } else {
+            console.log.apply(console, messages);
+        }
     }
 };
 
 lib.warn = function() {
     if(config.logging > 0) {
-        console.warn.apply(console, arguments);
+        var messages = ['WARN:'];
+
+        for(var i = 0; i < arguments.length; i++) {
+            messages.push(arguments[i]);
+        }
+
+        if(console.trace) {
+            console.trace.apply(console, messages);
+        } else {
+            console.log.apply(console, messages);
+        }
     }
 };
 
@@ -120,6 +137,7 @@ lib.error = function() {
         console.error.apply(console, arguments);
     }
 };
+/* eslint-enable no-console */
 
 // constrain - restrict a number v to be between v0 and v1
 lib.constrain = function(v, v0, v1) {
@@ -432,7 +450,6 @@ lib.addStyleRule = function(selector, styleString) {
     else if(styleSheet.addRule) {
         styleSheet.addRule(selector, styleString, 0);
     }
-    else console.warn('addStyleRule failed');
     else lib.warn('addStyleRule failed');
 };
 

src/lib/search.js

@@ -11,6 +11,8 @@
 
 var isNumeric = require('fast-isnumeric');
 
+var Lib = require('../lib');
+
 
 /**
  * findBin - find the bin for val - note that it can return outside the
@@ -45,7 +47,7 @@ exports.findBin = function(val, bins, linelow) {
             if(test(bins[n], val)) n1 = n + 1;
             else n2 = n;
         }
-        if(c > 90) console.log('Long binary search...');
+        if(c > 90) Lib.log('Long binary search...');
         return n1 - 1;
     }
 };

src/lib/svg_text_utils.js

@@ -14,6 +14,7 @@
 var Plotly = require('../plotly');
 var d3 = require('d3');
 
+var Lib = require('../lib');
 var xmlnsNamespaces = require('../constants/xmlns_namespaces');
 
 var util = module.exports = {};
@@ -36,7 +37,7 @@ d3.selection.prototype.appendSVG = function(_svgString) {
         childNode = childNode.nextSibling;
     }
     if(dom.querySelector('parsererror')) {
-        console.log(dom.querySelector('parsererror div').textContent);
+        Lib.log(dom.querySelector('parsererror div').textContent);
         return null;
     }
     return d3.select(this.node().lastChild);
@@ -202,7 +203,7 @@ function texToSVG(_texString, _config, _callback) {
         var glyphDefs = d3.select('body').select('#MathJax_SVG_glyphs');
 
         if(tmpDiv.select('.MathJax_SVG').empty() || !tmpDiv.select('svg').node()) {
-            console.log('There was an error in the tex syntax.', _texString);
+            Lib.log('There was an error in the tex syntax.', _texString);
             _callback();
         }
         else {

src/plot_api/plot_api.js

@@ -63,7 +63,7 @@ Plotly.plot = function(gd, data, layout, config) {
     // if there's no data or layout, and this isn't yet a plotly plot
     // container, log a warning to help plotly.js users debug
     if(!data && !layout && !Lib.isPlotDiv(gd)) {
-        console.log('Warning: calling Plotly.plot as if redrawing ' +
+        Lib.warn('Calling Plotly.plot as if redrawing ' +
             'but this container doesn\'t yet have a plot.', gd);
     }
 
@@ -539,7 +539,7 @@ function cleanLayout(layout) {
     }
 
     if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
-        console.log('annotations must be an array');
+        Lib.warn('Annotations must be an array.');
         delete layout.annotations;
     }
     var annotationsLen = (layout.annotations || []).length;
@@ -561,7 +561,7 @@ function cleanLayout(layout) {
     }
 
     if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
-        console.log('shapes must be an array');
+        Lib.warn('Shapes must be an array.');
         delete layout.shapes;
     }
     var shapesLen = (layout.shapes || []).length;
@@ -785,9 +785,7 @@ function cleanData(data, existingData) {
 
         // sanitize rgb(fractions) and rgba(fractions) that old tinycolor
         // supported, but new tinycolor does not because they're not valid css
-        Lib.markTime('finished rest of cleanData, starting color');
         Color.clean(trace);
-        Lib.markTime('finished cleanData color.clean');
     }
 }
 
@@ -816,7 +814,7 @@ Plotly.redraw = function(gd) {
     gd = getGraphDiv(gd);
 
     if(!Lib.isPlotDiv(gd)) {
-        console.log('This element is not a Plotly Plot', gd);
+        Lib.warn('This element is not a Plotly plot.', gd);
         return;
     }
 
@@ -891,7 +889,6 @@ function doCalcdata(gd) {
         if(!cd[0].t) cd[0].t = {};
         cd[0].trace = trace;
 
-        Lib.markTime('done with calcdata for ' + i);
         calcdata[i] = cd;
     }
 }
@@ -1548,7 +1545,7 @@ Plotly.restyle = function restyle(gd, astr, val, traces) {
         if(traces === undefined) traces = val; // the 3-arg form
     }
     else {
-        console.log('restyle fail', astr, val, traces);
+        Lib.warn('Restyle fail.', astr, val, traces);
         return Promise.reject();
     }
 
@@ -2092,7 +2089,7 @@ Plotly.relayout = function relayout(gd, astr, val) {
     if(typeof astr === 'string') aobj[astr] = val;
     else if(Lib.isPlainObject(astr)) aobj = astr;
     else {
-        console.log('relayout fail', astr, val);
+        Lib.warn('Relayout fail.', astr, val);
         return Promise.reject();
     }
 
@@ -2283,7 +2280,7 @@ Plotly.relayout = function relayout(gd, astr, val) {
                     }
                     else undoit[ai] = obji;
                 }
-                else console.log('???', aobj);
+                else Lib.log('???', aobj);
             }
             if((refAutorange(obji, 'x') || refAutorange(obji, 'y')) &&
                     !Lib.containsAny(ai, ['color', 'opacity', 'align', 'dash'])) {

src/plot_api/plot_config.js

@@ -6,9 +6,10 @@
 * LICENSE file in the root directory of this source tree.
 */
 
-
 'use strict';
 
+var Lib = require('../lib');
+
 /**
  * This will be transfered over to gd and overridden by
  * config args to Plotly.plot.
@@ -83,8 +84,10 @@ module.exports = {
     setBackground: defaultSetBackground,
 
     // URL to topojson files used in geo charts
-    topojsonURL: 'https://cdn.plot.ly/'
+    topojsonURL: 'https://cdn.plot.ly/',
 
+    // Turn all console logging on or off (errors will be thrown)
+    logging: false
 };
 
 // where and how the background gets set can be overridden by context
@@ -93,5 +96,5 @@ function defaultSetBackground(gd, bgColor) {
     try {
         gd._fullLayout._paper.style('background', bgColor);
     }
-    catch(e) { console.log(e); }
+    catch(e) { Lib.error(e); }
 }

src/plots/cartesian/axes.js

@@ -1412,7 +1412,7 @@ axes.doTicks = function(gd, axid, skipTitle) {
         };
     }
     else {
-        console.log('unrecognized doTicks axis', axid);
+        Lib.warn('Unrecognized doTicks axis:', axid);
         return;
     }
     var axside = ax.side || sides[0],

src/plots/cartesian/clean_datum.js

@@ -30,7 +30,7 @@ module.exports = function cleanDatum(c) {
         c = c.toString().replace(/['"%,$# ]/g, '');
     }
     catch(e) {
-        console.log(e, c);
+        Lib.error(e, c);
     }
 
     return c;

src/plots/cartesian/dragbox.js

@@ -372,7 +372,7 @@ module.exports = function dragBox(gd, plotinfo, x, y, w, h, ns, ew) {
         var wheelDelta = -e.deltaY;
         if(!isFinite(wheelDelta)) wheelDelta = e.wheelDelta / 10;
         if(!isFinite(wheelDelta)) {
-            console.log('did not find wheel motion attributes', e);
+            Lib.log('Did not find wheel motion attributes: ', e);
             return;
         }
 

src/plots/cartesian/graph_interact.js

@@ -442,7 +442,7 @@ function hover(gd, evt, subplot) {
         else yvalArray = p2c(yaArray, ypx);
 
         if(!isNumeric(xvalArray[0]) || !isNumeric(yvalArray[0])) {
-            console.log('Plotly.Fx.hover failed', evt, gd);
+            Lib.warn('Plotly.Fx.hover failed', evt, gd);
             return dragElement.unhoverRaw(gd, evt);
         }
     }
@@ -529,7 +529,7 @@ function hover(gd, evt, subplot) {
             }
         }
         else {
-            console.log('unrecognized trace type in hover', trace);
+            Lib.log('Unrecognized trace type in hover:', trace);
         }
 
         // in closest mode, remove any existing (farther) points

src/plots/cartesian/index.js

@@ -9,7 +9,6 @@
 
 'use strict';
 
-var Lib = require('../../lib');
 var Plots = require('../plots');
 
 var constants = require('./constants');

src/plots/cartesian/set_convert.js

@@ -167,7 +167,7 @@ module.exports = function setConvert(ax) {
                     ax.range[1] = ar1[1];
                 }
             }
-            catch(e) { console.log(e, ax.range); }
+            catch(e) { Lib.error(e, ax.range); }
         }
     }
     else if(ax.type === 'category') {