pubsub: Fix broken abortion of outstanding requests

This restores the fix from googleapis#1105 which was broken after googleapis#1070
ctavan · Feb 3, 2017 · 72129dd · 72129dd
1 parent 7a08cec
commit 72129dd
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 5 deletions.
diff --git a/packages/common-grpc/src/service.js b/packages/common-grpc/src/service.js
@@ -280,7 +280,9 @@ GrpcService.prototype.request = function(protoOpts, reqOpts, callback) {
     }
   };
 
-  retryRequest(null, retryOpts, function(err, resp) {
+  // Return the request object to allow abort()-ing long-running requests (e.g.
+  // pub/sub pulls)
+  return retryRequest(null, retryOpts, function(err, resp) {
     if (!err && resp === respError) {
       err = respError;
       resp = null;

diff --git a/packages/common-grpc/test/service.js b/packages/common-grpc/test/service.js
@@ -648,6 +648,18 @@ describe('GrpcService', function() {
       delete global.GCLOUD_SANDBOX_ENV;
     });
 
+    it('should return request object with abort() method', function(done) {
+      grpcService.protos.Service = {
+        service: function() {
+          setImmediate(done);
+          return new ProtoService();
+        }
+      };
+
+      var request = grpcService.request(PROTO_OPTS, REQ_OPTS, assert.ifError);
+      assert.strictEqual(typeof request.abort, 'function');
+    });
+
     it('should access the specified service proto object', function(done) {
       grpcService.protos.CustomService = {
         CustomService: function() {

diff --git a/packages/pubsub/src/subscription.js b/packages/pubsub/src/subscription.js
@@ -732,8 +732,8 @@ Subscription.prototype.listenForEvents_ = function() {
     if (event === 'message' && --self.messageListeners === 0) {
       self.closed = true;
 
-      if (self.activeRequest_ && self.activeRequest_.cancel) {
-        self.activeRequest_.cancel();
+      if (self.activeRequest_ && self.activeRequest_.abort) {
+        self.activeRequest_.abort();
       }
     }
   });

diff --git a/packages/pubsub/test/subscription.js b/packages/pubsub/test/subscription.js
@@ -961,11 +961,11 @@ describe('Subscription', function() {
       assert.strictEqual(subscription.closed, true);
     });
 
-    it('should cancel the HTTP request when listeners removed', function(done) {
+    it('should abort the HTTP request when listeners removed', function(done) {
       subscription.startPulling_ = util.noop;
 
       subscription.activeRequest_ = {
-        cancel: done
+        abort: done
       };
 
       subscription.on('message', util.noop);