#8990: fix non-awaited screenshot promise

end-to-end-tests/fixtures/utils.ts

@@ -41,9 +41,6 @@ export const launchPersistentContextWithExtension = async (
     ],
     slowMo: SLOWMO ? 3000 : undefined,
     permissions: ["clipboard-read", "clipboard-write", "accessibility-events"],
-    // Set the viewport to null because we rely on the real inner window width to detect when the sidepanel is open
-    // See: https://github.com/microsoft/playwright/issues/11465 and https://github.com/pixiebrix/pixiebrix-extension/blob/b4b0a2efde2c3ac5e634220b555532a2875fe5da/src/contentScript/sidebarController.tsx#L78
-    viewport: null,
   });
 };
 

end-to-end-tests/tests/runtime/screenshotTab.spec.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2024 PixieBrix, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import { test, expect } from "../../fixtures/testBase";
+import { ActivateModPage } from "../../pageObjects/extensionConsole/modsPage";
+// @ts-expect-error -- https://youtrack.jetbrains.com/issue/AQUA-711/Provide-a-run-configuration-for-Playwright-tests-in-specs-with-fixture-imports-only
+import { test as base } from "@playwright/test";
+import { runModViaQuickBar } from "../../utils";
+
+test("screenshot tab brick functionality", async ({ page, extensionId }) => {
+  const modId = "@e2e-testing/test-screenshot";
+
+  const modActivationPage = new ActivateModPage(page, extensionId, modId);
+  await modActivationPage.goto();
+
+  await modActivationPage.clickActivateAndWaitForModsPageRedirect();
+
+  await page.goto("/advanced-fields/");
+
+  await runModViaQuickBar(page, "Screenshot");
+
+  const screenshotModalFrame = page.frameLocator(
+    'iframe[title="Modal content"]',
+  );
+
+  await expect(
+    screenshotModalFrame.getByText("Screenshot modal"),
+  ).toBeVisible();
+
+  await expect(screenshotModalFrame.getByRole("img")).toHaveScreenshot(
+    "screenshotTab.png",
+  );
+});

playwright.config.ts

@@ -23,6 +23,9 @@ export default defineConfig<{ chromiumChannel: string }>({
   expect: {
     /* Timeout for each assertion. If a particular interaction is timing out, adjust its specific timeout value rather than this global setting */
     timeout: 5000,
+    toHaveScreenshot: {
+      maxDiffPixelRatio: 0.1,
+    },
   },
   reportSlowTests: null,
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */

src/bricks/transformers/screenshotTab.ts

@@ -46,12 +46,12 @@ export class ScreenshotTab extends TransformerABC {
   override defaultOutputKey = "screenshot";
 
   async transform(
-    args: BrickArgs,
+    _args: BrickArgs,
     { platform }: BrickOptions,
-  ): Promise<unknown> {
+  ): Promise<{ data: string }> {
     try {
       return {
-        data: platform.capture.captureScreenshot(),
+        data: await platform.capture.captureScreenshot(),
       };
     } catch (error) {
       if (getErrorMessage(error).includes("activeTab")) {