Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: return gateway href in .info response #850

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/kubo/daemon.ts
Original file line number Diff line number Diff line change
@@ -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'
@@ -91,7 +91,8 @@ export default class KuboDaemon implements KuboNode {
peerId: id?.id.toString(),
multiaddrs: (id?.addresses ?? []).map(ma => ma.toString()),
api: checkForRunningApi(this.repo),
repo: this.repo
repo: this.repo,
gateway: getGatewayAddress(this.repo)
}
}

1 change: 1 addition & 0 deletions src/kubo/index.ts
Original file line number Diff line number Diff line change
@@ -75,6 +75,7 @@ export interface KuboInfo {
multiaddrs: string[]
api?: string
repo: string
gateway: string
}

export interface KuboNode extends Node<KuboRPCClient, KuboOptions, KuboInfo, KuboInitOptions, KuboStartOptions, KuboStopOptions> {
15 changes: 15 additions & 0 deletions src/kubo/utils.ts
Original file line number Diff line number Diff line change
@@ -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()}`)
}
21 changes: 21 additions & 0 deletions test/controller.spec.ts
Original file line number Diff line number Diff line change
@@ -208,4 +208,25 @@ describe('Node API', function () {
}
})
})

describe('info', () => {
describe('should return the node info', () => {
for (const opts of types) {
it(`type: ${opts.type} remote: ${Boolean(opts.remote)}`, async () => {
const node = await factory.spawn(opts)
const info = await node.info()

expect(info).to.have.property('version').that.is.a('string')
expect(info).to.have.property('api').that.is.a('string')
expect(info).to.have.property('peerId').that.is.a('string')
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(/http:\/\/127.0.0.1:\d+/)

await node.stop()
})
}
})
})
})
2 changes: 2 additions & 0 deletions test/endpoint/routes.node.ts
Original file line number Diff line number Diff line change
@@ -109,6 +109,8 @@ describe('routes', function () {
expect(res.result).to.have.property('api').that.is.a('string')
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').that.matches(/http:\/\/127.0.0.1:\d+/)
})

it('should return 400', async () => {