From ead8e07f6d0deba05d191ebc6c85b87de22af443 Mon Sep 17 00:00:00 2001 From: "chendaxin.tk" Date: Mon, 9 Nov 2026 17:24:45 +0800 Subject: [PATCH] fix(core): preserve federated input payloads when cloning --- .../__tests__/unit/common/event-clone.test.ts | 106 ++++++++++++++++++ .../__tests__/unit/common/host-input.test.ts | 23 +++- .../src/event/federated-event/mouse-event.ts | 23 ++++ .../event/federated-event/pointer-event.ts | 26 +---- .../src/event/federated-event/wheel-event.ts | 25 +---- packages/vrender-core/src/interface/event.ts | 4 +- 6 files changed, 158 insertions(+), 49 deletions(-) create mode 100644 packages/vrender-core/__tests__/unit/common/event-clone.test.ts diff --git a/packages/vrender-core/__tests__/unit/common/event-clone.test.ts b/packages/vrender-core/__tests__/unit/common/event-clone.test.ts new file mode 100644 index 000000000..44525ec42 --- /dev/null +++ b/packages/vrender-core/__tests__/unit/common/event-clone.test.ts @@ -0,0 +1,106 @@ +import { FederatedPointerEvent } from '../../../src/event/federated-event/pointer-event'; +import { FederatedWheelEvent } from '../../../src/event/federated-event/wheel-event'; +import { FederatedMouseEvent } from '../../../src/event/federated-event/mouse-event'; +import { EventManager } from '../../../src/event/event-manager'; + +describe('federated input clone', () => { + test.each([false, true])('pointer data survives reuse (managed: %s)', managed => { + const manager = managed ? new EventManager(null, {}) : undefined; + const event = new FederatedPointerEvent(manager); + const payload = { label: 'consumer-owned' }; + const extension = Symbol('extension'); + Object.assign(event, { type: 'pointerdown', pointerId: 7, buttons: 1, timeStamp: 123, payload, [extension]: 42 }); + const points = ['layer', 'page', 'canvas', 'viewport', 'client', 'movement', 'offset', 'global', 'screen'] as const; + points.forEach(key => Object.assign(event[key], { x: 10, y: 20 })); + event.nativeEvent = { type: 'pointerdown' } as PointerEvent; + event.currentTarget = {} as any; + event.eventPhase = event.AT_TARGET; + event.defaultPrevented = true; + event.propagationStopped = true; + event.propagationImmediatelyStopped = true; + const cloned = event.clone(); + points.forEach(key => Object.assign(event[key], { x: 30, y: 40 })); + event.type = 'pointerup'; + event.buttons = 0; + event.nativeEvent = null; + expect(cloned).toBeInstanceOf(FederatedPointerEvent); + expect(cloned).toMatchObject({ type: 'pointerdown', pointerId: 7, buttons: 1, timeStamp: 123, clientX: 10 }); + points.forEach(key => { + expect(cloned[key]).toEqual({ x: 10, y: 20 }); + expect(cloned[key]).not.toBe(event[key]); + }); + expect((cloned as any).payload).toBe(payload); + expect(cloned[extension]).toBe(42); + expect(cloned.nativeEvent.type).toBe('pointerdown'); + expect(cloned.path).toEqual([]); + expect(cloned.currentTarget).toBeNull(); + expect(cloned.eventPhase).toBe(cloned.NONE); + expect(cloned.defaultPrevented).toBe(false); + expect(cloned.propagationStopped).toBe(false); + expect(cloned.propagationImmediatelyStopped).toBe(false); + }); + + test.each([false, true])('wheel clone retains deltas (managed: %s)', managed => { + const event = new FederatedWheelEvent(managed ? new EventManager(null, {}) : undefined); + Object.assign(event, { type: 'wheel', deltaMode: 1, deltaX: 2, deltaY: 3, deltaZ: 4 }); + event.viewport.x = 10; + const cloned = event.clone(); + event.deltaY = 30; + event.viewport.x = 100; + expect(cloned).toBeInstanceOf(FederatedWheelEvent); + expect(cloned).toMatchObject({ type: 'wheel', deltaMode: 1, deltaX: 2, deltaY: 3, deltaZ: 4, viewX: 10 }); + }); + + test('root mouse clone retains coordinates without a manager', () => { + const event = new FederatedMouseEvent(); + event.type = 'mousemove'; + event.client.x = 10; + const cloned = event.clone(); + event.client.x = 20; + expect(cloned).toBeInstanceOf(FederatedMouseEvent); + expect(cloned).toMatchObject({ type: 'mousemove', clientX: 10, path: [] }); + }); + + test.each([FederatedMouseEvent, FederatedPointerEvent, FederatedWheelEvent])( + '%p clone detaches propagation paths and retains target identity', + EventConstructor => { + const root = {} as any; + const target = { parent: root } as any; + const manager = new EventManager(root, {}); + const event = new EventConstructor(manager); + event.target = target; + const cloned = event.clone(); + expect(cloned.manager).toBe(manager); + expect(cloned.target).toBe(target); + expect(cloned.path).toEqual([root, target]); + expect(cloned.detailPath).toEqual([root, target]); + event.path.length = 0; + event.detailPath.length = 0; + expect(cloned.path).toEqual([root, target]); + expect(cloned.detailPath).toEqual([root, target]); + } + ); + + test('cloned gesture retains its complete payload', () => { + const event = Object.assign(new FederatedPointerEvent(new EventManager(null, {})), { + scale: 2, + center: { x: 5, y: 0 }, + points: [ + { x: 0, y: 0 }, + { x: 20, y: 0 } + ], + direction: 'right', + velocity: 3 + }); + const cloned = event.clone(); + expect(cloned).toMatchObject({ + scale: 2, + center: event.center, + points: event.points, + direction: 'right', + velocity: 3 + }); + expect((cloned as typeof event).center).toBe(event.center); + expect((cloned as typeof event).points).toBe(event.points); + }); +}); diff --git a/packages/vrender-core/__tests__/unit/common/host-input.test.ts b/packages/vrender-core/__tests__/unit/common/host-input.test.ts index fa09eadc5..04e2eb482 100644 --- a/packages/vrender-core/__tests__/unit/common/host-input.test.ts +++ b/packages/vrender-core/__tests__/unit/common/host-input.test.ts @@ -1,7 +1,7 @@ /** @jest-environment jsdom */ import { EventEmitter } from '@visactor/vutils'; import { EventSystem } from '../../../src/event/event-system'; -import type { RenderConfig } from '../../../src/interface/event'; +import type { IFederatedMouseEvent, RenderConfig } from '../../../src/interface/event'; function setup() { const canvas = document.createElement('canvas'); @@ -124,3 +124,24 @@ test('new input enqueued while draining cancellation stays behind already queued root.removeAllListeners(); system.release(); }); + +test.each(['canvas', 'window'] as const)('%s input clones survive root event reuse', source => { + const { system, send } = setup(); + let saved: IFederatedMouseEvent; + let borrowed: IFederatedMouseEvent; + system.input[source].on('pointerdown', event => { + borrowed = event; + saved = event.clone(); + }); + send('mousedown'); + send('mousemove'); + send('mouseup'); + expect(saved).not.toBe(borrowed); + expect(saved.type).toBe('pointerdown'); + expect(saved.nativeEvent.type).toBe('mousedown'); + expect(saved.canvasX).toBe(20); + expect(saved.clientX).toBe(60); + expect(borrowed.nativeEvent).toBeNull(); + expect(borrowed.type).toBe('pointerup'); + system.release(); +}); diff --git a/packages/vrender-core/src/event/federated-event/mouse-event.ts b/packages/vrender-core/src/event/federated-event/mouse-event.ts index 678589a6b..603325547 100644 --- a/packages/vrender-core/src/event/federated-event/mouse-event.ts +++ b/packages/vrender-core/src/event/federated-event/mouse-event.ts @@ -131,6 +131,29 @@ export class FederatedMouseEvent extends FederatedEvent(event: T): T { + Object.assign(event, this); + const points = ['layer', 'page', 'canvas', 'viewport', 'client', 'movement', 'offset', 'global', 'screen'] as const; + for (const key of points) { + const point = this[key]; + event[key] = { x: point.x, y: point.y }; + } + // Root input has no manager or propagation path, but still owns reusable coordinates. + event.path = (this.manager ? this.composedPath() : this.path)?.slice() ?? []; + event.detailPath = this.detailPath?.slice(); + event.eventPhase = event.NONE; + event.currentTarget = null; + event.defaultPrevented = false; + event.propagationStopped = false; + event.propagationImmediatelyStopped = false; + return event; + } + /** * Whether the modifier key was pressed when this event natively occurred. * @param key - The modifier key. diff --git a/packages/vrender-core/src/event/federated-event/pointer-event.ts b/packages/vrender-core/src/event/federated-event/pointer-event.ts index 6538446b5..aea3ffa9c 100644 --- a/packages/vrender-core/src/event/federated-event/pointer-event.ts +++ b/packages/vrender-core/src/event/federated-event/pointer-event.ts @@ -107,29 +107,7 @@ export class FederatedPointerEvent extends FederatedMouseEvent implements Pointe throw new Error('getPredictedEvents is not supported!'); } - clone() { - const event = new FederatedPointerEvent(this.manager); - - event.eventPhase = event.NONE; - event.currentTarget = null; - event.path = []; - event.detailPath = []; - event.target = null; - - event.nativeEvent = this.nativeEvent; - event.originalEvent = this.originalEvent; - - this.manager?.copyPointerData(this, event); - this.manager?.copyMouseData(this, event); - this.manager?.copyData(this, event); - - // copy propagation path for perf - event.target = this.target; - event.path = this.composedPath().slice(); - const p = this.composedDetailPath(); - event.detailPath = p && p.slice(); - event.type = this.type; - - return event; + clone(): FederatedPointerEvent { + return this.cloneProperties(new FederatedPointerEvent(this.manager)); } } diff --git a/packages/vrender-core/src/event/federated-event/wheel-event.ts b/packages/vrender-core/src/event/federated-event/wheel-event.ts index 35a28f8f1..190ab4e63 100644 --- a/packages/vrender-core/src/event/federated-event/wheel-event.ts +++ b/packages/vrender-core/src/event/federated-event/wheel-event.ts @@ -52,28 +52,7 @@ export class FederatedWheelEvent extends FederatedMouseEvent implements WheelEve readonly DOM_DELTA_PAGE = 2; - clone() { - const event = new FederatedWheelEvent(this.manager); - - event.eventPhase = event.NONE; - event.currentTarget = null; - event.path = []; - event.detailPath = []; - event.target = null; - - event.nativeEvent = this.nativeEvent; - event.originalEvent = this.originalEvent; - - this.manager?.copyWheelData(this, event); - this.manager?.copyMouseData(this, event); - this.manager?.copyData(this, event); - - event.target = this.target; - event.path = this.composedPath().slice(); - const p = this.composedDetailPath(); - event.detailPath = p && p.slice(); - event.type = this.type; - - return event; + clone(): FederatedWheelEvent { + return this.cloneProperties(new FederatedWheelEvent(this.manager)); } } diff --git a/packages/vrender-core/src/interface/event.ts b/packages/vrender-core/src/interface/event.ts index 0802bd0ba..c303a593d 100644 --- a/packages/vrender-core/src/interface/event.ts +++ b/packages/vrender-core/src/interface/event.ts @@ -73,6 +73,8 @@ export interface IFederatedEvent { } export interface IFederatedMouseEvent extends IFederatedEvent { + /** Copies coordinates and paths; targets, native events and extension payloads stay shared. */ + clone: () => IFederatedMouseEvent; altKey: boolean; button: number; buttons: number; @@ -311,7 +313,7 @@ export interface HostInputOptions { inViewport: boolean; } -/** Synchronous only: events are pooled. Async consumers must copy the required scalar values. */ +/** Events are pooled; async consumers must call event.clone() before returning from the listener. */ export interface InputEventSource { on(type: string, listener: (event: IFederatedMouseEvent) => void): void; off(type: string, listener: (event: IFederatedMouseEvent) => void): void;