Skip to content

Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥

Add viewport dimension support for Playwright engine screenshots

Devin AId7f595b434a4
diff --git a/apps/api/src/__tests__/snips/v2/scrape-viewport.test.ts b/apps/api/src/__tests__/snips/v2/scrape-viewport.test.ts
index e3fba0dfe..b2f7c25ba 100644
--- a/apps/api/src/__tests__/snips/v2/scrape-viewport.test.ts
+++ b/apps/api/src/__tests__/snips/v2/scrape-viewport.test.ts
@@ -40,9 +40,9 @@ describe("V2 Scrape Screenshot Viewport", () => {
);
test(
- "should take full page screenshot with custom viewport width",
+ "should reject fullPage=true with viewport",
async () => {
- const data = await scrape(
+ const response = await scrapeRaw(
{
url: "https://example.com",
formats: [
@@ -59,8 +59,11 @@ describe("V2 Scrape Screenshot Viewport", () => {
identity,
);
- expect(data).toBeDefined();
- expect(data.screenshot).toBeDefined();
+ expect(response.status).toBe(400);
+ expect(response.body.success).toBe(false);
+ expect(response.body.error).toContain(
+ "Cannot specify viewport dimensions when fullPage is true",
+ );
},
scrapeTimeout,
);
diff --git a/apps/api/src/controllers/v2/types.ts b/apps/api/src/controllers/v2/types.ts
index dd7c0c168..8511cf270 100644
--- a/apps/api/src/controllers/v2/types.ts
+++ b/apps/api/src/controllers/v2/types.ts
@@ -201,17 +201,22 @@ const actionSchema = z.union([
selector: z.string(),
all: z.boolean().default(false),
}),
- z.object({
- type: z.literal("screenshot"),
- fullPage: z.boolean().default(false),
- quality: z.number().min(1).max(100).optional(),
- viewport: z
- .object({
- width: z.number().int().positive().finite().max(7680), // 8K resolution width
- height: z.number().int().positive().finite().max(4320), // 8K resolution height
- })
- .optional(),
- }),
+ z
+ .object({
+ type: z.literal("screenshot"),
+ fullPage: z.boolean().default(false),
+ quality: z.number().min(1).max(100).optional(),
+ viewport: z
+ .object({
+ width: z.number().int().positive().finite().max(7680), // 8K resolution width
+ height: z.number().int().positive().finite().max(4320), // 8K resolution height
+ })
+ .optional(),
+ })
+ .refine(data => !(data.fullPage === true && data.viewport !== undefined), {
+ message: "Cannot specify viewport dimensions when fullPage is true",
+ path: ["viewport"],
+ }),
z.object({
type: z.literal("write"),
text: z.string(),
@@ -302,17 +307,22 @@ type ChangeTrackingFormatWithOptions = z.output<
typeof changeTrackingFormatWithOptions
>;
-const screenshotFormatWithOptions = z.object({
- type: z.literal("screenshot"),
- fullPage: z.boolean().default(false),
- quality: z.number().min(1).max(100).optional(),
- viewport: z
- .object({
- width: z.number().int().positive().finite().max(7680), // 8K resolution width
- height: z.number().int().positive().finite().max(4320), // 8K resolution height
- })
- .optional(),
-});
+const screenshotFormatWithOptions = z
+ .object({
+ type: z.literal("screenshot"),
+ fullPage: z.boolean().default(false),
+ quality: z.number().min(1).max(100).optional(),
+ viewport: z
+ .object({
+ width: z.number().int().positive().finite().max(7680), // 8K resolution width
+ height: z.number().int().positive().finite().max(4320), // 8K resolution height
+ })
+ .optional(),
+ })
+ .refine(data => !(data.fullPage === true && data.viewport !== undefined), {
+ message: "Cannot specify viewport dimensions when fullPage is true",
+ path: ["viewport"],
+ });
type ScreenshotFormatWithOptions = z.output<typeof screenshotFormatWithOptions>;
diff --git a/apps/api/src/scraper/scrapeURL/engines/fire-engine/index.ts b/apps/api/src/scraper/scrapeURL/engines/fire-engine/index.ts
index b8d575112..bf04157b3 100644
--- a/apps/api/src/scraper/scrapeURL/engines/fire-engine/index.ts
+++ b/apps/api/src/scraper/scrapeURL/engines/fire-engine/index.ts
@@ -385,6 +385,7 @@ export async function scrapeURLWithFireEnginePlaywright(
hasFormatOfType(meta.options.formats, "screenshot") !== undefined,
fullPageScreenshot: hasFormatOfType(meta.options.formats, "screenshot")
?.fullPage,
+ viewport: hasFormatOfType(meta.options.formats, "screenshot")?.viewport,
wait: meta.options.waitFor,
geolocation: meta.options.location,
blockAds: meta.options.blockAds,
diff --git a/apps/api/src/scraper/scrapeURL/engines/fire-engine/scrape.ts b/apps/api/src/scraper/scrapeURL/engines/fire-engine/scrape.ts
index 743f744ed..6734d233a 100644
--- a/apps/api/src/scraper/scrapeURL/engines/fire-engine/scrape.ts
+++ b/apps/api/src/scraper/scrapeURL/engines/fire-engine/scrape.ts
@@ -62,6 +62,7 @@ export type FireEngineScrapeRequestPlaywright = {
// mutually exclusive, default: false
screenshot?: boolean;
fullPageScreenshot?: boolean;
+ viewport?: { width: number; height: number };
wait?: number; // default: 0
};