refactor: rename HasDNSLinkRecord to GetDNSLinkRecord

examples/gateway/common/blocks.go

@@ -2,6 +2,7 @@ package common
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/http"
 	gopath "path"
@@ -143,6 +144,10 @@ func (api *BlocksGateway) GetIPNSRecord(ctx context.Context, c cid.Cid) ([]byte,
 	return nil, routing.ErrNotSupported
 }
 
+func (api *BlocksGateway) GetDNSLinkRecord(ctx context.Context, host string) (ifacepath.Path, error) {
+	return nil, errors.New("not implemented")
+}
+
 func (api *BlocksGateway) IsCached(ctx context.Context, p ifacepath.Path) bool {
 	rp, err := api.ResolvePath(ctx, p)
 	if err != nil {
@@ -188,11 +193,6 @@ func (api *BlocksGateway) ResolvePath(ctx context.Context, p ifacepath.Path) (if
 	return ifacepath.NewResolvedPath(ipath, node, root, gopath.Join(rest...)), nil
 }
 
-func (api *BlocksGateway) HasDNSLinkRecord(ctx context.Context, host string) bool {
-	// Not implemented.
-	return false
-}
-
 func (api *BlocksGateway) resolveNode(ctx context.Context, p ifacepath.Path) (format.Node, error) {
 	rp, err := api.ResolvePath(ctx, p)
 	if err != nil {

gateway/gateway.go

@@ -32,18 +32,19 @@ type API interface {
 	// from the routing system.
 	GetIPNSRecord(context.Context, cid.Cid) ([]byte, error)
 
+	// GetDNSLinkRecord returns the DNSLink TXT record for the provided FQDN.
+	// Unlike ResolvePath, it does not perform recursive resolution. It only
+	// checks for the existence of a DNSLink TXT record with path starting with
+	// /ipfs/ or /ipns/ and returns the path as-is.
+	GetDNSLinkRecord(context.Context, string) (path.Path, error)
+
 	// IsCached returns whether or not the path exists locally.
 	IsCached(context.Context, path.Path) bool
 
 	// ResolvePath resolves the path using UnixFS resolver. If the path does not
 	// exist due to a missing link, it should return an error of type:
 	// https://pkg.go.dev/github.com/ipfs/[email protected]/resolver#ErrNoLink
 	ResolvePath(context.Context, path.Path) (path.Resolved, error)
-
-	// HasDNSLinkRecord returns if the provided path has a DNSLink TXT record.
-	// It does not perform any validation, only checks for the existence of
-	// a DNSLink TXT record.
-	HasDNSLinkRecord(context.Context, string) bool
 }
 
 // A helper function to clean up a set of headers:

gateway/gateway_test.go

@@ -94,7 +94,10 @@ func (m *mockApi) ResolvePath(context.Context, ipath.Path) (ipath.Resolved, erro
 	return nil, errors.New("not implemented")
 }
 
-func (m *mockApi) HasDNSLinkRecord(ctx context.Context, hostname string) bool {
-	_, err := m.ns.Resolve(ctx, "/ipns/"+hostname, nsopts.Depth(1))
-	return err == nil || err == namesys.ErrResolveRecursion
+func (m *mockApi) GetDNSLinkRecord(ctx context.Context, hostname string) (ipath.Path, error) {
+	p, err := m.ns.Resolve(ctx, "/ipns/"+hostname, nsopts.Depth(1))
+	if err == namesys.ErrResolveRecursion {
+		err = nil
+	}
+	return ipath.New(p.String()), err
 }

gateway/hostname.go

@@ -268,7 +268,8 @@ func hasDNSLinkRecord(ctx context.Context, api API, host string) bool {
 		return false
 	}
 
-	return api.HasDNSLinkRecord(ctx, dnslinkName)
+	_, err := api.GetDNSLinkRecord(ctx, dnslinkName)
+	return err == nil
 }
 
 func isSubdomainNamespace(ns string) bool {