Fixed invalid Promise syntax in Plotly.relayout

Tom Chandler · Tom Chandler · commit a6ddc7358a2c · 2016-01-29T17:54:44.000-05:00
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -2095,7 +2095,7 @@ Plotly.relayout = function relayout(gd, astr, val) {
     gd = getGraphDiv(gd);
 
     if(gd.framework && gd.framework.isPolar) {
-        return new Promise.resolve(gd);
+        return Promise.resolve(gd);
     }
 
     var layout = gd.layout,
@@ -2113,7 +2113,7 @@ Plotly.relayout = function relayout(gd, astr, val) {
     else if(Lib.isPlainObject(astr)) aobj = astr;
     else {
         console.log('relayout fail',astr,val);
-        return new Promise.reject();
+        return Promise.reject();
     }
 
     if(Object.keys(aobj).length) gd.changed = true;
diff --git a/test/jasmine/tests/plot_promise_test.js b/test/jasmine/tests/plot_promise_test.js
@@ -361,11 +361,12 @@ describe('Plotly.___ methods', function() {
 
         beforeEach(function(done) {
             var data = [{ x: [1,2,3], y: [4,5,6] }],
+                layout = {hovermode:'closest'},
                 initialDiv = createGraphDiv();
 
-            Plotly.plot(initialDiv, data, {});
+            Plotly.plot(initialDiv, data, layout);
 
-            promise = Plotly.restyle(initialDiv, 'title', 'Promise test!');
+            promise = Plotly.relayout(initialDiv, 'hovermode', false);
 
             promise.then(function(gd){
                 promiseGd = gd;
@@ -382,4 +383,85 @@ describe('Plotly.___ methods', function() {
         });
     });
 
+    describe('Plotly.relayout promise', function() {
+        var promise,
+            promiseGd;
+
+        beforeEach(function(done) {
+            var data = [{ x: [1,2,3], y: [4,5,6] }],
+                layout = {hovermode:'closest'},
+                initialDiv = createGraphDiv();
+
+            Plotly.plot(initialDiv, data, layout);
+
+            promise = Plotly.relayout(initialDiv, 'hovermode', false);
+
+            promise.then(function(gd){
+                promiseGd = gd;
+                done();
+            });
+        });
+        afterEach(destroyGraphDiv);
+
+        it('should be returned with the graph div as an argument', function() {
+            expect(promiseGd).toBeDefined();
+            expect(typeof promiseGd).toBe('object');
+            expect(promiseGd.data).toBeDefined();
+            expect(promiseGd.layout).toBeDefined();
+        });
+    });
+
+    describe('Plotly.relayout promise', function() {
+        var promise,
+            promiseGd;
+
+        beforeEach(function(done) {
+            var data = [{ x: [1,2,3], y: [4,5,6] }],
+                layout = {hovermode:'closest'},
+                initialDiv = createGraphDiv();
+
+            Plotly.plot(initialDiv, data, layout);
+
+            initialDiv.framework = { isPolar: true };
+            promise = Plotly.relayout(initialDiv, 'hovermode', false);
+
+            promise.then(function(gd){
+                promiseGd = gd;
+                done();
+            });
+        });
+        afterEach(destroyGraphDiv);
+
+        it('should be returned with the graph div unchanged when the framework is polar', function() {
+            expect(promiseGd).toBeDefined();
+            expect(typeof promiseGd).toBe('object');
+            expect(promiseGd.changed).toBeFalsy();
+        });
+    });
+
+    describe('Plotly.relayout promise', function() {
+        var promise,
+            promiseRejected = false;
+
+        beforeEach(function(done) {
+            var data = [{ x: [1,2,3], y: [4,5,6] }],
+                layout = {hovermode:'closest'},
+                initialDiv = createGraphDiv();
+
+            Plotly.plot(initialDiv, data, layout);
+
+            promise = Plotly.relayout(initialDiv, undefined, false);
+
+            promise.then(null, function(){
+                promiseRejected = true;
+                done();
+            });
+        });
+        afterEach(destroyGraphDiv);
+
+        it('should be rejected when the attribute is missing', function() {
+            expect(promiseRejected).toBe(true);
+        });
+    });
+
 });

Original file line number	Diff line number	Diff line change
`@@ -2095,7 +2095,7 @@ Plotly.relayout = function relayout(gd, astr, val) {`
`2095`	`2095`	`gd = getGraphDiv(gd);`
`2096`	`2096`
`2097`	`2097`	`if(gd.framework && gd.framework.isPolar) {`
`2098`		`- return new Promise.resolve(gd);`
	`2098`	`+ return Promise.resolve(gd);`
`2099`	`2099`	`}`
`2100`	`2100`
`2101`	`2101`	`var layout = gd.layout,`
`@@ -2113,7 +2113,7 @@ Plotly.relayout = function relayout(gd, astr, val) {`
`2113`	`2113`	`else if(Lib.isPlainObject(astr)) aobj = astr;`
`2114`	`2114`	`else {`
`2115`	`2115`	`console.log('relayout fail',astr,val);`
`2116`		`- return new Promise.reject();`
	`2116`	`+ return Promise.reject();`
`2117`	`2117`	`}`
`2118`	`2118`
`2119`	`2119`	`if(Object.keys(aobj).length) gd.changed = true;`