Add rect() as alias for getRect() command. (#4128)

Author: dikwickley

lib/api/web-element/commands/getRect.js

@@ -29,6 +29,8 @@
  * @syntax browser.element(selector).getRect()
  * @see https://www.w3.org/TR/webdriver#dfn-get-element-rect
  * @returns {ScopedValue<{ width: number, height: number }>}
+ * @alias getSize
+ * @alias getLocation
  */
 module.exports.command = function() {
   return this.runQueuedCommandScoped('getElementRect');

lib/api/web-element/scoped-element.js

@@ -22,7 +22,7 @@ class ScopedWebElement {
       'findAllByRole': ['getAllByRole'],
       'findAllByPlaceholderText': ['getAllByPlaceholderText'],
       'findAllByAltText': ['getAllByAltText'],
-      'getRect': ['getSize', 'getLocation'],
+      'getRect': ['getSize', 'getLocation', 'rect'],
       'getProperty': ['property'],
       'getCssProperty': ['css'],
       'isVisible': ['isDisplayed']

test/src/api/commands/web-element/testGetRect.js

@@ -38,6 +38,30 @@ describe('element().getRect() command', function () {
     assert.deepStrictEqual(resultValue, {height: 34, width: 443, x: 356, y: 381.5});
   });
 
+  it('test .element().rect()', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/element/0/rect',
+      method: 'GET',
+      response: JSON.stringify({
+        value: {height: 34, width: 443, x: 356, y: 381.5}
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').rect();
+    assert.strictEqual(resultPromise instanceof Element, false);
+    assert.strictEqual(typeof resultPromise.find, 'undefined');
+
+    assert.strictEqual(resultPromise instanceof Promise, false);
+    assert.strictEqual(typeof resultPromise.then, 'function');
+
+    const result = await resultPromise;
+    assert.strictEqual(result instanceof WebElement, false);
+    assert.deepStrictEqual(result, {height: 34, width: 443, x: 356, y: 381.5});
+
+    const resultValue = await resultPromise.value;
+    assert.deepStrictEqual(resultValue, {height: 34, width: 443, x: 356, y: 381.5});
+  });
+
   it('test .element().getSize()', async function() {
     MockServer.addMock({
       url: '/session/13521-10219-202/element/0/rect',
@@ -133,4 +157,5 @@ describe('element().getRect() command', function () {
     const resultValue = await resultPromise.value;
     assert.deepStrictEqual(resultValue, {height: 34, width: 443, x: 356, y: 381.5});
   });
+
 });

types/tests/webElement.test-d.ts

@@ -145,7 +145,9 @@ describe('new element() api', function () {
     expectType<ElementValue<boolean>>(elem.isDisplayed());
 
     expectType<ElementValue<ScopedElementRect>>(elem.getRect());
+    expectType<ElementValue<ScopedElementRect>>(elem.rect());
     expectType<ElementValue<ScopedElementRect>>(elem.getSize());
+    expectType<ElementValue<ScopedElementRect>>(elem.getLocation());
 
     expectType<ElementValue<string>>(elem.getAccessibleName());
     expectType<ElementValue<string>>(elem.getAriaRole());

types/web-element.d.ts

@@ -139,6 +139,12 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
 
   getRect(): ElementValue<ScopedElementRect>;
 
+  rect(): ElementValue<ScopedElementRect>;
+
+  getSize(): ElementValue<ScopedElementRect>;
+
+  getLocation(): ElementValue<ScopedElementRect>;
+
   getTagName(): ElementValue<string>;
 
   getText(): ElementValue<string>;
@@ -175,8 +181,6 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
 
   getCssProperty(name: string): ElementValue<string>;
 
-  getSize(): ElementValue<ScopedElementRect>;
-
   getValue(): ElementValue<string | null>;
 
   setValue<E extends readonly unknown[]>(...keys: E): Promise<WebElement>;