validate: improve isLinkedToArray validation

etpinard · etpinard · commit e7391d5c7874 · 2016-08-03T19:12:37.000-04:00
- make sure that invalid and skipped-over containers
  lead to validation errors.
- make sure to track the input index to match schema/value
  with the correct input container
diff --git a/src/plot_api/validate.js b/src/plot_api/validate.js
@@ -173,15 +173,37 @@ function crawl(objIn, objOut, schema, list, base, path) {
             crawl(valIn, valOut, nestedSchema, list, base, p);
         }
         else if(nestedSchema.items && !isInfoArray && isArray(valIn)) {
-            var itemName = k.substr(0, k.length - 1);
+            var itemName = k.substr(0, k.length - 1),
+                indexList = [];
 
-            for(var j = 0; j < valIn.length; j++) {
+            var j, _p;
+
+            // loop over valOut items while keeping track of their
+            // corresponding input container index (given by _index)
+            for(j = 0; j < valOut.length; j++) {
                 var _nestedSchema = nestedSchema.items[itemName],
-                    _p = p.slice();
+                    _index = valOut[j]._index || j;
+
+                _p = p.slice();
+                _p.push(_index);
 
+                if(isPlainObject(valIn[_index]) && isPlainObject(valOut[j])) {
+                    indexList.push(_index);
+                    crawl(valIn[_index], valOut[j], _nestedSchema, list, base, _p);
+                }
+            }
+
+            // loop over valIn to determine where it went wrong for some items
+            for(j = 0; j < valIn.length; j++) {
+                _p = p.slice();
                 _p.push(j);
 
-                crawl(valIn[j], valOut[j], _nestedSchema, list, base, _p);
+                if(!isPlainObject(valIn[j])) {
+                    list.push(format('object', base, _p, valIn[j]));
+                }
+                else if(indexList.indexOf(j) === -1) {
+                    list.push(format('unused', base, _p));
+                }
             }
         }
         else if(!isPlainObject(valIn) && isPlainObject(valOut)) {
diff --git a/test/jasmine/tests/validate_test.js b/test/jasmine/tests/validate_test.js
@@ -169,7 +169,7 @@ describe('Plotly.validate', function() {
                         label: '1 month',
                         step: 'all',
                         count: 10
-                    }, {
+                    }, 'wont-work', {
                         title: '1 month'
                     }]
                 }
@@ -190,10 +190,25 @@ describe('Plotly.validate', function() {
             },
             shapes: [{
                 opacity: 'none'
+            }],
+            updatemenus: [{
+                buttons: [{
+                    method: 'restyle',
+                    args: ['marker.color', 'red']
+                }]
+            }, 'wont-work', {
+                buttons: [{
+                    method: 'restyle',
+                    args: null
+                }, {
+                    method: 'relayout',
+                    args: ['marker.color', 'red'],
+                    title: 'not-gonna-work'
+                }, 'wont-work']
             }]
         });
 
-        expect(out.length).toEqual(7);
+        expect(out.length).toEqual(12);
         assertErrorContent(
             out[0], 'schema', 'layout', null,
             ['annotations', 1, 'arrowSymbol'], 'annotations[1].arrowSymbol',
@@ -212,27 +227,48 @@ describe('Plotly.validate', function() {
         );
         assertErrorContent(
             out[3], 'schema', 'layout', null,
-            ['xaxis', 'rangeselector', 'buttons', 1, 'title'],
-            'xaxis.rangeselector.buttons[1].title',
-            'In layout, key xaxis.rangeselector.buttons[1].title is not part of the schema'
+            ['xaxis', 'rangeselector', 'buttons', 2, 'title'],
+            'xaxis.rangeselector.buttons[2].title',
+            'In layout, key xaxis.rangeselector.buttons[2].title is not part of the schema'
         );
         assertErrorContent(
-            out[4], 'schema', 'layout', null,
+            out[4], 'object', 'layout', null,
+            ['xaxis', 'rangeselector', 'buttons', 1],
+            'xaxis.rangeselector.buttons[1]',
+            'In layout, key xaxis.rangeselector.buttons[1] must be linked to an object container'
+        );
+        assertErrorContent(
+            out[5], 'schema', 'layout', null,
             ['xaxis2', 'rangeselector', 'buttons', 0, 'title'],
             'xaxis2.rangeselector.buttons[0].title',
             'In layout, key xaxis2.rangeselector.buttons[0].title is not part of the schema'
         );
         assertErrorContent(
-            out[5], 'array', 'layout', null,
+            out[6], 'array', 'layout', null,
             ['xaxis3', 'rangeselector', 'buttons'],
             'xaxis3.rangeselector.buttons',
             'In layout, key xaxis3.rangeselector.buttons must be linked to an array container'
         );
         assertErrorContent(
-            out[6], 'value', 'layout', null,
+            out[7], 'value', 'layout', null,
             ['shapes', 0, 'opacity'], 'shapes[0].opacity',
             'In layout, key shapes[0].opacity is set to an invalid value (none)'
         );
+        assertErrorContent(
+            out[8], 'schema', 'layout', null,
+            ['updatemenus', 2, 'buttons', 1, 'title'], 'updatemenus[2].buttons[1].title',
+            'In layout, key updatemenus[2].buttons[1].title is not part of the schema'
+        );
+        assertErrorContent(
+            out[9], 'unused', 'layout', null,
+            ['updatemenus', 2, 'buttons', 0], 'updatemenus[2].buttons[0]',
+            'In layout, key updatemenus[2].buttons[0] did not get coerced'
+        );
+        assertErrorContent(
+            out[10], 'object', 'layout', null,
+            ['updatemenus', 2, 'buttons', 2], 'updatemenus[2].buttons[2]',
+            'In layout, key updatemenus[2].buttons[2] must be linked to an object container'
+        );
     });
 
     it('should work with isSubplotObj attributes', function() {
