Merge pull request #515: Fix SearchAttributes in ChildWorkflow

temporalio · Oct 8, 2024 · d789123 · d789123
2 parents 221afce + 6d6e335
commit d789123
Show file tree

Hide file tree

Showing 12 changed files with 354 additions and 107 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -212,43 +212,14 @@
       <code><![CDATA[$name]]></code>
       <code><![CDATA[$value]]></code>
     </InvalidArgument>
-    <MismatchingDocblockParamType>
-      <code><![CDATA[iterable<array-key, Payload>]]></code>
-    </MismatchingDocblockParamType>
-    <MismatchingDocblockReturnType>
-      <code><![CDATA[EncodedCollection]]></code>
-    </MismatchingDocblockReturnType>
     <MoreSpecificImplementedParamType>
       <code><![CDATA[$type]]></code>
     </MoreSpecificImplementedParamType>
-    <PossiblyNullReference>
-      <code><![CDATA[fromPayload]]></code>
-    </PossiblyNullReference>
-    <UnsafeInstantiation>
-      <code><![CDATA[new static()]]></code>
-      <code><![CDATA[new static()]]></code>
-    </UnsafeInstantiation>
   </file>
   <file src="src/DataConverter/EncodedValues.php">
-    <InvalidNullableReturnType>
-      <code><![CDATA[array]]></code>
-    </InvalidNullableReturnType>
-    <MissingClosureParamType>
-      <code><![CDATA[$value]]></code>
-    </MissingClosureParamType>
-    <NullableReturnStatement>
-      <code><![CDATA[$result]]></code>
-      <code><![CDATA[$result]]></code>
-    </NullableReturnStatement>
-    <PossiblyNullArrayAccess>
-      <code><![CDATA[$this->payloads[$index]]]></code>
-    </PossiblyNullArrayAccess>
     <PossiblyNullIterator>
       <code><![CDATA[$this->values]]></code>
     </PossiblyNullIterator>
-    <PossiblyNullReference>
-      <code><![CDATA[$this->payloads]]></code>
-    </PossiblyNullReference>
     <UnsafeInstantiation>
       <code><![CDATA[new static()]]></code>
       <code><![CDATA[new static()]]></code>
@@ -661,6 +632,11 @@
       <code><![CDATA[NamedArgumentConstructor]]></code>
     </DeprecatedClass>
   </file>
+  <file src="src/Internal/Marshaller/Meta/MarshalAssocArray.php">
+    <DeprecatedClass>
+      <code><![CDATA[NamedArgumentConstructor]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Internal/Marshaller/Meta/MarshalDateTime.php">
     <DeprecatedClass>
       <code><![CDATA[NamedArgumentConstructor]]></code>
@@ -694,12 +670,6 @@
     <InvalidFalsableReturnType>
       <code><![CDATA[\DateTimeImmutable]]></code>
     </InvalidFalsableReturnType>
-    <InvalidReturnStatement>
-      <code><![CDATA[\Temporal\Interceptor\Header::fromPayloadCollection($input->getFields(), $this->converter)]]></code>
-    </InvalidReturnStatement>
-    <InvalidReturnType>
-      <code><![CDATA[HeaderInterface]]></code>
-    </InvalidReturnType>
     <LessSpecificReturnStatement>
       <code><![CDATA[$mapper]]></code>
     </LessSpecificReturnStatement>
@@ -779,7 +749,6 @@
     </InvalidReturnStatement>
     <InvalidReturnType>
       <code><![CDATA[?string]]></code>
-      <code><![CDATA[iterable<class-string<DetectableTypeInterface>>]]></code>
     </InvalidReturnType>
     <LessSpecificReturnStatement>
       <code><![CDATA[$result]]></code>
@@ -1306,9 +1275,6 @@
     </PossiblyInvalidArgument>
   </file>
   <file src="src/Worker/Transport/Codec/JsonCodec/Decoder.php">
-    <InvalidArgument>
-      <code><![CDATA[Header::fromPayloadCollection($headers->getFields(), $this->dataConverter)]]></code>
-    </InvalidArgument>
     <InvalidReturnStatement>
       <code><![CDATA[match (true) {
             isset($command['command']) => $this->parseRequest($command, $info),
@@ -1344,9 +1310,6 @@
     <ArgumentTypeCoercion>
       <code><![CDATA[$msg->getCommand()]]></code>
     </ArgumentTypeCoercion>
-    <InvalidArgument>
-      <code><![CDATA[$header]]></code>
-    </InvalidArgument>
     <PossiblyNullArgument>
       <code><![CDATA[$msg->getFailure()]]></code>
       <code><![CDATA[$msg->getPayloads()]]></code>

diff --git a/src/DataConverter/EncodedCollection.php b/src/DataConverter/EncodedCollection.php
@@ -11,18 +11,16 @@
 
 namespace Temporal\DataConverter;
 
-use ArrayAccess;
-use Countable;
-use IteratorAggregate;
 use Temporal\Api\Common\V1\Payload;
-use Traversable;
 
 /**
- * @psalm-type TPayloadsCollection = Traversable&ArrayAccess&Countable
+ * Assoc collection of typed values.
+ *
  * @psalm-type TKey = array-key
  * @psalm-type TValue = mixed
+ * @psalm-type TPayloadsCollection = \Traversable&\ArrayAccess<TKey, TValue>&\Countable
  *
- * @implements IteratorAggregate<TKey, TValue>
+ * @implements \IteratorAggregate<TKey, TValue>
  */
 class EncodedCollection implements \IteratorAggregate, \Countable
 {
@@ -36,16 +34,14 @@ class EncodedCollection implements \IteratorAggregate, \Countable
      */
     private ?\ArrayAccess $payloads = null;
 
+    /** @var array<TKey, TValue> */
     private array $values = [];
 
     /**
      * Cannot be constructed directly.
      */
-    private function __construct() {}
+    final private function __construct() {}
 
-    /**
-     * @return static
-     */
     public static function empty(): static
     {
         $ev = new static();
@@ -55,10 +51,7 @@ public static function empty(): static
     }
 
     /**
-     * @param iterable $values
-     * @param DataConverterInterface|null $dataConverter
-     *
-     * @return static
+     * @param iterable<TKey, TValue> $values
      */
     public static function fromValues(iterable $values, ?DataConverterInterface $dataConverter = null): static
     {
@@ -72,10 +65,7 @@ public static function fromValues(iterable $values, ?DataConverterInterface $dat
     }
 
     /**
-     * @param iterable<array-key, Payload> $payloads
-     * @param DataConverterInterface $dataConverter
-     *
-     * @return EncodedCollection
+     * @param array<TKey, Payload>|TPayloadsCollection $payloads
      */
     public static function fromPayloadCollection(
         array|\ArrayAccess $payloads,
@@ -103,8 +93,6 @@ public function isEmpty(): bool
     /**
      * @param array-key $name
      * @param Type|string|null $type
-     *
-     * @return mixed
      */
     public function getValue(int|string $name, mixed $type = null): mixed
     {
@@ -143,9 +131,8 @@ public function getValues(): array
     public function getIterator(): \Traversable
     {
         yield from $this->values;
-        if ($this->payloads !== null) {
-            $this->converter !== null or $this->payloads->count() === 0
-            or throw new \LogicException('DataConverter is not set.');
+        if ($this->payloads !== null && $this->payloads->count() > 0) {
+            $this->converter === null and throw new \LogicException('DataConverter is not set.');
 
             foreach ($this->payloads as $key => $payload) {
                 yield $key => $this->converter->fromPayload($payload, null);
@@ -166,9 +153,7 @@ public function toPayloadArray(): array
             return $data;
         }
 
-        if ($this->converter === null) {
-            throw new \LogicException('DataConverter is not set.');
-        }
+        $this->converter === null and throw new \LogicException('DataConverter is not set.');
 
         foreach ($this->values as $key => $value) {
             $data[$key] = $this->converter->toPayload($value);
@@ -177,6 +162,10 @@ public function toPayloadArray(): array
         return $data;
     }
 
+    /**
+     * @param TKey $name
+     * @param TValue $value
+     */
     public function withValue(int|string $name, mixed $value): static
     {
         $clone = clone $this;
@@ -193,9 +182,6 @@ public function withValue(int|string $name, mixed $value): static
         return $clone;
     }
 
-    /**
-     * @param DataConverterInterface $converter
-     */
     public function setDataConverter(DataConverterInterface $converter): void
     {
         $this->converter = $converter;

diff --git a/src/DataConverter/EncodedValues.php b/src/DataConverter/EncodedValues.php
@@ -20,8 +20,10 @@
 use Traversable;
 
 /**
+ * List of typed values.
+ *
  * @psalm-type TPayloadsCollection = Traversable&ArrayAccess&Countable
- * @psalm-type TKey = array-key
+ * @psalm-type TKey = int
  * @psalm-type TValue = string
  */
 class EncodedValues implements ValuesInterface
@@ -100,7 +102,7 @@ public static function sliceValues(
     public static function decodePromise(PromiseInterface $promise, $type = null): PromiseInterface
     {
         return $promise->then(
-            static function ($value) use ($type) {
+            static function (mixed $value) use ($type) {
                 if (!$value instanceof ValuesInterface || $value instanceof \Throwable) {
                     return $value;
                 }
@@ -153,22 +155,26 @@ public function getValue(int|string $index, $type = null): mixed
             return $this->values[$index];
         }
 
+        $count = $this->count();
         // External SDKs might return an empty array with metadata, alias to null
         // Most likely this is a void type
-        if ($index === 0 && $this->count() === 0 && $this->isVoidType($type)) {
+        if ($index === 0 && $count === 0 && $this->isVoidType($type)) {
             return null;
         }
 
-        if ($this->converter === null) {
-            throw new \LogicException('DataConverter is not set');
-        }
+        $count > $index or throw new \OutOfBoundsException("Index {$index} is out of bounds.");
+        $this->converter === null and throw new \LogicException('DataConverter is not set.');
 
-        return $this->converter->fromPayload($this->payloads[$index], $type);
+        \assert($this->payloads !== null);
+        return $this->converter->fromPayload(
+            $this->payloads[$index],
+            $type,
+        );
     }
 
     public function getValues(): array
     {
-        $result = $this->values;
+        $result = (array) $this->values;
 
         if (empty($this->payloads)) {
             return $result;

diff --git a/src/Internal/Declaration/Dispatcher/AutowiredPayloads.php b/src/Internal/Declaration/Dispatcher/AutowiredPayloads.php
@@ -23,12 +23,12 @@ class AutowiredPayloads extends Dispatcher
     public function dispatchValues(object $ctx, ValuesInterface $values): mixed
     {
         $arguments = [];
-        for ($i = 0; $i < $values->count(); $i++) {
-            try {
+        try {
+            for ($i = 0, $count = $values->count(); $i < $count; $i++) {
                 $arguments[] = $values->getValue($i, $this->getArgumentTypes()[$i] ?? null);
-            } catch (\Throwable $e) {
-                throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
             }
+        } catch (\Throwable $e) {
+            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
         }
 
         try {

diff --git a/src/Internal/Declaration/Graph/ClassNode.php b/src/Internal/Declaration/Graph/ClassNode.php
@@ -11,8 +11,6 @@
 
 namespace Temporal\Internal\Declaration\Graph;
 
-use Temporal\Tests\Workflow\Inheritance\ExtendingWorkflow;
-
 final class ClassNode implements NodeInterface
 {
     /**
@@ -39,7 +37,8 @@ public function getReflection(): \ReflectionClass
      *
      * @throws \ReflectionException
      */
-    public function getAllMethods(): array {
+    public function getAllMethods(): array
+    {
         /** @var array<non-empty-string, \ReflectionMethod> $result */
         $result = [];
 

diff --git a/src/Internal/Marshaller/Meta/MarshalAssocArray.php b/src/Internal/Marshaller/Meta/MarshalAssocArray.php
@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * This file is part of Temporal package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Temporal\Internal\Marshaller\Meta;
+
+use Spiral\Attributes\NamedArgumentConstructor;
+use Temporal\Internal\Marshaller\Type\AssocArrayType;
+
+/**
+ * The same as {@see MarshalArray}, but it forces the marshaller to treat the property as an associative array.
+ * Useful when you send an empty array, but the recipient can't handle it because expects an object,
+ * but PHP's {@see json_encode()} encodes an empty array as a list `[]` instead of an object `{}`.
+ *
+ * @Annotation
+ * @NamedArgumentConstructor
+ * @Target({ "PROPERTY", "METHOD" })
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE), NamedArgumentConstructor]
+final class MarshalAssocArray extends Marshal
+{
+    /**
+     * @param string|null $name
+     * @param Marshal|string|null $of
+     * @param bool $nullable
+     */
+    public function __construct(
+        string $name = null,
+        Marshal|string|null $of = null,
+        bool $nullable = true,
+    ) {
+        parent::__construct($name, AssocArrayType::class, $of, $nullable);
+    }
+}