refactor(core): Add a bit to EventInfo to mark resolution. (#55864)

tbondwilkinson · dylhunn · commit b79b6c14de89 · 2024-05-21T12:20:48.000-07:00
This will prevent running `ActionResolver` logic multiple times while migrating to use `Dispatcher` to resolve actions rather than `EventContract`. PR Close #55864
diff --git a/goldens/public-api/core/primitives/event-dispatch/index.md b/goldens/public-api/core/primitives/event-dispatch/index.md
@@ -78,6 +78,8 @@ export class EventInfoWrapper {
     // (undocumented)
     getIsReplay(): boolean | undefined;
     // (undocumented)
+    getResolved(): boolean | undefined;
+    // (undocumented)
     getTargetElement(): Element;
     // (undocumented)
     getTimestamp(): number;
@@ -92,6 +94,8 @@ export class EventInfoWrapper {
     // (undocumented)
     setIsReplay(replay: boolean): void;
     // (undocumented)
+    setResolved(resolved: boolean): void;
+    // (undocumented)
     setTargetElement(targetElement: Element): void;
     // (undocumented)
     setTimestamp(timestamp: number): void;
diff --git a/packages/core/primitives/event-dispatch/src/action_resolver.ts b/packages/core/primitives/event-dispatch/src/action_resolver.ts
@@ -53,7 +53,11 @@ export class ActionResolver {
   }
 
   resolve(eventInfo: eventInfoLib.EventInfo) {
+    if (eventInfoLib.getResolved(eventInfo)) {
+      return;
+    }
     this.populateAction(eventInfo);
+    eventInfoLib.setResolved(eventInfo, true);
   }
 
   /**
diff --git a/packages/core/primitives/event-dispatch/src/event_info.ts b/packages/core/primitives/event-dispatch/src/event_info.ts
@@ -54,6 +54,8 @@ export declare interface EventInfo {
    * as a `click`. Only used when a11y click events is on.
    */
   eiack?: boolean;
+  /** Whether action resolution has already run on this `EventInfo`. */
+  eir?: boolean;
 }
 
 /** Added for readability when accessing stable property names. */
@@ -151,6 +153,16 @@ export function setA11yClickKey(eventInfo: EventInfo, a11yClickKey: boolean) {
   eventInfo.eiack = a11yClickKey;
 }
 
+/** Added for readability when accessing stable property names. */
+export function getResolved(eventInfo: EventInfo) {
+  return eventInfo.eir;
+}
+
+/** Added for readability when accessing stable property names. */
+export function setResolved(eventInfo: EventInfo, resolved: boolean) {
+  eventInfo.eir = resolved;
+}
+
 /** Clones an `EventInfo` */
 export function cloneEventInfo(eventInfo: EventInfo): EventInfo {
   return {
@@ -162,6 +174,7 @@ export function cloneEventInfo(eventInfo: EventInfo): EventInfo {
     timeStamp: eventInfo.timeStamp,
     eirp: eventInfo.eirp,
     eiack: eventInfo.eiack,
+    eir: eventInfo.eir,
   };
 }
 
@@ -303,6 +316,14 @@ export class EventInfoWrapper {
     setIsReplay(this.eventInfo, replay);
   }
 
+  getResolved() {
+    return getResolved(this.eventInfo);
+  }
+
+  setResolved(resolved: boolean) {
+    setResolved(this.eventInfo, resolved);
+  }
+
   clone() {
     return new EventInfoWrapper(cloneEventInfo(this.eventInfo));
   }
diff --git a/packages/core/primitives/event-dispatch/test/eventcontract_test.ts b/packages/core/primitives/event-dispatch/test/eventcontract_test.ts
@@ -450,6 +450,7 @@ describe('EventContract', () => {
     expect(eventInfoWrapper.getTargetElement()).toBe(targetElement);
     expect(eventInfoWrapper.getAction()?.name).toBe('handleClick');
     expect(eventInfoWrapper.getAction()?.element).toBe(actionElement);
+    expect(eventInfoWrapper.getResolved()).toBe(true);
   });
 
   it('dispatches event when targetElement is actionElement', () => {

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,11 @@ export class ActionResolver {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`resolve(eventInfo: eventInfoLib.EventInfo) {`
	`56`	`+ if (eventInfoLib.getResolved(eventInfo)) {`
	`57`	`+ return;`
	`58`	`+ }`
`56`	`59`	`this.populateAction(eventInfo);`
	`60`	`+ eventInfoLib.setResolved(eventInfo, true);`
`57`	`61`	`}`
`58`	`62`
`59`	`63`	`/**`