feat(export): install requirements from dialog - #10471
Open
peter-gy wants to merge 2 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
All contributors have signed the CLA ✍️ ✅ |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 13 files
Architecture diagram
sequenceDiagram
participant UI as ExportDialog (React)
participant Hook as useExportDialog
participant Toast as Toaster / Toast
participant Backend as /api/editing/install_missing_packages
participant Deps as Export Dependencies
participant Subprocess as subprocess (playwright install)
Note over UI,Subprocess: NEW: Install action from export dialog
UI->>Hook: user clicks "Install" button
alt missing-packages reason
Hook->>Hook: NEW: collect packages from reason.packages
else missing-setup reason (Playwright Chromium)
Hook->>Hook: NEW: no packages, format === "pdf"
end
Hook->>Hook: NEW: set isInstalling = true
Hook->>Backend: POST install_missing_packages<br/>{versions, manager, source: "server", installPlaywrightChromium: true}
Note over Hook,Backend: NEW: installPlaywrightChromium field in request
alt error
Backend-->>Toast: HTTPError with detail message
Toast-->>UI: CHANGED: toast rendered in portal (StyleNamespace)<br/>"Failed to install missing packages"
Hook->>Hook: error logged, isInstalling = false
else success
Backend->>Deps: CHANGED: if versions present, install packages on server<br/>if installPlaywrightChromium, also run:
Deps->>Subprocess: NEW: [sys.executable, "-m", "playwright", "install", "chromium"]
alt subprocess fails
Subprocess-->>Deps: non-zero return code
Deps-->>Backend: raise RuntimeError
Backend-->>Toast: error toast
else subprocess succeeds
Subprocess-->>Deps: exit code 0
Deps-->>Backend: success
Backend-->>Hook: 200 OK
Hook->>Hook: NEW: refetchExportAvailability()
Hook->>Hook: set isInstalling = false
end
end
Note over UI,Hook: UI re-renders with updated dependenciesAvailable state
UI->>UI: CHANGED: tabs re-enabled, install button removed, submit enabled
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Collaborator
Author
|
@cubic-dev-ai review please |
Contributor
@peter-gy I have started the AI code review. It will take a few minutes to complete. |
Contributor
There was a problem hiding this comment.
No issues found across 15 files
Architecture diagram
sequenceDiagram
participant User as Browser User
participant Dialog as ExportDialog (React)
participant Hook as useExportDialog (React Hook)
participant Client as RequestClient (Lazy)
participant Server as marimo Server (FastAPI)
participant Deps as Export Dependencies (Python)
participant OS as Subprocess (OS)
Note over User,OS: Install Export Requirements Flow
User->>Dialog: Opens Export Dialog
Dialog->>Hook: Initialize state
Hook->>Client: getExportAvailability()
Client->>Server: GET /api/export/availability
Server-->>Client: formats[] with missingPackages / missingSetup
Client-->>Hook: ExportAvailabilityResponse
Hook->>Hook: Compute canInstall flag
Hook-->>Dialog: format status (unavailable, missing packages/setup)
Dialog->>Dialog: Render FormatNotice with Install button
alt User clicks Install button
User->>Dialog: Click "Install"
Dialog->>Hook: installRequirements()
Hook->>Hook: set isInstalling=true
Hook->>Client: sendInstallMissingPackages({manager, versions, source:"server", installPlaywrightChromium})
Client->>Client: Check connection state
alt Connection not yet open
Client->>Client: initOnce() - start WebSocket connection
end
Client->>Client: waitForConnectionOpen() - skip kernel init
Client->>Server: POST /api/kernel/install_missing_packages
Server->>Server: enforce_consumer_capability()
alt Has packages to install (versions non-empty)
Server->>Server: install_packages_on_server(manager, versions)
end
alt installPlaywrightChromium is true
Server->>Deps: install_playwright_chromium()
Deps->>OS: subprocess.run([sys.executable, "-m", "playwright", "install", "chromium"])
alt Success (returncode=0)
OS-->>Deps: stdout
else Failure (returncode!=0 or timeout)
OS-->>Deps: stderr / TimeoutExpired
Deps-->>Server: Raise RuntimeError
end
end
Server-->>Client: 200 OK (or error)
alt Success
Client-->>Hook: null
Hook->>Client: availabilityRequest.refetch()
Client->>Server: GET /api/export/availability
Server-->>Client: Updated formats (dependenciesAvailable:true)
Client-->>Hook: new ExportAvailabilityResponse
Hook-->>Dialog: Update format status (export enabled)
Dialog->>User: Export button becomes enabled, Install button hidden
else Error (HTTP 500)
Client-->>Hook: Rejects with HTTPError
Hook->>Hook: Catch error, log
Hook->>Hook: set isInstalling=false
Hook-->>Dialog: Toast: "Failed to install missing packages"
Dialog->>User: Install button re-enabled, error toast displayed
end
end
Note over Hook,Client: Guard: installAllowed check from user config
Note over Client,Server: Server install skips kernel dependency (no waitForKernelToBeInstantiated)
peter-gy
marked this pull request as draft
August 6, 2026 09:46
Add the dialog action and typed request plumbing, refresh availability after installation, and preserve manual setup guidance.
peter-gy
force-pushed
the
ptr/install-deps-from-export-dialog
branch
from
August 6, 2026 12:01
ca4c7f1 to
9b27518
Compare
peter-gy
changed the title
Collaborator
Author
|
@cubic-dev-ai review please |
Contributor
@peter-gy I have started the AI code review. It will take a few minutes to complete. |
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 16 files
Architecture diagram
sequenceDiagram
participant User
participant ExportDialog as Export Dialog
participant useExportDialog as useExportDialog Hook
participant Requests as Request Client Layer
participant Server as Server API
participant Toast as Toast Notification
Note over User,Toast: User opens export dialog for unavailable format (e.g., PDF)
ExportDialog->>useExportDialog: mount & initialize
useExportDialog->>Requests: getExportAvailability()
Requests->>Server: GET /api/export/availability
Server-->>Requests: { formats: [ { format: "pdf", dependenciesAvailable: false, missingPackages: ["nbconvert[webpdf]"] } ] }
Requests-->>useExportDialog: availability response
useExportDialog->>useExportDialog: compute canInstall (installAllowed && missing-packages|missing-setup)
useExportDialog-->>ExportDialog: status = unavailable, canInstall = true
ExportDialog->>User: render format notice with Install button
Note over User,Toast: User clicks Install button
User->>ExportDialog: click Install
ExportDialog->>useExportDialog: installRequirements()
useExportDialog->>useExportDialog: setIsInstalling(true)
useExportDialog->>ExportDialog: re-render with busy state
ExportDialog->>ExportDialog: disable all export tabs & submit button
useExportDialog->>Requests: installExportRequirements({ format: "pdf" })
alt Session not connected
Requests->>Requests: startConnectionWithoutKernel (init runtime + waitForConnectionOpen)
Note over Requests: Does NOT waitForKernelToBeInstantiated
end
Requests->>Server: POST /api/export/requirements/install { format: "pdf" }
alt Installation succeeds
Server-->>Requests: { source: "server", formats: [ { format: "pdf", dependenciesAvailable: true } ] }
Requests-->>useExportDialog: updated availability
useExportDialog->>useExportDialog: availabilityRequest.setData(availability)
useExportDialog->>Requests: getExportAvailability() (refreshes full manifest)
Requests-->>useExportDialog: fresh availability
useExportDialog->>useExportDialog: setIsInstalling(false)
useExportDialog-->>ExportDialog: status = available, canInstall = false
ExportDialog->>ExportDialog: re-enable & allow export
ExportDialog-->>User: format now ready, Install button gone
else Installation fails
Server-->>Requests: HTTP 500 { detail: "Playwright Chromium installation failed..." }
Requests-->>Toast: toast({ title: "Failed to install export requirements", description: "...", variant: "danger" })
Requests-->>useExportDialog: rejected promise
useExportDialog->>useExportDialog: setIsInstalling(false) in finally block
useExportDialog-->>ExportDialog: install button re-enabled, format still unavailable
ExportDialog-->>User: Install button clickable again, error toast visible
end
Note over ExportDialog,User: Read-only / kiosk mode (Install button hidden entirely)
alt mode=read or kioskMode or ?kiosk query param
useExportDialog->>useInstallAllowed: returns false
useExportDialog->>ExportDialog: canInstall = false
ExportDialog->>User: show setup command text (e.g., "uv run playwright install chromium") instead of Install button
end
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Match the server's exact kiosk=true contract so explicit false values keep installation available. Cover pending install locking and kernel-independent instantiation in the surrounding flow.
peter-gy
marked this pull request as ready for review
August 6, 2026 12:45
mscolnick
reviewed
Aug 6, 2026
| getExportAvailability: () => { | ||
| return getClient().GET("/api/export/availability").then(handleResponse); | ||
| }, | ||
| installExportRequirements: (request) => { |
Contributor
There was a problem hiding this comment.
is it possible to avoid another endpoint by reusing the existing install command?
| | "throwError" | ||
| | "dropRequest" | ||
| | "startConnection" | ||
| | "startConnectionWithoutKernel" |
Contributor
There was a problem hiding this comment.
Should this just be waitForConnection? I may need to revisit some of this logic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion of #10473.
Summary
The export dialog identifies missing requirements, but users must install them outside the web UI.
Add a compact Install action to unavailable export formats. The action calls the server-owned installation contract from #10473, refreshes availability after installation, and prevents overlapping dialog actions while the request is running. Installation failures use the existing request toast above the dialog.
Read-only and kiosk views keep the manual setup command visible.
Demo