@percy/core 1.3.0 → 1.5.0

package/dist/api.js

@@ -2,14 +2,13 @@ import fs from 'fs';
 import path from 'path';
 import { createRequire } from 'module';
 import logger from '@percy/logger';
-import { getPackageJSON } from './utils.js';
-import Server from './server.js'; // need require.resolve until import.meta.resolve can be transpiled
+import { getPackageJSON, Server } from './utils.js'; // need require.resolve until import.meta.resolve can be transpiled
 
 export const PERCY_DOM = createRequire(import.meta.url).resolve('@percy/dom'); // Create a Percy CLI API server instance
 
 export function createPercyServer(percy, port) {
   let pkg = getPackageJSON(import.meta.url);
-  return new Server({
+  return Server.createServer({
     port
   }) // facilitate logger websocket connections
   .websocket('/(logger)?', ws => {
@@ -83,14 +82,10 @@ export function createPercyServer(percy, port) {
 
 export function createStaticServer(options) {
   let {
-    serve,
-    port,
-    baseUrl = '/',
-    ...opts
+    serve: dir,
+    baseUrl = '/'
   } = options;
-  let server = new Server({
-    port
-  }).serve(baseUrl, serve, opts); // used when generating an automatic sitemap
+  let server = Server.createServer(options); // used when generating an automatic sitemap
 
   let toURL = Server.createRewriter( // reverse rewrites' src, dest, & order
   Object.entries((options === null || options === void 0 ? void 0 : options.rewrites) ?? {}).reduce((acc, rw) => [rw.reverse(), ...acc], []), (filename, rewrite) => new URL(path.posix.join(baseUrl, // cleanUrls will trim trailing .html/index.html from paths
@@ -101,7 +96,7 @@ export function createStaticServer(options) {
       default: glob
     } = await import('fast-glob');
     let files = await glob('**/*.html', {
-      cwd: serve,
+      cwd: dir,
       fs
     });
     return res.send(200, 'application/xml', ['<?xml version="1.0" encoding="UTF-8"?>', '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">', ...files.map(name => `  <url><loc>${toURL(name)}</loc></url>`), '</urlset>'].join('\n'));

package/dist/config.js

@@ -28,6 +28,9 @@ export const configSchema = {
       },
       scope: {
         type: 'string'
+      },
+      devicePixelRatio: {
+        type: 'integer'
       }
     }
   },
@@ -177,6 +180,9 @@ export const snapshotSchema = {
         enableJavaScript: {
           $ref: '/config/snapshot#/properties/enableJavaScript'
         },
+        devicePixelRatio: {
+          $ref: '/config/snapshot#/properties/devicePixelRatio'
+        },
         discovery: {
           type: 'object',
           additionalProperties: false,

package/dist/page.js

@@ -29,12 +29,14 @@ export class Page {
 
   async resize({
     width,
-    height
+    height,
+    deviceScaleFactor = 1,
+    mobile = false
   }) {
-    this.log.debug(`Resize page to ${width}x${height}`);
+    this.log.debug(`Resize page to ${width}x${height} @${deviceScaleFactor}x`);
     await this.session.send('Emulation.setDeviceMetricsOverride', {
-      deviceScaleFactor: 1,
-      mobile: false,
+      deviceScaleFactor,
+      mobile,
       height,
       width
     });

package/dist/server.js

@@ -422,9 +422,23 @@ function parseByteRange(range, size) {
     start,
     end
   };
-} // include ServerError and createRewriter as static properties
+} // shorthand function for creating a new server with specific options
 
 
+export function createServer(options = {}) {
+  let {
+    serve,
+    port,
+    baseUrl = '/',
+    ...opts
+  } = options;
+  let server = new Server({
+    port
+  });
+  return serve ? server.serve(baseUrl, serve, opts) : server;
+} // include some exports as static properties
+
 Server.Error = ServerError;
 Server.createRewriter = createRewriter;
+Server.createServer = createServer;
 export default Server;

package/dist/snapshot.js

@@ -260,6 +260,7 @@ function debugSnapshotConfig(snapshot, showInfo) {
   debugProp(snapshot, 'widths', v => `${v}px`);
   debugProp(snapshot, 'minHeight', v => `${v}px`);
   debugProp(snapshot, 'enableJavaScript');
+  debugProp(snapshot, 'deviceScaleFactor');
   debugProp(snapshot, 'waitForTimeout');
   debugProp(snapshot, 'waitForSelector');
   debugProp(snapshot, 'execute.afterNavigation');
@@ -320,20 +321,55 @@ function waitForDiscoveryNetworkIdle(page, options) {
 } // Used to cache resources across core instances
 
 
-const RESOURCE_CACHE_KEY = Symbol('resource-cache'); // Discovers resources for a snapshot using a browser page to intercept requests. The callback
+const RESOURCE_CACHE_KEY = Symbol('resource-cache'); // Trigger resource requests for a page by iterating over snapshot widths and calling any provided
+// execute options. Additional resize options may be provided to capture resources mobile resources
+
+function* triggerResourceRequests(page, snapshot, options) {
+  // copy widths to prevent mutation later
+  let [initialWidth, ...widths] = snapshot.widths; // set the initial page size
+
+  yield page.resize({
+    width: initialWidth,
+    height: snapshot.minHeight,
+    ...options
+  }); // navigate to the url
+
+  yield page.goto(snapshot.url);
+
+  if (snapshot.execute) {
+    // when any execute options are provided, inject snapshot options
+
+    /* istanbul ignore next: cannot detect coverage of injected code */
+    yield page.eval((_, s) => window.__PERCY__.snapshot = s, snapshot);
+    yield page.evaluate(snapshot.execute.afterNavigation);
+  } // trigger resize events for other widths
+
+
+  for (let width of widths) {
+    var _snapshot$execute, _snapshot$execute2;
+
+    yield page.evaluate((_snapshot$execute = snapshot.execute) === null || _snapshot$execute === void 0 ? void 0 : _snapshot$execute.beforeResize);
+    yield waitForDiscoveryNetworkIdle(page, snapshot.discovery);
+    yield page.resize({
+      width,
+      height: snapshot.minHeight,
+      ...options
+    });
+    yield page.evaluate((_snapshot$execute2 = snapshot.execute) === null || _snapshot$execute2 === void 0 ? void 0 : _snapshot$execute2.afterResize);
+  }
+} // Discovers resources for a snapshot using a browser page to intercept requests. The callback
 // function will be called with the snapshot name (for additional snapshots) and an array of
 // discovered resources. When additional snapshots are provided, the callback will be called once
 // for each snapshot.
 
+
 export async function* discoverSnapshotResources(percy, snapshot, callback) {
   debugSnapshotConfig(snapshot, percy.dryRun); // when dry-running, invoke the callback for each snapshot and immediately return
 
   let allSnapshots = [snapshot, ...(snapshot.additionalSnapshots || [])];
   if (percy.dryRun) return allSnapshots.map(s => callback(s)); // keep a global resource cache across snapshots
 
-  let cache = percy[RESOURCE_CACHE_KEY] || (percy[RESOURCE_CACHE_KEY] = new Map()); // copy widths to prevent mutation later
-
-  let widths = snapshot.widths.slice(); // preload the root resource for existing dom snapshots
+  let cache = percy[RESOURCE_CACHE_KEY] || (percy[RESOURCE_CACHE_KEY] = new Map()); // preload the root resource for existing dom snapshots
 
   let resources = new Map(snapshot.domSnapshot && [createRootResource(snapshot.url, snapshot.domSnapshot)].map(resource => [resource.url, resource])); // open a new browser page
 
@@ -356,33 +392,15 @@ export async function* discoverSnapshotResources(percy, snapshot, callback) {
   });
 
   try {
-    // set the initial page size
-    yield page.resize({
-      width: widths.shift(),
-      height: snapshot.minHeight
-    }); // navigate to the url
-
-    yield page.goto(snapshot.url);
-
-    if (snapshot.execute) {
-      // when any execute options are provided, inject snapshot options
-
-      /* istanbul ignore next: cannot detect coverage of injected code */
-      yield page.eval((_, s) => window.__PERCY__.snapshot = s, snapshot);
-      yield page.evaluate(snapshot.execute.afterNavigation);
-    } // trigger resize events for other widths
-
+    yield* triggerResourceRequests(page, snapshot); // trigger resource requests for any alternate device pixel ratio
 
-    for (let width of widths) {
-      var _snapshot$execute, _snapshot$execute2;
-
-      yield page.evaluate((_snapshot$execute = snapshot.execute) === null || _snapshot$execute === void 0 ? void 0 : _snapshot$execute.beforeResize);
+    if (snapshot.devicePixelRatio) {
+      // wait for any existing pending resource requests first
       yield waitForDiscoveryNetworkIdle(page, snapshot.discovery);
-      yield page.resize({
-        width,
-        height: snapshot.minHeight
+      yield* triggerResourceRequests(page, snapshot, {
+        deviceScaleFactor: snapshot.devicePixelRatio,
+        mobile: true
       });
-      yield page.evaluate((_snapshot$execute2 = snapshot.execute) === null || _snapshot$execute2 === void 0 ? void 0 : _snapshot$execute2.afterResize);
     }
 
     if (snapshot.domSnapshot) {
@@ -413,12 +431,8 @@ export async function* discoverSnapshotResources(percy, snapshot, callback) {
 
         resources.delete(root.url);
       }
-    } // page clean up
-
-
-    await page.close();
-  } catch (error) {
+    }
+  } finally {
     await page.close();
-    throw error;
   }
 }

package/dist/utils.js

@@ -1,6 +1,7 @@
 import EventEmitter from 'events';
 import { sha256hash } from '@percy/client/utils';
-export { request, getPackageJSON, hostnameMatches } from '@percy/client/utils'; // Returns the hostname portion of a URL.
+export { request, getPackageJSON, hostnameMatches } from '@percy/client/utils';
+export { Server, createServer } from './server.js'; // Returns the hostname portion of a URL.
 
 export function hostname(url) {
   return new URL(url).hostname;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/core",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -39,10 +39,10 @@
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/client": "1.3.0",
-    "@percy/config": "1.3.0",
-    "@percy/dom": "1.3.0",
-    "@percy/logger": "1.3.0",
+    "@percy/client": "1.5.0",
+    "@percy/config": "1.5.0",
+    "@percy/dom": "1.5.0",
+    "@percy/logger": "1.5.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": "c2d8d8337867b74fb3c494e490912ec6349dbe5f"
+  "gitHead": "813db57980acd418a03d5bf39174ee840feb6229"
 }