use isFeatureEnabled for security features check (appium#989)

README.md

@@ -179,6 +179,14 @@ Differences are noted here:
 |`skipLogCapture`|Skips to start capturing logs such as crash, system, safari console and safari network. It might improve performance such as network. Log related commands will not work. Defaults to `false`. |`true` or `false`|
 |`safariGarbageCollect`|Turns on/off Web Inspector garbage collection when executing scripts on Safari. Turning on may improve performance. Defaults to `false`.|`true` or `false`|
 
+## Opt-in Features (With Security Risk)
+
+These can be enabled when running this driver through Appium, via the `--allow-insecure` or `--relaxed-security` flags.
+
+|Feature Name|Description|
+|------------|-----------|
+|shutdown_other_sims|Allow any session to use a capability to shutdown any running simulators on the host|
+|perf_record|Allow recording the system performance and other metrics of the simulator|
 
 ## Development<a id="development"></a>
 

lib/commands/performance.js

@@ -9,6 +9,7 @@ import { waitForCondition } from 'asyncbox';
 
 let commands = {};
 
+const PERF_RECORD_FEAT_NAME = 'perf_record';
 const RECORDERS_CACHE = {};
 const DEFAULT_TIMEOUT_MS = 5 * 60 * 1000;
 const STOP_TIMEOUT_MS = 3 * 60 * 1000;
@@ -62,9 +63,9 @@ async function uploadTrace (localFile, remotePath = null, uploadOptions = {}) {
  * @param {?StartPerfRecordOptions} opts - The set of possible start record options
  */
 commands.mobileStartPerfRecord = async function mobileStartPerfRecord (opts = {}) {
-  if (!this.relaxedSecurityEnabled && !this.isRealDevice()) {
-    log.errorAndThrow(`Appium server must have relaxed security flag set in order ` +
-                      `for Simulator performance measurement to work`);
+  this.ensureFeatureEnabled(PERF_RECORD_FEAT_NAME);
+  if (!this.isRealDevice()) {
+    log.errorAndThrow('Performance measurement is for simulators only');
   }
 
   const {
@@ -170,9 +171,9 @@ commands.mobileStartPerfRecord = async function mobileStartPerfRecord (opts = {}
  * has been started before or the resulting .trace file has not been generated properly.
  */
 commands.mobileStopPerfRecord = async function mobileStopPerfRecord (opts = {}) {
-  if (!this.relaxedSecurityEnabled && !this.isRealDevice()) {
-    log.errorAndThrow(`Appium server must have relaxed security flag set in order ` +
-                      `for Simulator performance measurement to work`);
+  this.ensureFeatureEnabled(PERF_RECORD_FEAT_NAME);
+  if (!this.isRealDevice()) {
+    log.errorAndThrow('Performance measurement is for simulators only');
   }
 
   const {

lib/driver.js

@@ -29,6 +29,7 @@ import path from 'path';
 import IDB from 'appium-idb';
 
 
+const SHUTDOWN_OTHER_FEAT_NAME = 'shutdown_other_sims';
 const SAFARI_BUNDLE_ID = 'com.apple.mobilesafari';
 const WDA_SIM_STARTUP_RETRIES = 2;
 const WDA_REAL_DEV_STARTUP_RETRIES = 1;
@@ -354,10 +355,7 @@ class XCUITestDriver extends BaseDriver {
 
     if (this.isSimulator()) {
       if (this.opts.shutdownOtherSimulators) {
-        if (!this.relaxedSecurityEnabled) {
-          log.errorAndThrow(`Appium server must have relaxed security flag set in order ` +
-                            `for 'shutdownOtherSimulators' capability to work`);
-        }
+        this.ensureFeatureEnabled(SHUTDOWN_OTHER_FEAT_NAME);
         await shutdownOtherSimulators(this.opts.device);
       }
 

package.json

@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "appium-base-driver": "^3.0.0",
+    "appium-base-driver": "^3.17.0",
     "appium-idb": "^0.1.0",
     "appium-ios-device": "^0.2.1",
     "appium-ios-driver": "^4.0.0",