feat: export advancedRouteFromHAR (#72)

Co-authored-by: Noam Gaash <[email protected]>

Author: ImLunaHey

package-lock.json

@@ -1,4 +1,4 @@
-import { test as base } from "@playwright/test";
+import { test as base, type Page } from "@playwright/test";
 import * as fs from "fs";
 import { AdvancedRouteFromHAR, requestResponseToEntry } from "./utils/types";
 import { parseContent, serveFromHar } from "./utils/serveFromHar";
@@ -9,47 +9,53 @@ export { customMatcher } from "./utils/matchers/customMatcher";
 export { parseContent } from "./utils/serveFromHar";
 import * as path from "path";
 
-export const test = base.extend<{
-	advancedRouteFromHAR: AdvancedRouteFromHAR;
-}>({
-	advancedRouteFromHAR: async ({ page }, use) => {
-		const originalRouteFromHAR = page.routeFromHAR.bind(page);
-		const advancedRouteFromHAR: AdvancedRouteFromHAR = async (filename, options) => {
-			if (options?.update) {
-				const {matcher} = options;
-				if (matcher && "postProcess" in matcher) {
-					await page.route(options.url || /.*/, async (route, request) => {
-						const resp = await route.fetch();
-						const response = matcher.postProcess?.(await requestResponseToEntry(request, resp, await page.context().cookies())).response;
-						if(response)
-							route.fulfill({
-								status: response.status,
-								headers: Object.fromEntries(response.headers.map((header) => [header.name, header.value])),
-								body: await parseContent(response.content, path.dirname(filename)),
-							});
-					});
-				}
-				// on update, we want to record the HAR just like the original playwright method
-				return originalRouteFromHAR(filename, {
-					url: options.url,
-					update: true,
-					updateContent: options?.updateContent,
-					updateMode: options?.updateMode,
+export const advancedRouteFromHAR = async (
+	{ page }: { page: Page },
+	use: (fn: AdvancedRouteFromHAR) => Promise<void>,
+) => {
+	const originalRouteFromHAR = page.routeFromHAR.bind(page);
+
+	await use(async (filename, options) => {
+		if (options?.update) {
+			const { matcher } = options;
+			if (matcher && "postProcess" in matcher) {
+				await page.route(options.url || /.*/, async (route, request) => {
+					const resp = await route.fetch();
+					const response = matcher.postProcess?.(
+						await requestResponseToEntry(request, resp, await page.context().cookies()),
+					).response;
+					if (response)
+						route.fulfill({
+							status: response.status,
+							headers: Object.fromEntries(response.headers.map((header) => [header.name, header.value])),
+							body: await parseContent(response.content, path.dirname(filename)),
+						});
 				});
-			} else {
-				const har = JSON.parse(await fs.promises.readFile(filename, { encoding: "utf8" }));
-				return serveFromHar(
-					har,
-					{
-						...options,
-						matcher: options?.matcher ?? defaultMatcher,
-						dirName: path.dirname(filename),
-					},
-					page,
-				);
 			}
-		};
+			// on update, we want to record the HAR just like the original playwright method
+			return originalRouteFromHAR(filename, {
+				url: options.url,
+				update: true,
+				updateContent: options?.updateContent,
+				updateMode: options?.updateMode,
+			});
+		} else {
+			const har = JSON.parse(await fs.promises.readFile(filename, { encoding: "utf8" }));
+			return serveFromHar(
+				har,
+				{
+					...options,
+					matcher: options?.matcher ?? defaultMatcher,
+					dirName: path.dirname(filename),
+				},
+				page,
+			);
+		}
+	});
+};
 
-		await use(advancedRouteFromHAR);
-	},
+export const test = base.extend<{
+	advancedRouteFromHAR: AdvancedRouteFromHAR;
+}>({
+	advancedRouteFromHAR,
 });

src/index.ts

@@ -1,5 +1,5 @@
 import { expect } from "@playwright/test";
-import { defaultMatcher, test } from "../lib/index";
+import { defaultMatcher, test, advancedRouteFromHAR } from "../lib/index";
 import fs from "fs";
 import { parseContent } from "../lib/index";
 
@@ -8,6 +8,13 @@ test("sanity", async ({ page, advancedRouteFromHAR }) => {
 	await page.goto("https://demo.playwright.dev/todomvc");
 });
 
+test("sanity with import", async ({ page }) => {
+	await advancedRouteFromHAR({ page }, async (r) => {
+		await r("tests/har/demo-todo-app.har");
+	});
+	await page.goto("https://demo.playwright.dev/todomvc");
+});
+
 test("sanity with option", async ({ page, advancedRouteFromHAR }) => {
 	await advancedRouteFromHAR("tests/har/demo-todo-app.har", {
 		update: false,
@@ -183,13 +190,12 @@ test("attached content", async ({ page, advancedRouteFromHAR }) => {
 	await advancedRouteFromHAR("tests/har/temp/not-embedded.har", {
 		matcher: async (request, entry) => {
 			let content = await parseContent(entry.response.content, "tests/har/temp");
-			if(typeof content === "object")
-				content = content.toString();
-		
+			if (typeof content === "object") content = content.toString();
+
 			expect(content).toBeTruthy();
 			expect(content).toContain("category");
 			return defaultMatcher(request, entry);
-		}
+		},
 	});
 	await page.goto("https://v2.jokeapi.dev/joke/Any?blacklistFlags=nsfw,religious,political,racist,sexist,explicit");
 });
@@ -202,24 +208,27 @@ test("test a joke recording with postprocess", async ({ page, advancedRouteFromH
 			postProcess(entry) {
 				entry.response.content.text = "This is a joke";
 				return entry;
-			}
-		}
+			},
+		},
 	});
 	await page.goto("https://v2.jokeapi.dev/joke/Any?blacklistFlags=nsfw,religious,political,racist,sexist,explicit");
 	await page.waitForSelector("text=This is a joke");
 	await page.close();
 });
 
-test("test a joke recording with different postprocess that was not recorded", async ({ page, advancedRouteFromHAR }) => {
+test("test a joke recording with different postprocess that was not recorded", async ({
+	page,
+	advancedRouteFromHAR,
+}) => {
 	await advancedRouteFromHAR("tests/har/temp/joke-postprocess.har", {
 		update: true,
 		updateContent: "embed",
 		matcher: {
 			postProcess(entry) {
 				entry.response.content.text = "This is not a joke";
 				return entry;
-			}
-		}
+			},
+		},
 	});
 	await page.goto("https://v2.jokeapi.dev/joke/Any?blacklistFlags=nsfw,religious,political,racist,sexist,explicit");
 	await page.waitForSelector("text=This is not a joke");
@@ -236,8 +245,8 @@ test("test a postprocess that change only part of the output", async ({ page, ad
 				json.flags.custom = true;
 				entry.response.content.text = JSON.stringify(json);
 				return entry;
-			}
-		}
+			},
+		},
 	});
 	await page.goto("https://v2.jokeapi.dev/joke/Any?blacklistFlags=nsfw,religious,political,racist,sexist,explicit");
 	const flags = await page.evaluate(() => {
@@ -261,4 +270,3 @@ test.fail("sensitive data file should not contain sensitive data", async () => {
 	const data = await waitForFile("tests/har/temp/no-sensitive-data.har");
 	expect(data).not.toContain("top secret");
 });
-