|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +namespace Temporal\Tests\Acceptance\Extra\Workflow\Metadata; |
| 6 | + |
| 7 | +use PHPUnit\Framework\Attributes\Test; |
| 8 | +use Temporal\Api\Sdk\V1\WorkflowInteractionDefinition; |
| 9 | +use Temporal\Api\Sdk\V1\WorkflowMetadata; |
| 10 | +use Temporal\Client\WorkflowStubInterface; |
| 11 | +use Temporal\DataConverter\ValuesInterface; |
| 12 | +use Temporal\Tests\Acceptance\App\Attribute\Stub; |
| 13 | +use Temporal\Tests\Acceptance\App\TestCase; |
| 14 | +use Temporal\Workflow; |
| 15 | +use Temporal\Workflow\QueryMethod; |
| 16 | +use Temporal\Workflow\SignalMethod; |
| 17 | +use Temporal\Workflow\WorkflowInterface; |
| 18 | +use Temporal\Workflow\WorkflowMethod; |
| 19 | + |
| 20 | +class MetadataTest extends TestCase |
| 21 | +{ |
| 22 | + #[Test] |
| 23 | + public static function withoutDynamicHandlers( |
| 24 | + #[Stub('Extra_Workflow_Metadata')] WorkflowStubInterface $stub, |
| 25 | + ): void { |
| 26 | + $metadata = $stub->query('__temporal_workflow_metadata')?->getValue(0, WorkflowMetadata::class); |
| 27 | + |
| 28 | + self::assertInstanceOf(WorkflowMetadata::class, $metadata); |
| 29 | + self::assertNotNull($metadata->getDefinition()); |
| 30 | + self::assertCount(1, $metadata->getDefinition()->getQueryDefinitions()); |
| 31 | + self::assertCount(2, $metadata->getDefinition()->getSignalDefinitions()); |
| 32 | + self::assertCount(0, $metadata->getDefinition()->getUpdateDefinitions()); |
| 33 | + } |
| 34 | + |
| 35 | + #[Test] |
| 36 | + public static function withDynamicHandlers( |
| 37 | + #[Stub('Extra_Workflow_Metadata', args: [true])] |
| 38 | + WorkflowStubInterface $stub, |
| 39 | + ): void { |
| 40 | + /** @var WorkflowMetadata $metadata */ |
| 41 | + $metadata = $stub->query('__temporal_workflow_metadata')?->getValue(0, WorkflowMetadata::class); |
| 42 | + |
| 43 | + /** @var \ArrayAccess<int, WorkflowInteractionDefinition>|list<WorkflowInteractionDefinition> $queries */ |
| 44 | + $queries = $metadata->getDefinition()->getQueryDefinitions(); |
| 45 | + /** @var \ArrayAccess<int, WorkflowInteractionDefinition>|list<WorkflowInteractionDefinition> $signals */ |
| 46 | + $signals = $metadata->getDefinition()->getSignalDefinitions(); |
| 47 | + /** @var \ArrayAccess<int, WorkflowInteractionDefinition>|list<WorkflowInteractionDefinition> $updates */ |
| 48 | + $updates = $metadata->getDefinition()->getUpdateDefinitions(); |
| 49 | + |
| 50 | + self::assertInstanceOf(WorkflowMetadata::class, $metadata); |
| 51 | + self::assertNotNull($metadata->getDefinition()); |
| 52 | + |
| 53 | + # Queries |
| 54 | + self::assertCount(2, $queries); |
| 55 | + # Dynamic query handler |
| 56 | + self::assertSame('Dynamic query handler', $queries[0]->getDescription()); |
| 57 | + # Static query handler |
| 58 | + self::assertSame('get_counter', $queries[1]->getName()); |
| 59 | + self::assertSame('Get the current counter value', $queries[1]->getDescription()); |
| 60 | + |
| 61 | + # Signals |
| 62 | + self::assertCount(3, $signals); |
| 63 | + # Dynamic signal handler |
| 64 | + self::assertSame('Dynamic signal handler', $signals[0]->getDescription()); |
| 65 | + # Static signal handlers |
| 66 | + self::assertSame('finish', $signals[1]->getName()); |
| 67 | + self::assertSame('Finish the workflow', $signals[1]->getDescription()); |
| 68 | + self::assertSame('inc_counter', $signals[2]->getName()); |
| 69 | + self::assertSame('', $signals[2]->getDescription()); |
| 70 | + |
| 71 | + # Updates |
| 72 | + self::assertCount(1, $updates); |
| 73 | + self::assertSame('Dynamic update handler', $updates[0]->getDescription()); |
| 74 | + |
| 75 | + } |
| 76 | +} |
| 77 | + |
| 78 | +#[WorkflowInterface] |
| 79 | +class FeatureWorkflow |
| 80 | +{ |
| 81 | + private int $counter = 0; |
| 82 | + private bool $beDone = false; |
| 83 | + |
| 84 | + #[WorkflowMethod('Extra_Workflow_Metadata')] |
| 85 | + public function run(bool $registerFallbacks = false) |
| 86 | + { |
| 87 | + if ($registerFallbacks) { |
| 88 | + Workflow::registerDynamicQuery(static fn(string $name, ValuesInterface $values): mixed => $name); |
| 89 | + Workflow::registerDynamicSignal(static fn(string $name, ValuesInterface $values): mixed => $name); |
| 90 | + Workflow::registerDynamicUpdate( |
| 91 | + static fn(string $name, ValuesInterface $values): mixed => $name, |
| 92 | + static fn(string $name, ValuesInterface $values) => null, |
| 93 | + ); |
| 94 | + } |
| 95 | + |
| 96 | + yield Workflow::await(fn(): bool => $this->beDone); |
| 97 | + } |
| 98 | + |
| 99 | + #[QueryMethod('get_counter', description: 'Get the current counter value')] |
| 100 | + public function getCounter(): int |
| 101 | + { |
| 102 | + return $this->counter; |
| 103 | + } |
| 104 | + |
| 105 | + #[SignalMethod('inc_counter')] |
| 106 | + public function incCounter(): void |
| 107 | + { |
| 108 | + ++$this->counter; |
| 109 | + } |
| 110 | + |
| 111 | + #[SignalMethod('finish', description: 'Finish the workflow')] |
| 112 | + public function finish(): void |
| 113 | + { |
| 114 | + $this->beDone = true; |
| 115 | + } |
| 116 | +} |
0 commit comments