Fix nil pointer during SearchAttribute translation (#102)

Author: pglass

interceptor/reflection.go

@@ -57,6 +57,10 @@ func visitNamespace(obj any, match stringMatcher) (bool, error) {
 
 	// The visitor function can return Skip, Stop, or Continue to control recursion.
 	err := visit.Values(obj, func(vwp visit.ValueWithParent) (visit.Action, error) {
+		if vwp.Kind() == reflect.Ptr && vwp.IsNil() {
+			return visit.Skip, nil
+		}
+
 		// Grab name of this struct field from the parent.
 		fieldType, action := getParentFieldType(vwp)
 		if action != "" {
@@ -109,12 +113,15 @@ func visitSearchAttributes(obj any, match stringMatcher) (bool, error) {
 
 	// The visitor function can return Skip, Stop, or Continue to control recursion.
 	err := visit.Values(obj, func(vwp visit.ValueWithParent) (visit.Action, error) {
+		if vwp.Kind() == reflect.Ptr && vwp.IsNil() {
+			return visit.Skip, nil
+		}
+
 		// Grab name of this struct field from the parent.
 		fieldType, action := getParentFieldType(vwp)
 		if action != "" {
 			return action, nil
 		}
-
 		if dataBlobFieldNames[fieldType.Name] {
 			changed, err := visitDataBlobs(vwp, match, visitSearchAttributes)
 			matched = matched || changed

interceptor/search_attribute_translator_test.go

@@ -7,12 +7,41 @@ import (
 	"go.temporal.io/api/common/v1"
 	"go.temporal.io/api/enums/v1"
 	"go.temporal.io/api/history/v1"
-	"go.temporal.io/api/sdk/v1"
 	"go.temporal.io/server/api/adminservice/v1"
 	"go.temporal.io/server/api/persistence/v1"
 	replicationspb "go.temporal.io/server/api/replication/v1"
 	"go.temporal.io/server/common/persistence/serialization"
-	"google.golang.org/protobuf/types/known/timestamppb"
+)
+
+type (
+	Other           struct{}
+	SAWithTwoFields struct {
+		Other            *Other
+		SearchAttributes *common.SearchAttributes
+	}
+
+	SAWithTwoFieldsSwapped struct {
+		SearchAttributes *common.SearchAttributes
+		Other            *Other
+	}
+
+	SAWithOneField struct {
+		SearchAttributes *common.SearchAttributes
+	}
+
+	SAWithOneMap struct {
+		SearchAttributes map[string]*common.Payload
+	}
+
+	SAWithOneMapAndOneField struct {
+		Other            *Other
+		SearchAttributes map[string]*common.Payload
+	}
+
+	SAWithOneMapAndOneFieldSwapped struct {
+		SearchAttributes map[string]*common.Payload
+		Other            *Other
+	}
 )
 
 func TestTranslateSearchAttribute(t *testing.T) {
@@ -21,6 +50,58 @@ func TestTranslateSearchAttribute(t *testing.T) {
 
 func generateSearchAttributeObjs() []objCase {
 	return []objCase{
+		{
+			objName:     "nil",
+			containsObj: false,
+			makeType: func(name string) any {
+				return nil
+			},
+		},
+		{
+			objName:     "nil SearchAttributes",
+			containsObj: false,
+			makeType: func(name string) any {
+				return &persistence.WorkflowExecutionInfo{
+					NamespaceId:      name,
+					SearchAttributes: map[string]*common.Payload(nil),
+				}
+			},
+		},
+		{
+			objName:  "nil two fields",
+			makeType: func(name string) any { return &SAWithTwoFields{} },
+		},
+		{
+			objName:  "nil two fields different order",
+			makeType: func(name string) any { return &SAWithTwoFieldsSwapped{} },
+		},
+		{
+			objName:  "nil one field",
+			makeType: func(name string) any { return &SAWithOneField{} },
+		},
+		{
+			objName:  "nil map",
+			makeType: func(name string) any { return &SAWithOneMap{} },
+		},
+		{
+			objName:  "nil map and field",
+			makeType: func(name string) any { return &SAWithOneMapAndOneField{} },
+		},
+		{
+			objName:  "nil map and field different order",
+			makeType: func(name string) any { return &SAWithOneMapAndOneFieldSwapped{} },
+		},
+		{
+			objName:     "nil value in SearchAttributes",
+			containsObj: true,
+			makeType: func(name string) any {
+				return &persistence.WorkflowExecutionInfo{
+					SearchAttributes: map[string]*common.Payload{
+						name: nil,
+					},
+				}
+			},
+		},
 		{
 			objName:     "HistoryTaskAttributes",
 			containsObj: true,
@@ -97,18 +178,42 @@ func makeHistoryEventsBlobWithSearchAttribute(name string) *common.DataBlob {
 			TaskId:    100,
 			Attributes: &history.HistoryEvent_WorkflowExecutionStartedEventAttributes{
 				WorkflowExecutionStartedEventAttributes: &history.WorkflowExecutionStartedEventAttributes{
-					WorkflowType: &common.WorkflowType{
-						Name: "some-wf-type",
-					},
+					WorkflowType: &common.WorkflowType{Name: "some-wf-type-1"},
 					SearchAttributes: &common.SearchAttributes{
 						IndexedFields: makeTestIndexedFieldMap(name),
 					},
 				},
 			},
-			EventTime:       &timestamppb.Timestamp{},
-			WorkerMayIgnore: false,
-			UserMetadata:    &sdk.UserMetadata{},
-			Links:           []*common.Link{},
+		},
+		{
+			Attributes: &history.HistoryEvent_WorkflowExecutionStartedEventAttributes{
+				WorkflowExecutionStartedEventAttributes: &history.WorkflowExecutionStartedEventAttributes{
+					WorkflowType:     &common.WorkflowType{Name: "some-wf-type-2"},
+					SearchAttributes: nil,
+				},
+			},
+		},
+		{
+			Attributes: &history.HistoryEvent_WorkflowExecutionStartedEventAttributes{
+				WorkflowExecutionStartedEventAttributes: &history.WorkflowExecutionStartedEventAttributes{
+					WorkflowType: &common.WorkflowType{Name: "some-wf-type-2"},
+					SearchAttributes: &common.SearchAttributes{
+						IndexedFields: nil,
+					},
+				},
+			},
+		},
+		{
+			Attributes: &history.HistoryEvent_WorkflowExecutionStartedEventAttributes{
+				WorkflowExecutionStartedEventAttributes: &history.WorkflowExecutionStartedEventAttributes{
+					WorkflowType: &common.WorkflowType{Name: "some-wf-type-3"},
+					SearchAttributes: &common.SearchAttributes{
+						IndexedFields: map[string]*common.Payload{
+							name: nil,
+						},
+					},
+				},
+			},
 		},
 	}