[js] Remove thenable properties from promise.Deferred

Author: jleyba

javascript/node/selenium-webdriver/CHANGES.md

@@ -9,6 +9,7 @@
 * Internal cleanup replacing uses of managed promises with native promises
 * Removed the mandatory use of Firefox Dev Edition, when using Marionette driver
 * Fixed timeouts' URL
+* `promise.Deferred` is no longer a thenable object.
 * Removed deprecated modules:
    - `selenium-webdriver/error` (use `selenium-webdriver/lib/error`,\
      or the `error` property exported by `selenium-webdriver`)
@@ -19,6 +20,11 @@
    - `until.WebElementCondition` (use `webdriver.WebElementCondition`)
    - `webdriver.UnhandledAlertError` (use `error.UnexpectedAlertOpenError`)
 * Removed deprecated functions:
+   - `Deferred#cancel()`
+   - `Deferred#catch()`
+   - `Deferred#finally()`
+   - `Deferred#isPending()`
+   - `Deferred#then()`
    - `Promise#thenCatch()`
    - `Promise#thenFinally()`
    - `WebDriver#isElementPresent()`

javascript/node/selenium-webdriver/http/util.js

@@ -87,7 +87,7 @@ exports.waitForServer = function(url, timeout) {
           Error('Timed out waiting for the WebDriver server at ' + url));
     } else {
       setTimeout(function() {
-        if (ready.isPending()) {
+        if (ready.promise.isPending()) {
           checkServerStatus();
         }
       }, 50);
@@ -122,15 +122,15 @@ exports.waitForUrl = function(url, timeout) {
           'Timed out waiting for the URL to return 2xx: ' + url));
     } else {
       setTimeout(function() {
-        if (ready.isPending()) {
+        if (ready.promise.isPending()) {
           testUrl();
         }
       }, 50);
     }
   }
 
   function onResponse(response) {
-    if (!ready.isPending()) return;
+    if (!ready.promise.isPending()) return;
     if (response.status > 199 && response.status < 300) {
       return ready.fulfill();
     }

javascript/node/selenium-webdriver/lib/promise.js

@@ -1331,7 +1331,6 @@ Thenable.addImplementation(ManagedPromise);
  * the next turn of the event loop, the rejection will be passed to the
  * {@link ControlFlow} as an unhandled failure.
  *
- * @implements {Thenable<T>}
  * @template T
  */
 class Deferred {
@@ -1375,42 +1374,7 @@ class Deferred {
       reject(opt_reason);
     };
   }
-
-  /** @override */
-  isPending() {
-    return this.promise.isPending();
-  }
-
-  /** @override */
-  cancel(opt_reason) {
-    this.promise.cancel(opt_reason);
-  }
-
-  /**
-   * @override
-   * @deprecated Use {@code then} from the promise property directly.
-   */
-  then(opt_cb, opt_eb) {
-    return this.promise.then(opt_cb, opt_eb);
-  }
-
-  /**
-   * @override
-   * @deprecated Use {@lcode catch} from the promise property directly.
-   */
-  catch(opt_eb) {
-    return this.promise.catch(opt_eb);
-  }
-
-  /**
-   * @override
-   * @deprecated Use {@code finally} from the promise property directly.
-   */
-  finally(opt_cb) {
-    return this.promise.finally(opt_cb);
-  }
 }
-Thenable.addImplementation(Deferred);
 
 
 /**
@@ -2702,7 +2666,8 @@ class TaskQueue extends events.EventEmitter {
 
     if (this.pending_) {
       vlog(2, () => this + '.abort(); cancelling pending task', this);
-      this.pending_.task.cancel(/** @type {!CancellationError} */(error));
+      this.pending_.task.promise.cancel(
+          /** @type {!CancellationError} */(error));
 
     } else {
       vlog(2, () => this + '.abort(); emitting error event', this);
@@ -3018,7 +2983,7 @@ function consume(generatorFn, opt_self, var_args) {
   }
 
   function pump(fn, opt_arg) {
-    if (!deferred.isPending()) {
+    if (!deferred.promise.isPending()) {
       return;  // Defererd was cancelled; silently abort.
     }
 

javascript/node/selenium-webdriver/test/lib/promise_flow_test.js

@@ -224,7 +224,7 @@ describe('promise control flow', function() {
 
       return timeout(5).then(function() {
         assert(!callback.called);
-        d1.fulfill(d2);
+        d1.fulfill(d2.promise);
         return timeout(5);
       }).then(function() {
         assert(!callback.called);
@@ -1454,7 +1454,7 @@ describe('promise control flow', function() {
       });
 
       var d = new promise.Deferred();
-      d.then(deferredPair.callback, deferredPair.errback);
+      d.promise.then(deferredPair.callback, deferredPair.errback);
 
       promise.fulfilled().
           then(function() {
@@ -1479,7 +1479,7 @@ describe('promise control flow', function() {
       });
 
       var d = new promise.Deferred();
-      d.then(deferredPair.callback, deferredPair.errback);
+      d.promise.then(deferredPair.callback, deferredPair.errback);
 
       schedule('a').
           then(function() {
@@ -1558,7 +1558,7 @@ describe('promise control flow', function() {
       assert.equal(e, err);
       assertFlowIs(defaultFlow);
     });
-    promise.defer().then(function() {
+    promise.defer().promise.then(function() {
       assertFlowIs(defaultFlow);
     });
 
@@ -1578,9 +1578,11 @@ describe('promise control flow', function() {
         assertFlowIs(newFlow);
       });
 
-      promise.defer().then(function() {
+      let d = promise.defer();
+      d.promise.then(function() {
         assertFlowIs(newFlow);
       });
+      d.fulfill();
     }).then(function() {
       assertFlowIs(newFlow);
     });

javascript/node/selenium-webdriver/test/lib/promise_test.js

@@ -65,10 +65,10 @@ describe('promise', function() {
     assertIsPromise(new promise.Promise(function(fulfill) {
       fulfill();
     }));
-    assertIsPromise(new promise.Deferred());
     assertIsPromise(new promise.Deferred().promise);
     assertIsPromise({then:function() {}});
 
+    assertNotPromise(new promise.Deferred());
     assertNotPromise(undefined);
     assertNotPromise(null);
     assertNotPromise('');
@@ -139,17 +139,17 @@ describe('promise', function() {
   describe('cancel', function() {
     it('passesTheCancellationReasonToReject', function() {
       var d = new promise.Deferred();
-      var res = d.then(assert.fail, function(e) {
+      var res = d.promise.then(assert.fail, function(e) {
         assert.ok(e instanceof promise.CancellationError);
         assert.equal('because i said so', e.message);
       });
-      d.cancel('because i said so');
+      d.promise.cancel('because i said so');
       return res;
     });
 
     it('canCancelADeferredFromAChainedPromise', function() {
       var d = new promise.Deferred();
-      var p = d.then(assert.fail, function(e) {
+      var p = d.promise.then(assert.fail, function(e) {
         assert.ok(e instanceof promise.CancellationError);
         assert.equal('because i said so', e.message);
       });
@@ -207,7 +207,7 @@ describe('promise', function() {
 
     it('WaitsForValueToBeResolvedBeforeInvokingCallback', function() {
       var d = new promise.Deferred(), callback;
-      let result = promise.when(d, callback = callbackHelper(function(value) {
+      let result = promise.when(d.promise, callback = callbackHelper(function(value) {
         assert.equal('hi', value);
       }));
       callback.assertNotCalled();
@@ -506,10 +506,11 @@ describe('promise', function() {
 
   describe('all', function() {
     it('(base case)', function() {
+      let defer = [promise.defer(), promise.defer()];
       var a = [
           0, 1,
-          promise.defer(),
-          promise.defer(),
+          defer[0].promise,
+          defer[1].promise,
           4, 5, 6
       ];
       delete a[5];
@@ -521,10 +522,10 @@ describe('promise', function() {
       var result = promise.all(a).then(pair.callback, pair.errback);
       pair.assertNeither();
 
-      a[2].fulfill(2);
+      defer[0].fulfill(2);
       pair.assertNeither();
 
-      a[3].fulfill(3);
+      defer[1].fulfill(3);
       return result.then(() => pair.assertCallback());
     });
 
@@ -533,14 +534,12 @@ describe('promise', function() {
     });
 
     it('usesFirstRejection', function() {
-      var a = [
-        promise.defer(),
-        promise.defer()
-      ];
+      let defer = [promise.defer(), promise.defer()];
+      let a = [defer[0].promise, defer[1].promise];
 
       var result = promise.all(a).then(assert.fail, assertIsStubError);
-      a[1].reject(new StubError);
-      setTimeout(() => a[0].reject(Error('ignored')), 0);
+      defer[1].reject(new StubError);
+      setTimeout(() => defer[0].reject(Error('ignored')), 0);
       return result;
     });
   });
@@ -587,7 +586,7 @@ describe('promise', function() {
 
     it('inputIsPromise', function() {
       var input = promise.defer();
-      var result = promise.map(input, function(value) {
+      var result = promise.map(input.promise, function(value) {
         return value + 1;
       });
 
@@ -739,7 +738,7 @@ describe('promise', function() {
 
     it('inputIsPromise', function() {
       var input = promise.defer();
-      var result = promise.filter(input, function(value) {
+      var result = promise.filter(input.promise, function(value) {
         return value > 1 && value < 3;
       });
 

javascript/node/selenium-webdriver/test/lib/webdriver_test.js

@@ -1563,12 +1563,12 @@ describe('WebDriver', function() {
 
   describe('alert handling', function() {
     it('alertResolvesWhenPromisedTextResolves', function() {
-      var textPromise = new promise.Deferred();
+      var deferredText = new promise.Deferred();
 
-      var alert = new AlertPromise({}, textPromise);
+      var alert = new AlertPromise({}, deferredText.promise);
       assert.ok(alert.isPending());
 
-      textPromise.fulfill(new Alert({}, 'foo'));
+      deferredText.fulfill(new Alert({}, 'foo'));
       return alert.getText().then(function(text) {
         assert.equal('foo', text);
       });