Speech API: fix createRecognizeStream timeout. (googleapis#1915)

jmuk · stephenplusplus · commit f6c5ce9b8e27 · 2017-01-24T08:53:11.000-05:00
diff --git a/packages/speech/src/index.js b/packages/speech/src/index.js
@@ -364,11 +364,20 @@ Speech.formatResults_ = function(resultSets, verboseMode) {
  *     property, a `confidence` score from `0` - `100`, and an `alternatives`
  *     array consisting of other transcription possibilities.
  *
+ * Google Cloud Speech sets the limits for the audio duration. For more
+ * information, see
+ * [Content Limits]{@link https://cloud.google.com/speech/limits#content}.
+ *
  * @resource [StreamingRecognize API Reference]{@link https://cloud.google.com/speech/reference/rpc/google.cloud.speech.v1beta1#google.cloud.speech.v1beta1.Speech.StreamingRecognize}
  * @resource [StreamingRecognizeRequest API Reference]{@link https://cloud.google.com/speech/reference/rpc/google.cloud.speech.v1beta1#google.cloud.speech.v1beta1.StreamingRecognizeRequest}
+ * @resource [Content Limits]{@link https://cloud.google.com/speech/limits#content}
  *
  * @param {object} config - A `StreamingRecognitionConfig` object. See
  *     [`StreamingRecognitionConfig`](https://cloud.google.com/speech/reference/rpc/google.cloud.speech.v1beta1#google.cloud.speech.v1beta1.StreamingRecognitionConfig).
+ * @param {number=} config.timeout - In seconds, the amount of time before the
+ *     underlying API request times out. The default value, `190`, is sufficient
+ *     for audio input of 60 seconds or less. If your input is longer, consider
+ *     using a higher timeout value.
  * @param {boolean=} config.verbose - Enable verbose mode for a more detailed
  *     response. See the examples below. Default: `false`.
  *
@@ -469,10 +478,17 @@ Speech.prototype.createRecognizeStream = function(config) {
   var verboseMode = config.verbose === true;
   delete config.verbose;
 
+  var gaxOptions = {};
+
+  if (is.number(config.timeout)) {
+    gaxOptions.timeout = config.timeout * 1000;
+    delete config.timeout;
+  }
+
   var recognizeStream = streamEvents(pumpify.obj());
 
   recognizeStream.once('writing', function() {
-    var requestStream = self.api.Speech.streamingRecognize();
+    var requestStream = self.api.Speech.streamingRecognize(gaxOptions);
 
     requestStream.on('response', function(response) {
       recognizeStream.emit('response', response);
diff --git a/packages/speech/src/v1beta1/speech_client.js b/packages/speech/src/v1beta1/speech_client.js
@@ -79,7 +79,8 @@ function SpeechClient(gaxGrpc, grpcClients, opts) {
     'gax/' + gax.version,
     'nodejs/' + process.version].join(' ');
 
-  var operationsClient = new gax.lro({
+
+  this.operationsClient = new gax.lro({
     auth: gaxGrpc.auth,
     grpc: gaxGrpc.grpc
   }).operationsClient({
@@ -91,9 +92,9 @@ function SpeechClient(gaxGrpc, grpcClients, opts) {
     appVersion: appVersion
   });
 
-  var longrunningDescriptors = {
+  this.longrunningDescriptors = {
     asyncRecognize: new gax.LongrunningDescriptor(
-      operationsClient,
+      this.operationsClient,
       grpcClients.google.cloud.speech.v1beta1.AsyncRecognizeResponse.decode,
       grpcClients.google.cloud.speech.v1beta1.AsyncRecognizeMetadata.decode)
   };
@@ -104,6 +105,8 @@ function SpeechClient(gaxGrpc, grpcClients, opts) {
       clientConfig,
       {'x-goog-api-client': googleApiClient});
 
+  var self = this;
+
   var speechStub = gaxGrpc.createStub(
       servicePath,
       port,
@@ -115,13 +118,16 @@ function SpeechClient(gaxGrpc, grpcClients, opts) {
     'streamingRecognize'
   ];
   speechStubMethods.forEach(function(methodName) {
-    this['_' + methodName] = gax.createApiCall(
+    self['_' + methodName] = gax.createApiCall(
       speechStub.then(function(speechStub) {
-        return speechStub[methodName].bind(speechStub);
+        return function() {
+          var args = Array.prototype.slice.call(arguments, 0);
+          return speechStub[methodName].apply(speechStub, args);
+        };
       }),
       defaults[methodName],
-      STREAM_DESCRIPTORS[methodName] || longrunningDescriptors[methodName]);
-  }.bind(this));
+      STREAM_DESCRIPTORS[methodName] || self.longrunningDescriptors[methodName]);
+  });
 }
 
 // Service calls
diff --git a/packages/speech/src/v1beta1/speech_client_config.json b/packages/speech/src/v1beta1/speech_client_config.json
@@ -33,7 +33,7 @@
           "retry_params_name": "default"
         },
         "StreamingRecognize": {
-          "timeout_millis": 60000,
+          "timeout_millis": 190000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         }
diff --git a/packages/speech/test/index.js b/packages/speech/test/index.js
@@ -589,16 +589,53 @@ describe('Speech', function() {
           var stream = through.obj();
 
           stream.on('data', function(data) {
-            assert.deepEqual(data, {
-              streamingConfig: {} // No `verbose` property.
-            });
+            assert.strictEqual(data.streamingConfig.verbose, undefined);
+            done();
+          });
+
+          return stream;
+        }
+      };
+
+      stream.emit('writing');
+    });
+
+    it('should allow specifying a timeout', function(done) {
+      var timeout = 200;
+      var expectedTimeout = 200 * 1000;
+
+      speech.api.Speech = {
+        streamingRecognize: function(opts) {
+          assert.strictEqual(opts.timeout, expectedTimeout);
+          done();
+        }
+      };
+
+      var stream = speech.createRecognizeStream({
+        timeout: timeout
+      });
+
+      stream.emit('writing');
+    });
+
+    it('should delete timeout option from request object', function(done) {
+      speech.api.Speech = {
+        streamingRecognize: function() {
+          var stream = through.obj();
+
+          stream.on('data', function(data) {
+            assert.strictEqual(data.streamingConfig.timeout, undefined);
             done();
           });
 
           return stream;
         }
       };
 
+      var stream = speech.createRecognizeStream({
+        timeout: 90
+      });
+
       stream.emit('writing');
     });
   });

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`"retry_params_name": "default"`
`34`	`34`	`},`
`35`	`35`	`"StreamingRecognize": {`
`36`		`- "timeout_millis": 60000,`
	`36`	`+ "timeout_millis": 190000,`
`37`	`37`	`"retry_codes_name": "non_idempotent",`
`38`	`38`	`"retry_params_name": "default"`
`39`	`39`	`}`