mirror of
https://github.com/coredns/coredns.git
synced 2025-10-31 10:13:14 -04:00
d8a0d97df2
* deprecate normalize and mustnormalize Signed-off-by: Chris O'Haver <cohaver@infoblox.com> * add runtime warning Signed-off-by: Chris O'Haver <cohaver@infoblox.com> * elaborate runtime warning Signed-off-by: Chris O'Haver <cohaver@infoblox.com> * include caller info Signed-off-by: Chris O'Haver <cohaver@infoblox.com>
72 lines
2.1 KiB
Go
72 lines
2.1 KiB
Go
// Package fall handles the fallthrough logic used in plugins that support it. Be careful when including this
|
|
// functionality in your plugin. Why? In the DNS only 1 source is authoritative for a set of names. Fallthrough
|
|
// breaks this convention by allowing a plugin to query multiple sources, depending on the replies it got sofar.
|
|
//
|
|
// This may cause issues in downstream caches, where different answers for the same query can potentially confuse clients.
|
|
// On the other hand this is a powerful feature that can aid in migration or other edge cases.
|
|
//
|
|
// The take away: be mindful of this and don't blindly assume it's a good feature to have in your plugin.
|
|
//
|
|
// See https://github.com/coredns/coredns/issues/2723 for some discussion on this, which includes this quote:
|
|
//
|
|
// TL;DR: `fallthrough` is indeed risky and hackish, but still a good feature of CoreDNS as it allows to quickly answer boring edge cases.
|
|
//
|
|
package fall
|
|
|
|
import (
|
|
"github.com/coredns/coredns/plugin"
|
|
)
|
|
|
|
// F can be nil to allow for no fallthrough, empty allow all zones to fallthrough or
|
|
// contain a zone list that is checked.
|
|
type F struct {
|
|
Zones []string
|
|
}
|
|
|
|
// Through will check if we should fallthrough for qname. Note that we've named the
|
|
// variable in each plugin "Fall", so this then reads Fall.Through().
|
|
func (f F) Through(qname string) bool {
|
|
return plugin.Zones(f.Zones).Matches(qname) != ""
|
|
}
|
|
|
|
// setZones will set zones in f.
|
|
func (f *F) setZones(zones []string) {
|
|
z := []string{}
|
|
for i := range zones {
|
|
z = append(z, plugin.Host(zones[i]).NormalizeExact()...)
|
|
}
|
|
f.Zones = z
|
|
}
|
|
|
|
// SetZonesFromArgs sets zones in f to the passed value or to "." if the slice is empty.
|
|
func (f *F) SetZonesFromArgs(zones []string) {
|
|
if len(zones) == 0 {
|
|
f.setZones(Root.Zones)
|
|
return
|
|
}
|
|
f.setZones(zones)
|
|
}
|
|
|
|
// Equal returns true if f and g are equal.
|
|
func (f *F) Equal(g F) bool {
|
|
if len(f.Zones) != len(g.Zones) {
|
|
return false
|
|
}
|
|
for i := range f.Zones {
|
|
if f.Zones[i] != g.Zones[i] {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
|
|
// Zero returns a zero valued F.
|
|
var Zero = func() F {
|
|
return F{[]string{}}
|
|
}()
|
|
|
|
// Root returns F set to only ".".
|
|
var Root = func() F {
|
|
return F{[]string{"."}}
|
|
}()
|