interface-ipfs-core/src/miscellaneous/dns.js

A test suite and interface you can use to implement a IPFS core interface.

/* eslint-env mocha */

import { expect } from 'aegir/chai'
import { getDescribe, getIt } from '../utils/mocha.js'

/**
 * @typedef {import('ipfsd-ctl').Factory} Factory
 */

/**
 * @param {Factory} factory
 * @param {object} options
 */
export function testDns (factory, options) {
  const describe = getDescribe(options)
  const it = getIt(options)

  describe('.dns', function () {
    this.timeout(60 * 1000)
    this.retries(3)

    /** @type {import('ipfs-core-types').IPFS} */
    let ipfs

    before(async () => {
      ipfs = (await factory.spawn()).api
    })

    after(() => factory.clean())

    it('should non-recursively resolve ipfs.io', async function () {
      const domain = 'ipfs.io'

      try {
        const res = await ipfs.dns(domain, { recursive: false })

        // matches pattern /ipns/<ipnsaddress>
        expect(res).to.match(/\/ipns\/.+$/)
      } catch (/** @type {any} */ err) {
        if (err.message.includes('could not resolve name')) {
          return this.skip()
        }

        // happens when running tests offline
        if (err.message.includes(`ECONNREFUSED ${domain}`)) {
          return this.skip()
        }

        throw err
      }
    })

    it('should recursively resolve ipfs.io', async function () {
      const domain = 'ipfs.io'

      try {
        const res = await ipfs.dns(domain, { recursive: true })

        // matches pattern /ipfs/<hash>
        expect(res).to.match(/\/ipfs\/.+$/)
      } catch (/** @type {any} */ err) {
        if (err.message.includes('could not resolve name')) {
          return this.skip()
        }

        // happens when running tests offline
        if (err.message.includes(`ECONNREFUSED ${domain}`)) {
          return this.skip()
        }

        throw err
      }
    })

    it('should resolve subdomain docs.ipfs.io', async function () {
      const domain = 'docs.ipfs.io'

      try {
        const res = await ipfs.dns(domain)

        // matches pattern /ipfs/<hash>
        expect(res).to.match(/\/ipfs\/.+$/)
      } catch (/** @type {any} */ err) {
        if (err.message.includes('could not resolve name')) {
          return this.skip()
        }

        // happens when running tests offline
        if (err.message.includes(`ECONNREFUSED ${domain}`)) {
          return this.skip()
        }

        throw err
      }
    })
  })
}