podojo-cli 1.25.0__tar.gz → 1.25.2__tar.gz

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/CHANGELOG.md

@@ -5,6 +5,32 @@ All notable changes to the Podojo CLI will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com),
 and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [1.25.2] - 2026-10-01
+
+### Changed
+- `usertests snippet` prints the recording snippet as two script tags plus a
+  `recorder.js` file to save next to the pages. The `rrweb.record()` call used
+  to be an inline `<script>`, which Boltable's content security policy
+  refuses, so recording never started on Boltable prototypes. The hints after
+  `usertests create` and on a failed go-live check now say to add the snippet
+  to every page instead of the `<head>`.
+
+### Fixed
+- `usertests get` and `aiinterviews get` print plain YAML, so
+  `get > file.yaml` can be edited and pushed back with `update -f`. The
+  output used to be hard-wrapped at the terminal width (or 80 columns when
+  redirected), which split long links and broke the YAML, and `[...]` text
+  was treated as console markup. The response count and preview/live links
+  now go to stderr, so they no longer end up in the saved file.
+
+## [1.25.1] - 2026-09-24
+
+### Fixed
+- YAML files for AI interviews and usertests are now read as UTF-8
+  explicitly. Reading them with the machine's locale encoding double-
+  encoded multi-byte characters (em-dashes, arrows) into mojibake when
+  uploading from a Windows machine.
+
 ## [1.25.0] - 2026-09-20
 
 ### Added

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: podojo-cli
-Version: 1.25.0
+Version: 1.25.2
 Summary: CLI for the Podojo user research platform
 Project-URL: Homepage, https://github.com/podojo/cli-podojo
 Project-URL: Source, https://github.com/podojo/cli-podojo
@@ -116,7 +116,7 @@ podojo usertests list
 podojo usertests get checkout-usability-v1
 podojo usertests update checkout-usability-v1 -f changes.yaml
 podojo usertests delete checkout-usability-v1
-podojo usertests snippet                  # recorder script for self-hosted prototypes
+podojo usertests snippet                  # recording snippet: two script tags + recorder.js
 ```
 
 A user test can open with an optional participant screener: on-screen

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/README.md

@@ -84,7 +84,7 @@ podojo usertests list
 podojo usertests get checkout-usability-v1
 podojo usertests update checkout-usability-v1 -f changes.yaml
 podojo usertests delete checkout-usability-v1
-podojo usertests snippet                  # recorder script for self-hosted prototypes
+podojo usertests snippet                  # recording snippet: two script tags + recorder.js
 ```
 
 A user test can open with an optional participant screener: on-screen

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "podojo-cli"
-version = "1.25.0"
+version = "1.25.2"
 description = "CLI for the Podojo user research platform"
 readme = "README.md"
 license = "MIT"

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/src/podojo_cli/commands/aiinterviews.py

@@ -11,6 +11,7 @@ from ..config import load_config
 
 app = typer.Typer(help="Manage AI voice interviews")
 console = Console()
+err_console = Console(stderr=True, soft_wrap=True)
 
 REQUIRED_FIELDS = ["interview_id", "title", "questions"]
 REQUIRED_QUESTION_FIELDS = ["text"]
@@ -324,7 +325,7 @@ def _load_yaml(path: Path) -> dict:
         console.print(f"[red]Error:[/red] File not found: {path}")
         raise typer.Exit(1)
     try:
-        with open(path) as f:
+        with open(path, encoding="utf-8") as f:
             data = yaml.safe_load(f)
     except yaml.YAMLError as e:
         console.print(f"[red]Error:[/red] Invalid YAML syntax:\n{e}")
@@ -449,16 +450,18 @@ def get_ai_interview(
     for key in ("id", "created_at", "created_by", "last_updated"):
         interview.pop(key, None)
 
-    console.print(yaml.dump(interview, default_flow_style=False, sort_keys=False, allow_unicode=True))
+    # Plain stdout, so `get > file.yaml` round-trips: rich would hard-wrap long
+    # lines and eat [markup]. The info lines go to stderr for the same reason.
+    typer.echo(yaml.dump(interview, default_flow_style=False, sort_keys=False, allow_unicode=True))
     max_responses = interview.get("max_responses")
     if max_responses:
-        console.print(f"Responses: {response_count} / {max_responses}")
+        err_console.print(f"Responses: {response_count} / {max_responses}")
     elif response_count:
-        console.print(f"Responses: {response_count}")
+        err_console.print(f"Responses: {response_count}")
     if group:
         base = _ai_interviews_url()
-        console.print(f"Preview: {base}/preview/{group}/{interview_id}")
-        console.print(f"Live:    {base}/{group}/{interview_id}")
+        err_console.print(f"Preview: {base}/preview/{group}/{interview_id}")
+        err_console.print(f"Live:    {base}/{group}/{interview_id}")
 
 
 @app.command("create")

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/src/podojo_cli/commands/usertests.py

@@ -10,26 +10,44 @@ from ..client import PodojoClient
 
 app = typer.Typer(help="Manage unmoderated user tests")
 console = Console()
+err_console = Console(stderr=True, soft_wrap=True)
 
 REQUIRED_FIELDS = ["usertest_id", "title", "prototype_url", "steps"]
 VALID_STEP_TYPES = {"screen", "prototype"}
 VALID_STEP_VARIANTS = {"question", "task", "instruction"}
 REQUIRED_STEP_FIELDS = ["type", "title"]
 
-RECORDER_SNIPPET = """\
+# The rrweb.record() call lives in recorder.js rather than an inline <script>:
+# Boltable's CSP refuses inline scripts, so an inline call never runs there.
+SNIPPET_TAGS = """\
 <script src="https://usertests.podojo.com/player-v1.js" integrity="sha384-UpKcjeLZtEcYxELLISURK3MAcN3KQdTx8iygewcEWVl8LqgVrftgiMtuMHod7D8e" crossorigin="anonymous"></script>
-<script>
+<script src="./recorder.js"></script>"""
+
+RECORDER_JS = """\
+(function initRecorder() {
   if (typeof rrweb === "undefined") {
     console.error("[rrweb] failed to load — screen recording disabled");
-  } else {
-    rrweb.record({
-      emit(event) {
-        window.parent.postMessage({ type: "rrweb-event", event: event }, "*");
-      },
-      checkoutEveryNms: 30000,
-    });
+    return;
   }
-</script>
+
+  rrweb.record({
+    emit(event) {
+      window.parent.postMessage({ type: "rrweb-event", event: event }, "*");
+    },
+    checkoutEveryNms: 30000,
+  });
+})();"""
+
+RECORDER_SNIPPET = f"""\
+1. Add these two lines to every HTML page of your prototype, just before </body>:
+
+{SNIPPET_TAGS}
+
+2. Save this as recorder.js in the same folder as your pages:
+
+{RECORDER_JS}
+
+Copy both exactly – any change stops the recording.
 """
 
 EXAMPLE_YAML = """\
@@ -268,7 +286,7 @@ def _load_yaml(path: Path) -> dict:
         console.print(f"[red]Error:[/red] File not found: {path}")
         raise typer.Exit(1)
     try:
-        with open(path) as f:
+        with open(path, encoding="utf-8") as f:
             data = yaml.safe_load(f)
     except yaml.YAMLError as e:
         console.print(f"[red]Error:[/red] Invalid YAML syntax:\n{e}")
@@ -320,7 +338,7 @@ def _print_snippet_gate_error(e: httpx.HTTPStatusError) -> None:
         reason = f"the recording snippet was not found at {url}"
     console.print(f"[red]Error:[/red] Not going live: {reason}.")
     console.print("Without the snippet, participant screens are not recorded.")
-    console.print("  - Add the snippet to your prototype's <head>: [bold]podojo usertests snippet[/bold]")
+    console.print("  - Add the snippet to every page of your prototype: [bold]podojo usertests snippet[/bold]")
     console.print("  - or set [bold]live: false[/bold] to save a draft")
     console.print("  - or re-run with [bold]--allow-missing-snippet[/bold] to go live without screen recording")
 
@@ -404,15 +422,17 @@ def get_usertest(
     for key in ("id", "created_at", "created_by", "last_updated"):
         usertest.pop(key, None)
 
-    console.print(yaml.dump(usertest, default_flow_style=False, sort_keys=False, allow_unicode=True))
+    # Plain stdout, so `get > file.yaml` round-trips: rich would hard-wrap long
+    # lines and eat [markup]. The info lines go to stderr for the same reason.
+    typer.echo(yaml.dump(usertest, default_flow_style=False, sort_keys=False, allow_unicode=True))
     max_responses = usertest.get("max_responses")
     if max_responses:
-        console.print(f"Responses: {response_count} / {max_responses}")
+        err_console.print(f"Responses: {response_count} / {max_responses}")
     elif response_count:
-        console.print(f"Responses: {response_count}")
+        err_console.print(f"Responses: {response_count}")
     if group:
-        console.print(f"Preview: https://usertests.podojo.com/preview/{group}/{usertest_id}")
-        console.print(f"Live:    https://usertests.podojo.com/{group}?test={usertest_id}")
+        err_console.print(f"Preview: https://usertests.podojo.com/preview/{group}/{usertest_id}")
+        err_console.print(f"Live:    https://usertests.podojo.com/{group}?test={usertest_id}")
 
 
 @app.command("create")
@@ -457,8 +477,8 @@ def create_usertest(
         console.print(f"  Preview: https://usertests.podojo.com/preview/{group}/{usertest_id}")
         console.print(f"  Live:    https://usertests.podojo.com/{group}?test={usertest_id}")
     console.print(
-        "\n[dim]If your prototype is self-hosted, add the recorder script to its "
-        "[bold]<head>[/bold] to enable screen recording.\n"
+        "\n[dim]To record participants' screens, every page of your prototype needs "
+        "the recording snippet.\n"
         "Run [bold]podojo usertests snippet[/bold] to print it.[/dim]"
     )
 
@@ -539,5 +559,5 @@ def example():
 
 @app.command("snippet")
 def snippet():
-    """Print the recorder script to embed in self-hosted prototypes."""
+    """Print the recording snippet: two script tags for every page, plus recorder.js."""
     print(RECORDER_SNIPPET)

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/tests/test_aiinterviews.py

@@ -119,6 +119,21 @@ def test_get_ai_interview(runner, httpx_mock):
     assert "http://interviews.test.local/test-group/ai-1" in result.output
 
 
+def test_get_ai_interview_stdout_round_trips(runner, httpx_mock):
+    overview = "Participants [drivers in Tallinn] talk about " + "their last week of rides " * 6
+    httpx_mock.add_response(
+        url="http://test.local/api/v1/ai-interviews/ai-1",
+        json={**GET_RESPONSE, "overview": overview},
+    )
+
+    result = runner.invoke(app, ["aiinterviews", "get", "ai-1"])
+
+    data = yaml.safe_load(result.stdout)
+    assert data["overview"] == overview
+    assert "Responses" not in data and "Preview" not in data and "Live" not in data
+    assert "Responses: 7 / 20" in result.stderr
+
+
 def test_get_ai_interview_not_found(runner, httpx_mock):
     httpx_mock.add_response(
         url="http://test.local/api/v1/ai-interviews/nonexistent",

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/tests/test_usertests.py

@@ -1,3 +1,5 @@
+import yaml
+
 from podojo_cli.main import app
 
 
@@ -107,6 +109,26 @@ def test_get_usertest(runner, httpx_mock):
     assert "https://usertests.podojo.com/test-group?test=ut-1" in result.output
 
 
+def test_get_usertest_stdout_round_trips(runner, httpx_mock):
+    long_url = "https://uxr-prototypes.static.boltable.eu/_t/y2eb-2jft-ekzv-cn53/price-lock-test/1.html"
+    httpx_mock.add_response(
+        url="http://test.local/api/v1/usertests/ut-1",
+        json={
+            **GET_RESPONSE,
+            "prototype_url": long_url,
+            "welcome_text": "Tap [Continue] when you are ready",
+        },
+    )
+
+    result = runner.invoke(app, ["usertests", "get", "ut-1"])
+
+    data = yaml.safe_load(result.stdout)
+    assert data["prototype_url"] == long_url
+    assert data["welcome_text"] == "Tap [Continue] when you are ready"
+    assert "Responses" not in data and "Preview" not in data and "Live" not in data
+    assert "Preview: https://usertests.podojo.com/preview/test-group/ut-1" in result.stderr
+
+
 def test_get_usertest_not_found(runner, httpx_mock):
     httpx_mock.add_response(
         url="http://test.local/api/v1/usertests/nonexistent",
@@ -615,4 +637,7 @@ def test_snippet(runner):
     assert result.exit_code == 0
     assert "player-v1.js" in result.output
     assert 'integrity="sha384-' in result.output
+    assert '<script src="./recorder.js"></script>' in result.output
     assert "rrweb.record" in result.output
+    # the recording must start from recorder.js: Boltable refuses inline scripts
+    assert "<script>" not in result.output

{podojo_cli-1.25.0 → podojo_cli-1.25.2}/uv.lock

@@ -438,7 +438,7 @@ wheels = [
 
 [[package]]
 name = "podojo-cli"
-version = "1.25.0"
+version = "1.25.2"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },