chore: Ditch unused cookie-related functions (#2647)

Author: mykola-mokhnach

lib/commands/web.js

@@ -3,7 +3,6 @@ import {timing, util} from 'appium/support';
 import {retryInterval} from 'asyncbox';
 import B, {TimeoutError, AggregateError} from 'bluebird';
 import _ from 'lodash';
-import * as cookieUtils from '../cookies';
 
 const IPHONE_TOP_BAR_HEIGHT = 71;
 const IPHONE_SCROLLED_TOP_BAR_HEIGHT = 41;
@@ -88,6 +87,9 @@ export async function setFrame(frame) {
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @param {string} propertyName
+ * @param {Element | string} el
+ * @returns {Promise<string>}
  */
 export async function getCssProperty(propertyName, el) {
   if (!this.isWebContext()) {
@@ -129,6 +131,7 @@ export async function refresh() {
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @returns {Promise<string>}
  */
 export async function getUrl() {
   if (!this.isWebContext()) {
@@ -141,6 +144,7 @@ export async function getUrl() {
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @returns {Promise<string>}
  */
 export async function title() {
   if (!this.isWebContext()) {
@@ -153,6 +157,7 @@ export async function title() {
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @returns {Promise<import('@appium/types').Cookie[]>}
  */
 export async function getCookies() {
   if (!this.isWebContext()) {
@@ -182,34 +187,36 @@ export async function getCookies() {
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @param {import('@appium/types').Cookie} cookie
+ * @returns {Promise<void>}
  */
 export async function setCookie(cookie) {
   if (!this.isWebContext()) {
     throw new errors.NotImplementedError();
   }
 
-  cookie = _.clone(cookie);
-
+  const clonedCookie = _.clone(cookie);
   // if `path` field is not specified, Safari will not update cookies as expected; eg issue #1708
-  if (!cookie.path) {
-    cookie.path = '/';
+  if (!clonedCookie.path) {
+    clonedCookie.path = '/';
   }
-
-  const jsCookie = cookieUtils.createJSCookie(cookie.name, cookie.value, {
-    expires: _.isNumber(cookie.expiry)
-      ? new Date(cookie.expiry * 1000).toUTCString()
-      : cookie.expiry,
-    path: cookie.path,
-    domain: cookie.domain,
-    httpOnly: cookie.httpOnly,
-    secure: cookie.secure,
+  const jsCookie = createJSCookie(clonedCookie.name, clonedCookie.value, {
+    expires: _.isNumber(clonedCookie.expiry)
+      ? new Date(clonedCookie.expiry * 1000).toUTCString()
+      : clonedCookie.expiry,
+    path: clonedCookie.path,
+    domain: clonedCookie.domain,
+    httpOnly: clonedCookie.httpOnly,
+    secure: clonedCookie.secure,
   });
-  let script = `document.cookie = ${JSON.stringify(jsCookie)}`;
+  const script = `document.cookie = ${JSON.stringify(jsCookie)}`;
   await this.executeAtom('execute_script', [script, []]);
 }
 
 /**
  * @this {XCUITestDriver}
+ * @param {string} cookieName
+ * @returns {Promise<void>}
  * @group Mobile Web Only
  */
 export async function deleteCookie(cookieName) {
@@ -224,32 +231,27 @@ export async function deleteCookie(cookieName) {
     return;
   }
 
-  await this._deleteCookie(cookie);
+  await _deleteCookie.bind(this)(cookie);
 }
 
 /**
  * @this {XCUITestDriver}
  * @group Mobile Web Only
+ * @returns {Promise<void>}
  */
 export async function deleteCookies() {
   if (!this.isWebContext()) {
     throw new errors.NotImplementedError();
   }
 
   const cookies = await this.getCookies();
-  await B.all(cookies.map((cookie) => this._deleteCookie(cookie)));
-}
-
-/**
- * @this {XCUITestDriver}
- */
-export async function _deleteCookie(cookie) {
-  const url = `http${cookie.secure ? 's' : ''}://${cookie.domain}${cookie.path}`;
-  return await (/** @type {RemoteDebugger} */ (this.remote)).deleteCookie(cookie.name, url);
+  await B.all(cookies.map((cookie) => _deleteCookie.bind(this)(cookie)));
 }
 
 /**
  * @this {XCUITestDriver}
+ * @param {Element | string} el
+ * @returns {Element | string}
  */
 export function cacheWebElement(el) {
   if (!_.isPlainObject(el)) {
@@ -268,14 +270,16 @@ export function cacheWebElement(el) {
 
 /**
  * @this {XCUITestDriver}
+ * @param {any} response
+ * @returns {any}
  */
 export function cacheWebElements(response) {
-  const toCached = (v) => (_.isArray(v) || _.isPlainObject(v) ? this.cacheWebElements(v) : v);
+  const toCached = (/** @type {any} */ v) => (_.isArray(v) || _.isPlainObject(v)) ? this.cacheWebElements(v) : v;
 
   if (_.isArray(response)) {
     return response.map(toCached);
   } else if (_.isPlainObject(response)) {
-    const result = {...response, ...this.cacheWebElement(response)};
+    const result = {...response, ...(/** @type {Element} */ (this.cacheWebElement(response)))};
     return _.toPairs(result).reduce((acc, [key, value]) => {
       acc[key] = toCached(value);
       return acc;
@@ -345,8 +349,13 @@ export function convertElementsForAtoms(args = []) {
   });
 }
 
+/**
+ *
+ * @param {any} element
+ * @returns {string | undefined}
+ */
 export function getElementId(element) {
-  return element.ELEMENT || element[W3C_WEB_ELEMENT_IDENTIFIER];
+  return element?.ELEMENT || element?.[W3C_WEB_ELEMENT_IDENTIFIER];
 }
 
 /**
@@ -362,12 +371,17 @@ export function hasElementId(element) {
 
 /**
  * @this {XCUITestDriver}
+ * @param {string} strategy
+ * @param {string} selector
+ * @param {boolean} [many]
+ * @param {Element | string | null} [ctx]
+ * @returns {Promise<Element | Element[]>}
  */
 export async function findWebElementOrElements(strategy, selector, many, ctx) {
   const contextElement = _.isNil(ctx) ? null : this.getAtomsElement(ctx);
   const atomName = many ? 'find_elements' : 'find_element_fragment';
   let element;
-  let doFind = async () => {
+  const doFind = async () => {
     element = await this.executeAtom(atomName, [strategy, selector, contextElement]);
     return !_.isNull(element);
   };
@@ -1045,6 +1059,45 @@ function isValidElementIdentifier(id) {
   return true;
 }
 
+/**
+ * Creates a JavaScript Cookie
+ *
+ * @param {string} key
+ * @param {string} value
+ * @param {CookieOptions} [options={}]
+ * @returns {string}
+ */
+function createJSCookie(key, value, options = {}) {
+  return [
+    encodeURIComponent(key),
+    '=',
+    value,
+    options.expires ? `; expires=${options.expires}` : '',
+    options.path ? `; path=${options.path}` : '',
+    options.domain ? `; domain=${options.domain}` : '',
+    options.secure ? '; secure' : '',
+  ].join('');
+}
+
+/**
+ * @this {XCUITestDriver}
+ * @param {import('@appium/types').Cookie} cookie
+ * @returns {Promise<any>}
+ */
+async function _deleteCookie(cookie) {
+  const url = `http${cookie.secure ? 's' : ''}://${cookie.domain}${cookie.path}`;
+  return await (/** @type {RemoteDebugger} */ (this.remote)).deleteCookie(cookie.name, url);
+}
+
+/**
+ * @typedef {Object} CookieOptions
+ * @property {string} [expires]
+ * @property {string} [path]
+ * @property {string} [domain]
+ * @property {boolean} [secure]
+ * @property {boolean} [httpOnly]
+ */
+
 /**
  * @typedef {import('../driver').XCUITestDriver} XCUITestDriver
  * @typedef {import('@appium/types').Rect} Rect

lib/cookies.js

@@ -2240,7 +2240,6 @@ export class XCUITestDriver extends BaseDriver {
   setCookie = webCommands.setCookie;
   deleteCookie = webCommands.deleteCookie;
   deleteCookies = webCommands.deleteCookies;
-  _deleteCookie = webCommands._deleteCookie;
   cacheWebElement = webCommands.cacheWebElement;
   cacheWebElements = webCommands.cacheWebElements;
   executeAtom = webCommands.executeAtom;