Merge pull request #355: Eager Workflow start client option

src/Client/WorkflowOptions.php

@@ -57,6 +57,13 @@ final class WorkflowOptions extends Options
     #[Marshal(name: 'TaskQueue')]
     public string $taskQueue = WorkerFactoryInterface::DEFAULT_TASK_QUEUE;
 
+    /**
+     * Eager Workflow Dispatch is a mechanism that minimizes the duration from starting a workflow to the
+     * processing of the first workflow task, making Temporal more suitable for latency sensitive applications.
+     */
+    #[Marshal(name: 'EnableEagerStart')]
+    public bool $eagerStart = false;
+
     /**
      * The timeout for duration of workflow execution.
      *
@@ -199,6 +206,26 @@ public function withTaskQueue(string $taskQueue): self
         return $self;
     }
 
+    /**
+     * Eager Workflow Dispatch is a mechanism that minimizes the duration from starting a workflow to the
+     * processing of the first workflow task, making Temporal more suitable for latency sensitive applications.
+     *
+     * Eager Workflow Dispatch can be enabled if the server supports it and a local worker
+     * is available the task is fed directly to the worker.
+     *
+     * @param bool $value
+     * @return $this
+     */
+    #[Pure]
+    public function withEagerStart(bool $value = true): self
+    {
+        $self = clone $this;
+
+        $self->eagerStart = $value;
+
+        return $self;
+    }
+
     /**
      * The maximum time that parent workflow is willing to wait for a child
      * execution (which includes retries and continue as new calls). If exceeded

src/Exception/Failure/FailureConverter.php

@@ -160,7 +160,7 @@ public static function mapExceptionToFailure(\Throwable $e, DataConverterInterfa
 
             default:
                 $info = new ApplicationFailureInfo();
-                $info->setType(get_class($e));
+                $info->setType($e::class);
                 $info->setNonRetryable(false);
                 $failure->setApplicationFailureInfo($info);
         }

src/Internal/Client/WorkflowStarter.php

@@ -93,7 +93,8 @@ public function start(
             ->setWorkflowExecutionTimeout(DateInterval::toDuration($options->workflowExecutionTimeout))
             ->setWorkflowTaskTimeout(DateInterval::toDuration($options->workflowTaskTimeout))
             ->setMemo($options->toMemo($this->converter))
-            ->setSearchAttributes($options->toSearchAttributes($this->converter));
+            ->setSearchAttributes($options->toSearchAttributes($this->converter))
+            ->setRequestEagerExecution($options->eagerStart);
 
         $input = EncodedValues::fromValues($args, $this->converter);
         if (!$input->isEmpty()) {

tests/Functional/SimpleWorkflowTestCase.php

@@ -6,6 +6,7 @@
 
 use Temporal\Client\GRPC\ServiceClient;
 use Temporal\Client\WorkflowClient;
+use Temporal\Client\WorkflowOptions;
 use Temporal\Testing\ActivityMocker;
 use Temporal\Tests\TestCase;
 use Temporal\Tests\Workflow\SimpleWorkflow;
@@ -38,4 +39,12 @@ public function testWorkflowReturnsUpperCasedInput(): void
         $run = $this->workflowClient->start($workflow, 'hello');
         $this->assertSame('world', $run->getResult('string'));
     }
+
+    public function testEagerStartDoesntFail(): void
+    {
+        $workflow = $this->workflowClient
+            ->newWorkflowStub(SimpleWorkflow::class, WorkflowOptions::new()->withEagerStart());
+        $run = $this->workflowClient->start($workflow, 'hello');
+        $this->assertSame('HELLO', $run->getResult('string'));
+    }
 }

tests/Unit/DTO/WorkflowOptionsTestCase.php

@@ -32,6 +32,7 @@ public function testMarshalling(): void
         $expected = [
             'WorkflowID'               => $dto->workflowId,
             'TaskQueue'                => 'default',
+            'EnableEagerStart'         => false,
             'WorkflowExecutionTimeout' => 0,
             'WorkflowRunTimeout'       => 0,
             'WorkflowTaskTimeout'      => 0,
@@ -59,6 +60,15 @@ public function testTaskQueueChangesNotMutateState(): void
         $this->assertNotSame($dto, $dto->withTaskQueue(Uuid::v4()));
     }
 
+    public function testEagerStateNotMutateState(): void
+    {
+        $dto = new WorkflowOptions();
+
+        $this->assertNotSame($dto, $newDto = $dto->withEagerStart());
+        $this->assertFalse($dto->eagerStart);
+        $this->assertTrue($newDto->eagerStart);
+    }
+
     public function testWorkflowExecutionTimeoutChangesNotMutateState(): void
     {
         $dto = new WorkflowOptions();

tests/Unit/Exception/FailureConverterTestCase.php

@@ -29,6 +29,5 @@ public function testApplicationFailureCanTransferData(): void
 
         $this->assertSame('abc', $restoredDetails->getValue(0));
         $this->assertSame(123, $restoredDetails->getValue(1));
-
     }
 }