@financial-times/o-ads/test.src/cypress/integration/ad-requests.test.js

This package contains the core functionality used by the FT in providing ads across all of its sites. This includes ft.com, howtospendit.com, ftadviser.com and other specialist titles.

/* globals describe, it, cy, expect */

function getQueryParams(url) {
	const o = {};
	url.slice(url.indexOf('?')+1).split('&').forEach(p => {
		const key = p.slice(0, p.indexOf('='));
		const value = p.slice(p.indexOf('=')+1);
		o[decodeURIComponent(key)] = decodeURIComponent(value);
	});
	return o;
}

// Integration tests check the ad requests are made properly
// We can spy on the ad calls and assert on the underlying xhr
// object, including query parameters and response headers.
describe('Integration tests', () => {
	it('Ad call contains correct size, targeting and custom parameters specified by targeting config option', () => {
		// Spy on the ad call with cy.server() and cy.route()
		// see https://docs.cypress.io/guides/guides/network-requests.html for more details
		// Note: this only works with xhr not fetch at the mo - there are workarounds for fetch
		cy.server();
		cy.route('https://securepubads.g.doubleclick.net/gampad/**').as('AdLoaded');
		cy.visit("/demos/local/Test-Ad.html");

		// Wait for the ad call to be made, then assert on the query string
		cy.wait('@AdLoaded').then(xhr => {
			// xhr.url gives you the url but it is decoded. We don't want that
			// as some params include subparameters as encoded strings
			const url = xhr.xhr.responseURL;
			const qsp = getQueryParams(url);
			const cust_params = getQueryParams(qsp.cust_params);

			// Check sizes are converted and set
			expect(qsp.prev_iu_szs || qsp.sz).to.equal('300x250|180x50|160x600|728x90|970x90|970x66|300x600|970x250|300x1050|320x50|88x31|120x60|2x2');
			// Check targeting is set
			expect(qsp.prev_scp || qsp.scp).to.equal('pos=top');
			// Check custom parameters are set
			expect(cust_params).to.have.property('testparam', 'hello');
			//
		});
	});

	// NOT WORKING - ads requests never fire when responsive formats are set - find out why
	it.skip('Responsive ad renders correctly', () => {
		cy.server();
		cy.route('https://securepubads.g.doubleclick.net/gampad/**').as('AdLoaded');
		cy.visit("/demos/local/Test-Ad-Responsive.html");
		cy.viewport(780, 500);	// w, h. W above 760px = Medium breakpoint;

		cy.wait('@AdLoaded').then(xhr => {
			const url = xhr.xhr.responseURL;
			const qsp = getQueryParams(url);

			expect(qsp.sz).to.equal('300x250');
		});
	});

	it('Targeting options are appended to the ad call', () => {
		cy.server();
		cy.route('https://securepubads.g.doubleclick.net/gampad/**').as('AdLoaded');
		cy.visit("/demos/local/Individual-Ad-with-Custom-Targeting-Values.html");

		cy.wait('@AdLoaded').then(xhr => {
			const url = xhr.xhr.responseURL;
			const qsp = getQueryParams(url);
			const cust_params = getQueryParams(qsp.cust_params);
			expect(cust_params).to.have.property('slv', 'anon');
			expect(cust_params).to.have.property('auuid', 'sample-id');
			expect(cust_params).to.have.property('pos', 'top');
			expect(cust_params).to.have.property('title', 'hello world & goodbye!');
		});
	});
});