@percy/core 1.30.8 → 1.30.9-alpha-1.0

package/dist/config.js

@@ -26,6 +26,33 @@ export const configSchema = {
   snapshot: {
     type: 'object',
     additionalProperties: false,
+    definitions: {
+      configurationProperties: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          diffSensitivity: {
+            type: 'integer',
+            minimum: 0,
+            maximum: 4
+          },
+          imageIgnoreThreshold: {
+            type: 'number',
+            minimum: 0,
+            maximum: 1
+          },
+          carouselsEnabled: {
+            type: 'boolean'
+          },
+          bannersEnabled: {
+            type: 'boolean'
+          },
+          adsEnabled: {
+            type: 'boolean'
+          }
+        }
+      }
+    },
     properties: {
       widths: {
         type: 'array',
@@ -164,6 +191,88 @@ export const configSchema = {
             }
           }
         }
+      },
+      regions: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            elementSelector: {
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                boundingBox: {
+                  type: 'object',
+                  additionalProperties: false,
+                  properties: {
+                    x: {
+                      type: 'integer'
+                    },
+                    y: {
+                      type: 'integer'
+                    },
+                    width: {
+                      type: 'integer'
+                    },
+                    height: {
+                      type: 'integer'
+                    }
+                  }
+                },
+                elementXpath: {
+                  type: 'string'
+                },
+                elementCSS: {
+                  type: 'string'
+                }
+              }
+            },
+            padding: {
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                top: {
+                  type: 'integer'
+                },
+                bottom: {
+                  type: 'integer'
+                },
+                left: {
+                  type: 'integer'
+                },
+                right: {
+                  type: 'integer'
+                }
+              }
+            },
+            algorithm: {
+              type: 'string',
+              enum: ['standard', 'layout', 'ignore', 'intelliignore']
+            },
+            configuration: {
+              $ref: '#/definitions/configurationProperties'
+            },
+            assertion: {
+              type: 'object',
+              additionalProperties: false,
+              properties: {
+                diffIgnoreThreshold: {
+                  type: 'number',
+                  minimum: 0,
+                  maximum: 1
+                }
+              }
+            }
+          },
+          required: ['algorithm']
+        }
+      },
+      algorithm: {
+        type: 'string',
+        enum: ['standard', 'layout', 'intelliignore']
+      },
+      algorithmConfiguration: {
+        $ref: '#/definitions/configurationProperties'
       }
     }
   },
@@ -370,6 +479,15 @@ export const snapshotSchema = {
         reshuffleInvalidTags: {
           $ref: '/config/snapshot#/properties/reshuffleInvalidTags'
         },
+        regions: {
+          $ref: '/config/snapshot#/properties/regions'
+        },
+        algorithm: {
+          $ref: '/config/snapshot#/properties/algorithm'
+        },
+        algorithmConfiguration: {
+          $ref: '/config/snapshot#/properties/algorithmConfiguration'
+        },
         scopeOptions: {
           $ref: '/config/snapshot#/properties/scopeOptions'
         },
@@ -913,6 +1031,15 @@ export const comparisonSchema = {
         ignoreElementsData: regionsSchema
       }
     },
+    regions: {
+      $ref: '/config/snapshot#/properties/regions'
+    },
+    algorithm: {
+      $ref: '/config/snapshot#/properties/algorithm'
+    },
+    algorithmConfiguration: {
+      $ref: '/config/snapshot#/properties/algorithmConfiguration'
+    },
     consideredElementsData: {
       type: 'object',
       additionalProperties: false,

package/dist/network.js

@@ -491,6 +491,7 @@ async function makeDirectRequest(network, request, session) {
 
 // Save a resource from a request, skipping it if specific paramters are not met
 async function saveResponseResource(network, request, session) {
+  var _response$headers;
   let {
     disableCache,
     allowedHostnames,
@@ -507,7 +508,8 @@ async function saveResponseResource(network, request, session) {
   // Checing for content length more than 100MB, to prevent websocket error which is governed by
   // maxPayload option of websocket defaulted to 100MB.
   // If content-length is more than our allowed 25MB, no need to process that resouce we can return log.
-  let contentLength = parseInt(response.headers['Content-Length']);
+  let contentLength = (_response$headers = response.headers) === null || _response$headers === void 0 ? void 0 : _response$headers[Object.keys(response.headers).find(key => key.toLowerCase() === 'content-length')];
+  contentLength = parseInt(contentLength);
   if (contentLength > MAX_RESOURCE_SIZE) {
     return log.debug('- Skipping resource larger than 25MB', meta);
   }
@@ -527,6 +529,9 @@ async function saveResponseResource(network, request, session) {
         return log.debug('- Skipping remote resource', meta);
       } else if (!body.length) {
         return log.debug('- Skipping empty response', meta);
+      } else if (body.length > MAX_RESOURCE_SIZE) {
+        log.debug('- Missing headers for the requested resource.', meta);
+        return log.debug('- Skipping resource larger than 25MB', meta);
       } else if (!ALLOWED_STATUSES.includes(response.status)) {
         return log.debug(`- Skipping disallowed status [${response.status}]`, meta);
       } else if (!enableJavaScript && !ALLOWED_RESOURCES.includes(request.type)) {

package/dist/queue.js

@@ -115,6 +115,13 @@ export class Queue {
     // return the deferred task promise
     return task.deferred;
   }
+  logQueueSize() {
+    this.log.debug(`${this.name} queueInfo: ${JSON.stringify({
+      queued: _classPrivateFieldGet(_queued, this).size,
+      pending: _classPrivateFieldGet(_pending, this).size,
+      total: _classPrivateFieldGet(_pending, this).size + _classPrivateFieldGet(_queued, this).size
+    })}`);
+  }
   // Cancels and aborts a specific item task.
   cancel(item) {
     let task = _assertClassBrand(_Queue_brand, this, _find).call(this, item);
@@ -243,6 +250,7 @@ export class Queue {
   // Repeatedly yields, calling the callback with the position of the task within the queue
 }
 function _dequeue() {
+  this.logQueueSize();
   if (!_classPrivateFieldGet(_queued, this).size || this.readyState < 2) return;
   if (_classPrivateFieldGet(_pending, this).size >= this.concurrency) return;
   let [task] = _classPrivateFieldGet(_queued, this);

package/dist/snapshot.js

@@ -3,7 +3,7 @@ import PercyConfig from '@percy/config';
 import micromatch from 'micromatch';
 import { configSchema } from './config.js';
 import Queue from './queue.js';
-import { request, hostnameMatches, yieldTo, snapshotLogName, decodeAndEncodeURLWithLogging, compareObjectTypes } from './utils.js';
+import { request, hostnameMatches, yieldTo, snapshotLogName, decodeAndEncodeURLWithLogging, compareObjectTypes, normalizeOptions } from './utils.js';
 import { JobData } from './wait-for-job.js';
 
 // Throw a better error message for missing or invalid urls
@@ -192,9 +192,9 @@ function getSnapshotOptions(options, {
 export function validateSnapshotOptions(options) {
   var _migrated$baseUrl, _migrated$domSnapshot;
   let log = logger('core:snapshot');
-
   // decide which schema to validate against
   let schema = ['domSnapshot', 'dom-snapshot', 'dom_snapshot'].some(k => k in options) && '/snapshot/dom' || 'url' in options && '/snapshot' || 'sitemap' in options && '/snapshot/sitemap' || 'serve' in options && '/snapshot/server' || 'snapshots' in options && '/snapshot/list' || '/snapshot';
+  options = normalizeOptions(options);
   let {
     // normalize, migrate, and remove certain properties from validating
     clientInfo,
@@ -226,7 +226,6 @@ export function validateSnapshotOptions(options) {
     log.warn('Encountered snapshot serialization warnings:');
     for (let w of domWarnings) log.warn(`- ${w}`);
   }
-
   // warn on validation errors
   let errors = PercyConfig.validate(migrated, schema);
   if ((errors === null || errors === void 0 ? void 0 : errors.length) > 0) {

package/dist/utils.js

@@ -52,6 +52,9 @@ export function percyAutomateRequestHandler(req, percy) {
     ignoreRegionXpaths: (_percy$config$snapsho4 = percy.config.snapshot.ignoreRegions) === null || _percy$config$snapsho4 === void 0 ? void 0 : _percy$config$snapsho4.ignoreRegionXpaths,
     considerRegionSelectors: (_percy$config$snapsho5 = percy.config.snapshot.considerRegions) === null || _percy$config$snapsho5 === void 0 ? void 0 : _percy$config$snapsho5.considerRegionSelectors,
     considerRegionXpaths: (_percy$config$snapsho6 = percy.config.snapshot.considerRegions) === null || _percy$config$snapsho6 === void 0 ? void 0 : _percy$config$snapsho6.considerRegionXpaths,
+    regions: percy.config.snapshot.regions,
+    algorithm: percy.config.snapshot.algorithm,
+    algorithmConfiguration: percy.config.snapshot.algorithmConfiguration,
     sync: percy.config.snapshot.sync,
     version: 'v2'
   }, camelCasedOptions], (path, prev, next) => {
@@ -540,4 +543,31 @@ export function compareObjectTypes(obj1, obj2) {
     if (!keys2.includes(key) || !compareObjectTypes(obj1[key], obj2[key])) return false;
   }
   return true;
+}
+const OPTION_MAPPINGS = {
+  name: 'name',
+  widths: 'widths',
+  scope: 'scope',
+  scopeoptions: 'scopeOptions',
+  minheight: 'minHeight',
+  enablejavascript: 'enableJavaScript',
+  enablelayout: 'enableLayout',
+  clientinfo: 'clientInfo',
+  environmentinfo: 'environmentInfo',
+  sync: 'sync',
+  testcase: 'testCase',
+  labels: 'labels',
+  thtestcaseexecutionid: 'thTestCaseExecutionId',
+  resources: 'resources',
+  meta: 'meta',
+  snapshot: 'snapshot'
+};
+export function normalizeOptions(options) {
+  const normalizedOptions = {};
+  for (const key in options) {
+    const lowerCaseKey = key.toLowerCase().replace(/[-_]/g, '');
+    const normalizedKey = OPTION_MAPPINGS[lowerCaseKey] ? OPTION_MAPPINGS[lowerCaseKey] : key;
+    normalizedOptions[normalizedKey] = options[key];
+  }
+  return normalizedOptions;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.30.8",
+  "version": "1.30.9-alpha-1.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "alpha"
   },
   "engines": {
     "node": ">=14"
@@ -43,12 +43,12 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.30.8",
-    "@percy/config": "1.30.8",
-    "@percy/dom": "1.30.8",
-    "@percy/logger": "1.30.8",
-    "@percy/monitoring": "1.30.8",
-    "@percy/webdriver-utils": "1.30.8",
+    "@percy/client": "1.30.9-alpha-1.0",
+    "@percy/config": "1.30.9-alpha-1.0",
+    "@percy/dom": "1.30.9-alpha-1.0",
+    "@percy/logger": "1.30.9-alpha-1.0",
+    "@percy/monitoring": "1.30.9-alpha-1.0",
+    "@percy/webdriver-utils": "1.30.9-alpha-1.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -61,5 +61,5 @@
     "ws": "^8.17.1",
     "yaml": "^2.4.1"
   },
-  "gitHead": "daa3c96d70488a49671e48427c9b363c68876935"
+  "gitHead": "c9741e74fdbd7d2c152bcdcb619e9b5c1da13be6"
 }

package/test/helpers/server.js

@@ -1,18 +1,25 @@
 // aliased to src during tests
 import Server from '../../dist/server.js';
 
-export function createTestServer({ default: defaultReply, ...replies }, port = 8000) {
+export function createTestServer({ default: defaultReply, ...replies }, port = 8000, options = {}) {
   let server = new Server();
 
   // alternate route handling
-  let handleReply = reply => async (req, res) => {
+  let handleReply = (reply, options = {}) => async (req, res) => {
     let [status, headers, body] = typeof reply === 'function' ? await reply(req) : reply;
     if (!Buffer.isBuffer(body) && typeof body !== 'string') body = JSON.stringify(body);
+
+    if (options.noHeaders) {
+      return res.writeHead(status).end(body);
+    }
+    if (options.headersOverride) {
+      headers = { ...headers, ...options.headersOverride };
+    }
     return res.send(status, headers, body);
   };
 
   // map replies to alternate route handlers
-  server.reply = (p, reply) => (replies[p] = handleReply(reply), null);
+  server.reply = (p, reply, options = {}) => (replies[p] = handleReply(reply, options), null);
   for (let [p, reply] of Object.entries(replies)) server.reply(p, reply);
   if (defaultReply) defaultReply = handleReply(defaultReply);