Merge pull request #55 from Visual-Regression-Tracker/64-build-start

Build returned after start

Author: pashidlos

lib/playwrightVisualRegressionTracker.spec.ts

@@ -11,11 +11,13 @@ import {
 import { mocked } from "ts-jest/utils";
 import { MaybeMocked } from "ts-jest/dist/utils/testing";
 
+jest.mock("@visual-regression-tracker/sdk-js");
+
 let browserType = chromium;
 let browser: Browser;
 let context: BrowserContext;
 let page: Page;
-let vrt: PlaywrightVisualRegressionTracker;
+let playwrightVrt: PlaywrightVisualRegressionTracker;
 
 const config: Config = {
   apiUrl: "http://localhost:4200",
@@ -34,41 +36,40 @@ beforeAll(async () => {
     },
   });
   page = await context.newPage();
-  vrt = new PlaywrightVisualRegressionTracker(browserType, config);
 });
 
 afterAll(async () => {
   await browser.close();
 });
 
 describe("playwright", () => {
-  it("start", async () => {
-    const startMock = jest.fn();
-    VisualRegressionTracker.prototype.start = startMock;
+  beforeEach(() => {
+    playwrightVrt = new PlaywrightVisualRegressionTracker(browserType, config);
+  });
+
+  it("constructor", async () => {
+    expect(playwrightVrt["browser"]).toBe(browserType.name());
+    expect(VisualRegressionTracker).toHaveBeenCalledWith(config);
+  });
 
-    await vrt.start();
+  it("start", async () => {
+    await playwrightVrt.start();
 
-    expect(startMock).toHaveBeenCalled();
+    expect(VisualRegressionTracker.prototype.start).toHaveBeenCalled();
   });
 
   it("stop", async () => {
-    const stopMock = jest.fn();
-    VisualRegressionTracker.prototype.stop = stopMock;
+    await playwrightVrt.stop();
 
-    await vrt.stop();
-
-    expect(stopMock).toHaveBeenCalled();
+    expect(VisualRegressionTracker.prototype.stop).toHaveBeenCalled();
   });
 
   describe("track", () => {
-    let trackMock: jest.Mock<any, any>;
     let pageMocked: MaybeMocked<Page>;
     const screenshot: Buffer = Buffer.from("image mocked");
 
     beforeEach(() => {
-      vrt["vrt"]["isStarted"] = jest.fn().mockReturnValueOnce(true);
-      trackMock = jest.fn();
-      VisualRegressionTracker.prototype.track = trackMock;
+      playwrightVrt["vrt"]["isStarted"] = jest.fn().mockReturnValueOnce(true);
       pageMocked = mocked(page);
       pageMocked.screenshot = jest.fn().mockResolvedValueOnce(screenshot);
     });
@@ -102,12 +103,12 @@ describe("playwright", () => {
           },
         };
 
-        await vrt.trackPage(page, imageName, trackOptions);
+        await playwrightVrt.trackPage(page, imageName, trackOptions);
 
         expect(pageMocked.screenshot).toHaveBeenCalledWith(
           trackOptions.screenshotOptions
         );
-        expect(trackMock).toHaveBeenCalledWith({
+        expect(VisualRegressionTracker.prototype.track).toHaveBeenCalledWith({
           name: imageName,
           imageBase64: screenshot.toString("base64"),
           browser: browserType.name(),
@@ -123,10 +124,10 @@ describe("playwright", () => {
         const imageName = "test name";
         pageMocked.viewportSize = jest.fn().mockReturnValueOnce(null);
 
-        await vrt.trackPage(page, imageName);
+        await playwrightVrt.trackPage(page, imageName);
 
         expect(pageMocked.screenshot).toHaveBeenCalledWith(undefined);
-        expect(trackMock).toHaveBeenCalledWith({
+        expect(VisualRegressionTracker.prototype.track).toHaveBeenCalledWith({
           name: imageName,
           imageBase64: screenshot.toString("base64"),
           browser: browserType.name(),
@@ -168,12 +169,16 @@ describe("playwright", () => {
           .fn()
           .mockResolvedValueOnce(screenshot);
 
-        await vrt.trackElementHandle(elementHandle, imageName, trackOptions);
+        await playwrightVrt.trackElementHandle(
+          elementHandle,
+          imageName,
+          trackOptions
+        );
 
         expect(elementHandleMocked!.screenshot).toHaveBeenCalledWith(
           trackOptions.screenshotOptions
         );
-        expect(trackMock).toHaveBeenCalledWith({
+        expect(VisualRegressionTracker.prototype.track).toHaveBeenCalledWith({
           name: imageName,
           imageBase64: screenshot.toString("base64"),
           browser: browserType.name(),
@@ -194,10 +199,10 @@ describe("playwright", () => {
           .fn()
           .mockResolvedValueOnce(screenshot);
 
-        await vrt.trackElementHandle(elementHandle, imageName);
+        await playwrightVrt.trackElementHandle(elementHandle, imageName);
 
         expect(elementHandleMocked!.screenshot).toHaveBeenCalledWith(undefined);
-        expect(trackMock).toHaveBeenCalledWith({
+        expect(VisualRegressionTracker.prototype.track).toHaveBeenCalledWith({
           name: imageName,
           imageBase64: screenshot.toString("base64"),
           browser: browserType.name(),
@@ -214,7 +219,7 @@ describe("playwright", () => {
         const elementHandle = await page.$("#test");
 
         await expect(
-          vrt.trackElementHandle(elementHandle, imageName)
+          playwrightVrt.trackElementHandle(elementHandle, imageName)
         ).rejects.toThrowError(new Error("ElementHandle is null"));
       });
     });

lib/playwrightVisualRegressionTracker.ts

@@ -1,6 +1,7 @@
 import {
   VisualRegressionTracker,
   Config,
+  BuildResponse,
 } from "@visual-regression-tracker/sdk-js";
 import { Page, Browser, BrowserType, ElementHandle } from "playwright";
 import {
@@ -10,14 +11,14 @@ import {
 
 export class PlaywrightVisualRegressionTracker {
   private vrt: VisualRegressionTracker;
-  private browser: BrowserType<Browser>;
+  private browser: string;
 
-  constructor(browser: BrowserType<Browser>, config?: Config) {
+  constructor(browserType: BrowserType<Browser>, config?: Config) {
     this.vrt = new VisualRegressionTracker(config);
-    this.browser = browser;
+    this.browser = browserType.name();
   }
 
-  async start() {
+  async start(): Promise<BuildResponse> {
     return this.vrt.start();
   }
 
@@ -32,7 +33,7 @@ export class PlaywrightVisualRegressionTracker {
       imageBase64: (await page.screenshot(options?.screenshotOptions)).toString(
         "base64"
       ),
-      browser: this.browser.name(),
+      browser: this.browser,
       viewport: viewportSize
         ? `${viewportSize.width}x${viewportSize.height}`
         : undefined,
@@ -56,7 +57,7 @@ export class PlaywrightVisualRegressionTracker {
       imageBase64: (
         await elementHandle.screenshot(options?.screenshotOptions)
       ).toString("base64"),
-      browser: this.browser.name(),
+      browser: this.browser,
       viewport: options?.agent?.viewport,
       os: options?.agent?.os,
       device: options?.agent?.device,

package-lock.json

@@ -5,8 +5,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "jest",
-    "test:cov": "jest --collectCoverage",
+    "test": "jest --detectOpenHandles --forceExit",
+    "test:cov": "jest --collectCoverage --detectOpenHandles --forceExit",
     "build": "./node_modules/.bin/tsc"
   },
   "repository": {
@@ -25,14 +25,14 @@
   },
   "homepage": "https://github.com/Visual-Regression-Tracker/agent-playwright#readme",
   "dependencies": {
-    "@visual-regression-tracker/sdk-js": "^4.6.2"
+    "@visual-regression-tracker/sdk-js": "^4.6.3"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.16",
-    "@types/node": "^14.14.10",
+    "@types/jest": "^26.0.19",
+    "@types/node": "^14.14.16",
     "jest": "^26.6.2",
-    "playwright": "^1.6.2",
+    "playwright": "^1.7.1",
     "ts-jest": "^26.4.3",
-    "typescript": "^4.1.2"
+    "typescript": "^4.1.3"
   }
 }