fix: use REPO_PATH/gateway file for gateway address

Author: SgtPooki

src/kubo/daemon.ts

@@ -4,7 +4,7 @@ import { execa, type ResultPromise } from 'execa'
 import mergeOptions from 'merge-options'
 import pDefer from 'p-defer'
 import waitFor from 'p-wait-for'
-import { checkForRunningApi, tmpDir, buildStartArgs, repoExists, buildInitArgs } from './utils.js'
+import { checkForRunningApi, tmpDir, buildStartArgs, repoExists, buildInitArgs, getGatewayAddress } from './utils.js'
 import type { KuboNode, KuboInfo, KuboInitOptions, KuboOptions, KuboStartOptions, KuboStopOptions } from './index.js'
 import type { Logger } from '@libp2p/interface'
 import type { KuboRPCClient } from 'kubo-rpc-client'
@@ -27,7 +27,6 @@ export default class KuboDaemon implements KuboNode {
   private readonly disposable: boolean
   private subprocess?: ResultPromise
   private _api?: KuboRPCClient
-  private _gateway?: string
   private readonly repo: string
   private readonly stdout: Logger
   private readonly stderr: Logger
@@ -93,7 +92,7 @@ export default class KuboDaemon implements KuboNode {
       multiaddrs: (id?.addresses ?? []).map(ma => ma.toString()),
       api: checkForRunningApi(this.repo),
       repo: this.repo,
-      gateway: this._gateway ?? ''
+      gateway: getGatewayAddress(this.repo)
     }
   }
 
@@ -204,16 +203,11 @@ export default class KuboDaemon implements KuboNode {
     const readyHandler = (data: Buffer): void => {
       output += data.toString()
       const apiMatch = output.trim().match(/API .*listening on:? (.*)/)
-      const gwMatch = output.trim().match(/Gateway .*listening on:? (.*)/)
 
       if ((apiMatch != null) && apiMatch.length > 0) {
         this._api = this.options.rpc(apiMatch[1])
       }
 
-      if ((gwMatch != null) && gwMatch.length > 0) {
-        this._gateway = gwMatch[1]
-      }
-
       if (output.match(/(?:daemon is running|Daemon is ready)/) != null) {
         // we're good
         stdout.off('data', readyHandler)

src/kubo/utils.ts

@@ -32,6 +32,21 @@ export const checkForRunningApi = (repoPath = ''): string | undefined => {
   return (api != null) ? api.toString() : undefined
 }
 
+export const getGatewayAddress = (repoPath = ''): string => {
+  let gatewayAddress = ''
+  try {
+    /**
+     * Note that this file is only created by Kubo versions >=v0.15.0, which came out in 2022
+     *
+     * @see https://github.com/ipfs/kubo/blob/720663d7c8f9971d34f85bd4c02a256da2d56a25/docs/changelogs/v0.15.md?plain=1#L56
+     */
+    gatewayAddress = fs.readFileSync(path.join(repoPath, 'gateway'))?.toString()
+  } catch (err: any) {
+    log('Unable to open gateway file')
+  }
+  return gatewayAddress
+}
+
 export const tmpDir = (type = ''): string => {
   return path.join(os.tmpdir(), `${type}_ipfs_${nanoid()}`)
 }

test/controller.spec.ts

@@ -222,7 +222,7 @@ describe('Node API', function () {
           expect(info).to.have.property('repo').that.is.a('string')
           expect(info).to.have.property('pid').that.is.a('number')
           expect(info).to.have.property('multiaddrs').that.is.an('array')
-          expect(info).to.have.property('gateway').that.is.a('string').that.matches(/\/ip4\/127\.0\.0\.1\/tcp\/\d+/)
+          expect(info).to.have.property('gateway').that.is.a('string').that.matches(/http:\/\/127.0.0.1:\d+/)
 
           await node.stop()
         })

test/endpoint/routes.node.ts

@@ -110,7 +110,7 @@ describe('routes', function () {
       expect(res.result).to.have.property('repo').that.is.a('string')
       expect(res.result).to.have.property('multiaddrs').that.is.an('array')
       expect(res.result).to.have.property('peerId').that.is.a('string')
-      expect(res.result).to.have.property('gateway').that.is.a('string')
+      expect(res.result).to.have.property('gateway').that.is.a('string').that.matches(/http:\/\/127.0.0.1:\d+/)
     })
 
     it('should return 400', async () => {