Prevent crazy excessive warnings, just in case

Author: rreusser

src/plot_api/plot_api.js

@@ -2528,7 +2528,7 @@ Plotly.animate = function(gd, frameOrGroupNameOrFrameList, animationOpts) {
 Plotly.addFrames = function(gd, frameList, indices) {
     gd = helpers.getGraphDiv(gd);
 
-    var hasBeenWarnedAboutNumericNames = false;
+    var numericNameWarningCount = 0;
 
     if(frameList === null || frameList === undefined) {
         return Promise.resolve();
@@ -2563,8 +2563,20 @@ Plotly.addFrames = function(gd, frameList, indices) {
         var name = (_hash[frameList[i].name] || {}).name;
         var newName = frameList[i].name;
 
-        if (name && newName && typeof newName === 'number' && _hash[name]) {
-            Lib.warn('addFrames: overwriting frame "' + _hash[name].name + '" with a frame whose name of type "number" also equates to "' + name + '". This is valid but may potentially lead to unexpected behavior since all plotly.js frame names are stored internally as strings.');
+        if(name && newName && typeof newName === 'number' && _hash[name]) {
+            numericNameWarningCount++;
+
+            Lib.warn('addFrames: overwriting frame "' + _hash[name].name +
+                '" with a frame whose name of type "number" also equates to "' +
+                name + '". This is valid but may potentially lead to unexpected ' +
+                'behavior since all plotly.js frame names are stored internally ' +
+                'as strings.');
+
+            if(numericNameWarningCount > 5) {
+                Lib.warn('addFrames: This API call has yielded too many warnings. ' +
+                    'For the rest of this call, further warnings about numeric frame ' +
+                    'names will be suppressed.');
+            }
         }
 
         insertions.push({
@@ -2587,7 +2599,7 @@ Plotly.addFrames = function(gd, frameList, indices) {
     for(i = insertions.length - 1; i >= 0; i--) {
         frame = insertions[i].frame;
 
-        if (typeof frame.name === 'number') {
+        if(typeof frame.name === 'number') {
             Lib.warn('Warning: addFrames accepts frames with numeric names, but the numbers are' +
                 'implicitly cast to strings');
 

src/plots/plots.js

@@ -1484,8 +1484,8 @@ plots.computeFrame = function(gd, frameName) {
     // properly cast to strings. We really just want to ensure here that this
     // 1) doesn't fail, and
     // 2) doens't give an incorrect answer (which String(frameName) would)
-    if (!frameName) {
-        throw new Error('computeFrame must be given a string frame name')
+    if(!frameName) {
+        throw new Error('computeFrame must be given a string frame name');
     }
 
     var framePtr = frameLookup[frameName.toString()];

test/jasmine/tests/frame_api_test.js

@@ -74,36 +74,36 @@ describe('Test frame api', function() {
         });
 
         it('creates multiple unnamed frames in series', function(done) {
-            Plotly.addFrames(gd, [{}]).then(function () {
-                return Plotly.addFrames(gd, [{}])
+            Plotly.addFrames(gd, [{}]).then(function() {
+                return Plotly.addFrames(gd, [{}]);
             }).then(function() {
                 expect(f).toEqual([{name: 'frame 0'}, {name: 'frame 1'}]);
             }).catch(fail).then(done);
         });
 
-        it('casts number names to strings on insertion', function (done) {
-            Plotly.addFrames(gd, [{name: 2}]).then(function () {
+        it('casts number names to strings on insertion', function(done) {
+            Plotly.addFrames(gd, [{name: 2}]).then(function() {
                 expect(f).toEqual([{name: '2'}]);
             }).catch(fail).then(done);
         });
 
-        it('updates frames referenced by number', function (done) {
-            Plotly.addFrames(gd, [{name: 2}]).then(function () {
+        it('updates frames referenced by number', function(done) {
+            Plotly.addFrames(gd, [{name: 2}]).then(function() {
                 return Plotly.addFrames(gd, [{name: 2, layout: {foo: 'bar'}}]);
-            }).then(function () {
+            }).then(function() {
                 expect(f).toEqual([{name: '2', layout: {foo: 'bar'}}]);
             }).catch(fail).then(done);
         });
 
-        it('issues a warning if a number-named frame would overwrite a frame', function (done) {
+        it('issues a warning if a number-named frame would overwrite a frame', function(done) {
             var warnings = [];
-            spyOn(Lib, 'warn').and.callFake(function (msg){
+            spyOn(Lib, 'warn').and.callFake(function(msg) {
                 warnings.push(msg);
             });
 
-            Plotly.addFrames(gd, [{name: 2}]).then(function () {
+            Plotly.addFrames(gd, [{name: 2}]).then(function() {
                 return Plotly.addFrames(gd, [{name: 2, layout: {foo: 'bar'}}]);
-            }).then(function () {
+            }).then(function() {
                 expect(warnings.length).toEqual(1);
                 expect(warnings[0]).toMatch(/overwriting/);
             }).catch(fail).then(done);