go.temporal.io/server@v1.23.0/common/searchattribute/encode.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package searchattribute
    26  
    27  import (
    28  	commonpb "go.temporal.io/api/common/v1"
    29  	enumspb "go.temporal.io/api/enums/v1"
    30  
    31  	"go.temporal.io/server/common/payload"
    32  )
    33  
    34  // Encode encodes map of search attribute values to search attributes.
    35  // typeMap can be nil (then MetadataType field won't be set).
    36  // In case of error, it will continue to next search attribute and return last error.
    37  func Encode(searchAttributes map[string]interface{}, typeMap *NameTypeMap) (*commonpb.SearchAttributes, error) {
    38  	if len(searchAttributes) == 0 {
    39  		return nil, nil
    40  	}
    41  
    42  	indexedFields := make(map[string]*commonpb.Payload, len(searchAttributes))
    43  	var lastErr error
    44  	for saName, saValue := range searchAttributes {
    45  		valPayload, err := payload.Encode(saValue)
    46  		if err != nil {
    47  			lastErr = err
    48  			indexedFields[saName] = nil
    49  			continue
    50  		}
    51  
    52  		indexedFields[saName] = valPayload
    53  		saType := enumspb.INDEXED_VALUE_TYPE_UNSPECIFIED
    54  		if typeMap != nil {
    55  			saType, err = typeMap.getType(saName, customCategory|predefinedCategory)
    56  			if err != nil {
    57  				lastErr = err
    58  				continue
    59  			}
    60  			setMetadataType(valPayload, saType)
    61  		}
    62  	}
    63  	return &commonpb.SearchAttributes{IndexedFields: indexedFields}, lastErr
    64  }
    65  
    66  // Decode decodes search attributes to the map of search attribute values using (in order):
    67  // 1. type from typeMap,
    68  // 2. if typeMap is nil, type from MetadataType field is used.
    69  // In case of error, it will continue to next search attribute and return last error.
    70  func Decode(
    71  	searchAttributes *commonpb.SearchAttributes,
    72  	typeMap *NameTypeMap,
    73  	allowList bool,
    74  ) (map[string]interface{}, error) {
    75  	if len(searchAttributes.GetIndexedFields()) == 0 {
    76  		return nil, nil
    77  	}
    78  
    79  	result := make(map[string]interface{}, len(searchAttributes.GetIndexedFields()))
    80  	var lastErr error
    81  	for saName, saPayload := range searchAttributes.GetIndexedFields() {
    82  		saType := enumspb.INDEXED_VALUE_TYPE_UNSPECIFIED
    83  		if typeMap != nil {
    84  			var err error
    85  			saType, err = typeMap.getType(saName, customCategory|predefinedCategory)
    86  			if err != nil {
    87  				lastErr = err
    88  			}
    89  		}
    90  
    91  		searchAttributeValue, err := DecodeValue(saPayload, saType, allowList)
    92  		if err != nil {
    93  			lastErr = err
    94  			result[saName] = nil
    95  			continue
    96  		}
    97  		result[saName] = searchAttributeValue
    98  	}
    99  
   100  	return result, lastErr
   101  }