Skip to content

fix(lb): unnecessary reattach of private networks #2531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 16, 2024
Merged

fix(lb): unnecessary reattach of private networks #2531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7fcc294
fix(lb): unnecessary reattach of private networks
yfodil Apr 12, 2024
15e74bb
Merge branch 'master' into fix/lb-unnecessary-reattach
yfodil Apr 12, 2024
719fde4
add unit tests
yfodil Apr 16, 2024
0b4d8b6
Merge branch 'fix/lb-unnecessary-reattach' of github.com:yfodil/terra…
yfodil Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 40 additions & 29 deletions internal/services/lb/helpers_lb.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,42 +49,53 @@ func NewAPIWithZoneAndID(m interface{}, id string) (*lbSDK.ZonedAPI, scw.Zone, s
return lbAPI, zone, ID, nil
}

func IsPrivateNetworkEqual(a, b interface{}) bool {
// Find out the diff Private Network or not
if _, ok := a.(*lbSDK.PrivateNetwork); ok {
if _, ok := b.(*lbSDK.PrivateNetwork); ok {
if a.(*lbSDK.PrivateNetwork).PrivateNetworkID == b.(*lbSDK.PrivateNetwork).PrivateNetworkID {
// if both has dhcp config should not update
if a.(*lbSDK.PrivateNetwork).DHCPConfig != nil && b.(*lbSDK.PrivateNetwork).DHCPConfig != nil {
return true
}
// check static config
aConfig := a.(*lbSDK.PrivateNetwork).StaticConfig
bConfig := b.(*lbSDK.PrivateNetwork).StaticConfig
if aConfig != nil && bConfig != nil {
// check if static config is different
return reflect.DeepEqual(aConfig.IPAddress, bConfig.IPAddress)
}
}
}
func IsPrivateNetworkEqual(a, b *lbSDK.PrivateNetwork) bool {
if a == nil || b == nil {
return a == b
}
if a.PrivateNetworkID != b.PrivateNetworkID {
return false
}
if !reflect.DeepEqual(a.DHCPConfig, b.DHCPConfig) {
return false
}
if !reflect.DeepEqual(a.StaticConfig, b.StaticConfig) {
return false
}
return false

return true
}

func privateNetworksCompare(slice1, slice2 []*lbSDK.PrivateNetwork) []*lbSDK.PrivateNetwork {
var diff []*lbSDK.PrivateNetwork
func PrivateNetworksCompare(oldPNs, newPNs []*lbSDK.PrivateNetwork) ([]*lbSDK.PrivateNetwork, []*lbSDK.PrivateNetwork) {
var toDetach, toAttach []*lbSDK.PrivateNetwork

m := make(map[string]struct{}, len(slice1))
for _, pn := range slice1 {
m[pn.PrivateNetworkID] = struct{}{}
oldPNMap := make(map[string]*lbSDK.PrivateNetwork, len(oldPNs))
for _, pn := range oldPNs {
oldPNMap[pn.PrivateNetworkID] = pn
}
// find the differences
for _, pn := range slice2 {
if _, foundID := m[pn.PrivateNetworkID]; !foundID || (foundID && !IsPrivateNetworkEqual(slice1, slice2)) {
diff = append(diff, pn)

newPNMap := make(map[string]*lbSDK.PrivateNetwork, len(newPNs))
for _, pn := range newPNs {
newPNMap[pn.PrivateNetworkID] = pn
}

for id, oldPN := range oldPNMap {
newPN, found := newPNMap[id]
if !found {
toDetach = append(toDetach, oldPN)
} else if !IsPrivateNetworkEqual(oldPN, newPN) {
toDetach = append(toDetach, oldPN)
toAttach = append(toAttach, newPN)
}
}
return diff

for id, newPN := range newPNMap {
if _, found := oldPNMap[id]; !found {
toAttach = append(toAttach, newPN)
}
}

return toDetach, toAttach
}

func lbUpgradeV1SchemaType() cty.Type {
Expand Down
106 changes: 106 additions & 0 deletions internal/services/lb/helpers_lb_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,109 @@ func TestIsEqualPrivateNetwork(t *testing.T) {
})
}
}

func TestPrivateNetworksCompare(t *testing.T) {
tests := []struct {
name string
oldPNs []*lbSDK.PrivateNetwork
newPNs []*lbSDK.PrivateNetwork
expectedToDetach []*lbSDK.PrivateNetwork
expectedToAttach []*lbSDK.PrivateNetwork
}{
{
name: "no changes",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
expectedToDetach: []*lbSDK.PrivateNetwork(nil),
expectedToAttach: []*lbSDK.PrivateNetwork(nil),
},
{
name: "private network removed",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
expectedToDetach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
expectedToAttach: []*lbSDK.PrivateNetwork(nil),
},
{
name: "private network added",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
expectedToDetach: []*lbSDK.PrivateNetwork(nil),
expectedToAttach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
},
{
name: "private network static configuration changed",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.2"})}},
},
expectedToDetach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
expectedToAttach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.2"})}},
},
},
{
name: "private network configuration changed from static to DHCP",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
expectedToDetach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
expectedToAttach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
},
},
{
name: "multiple private networks removed",
oldPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
{PrivateNetworkID: "pn3", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.3"})}},
},
newPNs: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn1", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.1"})}},
},
expectedToDetach: []*lbSDK.PrivateNetwork{
{PrivateNetworkID: "pn2", DHCPConfig: &lbSDK.PrivateNetworkDHCPConfig{}},
{PrivateNetworkID: "pn3", StaticConfig: &lbSDK.PrivateNetworkStaticConfig{IPAddress: scw.StringsPtr([]string{"192.168.1.3"})}},
},
expectedToAttach: []*lbSDK.PrivateNetwork(nil),
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
toDetach, toAttach := lb.PrivateNetworksCompare(tt.oldPNs, tt.newPNs)
assert.ElementsMatch(t, tt.expectedToDetach, toDetach)
assert.ElementsMatch(t, tt.expectedToAttach, toAttach)
})
}
}
26 changes: 14 additions & 12 deletions internal/services/lb/lb.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,45 +465,47 @@ func resourceLbUpdate(ctx context.Context, d *schema.ResourceData, m interface{}
}

// check that pns are in a stable state
pns, err := waitForPrivateNetworks(ctx, lbAPI, zone, ID, d.Timeout(schema.TimeoutUpdate))
_, err := waitForPrivateNetworks(ctx, lbAPI, zone, ID, d.Timeout(schema.TimeoutUpdate))
if err != nil && !httperrors.Is404(err) {
return diag.FromErr(err)
}

pnConfigs, err := expandPrivateNetworks(d.Get("private_network"))
oldPNs, newPNs := d.GetChange("private_network")
oldPNConfigs, err := expandPrivateNetworks(oldPNs)
if err != nil {
return diag.FromErr(err)
}
newPNConfigs, err := expandPrivateNetworks(newPNs)
if err != nil {
return diag.FromErr(err)
}
// select only private networks that have changed
pnToDetach := privateNetworksCompare(pnConfigs, pns)

toDetach, toAttach := PrivateNetworksCompare(oldPNConfigs, newPNConfigs)

// detach private networks
for i := range pnToDetach {
for _, pn := range toDetach {
err = lbAPI.DetachPrivateNetwork(&lbSDK.ZonedAPIDetachPrivateNetworkRequest{
Zone: zone,
LBID: ID,
PrivateNetworkID: pnToDetach[i].PrivateNetworkID,
PrivateNetworkID: pn.PrivateNetworkID,
}, scw.WithContext(ctx))
if err != nil && !httperrors.Is404(err) {
return diag.FromErr(err)
}
}

// check load balancer state
_, err = waitForLB(ctx, lbAPI, zone, ID, d.Timeout(schema.TimeoutUpdate))
if err != nil && !httperrors.Is404(err) {
return diag.FromErr(err)
}

// check that pns are in a stable state
pns, err = waitForPrivateNetworks(ctx, lbAPI, zone, ID, d.Timeout(schema.TimeoutUpdate))
_, err = waitForPrivateNetworks(ctx, lbAPI, zone, ID, d.Timeout(schema.TimeoutUpdate))
if err != nil && !httperrors.Is404(err) {
return diag.FromErr(err)
}

pnToAttach := privateNetworksCompare(pns, pnConfigs)
// attach new/updated private networks
_, err = attachLBPrivateNetworks(ctx, lbAPI, zone, pnToAttach, ID, d.Timeout(schema.TimeoutUpdate))
// attach private networks
_, err = attachLBPrivateNetworks(ctx, lbAPI, zone, toAttach, ID, d.Timeout(schema.TimeoutUpdate))
if err != nil {
return diag.FromErr(err)
}
Expand Down
Loading