fix: remove client-side timeout from http rpc calls (#3178)

Do not set up a client-side timeout, instead rely on the server-side version. The global timeout is still respected, users can use an AbortSignal to do timeouts on a per-call basis if desired. Also brings refs API in line with go-IPFS - timeouts are recorded in the `.err` prop of the output instead of the whole API call throwing a `TimeoutError` fixes: #3161
ipfs · Sep 1, 2021 · 8a498fe · 8a498fe
1 parent 025914e
commit 8a498fe
Show file tree

Hide file tree

Showing 96 changed files with 12 additions and 100 deletions.
diff --git a/src/add-all.js b/src/add-all.js
@@ -43,7 +43,6 @@ module.exports = configure((api) => {
         ...options,
         progress: Boolean(progressFn)
       }),
-      timeout: options.timeout,
       onUploadProgress,
       signal,
       headers,

diff --git a/src/bitswap/stat.js b/src/bitswap/stat.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
   async function stat (options = {}) {
     const res = await api.post('bitswap/stat', {
       searchParams: toUrlSearchParams(options),
-      timeout: options.timeout,
       signal: options.signal,
       headers: options.headers
     })

diff --git a/src/bitswap/unwant.js b/src/bitswap/unwant.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function unwant (cid, options = {}) {
     const res = await api.post('bitswap/unwant', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cid.toString(),

diff --git a/src/bitswap/wantlist-for-peer.js b/src/bitswap/wantlist-for-peer.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function wantlistForPeer (peerId, options = {}) {
     const res = await (await api.post('bitswap/wantlist', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         ...options,

diff --git a/src/bitswap/wantlist.js b/src/bitswap/wantlist.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function wantlist (options = {}) {
     const res = await (await api.post('bitswap/wantlist', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/block/get.js b/src/block/get.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function get (cid, options = {}) {
     const res = await api.post('block/get', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cid.toString(),

diff --git a/src/block/put.js b/src/block/put.js
@@ -24,7 +24,6 @@ module.exports = configure(api => {
     let res
     try {
       const response = await api.post('block/put', {
-        timeout: options.timeout,
         signal: signal,
         searchParams: toUrlSearchParams(options),
         ...(

diff --git a/src/block/rm.js b/src/block/rm.js
@@ -20,7 +20,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('block/rm', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cid.map(cid => cid.toString()),

diff --git a/src/block/stat.js b/src/block/stat.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function stat (cid, options = {}) {
     const res = await api.post('block/stat', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cid.toString(),

diff --git a/src/bootstrap/add.js b/src/bootstrap/add.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function add (addr, options = {}) {
     const res = await api.post('bootstrap/add', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: addr,

diff --git a/src/bootstrap/clear.js b/src/bootstrap/clear.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function clear (options = {}) {
     const res = await api.post('bootstrap/rm', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         ...options,

diff --git a/src/bootstrap/list.js b/src/bootstrap/list.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function list (options = {}) {
     const res = await api.post('bootstrap/list', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/bootstrap/reset.js b/src/bootstrap/reset.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function reset (options = {}) {
     const res = await api.post('bootstrap/add', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         ...options,

diff --git a/src/bootstrap/rm.js b/src/bootstrap/rm.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function rm (addr, options = {}) {
     const res = await api.post('bootstrap/rm', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: addr,

diff --git a/src/cat.js b/src/cat.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function * cat (path, options = {}) {
     const res = await api.post('cat', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path.toString(),

diff --git a/src/commands.js b/src/commands.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   const commands = async (options = {}) => {
     const res = await api.post('commands', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/config/get.js b/src/config/get.js
@@ -18,7 +18,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('config', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: key,

diff --git a/src/config/getAll.js b/src/config/getAll.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   const getAll = async (options = {}) => {
     const res = await api.post('config/show', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         ...options

diff --git a/src/config/profiles/apply.js b/src/config/profiles/apply.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function apply (profile, options = {}) {
     const res = await api.post('config/profile/apply', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: profile,

diff --git a/src/config/profiles/list.js b/src/config/profiles/list.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function list (options = {}) {
     const res = await api.post('config/profile/list', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/config/replace.js b/src/config/replace.js
@@ -22,7 +22,6 @@ module.exports = configure(api => {
     const signal = abortSignal(controller.signal, options.signal)
 
     const res = await api.post('config/replace', {
-      timeout: options.timeout,
       signal,
       searchParams: toUrlSearchParams(options),
       ...(

diff --git a/src/config/set.js b/src/config/set.js
@@ -23,7 +23,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('config', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(params),
       headers: options.headers

diff --git a/src/dag/export.js b/src/dag/export.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function * dagExport (root, options = {}) {
     const res = await api.post('dag/export', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: root.toString()

diff --git a/src/dag/import.js b/src/dag/import.js
@@ -22,7 +22,6 @@ module.exports = configure(api => {
     const { headers, body } = await multipartRequest(source, controller, options.headers)
 
     const res = await api.post('dag/import', {
-      timeout: options.timeout,
       signal,
       headers,
       body,

diff --git a/src/dag/resolve.js b/src/dag/resolve.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   const resolve = async (ipfsPath, options = {}) => {
     const res = await api.post('dag/resolve', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: `${ipfsPath}${options.path ? `/${options.path}`.replace(/\/[/]+/g, '/') : ''}`,

diff --git a/src/dht/find-peer.js b/src/dht/find-peer.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
    */
   async function findPeer (peerId, options = {}) {
     const res = await api.post('dht/findpeer', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: peerId,

diff --git a/src/dht/find-provs.js b/src/dht/find-provs.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
    */
   async function * findProvs (cid, options = {}) {
     const res = await api.post('dht/findprovs', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cid.toString(),

diff --git a/src/dht/get.js b/src/dht/get.js
@@ -17,7 +17,6 @@ module.exports = configure(api => {
    */
   async function get (key, options = {}) {
     const res = await api.post('dht/get', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: key instanceof Uint8Array ? uint8ArrayToString(key) : key,

diff --git a/src/dht/provide.js b/src/dht/provide.js
@@ -20,7 +20,6 @@ module.exports = configure(api => {
     const cidArr = Array.isArray(cids) ? cids : [cids]
 
     const res = await api.post('dht/provide', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: cidArr.map(cid => cid.toString()),

diff --git a/src/dht/put.js b/src/dht/put.js
@@ -24,7 +24,6 @@ module.exports = configure(api => {
     const signal = abortSignal(controller.signal, options.signal)
 
     const res = await api.post('dht/put', {
-      timeout: options.timeout,
       signal,
       searchParams: toUrlSearchParams({
         arg: uint8ArrayToString(key),

diff --git a/src/dht/query.js b/src/dht/query.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
    */
   async function * query (peerId, options = {}) {
     const res = await api.post('dht/query', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: peerId.toString(),

diff --git a/src/diag/cmds.js b/src/diag/cmds.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function cmds (options = {}) {
     const res = await api.post('diag/cmds', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/diag/net.js b/src/diag/net.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function net (options = {}) {
     const res = await api.post('diag/net', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/diag/sys.js b/src/diag/sys.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function sys (options = {}) {
     const res = await api.post('diag/sys', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(options),
       headers: options.headers

diff --git a/src/dns.js b/src/dns.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   const dns = async (domain, options = {}) => {
     const res = await api.post('dns', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: domain,

diff --git a/src/files/chmod.js b/src/files/chmod.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function chmod (path, mode, options = {}) {
     const res = await api.post('files/chmod', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/cp.js b/src/files/cp.js
@@ -18,7 +18,6 @@ module.exports = configure(api => {
     const sourceArr = Array.isArray(sources) ? sources : [sources]
 
     const res = await api.post('files/cp', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: sourceArr.concat(destination).map(src => src instanceof CID ? `/ipfs/${src}` : src),

diff --git a/src/files/flush.js b/src/files/flush.js
@@ -19,7 +19,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('files/flush', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/ls.js b/src/files/ls.js
@@ -19,7 +19,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('files/ls', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path instanceof CID ? `/ipfs/${path}` : path,

diff --git a/src/files/mkdir.js b/src/files/mkdir.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function mkdir (path, options = {}) {
     const res = await api.post('files/mkdir', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/mv.js b/src/files/mv.js
@@ -18,7 +18,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('files/mv', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: sources.concat(destination),

diff --git a/src/files/read.js b/src/files/read.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
    */
   async function * read (path, options = {}) {
     const res = await api.post('files/read', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/rm.js b/src/files/rm.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function rm (path, options = {}) {
     const res = await api.post('files/rm', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/stat.js b/src/files/stat.js
@@ -23,7 +23,6 @@ module.exports = configure(api => {
     options = options || {}
 
     const res = await api.post('files/stat', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/touch.js b/src/files/touch.js
@@ -14,7 +14,6 @@ module.exports = configure(api => {
    */
   async function touch (path, options = {}) {
     const res = await api.post('files/touch', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/files/write.js b/src/files/write.js
@@ -23,7 +23,6 @@ module.exports = configure(api => {
     const signal = abortSignal(controller.signal, options.signal)
 
     const res = await api.post('files/write', {
-      timeout: options.timeout,
       signal,
       searchParams: toUrlSearchParams({
         arg: path,

diff --git a/src/get.js b/src/get.js
@@ -26,7 +26,6 @@ module.exports = configure(api => {
     }
 
     const res = await api.post('get', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams(opts),
       headers: options.headers

diff --git a/src/id.js b/src/id.js
@@ -16,7 +16,6 @@ module.exports = configure(api => {
    */
   async function id (options = {}) {
     const res = await api.post('id', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: options.peerId ? options.peerId.toString() : undefined,

diff --git a/src/key/gen.js b/src/key/gen.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function gen (name, options = { type: 'rsa', size: 2048 }) {
     const res = await api.post('key/gen', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: name,

diff --git a/src/key/import.js b/src/key/import.js
@@ -15,7 +15,6 @@ module.exports = configure(api => {
    */
   async function importKey (name, pem, password, options = {}) {
     const res = await api.post('key/import', {
-      timeout: options.timeout,
       signal: options.signal,
       searchParams: toUrlSearchParams({
         arg: name,