fix(visual-grid-client): now referrer is per checkWindow

packages/visual-grid-client/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@applitools/visual-grid-client",
- "version": "12.29.0",
+ "version": "12.29.1",
  "description": "",
  "keywords": [
  "applitools",

packages/visual-grid-client/src/sdk/checkWindow.js

@@ -25,6 +25,7 @@ function makeCheckWindow({
  stepCounter,
  testName,
  openEyesPromises,
+ fetchHeaders,
  matchLevel: _matchLevel,
 }) {
  return function checkWindow({
@@ -50,6 +51,7 @@ function makeCheckWindow({
  enablePatterns,
  ignoreDisplacements,
  source,
+ referrer,
  }) {
  if (target === 'window' && !fully) {
  sizeMode = 'viewport';
@@ -58,6 +60,7 @@ function makeCheckWindow({
  } else if (target === 'region' && region) {
  sizeMode = 'region';
  }
+ fetchHeaders['Referer'] = referrer;
 
  const currStepCount = ++stepCounter;
  logger.log(`running checkWindow for test ${testName} step #${currStepCount}`);

packages/visual-grid-client/src/sdk/openEyes.js

@@ -40,7 +40,6 @@ function makeOpenEyes({
  compareWithParentBranch: _compareWithParentBranch,
  ignoreBaseline: _ignoreBaseline,
  userAgent: _userAgent,
- referrer: _referrer,
  createRGridDOMAndGetResourceMapping: _createRGridDOMAndGetResourceMapping,
  apiKey,
  proxy,
@@ -60,7 +59,6 @@ function makeOpenEyes({
  displayName,
  wrappers,
  userAgent = _userAgent,
- referrer = _referrer,
  appName = _appName,
  browser = _browser,
  saveDebugData = _saveDebugData,
@@ -167,11 +165,9 @@ function makeOpenEyes({
  let checkWindowPromises = wrappers.map(() => Promise.resolve());
  const testController = makeTestContorler({testName, numOfTests: wrappers.length, logger});
 
- const headers = {'User-Agent': userAgent, Referer: referrer};
- const createRGridDOMAndGetResourceMapping =
- headers['User-Agent'] || headers['Referer']
- ? arg => _createRGridDOMAndGetResourceMapping(Object.assign({fetchOptions: {headers}}, arg))
- : _createRGridDOMAndGetResourceMapping;
+ const headers = {'User-Agent': userAgent};
+ const createRGridDOMAndGetResourceMapping = args =>
+ _createRGridDOMAndGetResourceMapping(Object.assign({fetchOptions: {headers}}, args));
 
  const checkWindow = makeCheckWindow({
  testController,
@@ -190,6 +186,7 @@ function makeOpenEyes({
  testName,
  openEyesPromises,
  matchLevel,
+ fetchHeaders: headers,
  });
 
  const close = makeClose({

packages/visual-grid-client/src/sdk/renderingGridClient.js

@@ -65,7 +65,6 @@ function makeRenderingGridClient({
  agentId,
  fetchResourceTimeout = 120000,
  userAgent,
- referrer,
 }) {
  const openEyesConcurrency = Number(concurrency);
 
@@ -171,7 +170,6 @@ function makeRenderingGridClient({
  eyesTransactionThroat,
  agentId,
  userAgent,
- referrer,
  });
 
  return {

packages/visual-grid-client/test/unit/sdk/checkWindow.test.js

@@ -0,0 +1,35 @@
+'use strict';
+const {describe, it} = require('mocha');
+const {expect} = require('chai');
+const makeCheckWindow = require('../../../src/sdk/checkWindow');
+const makeTestContorler = require('../../../src/sdk/makeTestContorler');
+
+describe('checkWindow', () => {
+ it('handles fetchHeaders correctly', async () => {
+ const fetchHeaders = {['User-Agent']: 'some agent'};
+ const checkWindow = makeCheckWindow({
+ testController: makeTestContorler({numOfTests: 0, logger: console}),
+ createRGridDOMAndGetResourceMapping: () => {},
+ renderBatch: () => {},
+ waitForRenderedStatus: () => {},
+ renderInfo: {},
+ logger: console,
+ getCheckWindowPromises: () => {},
+ setCheckWindowPromises: () => {},
+ browsers: [],
+ wrappers: [],
+ renderThroat: () => {},
+ testName: 'some test',
+ openEyesPromises: () => {},
+ fetchHeaders,
+ });
+ await checkWindow({resourceUrls: [], referrer: 'some referrer'});
+ expect(fetchHeaders).to.eql({Referer: 'some referrer', ['User-Agent']: 'some agent'});
+
+ await checkWindow({resourceUrls: []});
+ expect(fetchHeaders).to.eql({Referer: undefined, ['User-Agent']: 'some agent'});
+
+ await checkWindow({resourceUrls: [], referrer: 'some referrer 2'});
+ expect(fetchHeaders).to.eql({Referer: 'some referrer 2', ['User-Agent']: 'some agent'});
+ });
+});