add other recordHar options

Author: rwoll

playwright/_impl/_browser.py

@@ -226,9 +226,6 @@ async def normalize_context_params(is_sync: bool, params: Dict) -> None:
     if "recordHarPath" in params:
         recordHar: Dict[str, Any] = {"path": str(params["recordHarPath"])}
         params["recordHar"] = recordHar
-        if "recordHarOmitContent" in params:
-            params["recordHar"]["omitContent"] = params["recordHarOmitContent"]
-            del params["recordHarOmitContent"]
         if "recordHarUrlFilter" in params:
             opt = params["recordHarUrlFilter"]
             if isinstance(opt, str):
@@ -237,6 +234,22 @@ async def normalize_context_params(is_sync: bool, params: Dict) -> None:
                 params["recordHar"]["urlRegexSource"] = opt.pattern
                 params["recordHar"]["urlRegexFlags"] = escape_regex_flags(opt)
             del params["recordHarUrlFilter"]
+        if "recordHarMode" in params:
+            params["recordHar"]["mode"] = params["recordHarMode"]
+            del params["recordHarMode"]
+
+        new_content_api = None
+        old_content_api = None
+        if "recordHarContent" in params:
+            new_content_api = params["recordHarContent"]
+            del params["recordHarContent"]
+        if "recordHarOmitContent" in params:
+            old_content_api = params["recordHarOmitContent"]
+            del params["recordHarOmitContent"]
+        content = new_content_api or ("omit" if old_content_api else None)
+        if content:
+            params["recordHar"]["content"] = content
+
         del params["recordHarPath"]
     if "recordVideoDir" in params:
         params["recordVideo"] = {"dir": str(params["recordVideoDir"])}

tests/async/test_har.py

@@ -15,6 +15,7 @@
 import json
 import os
 import re
+import zipfile
 
 from playwright.async_api import Browser
 from tests.server import Server
@@ -32,6 +33,24 @@ async def test_should_work(browser, server, tmpdir):
 
 
 async def test_should_omit_content(browser, server, tmpdir):
+    path = os.path.join(tmpdir, "log.har")
+    context = await browser.new_context(
+        record_har_path=path,
+        record_har_content="omit",
+    )
+    page = await context.new_page()
+    await page.goto(server.PREFIX + "/har.html")
+    await context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+        content1 = log["entries"][0]["response"]["content"]
+        assert "text" not in content1
+        assert "encoding" not in content1
+
+
+async def test_should_omit_content_legacy(browser, server, tmpdir):
     path = os.path.join(tmpdir, "log.har")
     context = await browser.new_context(
         record_har_path=path, record_har_omit_content=True
@@ -44,10 +63,67 @@ async def test_should_omit_content(browser, server, tmpdir):
         assert "log" in data
         log = data["log"]
         content1 = log["entries"][0]["response"]["content"]
-        assert "text" in content1
+        assert "text" not in content1
         assert "encoding" not in content1
 
 
+async def test_should_attach_content(browser, server, tmpdir, is_firefox):
+    path = os.path.join(tmpdir, "log.har.zip")
+    context = await browser.new_context(
+        record_har_path=path,
+        record_har_content="attach",
+    )
+    page = await context.new_page()
+    await page.goto(server.PREFIX + "/har.html")
+    await page.evaluate("() => fetch('/pptr.png').then(r => r.arrayBuffer())")
+    await context.close()
+    with zipfile.ZipFile(path) as z:
+        with z.open("har.har") as har:
+            entries = json.load(har)["log"]["entries"]
+
+            assert "encoding" not in entries[0]["response"]["content"]
+            assert (
+                entries[0]["response"]["content"]["mimeType"]
+                == "text/html; charset=utf-8"
+            )
+            assert (
+                "75841480e2606c03389077304342fac2c58ccb1b"
+                in entries[0]["response"]["content"]["_file"]
+            )
+            assert entries[0]["response"]["content"]["size"] >= 96
+            assert entries[0]["response"]["content"]["compression"] == 0
+
+            assert "encoding" not in entries[1]["response"]["content"]
+            assert (
+                entries[1]["response"]["content"]["mimeType"]
+                == "text/css; charset=utf-8"
+            )
+            assert (
+                "79f739d7bc88e80f55b9891a22bf13a2b4e18adb"
+                in entries[1]["response"]["content"]["_file"]
+            )
+            assert entries[1]["response"]["content"]["size"] >= 37
+            assert entries[1]["response"]["content"]["compression"] == 0
+
+            assert "encoding" not in entries[2]["response"]["content"]
+            assert entries[2]["response"]["content"]["mimeType"] == "image/png"
+            assert (
+                "a4c3a18f0bb83f5d9fe7ce561e065c36205762fa"
+                in entries[2]["response"]["content"]["_file"]
+            )
+            assert entries[2]["response"]["content"]["size"] >= 6000
+            assert entries[2]["response"]["content"]["compression"] == 0
+
+            with z.open("75841480e2606c03389077304342fac2c58ccb1b.html") as f:
+                assert b"HAR Page" in f.read()
+
+            with z.open("79f739d7bc88e80f55b9891a22bf13a2b4e18adb.css") as f:
+                assert b"pink" in f.read()
+
+            with z.open("a4c3a18f0bb83f5d9fe7ce561e065c36205762fa.png") as f:
+                assert len(f.read()) == entries[2]["response"]["content"]["size"]
+
+
 async def test_should_not_omit_content(browser, server, tmpdir):
     path = os.path.join(tmpdir, "log.har")
     context = await browser.new_context(
@@ -78,6 +154,37 @@ async def test_should_include_content(browser, server, tmpdir):
         assert "HAR Page" in content1["text"]
 
 
+async def test_should_default_to_full_mode(browser, server, tmpdir):
+    path = os.path.join(tmpdir, "log.har")
+    context = await browser.new_context(
+        record_har_path=path,
+    )
+    page = await context.new_page()
+    await page.goto(server.PREFIX + "/har.html")
+    await context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+        assert log["entries"][0]["request"]["bodySize"] >= 0
+
+
+async def test_should_support_minimal_mode(browser, server, tmpdir):
+    path = os.path.join(tmpdir, "log.har")
+    context = await browser.new_context(
+        record_har_path=path,
+        record_har_mode="minimal",
+    )
+    page = await context.new_page()
+    await page.goto(server.PREFIX + "/har.html")
+    await context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+        assert log["entries"][0]["request"]["bodySize"] == -1
+
+
 async def test_should_filter_by_glob(
     browser: Browser, server: Server, tmpdir: str
 ) -> None:

tests/server.py

@@ -139,6 +139,7 @@ def process(self) -> None:
                         content_type += "; charset=utf-8"
                     request.setHeader(b"Content-Type", content_type)
                     request.setHeader(b"Cache-Control", "no-cache, no-store")
+                    request.setHeader(b"Content-Length", str(len(file_content)))
                     if path in gzip_routes:
                         request.setHeader("Content-Encoding", "gzip")
                         request.write(gzip.compress(file_content))

tests/sync/test_har.py

@@ -15,6 +15,7 @@
 import json
 import os
 import re
+import zipfile
 from pathlib import Path
 
 from playwright.sync_api import Browser
@@ -33,6 +34,24 @@ def test_should_work(browser: Browser, server: Server, tmpdir: Path) -> None:
 
 
 def test_should_omit_content(browser: Browser, server: Server, tmpdir: Path) -> None:
+    path = os.path.join(tmpdir, "log.har")
+    context = browser.new_context(record_har_path=path, record_har_content="omit")
+    page = context.new_page()
+    page.goto(server.PREFIX + "/har.html")
+    context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+
+        content1 = log["entries"][0]["response"]["content"]
+        assert "text" not in content1
+        assert "encoding" not in content1
+
+
+def test_should_omit_content_legacy(
+    browser: Browser, server: Server, tmpdir: Path
+) -> None:
     path = os.path.join(tmpdir, "log.har")
     context = browser.new_context(record_har_path=path, record_har_omit_content=True)
     page = context.new_page()
@@ -44,10 +63,67 @@ def test_should_omit_content(browser: Browser, server: Server, tmpdir: Path) ->
         log = data["log"]
 
         content1 = log["entries"][0]["response"]["content"]
-        assert "text" in content1
+        assert "text" not in content1
         assert "encoding" not in content1
 
 
+def test_should_attach_content(browser: Browser, server: Server, tmpdir: Path) -> None:
+    path = os.path.join(tmpdir, "log.har.zip")
+    context = browser.new_context(
+        record_har_path=path,
+        record_har_content="attach",
+    )
+    page = context.new_page()
+    page.goto(server.PREFIX + "/har.html")
+    page.evaluate("() => fetch('/pptr.png').then(r => r.arrayBuffer())")
+    context.close()
+    with zipfile.ZipFile(path) as z:
+        with z.open("har.har") as har:
+            entries = json.load(har)["log"]["entries"]
+
+            assert "encoding" not in entries[0]["response"]["content"]
+            assert (
+                entries[0]["response"]["content"]["mimeType"]
+                == "text/html; charset=utf-8"
+            )
+            assert (
+                "75841480e2606c03389077304342fac2c58ccb1b"
+                in entries[0]["response"]["content"]["_file"]
+            )
+            assert entries[0]["response"]["content"]["size"] >= 96
+            assert entries[0]["response"]["content"]["compression"] == 0
+
+            assert "encoding" not in entries[1]["response"]["content"]
+            assert (
+                entries[1]["response"]["content"]["mimeType"]
+                == "text/css; charset=utf-8"
+            )
+            assert (
+                "79f739d7bc88e80f55b9891a22bf13a2b4e18adb"
+                in entries[1]["response"]["content"]["_file"]
+            )
+            assert entries[1]["response"]["content"]["size"] >= 37
+            assert entries[1]["response"]["content"]["compression"] == 0
+
+            assert "encoding" not in entries[2]["response"]["content"]
+            assert entries[2]["response"]["content"]["mimeType"] == "image/png"
+            assert (
+                "a4c3a18f0bb83f5d9fe7ce561e065c36205762fa"
+                in entries[2]["response"]["content"]["_file"]
+            )
+            assert entries[2]["response"]["content"]["size"] >= 6000
+            assert entries[2]["response"]["content"]["compression"] == 0
+
+            with z.open("75841480e2606c03389077304342fac2c58ccb1b.html") as f:
+                assert b"HAR Page" in f.read()
+
+            with z.open("79f739d7bc88e80f55b9891a22bf13a2b4e18adb.css") as f:
+                assert b"pink" in f.read()
+
+            with z.open("a4c3a18f0bb83f5d9fe7ce561e065c36205762fa.png") as f:
+                assert len(f.read()) == entries[2]["response"]["content"]["size"]
+
+
 def test_should_include_content(browser: Browser, server: Server, tmpdir: Path) -> None:
     path = os.path.join(tmpdir, "log.har")
     context = browser.new_context(record_har_path=path)
@@ -64,6 +140,41 @@ def test_should_include_content(browser: Browser, server: Server, tmpdir: Path)
         assert "HAR Page" in content1["text"]
 
 
+def test_should_default_to_full_mode(
+    browser: Browser, server: Server, tmpdir: Path
+) -> None:
+    path = os.path.join(tmpdir, "log.har")
+    context = browser.new_context(
+        record_har_path=path,
+    )
+    page = context.new_page()
+    page.goto(server.PREFIX + "/har.html")
+    context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+        assert log["entries"][0]["request"]["bodySize"] >= 0
+
+
+def test_should_support_minimal_mode(
+    browser: Browser, server: Server, tmpdir: Path
+) -> None:
+    path = os.path.join(tmpdir, "log.har")
+    context = browser.new_context(
+        record_har_path=path,
+        record_har_mode="minimal",
+    )
+    page = context.new_page()
+    page.goto(server.PREFIX + "/har.html")
+    context.close()
+    with open(path) as f:
+        data = json.load(f)
+        assert "log" in data
+        log = data["log"]
+        assert log["entries"][0]["request"]["bodySize"] == -1
+
+
 def test_should_filter_by_glob(browser: Browser, server: Server, tmpdir: str) -> None:
     path = os.path.join(tmpdir, "log.har")
     context = browser.new_context(