Update docs

Author: awln-temporal

chasm/engine.go

@@ -359,6 +359,17 @@ func engineFromContext(
 	return e
 }
 
+// ListExecutions lists the executions of a CHASM archetype given an initial query.
+// The query string can specify any combination of CHASM, custom, and predefined/system search attributes.
+// The generic parameter C is the CHASM component type used for executions and search attribute filtering.
+// The generic parameter M is the type of the memo payload to be unmarshaled from the execution.
+// PageSize is required, must be greater than 0.
+// NextPageToken is optional, set on subsequent requests to continue listing the next page of executions.
+// Note: For CHASM executions, TemporalNamespaceDivision is the predefined search attribute
+// that is used to identify the archetype of the execution.
+// If the query string does not specify TemporalNamespaceDivision, the archetype C of the request will be used to filter the executions.
+// If the initial query already specifies TemporalNamespaceDivision, the archetype C of the request will
+// only be used to get the registered SearchAttributes.
 func ListExecutions[C Component, M proto.Message](
 	ctx context.Context,
 	request *ListExecutionsRequest,
@@ -400,6 +411,14 @@ func ListExecutions[C Component, M proto.Message](
 	}, nil
 }
 
+// CountExecutions counts the executions of a CHASM archetype given an initial query.
+// The generic parameter C is the CHASM component type used for executions and search attribute filtering.
+// The query string can specify any combination of CHASM, custom, and predefined/system search attributes.
+// Note: For CHASM executions, TemporalNamespaceDivision is the predefined search attribute
+// that is used to identify the archetype of the execution.
+// If the query string does not specify TemporalNamespaceDivision, the archetype C of the request will be used to count the executions.
+// If the initial query already specifies TemporalNamespaceDivision, the archetype C of the request will
+// only be used to get the registered SearchAttributes.
 func CountExecutions[C Component](
 	ctx context.Context,
 	request *CountExecutionsRequest,

chasm/registry_test.go

@@ -218,6 +218,49 @@ func (s *RegistryTestSuite) TestRegistry_RegisterComponents_Error() {
 		require.Contains(t, err.Error(), "must be struct or pointer to struct")
 	})
 
+	s.T().Run("duplicate search attribute alias panics", func(t *testing.T) {
+		require.PanicsWithValue(t,
+			"registrable component validation error: search attribute alias \"MyAlias\" is already defined",
+			func() {
+				chasm.NewRegistrableComponent[*chasm.MockComponent](
+					"Component1",
+					chasm.WithSearchAttributes(
+						chasm.NewSearchAttributeBool("MyAlias", chasm.SearchAttributeFieldBool01),
+						chasm.NewSearchAttributeInt("MyAlias", chasm.SearchAttributeFieldInt01),
+					),
+				)
+			},
+		)
+	})
+
+	s.T().Run("duplicate search attribute field panics", func(t *testing.T) {
+		require.PanicsWithValue(t,
+			"registrable component validation error: search attribute field \"TemporalBool01\" is already defined",
+			func() {
+				chasm.NewRegistrableComponent[*chasm.MockComponent](
+					"Component1",
+					chasm.WithSearchAttributes(
+						chasm.NewSearchAttributeBool("Alias1", chasm.SearchAttributeFieldBool01),
+						chasm.NewSearchAttributeBool("Alias2", chasm.SearchAttributeFieldBool01),
+					),
+				)
+			},
+		)
+	})
+
+	s.T().Run("valid search attributes do not panic", func(t *testing.T) {
+		require.NotPanics(t, func() {
+			chasm.NewRegistrableComponent[*chasm.MockComponent](
+				"Component1",
+				chasm.WithSearchAttributes(
+					chasm.NewSearchAttributeBool("Completed", chasm.SearchAttributeFieldBool01),
+					chasm.NewSearchAttributeInt("Count", chasm.SearchAttributeFieldInt01),
+					chasm.NewSearchAttributeKeyword("Status", chasm.SearchAttributeFieldKeyword01),
+				),
+			)
+		})
+	})
+
 }
 
 func (s *RegistryTestSuite) TestRegistry_RegisterTasks_Error() {

chasm/search_attribute.go

@@ -448,6 +448,8 @@ func NewSearchAttributesMap(values map[string]VisibilityValue) SearchAttributesM
 // The return type T is inferred from the SearchAttribute's type parameter.
 // For example, SearchAttriteBool will return a bool value.
 // If the value is not found, the zero value for the type T is returned and the second return value is false.
+// Before casting the VisibilityValue to the target type, the value is checked to ensure it is of the correct type.
+// If the value is found but the type does not match, the zero value for the type T is returned and the second return value is false.
 func Get[T any](m SearchAttributesMap, sa typedSearchAttribute[T]) (val T, ok bool) {
 	var zero T
 	if m.values == nil {