refactor: remove deprecated EventManager method addGlobalEventListener (#49645)

alan-agius4 · atscott · commit 2703fd626040 · 2023-03-30T09:47:54.000-07:00
This commit removed the deprecated `EventManager` method `addGlobalEventListener`. BREAKING CHANGE: Deprecated `EventManager` method `addGlobalEventListener` has been removed as it is not used by Ivy. PR Close #49645
diff --git a/goldens/public-api/platform-browser/index.md b/goldens/public-api/platform-browser/index.md
@@ -94,8 +94,6 @@ export const EVENT_MANAGER_PLUGINS: InjectionToken<EventManagerPlugin[]>;
 export class EventManager {
     constructor(plugins: EventManagerPlugin[], _zone: NgZone);
     addEventListener(element: HTMLElement, eventName: string, handler: Function): Function;
-    // @deprecated
-    addGlobalEventListener(target: string, eventName: string, handler: Function): Function;
     getZone(): NgZone;
     // (undocumented)
     static ɵfac: i0.ɵɵFactoryDeclaration<EventManager, never>;
diff --git a/packages/core/test/bundling/animations/bundle.golden_symbols.json b/packages/core/test/bundling/animations/bundle.golden_symbols.json
@@ -866,9 +866,6 @@
   {
     "name": "dashCaseToCamelCase"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json b/packages/core/test/bundling/cyclic_import/bundle.golden_symbols.json
@@ -638,9 +638,6 @@
   {
     "name": "currentConsumer"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json b/packages/core/test/bundling/forms_reactive/bundle.golden_symbols.json
@@ -872,9 +872,6 @@
   {
     "name": "currentConsumer"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json b/packages/core/test/bundling/forms_template_driven/bundle.golden_symbols.json
@@ -842,9 +842,6 @@
   {
     "name": "currentConsumer"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/router/bundle.golden_symbols.json b/packages/core/test/bundling/router/bundle.golden_symbols.json
@@ -1091,9 +1091,6 @@
   {
     "name": "decodeQuery"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json b/packages/core/test/bundling/standalone_bootstrap/bundle.golden_symbols.json
@@ -578,9 +578,6 @@
   {
     "name": "currentConsumer"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/core/test/bundling/todo/bundle.golden_symbols.json b/packages/core/test/bundling/todo/bundle.golden_symbols.json
@@ -758,9 +758,6 @@
   {
     "name": "currentConsumer"
   },
-  {
-    "name": "decoratePreventDefault"
-  },
   {
     "name": "deepForEach"
   },
diff --git a/packages/platform-browser/src/dom/dom_renderer.ts b/packages/platform-browser/src/dom/dom_renderer.ts
@@ -6,6 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {ɵgetDOM as getDOM} from '@angular/common';
 import {APP_ID, CSP_NONCE, Inject, Injectable, InjectionToken, OnDestroy, Optional, Renderer2, RendererFactory2, RendererStyleFlags2, RendererType2, ViewEncapsulation} from '@angular/core';
 
 import {EventManager} from './events/event_manager';
@@ -288,10 +289,13 @@ class DefaultDomRenderer2 implements Renderer2 {
       () => void {
     (typeof ngDevMode === 'undefined' || ngDevMode) && checkNoSyntheticProp(event, 'listener');
     if (typeof target === 'string') {
-      return <() => void>this.eventManager.addGlobalEventListener(
-          target, event, decoratePreventDefault(callback));
+      target = getDOM().getGlobalEventTarget(document, target);
+      if (!target) {
+        throw new Error(`Unsupported event target ${target} for event ${event}`);
+      }
     }
-    return <() => void>this.eventManager.addEventListener(
+
+    return this.eventManager.addEventListener(
                target, event, decoratePreventDefault(callback)) as () => void;
   }
 }
diff --git a/packages/platform-browser/src/dom/events/event_manager.ts b/packages/platform-browser/src/dom/events/event_manager.ts
@@ -6,7 +6,6 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {ɵgetDOM as getDOM} from '@angular/common';
 import {Inject, Injectable, InjectionToken, NgZone} from '@angular/core';
 
 /**
@@ -52,21 +51,6 @@ export class EventManager {
     return plugin.addEventListener(element, eventName, handler);
   }
 
-  /**
-   * Registers a global handler for an event in a target view.
-   *
-   * @param target A target for global event notifications. One of "window", "document", or "body".
-   * @param eventName The name of the event to listen for.
-   * @param handler A function to call when the notification occurs. Receives the
-   * event object as an argument.
-   * @returns A callback function that can be used to remove the handler.
-   * @deprecated No longer being used in Ivy code. To be removed in version 14.
-   */
-  addGlobalEventListener(target: string, eventName: string, handler: Function): Function {
-    const plugin = this._findPluginFor(eventName);
-    return plugin.addGlobalEventListener(target, eventName, handler);
-  }
-
   /**
    * Retrieves the compilation zone in which event listeners are registered.
    */
@@ -102,12 +86,4 @@ export abstract class EventManagerPlugin {
   abstract supports(eventName: string): boolean;
 
   abstract addEventListener(element: HTMLElement, eventName: string, handler: Function): Function;
-
-  addGlobalEventListener(element: string, eventName: string, handler: Function): Function {
-    const target: HTMLElement = getDOM().getGlobalEventTarget(this._doc, element);
-    if (!target) {
-      throw new Error(`Unsupported event target ${target} for event ${eventName}`);
-    }
-    return this.addEventListener(target, eventName, handler);
-  }
 }
diff --git a/packages/platform-browser/test/dom/events/event_manager_spec.ts b/packages/platform-browser/test/dom/events/event_manager_spec.ts
@@ -75,26 +75,6 @@ describe('EventManager', () => {
     expect(receivedEvent).toBe(dispatchedEvent);
   });
 
-  it('should add and remove global event listeners', () => {
-    const element = el('<div><div></div></div>');
-    doc.body.appendChild(element);
-    const dispatchedEvent = createMouseEvent('click');
-    let receivedEvent: any /** TODO #9100 */ = null;
-    const handler = (e: any /** TODO #9100 */) => {
-      receivedEvent = e;
-    };
-    const manager = new EventManager([domEventPlugin], new FakeNgZone());
-
-    const remover = manager.addGlobalEventListener('document', 'click', handler);
-    getDOM().dispatchEvent(element, dispatchedEvent);
-    expect(receivedEvent).toBe(dispatchedEvent);
-
-    receivedEvent = null;
-    remover();
-    getDOM().dispatchEvent(element, dispatchedEvent);
-    expect(receivedEvent).toBe(null);
-  });
-
   it('should keep zone when addEventListener', () => {
     const Zone = (window as any)['Zone'];
 
diff --git a/packages/platform-browser/test/dom/events/hammer_gestures_spec.ts b/packages/platform-browser/test/dom/events/hammer_gestures_spec.ts
@@ -30,14 +30,6 @@ import {HammerGestureConfig, HammerGesturesPlugin,} from '@angular/platform-brow
         plugin = new HammerGesturesPlugin(document, new HammerGestureConfig(), fakeConsole);
       });
 
-      it('should implement addGlobalEventListener', () => {
-        spyOn(plugin, 'addEventListener').and.callFake(() => () => {});
-
-        expect(() => {
-          plugin.addGlobalEventListener('document', 'swipe', () => {});
-        }).not.toThrowError();
-      });
-
       it('should warn user and do nothing when Hammer.js not loaded', () => {
         expect(plugin.supports('swipe')).toBe(false);
         expect(fakeConsole.warn)
diff --git a/packages/platform-browser/test/dom/events/key_events_spec.ts b/packages/platform-browser/test/dom/events/key_events_spec.ts
@@ -71,17 +71,6 @@ import {KeyEventsPlugin} from '@angular/platform-browser/src/dom/events/key_even
           .toEqual(KeyEventsPlugin.parseEventName('keyup.control.escape'));
     });
 
-    if (!isNode) {
-      it('should implement addGlobalEventListener', () => {
-        const plugin = new KeyEventsPlugin(document);
-
-        spyOn(plugin, 'addEventListener').and.callFake(() => () => {});
-
-        expect(() => plugin.addGlobalEventListener('window', 'keyup.control.esc', () => {}))
-            .not.toThrowError();
-      });
-    }
-
     it('should match key field', () => {
       const baseKeyboardEvent = {
         isTrusted: true,
diff --git a/packages/platform-server/src/server_events.ts b/packages/platform-server/src/server_events.ts
@@ -21,13 +21,4 @@ export class ServerEventManagerPlugin /* extends EventManagerPlugin which is pri
   addEventListener(element: HTMLElement, eventName: string, handler: Function): Function {
     return getDOM().onAndCancel(element, eventName, handler);
   }
-
-  /** @deprecated No longer being used in Ivy code. To be removed in version 14. */
-  addGlobalEventListener(element: string, eventName: string, handler: Function): Function {
-    const target: HTMLElement = getDOM().getGlobalEventTarget(this.doc, element);
-    if (!target) {
-      throw new Error(`Unsupported event target ${target} for event ${eventName}`);
-    }
-    return this.addEventListener(target, eventName, handler);
-  }
 }
diff --git a/packages/platform-server/src/server_renderer.ts b/packages/platform-server/src/server_renderer.ts
@@ -209,11 +209,7 @@ class DefaultServerRenderer2 implements Renderer2 {
       target: 'document'|'window'|'body'|any, eventName: string,
       callback: (event: any) => boolean): () => void {
     checkNoSyntheticProp(eventName, 'listener');
-    if (typeof target === 'string') {
-      return <() => void>this.eventManager.addGlobalEventListener(
-          target, eventName, this.decoratePreventDefault(callback));
-    }
-    return <() => void>this.eventManager.addEventListener(
+    return this.eventManager.addEventListener(
                target, eventName, this.decoratePreventDefault(callback)) as () => void;
   }
 

Original file line number	Diff line number	Diff line change
`@@ -866,9 +866,6 @@`
`866`	`866`	`{`
`867`	`867`	`"name": "dashCaseToCamelCase"`
`868`	`868`	`},`
`869`		`- {`
`870`		`- "name": "decoratePreventDefault"`
`871`		`- },`
`872`	`869`	`{`
`873`	`870`	`"name": "deepForEach"`
`874`	`871`	`},`
Original file line number	Diff line number	Diff line change
`@@ -638,9 +638,6 @@`
`638`	`638`	`{`
`639`	`639`	`"name": "currentConsumer"`
`640`	`640`	`},`
`641`		`- {`
`642`		`- "name": "decoratePreventDefault"`
`643`		`- },`
`644`	`641`	`{`
`645`	`642`	`"name": "deepForEach"`
`646`	`643`	`},`
Original file line number	Diff line number	Diff line change
`@@ -872,9 +872,6 @@`
`872`	`872`	`{`
`873`	`873`	`"name": "currentConsumer"`
`874`	`874`	`},`
`875`		`- {`
`876`		`- "name": "decoratePreventDefault"`
`877`		`- },`
`878`	`875`	`{`
`879`	`876`	`"name": "deepForEach"`
`880`	`877`	`},`
Original file line number	Diff line number	Diff line change
`@@ -842,9 +842,6 @@`
`842`	`842`	`{`
`843`	`843`	`"name": "currentConsumer"`
`844`	`844`	`},`
`845`		`- {`
`846`		`- "name": "decoratePreventDefault"`
`847`		`- },`
`848`	`845`	`{`
`849`	`846`	`"name": "deepForEach"`
`850`	`847`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1091,9 +1091,6 @@`
`1091`	`1091`	`{`
`1092`	`1092`	`"name": "decodeQuery"`
`1093`	`1093`	`},`
`1094`		`- {`
`1095`		`- "name": "decoratePreventDefault"`
`1096`		`- },`
`1097`	`1094`	`{`
`1098`	`1095`	`"name": "deepForEach"`
`1099`	`1096`	`},`
Original file line number	Diff line number	Diff line change
`@@ -578,9 +578,6 @@`
`578`	`578`	`{`
`579`	`579`	`"name": "currentConsumer"`
`580`	`580`	`},`
`581`		`- {`
`582`		`- "name": "decoratePreventDefault"`
`583`		`- },`
`584`	`581`	`{`
`585`	`582`	`"name": "deepForEach"`
`586`	`583`	`},`
Original file line number	Diff line number	Diff line change
`@@ -758,9 +758,6 @@`
`758`	`758`	`{`
`759`	`759`	`"name": "currentConsumer"`
`760`	`760`	`},`
`761`		`- {`
`762`		`- "name": "decoratePreventDefault"`
`763`		`- },`
`764`	`761`	`{`
`765`	`762`	`"name": "deepForEach"`
`766`	`763`	`},`