PBjs Core: override refererInfo.canonicalUrl if pageUrl is defined in…

… config (#6591)

* Updated refererDetection logic for canonical url. First run getConfig('pageUrl')and if value exists, return value else run standard logic

* Added test for override from config

src/refererDetection.js

@@ -9,6 +9,7 @@
  */
 
 import { logWarn } from './utils.js';
+import { config } from './config.js';
 
 /**
  * @param {Window} win Window
@@ -41,6 +42,10 @@ export function detectReferer(win) {
    * @returns {string|null}
    */
   function getCanonicalUrl(doc) {
+    let pageURL = config.getConfig('pageUrl');
+
+    if (pageURL) return pageURL;
+
     try {
       const element = doc.querySelector("link[rel='canonical']");
 

test/spec/refererDetection_spec.js

@@ -1,4 +1,5 @@
 import { detectReferer } from 'src/refererDetection.js';
+import { config } from 'src/config.js';
 import { expect } from 'chai';
 
 /**
@@ -91,6 +92,10 @@ function buildWindowTree(urls, topReferrer = '', canonicalUrl = null, ancestorOr
 describe('Referer detection', () => {
   describe('Non cross-origin scenarios', () => {
     describe('No iframes', () => {
+      afterEach(function () {
+        config.resetConfig();
+      });
+
       it('Should return the current window location and no canonical URL', () => {
         const testWindow = buildWindowTree(['https://example.com/some/page'], 'https://othersite.com/'),
           result = detectReferer(testWindow)();
@@ -156,6 +161,26 @@ describe('Referer detection', () => {
           canonicalUrl: 'https://example.com/canonical/page'
         });
       });
+
+      it('Should override canonical URL with config pageUrl', () => {
+        config.setConfig({'pageUrl': 'testUrl.com'});
+
+        const testWindow = buildWindowTree(['https://example.com/some/page', 'https://example.com/other/page', 'https://example.com/third/page'], 'https://othersite.com/', 'https://example.com/canonical/page'),
+          result = detectReferer(testWindow)();
+
+        expect(result).to.deep.equal({
+          referer: 'https://example.com/some/page',
+          reachedTop: true,
+          isAmp: false,
+          numIframes: 2,
+          stack: [
+            'https://example.com/some/page',
+            'https://example.com/other/page',
+            'https://example.com/third/page'
+          ],
+          canonicalUrl: 'testUrl.com'
+        });
+      });
     });
   });