@applitools/eyes-cypress 3.23.9 → 3.24.0-beta.2

package/src/browser/socket.js

@@ -0,0 +1,143 @@
+const uuid = require('uuid');
+
+class Socket {
+  constructor() {
+    this._socket = null;
+    this._listeners = new Map();
+    this._queue = new Set();
+  }
+
+  attach(ws) {
+    if (!ws) return;
+
+    if (ws.readyState === WebSocket.CONNECTING) ws.addEventListener('open', () => this.attach(ws));
+    else if (ws.readyState === WebSocket.OPEN) {
+      this._socket = ws;
+      this._queue.forEach(command => command());
+      this._queue.clear();
+
+      this._socket.addEventListener('message', message => {
+        const {name, key, payload} = this.deserialize(message);
+        const fns = this._listeners.get(name);
+        if (fns) fns.forEach(fn => fn(payload, key));
+        if (key) {
+          const fns = this._listeners.get(`${name}/${key}`);
+          if (fns) fns.forEach(fn => fn(payload, key));
+        }
+      });
+      this._socket.addEventListener('close', () => {
+        const fns = this._listeners.get('close');
+        if (fns) fns.forEach(fn => fn());
+      });
+    }
+  }
+
+  on(type, fn) {
+    const name = typeof type === 'string' ? type : `${type.name}/${type.key}`;
+    let fns = this._listeners.get(name);
+    if (!fns) {
+      fns = new Set();
+      this._listeners.set(name, fns);
+    }
+    fns.add(fn);
+    return () => this.off(name, fn);
+  }
+
+  connect(url) {
+    const ws = new WebSocket(url);
+    this.attach(ws);
+  }
+
+  disconnect() {
+    if (!this._socket) return;
+    this._socket.terminate();
+    this._socket = null;
+  }
+
+  request(name, payload) {
+    return new Promise((resolve, reject) => {
+      try {
+        const key = uuid.v4();
+        this.emit({name, key}, payload);
+        this.once({name, key}, response => {
+          if (response.error) return reject(response.error);
+          return resolve(response.result);
+        });
+      } catch (ex) {
+        console.log(ex);
+        throw ex;
+      }
+    });
+  }
+
+  command(name, fn) {
+    this.on(name, async (payload, key) => {
+      try {
+        const result = await fn(payload);
+        this.emit({name, key}, {result});
+      } catch (error) {
+        console.log(error);
+        this.emit({name, key}, {error});
+      }
+    });
+  }
+
+  subscribe(name, publisher, fn) {
+    const subscription = uuid.v4();
+    this.emit(name, {publisher, subscription});
+    const off = this.on({name, key: subscription}, fn);
+    return () => (this.emit({name, key: subscription}), off());
+  }
+
+  once(type, fn) {
+    const off = this.on(type, (...args) => (fn(...args), this.off()));
+    return off;
+  }
+
+  off(name, fn) {
+    if (!fn) return this._listeners.delete(name);
+    const fns = this._listeners.get(name);
+    if (!fns) return false;
+    const existed = fns.delete(fn);
+    if (!fns.size) this._listeners.delete(name);
+    return existed;
+  }
+
+  emit(type, payload) {
+    try {
+      const command = () => this._socket.send(this.serialize(type, payload));
+      if (this._socket) command();
+      else this._queue.add(command);
+      return () => this._queue.delete(command);
+    } catch (ex) {
+      console.log(ex);
+      throw ex;
+    }
+  }
+
+  ref() {
+    const command = () => this._socket._socket.ref();
+    if (this._socket) command();
+    else this._queue.add(command);
+    return () => this._queue.delete(command);
+  }
+
+  unref() {
+    const command = () => this._socket._socket.unref();
+    if (this._socket) command();
+    else this._queue.add(command);
+    return () => this._queue.delete(command);
+  }
+
+  serialize(type, payload) {
+    const message =
+      typeof type === 'string' ? {name: type, payload} : {name: type.name, key: type.key, payload};
+    return JSON.stringify(message);
+  }
+
+  deserialize(message) {
+    return JSON.parse(message.data);
+  }
+}
+
+module.exports = Socket;

package/src/browser/socketCommands.js

@@ -0,0 +1,81 @@
+const spec = require('../../dist/browser/spec-driver');
+
+function socketCommands(socket, refer) {
+  socket.command('Driver.executeScript', ({context, script, arg = []}) => {
+    const res = spec.executeScript(refer.deref(context), script, derefArgs(arg));
+    return refer.ref(res);
+  });
+  socket.command('Driver.mainContext', () => {
+    return refer.ref(spec.mainContext());
+  });
+
+  socket.command('Driver.parentContext', ({context}) => {
+    return refer.ref(spec.parentContext(refer.deref(context)));
+  });
+
+  socket.command('Driver.childContext', ({context, element}) => {
+    return refer.ref(spec.childContext(refer.deref(context), refer.deref(element)));
+  });
+
+  socket.command('Driver.getViewportSize', () => {
+    return spec.getViewportSize();
+  });
+  socket.command('Driver.setViewportSize', vs => {
+    spec.setViewportSize(vs);
+  });
+  socket.command('Driver.findElement', ({context, selector, parent}) => {
+    const element = spec.findElement(
+      refer.deref(context),
+      spec.transformSelector(selector),
+      refer.deref(parent),
+    );
+    return element === null ? element : refer.ref(element, context);
+  });
+  socket.command('Driver.findElements', ({context, selector, parent}) => {
+    const elements = spec.findElements(
+      refer.deref(context),
+      spec.transformSelector(selector),
+      refer.deref(parent),
+    );
+    return Array.prototype.map.call(elements, element =>
+      element === null ? element : refer.ref(element, context),
+    );
+  });
+
+  socket.command('Driver.getUrl', context => {
+    return spec.getUrl(refer.deref(context));
+  });
+
+  socket.command('Driver.getTitle', context => {
+    return spec.getTitle(refer.deref(context.driver));
+  });
+
+  socket.command('Driver.getCookies', async () => {
+    return await spec.getCookies();
+  });
+
+  // utils
+
+  function derefArgs(arg) {
+    const derefArg = [];
+    if (Array.isArray(arg)) {
+      for (const argument of arg) {
+        if (Array.isArray(argument)) {
+          derefArg.push(derefArgs(argument));
+        } else {
+          derefArg.push(refer.deref(argument));
+        }
+      }
+      return derefArg;
+    } else if (typeof arg === 'object') {
+      for (const [key, value] of Object.entries(arg)) {
+        derefArg[key] = refer.deref(value);
+      }
+      return derefArg;
+    } else {
+      return arg;
+    }
+  }
+}
+
+module.exports = {socketCommands};

package/src/browser/spec-driver.ts

@@ -0,0 +1,109 @@
+export type Selector = (string | {selector: string; type?: string}) & {__applitoolsBrand?: never};
+export type Context = Document & {__applitoolsBrand?: never};
+export type Element = HTMLElement & {__applitoolsBrand?: never};
+
+export function executeScript(context: Context, script: string, arg: any): any {     
+  context = getCurrenctContext(context)
+
+      let scriptToExecute;
+      if (
+        script.includes('dom-snapshot') ||
+        script.includes('dom-capture') ||
+        script.includes('dom-shared')
+        ) {
+            scriptToExecute = script
+        } else {
+            const prepScirpt = script.replace('function(arg)', 'function func(arg)')
+            scriptToExecute = prepScirpt.concat(' return func(arg)')
+        }
+
+        const executor = new context.defaultView.Function('arg', scriptToExecute);
+        return executor(arg)
+}
+
+export function mainContext(): Context {
+  //@ts-ignore
+  return cy.state('window').document
+}
+
+export function parentContext(context: Context): Context {
+  if (!context) return; // because Cypress doesn't support cross origin iframe, then childContext might return null, and then the input to parentContext might be null
+  
+  return context === mainContext() ? context : context.defaultView.frameElement.ownerDocument
+}
+
+export function childContext(_context: Context, element: HTMLIFrameElement): Context {
+  return element.contentDocument // null in case of cross origin iframe
+}
+
+export function getViewportSize(): Object {
+  //@ts-ignore
+  const currWindow = cy.state('window')
+  const viewportSize = {
+    width: Math.max(currWindow.document.documentElement.clientWidth || 0, currWindow.innerWidth || 0),
+    height: Math.max(currWindow.document.documentElement.clientHeight || 0, currWindow.innerHeight || 0)
+  };
+  return viewportSize;
+}
+
+export function setViewportSize(vs: any): void {
+  //@ts-ignore
+  Cypress.action('cy:viewport:changed', { viewportWidth: vs.size.width, viewportHeight: vs.size.height });
+}
+
+export function transformSelector(selector: Selector): Selector {
+  if (selector.hasOwnProperty('selector') && (!selector.hasOwnProperty('type') || selector.type === 'css')) {
+    return selector.selector
+  }
+  return selector
+}
+
+export function findElement(context: Context, selector: Selector, parent?: Element) {
+  // context = getCurrenctContext(context)
+  const root = parent ?? context
+  const sel = typeof selector === 'string' ? selector : selector.selector
+  if (typeof selector !== 'string' && selector.type === 'xpath') {
+    return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+  } else {
+    return root.querySelector(sel)
+  }
+}
+
+export function findElements(context: Context, selector: Selector, parent: Element){
+  context = getCurrenctContext(context)
+  const root = parent ?? context
+  const sel = typeof selector === 'string' ? selector : selector.selector
+  if (typeof selector !== 'string' && selector.type === 'xpath') {
+    // TODO return multiple
+    return context.evaluate(sel, context, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue;
+  } else {
+    return root.querySelectorAll(sel)
+  }
+}
+
+export function getTitle(context: Context): string {
+  context = getCurrenctContext(context)
+  return context.title
+}
+
+export function getUrl(context: Context): string {
+  context = getCurrenctContext(context)
+  return context.location.href
+}
+
+export function getCookies(): Array<any> {
+  //@ts-ignore
+  return Cypress.automation('get:cookies', {})
+}
+
+// we need to method to reset the context in case the user called open before visit
+function getCurrenctContext(context: Context){
+  //@ts-ignore
+  return (context && context.defaultView) ? context : cy.state('window').document
+}
+
+// export function takeScreenshot(page: Driver): Promise<Buffer>;
+
+// export function visit(page: Driver, url: string): Promise<void>; (??)
+
+// export function isStaleElementError(err: any): boolean;

package/src/pem/server.cert

@@ -1,22 +1,22 @@
------BEGIN CERTIFICATE-----
-MIIDsDCCApigAwIBAgIJANJbHwoHZzbBMA0GCSqGSIb3DQEBCwUAMG0xCzAJBgNV
-BAYTAkNBMRIwEAYDVQQIDAlTYW4gTWF0ZW8xEzARBgNVBAoMCkFwcGxpdG9vbHMx
-NTAzBgNVBAMMLFNlbGYgc2lnbmVkIHNlcnZlciBmb3IgY3lwcmVzcyBleWVzIGNv
-bW1hbmRzMB4XDTE5MDExMzA5MDU0MloXDTM5MDEwODA5MDU0MlowbTELMAkGA1UE
-BhMCQ0ExEjAQBgNVBAgMCVNhbiBNYXRlbzETMBEGA1UECgwKQXBwbGl0b29sczE1
-MDMGA1UEAwwsU2VsZiBzaWduZWQgc2VydmVyIGZvciBjeXByZXNzIGV5ZXMgY29t
-bWFuZHMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCCGfKHFApw+Cf
-TPi8r6UG8pPI6KFNrNKCZfI0K1GNEVu5csdAaFMgPCpq+UgR87jJqra1z6LXUDWd
-Hw7i0eAvY2k86RsQyQ8VdmOuf5MOXwJrCjlVITRbBjP3bmCcJuYgLZeDLN28JNwE
-SBlbhAGPepDXnQGUQkpmGTisX5LXQ9V4azVJ2mMuweKIgYUVIORVaGyELdg62OOo
-ShQna2olFsa6XLB5crTJMrplFCrb+aSc/X+P+LXET4jlz6i2gt4MwGMeJ0zELYOz
-Dr7AhvuzmeoYYhJdVVeDYbTsYEYgAZ10UnpUcaXE3PnCIOz91dpTiXEtafH2HM1n
-BUr652YRAgMBAAGjUzBRMB0GA1UdDgQWBBRGWnmO6FmZVz32pEXykD8HTw4x6TAf
-BgNVHSMEGDAWgBRGWnmO6FmZVz32pEXykD8HTw4x6TAPBgNVHRMBAf8EBTADAQH/
-MA0GCSqGSIb3DQEBCwUAA4IBAQC98pfQnfmXfkDpffQVa+ms4xRNvqG5kDZn7BQd
-x0X0Td+7vNVGI2HDUnANo/X+jNzOeu5Rvk7fgZmQbLB6zZUAkz6J1DOCIAtY2DWF
-94YRam6rXu2J2QN8xnD/qLVlTNJMcy+O7QD2aIPkYJQUvrxcNE8phLX8L8qQGink
-O5I8zzH6RY/x6GkgLEez7u4wphXliiYgT1E3NI2g6SrIVMRjYW/Dt4/QsOcImaBN
-+qI6+Fc4Nm/ZaiGwwjy/hapn8zbX5jyDx9k89BAb199noXllYCvHQ8C1ak4oT1nS
-WoDAnRJRoMIEgara3fhU+R+vrdJuyf1awbmoXarrIu1mP6Na
------END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIDsDCCApigAwIBAgIJANJbHwoHZzbBMA0GCSqGSIb3DQEBCwUAMG0xCzAJBgNV
+BAYTAkNBMRIwEAYDVQQIDAlTYW4gTWF0ZW8xEzARBgNVBAoMCkFwcGxpdG9vbHMx
+NTAzBgNVBAMMLFNlbGYgc2lnbmVkIHNlcnZlciBmb3IgY3lwcmVzcyBleWVzIGNv
+bW1hbmRzMB4XDTE5MDExMzA5MDU0MloXDTM5MDEwODA5MDU0MlowbTELMAkGA1UE
+BhMCQ0ExEjAQBgNVBAgMCVNhbiBNYXRlbzETMBEGA1UECgwKQXBwbGl0b29sczE1
+MDMGA1UEAwwsU2VsZiBzaWduZWQgc2VydmVyIGZvciBjeXByZXNzIGV5ZXMgY29t
+bWFuZHMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDCCGfKHFApw+Cf
+TPi8r6UG8pPI6KFNrNKCZfI0K1GNEVu5csdAaFMgPCpq+UgR87jJqra1z6LXUDWd
+Hw7i0eAvY2k86RsQyQ8VdmOuf5MOXwJrCjlVITRbBjP3bmCcJuYgLZeDLN28JNwE
+SBlbhAGPepDXnQGUQkpmGTisX5LXQ9V4azVJ2mMuweKIgYUVIORVaGyELdg62OOo
+ShQna2olFsa6XLB5crTJMrplFCrb+aSc/X+P+LXET4jlz6i2gt4MwGMeJ0zELYOz
+Dr7AhvuzmeoYYhJdVVeDYbTsYEYgAZ10UnpUcaXE3PnCIOz91dpTiXEtafH2HM1n
+BUr652YRAgMBAAGjUzBRMB0GA1UdDgQWBBRGWnmO6FmZVz32pEXykD8HTw4x6TAf
+BgNVHSMEGDAWgBRGWnmO6FmZVz32pEXykD8HTw4x6TAPBgNVHRMBAf8EBTADAQH/
+MA0GCSqGSIb3DQEBCwUAA4IBAQC98pfQnfmXfkDpffQVa+ms4xRNvqG5kDZn7BQd
+x0X0Td+7vNVGI2HDUnANo/X+jNzOeu5Rvk7fgZmQbLB6zZUAkz6J1DOCIAtY2DWF
+94YRam6rXu2J2QN8xnD/qLVlTNJMcy+O7QD2aIPkYJQUvrxcNE8phLX8L8qQGink
+O5I8zzH6RY/x6GkgLEez7u4wphXliiYgT1E3NI2g6SrIVMRjYW/Dt4/QsOcImaBN
++qI6+Fc4Nm/ZaiGwwjy/hapn8zbX5jyDx9k89BAb199noXllYCvHQ8C1ak4oT1nS
+WoDAnRJRoMIEgara3fhU+R+vrdJuyf1awbmoXarrIu1mP6Na
+-----END CERTIFICATE-----

package/src/pem/server.key

@@ -1,27 +1,27 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEogIBAAKCAQEAwghnyhxQKcPgn0z4vK+lBvKTyOihTazSgmXyNCtRjRFbuXLH
-QGhTIDwqavlIEfO4yaq2tc+i11A1nR8O4tHgL2NpPOkbEMkPFXZjrn+TDl8Cawo5
-VSE0WwYz925gnCbmIC2XgyzdvCTcBEgZW4QBj3qQ150BlEJKZhk4rF+S10PVeGs1
-SdpjLsHiiIGFFSDkVWhshC3YOtjjqEoUJ2tqJRbGulyweXK0yTK6ZRQq2/mknP1/
-j/i1xE+I5c+otoLeDMBjHidMxC2Dsw6+wIb7s5nqGGISXVVXg2G07GBGIAGddFJ6
-VHGlxNz5wiDs/dXaU4lxLWnx9hzNZwVK+udmEQIDAQABAoIBAFwNiNAGJrHp0AND
-jS5XVj+5jgte8kfbmfNrUkEV3BbFCXMt1QHlfKpqYOVnZp29twlWCGCxJVxpHUZx
-mapaT7WrwB25qbGI8bMI+7mppKbIxGjr7M9KdYBJrRXSM9thSQQzHRKKkpfUFN2j
-JwSX1/Wt/FGOl1UzLgDKLmz42r1tCZPGlomMOW+Fs3TFtcro1iTlGQz7kvfWXxrF
-V5by7uFJIAkypFFMen0stqDH6eaNNFXrwdm6Sj6B/VOSz0HG+FSTAia0vt17dsqm
-2KLJIVWuTPibt5gb2C+X9GpHztTCbziYF6n4Cfp3dF1jBrKK6yM7LwH1RJVpYy2H
-tU+4dZECgYEA56uMFRZmuiFL+S+oDBVfe6GWwzgHwZ2h/4uBB2lDPULtUv+av/3C
-sthzfkRvw5EgBDQfpWgco/y0pCtfs9Wm5Occ461krTWu3ymVjrtsANPIdywZaj9I
-p+UfDR2jJoAmxlOPHm2s5vPGu+y/Zlxt1mHmn+WMcAhJ45F98eItOMMCgYEA1mj6
-1m0yOlQtmIFh3cYIV11W1R29KMx/UqGbSMev6pWfP3nrnzvz4yp835omTt4bkhcf
-U+9xEMCOHcILSQ3cx3xLeW6pWXyPJAJUX2Y2+SvmX5lypYRZSg2DE0mVKjEV7M6Q
-cKqIo+vqrcVhOpJf9y43ZkzNnLczxNuILlHBWJsCgYAyOmZPuCCjoE55g1Sa8hNW
-ma03PDGqT8PsxNE/yxmx8Y3E3fguQhVxcy5vJOVacF+Rqb9mvFDhWQvNQD4qnlrl
-7Bm+XzyhtS7p4Xk0jfwXndMry1rjRz84b5uw20khMs21WC6CeWLwW9AttGG3Drkd
-rvIynrE5JQLoHQZCaDhHwwKBgCPgUQiMIPltmGuKSqvnNQIZViw22631+eADto4J
-C8B+5LSkW+67A2Yhd9+aVYqg05AwWkebKxoYfi8wht7keOrQO3jIMYINu43U7fVA
-jzZGSDf63xoe+SnQ9PvHNjRnHjoPnk+b2V1EXnJRMqGwWGpty0tM0qLEbN8ltLW7
-bFS9AoGARqPSEW0PpLxW5m8fnfPRVWwpTuhhWm0fkw13O8cUVIVf3E6g+MF2I9wf
-v8yPDFyh5myoCzy8aFy4eSFeWzYTahsLDq03EyYuqIGoTJrcls9dmpxhRdPjwywJ
-Yll894/fpK2lWI54kCEh+jRE3+S+4D3zi2txta/tu7Z891eQ5sI=
------END RSA PRIVATE KEY-----
+-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEAwghnyhxQKcPgn0z4vK+lBvKTyOihTazSgmXyNCtRjRFbuXLH
+QGhTIDwqavlIEfO4yaq2tc+i11A1nR8O4tHgL2NpPOkbEMkPFXZjrn+TDl8Cawo5
+VSE0WwYz925gnCbmIC2XgyzdvCTcBEgZW4QBj3qQ150BlEJKZhk4rF+S10PVeGs1
+SdpjLsHiiIGFFSDkVWhshC3YOtjjqEoUJ2tqJRbGulyweXK0yTK6ZRQq2/mknP1/
+j/i1xE+I5c+otoLeDMBjHidMxC2Dsw6+wIb7s5nqGGISXVVXg2G07GBGIAGddFJ6
+VHGlxNz5wiDs/dXaU4lxLWnx9hzNZwVK+udmEQIDAQABAoIBAFwNiNAGJrHp0AND
+jS5XVj+5jgte8kfbmfNrUkEV3BbFCXMt1QHlfKpqYOVnZp29twlWCGCxJVxpHUZx
+mapaT7WrwB25qbGI8bMI+7mppKbIxGjr7M9KdYBJrRXSM9thSQQzHRKKkpfUFN2j
+JwSX1/Wt/FGOl1UzLgDKLmz42r1tCZPGlomMOW+Fs3TFtcro1iTlGQz7kvfWXxrF
+V5by7uFJIAkypFFMen0stqDH6eaNNFXrwdm6Sj6B/VOSz0HG+FSTAia0vt17dsqm
+2KLJIVWuTPibt5gb2C+X9GpHztTCbziYF6n4Cfp3dF1jBrKK6yM7LwH1RJVpYy2H
+tU+4dZECgYEA56uMFRZmuiFL+S+oDBVfe6GWwzgHwZ2h/4uBB2lDPULtUv+av/3C
+sthzfkRvw5EgBDQfpWgco/y0pCtfs9Wm5Occ461krTWu3ymVjrtsANPIdywZaj9I
+p+UfDR2jJoAmxlOPHm2s5vPGu+y/Zlxt1mHmn+WMcAhJ45F98eItOMMCgYEA1mj6
+1m0yOlQtmIFh3cYIV11W1R29KMx/UqGbSMev6pWfP3nrnzvz4yp835omTt4bkhcf
+U+9xEMCOHcILSQ3cx3xLeW6pWXyPJAJUX2Y2+SvmX5lypYRZSg2DE0mVKjEV7M6Q
+cKqIo+vqrcVhOpJf9y43ZkzNnLczxNuILlHBWJsCgYAyOmZPuCCjoE55g1Sa8hNW
+ma03PDGqT8PsxNE/yxmx8Y3E3fguQhVxcy5vJOVacF+Rqb9mvFDhWQvNQD4qnlrl
+7Bm+XzyhtS7p4Xk0jfwXndMry1rjRz84b5uw20khMs21WC6CeWLwW9AttGG3Drkd
+rvIynrE5JQLoHQZCaDhHwwKBgCPgUQiMIPltmGuKSqvnNQIZViw22631+eADto4J
+C8B+5LSkW+67A2Yhd9+aVYqg05AwWkebKxoYfi8wht7keOrQO3jIMYINu43U7fVA
+jzZGSDf63xoe+SnQ9PvHNjRnHjoPnk+b2V1EXnJRMqGwWGpty0tM0qLEbN8ltLW7
+bFS9AoGARqPSEW0PpLxW5m8fnfPRVWwpTuhhWm0fkw13O8cUVIVf3E6g+MF2I9wf
+v8yPDFyh5myoCzy8aFy4eSFeWzYTahsLDq03EyYuqIGoTJrcls9dmpxhRdPjwywJ
+Yll894/fpK2lWI54kCEh+jRE3+S+4D3zi2txta/tu7Z891eQ5sI=
+-----END RSA PRIVATE KEY-----

package/src/plugin/concurrencyMsg.js

@@ -1,8 +1,8 @@
-'use strict';
-const chalk = require('chalk');
-const MSG = `
-Important notice: Your Applitools visual tests are currently running with a testConcurrency value of 5.
-This means that only up to 5 visual tests can run in parallel, and therefore the execution might be slower.
-If your Applitools license supports a higher concurrency level, learn how to configure it here: https://www.npmjs.com/package/@applitools/eyes-cypress#concurrency.
-Need a higher concurrency in your account? Email us @ sdr@applitools.com with your required concurrency level.`;
-module.exports = {concurrencyMsg: chalk.yellow(MSG), msgText: MSG};
+'use strict';
+const chalk = require('chalk');
+const MSG = `
+Important notice: Your Applitools visual tests are currently running with a testConcurrency value of 5.
+This means that only up to 5 visual tests can run in parallel, and therefore the execution might be slower.
+If your Applitools license supports a higher concurrency level, learn how to configure it here: https://www.npmjs.com/package/@applitools/eyes-cypress#concurrency.
+Need a higher concurrency in your account? Email us @ sdr@applitools.com with your required concurrency level.`;
+module.exports = {concurrencyMsg: chalk.yellow(MSG), msgText: MSG};

package/src/plugin/config.js

@@ -1,53 +1,54 @@
-'use strict';
-const {configParams, ConfigUtils, TypeUtils} = require('@applitools/visual-grid-client');
-const {version: packageVersion} = require('../../package.json');
-const agentId = `eyes-cypress/${packageVersion}`;
-const DEFAULT_TEST_CONCURRENCY = 5;
-
-function makeConfig() {
-  const config = Object.assign(
-    {agentId},
-    ConfigUtils.getConfig({
-      configParams: [
-        ...configParams,
-        'failCypressOnDiff',
-        'tapDirPath',
-        'disableBrowserFetching',
-        'testConcurrency',
-      ],
-    }),
-  );
-
-  if (config.failCypressOnDiff === '0') {
-    config.failCypressOnDiff = false;
-  }
-
-  if (TypeUtils.isString(config.showLogs)) {
-    config.showLogs = config.showLogs === 'true' || config.showLogs === '1';
-  }
-
-  if (TypeUtils.isString(config.testConcurrency)) {
-    config.testConcurrency = Number(config.testConcurrency);
-  }
-
-  if (config.accessibilityValidation) {
-    config.accessibilitySettings = config.accessibilityValidation;
-    delete config.accessiblityValidation;
-  }
-
-  const eyesConfig = {
-    tapDirPath: config.tapDirPath,
-    eyesIsDisabled: !!config.isDisabled,
-    eyesBrowser: JSON.stringify(config.browser),
-    eyesLayoutBreakpoints: JSON.stringify(config.layoutBreakpoints),
-    eyesFailCypressOnDiff:
-      config.failCypressOnDiff === undefined ? true : !!config.failCypressOnDiff,
-    eyesDisableBrowserFetching: !!config.disableBrowserFetching,
-    eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
-    eyesWaitBeforeCapture: config.waitBeforeCapture,
-  };
-
-  return {config, eyesConfig};
-}
-
-module.exports = makeConfig;
+'use strict';
+const {configParams, ConfigUtils, TypeUtils} = require('@applitools/visual-grid-client');
+const DEFAULT_TEST_CONCURRENCY = 5;
+const uuid = require('uuid');
+
+function makeConfig() {
+  const config = ConfigUtils.getConfig({
+    configParams: [
+      ...configParams,
+      'failCypressOnDiff',
+      'tapDirPath',
+      'tapFileName',
+      'disableBrowserFetching',
+      'testConcurrency',
+    ],
+  });
+
+  if (!config.batch || !config.batch.id) {
+    config.batch = {id: uuid.v4(), ...config.batch};
+  }
+  if (config.failCypressOnDiff === '0') {
+    config.failCypressOnDiff = false;
+  }
+
+  if (TypeUtils.isString(config.showLogs)) {
+    config.showLogs = config.showLogs === 'true' || config.showLogs === '1';
+  }
+
+  if (TypeUtils.isString(config.testConcurrency)) {
+    config.testConcurrency = Number(config.testConcurrency);
+  }
+
+  if (config.accessibilityValidation) {
+    config.accessibilitySettings = config.accessibilityValidation;
+    delete config.accessiblityValidation;
+  }
+
+  const eyesConfig = {
+    tapDirPath: config.tapDirPath,
+    tapFileName: config.tapFileName,
+    eyesIsDisabled: !!config.isDisabled,
+    eyesBrowser: JSON.stringify(config.browser),
+    eyesLayoutBreakpoints: JSON.stringify(config.layoutBreakpoints),
+    eyesFailCypressOnDiff:
+      config.failCypressOnDiff === undefined ? true : !!config.failCypressOnDiff,
+    eyesDisableBrowserFetching: !!config.disableBrowserFetching,
+    eyesTestConcurrency: config.testConcurrency || DEFAULT_TEST_CONCURRENCY,
+    eyesWaitBeforeCapture: config.waitBeforeCapture,
+  };
+
+  return {config, eyesConfig};
+}
+
+module.exports = makeConfig;

package/src/plugin/defaultPort.js

@@ -1 +1 @@
-module.exports = 7373;
+module.exports = 7373;