chore(promises): match promises to webdriver.promise.Promise (#3282)

- resolve clang issues
- rename ptor_ to browser

Author: cnishina

lib/browser.ts

@@ -172,7 +172,7 @@ export class Browser {
    *
    * @type {q.Promise} Done when the new browser is ready for use
    */
-  ready: webdriver.Promise;
+  ready: webdriver.promise.Promise;
 
   /*
    * Set by the runner.
@@ -283,7 +283,7 @@ export class Browser {
    *
    * @return {q.Promise} A promise which resolves to the capabilities object.
    */
-  getProcessedConfig: () => webdriver.Promise;
+  getProcessedConfig: () => webdriver.promise.Promise;
 
   /**
    * Fork another instance of protractor for use in interactive tests.
@@ -329,7 +329,7 @@ export class Browser {
    */
   private executeScript_(
       script: string|Function, description: string,
-      ...scriptArgs: any[]): webdriver.Promise {
+      ...scriptArgs: any[]): webdriver.promise.Promise {
     if (typeof script === 'function') {
       script = 'return (' + script + ').apply(null, arguments);';
     }
@@ -355,7 +355,7 @@ export class Browser {
    */
   private executeAsyncScript_(
       script: string|Function, description: string,
-      ...scriptArgs: any[]): webdriver.Promise {
+      ...scriptArgs: any[]): webdriver.promise.Promise {
     if (typeof script === 'function') {
       script = 'return (' + script + ').apply(null, arguments);';
     }
@@ -377,15 +377,15 @@ export class Browser {
    * @return {!webdriver.promise.Promise} A promise that will resolve to the
    *    scripts return value.
    */
-  waitForAngular(opt_description?: string): webdriver.Promise {
+  waitForAngular(opt_description?: string): webdriver.promise.Promise {
     let description = opt_description ? ' - ' + opt_description : '';
     if (this.ignoreSynchronization) {
       return this.driver.controlFlow().execute(() => {
         return true;
       }, 'Ignore Synchronization Protractor.waitForAngular()');
     }
 
-    let runWaitForAngularScript: () => webdriver.Promise = () => {
+    let runWaitForAngularScript: () => webdriver.promise.Promise = () => {
       if (this.plugins_.skipAngularStability()) {
         return webdriver.promise.fulfilled();
       } else if (this.rootEl) {
@@ -445,7 +445,7 @@ export class Browser {
                   errMsg +=
                       '\nWhile waiting for element with locator' + description;
                 }
-                let pendingTimeoutsPromise: webdriver.Promise;
+                let pendingTimeoutsPromise: webdriver.promise.Promise;
                 if (this.trackOutstandingTimeouts_) {
                   pendingTimeoutsPromise = this.executeScript_(
                       'return window.NG_PENDING_TIMEOUTS',
@@ -510,7 +510,7 @@ export class Browser {
    * @return {!webdriver.promise.Promise} A promise that will be resolved to an
    *     array of the located {@link webdriver.WebElement}s.
    */
-  findElements(locator: Locator): webdriver.Promise {
+  findElements(locator: Locator): webdriver.promise.Promise {
     return this.element.all(locator).getWebElements();
   }
 
@@ -521,7 +521,7 @@ export class Browser {
    *     the element is present on the page.
    */
   isElementPresent(locatorOrElement: webdriver.Locator|
-                   webdriver.WebElement): webdriver.Promise {
+                   webdriver.WebElement): webdriver.promise.Promise {
     let element = (locatorOrElement.isPresent) ? locatorOrElement :
                                                  this.element(locatorOrElement);
     return element.isPresent();
@@ -839,7 +839,7 @@ export class Browser {
    * @return {!webdriver.promise.Promise} A promise that will resolve once
    *    page has been changed.
    */
-  setLocation(url: string): webdriver.Promise {
+  setLocation(url: string): webdriver.promise.Promise {
     this.waitForAngular();
     return this
         .executeScript_(
@@ -861,7 +861,7 @@ export class Browser {
    * expect(browser.getLocationAbsUrl())
    *     .toBe('http://angular.github.io/protractor/#/api');
    */
-  getLocationAbsUrl(): webdriver.Promise {
+  getLocationAbsUrl(): webdriver.promise.Promise {
     this.waitForAngular();
     return this.executeScript_(
         clientSideScripts.getLocationAbsUrl, 'Protractor.getLocationAbsUrl()',
@@ -905,7 +905,7 @@ export class Browser {
    *     is done. The promise will resolve to a boolean which represents whether
    *     this is the first time that the debugger is called.
    */
-  private validatePortAvailability_(port: number): webdriver.Promise {
+  private validatePortAvailability_(port: number): webdriver.promise.Promise {
     if (this.debuggerValidated_) {
       return webdriver.promise.fulfilled(false);
     }

lib/element.ts

@@ -72,7 +72,8 @@ export class ElementArrayFinder {
 
   constructor(
       private browser_: Browser, getWebElements?: Function,
-      private locator_?: any, public actionResults_: webdriver.Promise = null) {
+      private locator_?: any,
+      public actionResults_: webdriver.promise.Promise = null) {
     this.getWebElements = getWebElements || null;
 
     // TODO(juliemr): might it be easier to combine this with our docs and just
@@ -351,7 +352,7 @@ export class ElementArrayFinder {
    * @return {!webdriver.promise.Promise} A promise which resolves to the
    *     number of elements matching the locator.
    */
-  count(): webdriver.Promise {
+  count(): webdriver.promise.Promise {
     return this.getWebElements().then(
         (arr: any) => { return arr.length; },
         (err: any) => {
@@ -411,7 +412,7 @@ export class ElementArrayFinder {
    * @return {Array.<ElementFinder>} Return a promise, which resolves to a list
    *     of ElementFinders specified by the locator.
    */
-  asElementFinders_(): webdriver.Promise {
+  asElementFinders_(): webdriver.promise.Promise {
     return this.getWebElements().then((arr: webdriver.WebElement[]) => {
       return arr.map((webElem: webdriver.WebElement) => {
         return ElementFinder.fromWebElement_(
@@ -444,7 +445,7 @@ export class ElementArrayFinder {
    * @return {!webdriver.promise.Promise} A promise which will resolve to
    *     an array of ElementFinders represented by the ElementArrayFinder.
    */
-  then(fn: Function, errorFn: Function): webdriver.Promise {
+  then(fn: Function, errorFn: Function): webdriver.promise.Promise {
     if (this.actionResults_) {
       return this.actionResults_.then(fn, errorFn);
     } else {
@@ -478,7 +479,7 @@ export class ElementArrayFinder {
    *     function has been called on all the ElementFinders. The promise will
    *     resolve to null.
    */
-  each(fn: Function): webdriver.Promise {
+  each(fn: Function): webdriver.promise.Promise {
     return this.map(fn).then((): any => { return null; });
   }
 
@@ -514,7 +515,7 @@ export class ElementArrayFinder {
    * @return {!webdriver.promise.Promise} A promise that resolves to an array
    *     of values returned by the map function.
    */
-  map(mapFn: Function): webdriver.Promise {
+  map(mapFn: Function): webdriver.promise.Promise {
     return this.asElementFinders_().then((arr: ElementFinder[]) => {
       let list = arr.map((elementFinder: ElementFinder, index: number) => {
         let mapResult = mapFn(elementFinder, index);
@@ -556,7 +557,7 @@ export class ElementArrayFinder {
    * @return {!webdriver.promise.Promise} A promise that resolves to the final
    *     value of the accumulator.
    */
-  reduce(reduceFn: Function, initialValue: any): webdriver.Promise {
+  reduce(reduceFn: Function, initialValue: any): webdriver.promise.Promise {
     let valuePromise = webdriver.promise.fulfilled(initialValue);
     return this.asElementFinders_().then((arr: ElementFinder[]) => {
       return arr.reduce(
@@ -655,7 +656,7 @@ export class ElementArrayFinder {
  *
  * @constructor
  * @extends {webdriver.WebElement}
- * @param {Protractor} ptor
+ * @param {Browser} browser_
  * @param {ElementArrayFinder} elementArrayFinder The ElementArrayFinder
  *     that this is branched from.
  * @return {ElementFinder}
@@ -665,7 +666,7 @@ export class ElementFinder {
   elementArrayFinder_: ElementArrayFinder;
   then: Function = null;
 
-  constructor(private ptor_: any, elementArrayFinder: ElementArrayFinder) {
+  constructor(private browser_: Browser, elementArrayFinder: ElementArrayFinder) {
     if (!elementArrayFinder) {
       throw new Error('BUG: elementArrayFinder cannot be empty');
     }
@@ -718,7 +719,7 @@ export class ElementFinder {
     // Store a copy of the underlying elementArrayFinder, but with the more
     // restrictive getWebElements (which checks that there is only 1 element).
     this.elementArrayFinder_ = new ElementArrayFinder(
-        this.ptor_, getWebElements, elementArrayFinder.locator(),
+        this.browser_, getWebElements, elementArrayFinder.locator(),
         elementArrayFinder.actionResults_);
 
     WEB_ELEMENT_FUNCTIONS.forEach((fnName: string) => {
@@ -745,7 +746,7 @@ export class ElementFinder {
   clone(): ElementFinder {
     // A shallow copy is all we need since the underlying fields can never be
     // modified
-    return new ElementFinder(this.ptor_, this.parentElementArrayFinder);
+    return new ElementFinder(this.browser_, this.parentElementArrayFinder);
   }
 
   /**
@@ -778,7 +779,7 @@ export class ElementFinder {
         (parentWebElements: webdriver.WebElement[]) => {
           return parentWebElements[0];
         });
-    return new webdriver.WebElementPromise(this.ptor_.driver, id);
+    return new webdriver.WebElementPromise(this.browser_.driver, id);
   }
 
   /**
@@ -993,7 +994,7 @@ export class ElementFinder {
    * @return {!webdriver.promise.Promise.<boolean>} A promise that will be
    *     resolved to whether the two WebElements are equal.
    */
-  equals(element: any): webdriver.Promise {
+  equals(element: any): webdriver.promise.Promise {
     return webdriver.WebElement.equals(
         this.getWebElement(),
         element.getWebElement ? element.getWebElement() : element);

lib/globals.d.ts

@@ -60,9 +60,11 @@ declare namespace webdriver {
     getCapabilities: Function;
   }
 
-  class Promise {
-    controlFlow: Function;
-    then: Function;
+  namespace promise {
+    interface Promise {
+      controlFlow: Function,
+      then: Function
+    }
   }
 
   class Capabilities {