Merge pull request #5498 from plotly/add-test-for-5411

Add a test for enabling validation in node.js

.circleci/config.yml

@@ -170,6 +170,12 @@ jobs:
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plotly.min.js
             echo https://$CIRCLE_BUILD_NUM-$PROJECT_NUM-gh.circle-artifacts.com/0/dist/plot-schema.json
+      - run:
+          name: Test validation using node.js and jsdom
+          command: npm run test-plain-obj
+      - run:
+          name: Test plotly.min.js import using requirejs
+          command: npm run test-requirejs
       - run:
           name: Test plotly bundles againt unexpected characters
           command: npm run no-bad-char
@@ -184,9 +190,6 @@ jobs:
           environment:
             NODE_OPTIONS: --max_old_space_size=4096
           command: npm run no-dup-keys
-      - run:
-          name: Test plotly.min.js import using requirejs
-          command: npm run test-requirejs
 
 workflows:
   version: 2

package.json

@@ -43,6 +43,7 @@
     "test-syntax": "node tasks/test_syntax.js && npm run find-strings -- --no-output",
     "test-bundle": "node tasks/test_bundle.js",
     "test-requirejs": "node tasks/test_requirejs.js",
+    "test-plain-obj": "node tasks/test_plain_obj.js",
     "test": "npm run test-jasmine -- --nowatch && npm run test-bundle && npm run test-image && npm run test-export && npm run test-syntax && npm run lint",
     "start-test_dashboard": "node devtools/test_dashboard/server.js",
     "start-image_viewer": "node devtools/image_viewer/server.js",

tasks/test_plain_obj.js

@@ -0,0 +1,33 @@
+var jsdom = require('jsdom');
+var fs = require('fs');
+
+var plotlyServerDom = new jsdom.JSDOM('', { runScripts: 'dangerously'});
+// Mock a few things that jsdom doesn't support out-of-the-box
+plotlyServerDom.window.URL.createObjectURL = function() {};
+
+// Run Plotly inside jsdom
+var plotlyJsPath = require.resolve('../dist/plotly.js');
+var plotlyJsSource = fs.readFileSync(plotlyJsPath, 'utf-8');
+plotlyServerDom.window.eval(plotlyJsSource);
+
+var assertValidate = function(fig, exp) {
+    console.log(fig);
+
+    var errorList = plotlyServerDom.window.Plotly.validate(fig.data, fig.layout);
+
+    if(exp) {
+        if(errorList !== undefined) throw 'should be valid:';
+    } else {
+        if(errorList === undefined) throw 'should not be valid:';
+    }
+};
+
+assertValidate({
+    data: [{ y: [1] }],
+    layout: {}
+}, true);
+
+assertValidate({
+    data: [{ z: false }],
+    layout: {}
+}, false);