improve tests

collab-project · Apr 24, 2018 · 81dacec · 81dacec
1 parent 58c3524
commit 81dacec
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 80 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,6 +1,14 @@
 videojs-wavesurfer changelog
 ============================
 
+2.3.1 - unreleased
+------------------
+
+- Make sure plugin is only registered once
+- Add `isDestroyed` method
+- Add more tests
+
+
 2.3.0 - 2018/04/16
 ------------------
 

diff --git a/karma.conf.js b/karma.conf.js
@@ -10,7 +10,10 @@ var webpackConfig = require('./build-config/webpack.prod.main.js');
 
 var chromeFlags = [
     '--no-sandbox',
-    '--use-fake-ui-for-media-stream'
+    '--use-fake-device-for-media-stream',
+    '--use-fake-ui-for-media-stream',
+    '--use-file-for-fake-audio-capture=test/support/demo.wav',
+    '--autoplay-policy=no-user-gesture-required'
 ];
 
 module.exports = function(config) {
@@ -20,7 +23,7 @@ module.exports = function(config) {
         hostname: 'localhost',
         port: 9876,
         logLevel: config.LOG_INFO,
-        singleRun: true,  // enable for headless testing
+        singleRun: true,
         autoWatch: false,
         files: [
             // demo files

diff --git a/src/js/videojs.wavesurfer.js b/src/js/videojs.wavesurfer.js
@@ -357,7 +357,9 @@ class Wavesurfer extends Plugin {
      */
     pause() {
         // show play button
-        this.player.controlBar.playToggle.handlePause();
+        if (this.player.controlBar.playToggle.contentEl()) {
+            this.player.controlBar.playToggle.handlePause();
+        }
 
         if (this.liveMode) {
             // pause microphone visualization
@@ -394,6 +396,15 @@ class Wavesurfer extends Plugin {
         this.log('Destroyed plugin');
     }
 
+    /**
+     * Indicates whether the plugin is destroyed or not.
+     *
+     * @return {boolean} Plugin destroyed or not.
+     */
+    isDestroyed() {
+        return this.player && (this.player.children() === null);
+    }
+
     /**
      * Remove the player and waveform.
      */
@@ -486,9 +497,11 @@ class Wavesurfer extends Plugin {
         let time = Math.min(currentTime, duration);
 
         // update current time display component
-        this.player.controlBar.currentTimeDisplay.formattedTime_ =
-            this.player.controlBar.currentTimeDisplay.contentEl().lastChild.textContent =
-                formatTime(time, duration, this.msDisplayMax);
+        if (this.player.controlBar.currentTimeDisplay.contentEl()) {
+            this.player.controlBar.currentTimeDisplay.formattedTime_ =
+                this.player.controlBar.currentTimeDisplay.contentEl().lastChild.textContent =
+                    formatTime(time, duration, this.msDisplayMax);
+        }
     }
 
     /**
@@ -516,9 +529,11 @@ class Wavesurfer extends Plugin {
         duration = isNaN(duration) ? 0 : duration;
 
         // update duration display component
-        this.player.controlBar.durationDisplay.formattedTime_ =
-            this.player.controlBar.durationDisplay.contentEl().lastChild.textContent =
-                formatTime(duration, duration, this.msDisplayMax);
+        if (this.player.controlBar.durationDisplay.contentEl()) {
+            this.player.controlBar.durationDisplay.formattedTime_ =
+                this.player.controlBar.durationDisplay.contentEl().lastChild.textContent =
+                    formatTime(duration, duration, this.msDisplayMax);
+        }
     }
 
     /**
@@ -540,10 +555,14 @@ class Wavesurfer extends Plugin {
         this.setDuration();
 
         // enable and show play button
-        this.player.controlBar.playToggle.show();
+        if (this.player.controlBar.playToggle.contentEl()) {
+            this.player.controlBar.playToggle.show();
+        }
 
         // hide loading spinner
-        this.player.loadingSpinner.hide();
+        if (this.player.loadingSpinner.contentEl()) {
+            this.player.loadingSpinner.hide();
+        }
 
         // auto-play when ready (if enabled)
         if (this.player.options_.autoplay === true) {
@@ -702,30 +721,34 @@ class Wavesurfer extends Plugin {
      * @private
      */
     redrawWaveform(newWidth, newHeight) {
-        let rect = this.player.el_.getBoundingClientRect();
-        if (newWidth === undefined) {
-            // get player width
-            newWidth = rect.width;
-        }
-        if (newHeight === undefined) {
-            // get player height
-            newHeight = rect.height;
-        }
+        if (!this.isDestroyed()) {
+            if (this.player.el_) {
+                let rect = this.player.el_.getBoundingClientRect();
+                if (newWidth === undefined) {
+                    // get player width
+                    newWidth = rect.width;
+                }
+                if (newHeight === undefined) {
+                    // get player height
+                    newHeight = rect.height;
+                }
+            }
 
-        // destroy old drawing
-        this.surfer.drawer.destroy();
+            // destroy old drawing
+            this.surfer.drawer.destroy();
 
-        // set new dimensions
-        this.surfer.params.width = newWidth;
-        this.surfer.params.height = newHeight - this.player.controlBar.height();
+            // set new dimensions
+            this.surfer.params.width = newWidth;
+            this.surfer.params.height = newHeight - this.player.controlBar.height();
 
-        // redraw waveform
-        this.surfer.createDrawer();
-        this.surfer.drawer.wrapper.className = wavesurferClassName;
-        this.surfer.drawBuffer();
+            // redraw waveform
+            this.surfer.createDrawer();
+            this.surfer.drawer.wrapper.className = wavesurferClassName;
+            this.surfer.drawBuffer();
 
-        // make sure playhead is restored at right position
-        this.surfer.drawer.progress(this.surfer.backend.getPlayedPercents());
+            // make sure playhead is restored at right position
+            this.surfer.drawer.progress(this.surfer.backend.getPlayedPercents());
+        }
     }
 
     /**
@@ -739,9 +762,11 @@ class Wavesurfer extends Plugin {
 // version nr is injected during build
 Wavesurfer.VERSION = __VERSION__;
 
-// register plugin
+// register plugin once
 videojs.Wavesurfer = Wavesurfer;
-videojs.registerPlugin('wavesurfer', Wavesurfer);
+if (videojs.getPlugin('wavesurfer') === undefined) {
+    videojs.registerPlugin('wavesurfer', Wavesurfer);
+}
 
 // register the WavesurferTech as 'Html5' to override the default html5 tech.
 // If we register it as anything other then 'Html5', the <audio> element will

diff --git a/test/fluid.spec.js b/test/fluid.spec.js
@@ -6,15 +6,11 @@ import window from 'global/window';
 
 import TestHelpers from './test-helpers.js';
 
-
 /** @test {Wavesurfer} */
 describe('Wavesurfer Fluid', function() {
     var player;
 
     beforeEach(function() {
-        // cleanup all players
-        TestHelpers.cleanup();
-
         // create new player
         let options = {
             controls: true,
@@ -32,13 +28,20 @@ describe('Wavesurfer Fluid', function() {
                 }
             }
         };
-        player = TestHelpers.makePlayer(undefined, options);
+        var tag = TestHelpers.makeTag('audio', 'fluidAudio');
+        player = TestHelpers.makePlayer(tag, options);
+    });
+
+    afterEach(function() {
+        // delete player
+        player.dispose();
     });
 
     /** @test {Wavesurfer#redrawWaveform} */
     it('should redraw waveform', function(done) {
         player.one('waveReady', function() {
             player.wavesurfer().redrawWaveform(100, 200);
+
             done();
         });
     });

diff --git a/test/live.spec.js b/test/live.spec.js
@@ -4,40 +4,17 @@
 
 import TestHelpers from './test-helpers.js';
 
-
 /** @test {Wavesurfer} */
 describe('Wavesurfer Live', function() {
     var player;
 
     beforeEach(function() {
-        // cleanup all players
-        TestHelpers.cleanup();
-
-        // create new player
-        let options = {
-            controls: true,
-            fluid: false,
-            width: 600,
-            height: 300,
-            controlBar: {
-                currentTimeDisplay: false,
-                timeDivider: false,
-                durationDisplay: false,
-                remainingTimeDisplay: false,
-                volumePanel: false
-            },
-            plugins: {
-                wavesurfer: {
-                    src: 'live',
-                    waveColor: 'black',
-                    debug: false,
-                    cursorWidth: 0,
-                    interact: false,
-                    hideScrollbar: true
-                }
-            }
-        };
-        player = TestHelpers.makePlayer(undefined, options);
+        player = TestHelpers.makeLivePlayer();
+    });
+
+    afterEach(function() {
+        // delete player
+        player.dispose();
     });
 
     /** @test {Wavesurfer} */
@@ -46,11 +23,11 @@ describe('Wavesurfer Live', function() {
             // trigger click event on playToggle button to start mic
             TestHelpers.triggerDomEvent(player.controlBar.playToggle.el(), 'click');
 
-            player.wavesurfer().pause();
-            player.wavesurfer().play();
-            player.wavesurfer().play();
+            player.wavesurfer().play()
+            player.wavesurfer().pause()
 
-            done();
+            // mic is active for a while
+            setTimeout(done, 1000);
         });
     });
 

diff --git a/test/tech.spec.js b/test/tech.spec.js
@@ -10,9 +10,6 @@ describe('WavesurferTech', function() {
     var player;
 
     beforeEach(function() {
-        // cleanup all players
-        TestHelpers.cleanup();
-
         // create audio element with text track
         const tag = TestHelpers.makeTag('audio', 'myAudioTextTracks');
         const track = document.createElement('track');
@@ -26,6 +23,11 @@ describe('WavesurferTech', function() {
         player = TestHelpers.makePlayer(tag);
     });
 
+    afterEach(function() {
+        // delete player
+        player.dispose();
+    });
+
     /** @test {WavesurferTech} */
     it('should display interface elements', function(done) {
 
@@ -91,7 +93,7 @@ describe('WavesurferTech', function() {
         });
     });
 
-    /** @test {WavesurferTech#duration} */
+    /** @test {WavesurferTech#waveready} */
     it('should play and pause', function(done) {
 
         player.one('waveReady', function() {

diff --git a/test/test-helpers.js b/test/test-helpers.js
@@ -70,6 +70,28 @@ const TestHelpers = {
         return videojs(elementTag.id, playerOptions);
     },
 
+    makeLivePlayer() {
+        var tag = TestHelpers.makeTag('audio', 'liveAudio');
+        return this.makePlayer(tag, {
+            controls: true,
+            autoplay: false,
+            fluid: false,
+            loop: false,
+            width: 600,
+            height: 300,
+            plugins: {
+                wavesurfer: {
+                    src: 'live',
+                    waveColor: 'black',
+                    debug: true,
+                    cursorWidth: 0,
+                    interact: false,
+                    hideScrollbar: true
+                }
+            }
+        });
+    },
+
     /**
      * Dispose all players.
      */