Oss 953 consolidate query timeout for v5

README.md

@@ -172,21 +172,9 @@ more information on the pagination helper.
 
 #### Timeouts
 
-The client can be configured to handle timeouts in two different ways:
+The client can be configured to handle timeout by setting a `queryTimeout` on the client (or passing the value to the client's `.query()` method directly)
 
-1. Add a `timeout` field to the `options` block when instantiating the client
-2. By setting a `queryTimeout` on the client (or passing the value to the client's `.query()` method directly)
-
-The first option (i.e. `timeout`) represents a HTTP timeout on the client side. Defined in seconds, the client will wait the specified period before timing out if it has yet to receive a response.
-
-```javascript
-const client = new faunadb.Client({
-  secret: 'YOUR_FAUNADB_SECRET',
-  timeout: 100,
-})
-```
-
-On the other hand, using the client's `queryTimeout` dictates how long FaunaDB will process the request on the server before timing out if it hasn't finished running the operation. This can be done in two different ways:
+Using the client's `queryTimeout` dictates how long FaunaDB will process the request on the server before timing out if it hasn't finished running the operation. This can be done in two different ways:
 
 ```javascript
 // 1. Setting the value when instantiating a new client
@@ -280,7 +268,6 @@ async function main() {
 main().catch(console.error)
 ```
 
-
 ## Known issues
 
 ### Using with Cloudflare Workers

src/Client.js

@@ -149,7 +149,6 @@ var notifyAboutNewVersion = util.notifyAboutNewVersion()
  * @param {?number} options.port
  *   Port of the FaunaDB server.
  * @param {?string} options.secret FaunaDB secret (see [Reference Documentation](https://app.fauna.com/documentation/intro/security))
- * @param {?number} options.timeout Read timeout in seconds.
  * @param {?Client~observerCallback} options.observer
  *   Callback that will be called after every completed request.
  * @param {?boolean} options.keepAlive
@@ -176,7 +175,6 @@ function Client(options) {
     scheme: 'https',
     port: null,
     secret: null,
-    timeout: 60,
     observer: null,
     keepAlive: true,
     headers: {},

src/_http/fetchAdapter.js

@@ -60,7 +60,7 @@ function FetchAdapter(options) {
  * @param {?string} options.body Request body utf8 string.
  * @params {?object} options.streamConsumer Stream consumer.
  * @param {?object} options.signal Abort signal object.
- * @param {?number} options.timeout Request timeout.
+ * @param {?number} options.queryTimeout Request timeout.
  * @returns {Promise} Request result.
  */
 FetchAdapter.prototype.execute = function(options) {
@@ -78,7 +78,7 @@ FetchAdapter.prototype.execute = function(options) {
   var timerId = null
   var isStreaming = options.streamConsumer != null
   // Use timeout only if no signal provided
-  var useTimeout = !options.signal && !!options.timeout
+  var useTimeout = !options.signal && !!options.queryTimeout
   var ctrl = new AbortController()
   var pendingRequest = {
     isStreaming: isStreaming,
@@ -163,7 +163,7 @@ FetchAdapter.prototype.execute = function(options) {
     timerId = setTimeout(function() {
       timerId = null
       ctrl.abort()
-    }, options.timeout)
+    }, options.queryTimeout)
   }
 
   if (options.signal) {

src/_http/http2Adapter.js

@@ -170,7 +170,7 @@ Http2Adapter.prototype._cleanupSessionFor = function(origin, isStreaming) {
  * @param {?string} options.body Request body utf8 string.
  * @params {?object} options.streamConsumer Stream consumer.
  * @param {?object} options.signal Abort signal object.
- * @param {?number} options.timeout Request timeout.
+ * @param {?number} options.queryTimeout Request timeout.
  * @returns {Promise} Request result.
  */
 Http2Adapter.prototype.execute = function(options) {
@@ -305,8 +305,8 @@ Http2Adapter.prototype.execute = function(options) {
       sessionInterface.onRequestStart()
 
       // Set up timeout only if no signal provided.
-      if (!options.signal && options.timeout) {
-        request.setTimeout(options.timeout, onTimeout)
+      if (!options.signal && options.queryTimeout) {
+        request.setTimeout(options.queryTimeout, onTimeout)
       }
 
       if (options.signal) {

src/_http/index.js

@@ -35,9 +35,8 @@ function HttpClient(options) {
   this._baseUrl = options.scheme + '://' + options.domain + ':' + options.port
   this._secret = options.secret
   this._headers = Object.assign({}, options.headers, getDefaultHeaders())
-  this._queryTimeout = options.queryTimeout
   this._lastSeen = null
-  this._timeout = Math.floor(options.timeout * 1000)
+  this._queryTimeout = options.queryTimeout
 }
 
 /**
@@ -120,7 +119,7 @@ HttpClient.prototype.execute = function(options) {
     headers: util.removeNullAndUndefinedValues(headers),
     body: options.body,
     signal: options.signal,
-    timeout: this._timeout,
+    queryTimeout: this._queryTimeout,
     streamConsumer: options.streamConsumer,
   })
 }

src/types/Client.d.ts

@@ -13,7 +13,6 @@ export interface ClientConfig {
   domain?: string
   scheme?: 'http' | 'https'
   port?: number
-  timeout?: number
   queryTimeout?: number
   observer?: <T extends object = object>(
     res: RequestResult<T | errors.FaunaHTTPError>,

test/client.test.js

@@ -255,7 +255,7 @@ describe('Client', () => {
     const customTimeout = 3
     const mockedFetch = mockFetch({}, true)
     const clientWithTimeout = new Client({
-      timeout: customTimeout,
+      queryTimeout: customTimeout,
       fetch: mockedFetch,
     })