Fix psalm issues

temporalio · Sep 14, 2023 · e9b1351 · e9b1351
1 parent d25a629
commit e9b1351
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 93 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -783,6 +783,15 @@
       <code><![CDATA[$command->getID()]]></code>
     </PossiblyInvalidArgument>
   </file>
+  <file src="src/Internal/Transport/CompletableResult.php">
+    <InvalidArgument>
+      <code><![CDATA[$this->wrapContext($onFulfilledOrRejected)]]></code>
+      <code><![CDATA[$this->wrapContext($onFulfilledOrRejected)]]></code>
+    </InvalidArgument>
+    <PossiblyNullArgument>
+      <code>$value</code>
+    </PossiblyNullArgument>
+  </file>
   <file src="src/Internal/Transport/Request/NewTimer.php">
     <PossiblyNullPropertyFetch>
       <code><![CDATA[CarbonInterval::make($interval)->totalMilliseconds]]></code>
@@ -939,27 +948,18 @@
     </MoreSpecificReturnType>
   </file>
   <file src="src/Internal/Workflow/Process/Process.php">
-    <InternalClass>
-      <code>Scope</code>
-      <code>parent::__construct($services, $ctx)</code>
-      <code>parent::start($handler, $values)</code>
-    </InternalClass>
-    <InternalMethod>
-      <code>createScope</code>
-      <code>getContext</code>
-      <code>makeCurrent</code>
-      <code>onClose</code>
-      <code>parent::__construct($services, $ctx)</code>
-      <code>parent::start($handler, $values)</code>
-      <code>promise</code>
-      <code>startSignal</code>
-    </InternalMethod>
+    <InvalidDocblock>
+      <code>class Process extends Scope implements ProcessInterface</code>
+    </InvalidDocblock>
     <MissingClosureParamType>
       <code>$result</code>
     </MissingClosureParamType>
     <MissingParamType>
       <code>$result</code>
     </MissingParamType>
+    <MissingTemplateParam>
+      <code>ProcessInterface</code>
+    </MissingTemplateParam>
     <PropertyNotSetInConstructor>
       <code>Process</code>
     </PropertyNotSetInConstructor>
@@ -973,69 +973,10 @@
     <ArgumentTypeCoercion>
       <code><![CDATA[$this->context]]></code>
     </ArgumentTypeCoercion>
-    <InternalClass>
-      <code><![CDATA[new Scope($this->services, $this->context)]]></code>
-    </InternalClass>
-    <InternalMethod>
-      <code>attach</code>
-      <code>call</code>
-      <code>callSignalHandler</code>
-      <code>createScope</code>
-      <code>createScope</code>
-      <code>defer</code>
-      <code>defer</code>
-      <code>handleError</code>
-      <code>handleError</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code>makeCurrent</code>
-      <code><![CDATA[new Scope($this->services, $this->context)]]></code>
-      <code>next</code>
-      <code>next</code>
-      <code>next</code>
-      <code>next</code>
-      <code>next</code>
-      <code>nextPromise</code>
-      <code>nextPromise</code>
-      <code>nextPromise</code>
-      <code>nextPromise</code>
-      <code>onClose</code>
-      <code>onException</code>
-      <code>onException</code>
-      <code>onException</code>
-      <code>onException</code>
-      <code>onException</code>
-      <code>onResult</code>
-      <code>start</code>
-    </InternalMethod>
-    <InternalProperty>
-      <code><![CDATA[$scope->detached]]></code>
-      <code><![CDATA[$scope->layer]]></code>
-      <code><![CDATA[$this->cancelID]]></code>
-      <code><![CDATA[$this->cancelID]]></code>
-      <code><![CDATA[$this->cancelID]]></code>
-      <code><![CDATA[$this->cancelID]]></code>
-      <code><![CDATA[$this->cancelled]]></code>
-      <code><![CDATA[$this->context]]></code>
-      <code><![CDATA[$this->coroutine]]></code>
-      <code><![CDATA[$this->coroutine]]></code>
-      <code><![CDATA[$this->coroutine]]></code>
-      <code><![CDATA[$this->deferred]]></code>
-      <code><![CDATA[$this->exception]]></code>
-      <code><![CDATA[$this->onCancel]]></code>
-      <code><![CDATA[$this->onCancel]]></code>
-      <code><![CDATA[$this->onCancel]]></code>
-      <code><![CDATA[$this->onCancel]]></code>
-      <code><![CDATA[$this->onClose]]></code>
-      <code><![CDATA[$this->result]]></code>
-      <code><![CDATA[$this->scopeContext]]></code>
-      <code><![CDATA[$this->services]]></code>
-    </InternalProperty>
+    <InvalidArgument>
+      <code>$onFulfilled</code>
+      <code>$onRejected</code>
+    </InvalidArgument>
     <LessSpecificReturnStatement>
       <code><![CDATA[$this->context]]></code>
     </LessSpecificReturnStatement>
@@ -1067,6 +1008,9 @@
       <code>resolveConditions</code>
       <code>resolveConditions</code>
     </UndefinedInterfaceMethod>
+    <UnusedClosureParam>
+      <code>$e</code>
+    </UnusedClosureParam>
   </file>
   <file src="src/Internal/Workflow/ProcessCollection.php">
     <DocblockTypeContradiction>
@@ -1082,14 +1026,6 @@
     </PossiblyNullReference>
   </file>
   <file src="src/Internal/Workflow/ScopeContext.php">
-    <InternalMethod>
-      <code>getLayer</code>
-      <code>getLayer</code>
-      <code>isCancelled</code>
-      <code>onAwait</code>
-      <code>startScope</code>
-      <code>startScope</code>
-    </InternalMethod>
     <PropertyNotSetInConstructor>
       <code>$onRequest</code>
       <code>$parent</code>
@@ -1153,6 +1089,12 @@
       <code>$promiseOrValue</code>
       <code>$promiseOrValue</code>
     </MissingParamType>
+    <PossiblyInvalidArgument>
+      <code>$reasons</code>
+    </PossiblyInvalidArgument>
+    <TooManyArguments>
+      <code>$reduce($c, $value, $i++, $total)</code>
+    </TooManyArguments>
   </file>
   <file src="src/Worker/ActivityInvocationCache/ActivityInvocationCacheInterface.php">
     <MissingParamType>

diff --git a/src/Internal/Promise/Reasons.php b/src/Internal/Promise/Reasons.php
@@ -21,7 +21,7 @@
 final class Reasons extends RuntimeException implements Iterator, ArrayAccess, Countable
 {
     /**
-     * @param array<array-key, Traversable> $collection
+     * @param array<TKey, TValue> $collection
      */
     public function __construct(
         public array $collection,
@@ -59,11 +59,19 @@ public function offsetExists(mixed $offset): bool
         return isset($this->collection[$offset]);
     }
 
+    /**
+     * @param TKey $offset
+     * @return TValue
+     */
     public function offsetGet(mixed $offset): Traversable
     {
         return $this->collection[$offset];
     }
 
+    /**
+     * @param TKey $offset
+     * @param TValue $value
+     */
     public function offsetSet(mixed $offset, mixed $value): void
     {
         $this->collection[$offset] = $value;

diff --git a/src/Internal/Transport/CompletableResult.php b/src/Internal/Transport/CompletableResult.php
@@ -17,6 +17,10 @@
 use Temporal\Workflow;
 use Temporal\Workflow\WorkflowContextInterface;
 
+/**
+ * @template T of mixed
+ * @implements CompletableResultInterface<T>
+ */
 class CompletableResult implements CompletableResultInterface
 {
     /**
@@ -41,6 +45,8 @@ class CompletableResult implements CompletableResultInterface
 
     /**
      * @var PromiseInterface
+     *
+     * todo: ask Anton why we don't use it in the deferred
      */
     private PromiseInterface $promise;
 
@@ -95,7 +101,11 @@ public function getValue()
     }
 
     /**
-     * {@inheritDoc}
+     * @param (callable(mixed): mixed)|null $onFulfilled
+     * @param (callable(\Throwable): mixed)|null $onRejected
+     * @param callable|null $onProgress
+     *
+     * @return PromiseInterface
      */
     public function then(
         ?callable $onFulfilled = null,
@@ -108,7 +118,7 @@ public function then(
     }
 
     /**
-     * @return PromiseInterface
+     * @return PromiseInterface<T>
      */
     public function promise(): PromiseInterface
     {
@@ -173,6 +183,12 @@ public function always(callable $onFulfilledOrRejected): PromiseInterface
         return $this->finally($this->wrapContext($onFulfilledOrRejected));
     }
 
+    /**
+     * @template TParam of mixed
+     * @template TReturn of mixed
+     * @param (callable(TParam): TReturn)|null $callback
+     * @return ($callback is null ? null : (callable(TParam): TReturn))
+     */
     private function wrapContext(?callable $callback): ?callable
     {
         if ($callback === null) {

diff --git a/src/Internal/Workflow/Process/Process.php b/src/Internal/Workflow/Process/Process.php
@@ -18,8 +18,12 @@
 use Temporal\Internal\ServiceContainer;
 use Temporal\Internal\Workflow\WorkflowContext;
 use Temporal\Worker\LoopInterface;
+use Temporal\Workflow\CancellationScopeInterface;
 use Temporal\Workflow\ProcessInterface;
 
+/**
+ * @implements CancellationScopeInterface<mixed>
+ */
 class Process extends Scope implements ProcessInterface
 {
     /**

diff --git a/src/Internal/Workflow/Process/Scope.php b/src/Internal/Workflow/Process/Scope.php
@@ -34,6 +34,7 @@
  *
  * @internal CoroutineScope is an internal library class, please do not use it in your code.
  * @psalm-internal Temporal\Internal\Workflow
+ * @implements CancellationScopeInterface<mixed>
  */
 class Scope implements CancellationScopeInterface
 {

diff --git a/src/Promise.php b/src/Promise.php
@@ -12,6 +12,7 @@
 namespace Temporal;
 
 use React\Promise\Exception\LengthException;
+use React\Promise\Internal\RejectedPromise;
 use React\Promise\PromiseInterface;
 use Temporal\Internal\Promise\CancellationQueue;
 
@@ -207,7 +208,7 @@ static function (mixed $mapped) use ($i, &$values, &$toResolve, $resolve): void
      *
      * @psalm-param PromiseReduceCallback $reduce
      * @param iterable<int, PromiseInterface|mixed> $promises
-     * @param callable $reduce
+     * @param callable(mixed $current, mixed $carry, int $current, positive-int $items): mixed $reduce
      * @param mixed $initial
      * @return PromiseInterface
      */
@@ -297,7 +298,7 @@ public static function resolve($promiseOrValue = null): PromiseInterface
      * the value of another promise.
      *
      * @param $promiseOrValue
-     * @return PromiseInterface
+     * @return PromiseInterface<never>
      */
     public static function reject($promiseOrValue = null): PromiseInterface
     {
@@ -311,8 +312,9 @@ public static function reject($promiseOrValue = null): PromiseInterface
      * The returned promise will become **infinitely pending** if  `$promisesOrValues`
      * contains 0 items.
      *
-     * @param iterable $promisesOrValues
-     * @return PromiseInterface
+     * @template T
+     * @param iterable<PromiseInterface<T>|T> $promisesOrValues
+     * @return PromiseInterface<T>
      */
     public static function race(iterable $promisesOrValues): PromiseInterface
     {

diff --git a/src/Workflow/CancellationScopeInterface.php b/src/Workflow/CancellationScopeInterface.php
@@ -13,6 +13,10 @@
 
 use React\Promise\PromiseInterface;
 
+/**
+ * @template T
+ * @extends PromiseInterface<T>
+ */
 interface CancellationScopeInterface extends PromiseInterface
 {
     /**

diff --git a/src/Workflow/ProcessInterface.php b/src/Workflow/ProcessInterface.php
@@ -13,6 +13,10 @@
 
 use Temporal\Internal\Repository\Identifiable;
 
+/**
+ * @template T
+ * @extends CancellationScopeInterface<T>
+ */
 interface ProcessInterface extends CancellationScopeInterface, Identifiable
 {
     /**