Changes to canonical url being preferred for site.page

[patmmccann]

As discussed in #9152

• canonical looses its query string params
• Some pubs have the wrong canonical on their page for some reason

cc: @jsadwith @nllerandi

Proposal, ignore canonical being in pub config, append query string by default

[dgirardi]

Would it make sense to have a config toggle that gives preference to the page's location over canonicalUrl?

pbjs.setConfig({
   useCanonicalURL: false
})

[dgirardi]

Consensus is that the referer logic should be updated to refererInfo.page = getConfig('pageUrl') || refererInfo.location || refererInfo.canonicalUrl.

[nllerandi3lift]

Consensus is that the referer logic should be updated to refererInfo.page = getConfig('pageUrl') || refererInfo.location || refererInfo.canonicalUrl.

Was it refererInfo.location or refererInfo.topmostLocation as the second step?

[dgirardi]

@nllerandi3lift, consensus is that canonical should be used only if prebid is unable to determine the top frame location. That translates to refererInfo.location as the second step. Yes, I am regretting my name choices on those.

[dgirardi]

For a bit of history:

• PBjs Core: override refererInfo.canonicalUrl if pageUrl is defined in config #6591 made it so that setConfig({pageUrl}) overrides refererInfo.canonicalUrl
• Prebid 7: refactoring of refererInfo, pageUrl, publisherDomain #8450 introduced refererInfo.page = refererInfo.canonicalUrl || window.top.location as an attempt to solve Overriding referrer: publisherDomain vs pageUrl #5637 (adapters not picking up the pageUrl config)

It's unclear if the first was an attempt to solve the same problem with the expectation that adapters would pick up canonicalUrl. @mmoschovas, do you remember the context?

[nllerandi3lift]

cc @patrickloughrey @bwoolcott as I'll be on leave for some weeks any day now.
fyi @patmmccann

[mmoschovas]

@dgirardi Sorry, I dont really remember the context here. @bretg may remember the reason for this change

[bretg]

Sorry, wasn't really involved in this effort. FWIW, I think there are too many URL choices.

[patmmccann]

fixed in #9241