From 6b9d938c1aad13b25ebc9fa5e7e9b748e7df96fa Mon Sep 17 00:00:00 2001 From: Maisem Ali Date: Wed, 16 Mar 2022 21:45:19 -0700 Subject: [PATCH] types/views: add generic Slice[T] and remove StringSlice Also make IPPrefixSliceOf use Slice[netaddr.IPPrefix] as it also provides additional functions besides the standard ones provided by Slice[T]. Signed-off-by: Maisem Ali --- ipn/ipnlocal/local.go | 4 +-- ipn/ipnstate/ipnstate.go | 2 +- tailcfg/tailcfg.go | 8 ++--- types/views/views.go | 70 ++++++++++++++++++--------------------- types/views/views_test.go | 16 +++++---- 5 files changed, 48 insertions(+), 52 deletions(-) diff --git a/ipn/ipnlocal/local.go b/ipn/ipnlocal/local.go index c17ffe7f9..bcad6c64a 100644 --- a/ipn/ipnlocal/local.go +++ b/ipn/ipnlocal/local.go @@ -444,10 +444,10 @@ func (b *LocalBackend) populatePeerStatusLocked(sb *ipnstate.StatusBuilder) { exitNodeOption := tsaddr.PrefixesContainsFunc(p.AllowedIPs, func(r netaddr.IPPrefix) bool { return r.Bits() == 0 }) - var tags *views.StringSlice + var tags *views.Slice[string] var primaryRoutes *views.IPPrefixSlice if p.Tags != nil { - v := views.StringSliceOf(p.Tags) + v := views.SliceOf(p.Tags) tags = &v } if p.PrimaryRoutes != nil { diff --git a/ipn/ipnstate/ipnstate.go b/ipn/ipnstate/ipnstate.go index 7a333be3e..401bccee9 100644 --- a/ipn/ipnstate/ipnstate.go +++ b/ipn/ipnstate/ipnstate.go @@ -112,7 +112,7 @@ type PeerStatus struct { // Tags are the list of ACL tags applied to this node. // See tailscale.com/tailcfg#Node.Tags for more information. - Tags *views.StringSlice `json:",omitempty"` + Tags *views.Slice[string] `json:",omitempty"` // PrimaryRoutes are the routes this node is currently the primary // subnet router for, as determined by the control plane. It does diff --git a/tailcfg/tailcfg.go b/tailcfg/tailcfg.go index 3d8909d9e..4273f79c6 100644 --- a/tailcfg/tailcfg.go +++ b/tailcfg/tailcfg.go @@ -527,12 +527,12 @@ func (v HostinfoView) RoutableIPs() views.IPPrefixSlice { return views.IPPrefixSliceOf(v.ж.RoutableIPs) } -func (v HostinfoView) RequestTags() views.StringSlice { - return views.StringSliceOf(v.ж.RequestTags) +func (v HostinfoView) RequestTags() views.Slice[string] { + return views.SliceOf(v.ж.RequestTags) } -func (v HostinfoView) SSH_HostKeys() views.StringSlice { - return views.StringSliceOf(v.ж.SSH_HostKeys) +func (v HostinfoView) SSH_HostKeys() views.Slice[string] { + return views.SliceOf(v.ж.SSH_HostKeys) } func (v HostinfoView) Services() ServiceSlice { diff --git a/types/views/views.go b/types/views/views.go index b930d359f..7a18c4459 100644 --- a/types/views/views.go +++ b/types/views/views.go @@ -14,25 +14,25 @@ "tailscale.com/net/tsaddr" ) -// StringSlice is a read-only accessor for a slice of strings. -type StringSlice struct { +// Slice is a read-only accessor for a slice. +type Slice[T any] struct { // It is named distinctively to make you think of how dangerous it is to escape // to callers. You must not let callers be able to mutate it. - ж []string + ж []T } -// StringSliceOf returns a StringSlice for the provided slice. -func StringSliceOf(x []string) StringSlice { return StringSlice{x} } +// SliceOf returns a Slice for the provided slice. +func SliceOf[T any](x []T) Slice[T] { return Slice[T]{x} } // MarshalJSON implements json.Marshaler. -func (v StringSlice) MarshalJSON() ([]byte, error) { +func (v Slice[T]) MarshalJSON() ([]byte, error) { return json.Marshal(v.ж) } // UnmarshalJSON implements json.Unmarshaler. -func (v *StringSlice) UnmarshalJSON(b []byte) error { +func (v *Slice[T]) UnmarshalJSON(b []byte) error { if v.ж != nil { - return errors.New("StringSlice is already initialized") + return errors.New("Slice is already initialized") } if len(b) == 0 { return nil @@ -44,83 +44,77 @@ func (v *StringSlice) UnmarshalJSON(b []byte) error { } // IsNil reports whether the underlying slice is nil. -func (v StringSlice) IsNil() bool { return v.ж == nil } +func (v Slice[T]) IsNil() bool { return v.ж == nil } // Len returns the length of the slice. -func (v StringSlice) Len() int { return len(v.ж) } +func (v Slice[T]) Len() int { return len(v.ж) } -// At returns the string at index `i` of the slice. -func (v StringSlice) At(i int) string { return v.ж[i] } +// At returns the element at index `i` of the slice. +func (v Slice[T]) At(i int) T { return v.ж[i] } // AppendTo appends the underlying slice values to dst. -func (v StringSlice) AppendTo(dst []string) []string { +func (v Slice[T]) AppendTo(dst []T) []T { return append(dst, v.ж...) } // AsSlice returns a copy of underlying slice. -func (v StringSlice) AsSlice() []string { +func (v Slice[T]) AsSlice() []T { return v.AppendTo(v.ж[:0:0]) } // IPPrefixSlice is a read-only accessor for a slice of netaddr.IPPrefix. type IPPrefixSlice struct { - // It is named distinctively to make you think of how dangerous it is to escape - // to callers. You must not let callers be able to mutate it.jd - ж []netaddr.IPPrefix + ж Slice[netaddr.IPPrefix] } // IPPrefixSliceOf returns a IPPrefixSlice for the provided slice. -func IPPrefixSliceOf(x []netaddr.IPPrefix) IPPrefixSlice { return IPPrefixSlice{x} } +func IPPrefixSliceOf(x []netaddr.IPPrefix) IPPrefixSlice { return IPPrefixSlice{SliceOf(x)} } // IsNil reports whether the underlying slice is nil. -func (v IPPrefixSlice) IsNil() bool { return v.ж == nil } +func (v IPPrefixSlice) IsNil() bool { return v.ж.IsNil() } // Len returns the length of the slice. -func (v IPPrefixSlice) Len() int { return len(v.ж) } +func (v IPPrefixSlice) Len() int { return v.ж.Len() } // At returns the IPPrefix at index `i` of the slice. -func (v IPPrefixSlice) At(i int) netaddr.IPPrefix { return v.ж[i] } +func (v IPPrefixSlice) At(i int) netaddr.IPPrefix { return v.ж.At(i) } -// Append appends the underlying slice values to dst. +// AppendTo appends the underlying slice values to dst. func (v IPPrefixSlice) AppendTo(dst []netaddr.IPPrefix) []netaddr.IPPrefix { - return append(dst, v.ж...) + return v.ж.AppendTo(dst) +} + +// Generic returns the underlying Slice[netaddr.IPPrefix]. +func (v IPPrefixSlice) Generic() Slice[netaddr.IPPrefix] { + return v.ж } // AsSlice returns a copy of underlying slice. func (v IPPrefixSlice) AsSlice() []netaddr.IPPrefix { - return v.AppendTo(v.ж[:0:0]) + return v.ж.AsSlice() } // PrefixesContainsIP reports whether any IPPrefix contains IP. func (v IPPrefixSlice) ContainsIP(ip netaddr.IP) bool { - return tsaddr.PrefixesContainsIP(v.ж, ip) + return tsaddr.PrefixesContainsIP(v.ж.ж, ip) } // PrefixesContainsFunc reports whether f is true for any IPPrefix in the slice. func (v IPPrefixSlice) ContainsFunc(f func(netaddr.IPPrefix) bool) bool { - return tsaddr.PrefixesContainsFunc(v.ж, f) + return tsaddr.PrefixesContainsFunc(v.ж.ж, f) } // ContainsExitRoutes reports whether v contains ExitNode Routes. func (v IPPrefixSlice) ContainsExitRoutes() bool { - return tsaddr.ContainsExitRoutes(v.ж) + return tsaddr.ContainsExitRoutes(v.ж.ж) } // MarshalJSON implements json.Marshaler. func (v IPPrefixSlice) MarshalJSON() ([]byte, error) { - return json.Marshal(v.ж) + return v.ж.MarshalJSON() } // UnmarshalJSON implements json.Unmarshaler. func (v *IPPrefixSlice) UnmarshalJSON(b []byte) error { - if v.ж != nil { - return errors.New("IPPrefixSlice is already initialized") - } - if len(b) == 0 { - return nil - } - if err := json.Unmarshal(b, &v.ж); err != nil { - return err - } - return nil + return v.ж.UnmarshalJSON(b) } diff --git a/types/views/views_test.go b/types/views/views_test.go index 5f4a8ceee..d9785c9a1 100644 --- a/types/views/views_test.go +++ b/types/views/views_test.go @@ -23,10 +23,12 @@ func TestViewsJSON(t *testing.T) { } type viewStruct struct { Addrs IPPrefixSlice - Strings StringSlice + Strings Slice[string] AddrsPtr *IPPrefixSlice `json:",omitempty"` - StringsPtr *StringSlice `json:",omitempty"` + StringsPtr *Slice[string] `json:",omitempty"` } + ipp := IPPrefixSliceOf(mustCIDR("192.168.0.0/24")) + ss := SliceOf([]string{"bar"}) tests := []struct { name string in viewStruct @@ -40,12 +42,12 @@ type viewStruct struct { { name: "everything", in: viewStruct{ - Addrs: IPPrefixSliceOf(mustCIDR("192.168.0.0/24")), - AddrsPtr: &IPPrefixSlice{mustCIDR("192.168.0.0/24")}, - StringsPtr: &StringSlice{[]string{"foo"}}, - Strings: StringSlice{[]string{"bar"}}, + Addrs: ipp, + AddrsPtr: &ipp, + StringsPtr: &ss, + Strings: ss, }, - wantJSON: `{"Addrs":["192.168.0.0/24"],"Strings":["bar"],"AddrsPtr":["192.168.0.0/24"],"StringsPtr":["foo"]}`, + wantJSON: `{"Addrs":["192.168.0.0/24"],"Strings":["bar"],"AddrsPtr":["192.168.0.0/24"],"StringsPtr":["bar"]}`, }, }