@percy/core 1.14.0 → 1.15.0

package/dist/config.js

@@ -396,11 +396,47 @@ export const snapshotSchema = {
         name: {
           type: 'string'
         },
-        domSnapshot: {
-          type: 'string'
-        },
         width: {
           $ref: '/config/snapshot#/properties/widths/items'
+        },
+        domSnapshot: {
+          oneOf: [{
+            type: 'string'
+          }, {
+            type: 'object',
+            required: ['html'],
+            unevaluatedProperties: false,
+            properties: {
+              html: {
+                type: 'string'
+              },
+              warnings: {
+                type: 'array',
+                items: {
+                  type: 'string'
+                }
+              },
+              resources: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  required: ['url', 'content', 'mimetype'],
+                  unevaluatedProperties: false,
+                  properties: {
+                    url: {
+                      type: 'string'
+                    },
+                    content: {
+                      type: 'string'
+                    },
+                    mimetype: {
+                      type: 'string'
+                    }
+                  }
+                }
+              }
+            }
+          }]
         }
       },
       errors: {
@@ -514,12 +550,13 @@ export const comparisonSchema = {
         },
         width: {
           type: 'integer',
-          maximum: 2000,
-          minimum: 120
+          minimum: 1,
+          maximum: 10000
         },
         height: {
           type: 'integer',
-          minimum: 10
+          minimum: 1,
+          maximum: 10000
         },
         orientation: {
           type: 'string',

package/dist/discovery.js

@@ -1,6 +1,6 @@
 import logger from '@percy/logger';
 import Queue from './queue.js';
-import { normalizeURL, hostnameMatches, createRootResource, createPercyCSSResource, createLogResource, yieldAll } from './utils.js';
+import { normalizeURL, hostnameMatches, createResource, createRootResource, createPercyCSSResource, createLogResource, yieldAll } from './utils.js';
 
 // Logs verbose debug logs detailing various snapshot options.
 function debugSnapshotOptions(snapshot) {
@@ -58,6 +58,39 @@ function waitForDiscoveryNetworkIdle(page, options) {
   return page.network.idle(filter, networkIdleTimeout);
 }
 
+// Creates an initial resource map for a snapshot containing serialized DOM
+function parseDomResources({
+  url,
+  domSnapshot
+}) {
+  if (!domSnapshot) return new Map();
+  let isHTML = typeof domSnapshot === 'string';
+  let {
+    html,
+    resources = []
+  } = isHTML ? {
+    html: domSnapshot
+  } : domSnapshot;
+  let rootResource = createRootResource(url, html);
+
+  // reduce the array of resources into a keyed map
+  return resources.reduce((map, {
+    url,
+    content,
+    mimetype
+  }) => {
+    // serialized resource contents are base64 encoded
+    content = Buffer.from(content, 'base64');
+    // specify the resource as provided to prevent overwriting during asset discovery
+    let resource = createResource(url, content, mimetype, {
+      provided: true
+    });
+    // key the resource by its url and return the map
+    return map.set(resource.url, resource);
+    // the initial map is created with at least a root resource
+  }, new Map([[rootResource.url, rootResource]]));
+}
+
 // Calls the provided callback with additional resources
 function processSnapshotResources({
   domSnapshot,
@@ -67,11 +100,18 @@ function processSnapshotResources({
   var _resources;
   resources = [...(((_resources = resources) === null || _resources === void 0 ? void 0 : _resources.values()) ?? [])];
 
-  // find or create a root resource if one does not exist
-  let root = resources.find(r => r.content === domSnapshot);
+  // find any root resource matching the provided dom snapshot
+  let rootContent = (domSnapshot === null || domSnapshot === void 0 ? void 0 : domSnapshot.html) ?? domSnapshot;
+  let root = resources.find(r => r.content === rootContent);
+
+  // initialize root resources if needed
   if (!root) {
-    root = createRootResource(snapshot.url, domSnapshot);
-    resources.unshift(root);
+    let domResources = parseDomResources({
+      ...snapshot,
+      domSnapshot
+    });
+    resources = [...domResources.values(), ...resources];
+    root = resources[0];
   }
 
   // inject Percy CSS
@@ -247,14 +287,9 @@ export function createDiscoveryQueue(percy) {
     name,
     widths
   }, snapshot) => snapshot.name === name && (!percy.deferUploads || !widths || widths.join() === snapshot.widths.join()))
-  // initialize the root resource for DOM snapshots
+  // initialize the resources for DOM snapshots
   .handle('push', snapshot => {
-    let {
-      url,
-      domSnapshot
-    } = snapshot;
-    let root = domSnapshot && createRootResource(url, domSnapshot);
-    let resources = new Map(root ? [[root.url, root]] : []);
+    let resources = parseDomResources(snapshot);
     return {
       ...snapshot,
       resources

package/dist/network.js

@@ -290,7 +290,7 @@ async function sendResponseResource(network, request, session) {
         requestId: request.interceptId,
         errorReason: 'Aborted'
       });
-    } else if (resource && (resource.root || !disableCache)) {
+    } else if (resource && (resource.root || resource.provided || !disableCache)) {
       log.debug(resource.root ? '- Serving root resource' : '- Resource cache hit', meta);
       await session.send('Fetch.fulfillRequest', {
         requestId: request.interceptId,
@@ -356,7 +356,7 @@ async function saveResponseResource(network, request) {
     url
   };
   let resource = network.intercept.getResource(url);
-  if (!resource || !resource.root && disableCache) {
+  if (!resource || !resource.root && !resource.provided && disableCache) {
     try {
       log.debug(`Processing resource: ${url}`, meta);
       let shouldCapture = response && hostnameMatches(allowedHostnames, url);

package/dist/snapshot.js

@@ -163,7 +163,9 @@ function getSnapshotOptions(options, {
 // properties. Eagerly throws an error when missing a URL for any snapshot, and warns about all
 // other invalid options which are also scrubbed from the returned migrated options.
 export function validateSnapshotOptions(options) {
-  var _migrated$baseUrl;
+  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';
   let {
@@ -185,10 +187,22 @@ export function validateSnapshotOptions(options) {
 
   // add back snapshots before validating and scrubbing; function snapshots are validated later
   if (snapshots) migrated.snapshots = typeof snapshots === 'function' ? [] : snapshots;else if (!isSnapshot && options.snapshots) migrated.snapshots = [];
+
+  // parse json dom snapshots
+  if (schema === '/snapshot/dom' && typeof migrated.domSnapshot === 'string' && migrated.domSnapshot.startsWith('{') && migrated.domSnapshot.endsWith('}')) {
+    migrated.domSnapshot = JSON.parse(migrated.domSnapshot);
+  }
+
+  // log warnings encountered during dom serialization
+  let domWarnings = ((_migrated$domSnapshot = migrated.domSnapshot) === null || _migrated$domSnapshot === void 0 ? void 0 : _migrated$domSnapshot.warnings) || [];
+  if (domWarnings.length) {
+    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) {
-    // warn on validation errors
-    let log = logger('core:snapshot');
     log.warn('Invalid snapshot options:');
     for (let e of errors) log.warn(`- ${e.path}: ${e.message}`);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,10 +39,10 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.14.0",
-    "@percy/config": "1.14.0",
-    "@percy/dom": "1.14.0",
-    "@percy/logger": "1.14.0",
+    "@percy/client": "1.15.0",
+    "@percy/config": "1.15.0",
+    "@percy/dom": "1.15.0",
+    "@percy/logger": "1.15.0",
     "content-disposition": "^0.5.4",
     "cross-spawn": "^7.0.3",
     "extract-zip": "^2.0.1",
@@ -53,5 +53,5 @@
     "rimraf": "^3.0.2",
     "ws": "^8.0.0"
   },
-  "gitHead": "fd72688e449d6dd3eafd346fc07879cb3bb01a4e"
+  "gitHead": "383ce2888d2e4fe6972368f9bbe8580b23431a98"
 }