address comments

- In lieu of Promise.resolve(...) for async await, just return the item
- Clean up JSDocs for q.promise

Author: cnishina

lib/browser.ts

@@ -198,7 +198,7 @@ export class ProtractorBrowser extends AbstractExtendedWebDriver {
    */
   async angularAppRoot(valuePromise: string|wdpromise.Promise<string> = null): Promise<string> {
     if (valuePromise != null) {
-      const value = await Promise.resolve(valuePromise);
+      const value = await valuePromise;
       this.internalRootEl = value;
       if (this.bpClient) {
         await this.bpClient.setWaitParams(value);
@@ -414,7 +414,7 @@ export class ProtractorBrowser extends AbstractExtendedWebDriver {
   async waitForAngularEnabled(enabledPromise: boolean|wdpromise.Promise<boolean> = null):
       Promise<boolean> {
     if (enabledPromise != null) {
-      const enabled = await Promise.resolve(enabledPromise);
+      const enabled = await enabledPromise;
       if (this.bpClient) {
         logger.debug('Setting waitForAngular' + !enabled);
         await this.bpClient.setWaitEnabled(enabled);
@@ -615,99 +615,88 @@ export class ProtractorBrowser extends AbstractExtendedWebDriver {
   async waitForAngular(opt_description?: string): Promise<any> {
     let description = opt_description ? ' - ' + opt_description : '';
     if (this.ignoreSynchronization) {
-      return Promise.resolve(true);
+      return true;
     }
 
     let runWaitForAngularScript = async(): Promise<any> => {
       if (this.plugins_.skipAngularStability() || this.bpClient) {
-        return Promise.resolve(null);
+        return null;
       } else {
-        // Need to wrap this so that we read rootEl in the control flow, not synchronously.
         let rootEl = await this.angularAppRoot();
         return this.executeAsyncScript_(
-            clientSideScripts.waitForAngular, 'Protractor.waitForAngular()' + description, rootEl);
+            clientSideScripts.waitForAngular, `Protractor.waitForAngular() ${description}`, rootEl);
       }
     };
 
-    return runWaitForAngularScript()
-        .then((browserErr: Function) => {
-          if (browserErr) {
-            throw new Error(
-                'Error while waiting for Protractor to ' +
-                'sync with the page: ' + JSON.stringify(browserErr));
+    let browserErr = await runWaitForAngularScript();
+    if (browserErr) {
+      throw new Error(
+          'Error while waiting for Protractor to ' +
+          'sync with the page: ' + JSON.stringify(browserErr));
+    }
+    await this.plugins_.waitForPromise(this);
+    try {
+      await this.driver.wait(async () => {
+        let results = await this.plugins_.waitForCondition(this);
+        return results.reduce((x, y) => x && y, true);
+      }, this.allScriptsTimeout, 'Plugins.waitForCondition()');
+    } catch (err) {
+      let timeout: RegExpExecArray;
+      if (/asynchronous script timeout/.test(err.message)) {
+        // Timeout on Chrome
+        timeout = /-?[\d\.]*\ seconds/.exec(err.message);
+      } else if (/Timed out waiting for async script/.test(err.message)) {
+        // Timeout on Firefox
+        timeout = /-?[\d\.]*ms/.exec(err.message);
+      } else if (/Timed out waiting for an asynchronous script/.test(err.message)) {
+        // Timeout on Safari
+        timeout = /-?[\d\.]*\ ms/.exec(err.message);
+      }
+      if (timeout) {
+        let errMsg = `Timed out waiting for asynchronous Angular tasks to finish after ` +
+            `${timeout}. This may be because the current page is not an Angular ` +
+            `application. Please see the FAQ for more details: ` +
+            `https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular`;
+        if (description.indexOf(' - Locator: ') == 0) {
+          errMsg += '\nWhile waiting for element with locator' + description;
+        }
+        let pendingTimeoutsPromise: wdpromise.Promise<any>;
+        if (this.trackOutstandingTimeouts_) {
+          pendingTimeoutsPromise = this.executeScriptWithDescription(
+              'return window.NG_PENDING_TIMEOUTS',
+              'Protractor.waitForAngular() - getting pending timeouts' + description);
+        } else {
+          pendingTimeoutsPromise = wdpromise.when({});
+        }
+        let pendingHttpsPromise = this.executeScriptWithDescription(
+            clientSideScripts.getPendingHttpRequests,
+            'Protractor.waitForAngular() - getting pending https' + description,
+            this.internalRootEl);
+
+        let arr = await Promise.all([pendingTimeoutsPromise, pendingHttpsPromise]);
+
+        let pendingTimeouts = arr[0] || [];
+        let pendingHttps = arr[1] || [];
+
+        let key: string, pendingTasks: string[] = [];
+        for (key in pendingTimeouts) {
+          if (pendingTimeouts.hasOwnProperty(key)) {
+            pendingTasks.push(' - $timeout: ' + pendingTimeouts[key]);
           }
-        })
-        .then(
-            async () => {
-              await this.plugins_.waitForPromise(this);
-              return this.driver.wait(async () => {
-                let results = await this.plugins_.waitForCondition(this);
-                return results.reduce((x, y) => x && y, true);
-              }, this.allScriptsTimeout, 'Plugins.waitForCondition()');
-            },
-            (err: Error) => {
-              let timeout: RegExpExecArray;
-              if (/asynchronous script timeout/.test(err.message)) {
-                // Timeout on Chrome
-                timeout = /-?[\d\.]*\ seconds/.exec(err.message);
-              } else if (/Timed out waiting for async script/.test(err.message)) {
-                // Timeout on Firefox
-                timeout = /-?[\d\.]*ms/.exec(err.message);
-              } else if (/Timed out waiting for an asynchronous script/.test(err.message)) {
-                // Timeout on Safari
-                timeout = /-?[\d\.]*\ ms/.exec(err.message);
-              }
-              if (timeout) {
-                let errMsg = `Timed out waiting for asynchronous Angular tasks to finish after ` +
-                    `${timeout}. This may be because the current page is not an Angular ` +
-                    `application. Please see the FAQ for more details: ` +
-                    `https://github.com/angular/protractor/blob/master/docs/timeouts.md#waiting-for-angular`;
-                if (description.indexOf(' - Locator: ') == 0) {
-                  errMsg += '\nWhile waiting for element with locator' + description;
-                }
-                let pendingTimeoutsPromise: wdpromise.Promise<any>;
-                if (this.trackOutstandingTimeouts_) {
-                  pendingTimeoutsPromise = this.executeScriptWithDescription(
-                      'return window.NG_PENDING_TIMEOUTS',
-                      'Protractor.waitForAngular() - getting pending timeouts' + description);
-                } else {
-                  pendingTimeoutsPromise = wdpromise.when({});
-                }
-                let pendingHttpsPromise = this.executeScriptWithDescription(
-                    clientSideScripts.getPendingHttpRequests,
-                    'Protractor.waitForAngular() - getting pending https' + description,
-                    this.internalRootEl);
-
-                return wdpromise.all([pendingTimeoutsPromise, pendingHttpsPromise])
-                    .then(
-                        (arr: any[]) => {
-                          let pendingTimeouts = arr[0] || [];
-                          let pendingHttps = arr[1] || [];
-
-                          let key: string, pendingTasks: string[] = [];
-                          for (key in pendingTimeouts) {
-                            if (pendingTimeouts.hasOwnProperty(key)) {
-                              pendingTasks.push(' - $timeout: ' + pendingTimeouts[key]);
-                            }
-                          }
-                          for (key in pendingHttps) {
-                            pendingTasks.push(' - $http: ' + pendingHttps[key].url);
-                          }
-                          if (pendingTasks.length) {
-                            errMsg += '. \nThe following tasks were pending:\n';
-                            errMsg += pendingTasks.join('\n');
-                          }
-                          err.message = errMsg;
-                          throw err;
-                        },
-                        () => {
-                          err.message = errMsg;
-                          throw err;
-                        });
-              } else {
-                throw err;
-              }
-            });
+        }
+        for (key in pendingHttps) {
+          pendingTasks.push(' - $http: ' + pendingHttps[key].url);
+        }
+        if (pendingTasks.length) {
+          errMsg += '. \nThe following tasks were pending:\n';
+          errMsg += pendingTasks.join('\n');
+        }
+        err.message = errMsg;
+        throw err;
+      } else {
+        throw err;
+      }
+    }
   }
 
   /**

lib/driverProviders/attachSession.ts

@@ -21,13 +21,12 @@ export class AttachSession extends DriverProvider {
 
   /**
    * Configure and launch (if applicable) the object's environment.
-   * @return {q.promise} A promise which will resolve when the environment is
+   * @return {Promise} A promise which will resolve when the environment is
    *     ready to test.
    */
   protected async setupDriverEnv(): Promise<any> {
     logger.info('Using the selenium server at ' + this.config_.seleniumAddress);
     logger.info('Using session id - ' + this.config_.seleniumSessionId);
-    return Promise.resolve();
   }
 
   /**
@@ -49,7 +48,5 @@ export class AttachSession extends DriverProvider {
    *
    * @public
    */
-  quitDriver(): Promise<void> {
-    return Promise.resolve();
-  }
+  async quitDriver(): Promise<void> {}
 }

lib/driverProviders/browserStack.ts

@@ -93,6 +93,5 @@ export class BrowserStack extends DriverProvider {
     }
 
     logger.info(`Using BrowserStack selenium server at ${this.config_.seleniumAddress}`);
-    return Promise.resolve();
   }
 }

lib/driverProviders/direct.ts

@@ -25,7 +25,7 @@ export class Direct extends DriverProvider {
 
   /**
    * Configure and launch (if applicable) the object's environment.
-   * @return {q.promise} A promise which will resolve when the environment is
+   * @return {Promise} A promise which will resolve when the environment is
    *     ready to test.
    */
   protected async setupDriverEnv(): Promise<any> {
@@ -42,7 +42,6 @@ export class Direct extends DriverProvider {
             'browserName ' + this.config_.capabilities.browserName +
                 ' is not supported with directConnect.');
     }
-    return Promise.resolve(function() {});
   }
 
   /**

lib/driverProviders/driverProvider.ts

@@ -100,9 +100,7 @@ export abstract class DriverProvider {
    * Default update job method.
    * @return a promise
    */
-  updateJob(update: any): Promise<any> {
-    return Promise.resolve();
-  };
+  async updateJob(update: any): Promise<any>{};
 
   /**
    * Default setup environment method, common to all driver providers.

lib/driverProviders/hosted.ts

@@ -20,8 +20,7 @@ export class Hosted extends DriverProvider {
    * @return {Promise} A promise which will resolve when the environment is
    *     ready to test.
    */
-  protected setupDriverEnv(): Promise<any> {
+  protected async setupDriverEnv(): Promise<any> {
     logger.info('Using the selenium server at ' + this.config_.seleniumAddress);
-    return Promise.resolve();
   }
 }

lib/driverProviders/kobiton.ts

@@ -19,13 +19,12 @@ export class Kobiton extends DriverProvider {
    * @return {Promise} A promise which will resolve when the environment is
    *      ready to test.
    */
-  protected setupDriverEnv(): Promise<any> {
+  protected async setupDriverEnv(): Promise<any> {
     this.config_.capabilities['kobitonUser'] = this.config_.kobitonUser;
     this.config_.capabilities['kobitonKey'] = this.config_.kobitonKey;
     this.config_.seleniumAddress = 'https://' + this.config_.kobitonUser + ':' +
         this.config_.kobitonKey + '@api.kobiton.com/wd/hub';
 
     logger.info('Using Kobiton selenium server at ' + this.config_.seleniumAddress);
-    return Promise.resolve();
   }
 }

lib/driverProviders/local.ts

@@ -168,7 +168,7 @@ export class Local extends DriverProvider {
    *
    * @public
    * @override
-   * @return {q.promise} A promise which will resolve when the environment
+   * @return {Promise} A promise which will resolve when the environment
    *     is down.
    */
   async teardownEnv(): Promise<any> {

lib/driverProviders/mock.ts

@@ -20,18 +20,16 @@ export class Mock extends DriverProvider {
   /**
    * An execute function that returns a promise with a test value.
    */
-  execute(): Promise<any> {
-    return Promise.resolve({value: 'test_response'});
+  async execute(): Promise<any> {
+    return {value: 'test_response'};
   }
 
   /**
    * Configure and launch (if applicable) the object's environment.
    * @public
-   * @return {q.promise} A promise which will resolve immediately.
+   * @return {Promise} A promise which will resolve immediately.
    */
-  protected setupDriverEnv(): Promise<any> {
-    return Promise.resolve();
-  }
+  protected async setupDriverEnv(): Promise<any> {}
 
   /**
    * Create a new driver.

lib/driverProviders/sauce.ts

@@ -49,7 +49,7 @@ export class Sauce extends DriverProvider {
    * @return {Promise} A promise which will resolve when the environment is
    *     ready to test.
    */
-  protected setupDriverEnv(): Promise<any> {
+  protected async setupDriverEnv(): Promise<any> {
     this.sauceServer_ = new SauceLabs({
       username: this.config_.sauceUser,
       password: this.config_.sauceKey,
@@ -75,6 +75,5 @@ export class Sauce extends DriverProvider {
     logger.info(
         'Using SauceLabs selenium server at ' +
         this.config_.seleniumAddress.replace(/\/\/.+@/, '//'));
-    return Promise.resolve();
   }
 }

lib/driverProviders/testObject.ts

@@ -19,12 +19,11 @@ export class TestObject extends DriverProvider {
    * @return {Promise} A promise which will resolve when the environment is
    *      ready to test.
    */
-  protected setupDriverEnv(): Promise<any> {
+  protected async setupDriverEnv(): Promise<any> {
     this.config_.capabilities['testobject.user'] = this.config_.testobjectUser;
     this.config_.capabilities['testobject_api_key'] = this.config_.testobjectKey;
     this.config_.seleniumAddress = 'https://us1.appium.testobject.com/wd/hub';
 
     logger.info('Using TestObject selenium server at ' + this.config_.seleniumAddress);
-    return Promise.resolve();
   }
 }