Merge pull request #943 from emberjs/fix-trigger-event

Author: rwjblue

addon-test-support/@ember/test-helpers/dom/-get-window-or-element.ts

@@ -0,0 +1,17 @@
+import getElement from './-get-element';
+import Target, { isWindow } from './-target';
+
+/**
+  Used internally by the DOM interaction helpers to find either window or an element.
+
+  @private
+  @param {string|Element} target the window, an element or selector to retrieve
+  @returns {Element|Window} the target or selector
+*/
+export function getWindowOrElement(target: Target): Element | Document | Window | null {
+  if (isWindow(target)) {
+    return target as Window;
+  }
+
+  return getElement(target);
+}

addon-test-support/@ember/test-helpers/dom/-is-focusable.ts

@@ -1,5 +1,5 @@
 import isFormControl from './-is-form-control';
-import { isDocument, isContentEditable } from './-target';
+import { isDocument, isContentEditable, isWindow } from './-target';
 
 const FOCUSABLE_TAGS = ['A'];
 
@@ -16,8 +16,12 @@ function isFocusableElement(element: Element): element is FocusableElement {
   @returns {boolean} `true` when the element is focusable, `false` otherwise
 */
 export default function isFocusable(
-  element: HTMLElement | SVGElement | Element | Document
+  element: HTMLElement | SVGElement | Element | Document | Window
 ): element is HTMLElement | SVGElement {
+  if (isWindow(element)) {
+    return false;
+  }
+
   if (isDocument(element)) {
     return false;
   }

addon-test-support/@ember/test-helpers/dom/-is-form-control.ts

@@ -1,4 +1,4 @@
-import { isDocument } from './-target';
+import { isDocument, isWindow } from './-target';
 
 const FORM_CONTROL_TAGS = ['INPUT', 'BUTTON', 'SELECT', 'TEXTAREA'];
 
@@ -13,8 +13,11 @@ export type FormControl =
   @param {Element} element the element to check
   @returns {boolean} `true` when the element is a form control, `false` otherwise
 */
-export default function isFormControl(element: Element | Document): element is FormControl {
+export default function isFormControl(
+  element: Element | Document | Window
+): element is FormControl {
   return (
+    !isWindow(element) &&
     !isDocument(element) &&
     FORM_CONTROL_TAGS.indexOf(element.tagName) > -1 &&
     (element as HTMLInputElement).type !== 'hidden'

addon-test-support/@ember/test-helpers/dom/-target.ts

@@ -11,6 +11,11 @@ export function isElement(target: any): target is Element {
   return target.nodeType === Node.ELEMENT_NODE;
 }
 
+// eslint-disable-next-line require-jsdoc
+export function isWindow(target: Target): target is Window {
+  return target instanceof Window;
+}
+
 // eslint-disable-next-line require-jsdoc
 export function isDocument(target: any): target is Document {
   return target.nodeType === Node.DOCUMENT_NODE;

addon-test-support/@ember/test-helpers/dom/click.ts

@@ -1,5 +1,5 @@
 import { assign } from '@ember/polyfills';
-import getElement from './-get-element';
+import { getWindowOrElement } from './-get-window-or-element';
 import fireEvent from './fire-event';
 import { __focus__ } from './focus';
 import settled from '../settled';
@@ -31,7 +31,7 @@ export const DEFAULT_CLICK_OPTIONS = {
   @param {Element} element the element to click on
   @param {MouseEventInit} options the options to be merged into the mouse events
 */
-export function __click__(element: Element | Document, options: MouseEventInit): void {
+export function __click__(element: Element | Document | Window, options: MouseEventInit): void {
   fireEvent(element, 'mousedown', options);
 
   if (isFocusable(element)) {
@@ -97,7 +97,7 @@ export default function click(target: Target, _options: MouseEventInit = {}): Pr
         throw new Error('Must pass an element or selector to `click`.');
       }
 
-      let element = getElement(target);
+      let element = getWindowOrElement(target);
       if (!element) {
         throw new Error(`Element not found when calling \`click('${target}')\`.`);
       }

addon-test-support/@ember/test-helpers/dom/double-click.ts

@@ -1,5 +1,5 @@
 import { assign } from '@ember/polyfills';
-import getElement from './-get-element';
+import { getWindowOrElement } from './-get-window-or-element';
 import fireEvent from './fire-event';
 import { __focus__ } from './focus';
 import settled from '../settled';
@@ -20,7 +20,10 @@ registerHook('doubleClick', 'start', (target: Target) => {
   @param {Element} element the element to double-click on
   @param {MouseEventInit} options the options to be merged into the mouse events
 */
-export function __doubleClick__(element: Element | Document, options: MouseEventInit): void {
+export function __doubleClick__(
+  element: Element | Document | Window,
+  options: MouseEventInit
+): void {
   fireEvent(element, 'mousedown', options);
 
   if (isFocusable(element)) {
@@ -98,7 +101,7 @@ export default function doubleClick(target: Target, _options: MouseEventInit = {
         throw new Error('Must pass an element or selector to `doubleClick`.');
       }
 
-      let element = getElement(target);
+      let element = getWindowOrElement(target);
       if (!element) {
         throw new Error(`Element not found when calling \`doubleClick('${target}')\`.`);
       }

addon-test-support/@ember/test-helpers/dom/trigger-event.ts

@@ -1,4 +1,4 @@
-import getElement from './-get-element';
+import { getWindowOrElement } from './-get-window-or-element';
 import fireEvent from './fire-event';
 import settled from '../settled';
 import { nextTickPromise } from '../-utils';
@@ -72,7 +72,7 @@ export default function triggerEvent(
         throw new Error(`Must provide an \`eventType\` to \`triggerEvent\``);
       }
 
-      let element = getElement(target);
+      let element = getWindowOrElement(target);
       if (!element) {
         throw new Error(`Element not found when calling \`triggerEvent('${target}', ...)\`.`);
       }

tests/unit/dom/click-test.js

@@ -234,3 +234,19 @@ module('DOM Helper: click', function (hooks) {
     });
   });
 });
+
+module('DOM Helper: click with window', function () {
+  test('clicking window without context set fires the given event type', async function (assert) {
+    let listener = e => {
+      assert.step('click');
+      assert.ok(e instanceof Event, `click listener receives a native event`);
+    };
+    window.addEventListener('click', listener);
+
+    await click(window, 'click');
+
+    assert.verifySteps(['click']);
+
+    window.removeEventListener('click', listener);
+  });
+});

tests/unit/dom/double-click-test.js

@@ -278,3 +278,19 @@ module('DOM Helper: doubleClick', function (hooks) {
     });
   });
 });
+
+module('DOM Helper: doubleClick with window', function () {
+  test('double clicking window without context set fires the given event type', async function (assert) {
+    let listener = e => {
+      assert.step('click');
+      assert.ok(e instanceof Event, `click listener receives a native event`);
+    };
+    window.addEventListener('click', listener);
+
+    await doubleClick(window, 'click');
+
+    assert.verifySteps(['click', 'click']);
+
+    window.removeEventListener('click', listener);
+  });
+});

tests/unit/dom/trigger-event-test.js

@@ -171,3 +171,19 @@ module('DOM Helper: triggerEvent', function (hooks) {
     assert.verifySteps(['inner: mouseenter', 'outer: mouseenter', 'mouseenter']);
   });
 });
+
+module('DOM Helper: triggerEvent with window', function () {
+  test('triggering event via window without context set fires the given event type', async function (assert) {
+    let listener = e => {
+      assert.step('resize');
+      assert.ok(e instanceof Event, `resize listener receives a native event`);
+    };
+    window.addEventListener('resize', listener);
+
+    await triggerEvent(window, 'resize');
+
+    assert.verifySteps(['resize']);
+
+    window.removeEventListener('resize', listener);
+  });
+});