add support for transform in plot schema and Plotly.validate

Author: etpinard

src/plot_api/plot_schema.js

@@ -29,6 +29,7 @@ var UNDERSCORE_ATTRS = [IS_SUBPLOT_OBJ, IS_LINKED_TO_ARRAY, DEPRECATED];
 var plotSchema = {
     traces: {},
     layout: {},
+    transforms: {},
     defs: {}
 };
 
@@ -45,7 +46,11 @@ PlotSchema.get = function() {
         .forEach(getTraceAttributes);
 
     getLayoutAttributes();
+
+    Object.keys(Plots.transformsRegistry).forEach(getTransformAttributes);
+
     getDefs();
+
     return plotSchema;
 };
 
@@ -136,6 +141,18 @@ function getLayoutAttributes() {
     plotSchema.layout = { layoutAttributes: layoutAttributes };
 }
 
+function getTransformAttributes(name) {
+    var _module = Plots.transformsRegistry[name],
+        _schema = {};
+
+    _schema = coupleAttrs(_schema, _module.attributes || {}, 'attributes', '*');
+    _schema = removeUnderscoreAttrs(_schema);
+    mergeValTypeAndRole(_schema);
+    handleLinkedToArray(_schema);
+
+    plotSchema.transforms[name] = { attributes: _schema };
+}
+
 function getDefs() {
     plotSchema.defs = {
         valObjects: Lib.valObjects,

src/plot_api/validate.js

@@ -102,6 +102,39 @@ module.exports = function valiate(data, layout) {
         }
 
         crawl(traceIn, traceOut, traceSchema, errorList, base);
+
+        var transformsIn = traceIn.transforms,
+            transformsOut = traceOut.transforms;
+
+        if(transformsIn) {
+            if(!isArray(transformsIn)) {
+                errorList.push(format('array', base, ['transforms']));
+            }
+
+            base.push('transforms');
+
+            for(var j = 0; j < transformsIn.length; j++) {
+                var path = ['transforms', j],
+                    transformType = transformsIn[j].type;
+
+                if(!isPlainObject(transformsIn[j])) {
+                    errorList.push(format('object', base, path));
+                    continue;
+                }
+
+                var transformSchema = schema.transforms[transformType] ?
+                    schema.transforms[transformType].attributes :
+                    {};
+
+                // add 'type' to transform schema to validate the transform type
+                transformSchema.type = {
+                    valType: 'enumerated',
+                    values: Object.keys(schema.transforms)
+                };
+
+                crawl(transformsIn[j], transformsOut[j], transformSchema, errorList, base, path);
+            }
+        }
     }
 
     var layoutOut = gd._fullLayout,
@@ -121,6 +154,9 @@ function crawl(objIn, objOut, schema, list, base, path) {
     for(var i = 0; i < keys.length; i++) {
         var k = keys[i];
 
+        // transforms are handled separately
+        if(k === 'transforms') continue;
+
         var p = path.slice();
         p.push(k);
 
@@ -184,7 +220,7 @@ var code2msgFunc = {
         var prefix;
 
         if(base === 'layout' && astr === '') prefix = 'The layout argument';
-        else if(base[0] === 'data') {
+        else if(base[0] === 'data' && astr === '') {
             prefix = 'Trace ' + base[1] + ' in the data argument';
         }
         else prefix = inBase(base) + 'key ' + astr;

test/jasmine/tests/plotschema_test.js

@@ -1,10 +1,13 @@
 var Plotly = require('@lib/index');
 var Lib = require('@src/lib');
 
-// until it is part of the main plotly.js bundle
-Plotly.register(
-    require('@lib/scattermapbox')
-);
+Plotly.register([
+    // until it is part of the main plotly.js bundle
+    require('@lib/scattermapbox'),
+
+    // until they become official
+    require('@assets/transforms/filter')
+]);
 
 describe('plot schema', function() {
     'use strict';
@@ -180,4 +183,10 @@ describe('plot schema', function() {
         );
     });
 
+    it('should work with registered transforms', function() {
+        var valObjects = plotSchema.transforms.filter.attributes,
+            attrNames = Object.keys(valObjects);
+
+        expect(attrNames).toEqual(['operation', 'value', 'filtersrc']);
+    });
 });

test/jasmine/tests/validate_test.js

@@ -1,4 +1,10 @@
 var Plotly = require('@lib/index');
+var Lib = require('@src/lib');
+
+Plotly.register([
+    // until they become official
+    require('@assets/transforms/filter')
+]);
 
 
 describe('Plotly.validate', function() {
@@ -248,4 +254,68 @@ describe('Plotly.validate', function() {
             'In layout, key yaxis5 must be linked to an object container'
         );
     });
+
+    it('should work with attributes in registered transforms', function() {
+        var base = {
+            x: [-2, -1, -2, 0, 1, 2, 3],
+            y: [1, 2, 3, 1, 2, 3, 1],
+        };
+
+        var out = Plotly.validate([
+            Lib.extendFlat({}, base, {
+                transforms: [{
+                    type: 'filter',
+                    operation: '='
+                }, {
+                    type: 'filter',
+                    operation: '=',
+                    wrongKey: 'sup?'
+                }, {
+                    type: 'filter',
+                    operation: 'wrongVal'
+                },
+                    'wont-work'
+                ]
+            }),
+            Lib.extendFlat({}, base, {
+                transforms: {
+                    type: 'filter'
+                }
+            }),
+            Lib.extendFlat({}, base, {
+                transforms: [{
+                    type: 'no gonna work'
+                }]
+            }),
+        ], {
+            title: 'my transformed graph'
+        });
+
+        expect(out.length).toEqual(5);
+        assertErrorContent(
+            out[0], 'schema', 'data', 0,
+            ['transforms', 1, 'wrongKey'], 'transforms[1].wrongKey',
+            'In data trace 0, key transforms[1].wrongKey is not part of the schema'
+        );
+        assertErrorContent(
+            out[1], 'value', 'data', 0,
+            ['transforms', 2, 'operation'], 'transforms[2].operation',
+            'In data trace 0, key transforms[2].operation is set to an invalid value (wrongVal)'
+        );
+        assertErrorContent(
+            out[2], 'object', 'data', 0,
+            ['transforms', 3], 'transforms[3]',
+            'In data trace 0, key transforms[3] must be linked to an object container'
+        );
+        assertErrorContent(
+            out[3], 'array', 'data', 1,
+            ['transforms'], 'transforms',
+            'In data trace 1, key transforms must be linked to an array container'
+        );
+        assertErrorContent(
+            out[4], 'value', 'data', 2,
+            ['transforms', 0, 'type'], 'transforms[0].type',
+            'In data trace 2, key transforms[0].type is set to an invalid value (no gonna work)'
+        );
+    });
 });