Skip to content

fix: Make search attribute type more lenient when parsing #716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xepozz merged 4 commits into from
Mar 3, 2026
Merged

fix: Make search attribute type more lenient when parsing #716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a0860bb
feat: produce deprecation when use activity method without the activi…
xepozz Feb 23, 2026
bc8853a
feat: Make search attribute type more lenient when parsing
xepozz Feb 25, 2026
5393c4a
Merge branch 'master' into typed-attrs
xepozz Feb 25, 2026
f029630
Merge branch 'master' into typed-attrs
xepozz Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/Common/SearchAttributes/ValueType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,30 @@ enum ValueType: string
case KeywordList = 'keyword_list';
case Text = 'string';
case Datetime = 'datetime';

/**
* Parse a type string leniently, accepting the canonical form (e.g. "keyword"),
* PascalCase form (e.g. "Keyword"), and SCREAMING_SNAKE_CASE proto enum form
* (e.g. "INDEXED_VALUE_TYPE_KEYWORD").
*/
public static function fromMetadata(string $type): ?self
{
// Try canonical form first (e.g. "keyword", "int64")
$result = self::tryFrom($type);
if ($result !== null) {
return $result;
}

// PascalCase and SCREAMING_SNAKE_CASE forms
return match ($type) {
'Bool', 'INDEXED_VALUE_TYPE_BOOL' => self::Bool,
'Double', 'INDEXED_VALUE_TYPE_DOUBLE' => self::Float,
'Int', 'INDEXED_VALUE_TYPE_INT' => self::Int,
'Keyword', 'INDEXED_VALUE_TYPE_KEYWORD' => self::Keyword,
'KeywordList', 'INDEXED_VALUE_TYPE_KEYWORD_LIST' => self::KeywordList,
'Text', 'INDEXED_VALUE_TYPE_TEXT' => self::Text,
'Datetime', 'INDEXED_VALUE_TYPE_DATETIME' => self::Datetime,
default => null,
};
}
}
8 changes: 6 additions & 2 deletions src/Common/TypedSearchAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,12 @@ public static function fromJsonArray(array $array): self
$collection = new \SplObjectStorage();
foreach ($array as $name => ['type' => $type, 'value' => $value]) {
try {
$vt = ValueType::from($type);
$key = SearchAttributeKey::for($vt, $name);
$valueType = ValueType::fromMetadata($type);
if ($valueType === null) {
continue;
}

$key = SearchAttributeKey::for($valueType, $name);
$collection->offsetSet($key, $key->valueSet($value)->value);
} catch (\Throwable) {
// Ignore invalid values.
Expand Down
127 changes: 127 additions & 0 deletions tests/Unit/Common/TypedSearchAttributesTestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Temporal\Tests\Unit\Common;

use Temporal\Common\SearchAttributes\SearchAttributeKey;
use Temporal\Common\SearchAttributes\ValueType;
use Temporal\Common\TypedSearchAttributes;
use PHPUnit\Framework\TestCase;

Expand Down Expand Up @@ -196,6 +197,92 @@ public function testFromJsonArray(): void
self::assertSame(['foo', 'bar'], $collection->get(SearchAttributeKey::forKeywordList('name8')));
}

public function testFromJsonArrayWithPascalCaseType(): void
{
$collection = TypedSearchAttributes::fromJsonArray([
'name1' => [
'type' => 'Bool',
'value' => true,
],
'name2' => [
'type' => 'Int',
'value' => 42,
],
'name3' => [
'type' => 'Double',
'value' => 3.14,
],
'name4' => [
'type' => 'Keyword',
'value' => 'bar',
],
'name5' => [
'type' => 'Text',
'value' => 'foo',
],
'name6' => [
'type' => 'Datetime',
'value' => '2021-01-01T00:00:00+00:00',
],
'name7' => [
'type' => 'KeywordList',
'value' => ['foo', 'bar'],
],
]);

self::assertCount(7, $collection);
self::assertTrue($collection->get(SearchAttributeKey::forBool('name1')));
self::assertSame(42, $collection->get(SearchAttributeKey::forInteger('name2')));
self::assertSame(3.14, $collection->get(SearchAttributeKey::forFloat('name3')));
self::assertSame('bar', $collection->get(SearchAttributeKey::forKeyword('name4')));
self::assertSame('foo', $collection->get(SearchAttributeKey::forText('name5')));
self::assertInstanceOf(\DateTimeImmutable::class, $collection->get(SearchAttributeKey::forDatetime('name6')));
self::assertSame(['foo', 'bar'], $collection->get(SearchAttributeKey::forKeywordList('name7')));
}

public function testFromJsonArrayWithScreamingSnakeCaseType(): void
{
$collection = TypedSearchAttributes::fromJsonArray([
'name1' => [
'type' => 'INDEXED_VALUE_TYPE_BOOL',
'value' => true,
],
'name2' => [
'type' => 'INDEXED_VALUE_TYPE_INT',
'value' => 42,
],
'name3' => [
'type' => 'INDEXED_VALUE_TYPE_DOUBLE',
'value' => 3.14,
],
'name4' => [
'type' => 'INDEXED_VALUE_TYPE_KEYWORD',
'value' => 'bar',
],
'name5' => [
'type' => 'INDEXED_VALUE_TYPE_TEXT',
'value' => 'foo',
],
'name6' => [
'type' => 'INDEXED_VALUE_TYPE_DATETIME',
'value' => '2021-01-01T00:00:00+00:00',
],
'name7' => [
'type' => 'INDEXED_VALUE_TYPE_KEYWORD_LIST',
'value' => ['foo', 'bar'],
],
]);

self::assertCount(7, $collection);
self::assertTrue($collection->get(SearchAttributeKey::forBool('name1')));
self::assertSame(42, $collection->get(SearchAttributeKey::forInteger('name2')));
self::assertSame(3.14, $collection->get(SearchAttributeKey::forFloat('name3')));
self::assertSame('bar', $collection->get(SearchAttributeKey::forKeyword('name4')));
self::assertSame('foo', $collection->get(SearchAttributeKey::forText('name5')));
self::assertInstanceOf(\DateTimeImmutable::class, $collection->get(SearchAttributeKey::forDatetime('name6')));
self::assertSame(['foo', 'bar'], $collection->get(SearchAttributeKey::forKeywordList('name7')));
}

public function testFromUntypedCollection(): void
{
$collection = TypedSearchAttributes::fromCollection([
Expand All @@ -219,6 +306,46 @@ public function testFromUntypedCollection(): void
self::assertSame(['foo', 'bar'], $collection->get(SearchAttributeKey::forKeywordList('name8')));
}

public function testValueTypeFromMetadataCanonical(): void
{
self::assertSame(ValueType::Bool, ValueType::fromMetadata('bool'));
self::assertSame(ValueType::Float, ValueType::fromMetadata('float64'));
self::assertSame(ValueType::Int, ValueType::fromMetadata('int64'));
self::assertSame(ValueType::Keyword, ValueType::fromMetadata('keyword'));
self::assertSame(ValueType::KeywordList, ValueType::fromMetadata('keyword_list'));
self::assertSame(ValueType::Text, ValueType::fromMetadata('string'));
self::assertSame(ValueType::Datetime, ValueType::fromMetadata('datetime'));
}

public function testValueTypeFromMetadataPascalCase(): void
{
self::assertSame(ValueType::Bool, ValueType::fromMetadata('Bool'));
self::assertSame(ValueType::Float, ValueType::fromMetadata('Double'));
self::assertSame(ValueType::Int, ValueType::fromMetadata('Int'));
self::assertSame(ValueType::Keyword, ValueType::fromMetadata('Keyword'));
self::assertSame(ValueType::KeywordList, ValueType::fromMetadata('KeywordList'));
self::assertSame(ValueType::Text, ValueType::fromMetadata('Text'));
self::assertSame(ValueType::Datetime, ValueType::fromMetadata('Datetime'));
}

public function testValueTypeFromMetadataScreamingSnakeCase(): void
{
self::assertSame(ValueType::Bool, ValueType::fromMetadata('INDEXED_VALUE_TYPE_BOOL'));
self::assertSame(ValueType::Float, ValueType::fromMetadata('INDEXED_VALUE_TYPE_DOUBLE'));
self::assertSame(ValueType::Int, ValueType::fromMetadata('INDEXED_VALUE_TYPE_INT'));
self::assertSame(ValueType::Keyword, ValueType::fromMetadata('INDEXED_VALUE_TYPE_KEYWORD'));
self::assertSame(ValueType::KeywordList, ValueType::fromMetadata('INDEXED_VALUE_TYPE_KEYWORD_LIST'));
self::assertSame(ValueType::Text, ValueType::fromMetadata('INDEXED_VALUE_TYPE_TEXT'));
self::assertSame(ValueType::Datetime, ValueType::fromMetadata('INDEXED_VALUE_TYPE_DATETIME'));
}

public function testValueTypeFromMetadataUnknown(): void
{
self::assertNull(ValueType::fromMetadata('unknown'));
self::assertNull(ValueType::fromMetadata(''));
self::assertNull(ValueType::fromMetadata('INDEXED_VALUE_TYPE_UNKNOWN'));
}

public function testValues()
{
$collection = TypedSearchAttributes::empty()
Expand Down
Loading