feat: timeout option for http and webSocket (#79)

* feat: add timeout as config to transport * chore: changeset * feat: decode log `topics` + `data` & infer types for logs (#75) * feat: decode event log topics & data * docs: createContractEventFilter * pr review * feat: fall back to `getLogs` if filters are not supported (#76) * feat: fall back to getLogs if filters are not supported * Update src/actions/public/watchContractEvent.test.ts Co-authored-by: awkweb <[email protected]> * pr review --------- Co-authored-by: awkweb <[email protected]> * feat: decorate clients with actions (#77) * feat: fall back to getLogs if filters are not supported * Update src/actions/public/watchContractEvent.test.ts Co-authored-by: awkweb <[email protected]> * pr review * feat: decode event log topics & data * wip: public * wip: add ens * docs: public actions * wip: wallet actions * docs: wallet actions * wip: test actions * wip: add utils to main entrypoint * tests: add tests * playgrounds: update * chore: changeset * test * refactor: wire up decorator generics * fix conflicts * format --------- Co-authored-by: awkweb <[email protected]> --------- Co-authored-by: awkweb <[email protected]>
wevm · Feb 20, 2023 · db9caa9 · db9caa9 · vercel · Feb 20, 2023
1 parent d6a29f5
commit db9caa9
Show file tree

Hide file tree

Showing 16 changed files with 126 additions and 6 deletions.
diff --git a/.changeset/six-cows-think.md b/.changeset/six-cows-think.md
@@ -0,0 +1,5 @@
+---
+"viem": patch
+---
+
+Added `timeout` as a config option to the `http` and `webSocket` Transports.
diff --git a/site/docs/clients/transports/http.md b/site/docs/clients/transports/http.md
@@ -90,3 +90,17 @@ const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
   retryDelay: 100, // [!code focus]
 })
 ```
+
+### timeout (optional)
+
+- **Type:** `number`
+- **Default:** `10_000`
+
+The timeout for requests.
+
+```ts
+const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
+  timeout: 60_000, // [!code focus]
+})
+```
+
diff --git a/site/docs/clients/transports/websocket.md b/site/docs/clients/transports/websocket.md
@@ -88,4 +88,17 @@ The base delay (in ms) between retries. By default, the Transport will use [expo
 const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
   retryDelay: 100, // [!code focus]
 })
-```
+```
+
+### timeout (optional)
+
+- **Type:** `number`
+- **Default:** `10_000`
+
+The timeout for async WebSocket requests.
+
+```ts
+const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
+  timeout: 60_000, // [!code focus]
+})
+```
diff --git a/src/clients/createClient.test.ts b/src/clients/createClient.test.ts
@@ -34,6 +34,7 @@ test('creates', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "type": "base",
@@ -83,6 +84,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
           "url": undefined,
         },
@@ -134,6 +136,7 @@ describe('transports', () => {
           "retryCount": 3,
           "retryDelay": 150,
           "subscribe": [Function],
+          "timeout": 10000,
           "type": "webSocket",
         },
         "type": "base",
@@ -160,6 +163,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "type": "base",
@@ -197,6 +201,7 @@ describe('config', () => {
           "request": [MockFunction spy],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "mock",
         },
         "type": "base",
@@ -232,6 +237,7 @@ describe('config', () => {
           "request": [MockFunction spy],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "mock",
         },
         "type": "base",
@@ -267,6 +273,7 @@ describe('config', () => {
           "request": [MockFunction spy],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "mock",
         },
         "type": "base",
@@ -302,6 +309,7 @@ describe('config', () => {
           "request": [MockFunction spy],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "mock",
         },
         "type": "foo",

diff --git a/src/clients/createPublicClient.test.ts b/src/clients/createPublicClient.test.ts
@@ -65,6 +65,7 @@ test('creates', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "type": "publicClient",
@@ -148,6 +149,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
           "url": undefined,
         },
@@ -233,6 +235,7 @@ describe('transports', () => {
           "retryCount": 3,
           "retryDelay": 150,
           "subscribe": [Function],
+          "timeout": 10000,
           "type": "webSocket",
         },
         "type": "publicClient",
@@ -293,6 +296,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "type": "publicClient",

diff --git a/src/clients/createTestClient.test.ts b/src/clients/createTestClient.test.ts
@@ -66,6 +66,7 @@ test('creates', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "type": "testClient",
@@ -145,6 +146,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
           "url": undefined,
         },
@@ -226,6 +228,7 @@ describe('transports', () => {
           "retryCount": 3,
           "retryDelay": 150,
           "subscribe": [Function],
+          "timeout": 10000,
           "type": "webSocket",
         },
         "type": "testClient",

diff --git a/src/clients/createWalletClient.test.ts b/src/clients/createWalletClient.test.ts
@@ -46,6 +46,7 @@ test('creates', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "type": "walletClient",
@@ -84,6 +85,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "type": "walletClient",
@@ -121,6 +123,7 @@ describe('transports', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
           "url": "https://mockapi.com/rpc",
         },
@@ -162,6 +165,7 @@ describe('transports', () => {
           "retryCount": 3,
           "retryDelay": 150,
           "subscribe": [Function],
+          "timeout": 10000,
           "type": "webSocket",
         },
         "type": "walletClient",

diff --git a/src/clients/transports/createTransport.test.ts b/src/clients/transports/createTransport.test.ts
@@ -22,6 +22,7 @@ test('default', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "request": [Function],
@@ -52,6 +53,7 @@ test('value', () => {
         "request": [MockFunction spy],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "mock",
       },
       "request": [Function],

diff --git a/src/clients/transports/createTransport.ts b/src/clients/transports/createTransport.ts
@@ -20,6 +20,8 @@ export type TransportConfig<
   retryDelay?: number
   /** The max number of times to retry. */
   retryCount?: number
+  /** The timeout (in ms) for requests. */
+  timeout?: number
   /** The type of the transport. */
   type: TType
 }
@@ -52,12 +54,13 @@ export function createTransport<
     request,
     retryCount = 3,
     retryDelay = 150,
+    timeout,
     type,
   }: TransportConfig<TType>,
   value?: TRpcAttributes,
 ): ReturnType<Transport<TType, TRpcAttributes>> {
   return {
-    config: { key, name, request, retryCount, retryDelay, type },
+    config: { key, name, request, retryCount, retryDelay, timeout, type },
     request: buildRequest(request, { retryCount, retryDelay }),
     value,
   }

diff --git a/src/clients/transports/custom.test.ts b/src/clients/transports/custom.test.ts
@@ -30,6 +30,7 @@ test('default', () => {
         "request": [Function],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "custom",
       },
       "request": [Function],
@@ -50,6 +51,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "request": [Function],
@@ -74,6 +76,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "request": [Function],
@@ -100,6 +103,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "type": "custom",
         },
         "request": [Function],

diff --git a/src/clients/transports/fallback.test.ts b/src/clients/transports/fallback.test.ts
@@ -23,6 +23,7 @@ test('default', () => {
         "request": [Function],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": undefined,
         "type": "fallback",
       },
       "request": [Function],
@@ -35,6 +36,7 @@ test('default', () => {
               "request": [Function],
               "retryCount": 0,
               "retryDelay": 150,
+              "timeout": 10000,
               "type": "http",
             },
             "request": [Function],
@@ -49,6 +51,7 @@ test('default', () => {
               "request": [Function],
               "retryCount": 0,
               "retryDelay": 150,
+              "timeout": 10000,
               "type": "http",
             },
             "request": [Function],
@@ -328,6 +331,7 @@ describe('client', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": undefined,
           "transports": [
             {
               "config": {
@@ -336,6 +340,7 @@ describe('client', () => {
                 "request": [Function],
                 "retryCount": 0,
                 "retryDelay": 150,
+                "timeout": 10000,
                 "type": "http",
               },
               "request": [Function],
@@ -350,6 +355,7 @@ describe('client', () => {
                 "request": [Function],
                 "retryCount": 0,
                 "retryDelay": 150,
+                "timeout": 10000,
                 "type": "http",
               },
               "request": [Function],

diff --git a/src/clients/transports/http.test.ts b/src/clients/transports/http.test.ts
@@ -1,6 +1,7 @@
 import { assertType, describe, expect, test } from 'vitest'
 
 import { localhost } from '../../chains'
+import { wait } from '../../utils/wait'
 import { createHttpServer } from '../../_test'
 
 import type { HttpTransport } from './http'
@@ -20,6 +21,7 @@ test('default', () => {
         "request": [Function],
         "retryCount": 3,
         "retryDelay": 150,
+        "timeout": 10000,
         "type": "http",
       },
       "request": [Function],
@@ -44,6 +46,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
         },
         "request": [Function],
@@ -67,6 +70,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
         },
         "request": [Function],
@@ -88,6 +92,7 @@ describe('config', () => {
           "request": [Function],
           "retryCount": 3,
           "retryDelay": 150,
+          "timeout": 10000,
           "type": "http",
         },
         "request": [Function],
@@ -172,6 +177,34 @@ describe('request', () => {
       `)
     expect(end > 500 && end < 520).toBeTruthy()
   })
+
+  test('behavior: timeout', async () => {
+    const server = await createHttpServer(async (req, res) => {
+      await wait(5000)
+      res.writeHead(500, {
+        'Content-Type': 'application/json',
+      })
+      res.end(JSON.stringify({}))
+    })
+
+    const transport = http(server.url, {
+      key: 'jsonRpc',
+      name: 'JSON RPC',
+      timeout: 100,
+    })({ chain: localhost })
+
+    await expect(() =>
+      transport.request({ method: 'eth_blockNumber' }),
+    ).rejects.toThrowErrorMatchingInlineSnapshot(`
+      "The request took too long to respond.
+
+      URL: http://localhost
+      Request body: {\\"method\\":\\"eth_blockNumber\\"}
+
+      Details: The request timed out.
+      Version: [email protected]"
+    `)
+  })
 })
 
 test('no url', () => {