Merge pull request #155 from Seneca-CDOT/fix/label-stack-error

fix: call stack error in jsdom when clicking label element descendants
Seneca-CDOT · Mar 4, 2020 · 17aeaa1 · 17aeaa1
2 parents a325676 + 1c19be9
commit 17aeaa1
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 1 deletion.
diff --git a/src/WebElement/WebElement.ts b/src/WebElement/WebElement.ts
@@ -176,9 +176,13 @@ class WebElement {
    */
   private dispatchMouseEvents(element: HTMLElement, events: string[]): void {
     events.forEach(event => {
+      // prevents call stack error in jsdom when clicking label element descendants
+      const bubbles =
+        event === 'click' && this.findAncestor('label') ? false : true;
+
       element.dispatchEvent(
         new MouseEvent(event, {
-          bubbles: true,
+          bubbles,
           cancelable: true,
           composed: true,
           which: 1,

diff --git a/test/jest/e2e/click.test.js b/test/jest/e2e/click.test.js
@@ -0,0 +1,93 @@
+const request = require('supertest');
+const nock = require('nock');
+
+const { app } = require('../../../build/app');
+const { createSession } = require('./helpers');
+const { ELEMENT } = require('../../../build/constants/constants');
+
+describe('Click Element', () => {
+  let sessionId;
+
+  beforeAll(async () => {
+    nock(/plumadriver\.com/)
+      .get('/')
+      .reply(
+        200,
+        `<!DOCTYPE html>
+        <html lang="en">
+          <head>
+            <title>Test Page</title>
+          </head>
+          <body>
+            <label>
+              <select>
+                <option id="overflow-option" value="foo"></option>
+              </select>
+            </label>
+            <label>
+              <textarea id="overflow-textarea"></textarea>
+            </label>
+            <div id="bar" onclick="">
+              <button id="bubble">bubbled=false</button>
+            </div>
+            <script>
+              document
+                .querySelector('#bar')
+                .addEventListener(
+                  'click',
+                  e => (e.target.textContent = 'bubbled=true'),
+                );
+            </script>
+          </body>
+        </html>
+        `,
+      );
+
+    sessionId = await createSession(request, app);
+    await request(app)
+      .post(`/session/${sessionId}/url`)
+      .send({
+        url: 'http://plumadriver.com',
+      });
+  });
+
+  const getElement = async cssSelector => {
+    const {
+      body: {
+        value: { [ELEMENT]: elementId },
+      },
+    } = await request(app)
+      .post(`/session/${sessionId}/element`)
+      .send({ using: 'css selector', value: cssSelector })
+      .expect(200);
+
+    return elementId;
+  };
+
+  const clickElement = elementId => {
+    return request(app)
+      .post(`/session/${sessionId}/element/${elementId}/click`)
+      .expect(200);
+  };
+
+  it('does not cause call stack error when clicking label descendant', async () => {
+    const optionElementId = await getElement('#overflow-option');
+    await clickElement(optionElementId);
+
+    const textareaElementId = await getElement('#overflow-textarea');
+    await clickElement(textareaElementId);
+  });
+
+  it('bubbles click events', async () => {
+    const buttonElementId = await getElement('#bubble');
+    await clickElement(buttonElementId);
+
+    const {
+      body: { value },
+    } = await request(app).get(
+      `/session/${sessionId}/element/${buttonElementId}/text`,
+    );
+
+    expect(value).toBe('bubbled=true');
+  });
+});