Refactor: [Regions] virtualize DOM elements (#3712)

* Refactor: [Regions] virtualize DOM elements * Fix tests * Virtual Timeline elements
katspaugh · May 18, 2024 · 26482e2 · 26482e2
1 parent 0d0a08e
commit 26482e2
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 20 deletions.
diff --git a/cypress/e2e/regions.cy.js b/cypress/e2e/regions.cy.js
@@ -77,24 +77,26 @@ describe('WaveSurfer Regions plugin tests', () => {
 
       expect(region.start).to.equal(3)
 
-      // Drag the region
-      const pointerDownEvent = new PointerEvent('pointerdown', {
-        clientX: 90,
-        clientY: 1,
-      })
-      const pointerMoveEvent = new PointerEvent('pointermove', {
-        clientX: 200,
-        clientY: 10,
-      })
-      const pointerUpEvent = new PointerEvent('pointerup', {
-        clientX: 200,
-        clientY: 10,
-      })
-      region.element.dispatchEvent(pointerDownEvent)
-      win.document.dispatchEvent(pointerMoveEvent)
-      win.document.dispatchEvent(pointerUpEvent)
+      return cy.wait(10).then(() => {
+        // Drag the region
+        const pointerDownEvent = new PointerEvent('pointerdown', {
+          clientX: 90,
+          clientY: 1,
+        })
+        const pointerMoveEvent = new PointerEvent('pointermove', {
+          clientX: 200,
+          clientY: 10,
+        })
+        const pointerUpEvent = new PointerEvent('pointerup', {
+          clientX: 200,
+          clientY: 10,
+        })
+        region.element.dispatchEvent(pointerDownEvent)
+        win.document.dispatchEvent(pointerMoveEvent)
+        win.document.dispatchEvent(pointerUpEvent)
 
-      expect(region.start).to.be.greaterThan(3)
+        expect(region.start).to.be.greaterThan(3)
+      })
     })
   })
 

diff --git a/src/plugins/regions.ts b/src/plugins/regions.ts
@@ -505,8 +505,37 @@ class RegionsPlugin extends BasePlugin<RegionsPluginEvents, RegionsPluginOptions
     }
   }
 
+  private virtualAppend(region: Region, container: HTMLElement, element: HTMLElement) {
+    const renderIfVisible = () => {
+      if (!this.wavesurfer) return
+      const clientWidth = this.wavesurfer.getWidth()
+      const scrollLeft = this.wavesurfer.getScroll()
+      const scrollWidth = container.clientWidth
+      const duration = this.wavesurfer.getDuration()
+      const start = Math.round((region.start / duration) * scrollWidth)
+      const width = Math.round(((region.end - region.start) / duration) * scrollWidth) || 1
+
+      // Check if the region is between the scrollLeft and scrollLeft + clientWidth
+      const isVisible = start + width > scrollLeft && start < scrollLeft + clientWidth
+
+      if (isVisible) {
+        container.appendChild(element)
+      } else {
+        element.remove()
+      }
+    }
+
+    setTimeout(() => {
+      if (!this.wavesurfer) return
+      renderIfVisible()
+
+      const unsubscribe = this.wavesurfer.on('scroll', renderIfVisible)
+      this.subscriptions.push(region.once('remove', unsubscribe), unsubscribe)
+    }, 0)
+  }
+
   private saveRegion(region: Region) {
-    this.regionsContainer.appendChild(region.element)
+    this.virtualAppend(region, this.regionsContainer, region.element)
     this.avoidOverlapping(region)
     this.regions.push(region)
 

diff --git a/src/plugins/timeline.ts b/src/plugins/timeline.ts
@@ -143,6 +143,28 @@ class TimelinePlugin extends BasePlugin<TimelinePluginEvents, TimelinePluginOpti
     return 2
   }
 
+  private virtualAppend(start: number, container: HTMLElement, element: HTMLElement) {
+    const renderIfVisible = () => {
+      if (!this.wavesurfer) return
+      const clientWidth = this.wavesurfer.getWidth()
+      const scrollLeft = this.wavesurfer.getScroll()
+      const width = element.clientWidth
+      const isVisible = start + width > scrollLeft && start < scrollLeft + clientWidth
+
+      if (isVisible) {
+        container.appendChild(element)
+      } else {
+        element.remove()
+      }
+    }
+
+    setTimeout(() => {
+      if (!this.wavesurfer) return
+      renderIfVisible()
+      this.subscriptions.push(this.wavesurfer.on('scroll', renderIfVisible))
+    }, 0)
+  }
+
   private initTimeline() {
     const duration = this.wavesurfer?.getDuration() ?? this.options.duration ?? 0
     const pxPerSec = this.timelineWrapper.scrollWidth / duration
@@ -217,8 +239,9 @@ class TimelinePlugin extends BasePlugin<TimelinePluginEvents, TimelinePluginOpti
       const mode = isPrimary ? 'primary' : isSecondary ? 'secondary' : 'tick'
       notch.setAttribute('part', `timeline-notch timeline-notch-${mode}`)
 
-      notch.style.left = `${i * pxPerSec}px`
-      timeline.appendChild(notch)
+      const offset = i * pxPerSec
+      notch.style.left = `${offset}px`
+      this.virtualAppend(offset, timeline, notch)
     }
 
     this.timelineWrapper.innerHTML = ''

diff --git a/src/renderer.ts b/src/renderer.ts
@@ -267,6 +267,10 @@ class Renderer extends EventEmitter<RendererEvents> {
     return this.wrapper
   }
 
+  getWidth(): number {
+    return this.scrollContainer.clientWidth
+  }
+
   getScroll(): number {
     return this.scrollContainer.scrollLeft
   }

diff --git a/src/wavesurfer.ts b/src/wavesurfer.ts
@@ -380,6 +380,11 @@ class WaveSurfer extends Player<WaveSurferEvents> {
     return this.renderer.getWrapper()
   }
 
+  /** For plugins only: get the scroll container client width */
+  public getWidth(): number {
+    return this.renderer.getWidth()
+  }
+
   /** Get the current scroll position in pixels */
   public getScroll(): number {
     return this.renderer.getScroll()