refactor(sdk): change all factory methods and receiver functions to u…

pkg/transforms/aesprotection.go

@@ -36,8 +36,8 @@ type AESProtection struct {
 
 // NewAESProtection creates, initializes and returns a new instance of AESProtection configured
 // to retrieve the encryption key from the Secret Store
-func NewAESProtection(secretPath string, secretName string) AESProtection {
-	return AESProtection{
+func NewAESProtection(secretPath string, secretName string) *AESProtection {
+	return &AESProtection{
 		SecretPath: secretPath,
 		SecretName: secretName,
 	}
@@ -46,7 +46,7 @@ func NewAESProtection(secretPath string, secretName string) AESProtection {
 // Encrypt encrypts a string, []byte, or json.Marshaller type using AES 256 encryption.
 // It also signs the data using a SHA512 hash.
 // It will return a Base64 encode []byte of the encrypted data.
-func (protection AESProtection) Encrypt(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
+func (protection *AESProtection) Encrypt(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
 	if data == nil {
 		return false, fmt.Errorf("function Encrypt in pipeline '%s': No Data Received", ctx.PipelineId())
 	}

pkg/transforms/compression.go

@@ -38,8 +38,8 @@ type Compression struct {
 }
 
 // NewCompression creates, initializes and returns a new instance of Compression
-func NewCompression() Compression {
-	return Compression{}
+func NewCompression() *Compression {
+	return &Compression{}
 }
 
 // CompressWithGZIP compresses data received as either a string,[]byte, or json.Marshaller using gzip algorithm

pkg/transforms/conversion.go

@@ -31,13 +31,13 @@ type Conversion struct {
 }
 
 // NewConversion creates, initializes and returns a new instance of Conversion
-func NewConversion() Conversion {
-	return Conversion{}
+func NewConversion() *Conversion {
+	return &Conversion{}
 }
 
 // TransformToXML transforms an EdgeX event to XML.
 // It will return an error and stop the pipeline if a non-edgex event is received or if no data is received.
-func (f Conversion) TransformToXML(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, stringType interface{}) {
+func (f *Conversion) TransformToXML(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, stringType interface{}) {
 	if data == nil {
 		return false, fmt.Errorf("function TransformToXML in pipeline '%s': No Data Received", ctx.PipelineId())
 	}
@@ -59,7 +59,7 @@ func (f Conversion) TransformToXML(ctx interfaces.AppFunctionContext, data inter
 
 // TransformToJSON transforms an EdgeX event to JSON.
 // It will return an error and stop the pipeline if a non-edgex event is received or if no data is received.
-func (f Conversion) TransformToJSON(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, stringType interface{}) {
+func (f *Conversion) TransformToJSON(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, stringType interface{}) {
 	if data == nil {
 		return false, fmt.Errorf("function TransformToJSON in pipeline '%s': No Data Received", ctx.PipelineId())
 	}

pkg/transforms/filter.go

@@ -34,20 +34,20 @@ type Filter struct {
 
 // NewFilterFor creates, initializes and returns a new instance of Filter
 // that defaults FilterOut to false, so it is filtering for specified values
-func NewFilterFor(filterValues []string) Filter {
-	return Filter{FilterValues: filterValues, FilterOut: false}
+func NewFilterFor(filterValues []string) *Filter {
+	return &Filter{FilterValues: filterValues, FilterOut: false}
 }
 
 // NewFilterOut creates, initializes and returns a new instance of Filter
 // that defaults FilterOut to true, so it is filtering out specified values
-func NewFilterOut(filterValues []string) Filter {
-	return Filter{FilterValues: filterValues, FilterOut: true}
+func NewFilterOut(filterValues []string) *Filter {
+	return &Filter{FilterValues: filterValues, FilterOut: true}
 }
 
 // FilterByProfileName filters based on the specified Device Profile, aka Class of Device.
 // If FilterOut is false, it filters out those Events not associated with the specified Device Profile listed in FilterValues.
 // If FilterOut is true, it out those Events that are associated with the specified Device Profile listed in FilterValues.
-func (f Filter) FilterByProfileName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
+func (f *Filter) FilterByProfileName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
 	f.ctx = ctx
 	event, err := f.setupForFiltering("FilterByProfileName", "ProfileName", ctx.LoggingClient(), data)
 	if err != nil {
@@ -66,7 +66,7 @@ func (f Filter) FilterByProfileName(ctx interfaces.AppFunctionContext, data inte
 // FilterByDeviceName filters based on the specified Device Names, aka Instance of a Device.
 // If FilterOut is false, it filters out those Events not associated with the specified Device Names listed in FilterValues.
 // If FilterOut is true, it out those Events that are associated with the specified Device Names listed in FilterValues.
-func (f Filter) FilterByDeviceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
+func (f *Filter) FilterByDeviceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
 	f.ctx = ctx
 	event, err := f.setupForFiltering("FilterByDeviceName", "DeviceName", ctx.LoggingClient(), data)
 	if err != nil {
@@ -84,7 +84,7 @@ func (f Filter) FilterByDeviceName(ctx interfaces.AppFunctionContext, data inter
 // FilterBySourceName filters based on the specified Source for the Event, aka resource or command name.
 // If FilterOut is false, it filters out those Events not associated with the specified Source listed in FilterValues.
 // If FilterOut is true, it out those Events that are associated with the specified Source listed in FilterValues.
-func (f Filter) FilterBySourceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
+func (f *Filter) FilterBySourceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
 	f.ctx = ctx
 	event, err := f.setupForFiltering("FilterBySourceName", "SourceName", ctx.LoggingClient(), data)
 	if err != nil {
@@ -103,7 +103,7 @@ func (f Filter) FilterBySourceName(ctx interfaces.AppFunctionContext, data inter
 // If FilterOut is false, it filters out those Event Readings not associated with the specified Resource Names listed in FilterValues.
 // If FilterOut is true, it out those Event Readings that are associated with the specified Resource Names listed in FilterValues.
 // This function will return an error and stop the pipeline if a non-edgex event is received or if no data is received.
-func (f Filter) FilterByResourceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
+func (f *Filter) FilterByResourceName(ctx interfaces.AppFunctionContext, data interface{}) (continuePipeline bool, result interface{}) {
 	f.ctx = ctx
 	existingEvent, err := f.setupForFiltering("FilterByResourceName", "ResourceName", ctx.LoggingClient(), data)
 	if err != nil {
@@ -166,7 +166,7 @@ func (f Filter) FilterByResourceName(ctx interfaces.AppFunctionContext, data int
 	return false, nil
 }
 
-func (f Filter) setupForFiltering(funcName string, filterProperty string, lc logger.LoggingClient, data interface{}) (*dtos.Event, error) {
+func (f *Filter) setupForFiltering(funcName string, filterProperty string, lc logger.LoggingClient, data interface{}) (*dtos.Event, error) {
 	mode := "For"
 	if f.FilterOut {
 		mode = "Out"
@@ -185,7 +185,7 @@ func (f Filter) setupForFiltering(funcName string, filterProperty string, lc log
 	return &event, nil
 }
 
-func (f Filter) doEventFilter(filterProperty string, value string, lc logger.LoggingClient) bool {
+func (f *Filter) doEventFilter(filterProperty string, value string, lc logger.LoggingClient) bool {
 	// No names to filter for, so pass events through rather than filtering them all out.
 	if len(f.FilterValues) == 0 {
 		return true

pkg/transforms/filter_test.go

@@ -67,7 +67,7 @@ func TestFilter_FilterByProfileName(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.Name, func(t *testing.T) {
-			var filter Filter
+			var filter *Filter
 			if test.FilterOut {
 				filter = NewFilterOut(test.Filters)
 			} else {
@@ -117,7 +117,7 @@ func TestFilter_FilterByDeviceName(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.Name, func(t *testing.T) {
-			var filter Filter
+			var filter *Filter
 			if test.FilterOut {
 				filter = NewFilterOut(test.Filters)
 			} else {
@@ -167,7 +167,7 @@ func TestFilter_FilterBySourceName(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.Name, func(t *testing.T) {
-			var filter Filter
+			var filter *Filter
 			if test.FilterOut {
 				filter = NewFilterOut(test.Filters)
 			} else {
@@ -247,7 +247,7 @@ func TestFilter_FilterByResourceName(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.Name, func(t *testing.T) {
-			var filter Filter
+			var filter *Filter
 			if test.FilterOut {
 				filter = NewFilterOut(test.Filters)
 			} else {

pkg/transforms/jsonlogic.go

@@ -35,14 +35,14 @@ type JSONLogic struct {
 }
 
 // NewJSONLogic creates, initializes and returns a new instance of HTTPSender
-func NewJSONLogic(rule string) JSONLogic {
-	return JSONLogic{
+func NewJSONLogic(rule string) *JSONLogic {
+	return &JSONLogic{
 		Rule: rule,
 	}
 }
 
 // Evaluate ...
-func (logic JSONLogic) Evaluate(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
+func (logic *JSONLogic) Evaluate(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
 	if data == nil {
 		// We didn't receive a result
 		return false, fmt.Errorf("function Evaluate in pipeline '%s': No Data Received", ctx.PipelineId())

pkg/transforms/responsedata.go

@@ -29,13 +29,13 @@ type ResponseData struct {
 }
 
 // NewResponseData creates, initializes and returns a new instance of ResponseData
-func NewResponseData() ResponseData {
-	return ResponseData{}
+func NewResponseData() *ResponseData {
+	return &ResponseData{}
 }
 
 // SetResponseData sets the response data to that passed in from the previous function.
 // It will return an error and stop the pipeline if the input data is not of type []byte, string or json.Marshaller
-func (f ResponseData) SetResponseData(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
+func (f *ResponseData) SetResponseData(ctx interfaces.AppFunctionContext, data interface{}) (bool, interface{}) {
 
 	ctx.LoggingClient().Debugf("Setting response data in pipeline '%s'", ctx.PipelineId())
 

pkg/transforms/tags.go

@@ -30,8 +30,8 @@ type Tags struct {
 }
 
 // NewTags creates, initializes and returns a new instance of Tags using generic interface values
-func NewTags(tags map[string]interface{}) Tags {
-	return Tags{
+func NewTags(tags map[string]interface{}) *Tags {
+	return &Tags{
 		tags: tags,
 	}
 }