[JS] Adding support for /computedlabel (getAccessibleName) (#9073)

SeleniumHQ · Jan 22, 2021 · 84fc16d · 84fc16d
1 parent 1d8273f
commit 84fc16d
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 3 deletions.
diff --git a/javascript/node/selenium-webdriver/lib/command.js b/javascript/node/selenium-webdriver/lib/command.js
@@ -141,6 +141,7 @@ const Name = {
 
   GET_ELEMENT_TEXT: 'getElementText',
   GET_COMPUTED_ROLE: 'getAriaRole',
+  GET_COMPUTED_LABEL: 'getAccessibleName',
   GET_ELEMENT_TAG_NAME: 'getElementTagName',
   IS_ELEMENT_SELECTED: 'isElementSelected',
   IS_ELEMENT_ENABLED: 'isElementEnabled',

diff --git a/javascript/node/selenium-webdriver/lib/http.js b/javascript/node/selenium-webdriver/lib/http.js
@@ -234,7 +234,14 @@ const COMMAND_MAP = new Map([
   ],
   [cmd.Name.SUBMIT_ELEMENT, post('/session/:sessionId/element/:id/submit')],
   [cmd.Name.GET_ELEMENT_TEXT, get('/session/:sessionId/element/:id/text')],
-  [cmd.Name.GET_COMPUTED_ROLE, get('/session/:sessionId/element/:id/computedrole')],
+  [
+    cmd.Name.GET_COMPUTED_ROLE,
+    get('/session/:sessionId/element/:id/computedrole'),
+  ],
+  [
+    cmd.Name.GET_COMPUTED_LABEL,
+    get('/session/:sessionId/element/:id/computedlabel'),
+  ],
   [cmd.Name.GET_ELEMENT_TAG_NAME, get('/session/:sessionId/element/:id/name')],
   [
     cmd.Name.IS_ELEMENT_SELECTED,
@@ -403,7 +410,14 @@ const W3C_COMMAND_MAP = new Map([
     post('/session/:sessionId/element/:id/value'),
   ],
   [cmd.Name.GET_ELEMENT_TEXT, get('/session/:sessionId/element/:id/text')],
-  [cmd.Name.GET_COMPUTED_ROLE, get('/session/:sessionId/element/:id/computedrole')],
+  [
+    cmd.Name.GET_COMPUTED_ROLE,
+    get('/session/:sessionId/element/:id/computedrole'),
+  ],
+  [
+    cmd.Name.GET_COMPUTED_LABEL,
+    get('/session/:sessionId/element/:id/computedlabel'),
+  ],
   [cmd.Name.IS_ELEMENT_ENABLED, get('/session/:sessionId/element/:id/enabled')],
   [
     cmd.Name.GET_ELEMENT_ATTRIBUTE,

diff --git a/javascript/node/selenium-webdriver/lib/webdriver.js b/javascript/node/selenium-webdriver/lib/webdriver.js
@@ -2334,6 +2334,15 @@ class WebElement {
     return this.execute_(new command.Command(command.Name.GET_COMPUTED_ROLE))
   }
 
+  /**
+   * Get the computed WAI-ARIA label of element.
+   *
+   * @return {!Promise<string>} A promise that will be
+   *     resolved with the element's computed label.
+   */
+  getAccessibleName() {
+    return this.execute_(new command.Command(command.Name.GET_COMPUTED_LABEL))
+  }
   /**
    * Returns an object describing an element's location, in pixels relative to
    * the document element, and the element's size in pixels.

diff --git a/javascript/node/selenium-webdriver/package.json b/javascript/node/selenium-webdriver/package.json
@@ -43,7 +43,7 @@
     "sinon": "^7.5.0"
   },
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint --ignore-pattern node_modules --ignore-pattern generator --ext js lib/http.js \"**/*.js\"",
     "test": "npm run lint && mocha -t 600000 --recursive test",
     "test-jasmine": "jasmine JASMINE_CONFIG_PATH=jasmine.json"
   },

diff --git a/javascript/node/selenium-webdriver/test/elementAccessibleName_test.js b/javascript/node/selenium-webdriver/test/elementAccessibleName_test.js
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Software Freedom Conservancy (SFC) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The SFC licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+'use strict'
+
+const assert = require('assert')
+const test = require('../lib/test')
+const { By } = require('../index')
+
+test.suite(
+  function (env) {
+    let driver
+
+    before(async function () {
+      driver = await env.builder().build()
+    })
+    after(() => driver.quit())
+
+    describe('Testing Aria Label', function () {
+      it('Should return computed label', async function () {
+        await driver.get(`data:text/html,<!DOCTYPE html>
+          <h1>Level 1 Header</h1>`)
+        let header = driver.findElement(By.css('h1'))
+        assert.equal(await header.getAccessibleName(), 'Level 1 Header')
+      })
+
+      it('Should return computed label for img', async function () {
+        await driver.get(`data:text/html,<!DOCTYPE html>
+          <img src="tequila.png" alt="Test Image">`)
+        let imgLabel = driver.findElement(By.css('img'))
+        assert.equal(await imgLabel.getAccessibleName(), 'Test Image')
+      })
+
+      it('Should return computed label for label', async function () {
+        await driver.get(`data:text/html,<!DOCTYPE html>
+          <input type="checkbox" id="label_test">
+            <label for="label_test">Test Label</label>`)
+        let computedLabel = driver.findElement(By.css('input'))
+        assert.equal(await computedLabel.getAccessibleName(), 'Test Label')
+      })
+
+      it('Should return computed label for aria-label', async function () {
+        await driver.get(`data:text/html,<!DOCTYPE html>
+          <button aria-label="Add sample button to cart">Add to cart</button>`)
+        let computedAriaLabel = driver.findElement(By.css('button'))
+        assert.equal(
+          await computedAriaLabel.getAccessibleName(),
+          'Add sample button to cart'
+        )
+      })
+
+      it('Should return computed label for aria-labelby', async function () {
+        await driver.get(`data:text/html,<!DOCTYPE html>
+          <input type="search" aria-labelledby="this">
+            <button id="this">Search</button>`)
+        let computedAriaLabel = driver.findElement(By.css('input'))
+        assert.equal(await computedAriaLabel.getAccessibleName(), 'Search')
+      })
+    })
+  },
+  { browsers: ['chrome'] }
+)