Skip to content

A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.

feat: report missing Chromium for PDF export (#10453)

Péter Gyarmati9c1c5504ac35
diff --git a/frontend/src/__mocks__/requests.ts b/frontend/src/__mocks__/requests.ts
index 30a3f3c326..c78981f57c 100644
--- a/frontend/src/__mocks__/requests.ts
+++ b/frontend/src/__mocks__/requests.ts
@@ -72,26 +72,31 @@ export const MockRequestClient = {
format: "html",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
{
format: "markdown",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
{
format: "ipynb",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
{
format: "pdf",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
{
format: "script",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
],
}),
diff --git a/frontend/src/components/editor/actions/export-dialog/__tests__/export-dialog.test.tsx b/frontend/src/components/editor/actions/export-dialog/__tests__/export-dialog.test.tsx
index dfea3cb05d..3c02be33aa 100644
--- a/frontend/src/components/editor/actions/export-dialog/__tests__/export-dialog.test.tsx
+++ b/frontend/src/components/editor/actions/export-dialog/__tests__/export-dialog.test.tsx
@@ -259,6 +259,7 @@ describe("ExportDialog", () => {
format: "pdf",
dependenciesAvailable: false,
missingPackages: ["nbconvert[webpdf]"],
+ missingSetup: [],
},
],
}),
@@ -275,6 +276,40 @@ describe("ExportDialog", () => {
expect(screen.getByTestId("export-format-pdf")).toBeVisible();
});
+ it("explains missing Playwright Chromium setup", async () => {
+ store.set(
+ requestClientAtom,
+ MockRequestClient.create({
+ getExportAvailability: vi.fn().mockResolvedValue({
+ source: "server",
+ formats: [
+ {
+ format: "pdf",
+ dependenciesAvailable: false,
+ missingPackages: [],
+ missingSetup: [
+ {
+ name: "playwright-chromium",
+ command: "uv run playwright install chromium",
+ },
+ ],
+ },
+ ],
+ }),
+ }),
+ );
+
+ renderDialog("pdf");
+
+ expect(
+ await screen.findByText("PDF export requires Playwright Chromium."),
+ ).toBeVisible();
+ expect(
+ screen.getByText("uv run playwright install chromium"),
+ ).toBeVisible();
+ expect(screen.getByTestId("export-submit")).toBeDisabled();
+ });
+
it("announces requirement checks as status updates", () => {
store.set(
requestClientAtom,
diff --git a/frontend/src/components/editor/actions/export-dialog/__tests__/state.test.ts b/frontend/src/components/editor/actions/export-dialog/__tests__/state.test.ts
index 42293cafbb..8751a2d900 100644
--- a/frontend/src/components/editor/actions/export-dialog/__tests__/state.test.ts
+++ b/frontend/src/components/editor/actions/export-dialog/__tests__/state.test.ts
@@ -19,11 +19,13 @@ const AVAILABLE: ExportAvailabilityResponse = {
format: "ipynb",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
{
format: "pdf",
dependenciesAvailable: true,
missingPackages: [],
+ missingSetup: [],
},
],
};
@@ -188,6 +190,7 @@ describe("getExportFormatStatus", () => {
format: "pdf",
dependenciesAvailable: false,
missingPackages: ["nbconvert[webpdf]"],
+ missingSetup: [],
},
],
},
@@ -202,6 +205,64 @@ describe("getExportFormatStatus", () => {
});
});
+ it("reports missing server setup", () => {
+ expect(
+ status("pdf", {
+ availability: {
+ status: "success",
+ data: {
+ source: "server",
+ formats: [
+ {
+ format: "pdf",
+ dependenciesAvailable: false,
+ missingPackages: [],
+ missingSetup: [
+ {
+ name: "playwright-chromium",
+ command: "uv run playwright install chromium",
+ },
+ ],
+ },
+ ],
+ },
+ },
+ }),
+ ).toEqual({
+ available: false,
+ reason: {
+ type: "missing-setup",
+ requirements: [
+ {
+ name: "playwright-chromium",
+ command: "uv run playwright install chromium",
+ },
+ ],
+ },
+ });
+ });
+
+ it("fails open when an unavailable format has no requirements", () => {
+ expect(
+ status("pdf", {
+ availability: {
+ status: "success",
+ data: {
+ source: "server",
+ formats: [
+ {
+ format: "pdf",
+ dependenciesAvailable: false,
+ missingPackages: [],
+ missingSetup: [],
+ },
+ ],
+ },
+ },
+ }),
+ ).toEqual({ available: true, availabilityCheckFailed: true });
+ });
+
it.each([
["html", true, undefined],
["markdown", true, undefined],
diff --git a/frontend/src/components/editor/actions/export-dialog/format-notice.tsx b/frontend/src/components/editor/actions/export-dialog/format-notice.tsx
index 668ffbe34b..4efe214a08 100644
--- a/frontend/src/components/editor/actions/export-dialog/format-notice.tsx
+++ b/frontend/src/components/editor/actions/export-dialog/format-notice.tsx
@@ -10,8 +10,18 @@ import type {
ExportBlockReason,
ExportFormat,
ExportFormatStatus,
+ ExportSetupRequirement,
} from "./state";
+const SETUP_REQUIREMENTS: Record<
+ ExportSetupRequirement["name"],
+ { description: string }
+> = {
+ "playwright-chromium": {
+ description: "PDF export requires Playwright Chromium.",
+ },
+};
+
export function FormatStatusIcon({ status }: { status: ExportFormatStatus }) {
if (status.available && !status.availabilityCheckFailed) {
return null;
@@ -124,6 +134,24 @@ function ReasonNotice({
where marimo is running to use this export.
</Notice>
);
+ case "missing-setup":
+ return (
+ <Notice>
+ <span className="block min-w-0">
+ {reason.requirements.map((requirement) => {
+ const details = SETUP_REQUIREMENTS[requirement.name];
+ return (
+ <span className="block" key={requirement.name}>
+ {details.description}
+ <code className="mt-1 block break-all font-mono">
+ {requirement.command}
+ </code>
+ </span>
+ );
+ })}
+ </span>
+ </Notice>
+ );
case "wasm-runtime":
return (
<Notice>
diff --git a/frontend/src/components/editor/actions/export-dialog/state.ts b/frontend/src/components/editor/actions/export-dialog/state.ts
index 0caf7a169b..8ca3118d47 100644
--- a/frontend/src/components/editor/actions/export-dialog/state.ts
+++ b/frontend/src/components/editor/actions/export-dialog/state.ts
@@ -15,6 +15,8 @@ export const EXPORT_FORMATS = [
] as const;
export type ExportFormat = (typeof EXPORT_FORMATS)[number];
+export type ExportSetupRequirement =
+ ExportAvailabilityResponse["formats"][number]["missingSetup"][number];
export const MARKDOWN_FLAVORS = ["pymdown", "qmd", "mystmd", "mdx"] as const;
export const IPYNB_SORT_MODES = ["topological", "top-down"] as const;
@@ -185,6 +187,7 @@ export type ExportBlockReason =
| { type: "checking-requirements" }
| { type: "notebook-must-be-named" }
| { type: "missing-packages"; packages: string[] }
+ | { type: "missing-setup"; requirements: ExportSetupRequirement[] }
| { type: "wasm-runtime" };
export interface ExportFormatStatus {
@@ -308,12 +311,27 @@ export function getExportFormatStatus({
return { available: true, availabilityCheckFailed: true };
}
if (!serverStatus.dependenciesAvailable) {
+ if (serverStatus.missingPackages.length > 0) {
+ return {
+ available: false,
+ reason: {
+ type: "missing-packages",
+ packages: serverStatus.missingPackages,
+ },
+ };
+ }
+ if (serverStatus.missingSetup.length > 0) {
+ return {
+ available: false,
+ reason: {
+ type: "missing-setup",
+ requirements: serverStatus.missingSetup,
+ },
+ };
+ }
return {
- available: false,
- reason: {
- type: "missing-packages",
- packages: serverStatus.missingPackages,
- },
+ available: true,
+ availabilityCheckFailed: true,
};
}
diff --git a/frontend/src/core/network/__tests__/requests-lazy.test.ts b/frontend/src/core/network/__tests__/requests-lazy.test.ts
index 5d046de00b..4a4fb75d19 100644
--- a/frontend/src/core/network/__tests__/requests-lazy.test.ts
+++ b/frontend/src/core/network/__tests__/requests-lazy.test.ts
@@ -84,6 +84,7 @@ describe("createLazyRequests", () => {
format: "ipynb",
dependenciesAvailable: false,
missingPackages: ["nbformat"],
+ missingSetup: [],
},
],
};
diff --git a/marimo/_export/dependencies.py b/marimo/_export/dependencies.py
index 3c1aeea1fe..c9cb073f9d 100644
--- a/marimo/_export/dependencies.py
+++ b/marimo/_export/dependencies.py
@@ -1,13 +1,25 @@
# Copyright 2026 Marimo. All rights reserved.
from __future__ import annotations
+import asyncio
+import sys
+from typing import cast
+
+from marimo import _loggers
+from marimo._cli.install_hints import (
+ get_playwright_chromium_setup_commands,
+)
from marimo._dependencies.dependencies import (
DependencyLike,
DependencyManager,
DependencyRequirement,
)
+from marimo._schemas.export import ExportSetupRequirement
from marimo._schemas.export_options import ServerExportFormat
from marimo._utils.assert_never import assert_never
+from marimo._utils.async_path import isfile
+
+LOGGER = _loggers.marimo_logger()
_IPYNB_DEPENDENCIES = (DependencyManager.nbformat,)
_PDF_DEPENDENCIES = (
@@ -49,6 +61,69 @@ def get_missing_export_packages(
)
+async def get_missing_export_setup(
+ export_format: ServerExportFormat,
+) -> list[ExportSetupRequirement]:
+ """Return missing runtime setup for an export format."""
+ if export_format != "pdf" or not DependencyManager.playwright.has():
+ return []
+
+ try:
+ chromium_installed = await _is_playwright_chromium_installed()
+ except Exception as e:
+ LOGGER.warning(
+ "Failed to check whether Playwright Chromium is installed",
+ exc_info=e,
+ )
+ chromium_installed = False
+
+ if chromium_installed:
+ return []
+
+ return [
+ ExportSetupRequirement(
+ name="playwright-chromium",
+ command=get_playwright_chromium_setup_commands()[0],
+ )
+ ]
+
+
+async def _is_playwright_chromium_installed() -> bool:
+ """Return whether Playwright's matching Chromium executable exists."""
+ executable = (
+ await asyncio.to_thread(_get_playwright_chromium_executable_on_windows)
+ if sys.platform == "win32"
+ else await _get_playwright_chromium_executable()
+ )
+ return await isfile(executable)
+
+
+async def _get_playwright_chromium_executable() -> str:
+ """Return the executable expected by the installed Playwright version."""
+
+ from playwright.async_api import ( # type: ignore[import-not-found]
+ async_playwright,
+ )
+
+ async with async_playwright() as playwright:
+ return cast(str, playwright.chromium.executable_path)
+
+
+def _get_playwright_chromium_executable_on_windows() -> str:
+ # The server uses a Windows SelectorEventLoop, which cannot start the
+ # Playwright driver subprocess. This worker thread owns a Proactor loop.
+ assert sys.platform == "win32"
+ loop = asyncio.ProactorEventLoop() # type: ignore[attr-defined]
+ try:
+ return cast(
+ str,
+ loop.run_until_complete(_get_playwright_chromium_executable()),
+ )
+ finally:
+ loop.run_until_complete(loop.shutdown_asyncgens())
+ loop.close()
+
+
def require_export_dependencies(
export_format: ServerExportFormat,
why: str,
diff --git a/marimo/_schemas/export.py b/marimo/_schemas/export.py
index 8d295cd510..e73aec45b0 100644
--- a/marimo/_schemas/export.py
+++ b/marimo/_schemas/export.py
@@ -9,6 +9,7 @@ from marimo._convert.markdown.flavor.base import MarkdownFlavorName
from marimo._messaging.mimetypes import MimeBundleTuple
from marimo._schemas.export_options import (
ExportPDFPreset,
+ ExportSetupRequirementName,
HTMLExportOptions,
IPYNBExportOptions,
IPYNBSortMode,
@@ -101,10 +102,16 @@ class ExportedFile(msgspec.Struct, rename="camel"):
media_type: str
+class ExportSetupRequirement(msgspec.Struct, rename="camel", frozen=True):
+ name: ExportSetupRequirementName
+ command: str
+
+
class ExportFormatAvailability(msgspec.Struct, rename="camel", frozen=True):
format: ServerExportFormat
dependencies_available: bool
missing_packages: list[str]
+ missing_setup: list[ExportSetupRequirement]
class ExportAvailabilityResponse(msgspec.Struct, rename="camel", frozen=True):
diff --git a/marimo/_schemas/export_options.py b/marimo/_schemas/export_options.py
index abf79e210e..9385c726d0 100644
--- a/marimo/_schemas/export_options.py
+++ b/marimo/_schemas/export_options.py
@@ -13,6 +13,7 @@ ExportPDFPreset = Literal["document", "slides"]
IPYNBSortMode = Literal["top-down", "topological"]
PDFRasterServer = Literal["static", "live"]
ServerExportFormat = Literal["html", "markdown", "ipynb", "pdf", "script"]
+ExportSetupRequirementName = Literal["playwright-chromium"]
SERVER_EXPORT_FORMATS: tuple[ServerExportFormat, ...] = get_args(
ServerExportFormat
)
diff --git a/marimo/_server/api/endpoints/export.py b/marimo/_server/api/endpoints/export.py
index 7ad5636fcc..70ed514d34 100644
--- a/marimo/_server/api/endpoints/export.py
+++ b/marimo/_server/api/endpoints/export.py
@@ -21,7 +21,10 @@ from marimo._convert.common.filename import (
make_export_headers,
)
from marimo._convert.script import UnsupportedAsyncCodeError
-from marimo._export.dependencies import get_missing_export_packages
+from marimo._export.dependencies import (
+ get_missing_export_packages,
+ get_missing_export_setup,
+)
from marimo._export.exporter import (
AutoExporter,
Exporter,
@@ -86,7 +89,7 @@ async def get_export_availability(
"""
responses:
200:
- description: Dependency readiness for server-backed exports
+ description: Readiness for server-backed exports
content:
application/json:
schema:
@@ -96,11 +99,18 @@ async def get_export_availability(
formats: list[ExportFormatAvailability] = []
for export_format in SERVER_EXPORT_FORMATS:
missing_packages = get_missing_export_packages(export_format)
+ missing_setup = (
+ []
+ if missing_packages
+ else await get_missing_export_setup(export_format)
+ )
formats.append(
ExportFormatAvailability(
format=export_format,
- dependencies_available=not missing_packages,
+ dependencies_available=not missing_packages
+ and not missing_setup,
missing_packages=missing_packages,
+ missing_setup=missing_setup,
)
)
return ExportAvailabilityResponse(source="server", formats=formats)
diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yaml
index d41b78e87a..9723adc3dd 100644
--- a/packages/openapi/api.yaml
+++ b/packages/openapi/api.yaml
@@ -1962,12 +1962,29 @@ components:
items:
type: string
type: array
+ missingSetup:
+ items:
+ $ref: '#/components/schemas/ExportSetupRequirement'
+ type: array
required:
- format
- dependenciesAvailable
- missingPackages
+ - missingSetup
title: ExportFormatAvailability
type: object
+ ExportSetupRequirement:
+ properties:
+ command:
+ type: string
+ name:
+ enum:
+ - playwright-chromium
+ required:
+ - name
+ - command
+ title: ExportSetupRequirement
+ type: object
FileCopyRequest:
properties:
newPath:
@@ -6601,7 +6618,7 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ExportAvailabilityResponse'
- description: Dependency readiness for server-backed exports
+ description: Readiness for server-backed exports
/api/export/html:
post:
parameters:
diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.ts
index 06e79040d6..38d8a84e8a 100644
--- a/packages/openapi/src/api.ts
+++ b/packages/openapi/src/api.ts
@@ -906,7 +906,7 @@ export interface paths {
};
requestBody?: never;
responses: {
- /** @description Dependency readiness for server-backed exports */
+ /** @description Readiness for server-backed exports */
200: {
headers: {
[name: string]: unknown;
@@ -4823,6 +4823,13 @@ export interface components {
/** @enum {unknown} */
format: "html" | "ipynb" | "markdown" | "pdf" | "script";
missingPackages: string[];
+ missingSetup: components["schemas"]["ExportSetupRequirement"][];
+ };
+ /** ExportSetupRequirement */
+ ExportSetupRequirement: {
+ command: string;
+ /** @enum {unknown} */
+ name: "playwright-chromium";
};
/** FileCopyRequest */
FileCopyRequest: {
diff --git a/tests/_export/test_export_availability.py b/tests/_export/test_export_availability.py
index 7d6561399d..523a58f1d2 100644
--- a/tests/_export/test_export_availability.py
+++ b/tests/_export/test_export_availability.py
@@ -1,7 +1,10 @@
# Copyright 2026 Marimo. All rights reserved.
from __future__ import annotations
-from unittest.mock import patch
+import asyncio
+import sys
+from types import SimpleNamespace
+from unittest.mock import AsyncMock, MagicMock, patch
import pytest
@@ -9,11 +12,15 @@ from marimo._ast.app import App, InternalApp
from marimo._dependencies.dependencies import DependencyManager
from marimo._dependencies.errors import ManyModulesNotFoundError
from marimo._export.dependencies import (
+ _get_playwright_chromium_executable_on_windows,
+ _is_playwright_chromium_installed,
get_missing_export_packages,
+ get_missing_export_setup,
require_export_dependencies,
)
from marimo._export.exporter import Exporter
from marimo._export.requests import IPYNBExportRequest
+from marimo._schemas.export import ExportSetupRequirement
from marimo._schemas.export_options import (
SERVER_EXPORT_FORMATS,
IPYNBExportOptions,
@@ -70,6 +77,123 @@ def test_ipynb_requirement_uses_nbformat() -> None:
assert get_missing_export_packages("ipynb") == ["nbformat"]
+ ("chromium_installed", "missing_setup"),
+ [
+ (True, []),
+ (
+ False,
+ [
+ ExportSetupRequirement(
+ name="playwright-chromium",
+ command="uv run playwright install chromium",
+ )
+ ],
+ ),
+ ],
+)
+async def test_pdf_setup_requires_playwright_chromium(
+ *,
+ chromium_installed: bool,
+ missing_setup: list[ExportSetupRequirement],
+) -> None:
+ with (
+ patch.object(DependencyManager.playwright, "has", return_value=True),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=AsyncMock(return_value=chromium_installed),
+ ),
+ patch(
+ "marimo._export.dependencies.get_playwright_chromium_setup_commands",
+ return_value=["uv run playwright install chromium"],
+ ),
+ ):
+ assert await get_missing_export_setup("pdf") == missing_setup
+
+
+async def test_pdf_setup_is_deferred_until_playwright_is_installed() -> None:
+ probe = AsyncMock()
+ with (
+ patch.object(DependencyManager.playwright, "has", return_value=False),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=probe,
+ ),
+ ):
+ assert await get_missing_export_setup("pdf") == []
+ probe.assert_not_awaited()
+
+
+async def test_chromium_probe_checks_playwright_executable() -> None:
+ context = MagicMock()
+ context.__aenter__.return_value = SimpleNamespace(
+ chromium=SimpleNamespace(executable_path="/playwright/chromium")
+ )
+ async_api = MagicMock()
+ async_api.async_playwright.return_value = context
+ is_file = AsyncMock(return_value=True)
+
+ with (
+ patch.dict(
+ sys.modules,
+ {
+ "playwright": MagicMock(),
+ "playwright.async_api": async_api,
+ },
+ ),
+ patch("marimo._export.dependencies.sys.platform", "linux"),
+ patch("marimo._export.dependencies.isfile", new=is_file),
+ ):
+ assert await _is_playwright_chromium_installed() is True
+
+ async_api.async_playwright.assert_called_once_with()
+ context.__aexit__.assert_awaited_once()
+ is_file.assert_awaited_once_with("/playwright/chromium")
+
+
+async def test_chromium_probe_uses_proactor_worker_on_windows() -> None:
+ to_thread = AsyncMock(return_value="C:/playwright/chromium.exe")
+ is_file = AsyncMock(return_value=True)
+ with (
+ patch("marimo._export.dependencies.sys.platform", "win32"),
+ patch("marimo._export.dependencies.asyncio.to_thread", new=to_thread),
+ patch("marimo._export.dependencies.isfile", new=is_file),
+ ):
+ assert await _is_playwright_chromium_installed() is True
+
+ to_thread.assert_awaited_once_with(
+ _get_playwright_chromium_executable_on_windows
+ )
+ is_file.assert_awaited_once_with("C:/playwright/chromium.exe")
+
+
+def test_windows_chromium_probe_owns_proactor_loop() -> None:
+ loop = MagicMock()
+ loop.run_until_complete.side_effect = [
+ "C:/playwright/chromium.exe",
+ None,
+ ]
+ loop.shutdown_asyncgens = AsyncMock()
+
+ with (
+ patch("marimo._export.dependencies.sys.platform", "win32"),
+ patch.object(
+ asyncio,
+ "ProactorEventLoop",
+ create=True,
+ return_value=loop,
+ ),
+ ):
+ assert (
+ _get_playwright_chromium_executable_on_windows()
+ == "C:/playwright/chromium.exe"
+ )
+
+ for call in loop.run_until_complete.call_args_list:
+ call.args[0].close()
+ loop.close.assert_called_once_with()
+
+
def test_ipynb_export_requires_server_dependency() -> None:
with (
patch.object(DependencyManager.nbformat, "has", return_value=False),
diff --git a/tests/_server/api/endpoints/test_export.py b/tests/_server/api/endpoints/test_export.py
index fef4ff79be..eec35280d1 100644
--- a/tests/_server/api/endpoints/test_export.py
+++ b/tests/_server/api/endpoints/test_export.py
@@ -9,7 +9,7 @@ import time
from pathlib import Path
from textwrap import dedent
from typing import TYPE_CHECKING
-from unittest.mock import patch
+from unittest.mock import AsyncMock, patch
from urllib.parse import quote
import pytest
@@ -80,16 +80,22 @@ def test_export_availability_reports_server_dependencies(
client: TestClient,
) -> None:
get_session_manager(client).mode = SessionMode.RUN
+ probe = AsyncMock()
with (
patch.object(DependencyManager.nbformat, "has", return_value=False),
patch.object(DependencyManager.nbconvert, "has", return_value=True),
- patch.object(DependencyManager.playwright, "has", return_value=False),
+ patch.object(DependencyManager.playwright, "has", return_value=True),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=probe,
+ ),
):
response = client.get(
"/api/export/availability",
headers=token_header(),
)
+ probe.assert_not_awaited()
assert response.status_code == 200
assert response.json() == {
"source": "server",
@@ -98,31 +104,148 @@ def test_export_availability_reports_server_dependencies(
"format": "html",
"dependenciesAvailable": True,
"missingPackages": [],
+ "missingSetup": [],
},
{
"format": "markdown",
"dependenciesAvailable": True,
"missingPackages": [],
+ "missingSetup": [],
},
{
"format": "ipynb",
"dependenciesAvailable": False,
"missingPackages": ["nbformat"],
+ "missingSetup": [],
},
{
"format": "pdf",
"dependenciesAvailable": False,
"missingPackages": ["nbconvert[webpdf]"],
+ "missingSetup": [],
},
{
"format": "script",
"dependenciesAvailable": True,
"missingPackages": [],
+ "missingSetup": [],
},
],
}
+def test_export_availability_reports_available_pdf(
+ client: TestClient,
+) -> None:
+ get_session_manager(client).mode = SessionMode.RUN
+ probe = AsyncMock(return_value=True)
+ with (
+ patch.object(DependencyManager.nbformat, "has", return_value=True),
+ patch.object(DependencyManager.nbconvert, "has", return_value=True),
+ patch.object(DependencyManager.playwright, "has", return_value=True),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=probe,
+ ),
+ ):
+ response = client.get(
+ "/api/export/availability",
+ headers=token_header(),
+ )
+
+ probe.assert_awaited_once_with()
+ assert response.status_code == 200
+ pdf = next(
+ item for item in response.json()["formats"] if item["format"] == "pdf"
+ )
+ assert pdf == {
+ "format": "pdf",
+ "dependenciesAvailable": True,
+ "missingPackages": [],
+ "missingSetup": [],
+ }
+
+
+def test_export_availability_reports_missing_pdf_setup(
+ client: TestClient,
+) -> None:
+ get_session_manager(client).mode = SessionMode.RUN
+ with (
+ patch.object(DependencyManager.nbformat, "has", return_value=True),
+ patch.object(DependencyManager.nbconvert, "has", return_value=True),
+ patch.object(DependencyManager.playwright, "has", return_value=True),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=AsyncMock(return_value=False),
+ ),
+ patch(
+ "marimo._export.dependencies.get_playwright_chromium_setup_commands",
+ return_value=["uv run playwright install chromium"],
+ ),
+ ):
+ response = client.get(
+ "/api/export/availability",
+ headers=token_header(),
+ )
+
+ assert response.status_code == 200
+ pdf = next(
+ item for item in response.json()["formats"] if item["format"] == "pdf"
+ )
+ assert pdf == {
+ "format": "pdf",
+ "dependenciesAvailable": False,
+ "missingPackages": [],
+ "missingSetup": [
+ {
+ "name": "playwright-chromium",
+ "command": "uv run playwright install chromium",
+ }
+ ],
+ }
+
+
+def test_export_availability_handles_pdf_setup_probe_failure(
+ client: TestClient,
+) -> None:
+ get_session_manager(client).mode = SessionMode.RUN
+ error = RuntimeError("driver failed")
+ with (
+ patch.object(DependencyManager.nbformat, "has", return_value=True),
+ patch.object(DependencyManager.nbconvert, "has", return_value=True),
+ patch.object(DependencyManager.playwright, "has", return_value=True),
+ patch(
+ "marimo._export.dependencies._is_playwright_chromium_installed",
+ new=AsyncMock(side_effect=error),
+ ),
+ patch(
+ "marimo._export.dependencies.get_playwright_chromium_setup_commands",
+ return_value=["uv run playwright install chromium"],
+ ),
+ patch("marimo._export.dependencies.LOGGER.warning") as warning,
+ ):
+ response = client.get(
+ "/api/export/availability",
+ headers=token_header(),
+ )
+
+ assert response.status_code == 200
+ pdf = next(
+ item for item in response.json()["formats"] if item["format"] == "pdf"
+ )
+ assert pdf["dependenciesAvailable"] is False
+ assert pdf["missingSetup"] == [
+ {
+ "name": "playwright-chromium",
+ "command": "uv run playwright install chromium",
+ }
+ ]
+ warning.assert_called_once_with(
+ "Failed to check whether Playwright Chromium is installed",
+ exc_info=error,
+ )
+
+
@with_session(SESSION_ID)
def test_export_html(client: TestClient) -> None:
session = get_session_manager(client).get_session(SESSION_ID)