ITV-2200 Deprecate the use of *history=broadcast

- Pass through currentUrlParams to Historian - Update usages of hash fragment to utilize query param
bbc · Dec 6, 2018 · 01f8642 · 01f8642
1 parent 015c72d
commit 01f8642
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 12 deletions.
diff --git a/static/script-tests/tests/application-exit.js b/static/script-tests/tests/application-exit.js
@@ -86,7 +86,7 @@
                 // Configure BrowserDevice.getWindowLocation() to return canned data
                 this.sandbox.stub(BrowserDevice.prototype, 'getWindowLocation', function() {
                     return {
-                        href: 'http://www.test.com/#&*history=broadcast'
+                        href: 'http://www.test.com/?broadcast=true'
                     };
                 });
 
@@ -111,7 +111,7 @@
                 // Configure BrowserDevice.getWindowLocation() to return canned data
                 this.sandbox.stub(BrowserDevice.prototype, 'getWindowLocation', function() {
                     return {
-                        href: 'http://www.test.com/#&*history=broadcast'
+                        href: 'http://www.test.com/?broadcast=true'
                     };
                 });
 

diff --git a/static/script-tests/tests/historian.js b/static/script-tests/tests/historian.js
@@ -247,7 +247,7 @@
                 'antie/historian'
             ],
             function(Historian) {
-                var historian = new Historian('http://www.test.com/test/#&*history=broadcast');
+                var historian = new Historian('http://www.test.com/test/?broadcast=true');
                 assertFalse('hasHistory()', historian.hasHistory());
             }
         );
@@ -260,7 +260,7 @@
                 'antie/historian'
             ],
             function(Historian) {
-                var historian = new Historian('http://www.test.com/test/#&*history=http://www.test2.com&*history=broadcast');
+                var historian = new Historian('http://www.test.com/test/?broadcast=true#&*history=http://www.test2.com');
                 assert('hasHistory()', historian.hasHistory());
             }
         );
@@ -273,7 +273,7 @@
                 'antie/historian'
             ],
             function(Historian) {
-                var historian = new Historian('http://www.test.com/test/#&*history=http://www.test2.com&*history=broadcast');
+                var historian = new Historian('http://www.test.com/test/?broadcast=true#&*history=http://www.test2.com');
                 assert('hasBroadcastOrigin()', historian.hasBroadcastOrigin());
             }
         );
@@ -286,7 +286,7 @@
                 'antie/historian'
             ],
             function(Historian) {
-                var historian = new Historian('http://www.test.com/test#&*history=broadcast');
+                var historian = new Historian('http://www.test.com/test?broadcast=true');
                 assert('hasBroadcastOrigin()', historian.hasBroadcastOrigin());
             }
         );

diff --git a/static/script/devices/browserdevice.js b/static/script/devices/browserdevice.js
@@ -560,7 +560,7 @@ define(
              * @returns {antie.Historian} an object that can be used to get a back or forward url between applications while preserving history
              */
             getHistorian: function getHistorian () {
-                return new Historian(decodeURI(this.getWindowLocation().href));
+                return new Historian(decodeURI(this.getWindowLocation().href), this.getCurrentAppURLParams());
             },
 
             /**

diff --git a/static/script/historian.js b/static/script/historian.js
@@ -18,9 +18,10 @@ define(
              * @constructor
              * @ignore
              */
-            init: function init (currentUrl) {
+            init: function init (currentUrl, UrlAppParams) {
                 var i;
 
+                this._urlParams = UrlAppParams;
                 this._historyArray = currentUrl.split(Historian.HISTORY_TOKEN);
                 this._currentUrl = this._historyArray.shift(); // non-history portion of the URL
                 for(i = 0; i !== this._historyArray.length; i += 1) {
@@ -121,16 +122,16 @@ define(
              * @returns {Boolean} True if the history stack contains one or more valid return URLs.
              */
             hasHistory: function hasHistory () {
-                var historyMinimumLength = this.hasBroadcastOrigin() ? 2 : 1;
+                var historyMinimumLength = 1;
                 return this._historyArray.length >= historyMinimumLength;
             },
 
             /**
-             * Returns a Boolean to indicate whether the first entry in the history stack is the special 'broadcast' entry.
-             * @returns {Boolean} True if the first entry in the history stack is the special 'broadcast' entry.
+             * Returns a Boolean to indicate whether the URL contains a 'broadcast' query parameter.
+             * @returns {Boolean} True if the URL contains a 'broadcast' query parameter.
              */
             hasBroadcastOrigin: function hasBroadcastOrigin () {
-                return this._historyArray.length > 0 && this._historyArray[this._historyArray.length - 1] === Historian.HISTORY_TOKEN + Historian.BROADCAST_ENTRY;
+                return this._urlParams.length > 0 && this._urlParams[Historian.BROADCAST_ENTRY] === true;
             }
         });