parrableIdSystem: Send current page location to back-end

[icflournoy]

Type of change

• Bugfix

Description of change

Send the page location (window.location.href) as determined by the logic in the refererDetection module to Parrable's ID system.

The non-Prebid integration with Parrable sends the value of window.location.href when making a request to our system. This change makes Prebid more closely match our non-Prebid integration.

[icflournoy]

Hey @jdwieland8282 @jaiminpanchal27 I see that the CircleCI build failed on the BrowserStack step for this specific test:

TOTAL: 1 FAILED, 48977 SUCCESS

1) should notify after timeout period
     ExpiringQueue
     Timeout of 2000ms exceeded. For async tests and hooks, ensure "done()" is called; if returning a Promise, ensure it resolves.

This seems like a timing issue and not related to my change. Could you point me in the right direction on re-running a build, or updating the failing test so it is more robust?

[harpere]

I know it's a small change, but ideally you add a test for the new param.

[harpere]

@icflournoy unfortunately these tests are flakey and fail sporadically. Usually the reviewer will rerun if necessary.

[icflournoy]

Hey, thanks for the feedback @harpere

I spent a bit of time trying to figure out how to add a good test for this additional property, but could not find an easy way forward. The property is something we are sending off to our backend servers, via an Xhr request.

I see that Prebid has an Xhr mock that is used in a few places to create a fake http server:

Prebid.js/test/spec/AnalyticsAdapter_spec.js

Line 40 in 7e26de8

let result = JSON.parse(server.requests[0].requestBody);

This part makes sense to me.

I'm having trouble getting the parrableIdSystem module to actually have its getId callback method invoked during my test so that the mocked xhr object catches the outgoing request.

My understanding is that when userSync.syncDelay is set to 0 then the userId submodule callbacks are immediately invoked:

Prebid.js/modules/userId/index.js

Lines 337 to 343 in 7e26de8

	// when syncDelay is zero, process callbacks now, otherwise delay process with a setTimeout
	if (syncDelay > 0) {
	setTimeout(function() {
	processSubmoduleCallbacks(submodulesWithCallbacks);
	}, syncDelay);
	} else {
	processSubmoduleCallbacks(submodulesWithCallbacks);

but that doesn't seem to be happening.

General development questions:

• How can I run only my parrableIdSystem_spec.js test? There is a note in the gulpfile that says I can do gulp test --file path/to/my/test.js but this does not work (fails on using import syntax)
  

  Prebid.js/gulpfile.js

  Line 216 in 7e26de8

  // If --file "<path-to-test-file>" is given, the task will only run tests in the specified file.

• How do I enable debug logging during the test run? I've tried settings DEBUG_MODE=TRUE in constants.json, among other things, to get the utils.log* methods to print out, perhaps they are, but I do not see them when running the karma tests in a headless browser.

[harpere]

Hi @icflournoy - I don't think it's worth all that trouble to add the test. Sorry to put you through that, but looking on the bright side, maybe a good learning experience! Going to try to get you answers to your dev questions, but in the mean time will approve and merge this.

[idettman]

How can I run only my parrableIdSystem_spec.js test? There is a note in the gulpfile that says I can do gulp test --file path/to/my/test.js but this does not work (fails on using import syntax)

Unfortunately, the ability to run a single test file is not functional at the moment, I'm not sure if there are plans to fix or not yet. But you can add .skip or .only to the describe blocks to ignore or isolate.

To add debug logging you'll need to add eslint ignore comments before your console.log calls