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.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
prevent layout shift for auto-export ipynb (#7965)
Shahmir Varqha49c7e0fec431
diff --git a/frontend/src/core/export/hooks.ts b/frontend/src/core/export/hooks.tsindex 324ee2cd82..e1c8d8859a 100644--- a/frontend/src/core/export/hooks.ts+++ b/frontend/src/core/export/hooks.ts@@ -132,7 +132,7 @@ export function useEnrichCellOutputs() {const results = await Promise.all(cellsToCaptureScreenshot.map(async ([cellId]) => {try {- const dataUrl = await getImageDataUrlForCell(cellId);+ const dataUrl = await getImageDataUrlForCell(cellId, false);if (!dataUrl) {Logger.error(`Failed to capture screenshot for cell ${cellId}`);return null;diff --git a/frontend/src/utils/__tests__/download.test.tsx b/frontend/src/utils/__tests__/download.test.tsxindex 904d4cb366..dc7a7522f5 100644--- a/frontend/src/utils/__tests__/download.test.tsx+++ b/frontend/src/utils/__tests__/download.test.tsx@@ -158,7 +158,7 @@ describe("getImageDataUrlForCell", () => {expect(toPng).toHaveBeenCalledWith(mockElement);});- it("should add printing classes before capture", async () => {+ it("should add printing classes before capture when enablePrintMode is true", async () => {vi.mocked(toPng).mockImplementation(async () => {// Check classes are applied during captureexpect(mockElement.classList.contains("printing-output")).toBe(true);@@ -167,18 +167,42 @@ describe("getImageDataUrlForCell", () => {return mockDataUrl;});- await getImageDataUrlForCell("cell-1" as CellId);+ await getImageDataUrlForCell("cell-1" as CellId, true);});- it("should remove printing classes after capture", async () => {+ it("should remove printing classes after capture when enablePrintMode is true", async () => {vi.mocked(toPng).mockResolvedValue(mockDataUrl);- await getImageDataUrlForCell("cell-1" as CellId);+ await getImageDataUrlForCell("cell-1" as CellId, true);expect(mockElement.classList.contains("printing-output")).toBe(false);expect(document.body.classList.contains("printing")).toBe(false);});+ it("should add printing-output but NOT body.printing when enablePrintMode is false", async () => {+ vi.mocked(toPng).mockImplementation(async () => {+ // printing-output should still be added to the element+ expect(mockElement.classList.contains("printing-output")).toBe(true);+ // but body.printing should NOT be added+ expect(document.body.classList.contains("printing")).toBe(false);+ expect(mockElement.style.overflow).toBe("auto");+ return mockDataUrl;+ });++ await getImageDataUrlForCell("cell-1" as CellId, false);+ });++ it("should cleanup printing-output when enablePrintMode is false", async () => {+ mockElement.style.overflow = "hidden";+ vi.mocked(toPng).mockResolvedValue(mockDataUrl);++ await getImageDataUrlForCell("cell-1" as CellId, false);++ expect(mockElement.classList.contains("printing-output")).toBe(false);+ expect(document.body.classList.contains("printing")).toBe(false);+ expect(mockElement.style.overflow).toBe("hidden");+ });+it("should restore original overflow style after capture", async () => {mockElement.style.overflow = "hidden";vi.mocked(toPng).mockResolvedValue(mockDataUrl);@@ -207,7 +231,7 @@ describe("getImageDataUrlForCell", () => {expect(mockElement.style.overflow).toBe("scroll");});- it("should maintain body.printing during concurrent captures", async () => {+ it("should maintain body.printing during concurrent captures when enablePrintMode is true", async () => {// Create a second elementconst mockElement2 = document.createElement("div");mockElement2.id = CellOutputId.create("cell-2" as CellId);@@ -241,9 +265,9 @@ describe("getImageDataUrlForCell", () => {return mockDataUrl;});- // Start both captures concurrently- const capture1 = getImageDataUrlForCell("cell-1" as CellId);- const capture2 = getImageDataUrlForCell("cell-2" as CellId);+ // Start both captures concurrently with enablePrintMode = true+ const capture1 = getImageDataUrlForCell("cell-1" as CellId, true);+ const capture2 = getImageDataUrlForCell("cell-2" as CellId, true);// Let second capture complete firstresolveSecond!();@@ -264,6 +288,30 @@ describe("getImageDataUrlForCell", () => {mockElement2.remove();});++ it("should not interfere with body.printing during concurrent captures when enablePrintMode is false", async () => {+ // Create a second element+ const mockElement2 = document.createElement("div");+ mockElement2.id = CellOutputId.create("cell-2" as CellId);+ document.body.append(mockElement2);++ vi.mocked(toPng).mockImplementation(async () => {+ // body.printing should never be added when enablePrintMode is false+ expect(document.body.classList.contains("printing")).toBe(false);+ return mockDataUrl;+ });++ // Start both captures concurrently with enablePrintMode = false+ const capture1 = getImageDataUrlForCell("cell-1" as CellId, false);+ const capture2 = getImageDataUrlForCell("cell-2" as CellId, false);++ await Promise.all([capture1, capture2]);++ // body.printing should still not be present+ expect(document.body.classList.contains("printing")).toBe(false);++ mockElement2.remove();+ });});describe("downloadHTMLAsImage", () => {@@ -342,7 +390,7 @@ describe("downloadHTMLAsImage", () => {expect(cleanup).toHaveBeenCalled();});- it("should not add body.printing when prepare is provided", async () => {+ it("should delegate body.printing management to prepare function", async () => {let bodyPrintingDuringCapture = false;vi.mocked(toPng).mockImplementation(async () => {// Capture the state during toPng execution@@ -350,7 +398,14 @@ describe("downloadHTMLAsImage", () => {return mockDataUrl;});const cleanup = vi.fn();- const prepare = vi.fn().mockReturnValue(cleanup);+ // Mock prepare that adds body.printing+ const prepare = vi.fn().mockImplementation(() => {+ document.body.classList.add("printing");+ return () => {+ document.body.classList.remove("printing");+ cleanup();+ };+ });await downloadHTMLAsImage({element: mockElement,@@ -358,9 +413,8 @@ describe("downloadHTMLAsImage", () => {prepare,});- // body.printing should NOT be added by downloadHTMLAsImage when prepare is provided- // (the prepare function is responsible for managing its own classes)- expect(bodyPrintingDuringCapture).toBe(false);+ // body.printing should be added by prepare function+ expect(bodyPrintingDuringCapture).toBe(true);expect(document.body.classList.contains("printing")).toBe(false);expect(prepare).toHaveBeenCalledWith(mockElement);expect(cleanup).toHaveBeenCalled();diff --git a/frontend/src/utils/download.ts b/frontend/src/utils/download.tsindex 6e37f024d5..0dae76d3ca 100644--- a/frontend/src/utils/download.ts+++ b/frontend/src/utils/download.ts@@ -59,34 +59,51 @@ function releaseBodyPrinting() {}}-/*+/*** Prepare a cell element for screenshot capture.- * Returns a cleanup function that should be called when the screenshot is complete.+ *+ * @param element - The cell output element to prepare+ * @param enablePrintMode - When true, adds a 'printing' class to the body.+ * This can cause layout shifts that cause the page to scroll.+ * @returns A cleanup function to restore the element's original state*/-function prepareCellElementForScreenshot(element: HTMLElement) {+function prepareCellElementForScreenshot(+ element: HTMLElement,+ enablePrintMode: boolean,+) {element.classList.add("printing-output");- acquireBodyPrinting();+ if (enablePrintMode) {+ acquireBodyPrinting();+ }const originalOverflow = element.style.overflow;element.style.overflow = "auto";return () => {element.classList.remove("printing-output");- releaseBodyPrinting();+ if (enablePrintMode) {+ releaseBodyPrinting();+ }element.style.overflow = originalOverflow;};}/*** Capture a cell output as a PNG data URL.+ *+ * @param cellId - The ID of the cell to capture+ * @param enablePrintMode - When true, enables print mode which adds a 'printing' class to the body.+ * This can cause layout shifts that cause the page to scroll.+ * @returns The PNG as a data URL, or undefined if the cell element wasn't found*/export async function getImageDataUrlForCell(cellId: CellId,+ enablePrintMode = true,): Promise<string | undefined> {const element = findElementForCell(cellId);if (!element) {return;}- const cleanup = prepareCellElementForScreenshot(element);+ const cleanup = prepareCellElementForScreenshot(element, enablePrintMode);try {return await toPng(element);@@ -110,7 +127,7 @@ export async function downloadCellOutputAsImage(await downloadHTMLAsImage({element,filename,- prepare: prepareCellElementForScreenshot,+ prepare: () => prepareCellElementForScreenshot(element, true),});}@@ -127,7 +144,6 @@ export async function downloadHTMLAsImage(opts: {let cleanup: (() => void) | undefined;if (prepare) {- // Let the prepare function handle adding classes (e.g., body.printing)cleanup = prepare(element);} else {// When no prepare function is provided (e.g., downloading full notebook),