@percy/core 1.27.5-alpha.0 → 1.27.6-alpha.0

package/dist/api.js

@@ -3,7 +3,7 @@ import path from 'path';
 import { createRequire } from 'module';
 import logger from '@percy/logger';
 import { normalize } from '@percy/config/utils';
-import { getPackageJSON, Server, percyAutomateRequestHandler } from './utils.js';
+import { getPackageJSON, Server, percyAutomateRequestHandler, percyBuildEventHandler } from './utils.js';
 import WebdriverUtils from '@percy/webdriver-utils';
 // need require.resolve until import.meta.resolve can be transpiled
 export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom');
@@ -144,6 +144,15 @@ export function createPercyServer(percy, port) {
       success: true
     });
   })
+  // Recieves events from sdk's.
+  .route('post', '/percy/events', async (req, res) => {
+    var _percy$build2;
+    const body = percyBuildEventHandler(req, pkg.version);
+    await percy.client.sendBuildEvents((_percy$build2 = percy.build) === null || _percy$build2 === void 0 ? void 0 : _percy$build2.id, body);
+    res.json(200, {
+      success: true
+    });
+  })
   // stops percy at the end of the current event loop
   .route('/percy/stop', (req, res) => {
     setImmediate(() => percy.stop());

package/dist/config.js

@@ -47,9 +47,15 @@ export const configSchema = {
         type: 'boolean',
         default: false
       },
+      enableLayout: {
+        type: 'boolean'
+      },
       domTransformation: {
         type: 'string'
       },
+      reshuffleInvalidTags: {
+        type: 'boolean'
+      },
       scope: {
         type: 'string'
       },
@@ -280,6 +286,12 @@ export const snapshotSchema = {
         domTransformation: {
           $ref: '/config/snapshot#/properties/domTransformation'
         },
+        enableLayout: {
+          $ref: '/config/snapshot#/properties/enableLayout'
+        },
+        reshuffleInvalidTags: {
+          $ref: '/config/snapshot#/properties/reshuffleInvalidTags'
+        },
         discovery: {
           type: 'object',
           additionalProperties: false,
@@ -524,6 +536,12 @@ export const snapshotSchema = {
                     }
                   }
                 }
+              },
+              hints: {
+                type: 'array',
+                items: {
+                  type: 'string'
+                }
               }
             }
           }]

package/dist/discovery.js

@@ -26,6 +26,9 @@ function debugSnapshotOptions(snapshot) {
   debugProp(snapshot, 'enableJavaScript');
   debugProp(snapshot, 'cliEnableJavaScript');
   debugProp(snapshot, 'disableShadowDOM');
+  debugProp(snapshot, 'enableLayout');
+  debugProp(snapshot, 'domTransformation');
+  debugProp(snapshot, 'reshuffleInvalidTags');
   debugProp(snapshot, 'deviceScaleFactor');
   debugProp(snapshot, 'waitForTimeout');
   debugProp(snapshot, 'waitForSelector');
@@ -101,6 +104,7 @@ function processSnapshotResources({
   ...snapshot
 }) {
   var _resources;
+  let log = logger('core:snapshot');
   resources = [...(((_resources = resources) === null || _resources === void 0 ? void 0 : _resources.values()) ?? [])];
 
   // find any root resource matching the provided dom snapshot
@@ -119,6 +123,11 @@ function processSnapshotResources({
 
   // inject Percy CSS
   if (snapshot.percyCSS) {
+    // check @percy/dom/serialize-dom.js
+    let domSnapshotHints = (domSnapshot === null || domSnapshot === void 0 ? void 0 : domSnapshot.hints) ?? [];
+    if (domSnapshotHints.includes('DOM elements found outside </body>')) {
+      log.warn('DOM elements found outside </body>, percyCSS might not work');
+    }
     let css = createPercyCSSResource(root.url, snapshot.percyCSS);
     resources.push(css);
 
@@ -270,7 +279,7 @@ export function createDiscoveryQueue(percy) {
   let {
     concurrency
   } = percy.config.discovery;
-  let queue = new Queue();
+  let queue = new Queue('discovery');
   let cache;
   return queue.set({
     concurrency

package/dist/page.js

@@ -146,7 +146,8 @@ export class Page {
       width,
       enableJavaScript,
       disableShadowDOM,
-      domTransformation
+      domTransformation,
+      reshuffleInvalidTags
     } = snapshot;
     this.log.debug(`Taking snapshot: ${name}${width ? ` @${width}px` : ''}`, this.meta);
 
@@ -191,7 +192,8 @@ export class Page {
     }), {
       enableJavaScript,
       disableShadowDOM,
-      domTransformation
+      domTransformation,
+      reshuffleInvalidTags
     });
     return {
       ...snapshot,

package/dist/queue.js

@@ -9,6 +9,7 @@ function _classPrivateFieldGet(receiver, privateMap) { var descriptor = _classEx
 function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
 function _classApplyDescriptorGet(receiver, descriptor) { if (descriptor.get) { return descriptor.get.call(receiver); } return descriptor.value; }
 import { yieldFor, generatePromise, AbortController } from './utils.js';
+import logger from '@percy/logger';
 
 // Assigns a deffered promise and resolve & reject functions to an object
 function deferred(obj) {
@@ -46,12 +47,15 @@ var _end = /*#__PURE__*/new WeakMap();
 var _process = /*#__PURE__*/new WeakSet();
 var _until = /*#__PURE__*/new WeakSet();
 export class Queue {
-  constructor() {
+  // item concurrency
+
+  constructor(name) {
     _classPrivateMethodInitSpec(this, _until);
     _classPrivateMethodInitSpec(this, _process);
     _classPrivateMethodInitSpec(this, _find);
     _classPrivateMethodInitSpec(this, _dequeue);
     _defineProperty(this, "concurrency", 10);
+    _defineProperty(this, "log", logger('core:queue'));
     _classPrivateFieldInitSpec(this, _handlers, {
       writable: true,
       value: {}
@@ -73,7 +77,9 @@ export class Queue {
       value: null
     });
     _defineProperty(this, "readyState", 0);
+    this.name = name;
   }
+
   // Configure queue properties
   set({
     concurrency
@@ -201,6 +207,7 @@ export class Queue {
   // clear and abort any queued tasks
   clear() {
     let tasks = [..._classPrivateFieldGet(this, _queued)];
+    this.log.debug(`Clearing ${this.name} queue, queued state: ${_classPrivateFieldGet(this, _queued).size}, pending state: ${_classPrivateFieldGet(this, _pending).size}`);
     _classPrivateFieldGet(this, _queued).clear();
     for (let task of tasks) {
       task.ctrl.abort();
@@ -235,6 +242,7 @@ export class Queue {
   // process items up to the latest queued item, starting the queue if necessary;
   // returns a generator that yields until the flushed item has finished processing
   flush(callback) {
+    this.log.debug(`Flushing ${this.name} queue, queued state: ${_classPrivateFieldGet(this, _queued).size}, pending state: ${_classPrivateFieldGet(this, _pending).size}`);
     let interrupt =
     // check for existing interrupts
     [..._classPrivateFieldGet(this, _pending)].find(t => t.stop) ?? [..._classPrivateFieldGet(this, _queued)].find(t => t.stop);
@@ -317,9 +325,11 @@ async function* _until2(task, callback) {
       // calculate the position within queued when not pending
       if (task && task.pending == null) queued = positionOf(_classPrivateFieldGet(this, _queued), task);
       // calculate the position within pending when not stopping
-      if (!(task !== null && task !== void 0 && task.stop) && (task === null || task === void 0 ? void 0 : task.pending) != null) pending = positionOf(_classPrivateFieldGet(this, _pending), task);
+      // Commenting below line reason being currently if the task passed is found we will stop flushing
+      // rest of the tasks but ideally it should wait for flushing of all the tasks till the last dequeued task.
+      // if (!task?.stop && task?.pending != null) pending = positionOf(this.#pending, task);
       // call the callback and return true when not queued or pending
-      let position = (queued ?? 0) + (pending ?? 0);
+      let position = (queued ?? 0) + pending;
       callback === null || callback === void 0 ? void 0 : callback(position);
       return !position;
     }, {

package/dist/snapshot.js

@@ -318,7 +318,7 @@ export function createSnapshotsQueue(percy) {
   let {
     concurrency
   } = percy.config.discovery;
-  let queue = new Queue();
+  let queue = new Queue('snapshot');
   let build;
   return queue.set({
     concurrency

package/dist/utils.js

@@ -55,6 +55,40 @@ export function percyAutomateRequestHandler(req, percy) {
   req.body.buildInfo = percy.build;
 }
 
+// Returns the body for sendEvent structure
+export function percyBuildEventHandler(req, cliVersion) {
+  if (Array.isArray(req.body)) {
+    return req.body.map(item => processSendEventData(item, cliVersion));
+  } else {
+    // Treat the input as an object and perform instructions
+    return processSendEventData(req.body, cliVersion);
+  }
+}
+
+// Process sendEvent object
+function processSendEventData(input, cliVersion) {
+  // Add Properties here to send to eventData
+  const allowedEventProperties = ['message', 'cliVersion', 'clientInfo', 'errorKind', 'extra'];
+  const extractedData = {};
+  for (const property of allowedEventProperties) {
+    if (Object.prototype.hasOwnProperty.call(input, property)) {
+      extractedData[property] = input[property];
+    }
+  }
+  if (extractedData.clientInfo) {
+    const [client, clientVersion] = extractedData.clientInfo.split('/');
+
+    // Add the client and clientVersion fields to the object
+    extractedData.client = client;
+    extractedData.clientVersion = clientVersion;
+    delete extractedData.clientInfo;
+  }
+  if (!input.cliVersion) {
+    extractedData.cliVersion = cliVersion;
+  }
+  return extractedData;
+}
+
 // Creates a local resource object containing the resource URL, mimetype, content, sha, and any
 // other additional resources attributes.
 export function createResource(url, content, mimetype, attrs) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.27.5-alpha.0",
+  "version": "1.27.6-alpha.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -43,11 +43,11 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.27.5-alpha.0",
-    "@percy/config": "1.27.5-alpha.0",
-    "@percy/dom": "1.27.5-alpha.0",
-    "@percy/logger": "1.27.5-alpha.0",
-    "@percy/webdriver-utils": "1.27.5-alpha.0",
+    "@percy/client": "1.27.6-alpha.0",
+    "@percy/config": "1.27.6-alpha.0",
+    "@percy/dom": "1.27.6-alpha.0",
+    "@percy/logger": "1.27.6-alpha.0",
+    "@percy/webdriver-utils": "1.27.6-alpha.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -58,5 +58,5 @@
     "rimraf": "^3.0.2",
     "ws": "^8.0.0"
   },
-  "gitHead": "8ecc32db25f708a01192b8454d0fdf9c051f48a0"
+  "gitHead": "415a083dc13e9453990b042a41d6676f6618df0c"
 }

package/types/index.d.ts

@@ -39,6 +39,9 @@ interface CommonSnapshotOptions {
   percyCSS?: string;
   enableJavaScript?: boolean;
   disableShadowDOM?: boolean;
+  enableLayout?: boolean;
+  domTransformation?: string;
+  reshuffleInvalidTags?: boolean;
   devicePixelRatio?: number;
   scope?: string;
 }