@argos-ci/puppeteer 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# @argos-ci/puppeteer
+
+[Puppeteer](https://pptr.dev/) commands and utilities for [Argos](https://argos-ci.com) visual testing.
+
+[![npm version](https://img.shields.io/npm/v/@argos-ci/puppeteer.svg)](https://www.npmjs.com/package/@argos-ci/puppeteer)
+[![npm dm](https://img.shields.io/npm/dm/@argos-ci/puppeteer.svg)](https://www.npmjs.com/package/@argos-ci/puppeteer)
+[![npm dt](https://img.shields.io/npm/dt/@argos-ci/puppeteer.svg)](https://www.npmjs.com/package/@argos-ci/puppeteer)
+
+## Installation
+
+```sh
+npm install --save-dev @argos-ci/puppeteer
+```
+
+## Usage
+
+Stabilizes the UI before taking a screenshot.
+
+`argosScreenshot(page, name[, options])`
+
+- `page` - A `puppeteer` page instance
+- `name` - The screenshot name; must be unique
+- `options` - See [Page.screenshot command options](https://pptr.dev/next/api/puppeteer.page.screenshot/)
+
+```js
+describe("Integration test with visual testing", () => {
+  it("Loads the homepage", async () => {
+    const browser = await puppeteer.launch();
+    const page = await browser.newPage();
+    await page.goto(TEST_URL);
+    await argosScreenshot(page, this.test.fullTitle());
+  });
+});
+```
+
+## Helper attributes
+
+The `data-visual-test` attributes allow you to control how elements behave in the Argos screenshot.
+
+It is often used to hide changing element like dates.
+
+- `[data-visual-test="transparent"]` - Make the element transparent (`opacity: 0`)
+- `[data-visual-test="removed"]` - Remove the element (`display: none`)
+- `[data-visual-test="blackout"]` - Blacked out the element
+
+```html
+<!-- Hide a div from a screenshot -->
+<div id="clock" data-visual-test="transparent">...</div>
+```

package/index.cjs

@@ -0,0 +1,6 @@
+const argosScreenshot = async (...args) => {
+  const { argosScreenshot } = await import("./index.js");
+  return argosScreenshot(...args);
+};
+
+exports.argosScreenshot = argosScreenshot;

package/index.d.ts

@@ -0,0 +1,18 @@
+import type { Page, ScreenshotOptions } from "puppeteer";
+
+export type ArgosScreenshotOptions = Omit<
+  ScreenshotOptions,
+  "encoding" | "type" | "omitBackground" | "path"
+>;
+
+/**
+ * Stabilize the UI and takes a screenshot of the application under test.
+ * @example
+ *    await argosScreenshot(page, "my-screenshot")
+ *    await argosScreenshot(page, "my-screenshot", { fullPage: true })
+ */
+export function argosScreenshot(
+  page: Page,
+  name: string,
+  options?: ArgosScreenshotOptions
+): Promise<void>;

package/index.js

@@ -0,0 +1,64 @@
+import { resolve } from "node:path";
+import mkdirp from "mkdirp";
+
+const GLOBAL_STYLES = `
+  /* Hide carets */
+  * { caret-color: transparent !important; }
+
+  /* Hide scrollbars */
+  ::-webkit-scrollbar {
+    display: none !important;
+  }
+
+  /* Generic hide */
+  [data-visual-test="transparent"] {
+    color: transparent !important;
+    font-family: monospace !important;
+    opacity: 0 !important;
+  }
+
+  [data-visual-test="removed"] {
+    display: none !important;
+  }
+`;
+
+/**
+ * Check if there is `[aria-busy="true"]` element on the page.
+ */
+async function ensureNoBusy() {
+  const checkIsVisible = (element) =>
+    Boolean(
+      element.offsetWidth ||
+        element.offsetHeight ||
+        element.getClientRects().length
+    );
+
+  return [...document.querySelectorAll('[aria-busy="true"]')].every(
+    (element) => !checkIsVisible(element)
+  );
+}
+
+// Check if the fonts are loaded
+function waitForFontLoading() {
+  return document.fonts.status === "loaded";
+}
+
+export async function argosScreenshot(page, name, { fullPage, clip } = {}) {
+  if (!page) throw new Error("A Puppeteer `page` object is required.");
+  if (!name) throw new Error("The `name` argument is required.");
+
+  await Promise.all([
+    page.addStyleTag({ content: GLOBAL_STYLES }),
+    page.waitForFunction(ensureNoBusy),
+    page.waitForFunction(waitForFontLoading),
+  ]);
+
+  const directory = resolve(process.cwd(), "screenshots/argos");
+  await mkdirp(directory);
+  await page.screenshot({
+    path: resolve(directory, `${name}.png`),
+    type: "png",
+    fullPage,
+    clip,
+  });
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@argos-ci/puppeteer",
+  "description": "Visual testing solution to avoid visual regression. Puppeteer commands and utilities for Argos visual testing.",
+  "version": "0.0.1",
+  "author": "Smooth Code",
+  "license": "MIT",
+  "repository": "github:argos-ci/argos-puppeteer",
+  "keywords": [
+    "puppeteer",
+    "argos",
+    "automation",
+    "test automation",
+    "testing",
+    "visual testing",
+    "regression",
+    "visual regression"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "jest": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "test": "npm run jest --runInBand",
+    "format": "prettier --write .",
+    "check-format": "prettier --check .",
+    "lint": "eslint --ignore-path .gitignore .",
+    "release": "standard-version && conventional-github-releaser --preset angular"
+  },
+  "peerDependencies": {
+    "puppeteer": ">=1"
+  },
+  "devDependencies": {
+    "@argos-ci/cli": "^0.1.2",
+    "@types/jest": "^28.1.8",
+    "conventional-github-releaser": "^3.1.5",
+    "eslint": "^8.23.0",
+    "eslint-plugin-html": "^7.1.0",
+    "jest": "^29.0.1",
+    "jest-light-runner": "^0.4.0",
+    "jest-puppeteer": "^6.1.1",
+    "prettier": "^2.7.1",
+    "puppeteer": "^17.0.0",
+    "standard-version": "^9.5.0"
+  },
+  "dependencies": {
+    "mkdirp": "^1.0.4"
+  }
+}