Merge pull request #974 from cloudxxx8/issue-870

refactor!: Clean up command client lib

Author: cloudxxx8

clients/http/command.go

@@ -114,22 +114,7 @@ func (client *CommandClient) IssueGetCommandByNameWithQueryParams(ctx context.Co
 }
 
 // IssueSetCommandByName issues the specified write command referenced by the command name to the device/sensor that is also referenced by name.
-func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]string) (res dtoCommon.BaseResponse, err errors.EdgeX) {
-	requestPath := common.NewPathBuilder().EnableNameFieldEscape(client.enableNameFieldEscape).
-		SetPath(common.ApiDeviceRoute).SetPath(common.Name).SetNameFieldPath(deviceName).SetNameFieldPath(commandName).BuildPath()
-	baseUrl, goErr := clients.GetBaseUrl(client.baseUrlFunc)
-	if goErr != nil {
-		return res, errors.NewCommonEdgeXWrapper(goErr)
-	}
-	err = utils.PutRequest(ctx, &res, baseUrl, requestPath, nil, settings, client.authInjector)
-	if err != nil {
-		return res, errors.NewCommonEdgeXWrapper(err)
-	}
-	return res, nil
-}
-
-// IssueSetCommandByNameWithObject issues the specified write command and the settings supports object value type
-func (client *CommandClient) IssueSetCommandByNameWithObject(ctx context.Context, deviceName string, commandName string, settings map[string]interface{}) (res dtoCommon.BaseResponse, err errors.EdgeX) {
+func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]any) (res dtoCommon.BaseResponse, err errors.EdgeX) {
 	requestPath := common.NewPathBuilder().EnableNameFieldEscape(client.enableNameFieldEscape).
 		SetPath(common.ApiDeviceRoute).SetPath(common.Name).SetNameFieldPath(deviceName).SetNameFieldPath(commandName).BuildPath()
 	baseUrl, goErr := clients.GetBaseUrl(client.baseUrlFunc)

clients/http/command_test.go

@@ -85,7 +85,7 @@ func TestIssueGetCommandByNameWithQueryParams(t *testing.T) {
 func TestIssueIssueSetCommandByName(t *testing.T) {
 	deviceName := "Simple-Device01"
 	cmdName := "SwitchButton"
-	settings := map[string]string{
+	settings := map[string]any{
 		"SwitchButton": "true",
 	}
 	path := common.NewPathBuilder().EnableNameFieldEscape(false).
@@ -101,8 +101,8 @@ func TestIssueIssueSetCommandByName(t *testing.T) {
 func TestIssueIssueSetCommandByNameWithObject(t *testing.T) {
 	deviceName := "Simple-Device01"
 	cmdName := "SwitchButton"
-	settings := map[string]interface{}{
-		"SwitchButton": map[string]interface{}{
+	settings := map[string]any{
+		"SwitchButton": map[string]any{
 			"kind":  "button",
 			"value": "on",
 		},
@@ -112,7 +112,7 @@ func TestIssueIssueSetCommandByNameWithObject(t *testing.T) {
 	ts := newTestServer(http.MethodPut, path, dtoCommon.BaseResponse{})
 	defer ts.Close()
 	client := NewCommandClient(ts.URL, NewNullAuthenticationInjector(), false)
-	res, err := client.IssueSetCommandByNameWithObject(context.Background(), deviceName, cmdName, settings)
+	res, err := client.IssueSetCommandByName(context.Background(), deviceName, cmdName, settings)
 	require.NoError(t, err)
 	require.IsType(t, dtoCommon.BaseResponse{}, res)
 }

clients/interfaces/command.go

@@ -29,7 +29,5 @@ type CommandClient interface {
 	// IssueGetCommandByNameWithQueryParams issues the specified read command by deviceName and commandName with additional query parameters.
 	IssueGetCommandByNameWithQueryParams(ctx context.Context, deviceName string, commandName string, queryParams map[string]string) (*responses.EventResponse, errors.EdgeX)
 	// IssueSetCommandByName issues the specified write command referenced by the command name to the device/sensor that is also referenced by name.
-	IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]string) (common.BaseResponse, errors.EdgeX)
-	// IssueSetCommandByNameWithObject issues the specified write command and the settings supports object value type
-	IssueSetCommandByNameWithObject(ctx context.Context, deviceName string, commandName string, settings map[string]interface{}) (common.BaseResponse, errors.EdgeX)
+	IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]any) (common.BaseResponse, errors.EdgeX)
 }