Merge branch 'master' into camper/missing-dependency-cooldown-finding-cooldown-sdk-php

Author: xepozz

.github/workflows/run-test-suite.yml

@@ -53,7 +53,12 @@ jobs:
     strategy:
       fail-fast: ${{ inputs.fail-fast }}
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php:
+          - 8.1
+          - 8.2
+          - 8.3
+          - 8.4
+          - 8.5
         os: [ ubuntu-latest ]
         extensions-suffix: [ '', ', protobuf' ]
         dependencies: [ lowest , highest ]

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+This doc is intended for contributors to `sdk-php` (hopefully that's you!)
+
+All contributors must complete the Temporal Contributor License Agreement (CLA) before changes can be merged. A link to the CLA will be posted in the PR.
+
+## Development environment
+
+- [PHP 8.1+](https://www.php.net/downloads.php)
+- [Composer](https://getcomposer.org/download/)
+
+## Build
+
+```bash
+composer install              # Downloads regular dependencies
+composer run get:binaries     # Downloads dependencies for local development
+pecl install grpc             # Required by the Temporal client
+pecl install protobuf         # Improves performance of protobuf serialization
+```
+
+## Test
+
+```bash
+composer run test:unit        # Unit tests
+composer run test:func        # Functional tests
+composer run test:arch        # Architecture tests
+composer run test:accept      # All acceptance tests
+composer run test:accept-fast # All acceptance tests except the slow ones
+composer run test:accept-slow # Only the slow acceptance tests
+```
+
+## Quality control
+
+```bash
+composer run cs:diff          # Show code style violations (dry run)
+composer run cs:fix           # Auto-fix code style violations
+composer run psalm            # Run static analysis
+composer run psalm:baseline   # Update the Psalm baseline file
+```

README.md

@@ -1,3 +1,5 @@
+![Temporal PHP SDK](https://raw.githubusercontent.com/temporalio/assets/main/files/w/php.png)
+
 # Temporal PHP SDK
 
 Temporal is a distributed, scalable, durable, and highly available orchestration
@@ -140,6 +142,10 @@ Web UI will be available at `http://localhost:8000`.
 For advanced autocomplete while coding in PHPStorm, use [Meta Storm plugin](https://github.com/xepozz/meta-storm-idea-plugin).
 The plugin provides better autocomplete and links Workflow and Activity when writing and debugging code.
 
+## Contibuting
+
+We'd love your help improving the Temporal PHP SDK. Please review our [contribution guidelines](./CONTRIBUTING.md).
+
 ## Resources
 
 Read the docs  

composer.json

@@ -40,7 +40,7 @@
         "spiral/roadrunner-kv": "^4.3.1",
         "spiral/roadrunner-worker": "^3.6.2",
         "symfony/filesystem": "^5.4.45 || ^6.4.13 || ^7.0 || ^8.0",
-        "symfony/http-client": "^5.4.49 || ^6.4.17 || ^7.0 || ^8.0",
+        "symfony/http-client": "^5.4.53 || ^6.4.17 || ^7.0 || ^8.0",
         "symfony/polyfill-php83": "^1.31.0",
         "symfony/process": "^5.4.51 || ^6.4.15 || ^7.0 || ^8.0"
     },

phpunit.xml.dist

@@ -82,6 +82,9 @@
             <directory suffix="TestCase.php">tests/Functional</directory>
         </testsuite>
     </testsuites>
+    <extensions>
+        <bootstrap class="Temporal\Tests\Acceptance\AcceptanceBootExtension"/>
+    </extensions>
     <groups>
         <exclude>
             <group>skip-on-test-server</group>

src/Activity.php

@@ -95,11 +95,10 @@ public static function hasHeartbeatDetails(): bool
      *
      * This method retrieves the payload that was passed into the last call of the {@see Activity::heartbeat()} method.
      *
-     * @param null|mixed $type
      * @psalm-param TType $type
      * @throws OutOfContextException in the absence of the activity execution context.
      */
-    public static function getHeartbeatDetails($type = null): mixed
+    public static function getHeartbeatDetails(mixed $type = null): mixed
     {
         $context = self::getCurrentContext();
 
@@ -158,7 +157,7 @@ public static function doNotCompleteOnReturn(): void
      *
      * @throws OutOfContextException in the absence of the activity execution context.
      */
-    public static function heartbeat($details): void
+    public static function heartbeat(mixed $details): void
     {
         $context = self::getCurrentContext();
 

src/Activity/ActivityCancellationDetails.php

@@ -18,5 +18,6 @@ public function __construct(
         public readonly bool $paused = false,
         public readonly bool $timedOut = false,
         public readonly bool $workerShutdown = false,
+        public readonly bool $reset = false,
     ) {}
 }

src/Activity/ActivityContextInterface.php

@@ -17,6 +17,7 @@
 use Temporal\Exception\Client\ActivityCanceledException;
 use Temporal\Exception\Client\ActivityCompletionException;
 use Temporal\Exception\Client\ActivityPausedException;
+use Temporal\Exception\Client\ActivityResetException;
 
 /**
  * @psalm-import-type TType from Type
@@ -67,6 +68,7 @@ public function doNotCompleteOnReturn(): void;
      * @throws ActivityCompletionException
      * @throws ActivityCanceledException
      * @throws ActivityPausedException
+     * @throws ActivityResetException
      *
      * @see Activity::heartbeat()
      *

src/Client/Update/UpdateHandle.php

@@ -20,6 +20,7 @@
 /**
  * UpdateHandle is a handle to an update workflow execution request that can be used to get the
  * status of that update request.
+ * @template ReturnType
  */
 final class UpdateHandle
 {
@@ -67,6 +68,7 @@ public function hasResult(): bool
      *
      * @param int|float|null $timeout Timeout in seconds. Accuracy to milliseconds.
      *
+     * @return ReturnType
      * @throws WorkflowUpdateException
      * @throws WorkflowUpdateRPCTimeoutOrCanceledException
      */

src/Client/Workflow/WorkflowExecutionDescription.php

@@ -4,6 +4,7 @@
 
 namespace Temporal\Client\Workflow;
 
+use Temporal\Workflow\PendingActivityInfo;
 use Temporal\Workflow\WorkflowExecutionConfig;
 use Temporal\Workflow\WorkflowExecutionInfo;
 
@@ -15,10 +16,13 @@
 final class WorkflowExecutionDescription
 {
     /**
+     * @param list<PendingActivityInfo> $pendingActivities
+     *
      * @internal
      */
     public function __construct(
         public readonly WorkflowExecutionConfig $config,
         public readonly WorkflowExecutionInfo $info,
+        public readonly array $pendingActivities = [],
     ) {}
 }