@percy/playwright 1.0.6-beta.0 → 1.0.6-beta.2

package/cache.js

@@ -0,0 +1,51 @@
+class Cache {
+  static CACHE = {};
+  static CACHE_TIMEOUT = 5 * 60; // 300 seconds
+  static TIMEOUT_KEY = 'last_access_time';
+
+  // Caching Keys
+  static sessionDetails = 'sessionDetails';
+
+  static checkTypes(sessionId, property) {
+    if (typeof sessionId !== 'string') {
+      throw new TypeError('Argument sessionId should be a string');
+    }
+    if (typeof property !== 'string') {
+      throw new TypeError('Argument property should be a string');
+    }
+  }
+
+  static setCache(sessionId, property, value) {
+    this.checkTypes(sessionId, property);
+    let session = this.CACHE[sessionId] || {};
+    session[this.TIMEOUT_KEY] = Math.floor(Date.now() / 1000);
+    session[property] = value;
+    this.CACHE[sessionId] = session;
+  }
+
+  static getCache(sessionId, property) {
+    this.cleanupCache();
+    this.checkTypes(sessionId, property);
+    /* Below line is covered even then nyc is not able to consider it as coverage */
+    /* istanbul ignore next */
+    let session = this.CACHE[sessionId] || {};
+    return session[property] || null;
+  }
+
+  static cleanupCache() {
+    let now = Math.floor(Date.now() / 1000);
+    for (let sessionId in this.CACHE) {
+      let session = this.CACHE[sessionId];
+      let timestamp = session[this.TIMEOUT_KEY];
+      if (now - timestamp >= this.CACHE_TIMEOUT) {
+        this.CACHE[sessionId] = {
+          [this.sessionDetails]: session[this.sessionDetails]
+        };
+      }
+    }
+  }
+}
+
+module.exports = {
+  Cache
+};

package/index.js

@@ -9,7 +9,7 @@ const ENV_INFO = `${playwrightPkg.name}/${playwrightPkg.version}`;
 const log = utils.logger('playwright');
 
 // Take a DOM snapshot and post it to the snapshot endpoint
-async function percySnapshot(page, name, options) {
+const percySnapshot = async function(page, name, options) {
   if (!page) throw new Error('A Playwright `page` object is required.');
   if (!name) throw new Error('The `name` argument is required.');
   if (!(await utils.isPercyEnabled())) return;
@@ -39,10 +39,10 @@ async function percySnapshot(page, name, options) {
     log.error(`Could not take DOM snapshot "${name}"`);
     log.error(err);
   }
-}
+};
 
 // Takes Playwright screenshot with Automate
-async function percyScreenshot(page, name, options) {
+const percyScreenshot = async function(page, name, options) {
   if (!page) throw new Error('A Playwright `page` object is required.');
   if (!name) throw new Error('The `name` argument is required.');
   if (!(await utils.isPercyEnabled())) return;
@@ -71,6 +71,10 @@ async function percyScreenshot(page, name, options) {
     log.error(`Could not take percy screenshot "${name}"`);
     log.error(err);
   }
-}
+};
 
-module.exports = { percySnapshot, percyScreenshot, CLIENT_INFO, ENV_INFO };
+module.exports = percySnapshot;
+module.exports.percySnapshot = percySnapshot;
+module.exports.percyScreenshot = percyScreenshot;
+module.exports.CLIENT_INFO = CLIENT_INFO;
+module.exports.ENV_INFO = ENV_INFO;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@percy/playwright",
   "description": "Playwright client library for visual testing with Percy",
-  "version": "1.0.6-beta.0",
+  "version": "1.0.6-beta.2",
   "license": "MIT",
   "author": "Perceptual Inc.",
   "repository": "https://github.com/percy/percy-playwright",
@@ -14,6 +14,8 @@
   "types": "types/index.d.ts",
   "files": [
     "index.js",
+    "utils.js",
+    "cache.js",
     "types/index.d.ts"
   ],
   "engines": {
@@ -33,7 +35,7 @@
     "playwright-core": ">=1"
   },
   "devDependencies": {
-    "@percy/cli": "^1.28.2",
+    "@percy/cli": "^1.28.8-beta.3",
     "@playwright/test": "^1.24.2",
     "babel-eslint": "^10.1.0",
     "cross-env": "^7.0.2",

package/utils.js

@@ -0,0 +1,28 @@
+const utils = require('@percy/sdk-utils');
+const { Cache } = require('./cache');
+
+class Utils {
+  static projectType() {
+    return utils.percy?.type;
+  }
+
+  static async captureAutomateScreenshot(data) {
+    return await utils.captureAutomateScreenshot(data);
+  }
+
+  static async sessionDetails(page) {
+    /* It is browser's guid maintained by playwright, considering it is unique for one automate session
+    will use it to cache the session details */
+    const browserGuid = page._parent._parent._guid;
+    let sessionDetails = Cache.getCache(browserGuid, Cache.sessionDetails);
+    if (!sessionDetails) {
+      sessionDetails = JSON.parse(await page.evaluate(/* istanbul ignore next */ _ => { }, `browserstack_executor: ${JSON.stringify({ action: 'getSessionDetails' })}`));
+      Cache.setCache(browserGuid, Cache.sessionDetails, sessionDetails);
+    }
+    return sessionDetails;
+  }
+}
+
+module.exports = {
+  Utils
+};