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

packages/interface-ipfs-core/src/refs.js

@@ -323,8 +323,7 @@ function getRefsTests () {
     'should print nothing for non-existent hashes': {
       path: () => 'QmYmW4HiZhotsoSqnv2o1oSssvkRM8b9RweBoH7ao5nki2',
       params: { timeout: 2000 },
-      expected: [],
-      expectTimeout: true
+      expected: ['']
     }
   }
 }

packages/ipfs-core/package.json

@@ -62,6 +62,7 @@
     "@ipld/dag-pb": "^2.1.3",
     "@multiformats/murmur3": "^1.0.1",
     "abort-controller": "^3.0.0",
+    "any-signal": "^2.1.2",
     "array-shuffle": "^2.0.0",
     "blockstore-datastore-adapter": "^1.0.0",
     "datastore-core": "^5.0.1",
@@ -126,6 +127,7 @@
     "parse-duration": "^1.0.0",
     "peer-id": "^0.15.1",
     "streaming-iterables": "^6.0.0",
+    "timeout-abort-controller": "^1.1.1",
     "uint8arrays": "^3.0.0"
   },
   "devDependencies": {

packages/ipfs-core/src/components/refs/index.js

@@ -3,9 +3,11 @@
 const dagPb = require('@ipld/dag-pb')
 const { Errors } = require('interface-datastore')
 const ERR_NOT_FOUND = Errors.notFoundError().code
-const withTimeoutOption = require('ipfs-core-utils/src/with-timeout-option')
 const toCIDAndPath = require('ipfs-core-utils/src/to-cid-and-path')
 const { CID } = require('multiformats/cid')
+// @ts-expect-error no types
+const TimeoutController = require('timeout-abort-controller')
+const { anySignal } = require('any-signal')
 
 const Format = {
   default: '<dst>',
@@ -21,6 +23,8 @@ const Format = {
  * @property {Node} parent
  * @property {Node} node
  * @property {boolean} isDuplicate
+ *
+ * @typedef {import('ipfs-core-types/src/utils').AbortOptions} AbortOptions
  */
 
 /**
@@ -49,17 +53,30 @@ module.exports = function ({ repo, codecs, resolve, preload }) {
       options.maxDepth = options.recursive ? Infinity : 1
     }
 
+    if (options.timeout) {
+      const controller = new TimeoutController(options.timeout)
+
+      options.signal = anySignal([options.signal, controller.signal])
+    }
+
     /** @type {(string|CID)[]} */
     const rawPaths = Array.isArray(ipfsPath) ? ipfsPath : [ipfsPath]
 
     const paths = rawPaths.map(p => getFullPath(preload, p, options))
 
     for (const path of paths) {
-      yield * refsStream(resolve, repo, codecs, path, options)
+      try {
+        yield * refsStream(resolve, repo, codecs, path, options)
+      } catch (err) {
+        yield {
+          ref: '',
+          err: err.message
+        }
+      }
     }
   }
 
-  return withTimeoutOption(refs)
+  return refs
 }
 
 module.exports.Format = Format
@@ -93,7 +110,7 @@ function getFullPath (preload, ipfsPath, options) {
  */
 async function * refsStream (resolve, repo, codecs, path, options) {
   // Resolve to the target CID of the path
-  const resPath = await resolve(path)
+  const resPath = await resolve(path, options)
   const {
     cid
   } = toCIDAndPath(resPath)
@@ -102,7 +119,7 @@ async function * refsStream (resolve, repo, codecs, path, options) {
   const unique = options.unique || false
 
   // Traverse the DAG, converting it into a stream
-  for await (const obj of objectStream(repo, codecs, cid, maxDepth, unique)) {
+  for await (const obj of objectStream(repo, codecs, cid, maxDepth, unique, options)) {
     // Root object will not have a parent
     if (!obj.parent) {
       continue
@@ -144,8 +161,9 @@ function formatLink (srcCid, dstCid, linkName = '', format = Format.default) {
  * @param {CID} rootCid
  * @param {number} maxDepth
  * @param {boolean} uniqueOnly
+ * @param {AbortOptions} options
  */
-async function * objectStream (repo, codecs, rootCid, maxDepth, uniqueOnly) { // eslint-disable-line require-await
+async function * objectStream (repo, codecs, rootCid, maxDepth, uniqueOnly, options) { // eslint-disable-line require-await
   const seen = new Set()
 
   /**
@@ -164,7 +182,7 @@ async function * objectStream (repo, codecs, rootCid, maxDepth, uniqueOnly) { //
     // Get this object's links
     try {
       // Look at each link, parent and the new depth
-      for await (const link of getLinks(repo, codecs, parent.cid)) {
+      for await (const link of getLinks(repo, codecs, parent.cid, options)) {
         yield {
           parent: parent,
           node: link,
@@ -195,14 +213,16 @@ async function * objectStream (repo, codecs, rootCid, maxDepth, uniqueOnly) { //
  * @param {import('ipfs-repo').IPFSRepo} repo
  * @param {import('ipfs-core-utils/src/multicodecs')} codecs
  * @param {CID} cid
- * @param {Array<string|number>} base
+ * @param {AbortOptions} options
  * @returns {AsyncGenerator<{ name: string, cid: CID }, void, undefined>}
  */
-async function * getLinks (repo, codecs, cid, base = []) {
-  const block = await repo.blocks.get(cid)
+async function * getLinks (repo, codecs, cid, options) {
+  const block = await repo.blocks.get(cid, options)
   const codec = await codecs.getCodec(cid.code)
   const value = codec.decode(block)
   const isDagPb = cid.code === dagPb.code
+  /** @type {Array<string|number>} */
+  const base = []
 
   for (const [name, cid] of links(value, base)) {
     // special case for dag-pb - use the name of the link

packages/ipfs-http-client/src/add-all.js

@@ -43,7 +43,6 @@ module.exports = configure((api) => {
         ...options,
         progress: Boolean(progressFn)
       }),
-      timeout: options.timeout,
       onUploadProgress,
       signal,
       headers,

packages/ipfs-http-client/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
     })

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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,

packages/ipfs-http-client/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

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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),
         ...(

packages/ipfs-http-client/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()),

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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,

packages/ipfs-http-client/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,

packages/ipfs-http-client/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

packages/ipfs-http-client/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,

packages/ipfs-http-client/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,

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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

packages/ipfs-http-client/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,

packages/ipfs-http-client/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

packages/ipfs-http-client/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,

packages/ipfs-http-client/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

packages/ipfs-http-client/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),
       ...(

packages/ipfs-http-client/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

packages/ipfs-http-client/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()

packages/ipfs-http-client/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,

packages/ipfs-http-client/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, '/') : ''}`,

packages/ipfs-http-client/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,

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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,

packages/ipfs-http-client/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()),

packages/ipfs-http-client/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),

packages/ipfs-http-client/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(),

packages/ipfs-http-client/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