fiv out of sync speaker view after presentation reloads #2822 #3032

plugin/notes/plugin.js

@@ -15,24 +15,48 @@ import marked from 'marked';
  */
 const Plugin = () => {
 
-    let popup = null;
-
+	let connectInterval;
+	let speakerWindow = null;
 	let deck;
 
-	function openNotes() {
+	/**
+	 * Opens a new speaker view window.
+	 */
+	function openSpeakerWindow() {
 
-        if (popup && !popup.closed) {
-            popup.focus();
+		// If a window is already open, focus it
+		if( speakerWindow && !speakerWindow.closed ) {
+			speakerWindow.focus();
+		}
+		else {
+			speakerWindow = window.open( 'about:blank', 'reveal.js - Notes', 'width=1100,height=700' );
+			speakerWindow.marked = marked;
+			speakerWindow.document.write( speakerViewHTML );
+
+			if( !speakerWindow ) {
+				alert( 'Speaker view popup failed to open. Please make sure popups are allowed and reopen the speaker view.' );
 				return;
 			}
 
-		popup = window.open( 'about:blank', 'reveal.js - Notes', 'width=1100,height=700' );
-		popup.marked = marked;
-		popup.document.write( speakerViewHTML );
+			connect();
+		}
+
+	}
+
+	/**
+	 * Reconnect with an existing speaker view window.
+	 */
+	function reconnectSpeakerWindow( reconnectWindow ) {
+
+		if( speakerWindow && !speakerWindow.closed ) {
+			speakerWindow.focus();
+		}
+		else {
+			speakerWindow = reconnectWindow;
+			window.addEventListener( 'message', onPostMessage );
+			onConnected();
+		}
 
-		if( !popup ) {
-			alert( 'Speaker view popup failed to open. Please make sure popups are allowed and reopen the speaker view.' );
-			return;
 	}
 
 	/**
@@ -42,9 +66,10 @@ const Plugin = () => {
 		* file system.
 		*/
 	function connect() {
+
 		// Keep trying to connect until we get a 'connected' message back
-			let connectInterval = setInterval( function() {
-				popup.postMessage( JSON.stringify( {
+		connectInterval = setInterval( function() {
+			speakerWindow.postMessage( JSON.stringify( {
 				namespace: 'reveal-notes',
 				type: 'connect',
 				url: window.location.protocol + '//' + window.location.host + window.location.pathname + window.location.search,
@@ -52,16 +77,8 @@ const Plugin = () => {
 			} ), '*' );
 		}, 500 );
 
-			window.addEventListener( 'message', function( event ) {
-				let data = JSON.parse( event.data );
-				if( data && data.namespace === 'reveal-notes' && data.type === 'connected' ) {
-					clearInterval( connectInterval );
-					onConnected();
-				}
-				if( data && data.namespace === 'reveal-notes' && data.type === 'call' ) {
-					callRevealApi( data.methodName, data.arguments, data.callId );
-				}
-			} );
+		window.addEventListener( 'message', onPostMessage );
+
 	}
 
 	/**
@@ -71,17 +88,17 @@ const Plugin = () => {
 	function callRevealApi( methodName, methodArguments, callId ) {
 
 		let result = deck[methodName].apply( deck, methodArguments );
-			popup.postMessage( JSON.stringify( {
+		speakerWindow.postMessage( JSON.stringify( {
 			namespace: 'reveal-notes',
 			type: 'return',
-				result: result,
-				callId: callId
+			result,
+			callId
 		} ), '*' );
 
 	}
 
 	/**
-		 * Posts the current slide data to the notes window
+	 * Posts the current slide data to the notes window.
 	 */
 	function post( event ) {
 
@@ -125,7 +142,20 @@ const Plugin = () => {
 			messageData.markdown = typeof notesElement.getAttribute( 'data-markdown' ) === 'string';
 		}
 
-			popup.postMessage( JSON.stringify( messageData ), '*' );
+		speakerWindow.postMessage( JSON.stringify( messageData ), '*' );
+
+	}
+
+	function onPostMessage( event ) {
+
+		let data = JSON.parse( event.data );
+		if( data && data.namespace === 'reveal-notes' && data.type === 'connected' ) {
+			clearInterval( connectInterval );
+			onConnected();
+		}
+		else if( data && data.namespace === 'reveal-notes' && data.type === 'call' ) {
+			callRevealApi( data.methodName, data.arguments, data.callId );
+		}
 
 	}
 
@@ -149,10 +179,6 @@ const Plugin = () => {
 
 	}
 
-		connect();
-
-	}
-
 	return {
 		id: 'notes',
 
@@ -164,19 +190,33 @@ const Plugin = () => {
 
 				// If the there's a 'notes' query set, open directly
 				if( window.location.search.match( /(\?|\&)notes/gi ) !== null ) {
-					openNotes();
+					openSpeakerWindow();
+				}
+				else {
+					// Keep listening for speaker view hearbeats. If we receive a
+					// heartbeat from an orphaned window, reconnect it. This ensures
+					// that we remain connected to the notes even if the presentation
+					// is reloaded.
+					window.addEventListener( 'message', event => {
+						if( !speakerWindow ) {
+							let data = JSON.parse( event.data );
+							if( data && data.namespace === 'reveal-notes' && data.type === 'heartbeat' ) {
+								reconnectSpeakerWindow( event.source );
+							}
+						}
+					});
 				}
 
 				// Open the notes when the 's' key is hit
 				deck.addKeyBinding({keyCode: 83, key: 'S', description: 'Speaker notes view'}, function() {
-					openNotes();
+					openSpeakerWindow();
 				} );
 
 			}
 
 		},
 
-		open: openNotes
+		open: openSpeakerWindow
 	};
 
 };

plugin/notes/speaker-view.html

@@ -435,6 +435,7 @@
 						setupKeyboard();
 						setupNotes();
 						setupTimer();
+						setupHeartbeat();
 					}
 
 				}
@@ -536,6 +537,18 @@
 
 				}
 
+				/**
+				 * We send out a heartbeat at all times to ensure we can
+				 * reconnect with the main presentation window after reloads.
+				 */
+				function setupHeartbeat() {
+
+					setInterval( () => {
+						window.opener.postMessage( JSON.stringify({ namespace: 'reveal-notes', type: 'heartbeat'} ), '*' );
+					}, 1000 );
+
+				}
+
 				function getTimings( callback ) {
 
 					callRevealApi( 'getSlidesAttributes', [], function ( slideAttributes ) {