diff --git a/apps/desktop/src/renderer/lib/browser-viewport-zoom/browser-viewport-zoom.ts b/apps/desktop/src/renderer/lib/browser-viewport-zoom/browser-viewport-zoom.ts new file mode 100644 index 00000000000..00be5920f35 --- /dev/null +++ b/apps/desktop/src/renderer/lib/browser-viewport-zoom/browser-viewport-zoom.ts @@ -0,0 +1,31 @@ +import { + applyPageViewportZoom, + NEXT_PAGE_VIEWPORT_ZOOM_SCRIPT, + type PageViewportZoom, +} from "@superset/shared/page-zoom"; + +export function attachBrowserViewportZoom(webview: Electron.WebviewTag) { + let generation = 0; + const onReady = () => { + const current = ++generation; + const listen = async () => { + while (generation === current) { + try { + const viewport: PageViewportZoom = await webview.executeJavaScript( + NEXT_PAGE_VIEWPORT_ZOOM_SCRIPT, + ); + if (generation !== current) return; + applyPageViewportZoom(webview, viewport); + } catch { + return; + } + } + }; + void listen(); + }; + webview.addEventListener("dom-ready", onReady); + return () => { + generation++; + webview.removeEventListener("dom-ready", onReady); + }; +} diff --git a/apps/desktop/src/renderer/lib/browser-viewport-zoom/index.ts b/apps/desktop/src/renderer/lib/browser-viewport-zoom/index.ts new file mode 100644 index 00000000000..d2fc98dcb14 --- /dev/null +++ b/apps/desktop/src/renderer/lib/browser-viewport-zoom/index.ts @@ -0,0 +1 @@ +export { attachBrowserViewportZoom } from "./browser-viewport-zoom"; diff --git a/apps/desktop/src/renderer/routes/_authenticated/_dashboard/components/PageViewer/PageViewer.tsx b/apps/desktop/src/renderer/routes/_authenticated/_dashboard/components/PageViewer/PageViewer.tsx index 723a9e9ffd9..ac27916ee7b 100644 --- a/apps/desktop/src/renderer/routes/_authenticated/_dashboard/components/PageViewer/PageViewer.tsx +++ b/apps/desktop/src/renderer/routes/_authenticated/_dashboard/components/PageViewer/PageViewer.tsx @@ -119,6 +119,7 @@ export function PageViewer({
{ + detachViewportZoom(); webview.removeEventListener("dom-ready", handleDomReady); webview.removeEventListener("did-start-loading", handleDidStartLoading); webview.removeEventListener("did-stop-loading", handleDidStopLoading); diff --git a/apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/TabView/BrowserPane/hooks/usePersistentWebview/usePersistentWebview.ts b/apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/TabView/BrowserPane/hooks/usePersistentWebview/usePersistentWebview.ts index adea8879a21..260032622f4 100644 --- a/apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/TabView/BrowserPane/hooks/usePersistentWebview/usePersistentWebview.ts +++ b/apps/desktop/src/renderer/screens/main/components/WorkspaceView/ContentView/TabsContent/TabView/BrowserPane/hooks/usePersistentWebview/usePersistentWebview.ts @@ -1,4 +1,5 @@ import { useCallback, useEffect, useRef } from "react"; +import { attachBrowserViewportZoom } from "renderer/lib/browser-viewport-zoom"; import { electronTrpc } from "renderer/lib/electron-trpc"; import { requestPaneClose } from "renderer/stores/editor-state/editorCoordinator"; import { useTabsStore } from "renderer/stores/tabs/store"; @@ -206,6 +207,8 @@ export function usePersistentWebview({ } else { // Create new webview webview = document.createElement("webview") as Electron.WebviewTag; + const detachViewportZoom = attachBrowserViewportZoom(webview); + webview.addEventListener("destroyed", detachViewportZoom); webview.setAttribute("partition", "persist:superset"); webview.setAttribute("allowpopups", ""); webview.style.display = "flex"; diff --git a/docs/verification/browser-viewport-zoom/after.png b/docs/verification/browser-viewport-zoom/after.png new file mode 100644 index 00000000000..b1c8e8607e8 Binary files /dev/null and b/docs/verification/browser-viewport-zoom/after.png differ diff --git a/docs/verification/browser-viewport-zoom/before.png b/docs/verification/browser-viewport-zoom/before.png new file mode 100644 index 00000000000..24785c7ba88 Binary files /dev/null and b/docs/verification/browser-viewport-zoom/before.png differ diff --git a/packages/shared/package.json b/packages/shared/package.json index 759af123050..b3fdf441334 100644 --- a/packages/shared/package.json +++ b/packages/shared/package.json @@ -4,6 +4,10 @@ "private": true, "type": "module", "exports": { + "./page-zoom": { + "types": "./src/page-zoom.ts", + "default": "./src/page-zoom.ts" + }, "./usercontent": { "types": "./src/usercontent/index.ts", "default": "./src/usercontent/index.ts" diff --git a/packages/shared/src/page-comments-runtime.ts b/packages/shared/src/page-comments-runtime.ts index 4c752cf815c..a7c5c0c9811 100644 --- a/packages/shared/src/page-comments-runtime.ts +++ b/packages/shared/src/page-comments-runtime.ts @@ -1,3 +1,8 @@ +import { + PAGE_PINCH_ZOOM_RUNTIME_SOURCE, + type PageViewportZoom, +} from "./page-zoom"; + export interface CommentAnchor { path: string; tag: string; @@ -24,6 +29,7 @@ export const FRAME_CHANNEL = "superset-comments/frame"; export type HostMessageBody = | { type: "ready" } + | { type: "enable-pinch-zoom" } | { type: "set-mode"; enabled: boolean; locked: boolean } | { type: "track"; anchors: { id: string; anchor: CommentAnchor }[] } | { type: "restore-scroll"; y: number }; @@ -32,6 +38,11 @@ export type HostMessage = HostMessageBody & { channel: typeof HOST_CHANNEL }; export type FrameMessage = | { channel: typeof FRAME_CHANNEL; type: "ready" } + | { + channel: typeof FRAME_CHANNEL; + type: "viewport-zoom"; + viewport: PageViewportZoom; + } | { channel: typeof FRAME_CHANNEL; type: "hover"; rect: FrameRect | null } | { channel: typeof FRAME_CHANNEL; type: "pointer-down" } | { channel: typeof FRAME_CHANNEL; type: "escape" } @@ -223,6 +234,13 @@ export const PAGE_COMMENTS_RUNTIME_SOURCE = `(() => { true, ); + const pinchZoom = (${PAGE_PINCH_ZOOM_RUNTIME_SOURCE})((viewport) => { + post({ type: "viewport-zoom", viewport }); + lastHoverPath = null; + post({ type: "hover", rect: null }); + schedule(); + }, () => locked); + addEventListener("scroll", schedule, true); addEventListener("resize", schedule); for (const type of ["wheel", "touchstart", "keydown"]) { @@ -252,6 +270,7 @@ export const PAGE_COMMENTS_RUNTIME_SOURCE = `(() => { addEventListener("message", (event) => { const data = event.data; if (!data || data.channel !== HOST) return; + if (data.type === "enable-pinch-zoom" && event.source === parent) pinchZoom.enable(); if (data.type === "ready") post({ type: "ready" }); if (data.type === "set-mode") { enabled = Boolean(data.enabled); diff --git a/packages/shared/src/page-zoom.test.ts b/packages/shared/src/page-zoom.test.ts new file mode 100644 index 00000000000..4e0abd3f349 --- /dev/null +++ b/packages/shared/src/page-zoom.test.ts @@ -0,0 +1,148 @@ +import { describe, expect, test } from "bun:test"; +import { createContext, runInContext, Script } from "node:vm"; +import { PAGE_COMMENTS_RUNTIME_SOURCE } from "./page-comments-runtime"; +import { + applyPageViewportZoom, + NEXT_PAGE_VIEWPORT_ZOOM_SCRIPT, + PAGE_PINCH_ZOOM_RUNTIME_SOURCE, + type PageViewportZoom, +} from "./page-zoom"; + +function setup() { + const listeners = new Map void>(); + const style = { zoom: "", width: "", transform: "" }; + let viewport: PageViewportZoom | null = null; + const context = createContext({ + document: { documentElement: { style } }, + innerWidth: 800, + innerHeight: 600, + scrollX: 0, + scrollY: 100, + locked: false, + onZoom: (value: PageViewportZoom) => { + viewport = value; + }, + addEventListener: (type: string, listener: (event: unknown) => void) => + listeners.set(type, listener), + scrollBy: ({ left, top }: { left: number; top: number }) => { + context.scrollX += left; + context.scrollY += top; + }, + }); + runInContext( + `const pinchZoom = (${PAGE_PINCH_ZOOM_RUNTIME_SOURCE})(onZoom, () => locked)`, + context, + ); + return { + context, + style, + enable: () => runInContext("pinchZoom.enable()", context), + viewport: () => viewport, + wheel: (deltaY: number, overrides = {}) => { + let prevented = false; + listeners.get("wheel")?.({ + ctrlKey: true, + deltaMode: 0, + deltaX: 0, + deltaY, + clientX: 200, + clientY: 150, + preventDefault: () => { + prevented = true; + }, + ...overrides, + }); + return prevented; + }, + }; +} + +describe("page viewport zoom", () => { + test("composes into valid frame and browser scripts", () => { + expect(() => new Script(PAGE_COMMENTS_RUNTIME_SOURCE)).not.toThrow(); + expect(() => new Script(NEXT_PAGE_VIEWPORT_ZOOM_SCRIPT)).not.toThrow(); + }); + test("preserves ordinary scrolling and requires host opt-in", () => { + const page = setup(); + expect(page.wheel(-50)).toBe(false); + page.enable(); + expect(page.wheel(-50, { ctrlKey: false })).toBe(false); + expect(page.wheel(-50, { defaultPrevented: true })).toBe(false); + page.context.locked = true; + expect(page.wheel(-50)).toBe(false); + }); + test("magnifies around the pointer without changing content styles or layout scroll", () => { + const page = setup(); + page.enable(); + page.wheel(-Math.log(2) / 0.01); + expect(page.viewport()).toEqual({ + scale: 2, + x: 200, + y: 150, + width: 800, + height: 600, + }); + expect(page.style).toEqual({ zoom: "", width: "", transform: "" }); + expect(page.context.scrollX).toBe(0); + expect(page.context.scrollY).toBe(100); + }); + test("pans within the magnified viewport before scrolling the document", () => { + const page = setup(); + page.enable(); + page.wheel(-Math.log(2) / 0.01); + page.wheel(100, { ctrlKey: false, deltaX: 50 }); + expect(page.viewport()?.x).toBe(250); + expect(page.viewport()?.y).toBe(250); + expect(page.context.scrollY).toBe(100); + page.wheel(400, { ctrlKey: false }); + expect(page.viewport()?.y).toBe(600); + expect(page.context.scrollY).toBe(125); + }); + test("clamps repeated zooms and returns to an untransformed surface", () => { + const page = setup(); + page.enable(); + for (let i = 0; i < 20; i++) page.wheel(-100); + expect(page.viewport()?.scale).toBe(5); + for (let i = 0; i < 20; i++) page.wheel(100); + expect(page.viewport()).toEqual({ + scale: 1, + x: 0, + y: 0, + width: 800, + height: 600, + }); + }); + test("clips the compositor surface to its original pane without changing its dimensions", () => { + const style = { + width: "800px", + height: "600px", + transform: "", + transformOrigin: "", + clipPath: "", + }; + const surface = { style }; + applyPageViewportZoom(surface, { + scale: 2, + x: 200, + y: 150, + width: 800, + height: 600, + }); + expect(style).toEqual({ + width: "800px", + height: "600px", + transform: "translate(-200px, -150px) scale(2)", + transformOrigin: "0 0", + clipPath: "inset(75px 300px 225px 100px)", + }); + applyPageViewportZoom(surface, { + scale: 1, + x: 0, + y: 0, + width: 800, + height: 600, + }); + expect(style.transform).toBe(""); + expect(style.clipPath).toBe(""); + }); +}); diff --git a/packages/shared/src/page-zoom.ts b/packages/shared/src/page-zoom.ts new file mode 100644 index 00000000000..d0245ee16c6 --- /dev/null +++ b/packages/shared/src/page-zoom.ts @@ -0,0 +1,95 @@ +export const PAGE_PINCH_ZOOM_LIMITS = Object.freeze({ min: 1, max: 5 }); + +export interface PageViewportZoom { + scale: number; + x: number; + y: number; + width: number; + height: number; +} + +export function applyPageViewportZoom( + element: { + style: { transform: string; transformOrigin: string; clipPath: string }; + }, + viewport: PageViewportZoom, +): void { + const { scale, x, y, width, height } = viewport; + if ( + ![scale, x, y, width, height].every(Number.isFinite) || + scale < PAGE_PINCH_ZOOM_LIMITS.min || + scale > PAGE_PINCH_ZOOM_LIMITS.max || + width <= 0 || + height <= 0 + ) + return; + if (scale === 1) { + element.style.transform = ""; + element.style.transformOrigin = ""; + element.style.clipPath = ""; + return; + } + const left = Math.max(0, Math.min(x, width * (scale - 1))); + const top = Math.max(0, Math.min(y, height * (scale - 1))); + element.style.transformOrigin = "0 0"; + element.style.transform = `translate(${-left}px, ${-top}px) scale(${scale})`; + element.style.clipPath = `inset(${top / scale}px ${width - (left + width) / scale}px ${height - (top + height) / scale}px ${left / scale}px)`; +} + +export const PAGE_PINCH_ZOOM_RUNTIME_SOURCE = `(onZoom = () => {}, isLocked = () => false) => { + let enabled = false; + let scale = 1; + let x = 0; + let y = 0; + const clamp = () => { + x = Math.max(0, Math.min(x, innerWidth * (scale - 1))); + y = Math.max(0, Math.min(y, innerHeight * (scale - 1))); + }; + const report = () => onZoom({ scale, x, y, width: innerWidth, height: innerHeight }); + addEventListener("resize", () => { clamp(); if (enabled) report(); }); + addEventListener("wheel", (event) => { + if (!enabled || event.defaultPrevented || isLocked()) return; + if (!event.ctrlKey && scale === 1) return; + event.preventDefault(); + const unit = event.deltaMode === 1 ? 16 : event.deltaMode === 2 ? innerHeight : 1; + if (event.ctrlKey) { + const next = Math.min(${PAGE_PINCH_ZOOM_LIMITS.max}, Math.max( + ${PAGE_PINCH_ZOOM_LIMITS.min}, scale * Math.exp(-event.deltaY * unit * 0.01), + )); + if (!Number.isFinite(next)) return; + x += event.clientX * (next - scale); + y += event.clientY * (next - scale); + scale = next; + clamp(); + } else { + const nextX = x + event.deltaX * unit; + const nextY = y + event.deltaY * unit; + x = nextX; + y = nextY; + clamp(); + if (nextX !== x || nextY !== y) { + scrollBy({ left: (nextX - x) / scale, top: (nextY - y) / scale, behavior: "instant" }); + } + } + report(); + }, { passive: false }); + return { enable: () => { enabled = true; report(); } }; +}`; + +export const NEXT_PAGE_VIEWPORT_ZOOM_SCRIPT = `(() => { + const key = Symbol.for("superset.viewport-zoom"); + if (!globalThis[key]) { + let latest = null; + let resolve = null; + const controller = (${PAGE_PINCH_ZOOM_RUNTIME_SOURCE})((viewport) => { + if (resolve) { const notify = resolve; resolve = null; notify(viewport); } + else latest = viewport; + }); + globalThis[key] = () => new Promise((notify) => { + if (latest) { const viewport = latest; latest = null; notify(viewport); } + else resolve = notify; + }); + controller.enable(); + } + return globalThis[key](); +})();`; diff --git a/packages/ui/src/components/PageComments/components/PageCommentsView/PageCommentsView.tsx b/packages/ui/src/components/PageComments/components/PageCommentsView/PageCommentsView.tsx index 8cee28f62b8..bc5a02e4807 100644 --- a/packages/ui/src/components/PageComments/components/PageCommentsView/PageCommentsView.tsx +++ b/packages/ui/src/components/PageComments/components/PageCommentsView/PageCommentsView.tsx @@ -8,6 +8,10 @@ import { HOST_CHANNEL, type HostMessageBody, } from "@superset/shared/page-comments-runtime"; +import { + applyPageViewportZoom, + type PageViewportZoom, +} from "@superset/shared/page-zoom"; import { useCallback, useEffect, useMemo, useRef, useState } from "react"; import { useComments } from "../../providers/CommentProvider"; import { CommentBubble, pinClassName } from "./components/CommentBubble"; @@ -26,6 +30,7 @@ interface PageCommentsViewProps { src: string; title: string; initialScrollY?: number; + pinchZoomEnabled?: boolean; onScrollYChange?: (y: number) => void; /** * A press inside the frame. It never bubbles into the host document, so a @@ -38,6 +43,7 @@ export function PageCommentsView({ src, title, initialScrollY, + pinchZoomEnabled = false, onScrollYChange, onFramePointerDown, }: PageCommentsViewProps) { @@ -47,6 +53,7 @@ export function PageCommentsView({ const onFramePointerDownRef = useRef(onFramePointerDown); onFramePointerDownRef.current = onFramePointerDown; const frameRef = useRef(null); + const viewportRef = useRef(null); const containerRef = useRef(null); const [container, setContainer] = useState({ width: 0, height: 0 }); const [frameEpoch, setFrameEpoch] = useState(0); @@ -169,7 +176,30 @@ export function PageCommentsView({ const data = event.data as FrameMessage | undefined; if (!data || data.channel !== FRAME_CHANNEL) return; + if (data.type === "viewport-zoom") { + viewportRef.current = data.viewport; + if (frameRef.current) + applyPageViewportZoom(frameRef.current, data.viewport); + } + const transformRect = ( + rect: { + top: number; + left: number; + width: number; + height: number; + } | null, + ) => { + const v = viewportRef.current; + if (!rect || !v) return rect; + return { + top: rect.top * v.scale - v.y, + left: rect.left * v.scale - v.x, + width: rect.width * v.scale, + height: rect.height * v.scale, + }; + }; if (data.type === "ready") { + if (pinchZoomEnabled) send({ type: "enable-pinch-zoom" }); setReadySrc(src); setFrameEpoch((epoch) => epoch + 1); if (scrollYRef.current > 0) { @@ -180,7 +210,7 @@ export function PageCommentsView({ scrollYRef.current = data.y; onScrollYChangeRef.current?.(data.y); } - if (data.type === "hover") setHoverRect(data.rect); + if (data.type === "hover") setHoverRect(transformRect(data.rect)); if (data.type === "pointer-down") { onFramePointerDownRef.current?.(); notifyFramePointerDown(); @@ -191,9 +221,18 @@ export function PageCommentsView({ } } if (data.type === "escape") dismiss(); - if (data.type === "rects") setRects(data.entries); + if (data.type === "rects") + setRects( + data.entries.map((entry) => ({ + ...entry, + rect: transformRect(entry.rect), + })), + ); if (data.type === "pick" && !popoverOpen) { - openSelection({ anchor: data.anchor, rect: data.rect }); + openSelection({ + anchor: data.anchor, + rect: transformRect(data.rect) ?? data.rect, + }); setHoverRect(null); } }; @@ -204,6 +243,7 @@ export function PageCommentsView({ discardDraft, dismiss, frameOrigin, + pinchZoomEnabled, notifyFramePointerDown, openSelection, popoverOpen,