@netless/app-presentation 0.1.13-beta.0 → 0.1.13-beta.2

package/src/app-presentation.ts

@@ -35,6 +35,7 @@ import {
   isValidSharedViewport,
   isValidSize,
 } from "./camera-reference";
+import { createPresentationRuntimeTeardown } from "./runtime-lifecycle";
 import debounce from "lodash/debounce";
 
 export type Logger = (...data: any[]) => void;
@@ -96,6 +97,17 @@ export interface PresentationAppOptions {
   goToPageByClick?: boolean;
   /** useClipView is used to set the presentation use clip view, it will be used in the presentation, and the presentation will be use clip view when the app is initialized */
   useClipView?: boolean;
+  /**
+   * Max time (ms) `setup()` waits for the first visible page image to load
+   * before resolving anyway. Default: 5_000.
+   */
+  setupReadyTimeout?: number;
+  /**
+   * Blur thumbnail degradation keeps cached (focused-lost) presentations on
+   * the low-res `previewURL` thumbnail to save memory. Enabled by default in
+   * maximized/minimized states; set `true` to disable it.
+   */
+  disableBlurThumbnailDegradation?: boolean;
 }
 
 export interface PresentationController {
@@ -154,6 +166,285 @@ const ppt2page = (
   return { ...size, src: ppt.src, thumbnail: ppt.previewURL, name };
 };
 
+/**
+ * The whiteboard SDK renders the scene ppt as a real `<img alt="background">`
+ * inside the background HTML engine layer of the view. All blur degradation
+ * below works directly on that DOM node; no scene API is ever called.
+ */
+const findBackgroundImage = (view: View): HTMLImageElement | null => {
+  const container = (view as any).divElement as HTMLElement | undefined | null;
+  if (!container || typeof container.querySelector !== "function") return null;
+  return container.querySelector('img[alt="background"]');
+};
+
+/**
+ * Degradation is a lazy-mode cache optimization only: inactive unless the
+ * WindowManager runs with lazySetupInMaximizedMode enabled (read dynamically
+ * — lazy can be disabled at runtime, e.g. when forceMaximized is cleared).
+ * It also only applies when the window cannot be visible: maximized
+ * (covered by the top app) or minimized. Normal mode may show several
+ * windows side by side, so a blurred app there must keep the full image.
+ */
+const isBlurDegradationAllowed = (context: AppContext): boolean => {
+  if ((context.getWindowManager() as any)?.lazySetupInMaximizedMode !== true) {
+    return false;
+  }
+  const boxStatus = context.getBoxStatus();
+  if (boxStatus) {
+    return boxStatus !== "normal";
+  }
+  const boxState = context.getWindowManager().boxState;
+  return boxState !== undefined && boxState !== "normal";
+};
+
+const DEFAULT_SETUP_READY_TIMEOUT = 5_000;
+
+/**
+ * Resolve once the current page background image has loaded (or after
+ * `timeoutMs`). `false` means timeout or the app was disposed mid-wait;
+ * callers must treat it as "continue loading in background", not an error.
+ */
+const waitForCurrentPageImage = (
+  view: View,
+  timeoutMs: number,
+  isDisposed: () => boolean,
+): Promise<boolean> => {
+  return new Promise<boolean>(resolve => {
+    let settled = false;
+    let pollTimer: number | undefined;
+    const settle = (loaded: boolean) => {
+      if (settled) return;
+      settled = true;
+      window.clearTimeout(timeoutTimer);
+      if (pollTimer !== undefined) window.clearInterval(pollTimer);
+      resolve(loaded);
+    };
+    const timeoutTimer = window.setTimeout(() => settle(false), timeoutMs);
+    const check = () => {
+      if (isDisposed()) {
+        settle(false);
+        return;
+      }
+      const img = findBackgroundImage(view);
+      if (img && img.complete && img.naturalWidth > 0) {
+        settle(true);
+      }
+    };
+    check();
+    if (!settled) {
+      pollTimer = window.setInterval(check, 100);
+    }
+  });
+};
+
+/**
+ * Compare image URLs by resolved absolute href so relative/absolute
+ * representations of the same URL do not look different (and to keep the
+ * load-capture re-degrade loop terminating).
+ */
+const resolveImageUrl = (url: string): string => {
+  try {
+    return new URL(url, window.location.href).href;
+  } catch {
+    return url;
+  }
+};
+
+const TRANSPARENT_BACKGROUND =
+  "data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs=";
+const BACKGROUND_SUSPENDED_CLASS =
+  "netless-app-presentation-background-suspended";
+
+const hasUsableThumbnail = (page: PresentationPage): boolean => {
+  const thumbnailURL = page.thumbnail;
+  if (!thumbnailURL) return false;
+  try {
+    const source = new URL(page.src, window.location.href);
+    const thumbnail = new URL(thumbnailURL, window.location.href);
+    const sameResourcePath =
+      source.origin === thumbnail.origin &&
+      source.pathname === thumbnail.pathname;
+    // OSS image resize URLs can return the complete animated GIF unchanged.
+    // Treat query-only GIF variants as the original resource, not a thumbnail.
+    if (/\.gif$/i.test(source.pathname) && sameResourcePath) return false;
+  } catch {
+    if (/\.gif(?:$|[?#])/i.test(page.src)) return false;
+  }
+  return resolveImageUrl(thumbnailURL) !== resolveImageUrl(page.src);
+};
+
+/**
+ * Blur thumbnail degradation (see lazy-setup design doc §15): when the app
+ * loses focus but stays cached (multi-runtime cache mode), swap the scene
+ * background `<img>` src to the low-res `PptDescription.previewURL`
+ * (`page.thumbnail`) via a pure DOM change and pause full-image preloading;
+ * restore the full image when focus comes back. A page without a real
+ * thumbnail keeps its measurable view container, but its background layer is
+ * hidden and replaced with a static pixel after TeleBox commits the blur.
+ *
+ * While degraded, every load of a background `<img>` is re-degraded
+ * immediately via a capture-phase `load` listener on the view container
+ * (`load` does not bubble but capture works). This covers remote page turns,
+ * SDK React re-renders and the SDK's own background-image onError retries —
+ * any path that (re)renders the full-size image while the app stays blurred.
+ */
+export const setupBlurThumbnailDegradation = (config: {
+  context: AppContext;
+  view: View;
+  pages: PresentationPage[];
+  pageIndex$: Readable<number>;
+  app: Presentation;
+  dispose: ReturnType<typeof disposableStore>;
+}): void => {
+  const { context, view, pages, pageIndex$, app, dispose } = config;
+  const box = context.getBox();
+  const boxBlurClass = box.wrapClassName("blur");
+  // Two separate flags: `blurEpisode` covers the whole blurred period (pages
+  // without a thumbnail don't end it, so a later page degrades again), while
+  // `reDegradeEnabled` only turns off when the degraded thumbnail itself
+  // fails, so we don't fight the SDK's background onError retry.
+  let blurEpisode = false;
+  let reDegradeEnabled = false;
+  let boxBlurred = box.$box.classList.contains(boxBlurClass);
+
+  const setBackgroundSuspended = (suspended: boolean): void => {
+    app.whiteboardDOM.classList.toggle(
+      BACKGROUND_SUSPENDED_CLASS,
+      suspended,
+    );
+  };
+
+  const degrade = (): void => {
+    const page = pages[pageIndex$.value];
+    if (!page) return;
+    const thumbnailURL = page.thumbnail;
+    const img = findBackgroundImage(view);
+    if (!thumbnailURL || !hasUsableThumbnail(page)) {
+      if (boxBlurred) {
+        setBackgroundSuspended(true);
+        if (
+          img &&
+          resolveImageUrl(img.src) !== resolveImageUrl(TRANSPARENT_BACKGROUND)
+        ) {
+          img.src = TRANSPARENT_BACKGROUND;
+        }
+      }
+      return;
+    }
+    setBackgroundSuspended(false);
+    if (img && resolveImageUrl(img.src) !== resolveImageUrl(thumbnailURL)) {
+      img.src = thumbnailURL;
+    }
+  };
+
+  const restore = (): void => {
+    const page = pages[pageIndex$.value];
+    const img = findBackgroundImage(view);
+    if (page && img && resolveImageUrl(img.src) !== resolveImageUrl(page.src)) {
+      img.src = page.src;
+    }
+    setBackgroundSuspended(false);
+  };
+
+  const suspendCachedResources = (): void => {
+    if (!blurEpisode || !boxBlurred) return;
+    app.suspendPreviewResources();
+    const page = pages[pageIndex$.value];
+    if (!page || !hasUsableThumbnail(page) || reDegradeEnabled) {
+      degrade();
+    }
+  };
+
+  const restoreFocusedResources = (): void => {
+    if (!blurEpisode) return;
+    blurEpisode = false;
+    reDegradeEnabled = false;
+    restore();
+    app.preload.resume(pageIndex$.value);
+  };
+
+  const isBackgroundImg = (target: EventTarget | null): boolean => {
+    const el = target as HTMLImageElement | null;
+    return Boolean(
+      el && el.tagName === "IMG" && el.matches?.('img[alt="background"]'),
+    );
+  };
+
+  // Re-degrade any background img that finishes loading a full-size image
+  // while the app is blurred. Listeners sit at document level (capture
+  // phase - load/error do not bubble but capture descends from document)
+  // and resolve the view container lazily per event, so a rebinding of
+  // view.divElement (bindContainer etc.) is followed automatically. The
+  // contains() check keeps the app's own preview-panel thumbnails untouched.
+  const ownsTarget = (target: EventTarget | null): target is HTMLImageElement => {
+    if (!isBackgroundImg(target)) return false;
+    const el = (view as any).divElement as HTMLElement | undefined | null;
+    return !!(el && el.contains(target as Node));
+  };
+
+  const onImgLoad = (ev: Event): void => {
+    if (!blurEpisode || !reDegradeEnabled) return;
+    if (!ownsTarget(ev.target)) return;
+    degrade();
+  };
+
+  // The degraded thumbnail failed to load: stop re-degrading for this blur
+  // episode so the SDK's onError retry can settle on the full image. Focus
+  // still force-restores afterwards.
+  const onImgError = (ev: Event): void => {
+    if (!blurEpisode || !reDegradeEnabled) return;
+    if (!ownsTarget(ev.target)) return;
+    reDegradeEnabled = false;
+  };
+
+  const offFocus = context.emitter.on("focus", (isFocused: boolean) => {
+    if (isFocused) {
+      restoreFocusedResources();
+    } else {
+      if (!isBlurDegradationAllowed(context)) return;
+      blurEpisode = true;
+      reDegradeEnabled = true;
+      degrade();
+      app.preload.pause();
+      suspendCachedResources();
+    }
+  });
+  dispose.add(offFocus);
+
+  const updateBoxBlurred = (blurred: boolean): void => {
+    if (boxBlurred === blurred) return;
+    boxBlurred = blurred;
+    if (blurred) suspendCachedResources();
+    else restoreFocusedResources();
+  };
+  const onBoxBlur = (): void => updateBoxBlurred(true);
+  const onBoxFocus = (): void => updateBoxBlurred(false);
+  box.events.on("blur", onBoxBlur);
+  box.events.on("focus", onBoxFocus);
+  dispose.add(() => {
+    box.events.off("blur", onBoxBlur);
+    box.events.off("focus", onBoxFocus);
+  });
+
+  // WindowManager may update TeleBox focus with skipUpdate=true. In that
+  // path the visual class changes but TeleBox intentionally emits no event.
+  const boxClassObserver = new MutationObserver(() => {
+    updateBoxBlurred(box.$box.classList.contains(boxBlurClass));
+  });
+  boxClassObserver.observe(box.$box, {
+    attributes: true,
+    attributeFilter: ["class"],
+  });
+  dispose.add(() => boxClassObserver.disconnect());
+
+  document.addEventListener("load", onImgLoad, true);
+  document.addEventListener("error", onImgError, true);
+  dispose.add(() => {
+    document.removeEventListener("load", onImgLoad, true);
+    document.removeEventListener("error", onImgError, true);
+  });
+};
+
 const createLogger = (room: Room | undefined): Logger => {
   if (room && (room as any).logger) {
     return (...args) => (room as any).logger.info(...args);
@@ -641,6 +932,12 @@ export const NetlessAppPresentation: NetlessApp<
     app.log = log;
     app.warn = warn;
 
+    // Setup only touches the current page's full image; the rest of the deck
+    // keeps loading through idle callbacks after the setup queue moves on.
+    if (pageIndex$.value !== 0) {
+      app.preload.touch(pageIndex$.value, true);
+    }
+
     const getCameraDiagnosticState = (
       reason: "initialize" | "moveCamera",
       requestedCamera?: MoveCameraRequest,
@@ -785,6 +1082,10 @@ export const NetlessAppPresentation: NetlessApp<
       }),
     );
 
+    if (!options.disableBlurThumbnailDegradation) {
+      setupBlurThumbnailDegradation({ context, view, pages, pageIndex$, app, dispose });
+    }
+
     const getOriginScale = () => {
       const page = app.page();
       if (!page || !isValidSize(page)) return 0;
@@ -941,13 +1242,23 @@ export const NetlessAppPresentation: NetlessApp<
 
     let disposed = false;
     let offDestroy: (() => void) | undefined;
+    // The public readonly box type hides host lifecycle mutators, while the
+    // TeleBox runtime exposes them for app mount cleanup.
+    const teardownRuntime = createPresentationRuntimeTeardown(
+      box as ReadonlyTeleBox & {
+        unmountContent(): unknown;
+        unmountFooter(): unknown;
+        unmountStyles(): unknown;
+      },
+      dispose,
+    );
     const teardown = () => {
       if (disposed) return;
       disposed = true;
       const removeDestroy = offDestroy;
       offDestroy = undefined;
       removeDestroy?.();
-      dispose();
+      teardownRuntime();
     };
     offDestroy = context.emitter.on("destroy", teardown);
     teardownByContext.set(context, teardown);
@@ -1207,9 +1518,16 @@ export const NetlessAppPresentation: NetlessApp<
     // Older WindowManager declarations model setup as synchronous even though
     // AppProxy awaits its result. Keep that source compatibility until the new
     // `SetupResult | Promise<SetupResult>` declaration is the minimum version.
-    return prepareScenesPromise.then(
-      () => controller,
-    ) as unknown as PresentationController;
+    const setupReadyTimeout = options.setupReadyTimeout ?? DEFAULT_SETUP_READY_TIMEOUT;
+    return prepareScenesPromise.then(async () => {
+      // Keep the serial setup queue honest: resolve only once the current
+      // page image is actually visible (or the bounded wait gives up).
+      const loaded = await waitForCurrentPageImage(view, setupReadyTimeout, () => disposed);
+      if (!loaded && !disposed) {
+        warn(`[Presentation] setup ready wait timed out after ${setupReadyTimeout}ms`);
+      }
+      return controller;
+    }) as unknown as PresentationController;
   },
   teardown(context) {
     teardownByContext.get(context)?.();

package/src/preload.ts

@@ -35,6 +35,9 @@ export class Preload implements IDisposable {
   // 当前触摸的索引
   touchIndex: number = 0;
   preloadSize: number = 0;
+  // 暂停后不再创建预加载链接（app 失焦降级时调用）；已插入的 link 会被移除，
+  // 挂起的 idle 回调重新进入 touch() 时也会被跳过
+  paused: boolean = false;
   constructor(readonly pages: PresentationPage[]) {
     this.preloadMap = new Map(pages.map((e,index) => [index, {
       src: e.src,
@@ -43,7 +46,18 @@ export class Preload implements IDisposable {
     this.preloadSize = this.preloadMap.size;
     this.touch(0, true);
   }
+  pause() {
+    if (this.paused) return;
+    this.paused = true;
+    this.destroySomeLink();
+  }
+  resume(index?: number) {
+    if (!this.paused) return;
+    this.paused = false;
+    this.touch(index ?? this.touchIndex, true);
+  }
   touch(index: number, force: boolean = false) {
+    if (this.paused) return;
     if (index >= this.preloadSize) {
       this.touchIndex = 0;
     } else {

package/src/presentation.ts

@@ -110,7 +110,7 @@ export class Presentation implements IDisposable<void> {
     if (this.initialized) return
     this.initialized = true
 
-    this.dispose.add(() => this.previewLazyload?.destroy())
+    this.dispose.add(() => this.destroyPreviewLazyload())
 
     this.contentDOM.classList.toggle(this.c('readonly'), this.readonly)
     this.dom.appendChild(this.contentDOM)
@@ -276,6 +276,18 @@ export class Presentation implements IDisposable<void> {
     }
   }
 
+  /** Release preview images while this presentation stays in the runtime cache. */
+  suspendPreviewResources() {
+    this.togglePreview(false)
+    this.destroyPreviewLazyload()
+    this.previewDOM.querySelectorAll<HTMLImageElement>('img').forEach(img => {
+      img.removeAttribute('src')
+      img.removeAttribute('srcset')
+      img.removeAttribute('sizes')
+      LazyLoad.resetStatus(img)
+    })
+  }
+
   // [origin] means the cause:
   // - navigation: user clicked on the left / right button on footer
   // - input: user filled the bottom-right page number input box
@@ -322,6 +334,11 @@ export class Presentation implements IDisposable<void> {
     }
   }
 
+  private destroyPreviewLazyload() {
+    this.previewLazyload?.destroy()
+    this.previewLazyload = null
+  }
+
   private c(className: string): string {
     return `${this.namespace}-${className}`
   }

package/src/runtime-lifecycle.ts

@@ -0,0 +1,24 @@
+export interface PresentationRuntimeBox {
+  unmountContent(): unknown;
+  unmountFooter(): unknown;
+  unmountStyles(): unknown;
+}
+
+/** Build an idempotent runtime teardown while preserving the TeleBox shell. */
+export const createPresentationRuntimeTeardown = (
+  box: PresentationRuntimeBox,
+  dispose: () => void,
+): (() => void) => {
+  let tornDown = false;
+  return () => {
+    if (tornDown) return;
+    tornDown = true;
+    try {
+      dispose();
+    } finally {
+      box.unmountContent();
+      box.unmountFooter();
+      box.unmountStyles();
+    }
+  };
+};

package/src/style.scss

@@ -12,6 +12,12 @@ $namespace: 'netless-app-presentation';
   overflow: hidden;
 }
 
+// Keep the view container measurable while releasing an unfocused cached
+// page's background from painting and compositing.
+.#{$namespace}-background-suspended .background {
+  display: none !important;
+}
+
 .#{$namespace}-preview-mask {
   display: none;
   position: absolute;
@@ -307,4 +313,4 @@ $namespace: 'netless-app-presentation';
 
 .#{$namespace}-scrollbar-y {
   width: 6px;
-}
+}