Skip to content

Commit 2e1a76d

Browse files
author
Shiranuit
authored
Merge pull request #632 from kuzzleio/feature/597-request-timeout
Add a timeout option for every request
2 parents 1e9bdf1 + ea885ed commit 2e1a76d

File tree

77 files changed

+1017
-469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1017
-469
lines changed

‎doc/7/controllers/auth/check-rights/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ Checks if the provided API request can be executed by the current logged user.
1818
checkRights(requestPayload)
1919
```
2020

21-
| Property | Type | Description |
22-
|--- |--- |--- |
23-
| `requestPayload` | <pre>object</pre> | Contains a [RequestPayload](/core/2/api/payloads/request) |
21+
| Property | Type | Description |
22+
| ---------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
23+
| `requestPayload` | <pre>object</pre> | Contains a [RequestPayload](/core/2/api/payloads/request) |
24+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
2425

2526
## `requestPayload`
2627

‎doc/7/controllers/auth/check-token/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ checkToken([token]);
2323
| -------- | ----------------- | ----------- |
2424
| `token` | <pre>string</pre> | Optional authentication token |
2525

26+
### options
27+
28+
Additional query options
29+
30+
| Property | Type<br/>(default) | Description |
31+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
32+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
33+
2634
## Resolves
2735

2836
An `object` representing the token validity status

‎doc/7/controllers/auth/create-api-key/index.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,21 @@ createApiKey(description, [options]);
2121

2222
<br />
2323

24-
| Property | Type | Description |
25-
| --- | --- | --- |
24+
| Property | Type | Description |
25+
| ------------- | ----------------- | ------------------- |
2626
| `description` | <pre>string</pre> | API key description |
27-
| `options` | <pre>object</pre> | Additional options |
27+
| `options` | <pre>object</pre> | Additional options |
2828

2929
### options
3030

3131
Additional query options
3232

33-
| Property | Type<br />(default) | Description |
34-
| --- | --- | --- |
35-
| `expiresIn` | <pre>string/number</pre><br />(`-1`) | Expiration duration |
36-
| `_id` | <pre>string</pre><br />(`null`) | API key unique ID |
37-
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
33+
| Property | Type<br />(default) | Description |
34+
| ----------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
35+
| `expiresIn` | <pre>string/number</pre><br />(`-1`) | Expiration duration |
36+
| `_id` | <pre>string</pre><br />(`null`) | API key unique ID |
37+
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
38+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/>(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3839

3940
**Notes**:
4041
- `expiresIn`:
@@ -46,20 +47,20 @@ Additional query options
4647

4748
An object containing the newly created API key:
4849

49-
| Name | Type | Description |
50-
| --------- | ----------------- | ---------------- |
51-
| `_id` | <pre>string</pre> | ID of the newly created API key |
52-
| `_source` | <pre>object</pre> | API key content |
50+
| Name | Type | Description |
51+
| --------- | ----------------- | ------------------------------- |
52+
| `_id` | <pre>string</pre> | ID of the newly created API key |
53+
| `_source` | <pre>object</pre> | API key content |
5354

5455
The API key content has the following properties:
5556

56-
| Name | Type | Description |
57-
| --------- | ----------------- | ---------------- |
58-
| `userId` | <pre>string</pre> | User kuid |
59-
| `expiresAt` | <pre>number</pre> | Expiration date in Epoch-millis format (`-1` if the token never expires) |
60-
| `ttl` | <pre>number</pre> | Original TTL |
61-
| `description` | <pre>string</pre> | API key description |
62-
| `token` | <pre>string</pre> | Authentication token associated with this API key |
57+
| Name | Type | Description |
58+
| ------------- | ----------------- | ------------------------------------------------------------------------ |
59+
| `userId` | <pre>string</pre> | User kuid |
60+
| `expiresAt` | <pre>number</pre> | Expiration date in Epoch-millis format (`-1` if the token never expires) |
61+
| `ttl` | <pre>number</pre> | Original TTL |
62+
| `description` | <pre>string</pre> | API key description |
63+
| `token` | <pre>string</pre> | Authentication token associated with this API key |
6364

6465
::: warning
6566
The authentication token `token` will never be returned by Kuzzle again. If you lose it, you'll have to delete the API key and recreate a new one.

‎doc/7/controllers/auth/create-my-credentials/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ createMyCredentials(strategy, credentials, [options]);
2727

2828
Additional query options
2929

30-
| Property | Type<br/>(default) | Description |
31-
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
32-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
30+
| Property | Type<br/>(default) | Description |
31+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
32+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
33+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3334

3435
## Resolves
3536

‎doc/7/controllers/auth/credentials-exist/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@ credentialsExist(strategy, [options]);
2626

2727
Additional query options
2828

29-
| Property | Type<br/>(default) | Description |
30-
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
31-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
29+
| Property | Type<br/>(default) | Description |
30+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
31+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
32+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3233

3334
## Resolves
3435

‎doc/7/controllers/auth/delete-api-key/index.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,19 @@ deleteApiKey(id, [options]);
2121

2222
<br />
2323

24-
| Property | Type | Description |
25-
| --- | --- | --- |
26-
| `id` | <pre>string</pre> | API key unique ID |
24+
| Property | Type | Description |
25+
| --------- | ----------------- | ------------------ |
26+
| `id` | <pre>string</pre> | API key unique ID |
2727
| `options` | <pre>object</pre> | Additional options |
2828

2929
### options
3030

3131
Additional query options
3232

33-
| Property | Type<br />(default) | Description |
34-
| --- | --- | --- |
35-
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
33+
| Property | Type<br />(default) | Description |
34+
| --------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
35+
| `refresh` | <pre>boolean</pre><br />(`false`) | If set to `wait_for`, Kuzzle will not respond until the API key is indexed |
36+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre><br/>(`-1`) | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3637

3738
## Resolves
3839

‎doc/7/controllers/auth/delete-my-credentials/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ deleteMyCredentials(strategy, [options]);
3030

3131
Additional query options
3232

33-
| Property | Type<br/>(default) | Description |
34-
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
35-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
33+
| Property | Type<br/>(default) | Description |
34+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
35+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
36+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3637

3738
## Resolves
3839

‎doc/7/controllers/auth/get-current-user/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ getCurrentUser([options]);
2525

2626
Additional query options
2727

28-
| Property | Type<br/>(default) | Description |
29-
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
30-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
28+
| Property | Type<br/>(default) | Description |
29+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
30+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
31+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3132

3233
## Resolves
3334

‎doc/7/controllers/auth/get-my-credentials/index.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ getMyCredentials(strategy, [options]);
3030

3131
Additional query options
3232

33-
| Property | Type<br/>(default) | Description |
34-
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
35-
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
33+
| Property | Type<br/>(default) | Description |
34+
| ---------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
35+
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
36+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3637

3738
## Resolves
3839

‎doc/7/controllers/auth/get-my-rights/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Additional query options
2828
| Property | Type<br/>(default) | Description |
2929
| ---------- | ------------------------------- | --------------------------------- |
3030
| `queuable` | <pre>boolean</pre><br/>(`true`) | Make this request queuable or not |
31+
| [`timeout`](/sdk/7/core-classes/kuzzle/query#timeout) | <pre>number</pre> | Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |
3132

3233
## Resolves
3334

0 commit comments

Comments
 (0)