Fix dropped values during driver unmarshal (#227)

* Fix dropped values during driver unmarshal * Add comments to driver UnmarshalJSON
rancher · Sep 28, 2023 · a0a7cc4 · a0a7cc4
1 parent 9617627
commit a0a7cc4
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 21 deletions.
diff --git a/drivers/amazonec2/amazonec2.go b/drivers/amazonec2/amazonec2.go
@@ -377,15 +377,22 @@ func (d *Driver) getClient() Ec2Client {
 	return d.clientFactory()
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/azure/azure.go b/drivers/azure/azure.go
@@ -322,15 +322,22 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 	}
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/digitalocean/digitalocean.go b/drivers/digitalocean/digitalocean.go
@@ -154,15 +154,22 @@ func (d *Driver) DriverName() string {
 	return "digitalocean"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/exoscale/exoscale.go b/drivers/exoscale/exoscale.go
@@ -187,15 +187,22 @@ func (d *Driver) DriverName() string {
 	return "exoscale"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/google/google.go b/drivers/google/google.go
@@ -201,15 +201,22 @@ func (d *Driver) DriverName() string {
 	return "google"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/noop/driver.go b/drivers/noop/driver.go
@@ -93,7 +93,9 @@ func (d *Driver) Restart() error {
 	return nil
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver

diff --git a/drivers/openstack/openstack.go b/drivers/openstack/openstack.go
@@ -362,15 +362,22 @@ func (d *Driver) DriverName() string {
 	return "openstack"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/rackspace/rackspace.go b/drivers/rackspace/rackspace.go
@@ -123,15 +123,22 @@ func missingEnvOrOption(setting, envVar, opt string) error {
 	)
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/softlayer/driver.go b/drivers/softlayer/driver.go
@@ -220,15 +220,22 @@ func validateClientConfig(c *Client) error {
 	return nil
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.

diff --git a/drivers/vmwarefusion/fusion_darwin.go b/drivers/vmwarefusion/fusion_darwin.go
@@ -144,7 +144,9 @@ func (d *Driver) DriverName() string {
 	return "vmwarefusion"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver

diff --git a/drivers/vmwarevcloudair/vcloudair.go b/drivers/vmwarevcloudair/vcloudair.go
@@ -152,7 +152,9 @@ func (d *Driver) DriverName() string {
 	return "vmwarevcloudair"
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver

diff --git a/drivers/vmwarevsphere/flags.go b/drivers/vmwarevsphere/flags.go
@@ -207,15 +207,22 @@ func (d *Driver) GetCreateFlags() []mcnflag.Flag {
 	}
 }
 
-// UnmarshalJSON loads driver config from JSON.
+// UnmarshalJSON loads driver config from JSON. This function is used by the RPCServerDriver that wraps
+// all drivers as a means of populating an already-initialized driver with new configuration.
+// See `RPCServerDriver.SetConfigRaw`.
 func (d *Driver) UnmarshalJSON(data []byte) error {
 	// Unmarshal driver config into an aliased type to prevent infinite recursion on UnmarshalJSON.
 	type targetDriver Driver
-	target := targetDriver{}
+
+	// Copy data from `d` to `target` before unmarshalling. This will ensure that already-initialized values
+	// from `d` that are left untouched during unmarshal (like functions) are preserved.
+	target := targetDriver(*d)
+
 	if err := json.Unmarshal(data, &target); err != nil {
 		return fmt.Errorf("error unmarshalling driver config from JSON: %w", err)
 	}
 
+	// Copy unmarshalled data back to `d`.
 	*d = Driver(target)
 
 	// Make sure to reload values that are subject to change from envvars and os.Args.