Add CHASM Visibility registration and task processing #8491

awln-temporal · 2025-10-15T22:39:05Z

What changed?

Adds CHASM search attribute provider and mapper implementation. To use CHASM search attributes, embed your component with ComponentSearchAttributesProvider and register the search attributes to the CHASM Registry.

To define a component search attribute, define a SearchAttribute as a package/global scoped variable (CHASM search attributes should reference exported variables like SearchAttributeFieldInt01, SearchAttributeFieldDateTime01:

var (
	TestComponentStartTimeSearchAttribute = NewSearchAttributeTime(testComponentStartTimeSAKey, SearchAttributeFieldDateTime01)

	_ VisibilitySearchAttributesProvider = (*TestComponent)(nil)
	_ VisibilityMemoProvider             = (*TestComponent)(nil)
	_ VisibilitySearchAttributesMapper   = (*TestComponent)(nil)
)

To update SearchAttributes during an execution of a CHASM archetype, implement the provider SearchAttributes in the root component, and call the NewValue method on a SearchAttribute within the Provider method to generate a new SearchAttributeValue. On SearchAttribute updates during CHASM transactions, the framework will detect changes and submit a Visibility task for persistence.

type TestComponent struct {
	UnimplementedComponent

	...
	Visibility Field[*Visibility]
}


func (tc *TestComponent) SearchAttributes(ctx Context) []SearchAttributeValue {
	return []SearchAttributeValue{
             TestComponentStartTimeSearchAttribute.NewValue(time)
        }
}

To register the search attribute with the CHASM Registry, WithSearchAttributes must be passed as a RegistrableComponentOption to the root component of the library. This is required to support Visibility queries.

return []*chasm.RegistrableComponent{
		chasm.NewRegistrableComponent[*Scheduler]("scheduler", WIthSearchAttributes([]SearchAttributeDefinition{TestComponentStartTimeSearchAttribute}),
		chasm.NewRegistrableComponent[*Generator]("generator"),
		chasm.NewRegistrableComponent[*Invoker]("invoker"),
		chasm.NewRegistrableComponent[*Backfiller]("backfiller"),
	}

Why?

Required to support CHASM Search Attributes.

How did you test it?

Potential risks

TBD

bergundy

Started reviewing but I think we still don't agree on the API, so let's discuss that before and agree before implementing anything.

chasm/registrable_component.go

chasm/lib/tests/payload.go

…vider

…Value

bergundy

Overall looks great.

bergundy · 2025-10-23T17:27:21Z

chasm/registrable_component.go

 }
+
+// GetAlias returns the search attribute alias for the given field name.
+func (rc *RegistrableComponent) GetAlias(field string) (string, error) {


Suggested change

func (rc *RegistrableComponent) GetAlias(field string) (string, error) {

func (rc *RegistrableComponent) SearchAttributeAlias(field string) (string, error) {

Also replied in the other comment, I think the only reason to have the SearchAttribute prefix in this function name is because it's making RegistrableComponent implement the VisibilitySearchAttributesMapper interface, which I'm not sure I like this approach.

I'd rather if RegistrableComponent had an actual var for the mapper. In fact, I'm wondering if the interface is even needed.

chasm/registrable_component.go

chasm/search_attribute.go

chasm/test_component_test.go

bergundy · 2025-10-23T20:25:50Z

chasm/visibility.go

+	GetAlias(field string) (string, error)
+	GetField(alias string) (string, error)


Suggested change

GetAlias(field string) (string, error)

GetField(alias string) (string, error)

SearchAttributeAlias(field string) (string, error)

SearchAttributeField(alias string) (string, error)

Isn't it redundant to have functions here prefixed with SearchAttribute since the interface is already called VisibilitySearchAttributesMapper? I think GetAlias/GetFieldName are in this case.

chasm/search_attribute.go

rodrigozhou · 2025-10-23T20:00:59Z

chasm/registrable_component.go

+		for _, sa := range searchAttributes {
+			alias := sa.getAlias()
+			field := sa.getField()
+			valueType := sa.getValueType()
+
+			rc.aliasToField[alias] = field
+			rc.fieldToAlias[field] = alias
+			rc.saTypeMap[field] = valueType
+		}


You cannot create these maps before validating. It's possible to create an invalid mapping that passes the validation. Example: Foo -> Field1, Foo -> Field2, Bar -> Field1

rodrigozhou · 2025-10-27T20:52:25Z

chasm/visibility.go

+	GetAlias(field string) (string, error)
+	GetField(alias string) (string, error)


Isn't it redundant to have functions here prefixed with SearchAttribute since the interface is already called VisibilitySearchAttributesMapper? I think GetAlias/GetFieldName are in this case.

rodrigozhou · 2025-10-27T20:56:32Z

chasm/registrable_component.go

 }
+
+// GetAlias returns the search attribute alias for the given field name.
+func (rc *RegistrableComponent) GetAlias(field string) (string, error) {


Also replied in the other comment, I think the only reason to have the SearchAttribute prefix in this function name is because it's making RegistrableComponent implement the VisibilitySearchAttributesMapper interface, which I'm not sure I like this approach.

I'd rather if RegistrableComponent had an actual var for the mapper. In fact, I'm wondering if the interface is even needed.

bergundy

This is already very close.
Please document all exported fields from the chasm package.

bergundy · 2025-10-29T00:40:40Z

chasm/visibility.go

+func (v *VisibilitySearchAttributesMapper) GetAlias(field string) (string, error) {
+	if v == nil {
+		return "", serviceerror.NewInvalidArgument("visibility search attributes mapper is not registered")
+	}
+	alias, ok := v.aliasToField[field]
+	if !ok {
+		return "", serviceerror.NewInvalidArgument(fmt.Sprintf("visibility search attributes mapper has no registered field %s", field))
+	}
+	return alias, nil
+}
+
+func (v *VisibilitySearchAttributesMapper) GetField(alias string) (string, error) {
+	if v == nil {
+		return "", serviceerror.NewInvalidArgument("visibility search attributes mapper is not registered")
+	}
+	field, ok := v.fieldToAlias[alias]
+	if !ok {
+		return "", serviceerror.NewInvalidArgument(fmt.Sprintf("visibility search attributes mapper has no registered alias %s", alias))
+	}
+	return field, nil
+}
+
+func (v *VisibilitySearchAttributesMapper) GetFieldValueType(field string) (enumspb.IndexedValueType, error) {
+	if v == nil {
+		return enumspb.INDEXED_VALUE_TYPE_UNSPECIFIED, serviceerror.NewInvalidArgument("visibility search attributes mapper is not registered")
+	}
+	saType, ok := v.saTypeMap[field]
+	if !ok {
+		return enumspb.INDEXED_VALUE_TYPE_UNSPECIFIED, serviceerror.NewInvalidArgument(fmt.Sprintf("visibility search attributes mapper has no registered field %s", field))
+	}
+	return saType, nil
+}


Why do you need to export these methods? And please don't use Get as a prefix for getters in Go.

bergundy · 2025-10-29T00:42:35Z

chasm/search_attribute.go

+	_ SearchAttribute = (*SearchAttributeKeywordList)(nil)
+)
+
+type (


nit: don't group all of the types together. The practice in Go is to put the type definition above its constructor followed by all of the methods.

bergundy · 2025-10-29T00:43:14Z

chasm/search_attribute.go

+		// alias refers to the user defined name of the search attribute
+		Alias string
+		// field refers to a fully formed schema field, which is either a Predefined or CHASM search attribute
+		Field     string
+		ValueType enumspb.IndexedValueType


Do these fields need to be exported? They're defined on a struct that isn't exported.

bergundy · 2025-10-29T00:46:59Z

chasm/lib/tests/payload.go

 )

 var (
+	TestKeywordSearchAttribute = chasm.NewSearchAttributeKeyword(TestKeywordSAFieldName, chasm.SearchAttributeFieldKeyword01)


We need another search attribute to test aliasing.
Also, don't use TemporalScheduledById as the mapped attribute.

You're going to want:

Define SearchAttributeTemporalScheduledById = newSearchAttributeKeywordByField(searchattribute.TemporalScheduledById) in chasm/search_attribute.go

Define a separate search attribute that will map to SearchAttributeFieldKeyword01 for testing aliasing

Register both with the component

Emit both from the component

Test both in functional tests

awln-temporal requested review from a team as code owners October 15, 2025 22:39

awln-temporal force-pushed the CHASMSearchAttributeComponents branch from 4a8af63 to c07d41e Compare October 17, 2025 17:36

awln-temporal requested review from bergundy and rodrigozhou October 20, 2025 13:41

bergundy reviewed Oct 20, 2025

View reviewed changes

chasm/registrable_component.go Outdated Show resolved Hide resolved

chasm/lib/tests/payload.go Outdated Show resolved Hide resolved

chasm/lib/tests/payload.go Outdated Show resolved Hide resolved

awln-temporal added 5 commits October 21, 2025 12:28

Add CHASM Visibility registration and task processing

8d45ce3

Remove unused code

dd5301f

simplify search attribute constructor methods

bf50c0a

Update linters

358a354

Update implementation to use separate mapper and search attribute pro…

c103f5f

…vider

awln-temporal force-pushed the CHASMSearchAttributeComponents branch from 560562e to c103f5f Compare October 21, 2025 16:29

awln-temporal added 15 commits October 21, 2025 12:49

Remove unused code for the RegistrableComponent

100cdce

Remove unused variable name ref

cad4f71

Add compile time checks for the mapper interface

34b9c4a

Rename SetValue to ValueSet

cc8a8b0

revert visibility queue task executor

e928a2d

Move attribute to global variable

6ee5c7f

Change search attribute index constructors to constant refs

c3ae24b

Move mapper provider to RegistrableComponent

6cbbf09

Add panic check in component registration

c7df243

Add upsert memo method

92d5c4a

Move validation to registration call

aebc387

Change search attribute provider interface to list of SearchAttribute…

dacfea5

…Value

Move exported search attribute field constants to top of file

bd03919

address accessor comments

4bdd20c

Refactor conversion of []SearchAttributeKeyValue to shared map

438f71a

awln-temporal requested a review from bergundy October 23, 2025 15:27

awln-temporal added 2 commits October 23, 2025 11:51

Add error return type for mapper provider interface

fd7f41d

Change accessor level of predefined CHASM search attribute constructor

cfccb46

awln-temporal force-pushed the CHASMSearchAttributeComponents branch from acf6008 to cfccb46 Compare October 23, 2025 19:10

awln-temporal added 2 commits October 23, 2025 15:13

Add compile time type checks

bb107ff

Change acceessor back to public to fix unit tests

10e9e45

bergundy reviewed Oct 23, 2025

View reviewed changes

awln-temporal added 6 commits October 23, 2025 19:49

Update chasm search attribute documentation and mapper interface

cd1339f

Fix linter issue

f7d4eb2

Shorten field name resolution

5c46ffc

Amend test search attribute accessor level

fdc9951

Fix linter issues

7f9c611

Address PR comments

528ada8

awln-temporal requested a review from bergundy October 24, 2025 20:01

rodrigozhou reviewed Oct 27, 2025

View reviewed changes

awln-temporal added 2 commits October 27, 2025 17:57

Move validation to component instantiation

3a14adc

Rename method names

b52cdd4

awln-temporal requested a review from rodrigozhou October 28, 2025 16:50

Merge branch 'main' into CHASMSearchAttributeComponents

d66929a

bergundy reviewed Oct 29, 2025

View reviewed changes

	func (rc *RegistrableComponent) GetAlias(field string) (string, error) {
	func (rc *RegistrableComponent) SearchAttributeAlias(field string) (string, error) {

		GetAlias(field string) (string, error)
		GetField(alias string) (string, error)

Uh oh!

Add CHASM Visibility registration and task processing #8491

Are you sure you want to change the base?

Add CHASM Visibility registration and task processing #8491

Uh oh!

Conversation

awln-temporal commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed?

Why?

How did you test it?

Potential risks

Uh oh!

bergundy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bergundy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rodrigozhou Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bergundy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

awln-temporal commented Oct 15, 2025 •

edited

Loading

rodrigozhou Oct 23, 2025 •

edited

Loading