feat!: Add EnableNameFieldEscape config

BREAKING CHANGE: Add EnableNameFieldEscape config on the service level and allow NameFieldEscape configurable Signed-off-by: bruce <[email protected]>
edgexfoundry · Sep 7, 2023 · d9b1415 · d9b1415
1 parent f8054bb
commit d9b1415
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/bootstrap/handlers/clients.go b/bootstrap/handlers/clients.go
@@ -80,22 +80,22 @@ func (cb *ClientsBootstrap) BootstrapHandler(
 			case common.CoreDataServiceKey:
 				dic.Update(di.ServiceConstructorMap{
 					container.EventClientName: func(get di.Get) interface{} {
-						return clients.NewEventClient(url, jwtSecretProvider)
+						return clients.NewEventClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 				})
 			case common.CoreMetaDataServiceKey:
 				dic.Update(di.ServiceConstructorMap{
 					container.DeviceClientName: func(get di.Get) interface{} {
-						return clients.NewDeviceClient(url, jwtSecretProvider)
+						return clients.NewDeviceClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 					container.DeviceServiceClientName: func(get di.Get) interface{} {
-						return clients.NewDeviceServiceClient(url, jwtSecretProvider)
+						return clients.NewDeviceServiceClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 					container.DeviceProfileClientName: func(get di.Get) interface{} {
-						return clients.NewDeviceProfileClient(url, jwtSecretProvider)
+						return clients.NewDeviceProfileClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 					container.ProvisionWatcherClientName: func(get di.Get) interface{} {
-						return clients.NewProvisionWatcherClient(url, jwtSecretProvider)
+						return clients.NewProvisionWatcherClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 				})
 
@@ -127,7 +127,7 @@ func (cb *ClientsBootstrap) BootstrapHandler(
 
 					lc.Infof("Using messaging for '%s' clients", serviceKey)
 				} else {
-					client = clients.NewCommandClient(url, jwtSecretProvider)
+					client = clients.NewCommandClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 				}
 
 				dic.Update(di.ServiceConstructorMap{
@@ -139,20 +139,20 @@ func (cb *ClientsBootstrap) BootstrapHandler(
 			case common.SupportNotificationsServiceKey:
 				dic.Update(di.ServiceConstructorMap{
 					container.NotificationClientName: func(get di.Get) interface{} {
-						return clients.NewNotificationClient(url, jwtSecretProvider)
+						return clients.NewNotificationClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 					container.SubscriptionClientName: func(get di.Get) interface{} {
-						return clients.NewSubscriptionClient(url, jwtSecretProvider)
+						return clients.NewSubscriptionClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 				})
 
 			case common.SupportSchedulerServiceKey:
 				dic.Update(di.ServiceConstructorMap{
 					container.IntervalClientName: func(get di.Get) interface{} {
-						return clients.NewIntervalClient(url, jwtSecretProvider)
+						return clients.NewIntervalClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 					container.IntervalActionClientName: func(get di.Get) interface{} {
-						return clients.NewIntervalActionClient(url, jwtSecretProvider)
+						return clients.NewIntervalActionClient(url, jwtSecretProvider, config.GetBootstrap().Service.EnableNameFieldEscape)
 					},
 				})
 

diff --git a/config/types.go b/config/types.go
@@ -62,6 +62,10 @@ type ServiceInfo struct {
 	// RequestTimeout specifies a timeout (in milliseconds) for
 	// processing REST request calls from other services.
 	RequestTimeout string
+	// EnableNameFieldEscape indicates whether enables NameFieldEscape in this service
+	// The name field escape could allow the system to use special or Chinese characters in the different name fields, including device, profile, and so on.  If the EnableNameFieldEscape is false, some special characters might cause system error.
+	// TODO: remove in EdgeX 4.0
+	EnableNameFieldEscape bool
 	// CORSConfiguration defines the cross-origin resource sharing related settings
 	CORSConfiguration CORSConfigurationInfo
 }