plot_promise_test.js

var Plotly = require('@lib/index');
var Events = require('@src/lib/events');
var createGraphDiv = require('../assets/create_graph_div');
var destroyGraphDiv = require('../assets/destroy_graph_div');


describe('Plotly.___ methods', function() {
    'use strict';

    afterEach(destroyGraphDiv);

    describe('Plotly.plot promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];

            promise = Plotly.plot(createGraphDiv(), data, {});

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.plot promise', function() {
        var gd;
        var promise;
        var promiseRejected = false;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];

            gd = createGraphDiv();

            Events.init(gd);

            gd.on('plotly_beforeplot', function() {
                return false;
            });

            promise = Plotly.plot(gd, data, {});

            promise.then(null, function() {
                promiseRejected = true;
                done();
            });
        });


        it('should be rejected when plotly_beforeplot event handlers return false', function() {
            expect(promiseRejected).toBe(true);
        });
    });

    describe('Plotly.redraw promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.redraw(initialDiv);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.newPlot promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];

            promise = Plotly.newPlot(createGraphDiv(), data, {});

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.extendTraces promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.extendTraces(initialDiv, { y: [[2]] }, [0], 3);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.prependTraces promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.prependTraces(initialDiv, { y: [[2]] }, [0], 3);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.addTraces promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.addTraces(initialDiv, [{ x: [1, 2, 3], y: [1, 2, 3] }], [1]);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.deleteTraces promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.deleteTraces(initialDiv, [0]);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.deleteTraces promise', function() {
        var promise,
            promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.deleteTraces(initialDiv, [0]);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.moveTraces promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [
                { x: [1, 2, 3], y: [4, 5, 6] },
                { x: [1, 2, 3], y: [6, 5, 4] }
            ];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.moveTraces(initialDiv, 0, 1);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.restyle promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.restyle(initialDiv, 'marker.color', 'rgb(255,0,0)');

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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.restyle promise', function() {
        var promise;
        var promiseRejected = false;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {});

            promise = Plotly.restyle(initialDiv, undefined, '');

            promise.then(null, function() {
                promiseRejected = true;
                done();
            });
        });

        it('should be rejected when the attribute is missing', function() {
            expect(promiseRejected).toBe(true);
        });
    });

    describe('Plotly.relayout promise', function() {
        var promise;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var layout = {hovermode: 'closest'};
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, layout);

            promise = Plotly.relayout(initialDiv, 'hovermode', false);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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;
        var promiseGd;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var layout = {hovermode: 'closest'};
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, layout);

            promise = Plotly.relayout(initialDiv, 'hovermode', false);

            promise.then(function(gd) {
                promiseGd = gd;
                done();
            });
        });

        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;
        var promiseRejected = false;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];
            var layout = {hovermode: 'closest'};
            var initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, layout);

            promise = Plotly.relayout(initialDiv, undefined, false);

            promise.then(null, function() {
                promiseRejected = true;
                done();
            });
        });

        it('should be rejected when the attribute is missing', function() {
            expect(promiseRejected).toBe(true);
        });
    });

    describe('Plotly.Plots.resize promise', function() {
        var initialDiv;

        beforeEach(function(done) {
            var data = [{ x: [1, 2, 3], y: [4, 5, 6] }];

            initialDiv = createGraphDiv();

            Plotly.newPlot(initialDiv, data, {}).then(done);
        });

        afterEach(destroyGraphDiv);

        it('should return a resolved promise of the gd', function(done) {
            Plotly.Plots.resize(initialDiv).then(function(gd) {
                expect(gd).toBeDefined();
                expect(typeof gd).toBe('object');
                expect(gd.layout).toBeDefined();
            })
            .then(done, done.fail);
        });

        it('should return a rejected promise if gd is hidden', function(done) {
            initialDiv.style.display = 'none';
            Plotly.Plots.resize(initialDiv).then(function() {
                expect(1).toBe(0, 'We were supposed to get an error.');
            }, function(err) {
                expect(err).toBeDefined();
                expect(err.message).toBe('Resize must be passed a displayed plot div element.');
            })
            .then(done, done.fail);
        });

        it('should return a rejected promise if gd is detached from the DOM', function(done) {
            destroyGraphDiv();
            Plotly.Plots.resize(initialDiv).then(function() {
                expect(1).toBe(0, 'We were supposed to get an error.');
            }, function(err) {
                expect(err).toBeDefined();
                expect(err.message).toBe('Resize must be passed a displayed plot div element.');
            })
            .then(done, done.fail);
        });

        it('should return a resolved promise if plot has been purged and there is nothing to resize', function(done) {
            var resizePromise = Plotly.Plots.resize(initialDiv);

            Plotly.purge(initialDiv);
            destroyGraphDiv();

            resizePromise
                .then(done, done.fail);
        });

        it('should return a resolved promise if plot has been hidden and gd is hidden', function(done) {
            var resizePromise = Plotly.Plots.resize(initialDiv);

            initialDiv.style.display = 'none';

            resizePromise
                .then(done, done.fail);
        });

        it('errors before even generating a promise if gd is not defined', function() {
            expect(function() { Plotly.Plots.resize(); })
                .toThrow(new Error('DOM element provided is null or undefined'));
        });
    });
});