fix(core): declare CUA screenshot media type at capture boundary#2300
Open
yawbtng wants to merge 1 commit into
Open
fix(core): declare CUA screenshot media type at capture boundary#2300yawbtng wants to merge 1 commit into
yawbtng wants to merge 1 commit into
Conversation
Closes browserbase#2046. Reshapes the screenshot-provider contract per review on browserbase#2159: setScreenshotProvider now returns { base64, mediaType } (ScreenshotProviderResult) instead of a bare base64 string, so the media type is declared once at capture and passed through by every CUA client rather than hardcoded or inferred per-client. - handler captures PNG explicitly and returns image/png - Anthropic: media_type: screenshot.mediaType - Google: mimeType: screenshot.mediaType (removes PNG-only prefix strip) - OpenAI/Microsoft: build data:${mediaType};base64,${base64} - options.base64Image path defaults to image/png (unchanged behavior) Updates the public API type test and CUA client tests, and adds cua-screenshot-mediatype coverage asserting a non-PNG media type is honored across all four clients.
🦋 Changeset detectedLatest commit: affd2ad The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
This PR is from an external contributor and must be approved by a stagehand team member with write access before CI can run. |
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.
why
Closes #2046. This is the reshaped version of #2159, following the approach @seanmcguire12 outlined when closing that PR.
setScreenshotProviderreturned a bare base64 string, so every CUA client had to independently infer or hardcode the media type — all four assumedimage/png. A non-PNG screenshot (e.g. a JPEG from a custom provider) was then mislabeled as PNG in the provider function-response payload, which is the root of #2046. Clients also stripped a hardcodeddata:image/png;base64,prefix by regex, so any other prefix silently broke.what changed
Move the media-type declaration to the capture boundary.
setScreenshotProvidernow returns an explicit payload:v3CuaAgentHandler) captures PNG explicitly (type: "png") and returns{ base64, mediaType: "image/png" }, so the default is unchanged.media_type: screenshot.mediaType,data: screenshot.base64(drops the.replace(/^data:image\/png;base64,/, "")).mimeType: screenshot.mediaType(drops the PNG-only prefix strip).data:${screenshot.mediaType};base64,${screenshot.base64}.options.base64Image(caller-supplied) still defaults toimage/png, preserving existing behavior.ScreenshotProviderResultis exported from the public entrypoint.testing
cua-screenshot-mediatype.test.ts: asserts a non-PNG (image/jpeg) media type is honored by all four clients'captureScreenshot(), and that theoptions.base64Imagepath still defaults to png.setScreenshotProvider(...)and the Anthropic/Microsoft CUA client tests to the new provider shape.pnpm --filter @browserbasehq/stagehand run typecheckpasses; the CUA + public-API unit suites are green (55 tests).Summary by cubic
Declare the screenshot media type at the capture boundary and pass it through all CUA clients. Fixes non‑PNG screenshots being mislabeled as PNG and removes PNG-only prefix stripping.
Bug Fixes
setScreenshotProvidernow returns{ base64, mediaType }(ScreenshotProviderResult) instead of a string.image/png.mediaTypethrough; OpenAI/Microsoft builddata:${mediaType};base64,${base64}; removed PNG-only prefix regex.options.base64Imagestill defaults toimage/png.Migration
setScreenshotProvider, return{ base64, mediaType: "image/png" | "image/jpeg" }instead of a base64 string.Written for commit affd2ad. Summary will update on new commits.