REFACTOR: Remove dead code, fix comments (#4057)

tlimoncelli · matteocontrini · web-flow · commit f38e12c87fd3 · 2026-02-06T09:42:49.000-05:00
Co-authored-by: Matteo Contrini &lt;matteo@contrini.it&gt;
diff --git a/pkg/diff2/groupsort.go b/pkg/diff2/groupsort.go
diff --git a/pkg/providers/providers.go b/pkg/providers/providers.go
@@ -193,11 +193,6 @@ func (n None) GetZoneRecordsCorrections(dc *models.DomainConfig, records models.
 	return nil, 0, nil
 }
 
-// GetDomainCorrections returns corrections to update a domain.
-func (n None) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
-	return nil, nil
-}
-
 var featuresNone = DocumentationNotes{
 	// The default for unlisted capabilities is 'Cannot'.
 	// See providers/capabilities.go for the entire list of capabilities.
diff --git a/pkg/txtutil/txtcombined.go b/pkg/txtutil/txtcombined.go
diff --git a/providers/cloudns/cloudnsProvider.go b/providers/cloudns/cloudnsProvider.go
@@ -96,43 +96,6 @@ func (c *cloudnsProvider) GetNameservers(domain string) ([]*models.Nameserver, e
 	return models.ToNameservers(names)
 }
 
-// // GetDomainCorrections returns the corrections for a domain.
-// func (c *cloudnsProvider) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
-// 	dc, err := dc.Copy()
-// 	if err != nil {
-// 		return nil, err
-// 	}
-
-// 	dc.Punycode()
-
-// 	if c.domainIndex == nil {
-// 		if err := c.fetchDomainList(); err != nil {
-// 			return nil, err
-// 		}
-// 	}
-// 	_, ok := c.domainIndex[dc.Name]
-// 	if !ok {
-// 		return nil, fmt.Errorf("'%s' not a zone in ClouDNS account", dc.Name)
-// 	}
-
-// 	existingRecords, err := c.GetZoneRecords(dc.Name)
-// 	if err != nil {
-// 		return nil, err
-// 	}
-// 	// Normalize
-// 	models.PostProcessRecords(existingRecords)
-
-// 	// Get a list of available TTL values.
-// 	// The TTL list needs to be obtained for each domain, so get it first here.
-// 	c.fetchAvailableTTLValues(dc.Name)
-// 	// ClouDNS can only be specified from a specific TTL list, so change the TTL in advance.
-// 	for _, record := range dc.Records {
-// 		record.TTL = fixTTL(record.TTL)
-// 	}
-
-// 	return c.GetZoneRecordsCorrections(dc, existingRecords)
-// }
-
 // GetZoneRecordsCorrections returns a list of corrections that will turn existing records into dc.Records.
 func (c *cloudnsProvider) GetZoneRecordsCorrections(dc *models.DomainConfig, existingRecords models.Records) ([]*models.Correction, int, error) {
 	domainID, ok, err := c.idForDomain(dc.Name)
diff --git a/providers/cnr/nameservers.go b/providers/cnr/nameservers.go
@@ -61,7 +61,7 @@ func (n *Client) getNameserversRaw(domain string) ([]string, error) {
 	return ns, nil
 }
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (n *Client) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	nss, err := n.getNameserversRaw(dc.Name)
 	if err != nil {
diff --git a/providers/cscglobal/registrar.go b/providers/cscglobal/registrar.go
@@ -9,7 +9,7 @@ import (
 	"github.com/StackExchange/dnscontrol/v4/models"
 )
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (client *providerClient) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	nss, err := client.getNameservers(dc.Name)
 	if err != nil {
diff --git a/providers/desec/desecProvider.go b/providers/desec/desecProvider.go
@@ -77,29 +77,6 @@ func (c *desecProvider) GetNameservers(domain string) ([]*models.Nameserver, err
 	return models.ToNameservers(defaultNameServerNames)
 }
 
-// func (c *desecProvider) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
-// 	if dc.AutoDNSSEC == "off" {
-// 		printer.Printf("Notice: DNSSEC signing was not requested, but cannot be turned off. (deSEC always signs all records.)\n")
-// 	}
-
-// 	existing, err := c.GetZoneRecords(dc.Name)
-// 	if err != nil {
-// 		return nil, err
-// 	}
-// 	models.PostProcessRecords(existing)
-// 	clean := PrepFoundRecords(existing)
-// 	var minTTL uint32
-// 	c.mutex.Lock()
-// 	if ttl, ok := c.domainIndex[dc.Name]; !ok {
-// 		minTTL = 3600
-// 	} else {
-// 		minTTL = ttl
-// 	}
-// 	c.mutex.Unlock()
-// 	PrepDesiredRecords(dc, minTTL)
-// 	return c.GetZoneRecordsCorrections(dc, clean)
-// }
-
 // GetZoneRecords gets the records of a zone and returns them in RecordConfig format.
 func (c *desecProvider) GetZoneRecords(domain string, meta map[string]string) (models.Records, error) {
 	punycodeDomain, err := idna.ToASCII(domain)
diff --git a/providers/dnsimple/dnsimpleProvider.go b/providers/dnsimple/dnsimpleProvider.go
@@ -235,7 +235,6 @@ func (c *dnsimpleProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*
 		return nil, err
 	}
 	sort.Strings(nameServers)
-
 	actual := strings.Join(nameServers, ",")
 
 	var expectedSet []string
diff --git a/providers/dnsmadeeasy/dnsMadeEasyProvider.go b/providers/dnsmadeeasy/dnsMadeEasyProvider.go
@@ -68,42 +68,6 @@ func New(settings map[string]string, _ json.RawMessage) (providers.DNSServicePro
 	return api, nil
 }
 
-// // GetDomainCorrections returns the corrections for a domain.
-// func (api *dnsMadeEasyProvider) GetDomainCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
-// 	dc, err := dc.Copy()
-// 	if err != nil {
-// 		return nil, err
-// 	}
-
-// 	err = dc.Punycode()
-// 	if err != nil {
-// 		return nil, err
-// 	}
-
-// 	for _, rec := range dc.Records {
-// 		if rec.Type == "ALIAS" {
-// 			// ALIAS is called ANAME on DNS Made Easy
-// 			rec.Type = "ANAME"
-// 		} else if rec.Type == "NS" {
-// 			// NS records have fixed TTL on DNS Made Easy and it cannot be changed
-// 			rec.TTL = fixedNameServerRecordTTL
-// 		}
-// 	}
-
-// 	domainName := dc.Name
-
-// 	// Get existing records
-// 	existingRecords, err := api.GetZoneRecords(domainName)
-// 	if err != nil {
-// 		return nil, err
-// 	}
-
-// 	// Normalize
-// 	models.PostProcessRecords(existingRecords)
-
-// 	return api.GetZoneRecordsCorrections(dc, existingRecords)
-// }
-
 func (api *dnsMadeEasyProvider) GetZoneRecordsCorrections(dc *models.DomainConfig, existingRecords models.Records) ([]*models.Correction, int, error) {
 	domainName := dc.Name
 	domainID, err := api.findDomainID(domainName)
diff --git a/providers/doh/dohProvider.go b/providers/doh/dohProvider.go
@@ -40,7 +40,7 @@ func newDNSOverHTTPS(m map[string]string) (providers.Registrar, error) {
 	return api, nil
 }
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (c *dohProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	nss, err := c.getNameservers(dc.Name)
 	if err != nil {
@@ -58,7 +58,6 @@ func (c *dohProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*model
 	if foundNameservers == expectedNameservers {
 		return nil, nil
 	}
-
 	return []*models.Correction{
 		{
 			Msg: fmt.Sprintf("Update nameservers %s -> %s", foundNameservers, expectedNameservers),
diff --git a/providers/easyname/easynameProvider.go b/providers/easyname/easynameProvider.go
@@ -44,7 +44,7 @@ func newEasyname(m map[string]string) (providers.Registrar, error) {
 	return api, nil
 }
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (c *easynameProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	domain, err := c.getDomain(dc.Name)
 	if err != nil {
diff --git a/providers/gidinet/registrar.go b/providers/gidinet/registrar.go
@@ -35,6 +35,7 @@ func (c *gidinetProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*m
 		desired[i] = strings.ToLower(strings.TrimSuffix(ns, "."))
 	}
 	// Deduplicate nameservers (can happen when NAMESERVER() and DNS provider both add them)
+	// FUTURE(tlim): Remove deduplication logic.  The "existing" and "desired" lists are not merged, and "desired" is authoritative.
 	seen := make(map[string]bool)
 	var uniqueDesired []string
 	for _, ns := range desired {
diff --git a/providers/hexonet/nameservers.go b/providers/hexonet/nameservers.go
@@ -58,7 +58,7 @@ func (n *HXClient) getNameserversRaw(domain string) ([]string, error) {
 	return ns, nil
 }
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (n *HXClient) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	nss, err := n.getNameserversRaw(dc.Name)
 	if err != nil {
diff --git a/providers/hostingde/hostingdeProvider.go b/providers/hostingde/hostingdeProvider.go
@@ -325,11 +325,6 @@ func firstNonZero(items ...uint32) uint32 {
 }
 
 func (hp *hostingdeProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
-	// err := dc.Punycode()
-	// if err != nil {
-	// 	return nil, err
-	// }
-
 	found, err := hp.getNameservers(dc.Name)
 	if err != nil {
 		return nil, fmt.Errorf("error getting nameservers: %w", err)
diff --git a/providers/internetbs/internetbsProvider.go b/providers/internetbs/internetbsProvider.go
@@ -44,7 +44,7 @@ func newInternetBs(m map[string]string) (providers.Registrar, error) {
 	return api, nil
 }
 
-// GetRegistrarCorrections gathers corrections that would being n to match dc.
+// GetRegistrarCorrections gathers corrections that would bring n to match dc.
 func (c *internetbsProvider) GetRegistrarCorrections(dc *models.DomainConfig) ([]*models.Correction, error) {
 	nss, err := c.getNameservers(dc.Name)
 	if err != nil {
diff --git a/providers/namecheap/namecheapProvider.go b/providers/namecheap/namecheapProvider.go
diff --git a/providers/namedotcom/nameservers.go b/providers/namedotcom/nameservers.go

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ func (n *Client) getNameserversRaw(domain string) ([]string, error) {`
`61`	`61`	`return ns, nil`
`62`	`62`	`}`
`63`	`63`
`64`		`-// GetRegistrarCorrections gathers corrections that would being n to match dc.`
	`64`	`+// GetRegistrarCorrections gathers corrections that would bring n to match dc.`
`65`	`65`	`func (n Client) GetRegistrarCorrections(dc models.DomainConfig) ([]*models.Correction, error) {`
`66`	`66`	`nss, err := n.getNameserversRaw(dc.Name)`
`67`	`67`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"github.com/StackExchange/dnscontrol/v4/models"`
`10`	`10`	`)`
`11`	`11`
`12`		`-// GetRegistrarCorrections gathers corrections that would being n to match dc.`
	`12`	`+// GetRegistrarCorrections gathers corrections that would bring n to match dc.`
`13`	`13`	`func (client providerClient) GetRegistrarCorrections(dc models.DomainConfig) ([]*models.Correction, error) {`
`14`	`14`	`nss, err := client.getNameservers(dc.Name)`
`15`	`15`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,6 @@ func (c dnsimpleProvider) GetRegistrarCorrections(dc models.DomainConfig) ([]*`
`235`	`235`	`return nil, err`
`236`	`236`	`}`
`237`	`237`	`sort.Strings(nameServers)`
`238`		`-`
`239`	`238`	`actual := strings.Join(nameServers, ",")`
`240`	`239`
`241`	`240`	`var expectedSet []string`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func newDNSOverHTTPS(m map[string]string) (providers.Registrar, error) {`
`40`	`40`	`return api, nil`
`41`	`41`	`}`
`42`	`42`
`43`		`-// GetRegistrarCorrections gathers corrections that would being n to match dc.`
	`43`	`+// GetRegistrarCorrections gathers corrections that would bring n to match dc.`
`44`	`44`	`func (c dohProvider) GetRegistrarCorrections(dc models.DomainConfig) ([]*models.Correction, error) {`
`45`	`45`	`nss, err := c.getNameservers(dc.Name)`
`46`	`46`	`if err != nil {`
`@@ -58,7 +58,6 @@ func (c dohProvider) GetRegistrarCorrections(dc models.DomainConfig) ([]*model`
`58`	`58`	`if foundNameservers == expectedNameservers {`
`59`	`59`	`return nil, nil`
`60`	`60`	`}`
`61`		`-`
`62`	`61`	`return []*models.Correction{`
`63`	`62`	`{`
`64`	`63`	`Msg: fmt.Sprintf("Update nameservers %s -> %s", foundNameservers, expectedNameservers),`