feat(base-driver): deprecate non-standard routes

and add deprecation warnings in the log when these routes are accessed
2026-02-22 11:19:06 -06:00 · 2023-01-10 14:37:42 -08:00
parent bc3f1373fd
commit 7055a0b281
7 changed files with 185 additions and 111 deletions
--- a/packages/appium/test/e2e/driver.e2e.spec.js
+++ b/packages/appium/test/e2e/driver.e2e.spec.js
@@ -3,6 +3,7 @@
 import {BaseDriver} from '@appium/base-driver';
 import {fs, tempDir} from '@appium/support';
 import axios from 'axios';
+import {command} from 'webdriver';
 import B from 'bluebird';
 import _ from 'lodash';
 import {createSandbox} from 'sinon';
@@ -444,6 +445,46 @@ describe('FakeDriver via HTTP', function () {
        await driver.deleteSession();
      }
    });
+
+    it('should log a single deprecation warning if a deprecated method is used and not overridden by a newMethodMap', async function () {
+      let driver = await wdio({...wdOpts, capabilities: caps});
+      try {
+        driver.addCommand(
+          'deprecated',
+          command('POST', '/session/:sessionId/deprecated', {
+            command: 'deprecated',
+            description: 'Call a deprecated command',
+            parameters: [],
+            ref: '',
+          })
+        );
+        driver.addCommand(
+          'doubleClick',
+          command('POST', '/session/:sessionId/doubleclick', {
+            command: 'doubleClick',
+            description: 'Global double click',
+            parameters: [],
+            ref: '',
+          })
+        );
+        await driver
+          .executeScript('fake: getDeprecatedCommandsCalled', [])
+          .should.eventually.eql([]);
+        await driver.deprecated();
+        await driver.deprecated();
+        await driver.shake();
+
+        // this call should not trigger a deprecation even though deprecated by appium because it's
+        // overridden as not deprecated by fake driver
+        await driver.doubleClick();
+
+        await driver
+          .executeScript('fake: getDeprecatedCommandsCalled', [])
+          .should.eventually.eql(['callDeprecatedCommand', 'mobileShake']);
+      } finally {
+        await driver.deleteSession();
+      }
+    });
  });
 });

--- a/packages/base-driver/lib/protocol/protocol.js
+++ b/packages/base-driver/lib/protocol/protocol.js
@@ -18,6 +18,9 @@ const CREATE_SESSION_COMMAND = 'createSession';
 const DELETE_SESSION_COMMAND = 'deleteSession';
 const GET_STATUS_COMMAND = 'getStatus';

+/** type {Set<string>} */
+const deprecatedCommandsLogged = new Set();
+
 function determineProtocol(createSessionArgs) {
  return _.some(createSessionArgs, isW3cCaps) ? PROTOCOLS.W3C : PROTOCOLS.MJSONWP;
 }
@@ -262,6 +265,16 @@ function buildHandler(app, method, path, spec, driver, isSessCmd) {
    let currentProtocol = extractProtocol(driver, req.params.sessionId);

    try {
+      // if the route accessed is deprecated, log a warning
+      if (spec.deprecated && !deprecatedCommandsLogged.has(spec.command)) {
+        deprecatedCommandsLogged.add(spec.command);
+        getLogger(driver, req.params.sessionId).warn(
+          `Command '${spec.command}' has been deprecated and will be removed in a future ` +
+            `version of Appium or your driver/plugin. Please use a different method or contact the ` +
+            `driver/plugin author to add explicit support for the command before it is removed`
+        );
+      }
+
      // if this is a session command but we don't have a session,
      // error out early (especially before proxying)
      if (isSessCmd && !driver.sessionExists(req.params.sessionId)) {
@@ -512,4 +525,5 @@ export {
  CREATE_SESSION_COMMAND,
  DELETE_SESSION_COMMAND,
  GET_STATUS_COMMAND,
+  deprecatedCommandsLogged,
 };
--- a/packages/base-driver/lib/protocol/routes.js
+++ b/packages/base-driver/lib/protocol/routes.js
@@ -68,10 +68,10 @@ const METHOD_MAP = /** @type {const} */ ({
    },
  },
  '/session/:sessionId/timeouts/async_script': {
-    POST: {command: 'asyncScriptTimeout', payloadParams: {required: ['ms']}},
+    POST: {command: 'asyncScriptTimeout', payloadParams: {required: ['ms']}, deprecated: true},
  },
  '/session/:sessionId/timeouts/implicit_wait': {
-    POST: {command: 'implicitWait', payloadParams: {required: ['ms']}},
+    POST: {command: 'implicitWait', payloadParams: {required: ['ms']}, deprecated: true},
  },
  // JSONWP
  '/session/:sessionId/window_handle': {
@@ -117,19 +117,19 @@ const METHOD_MAP = /** @type {const} */ ({
    GET: {command: 'getScreenshot'},
  },
  '/session/:sessionId/ime/available_engines': {
-    GET: {command: 'availableIMEEngines'},
+    GET: {command: 'availableIMEEngines', deprecated: true},
  },
  '/session/:sessionId/ime/active_engine': {
-    GET: {command: 'getActiveIMEEngine'},
+    GET: {command: 'getActiveIMEEngine', deprecated: true},
  },
  '/session/:sessionId/ime/activated': {
-    GET: {command: 'isIMEActivated'},
+    GET: {command: 'isIMEActivated', deprecated: true},
  },
  '/session/:sessionId/ime/deactivate': {
-    POST: {command: 'deactivateIMEEngine'},
+    POST: {command: 'deactivateIMEEngine', deprecated: true},
  },
  '/session/:sessionId/ime/activate': {
-    POST: {command: 'activateIMEEngine', payloadParams: {required: ['engine']}},
+    POST: {command: 'activateIMEEngine', payloadParams: {required: ['engine']}, deprecated: true},
  },
  '/session/:sessionId/frame': {
    POST: {command: 'setFrame', payloadParams: {required: ['id']}},
@@ -162,12 +162,11 @@ const METHOD_MAP = /** @type {const} */ ({
    DELETE: {command: 'closeWindow'},
  },
  '/session/:sessionId/window/:windowhandle/size': {
-    GET: {command: 'getWindowSize'},
-    POST: {},
+    GET: {command: 'getWindowSize', deprecated: true},
  },
  '/session/:sessionId/window/:windowhandle/position': {
-    POST: {},
-    GET: {},
+    POST: {deprecated: true},
+    GET: {deprecated: true},
  },
  '/session/:sessionId/window/:windowhandle/maximize': {
    POST: {command: 'maximizeWindow'},
@@ -222,7 +221,7 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {command: 'click'},
  },
  '/session/:sessionId/element/:elementId/submit': {
-    POST: {command: 'submit'},
+    POST: {command: 'submit', deprecated: true},
  },
  '/session/:sessionId/element/:elementId/text': {
    GET: {command: 'getText'},
@@ -246,7 +245,7 @@ const METHOD_MAP = /** @type {const} */ ({
    },
  },
  '/session/:sessionId/keys': {
-    POST: {command: 'keys', payloadParams: {required: ['value']}},
+    POST: {command: 'keys', payloadParams: {required: ['value']}, deprecated: true},
  },
  '/session/:sessionId/element/:elementId/name': {
    GET: {command: 'getName'},
@@ -264,19 +263,19 @@ const METHOD_MAP = /** @type {const} */ ({
    GET: {command: 'getAttribute'},
  },
  '/session/:sessionId/element/:elementId/equals/:otherId': {
-    GET: {command: 'equalsElement'},
+    GET: {command: 'equalsElement', deprecated: true},
  },
  '/session/:sessionId/element/:elementId/displayed': {
    GET: {command: 'elementDisplayed'},
  },
  '/session/:sessionId/element/:elementId/location': {
-    GET: {command: 'getLocation'},
+    GET: {command: 'getLocation', deprecated: true},
  },
  '/session/:sessionId/element/:elementId/location_in_view': {
-    GET: {command: 'getLocationInView'},
+    GET: {command: 'getLocationInView', deprecated: true},
  },
  '/session/:sessionId/element/:elementId/size': {
-    GET: {command: 'getSize'},
+    GET: {command: 'getSize', deprecated: true},
  },
  '/session/:sessionId/element/:elementId/shadow': {
    GET: {command: 'elementShadowRoot'},
@@ -319,34 +318,35 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {
      command: 'moveTo',
      payloadParams: {optional: ['element', 'xoffset', 'yoffset']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/click': {
-    POST: {command: 'clickCurrent', payloadParams: {optional: ['button']}},
+    POST: {command: 'clickCurrent', payloadParams: {optional: ['button']}, deprecated: true},
  },
  '/session/:sessionId/buttondown': {
-    POST: {command: 'buttonDown', payloadParams: {optional: ['button']}},
+    POST: {command: 'buttonDown', payloadParams: {optional: ['button']}, deprecated: true},
  },
  '/session/:sessionId/buttonup': {
-    POST: {command: 'buttonUp', payloadParams: {optional: ['button']}},
+    POST: {command: 'buttonUp', payloadParams: {optional: ['button']}, deprecated: true},
  },
  '/session/:sessionId/doubleclick': {
-    POST: {command: 'doubleClick'},
+    POST: {command: 'doubleClick', deprecated: true},
  },
  '/session/:sessionId/touch/click': {
-    POST: {command: 'click', payloadParams: {required: ['element']}},
+    POST: {command: 'click', payloadParams: {required: ['element']}, deprecated: true},
  },
  '/session/:sessionId/touch/down': {
-    POST: {command: 'touchDown', payloadParams: {required: ['x', 'y']}},
+    POST: {command: 'touchDown', payloadParams: {required: ['x', 'y']}, deprecated: true},
  },
  '/session/:sessionId/touch/up': {
-    POST: {command: 'touchUp', payloadParams: {required: ['x', 'y']}},
+    POST: {command: 'touchUp', payloadParams: {required: ['x', 'y']}, deprecated: true},
  },
  '/session/:sessionId/touch/move': {
-    POST: {command: 'touchMove', payloadParams: {required: ['x', 'y']}},
+    POST: {command: 'touchMove', payloadParams: {required: ['x', 'y']}, deprecated: true},
  },
  '/session/:sessionId/touch/scroll': {
-    POST: {},
+    POST: {deprecated: true},
  },
  '/session/:sessionId/touch/doubleclick': {
    POST: {},
@@ -356,7 +356,7 @@ const METHOD_MAP = /** @type {const} */ ({
    DELETE: {command: 'releaseActions'},
  },
  '/session/:sessionId/touch/longclick': {
-    POST: {command: 'touchLongClick', payloadParams: {required: ['elements']}},
+    POST: {command: 'touchLongClick', payloadParams: {required: ['elements']}, deprecated: true},
  },
  '/session/:sessionId/touch/flick': {
    POST: {
@@ -364,6 +364,7 @@ const METHOD_MAP = /** @type {const} */ ({
      payloadParams: {
        optional: ['element', 'xspeed', 'yspeed', 'xoffset', 'yoffset', 'speed'],
      },
+      deprecated: true,
    },
  },
  '/session/:sessionId/location': {
@@ -371,28 +372,28 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {command: 'setGeoLocation', payloadParams: {required: ['location']}},
  },
  '/session/:sessionId/local_storage': {
-    GET: {},
-    POST: {},
-    DELETE: {},
+    GET: {deprecated: true},
+    POST: {deprecated: true},
+    DELETE: {deprecated: true},
  },
  '/session/:sessionId/local_storage/key/:key': {
-    GET: {},
-    DELETE: {},
+    GET: {deprecated: true},
+    DELETE: {deprecated: true},
  },
  '/session/:sessionId/local_storage/size': {
-    GET: {},
+    GET: {deprecated: true},
  },
  '/session/:sessionId/session_storage': {
-    GET: {},
-    POST: {},
-    DELETE: {},
+    GET: {deprecated: true},
+    POST: {deprecated: true},
+    DELETE: {deprecated: true},
  },
  '/session/:sessionId/session_storage/key/:key': {
-    GET: {},
-    DELETE: {},
+    GET: {deprecated: true},
+    DELETE: {deprecated: true},
  },
  '/session/:sessionId/session_storage/size': {
-    GET: {},
+    GET: {deprecated: true},
  },
  // Selenium 4 clients
  '/session/:sessionId/se/log': {
@@ -425,7 +426,7 @@ const METHOD_MAP = /** @type {const} */ ({
    GET: {command: 'getContexts'},
  },
  '/session/:sessionId/element/:elementId/pageIndex': {
-    GET: {command: 'getPageIndex'},
+    GET: {command: 'getPageIndex', deprecated: true},
  },
  '/session/:sessionId/network_connection': {
    GET: {command: 'getNetworkConnection'},
@@ -438,12 +439,14 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {
      command: 'performTouch',
      payloadParams: {wrap: 'actions', required: ['actions']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/touch/multi/perform': {
    POST: {
      command: 'performMultiAction',
      payloadParams: {required: ['actions'], optional: ['elementId']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/receive_async_response': {
@@ -453,35 +456,37 @@ const METHOD_MAP = /** @type {const} */ ({
    },
  },
  '/session/:sessionId/appium/device/shake': {
-    POST: {command: 'mobileShake'},
+    POST: {command: 'mobileShake', deprecated: true},
  },
  '/session/:sessionId/appium/device/system_time': {
    GET: {command: 'getDeviceTime', payloadParams: {optional: ['format']}},
    POST: {command: 'getDeviceTime', payloadParams: {optional: ['format']}},
  },
  '/session/:sessionId/appium/device/lock': {
-    POST: {command: 'lock', payloadParams: {optional: ['seconds']}},
+    POST: {command: 'lock', payloadParams: {optional: ['seconds']}, deprecated: true},
  },
  '/session/:sessionId/appium/device/unlock': {
-    POST: {command: 'unlock'},
+    POST: {command: 'unlock', deprecated: true},
  },
  '/session/:sessionId/appium/device/is_locked': {
-    POST: {command: 'isLocked'},
+    POST: {command: 'isLocked', deprecated: true},
  },
  '/session/:sessionId/appium/start_recording_screen': {
    POST: {
      command: 'startRecordingScreen',
      payloadParams: {optional: ['options']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/stop_recording_screen': {
    POST: {
      command: 'stopRecordingScreen',
      payloadParams: {optional: ['options']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/performanceData/types': {
-    POST: {command: 'getPerformanceDataTypes'},
+    POST: {command: 'getPerformanceDataTypes', deprecated: true},
  },
  '/session/:sessionId/appium/getPerformanceData': {
    POST: {
@@ -490,70 +495,68 @@ const METHOD_MAP = /** @type {const} */ ({
        required: ['packageName', 'dataType'],
        optional: ['dataReadTimeout'],
      },
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/press_keycode': {
    POST: {
      command: 'pressKeyCode',
      payloadParams: {required: ['keycode'], optional: ['metastate', 'flags']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/long_press_keycode': {
    POST: {
      command: 'longPressKeyCode',
      payloadParams: {required: ['keycode'], optional: ['metastate', 'flags']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/finger_print': {
    POST: {
      command: 'fingerprint',
      payloadParams: {required: ['fingerprintId']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/send_sms': {
    POST: {
      command: 'sendSMS',
      payloadParams: {required: ['phoneNumber', 'message']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/gsm_call': {
    POST: {
      command: 'gsmCall',
      payloadParams: {required: ['phoneNumber', 'action']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/gsm_signal': {
    POST: {
      command: 'gsmSignal',
-      payloadParams: {
-        validate: (jsonObj) =>
-          !util.hasValue(jsonObj.signalStrength) &&
-          !util.hasValue(jsonObj.signalStrengh) &&
-          'we require one of "signalStrength" or "signalStrengh" params',
-        optional: ['signalStrength', 'signalStrengh'],
-        // backward-compatible. sonObj.signalStrength can be 0
-        makeArgs: (jsonObj) => [
-          util.hasValue(jsonObj.signalStrength) ? jsonObj.signalStrength : jsonObj.signalStrengh,
-        ],
-      },
+      payloadParams: {required: ['signalStrength']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/gsm_voice': {
-    POST: {command: 'gsmVoice', payloadParams: {required: ['state']}},
+    POST: {command: 'gsmVoice', payloadParams: {required: ['state']}, deprecated: true},
  },
  '/session/:sessionId/appium/device/power_capacity': {
-    POST: {command: 'powerCapacity', payloadParams: {required: ['percent']}},
+    POST: {command: 'powerCapacity', payloadParams: {required: ['percent']}, deprecated: true},
  },
  '/session/:sessionId/appium/device/power_ac': {
-    POST: {command: 'powerAC', payloadParams: {required: ['state']}},
+    POST: {command: 'powerAC', payloadParams: {required: ['state']}, deprecated: true},
  },
  '/session/:sessionId/appium/device/network_speed': {
-    POST: {command: 'networkSpeed', payloadParams: {required: ['netspeed']}},
+    POST: {command: 'networkSpeed', payloadParams: {required: ['netspeed']}, deprecated: true},
  },
  '/session/:sessionId/appium/device/keyevent': {
    POST: {
      command: 'keyevent',
      payloadParams: {required: ['keycode'], optional: ['metastate']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/rotate': {
@@ -563,13 +566,14 @@ const METHOD_MAP = /** @type {const} */ ({
        required: ['x', 'y', 'radius', 'rotation', 'touchCount', 'duration'],
        optional: ['element'],
      },
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/current_activity': {
-    GET: {command: 'getCurrentActivity'},
+    GET: {command: 'getCurrentActivity', deprecated: true},
  },
  '/session/:sessionId/appium/device/current_package': {
-    GET: {command: 'getCurrentPackage'},
+    GET: {command: 'getCurrentPackage', deprecated: true},
  },
  //region Applications Management
  '/session/:sessionId/appium/device/install_app': {
@@ -628,6 +632,7 @@ const METHOD_MAP = /** @type {const} */ ({
      payloadParams: {
        required: [['appId'], ['bundleId']],
      },
+      deprecated: true,
    },
  },
  //endregion
@@ -650,19 +655,19 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {command: 'pullFolder', payloadParams: {required: ['path']}},
  },
  '/session/:sessionId/appium/device/toggle_airplane_mode': {
-    POST: {command: 'toggleFlightMode'},
+    POST: {command: 'toggleFlightMode', deprecated: true},
  },
  '/session/:sessionId/appium/device/toggle_data': {
-    POST: {command: 'toggleData'},
+    POST: {command: 'toggleData', deprecated: true},
  },
  '/session/:sessionId/appium/device/toggle_wifi': {
-    POST: {command: 'toggleWiFi'},
+    POST: {command: 'toggleWiFi', deprecated: true},
  },
  '/session/:sessionId/appium/device/toggle_location_services': {
-    POST: {command: 'toggleLocationServices'},
+    POST: {command: 'toggleLocationServices', deprecated: true},
  },
  '/session/:sessionId/appium/device/open_notifications': {
-    POST: {command: 'openNotifications'},
+    POST: {command: 'openNotifications', deprecated: true},
  },
  '/session/:sessionId/appium/device/start_activity': {
    POST: {
@@ -679,77 +684,63 @@ const METHOD_MAP = /** @type {const} */ ({
          'dontStopAppOnReset',
        ],
      },
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/device/system_bars': {
-    GET: {command: 'getSystemBars'},
+    GET: {command: 'getSystemBars', deprecated: true},
  },
  '/session/:sessionId/appium/device/display_density': {
-    GET: {command: 'getDisplayDensity'},
+    GET: {command: 'getDisplayDensity', deprecated: true},
  },
  '/session/:sessionId/appium/simulator/touch_id': {
-    POST: {command: 'touchId', payloadParams: {required: ['match']}},
+    POST: {command: 'touchId', payloadParams: {required: ['match']}, deprecated: true},
  },
  '/session/:sessionId/appium/simulator/toggle_touch_id_enrollment': {
    POST: {
      command: 'toggleEnrollTouchId',
      payloadParams: {optional: ['enabled']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/app/launch': {
-    POST: {command: 'launchApp'},
+    POST: {command: 'launchApp', deprecated: true},
  },
  '/session/:sessionId/appium/app/close': {
-    POST: {command: 'closeApp'},
+    POST: {command: 'closeApp', deprecated: true},
  },
  '/session/:sessionId/appium/app/reset': {
-    POST: {command: 'reset'},
+    POST: {command: 'reset', deprecated: true},
  },
  '/session/:sessionId/appium/app/background': {
-    POST: {command: 'background', payloadParams: {required: ['seconds']}},
+    POST: {command: 'background', payloadParams: {required: ['seconds']}, deprecated: true},
  },
  '/session/:sessionId/appium/app/end_test_coverage': {
    POST: {
      command: 'endCoverage',
      payloadParams: {required: ['intent', 'path']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/app/strings': {
    POST: {
      command: 'getStrings',
      payloadParams: {optional: ['language', 'stringFile']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/element/:elementId/value': {
    POST: {
      command: 'setValueImmediate',
-      payloadParams: {
-        validate: (jsonObj) =>
-          !util.hasValue(jsonObj.value) &&
-          !util.hasValue(jsonObj.text) &&
-          'we require one of "text" or "value" params',
-        optional: ['value', 'text'],
-        // We want to either a value (old JSONWP) or a text (new W3C) parameter,
-        // but only send one of them to the command (not both).
-        // Prefer 'value' since it's more backward-compatible.
-        makeArgs: (jsonObj) => [jsonObj.value || jsonObj.text],
-      },
+      payloadParams: {required: ['text']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/element/:elementId/replace_value': {
    POST: {
      command: 'replaceValue',
-      payloadParams: {
-        validate: (jsonObj) =>
-          !util.hasValue(jsonObj.value) &&
-          !util.hasValue(jsonObj.text) &&
-          'we require one of "text" or "value" params',
-        optional: ['value', 'text'],
-        // We want to either a value (old JSONWP) or a text (new W3C) parameter,
-        // but only send one of them to the command (not both).
-        // Prefer 'value' since it's more backward-compatible.
-        makeArgs: (jsonObj) => [jsonObj.value ?? jsonObj.text ?? ''],
-      },
+      payloadParams: {required: ['text']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/settings': {
@@ -760,6 +751,7 @@ const METHOD_MAP = /** @type {const} */ ({
    POST: {
      command: 'receiveAsyncResponse',
      payloadParams: {required: ['response']},
+      deprecated: true,
    },
  },
  '/session/:sessionId/appium/events': {
@@ -856,6 +848,7 @@ const METHOD_MAP = /** @type {const} */ ({
      payloadParams: {
        required: ['content'],
        optional: ['contentType', 'label'],
+        deprecated: true,
      },
    },
  },
@@ -865,6 +858,7 @@ const METHOD_MAP = /** @type {const} */ ({
      payloadParams: {
        optional: ['contentType'],
      },
+      deprecated: true,
    },
  },

--- a/packages/base-driver/test/unit/protocol/routes.spec.js
+++ b/packages/base-driver/test/unit/protocol/routes.spec.js
@@ -35,7 +35,7 @@ describe('Protocol', function () {
      }
      let hash = shasum.digest('hex').substring(0, 8);
      // Modify the hash whenever the protocol has intentionally been modified.
-      hash.should.equal('b1985791');
+      hash.should.equal('484810b0');
    });
  });

--- a/packages/fake-driver/lib/commands/general.js
+++ b/packages/fake-driver/lib/commands/general.js
@@ -79,6 +79,12 @@ export function GeneralMixin(Base) {
      }
    }

+    async mobileShake() {
+      this.shook = true;
+    }
+
+    async doubleClick() {}
+
    async execute(script, args) {
      return await this.executeMethod(script, args);
    }
--- a/packages/fake-driver/lib/driver.js
+++ b/packages/fake-driver/lib/driver.js
@@ -1,5 +1,6 @@
 import B from 'bluebird';
 import {BaseDriver, errors} from 'appium/driver';
+import {deprecatedCommandsLogged} from '@appium/base-driver/build/lib/protocol/protocol';
 import {FakeApp} from './fake-app';
 import {FakeDriverMixin} from './commands';

@@ -37,6 +38,7 @@ export class FakeDriverCore extends BaseDriver {
    this.maxElId = 0;
    this.fakeThing = null;
    this._proxyActive = false;
+    this.shook = false;
  }

  proxyActive() {
@@ -73,12 +75,7 @@ export class FakeDriverCore extends BaseDriver {
   * @override
   * @returns {Promise<[string,FakeDriverCaps]>} Session ID and normalized capabilities
   */
-  async createSession(
-    w3cCapabilities1,
-    w3cCapabilities2,
-    w3cCapabilities3,
-    driverData = []
-  ) {
+  async createSession(w3cCapabilities1, w3cCapabilities2, w3cCapabilities3, driverData = []) {
    // TODO add validation on caps.app that we will get for free from
    // BaseDriver

@@ -94,12 +91,7 @@ export class FakeDriverCore extends BaseDriver {
    }

    let [sessionId, caps] = /** @type {[string, FakeDriverCaps]} */ (
-      await super.createSession(
-        w3cCapabilities1,
-        w3cCapabilities2,
-        w3cCapabilities3,
-        driverData
-      )
+      await super.createSession(w3cCapabilities1, w3cCapabilities2, w3cCapabilities3, driverData)
    );
    this.caps = caps;
    await this.appModel.loadApp(caps.app);
@@ -139,6 +131,25 @@ export class FakeDriverCore extends BaseDriver {
    return this.cliArgs;
  }

+  /**
+   * This is a command that will return a list of deprecated command names called
+   *
+   * @returns {Promise<string[]>}
+   */
+  async getDeprecatedCommandsCalled() {
+    await B.delay(1);
+    return Array.from(deprecatedCommandsLogged);
+  }
+
+  /**
+   * This is a command that exists just to be an example of a deprecated command
+   *
+   * @returns {Promise<void>}
+   */
+  async callDeprecatedCommand() {
+    await B.delay(1);
+  }
+
  static newMethodMap = /** @type {const} */ ({
    '/session/:sessionId/fakedriver': {
      GET: {command: 'getFakeThing'},
@@ -150,6 +161,13 @@ export class FakeDriverCore extends BaseDriver {
    '/session/:sessionId/fakedriverargs': {
      GET: {command: 'getFakeDriverArgs'},
    },
+    '/session/:sessionId/deprecated': {
+      POST: {command: 'callDeprecatedCommand', deprecated: true},
+    },
+    // this next one exists to override a deprecated method
+    '/session/:sessionId/doubleclick': {
+      POST: {command: 'doubleClick'},
+    },
  });

  static executeMethodMap = /** @type {const} */ ({
@@ -167,6 +185,9 @@ export class FakeDriverCore extends BaseDriver {
      command: 'setFakeThing',
      params: {required: ['thing']},
    },
+    'fake: getDeprecatedCommandsCalled': {
+      command: 'getDeprecatedCommandsCalled',
+    },
  });

  /**
--- a/packages/types/lib/driver.ts
+++ b/packages/types/lib/driver.ts
@@ -1484,8 +1484,6 @@ export interface ExternalDriver<C extends Constraints = BaseDriverCapConstraints
   * @param key - the text of a key to use to hide the keyboard
   * @param keyCode - a key code to trigger to hide the keyboard
   * @param keyName - the name of a key to use to hide the keyboard
-   *
-   * @deprecated
   */
  hideKeyboard?(strategy?: string, key?: string, keyCode?: string, keyName?: string): Promise<void>;