Enhance location detection within utils #2167

rachelrj · 2018-02-20T21:01:40Z

Type of change

Feature

Description of change

Check other window objects for location if cannot find.

send 'iv' param if present and full url in `site.page`

Enhance location detection within utils

matthewlane

@rachelrj Thanks for the PR. Adapter changes look good, a few comments regarding the changes to utils for your review

matthewlane · 2018-02-28T23:47:58Z

src/utils.js


-  return location;
+const parseFullUrl = function(locString) {


There's a parse function in the src/url.js module that parses a url and returns a similar looking object, would reusing that function in place of this one fit this use case?

Yes, though I added the href into the return object of that function.

matthewlane · 2018-02-28T23:57:07Z

src/utils.js

@@ -157,17 +157,50 @@ export function parseGPTSingleSizeArray(singleSize) {
  }
 };

-exports.getTopWindowLocation = function () {
-  let location;
+export function getTopWindowLocation() {


Several modules rely on this function, changing it may introduce subtle differences. Any reason to not keep the existing getTopWindowLocation as is, and create a new function for this case?

The old function getTopWindowLocation either returns window.top.location or returns window.location.

The new getTopWindowLocation returns window.location, window.top.location, window.document.referrer, window.document.location.ancestorOrigins[0], or an object that recreates the values within window.location

The new version attempts to get the same info, just from additional objects.

I checked the modules, and I think this new version should fit all the current use cases.

I am not opposed to creating a new function if you’re worried about it.

Ok, thanks for the explanation. Changes to core require a second review, assigning that now

matthewlane · 2018-02-28T23:59:19Z

src/utils.js

  try {
-    // force an exception in x-domain enviornments. #1509
-    window.top.location.toString();


Given the comment, not sure removing this is the correct thing to do, unless there's an equivalent fix in the new code i'm not seeing?

Yeah, I didn't realize that the exception wasn't thrown when trying to access window.top until I read that 1509 PR. Interesting. Thanks for pointing out. I added back in.

CR for enhanced-location-detection PR

mkendall07 · 2018-03-05T22:00:39Z

src/utils.js

+  do {
+    currentWindow = currentWindow ? currentWindow.parent : window;
+    if (currentWindow.document && currentWindow.document.referrer) {
+      referrerLoc = currentWindow.document.referrer;


won't this return a string when an object is expected?

Returns a string to getIframeParentLoc which then gets sent to parse which turns the string into the expected object.

mkendall07

I'd feel better if we had unit tests to cover the getTopWindowLocation changes

rachelrj · 2018-03-06T04:17:34Z

I'll work on adding some unit tests.

Reorg gettopwindowlocation util & add tests.

rachelrj · 2018-03-12T06:12:03Z

I reorganized the additions to getTopWindowLocation and added unit tests.
To mock the readonly window objects in sinon, I wrapped in accessors.
I couldn't figure out a better way to mock these...

Also to use url.parse for getTopWindowLocation, search needs to be returned as string to mirror window.location object.

mkendall07 · 2018-03-12T21:41:59Z

There really are not any elegant solutions that I've seen to mock window and the like. The other option is to pass window in the module bootstrap but that's not great either.

mkendall07

LGTM. Thanks for adding tests

mkendall07 · 2018-03-20T17:01:57Z

@rachelrj
could you fix the merge conflict so I can merge? Thanks

rachelrj · 2018-03-26T00:17:21Z

Fixed merge conflict.

* 'master' of https://github.com/prebid/Prebid.js: EngageBDR New Bid Adapter (prebid#2309) [FEAT] adunit sizes support (prebid#2320) Support aliases in prebidServer (prebid#2257) Changing default currency file to https (prebid#2306) Update stalebot labels (prebid#2319) Enhance location detection within utils (prebid#2167) if cache markup is not enabled, set it to the default value 0 (prebid#2302) Serverbid Bid Adapter: Added archon alias (prebid#2293) Smart Ad Server: Fix bug when multi bids (prebid#2170) NEW adapter AdtelligentBidAdapter (prebid#2137) add optional param to bridgewellBidAdapter (prebid#2289) Increment Pre Version Prebid 1.6.0 Release Unit test fixes (prebid#2301) PBS videoCacheKey and vastUrl (prebid#2101) Add Oneplanetonly Bid Adapter (prebid#2269) firing new adRenderFailed event when renderAd() fails (prebid#2210) Add Content Ignite adapter (prebid#2268) add hb_cache_id, hb_uuid should be deprecated and replaced by hb_cache_id (prebid#2273) Update Yieldlab adapter and add official maintainer (prebid#2231) Update for Media.net adapter (prebid#2232) Update to Rubicon Adapter for mediaTypes support (prebid#2272) message formatting (prebid#2285) Yieldbot impression image creation fix (prebid#2277) Updated Bid params (prebid#2275) Audience Network: Add 'pbv' and 'cb' query params (prebid#2252) Add e-planning analytics adapter (prebid#2211) Add vastUrl for Gamma Adapter Video (prebid#2261) update params for test bid (prebid#2267) Updated adUnitCode (prebid#2262)

* fix sovrn dealid * send 'iv' param if present * `page` field in `site` object sends full url * Enhance location detection within util function. * fix func call * fix tagid var type * add test for converting tagid to string * CR * Reorg gettopwindowlocation util & add tests. * lint fixes * search param is string in window location objects

Rachel Joyce and others added 10 commits February 7, 2018 17:04

fix sovrn dealid

c0c28d7

Merge branch 'master' of https://github.com/prebid/Prebid.js

d7df108

Merge branch 'master' of https://github.com/prebid/Prebid.js

0700e91

send 'iv' param if present

cf0ca21

page field in site object sends full url

f89135c

Merge pull request #1 from sovrn/HS-303_Send_iv_param

be091fd

send 'iv' param if present and full url in `site.page`

Merge remote-tracking branch 'upstream/master'

af86376

Enhance location detection within util function.

c2f2350

Merge pull request #3 from sovrn/enhanced-location-detection

4867c53

Enhance location detection within utils

fix func call

28f3e0e

mkendall07 requested a review from matthewlane February 21, 2018 19:07

mkendall07 assigned matthewlane Feb 21, 2018

mkendall07 added this to the Prebid 1.5.0 milestone Feb 23, 2018

aprakash-sovrn added 4 commits February 23, 2018 15:42

fix tagid var type

497723b

add test for converting tagid to string

f90b2e0

Merge branch 'master' of https://github.com/prebid/Prebid.js

2e9e413

merge upstream master

74ed7f9

matthewlane reviewed Mar 1, 2018

View reviewed changes

Rachel Joyce and others added 2 commits March 1, 2018 16:48

CR

1269a33

Merge pull request #4 from sovrn/enhanced-location-detection

55284d5

CR for enhanced-location-detection PR

matthewlane approved these changes Mar 2, 2018

View reviewed changes

matthewlane requested review from mkendall07 and jaiminpanchal27 March 2, 2018 21:22

mkendall07 self-assigned this Mar 5, 2018

mkendall07 reviewed Mar 5, 2018

View reviewed changes

mkendall07 requested changes Mar 5, 2018

View reviewed changes

matthewlane removed their assignment Mar 6, 2018

matthewlane added the needs update label Mar 6, 2018

mkendall07 removed this from the Prebid 1.5.0 milestone Mar 8, 2018

mkendall07 added this to the 1.6 milestone Mar 8, 2018

Rachel Joyce and others added 6 commits March 11, 2018 18:23

Reorg gettopwindowlocation util & add tests.

3c2f8bc

Merge branch 'master' into enhanced-location-detection

fee1789

Merge pull request #5 from sovrn/enhanced-location-detection

cd78968

Reorg gettopwindowlocation util & add tests.

lint fixes

68a8afa

Merge remote-tracking branch 'upstream/master'

35b3f4c

search param is string in window location objects

b2bc2a4

mkendall07 approved these changes Mar 12, 2018

View reviewed changes

mkendall07 added LGTM and removed needs update labels Mar 12, 2018

mkendall07 added the needs update label Mar 22, 2018

Merge branch 'master' into master

7da5620

jaiminpanchal27 approved these changes Mar 26, 2018

View reviewed changes

jaiminpanchal27 merged commit 63159da into prebid:master Mar 26, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enhance location detection within utils #2167

Enhance location detection within utils #2167

rachelrj commented Feb 20, 2018

matthewlane left a comment

matthewlane Feb 28, 2018

rachelrj Mar 1, 2018

matthewlane Feb 28, 2018

rachelrj Mar 1, 2018 •

edited

Loading

matthewlane Mar 2, 2018

matthewlane Feb 28, 2018

rachelrj Mar 1, 2018

mkendall07 Mar 5, 2018

rachelrj Mar 6, 2018

mkendall07 left a comment

rachelrj commented Mar 6, 2018

rachelrj commented Mar 12, 2018

mkendall07 commented Mar 12, 2018

mkendall07 left a comment

mkendall07 commented Mar 20, 2018

rachelrj commented Mar 26, 2018

Enhance location detection within utils #2167

Enhance location detection within utils #2167

Conversation

rachelrj commented Feb 20, 2018

Type of change

Description of change

matthewlane left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rachelrj Mar 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkendall07 left a comment

Choose a reason for hiding this comment

rachelrj commented Mar 6, 2018

rachelrj commented Mar 12, 2018

mkendall07 commented Mar 12, 2018

mkendall07 left a comment

Choose a reason for hiding this comment

mkendall07 commented Mar 20, 2018

rachelrj commented Mar 26, 2018

rachelrj Mar 1, 2018 •

edited

Loading