Oss 953 consolidate query timeout for v5 (#549)

* tests(OSS-92): remove resources after all test completed (#527)

* tests(OSS-92): remove resources after all test completed

* tests: posttest

* posttest

* posttest

* posttest

* fix: ContainsStr FQL to string (#537)

* fix: ContainsStr FQL to string

* test

* fix

* move test

* OSS-906 fix: restore _isFaunaValue and _isFaunaRef properties (#529)

* fix: restore _isFaunaValue and _isFaunaRef properties

* test: added tests for values type-helpers

* Add toFQL() to type declaration for Expr (#544)

I wanted to print a query as FQL for debugging purposes, but didn't find the toFQL method because it wasn't in the type declaration. A helpful person on StackOverflow pointed it out to me. https://stackoverflow.com/questions/69418846/how-can-i-print-an-fql-query-from-javascript-as-a-string-e-g-to-test-it-in-the/69472058

* fix tests clean (#545)

* TGB-921 page helper (#543)

* TGB-921 page helper

* remove page.data.forEach as it's deprecated

* fix test

* fix test

* debug auth0 tests (#546)

* slack notification (#547)

* OSS-953 Consolidate query timeout for v5

Co-authored-by: Paul Paterson <ptpaterson@gmail.com>
Co-authored-by: Kevin <89287578+ktint@users.noreply.github.com>

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

concourse/pipeline.yml

@@ -1,5 +1,16 @@
 ---
+resource_types:
+  - name: slack-notification
+    type: docker-image
+    source:
+      repository: cfcommunity/slack-notification-resource
+
 resources:
+  - name: notify
+    type: slack-notification
+    source:
+      url: ((slack-webhook))
+
   - name: fauna-js-repository
     type: git
     icon: github
@@ -39,6 +50,15 @@ jobs:
         file: fauna-js-repository/concourse/tasks/browserify-and-npm-publish.yml
         params:
           NPM_TOKEN: ((npm_token))
+        on_success:
+          put: notify
+          params:
+            text_file: slack-message/publish
+        on_failure:
+          put: notify
+          params:
+            text_file: slack-message/publish
+
 
       - task: publish-docs
         file: fauna-js-repository/concourse/tasks/publish-docs.yml

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/PageHelper.js

@@ -191,17 +191,7 @@ PageHelper.prototype._adjustCursors = function(page) {
 PageHelper.prototype._consumePages = function(lambda, reverse) {
   var self = this
   return function(page) {
-    var data = []
-    page.data.forEach(function(item) {
-      if (item.document) {
-        item.instance = item.document
-      }
-      if (item.value && item.value.document) {
-        item.value.instance = item.value.document
-      }
-      data.push(item)
-    })
-    lambda(data)
+    lambda(page.data)
 
     var nextCursor
     if (reverse) {

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/afterComplete.js

@@ -2,6 +2,7 @@ const query = require('../src/query')
 const Client = require('../src/Client')
 const util = require('../src/_util')
 const testConfig = require('./config')
+const errors = require('../src/errors')
 
 function takeObjectKeys(object) {
   var out = {}
@@ -20,32 +21,46 @@ const rootClient = new Client(
     )
   )
 )
-rootClient.query(
-  query.Let(
-    {
-      rootKey: query.KeyFromSecret(testConfig.auth),
-      keys: query.Map(query.Paginate(query.Keys()), ref => query.Get(ref)),
-      allKeysExceptRoot: query.Map(
-        query.Filter(query.Var('keys'), key =>
-          query.Not(
-            query.Equals(
-              query.Select(['ref'], key, null),
-              query.Select(['ref'], query.Var('rootKey'))
-            )
-          )
-        ),
-        key => query.Select(['ref'], key)
-      ),
-      refsToRemove: query.Union(
-        query.Select(['data'], query.Paginate(query.Databases())),
-        query.Select(['data'], query.Paginate(query.Collections())),
-        query.Select(['data'], query.Paginate(query.Indexes())),
-        query.Select(['data'], query.Paginate(query.Functions())),
-        query.Select(['data'], query.Var('allKeysExceptRoot'))
-      ),
-    },
-    query.Foreach(query.Var('refsToRemove'), ref =>
-      query.If(query.Exists(ref), query.Delete(ref), '')
+
+rootClient
+  .query(query.KeyFromSecret(testConfig.auth))
+  .catch(error => {
+    if (error instanceof errors.BadRequest) {
+      return null
+    }
+    throw error
+  })
+  .then(rootKey =>
+    rootClient.query(
+      query.Let(
+        {
+          rootKey,
+          keys: query.Map(query.Paginate(query.Keys()), ref => query.Get(ref)),
+          allKeysExceptRoot: query.Map(
+            rootKey
+              ? query.Filter(query.Var('keys'), key =>
+                  query.Not(
+                    query.Equals(
+                      query.Select(['ref'], key, null),
+                      query.Select(['ref'], query.Var('rootKey'))
+                    )
+                  )
+                )
+              : query.Var('keys'),
+            key => query.Select(['ref'], key)
+          ),
+          refsToRemove: query.Union(
+            query.Select(['data'], query.Paginate(query.Databases())),
+            query.Select(['data'], query.Paginate(query.Collections())),
+            query.Select(['data'], query.Paginate(query.Indexes())),
+            query.Select(['data'], query.Paginate(query.Functions())),
+            query.Select(['data'], query.Var('allKeysExceptRoot'))
+          ),
+        },
+        query.Foreach(query.Var('refsToRemove'), ref =>
+          query.If(query.Exists(ref), query.Delete(ref), '')
+        )
+      )
     )
   )
-)
+  .catch(console.error)

test/auth.test.js

@@ -21,7 +21,7 @@ describe('auth', () => {
         .then(resp => resp.json())
         .then(data => data.access_token)
     }
-    const providerName = util.randomString('provider_')
+    const providerName = util.randomString('js_driver_')
     const roleOneName = util.randomString('role_one_')
 
     let resource

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,
     })
 

test/page.test.js

@@ -263,7 +263,6 @@ describe('page', () => {
         expect('ts' in item).toBeTruthy()
         expect('action' in item).toBeTruthy()
         expect('document' in item).toBeTruthy()
-        expect('instance' in item).toBeTruthy()
         expect('data' in item).toBeTruthy()
       })
     })
@@ -293,7 +292,6 @@ describe('page', () => {
         expect('ts' in value).toBeTruthy()
         expect('action' in value).toBeTruthy()
         expect('document' in value).toBeTruthy()
-        expect('instance' in value).toBeTruthy()
         expect('data' in value).toBeTruthy()
       })
     })