Merge branch 'master' into timeout-exc

Author: xepozz

.gitattributes

@@ -5,7 +5,9 @@
 /resources/scripts/    export-ignore
 /runtime/              export-ignore
 /tests/                export-ignore
+/patches/              export-ignore
 
 /*.xml                 export-ignore
 /*.xml.dist            export-ignore
 Makefile               export-ignore
+patches.lock.json      export-ignore

.github/CODEOWNERS

@@ -1,3 +1 @@
-* @temporalio/sdk
-* @roxblnfk
-* @wolfy-j
+*  @temporalio/sdk @roxblnfk @wolfy-j

.github/workflows/docs.yml

@@ -5,16 +5,23 @@ on:
     branches:
       - "master"
 
+permissions:
+  contents: read
+  actions: write
+
 jobs:
   docs:
+    permissions:
+      contents: read
+      actions: write
     name: Generating API documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
         with:
           submodules: recursive
 
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6
         with:
           node-version: 20
 
@@ -23,7 +30,7 @@ jobs:
 
       - name: Cache phpDocumentor build files
         id: phpdocumentor-cache
-        uses: actions/cache@v3
+        uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5
         with:
           path: .phpdoc/cache
           key: ${{ runner.os }}-phpdocumentor-${{ github.sha }}

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

@@ -38,8 +38,13 @@ on:
       - 'psalm-baseline.xml'
       - '.editorconfig'
 
+permissions:
+  contents: read
+
 jobs:
   test:
+    permissions:
+      contents: read
     name: PHP${{ matrix.php }}${{ matrix.extensions-suffix }}, ${{ matrix.os }}, ${{ matrix.dependencies }} deps
     runs-on: ${{ matrix.os }}
     timeout-minutes: ${{ inputs.test-timeout }}
@@ -48,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 ]
@@ -65,10 +75,10 @@ jobs:
           git config --global core.eol lf
 
       - name: Check Out Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Setup PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, sockets, grpc, curl ${{ matrix.extensions-suffix }}
@@ -77,7 +87,7 @@ jobs:
         run: composer validate --strict
 
       - name: Install dependencies with composer
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@5c2bcf28d7b060ef3c601d7b476d5430a7b46c27 # v4
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
@@ -95,6 +105,8 @@ jobs:
 
       - name: Run tests
         run: ${{ inputs.test-command }}
+        env:
+          XDEBUG_MODE: off
 
       - name: Check for failures
         if: steps.validate.outcome == 'failure'

.github/workflows/security-check.yml

@@ -2,12 +2,17 @@ name: Security
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
 concurrency:
   cancel-in-progress: ${{ !contains(github.ref, 'release/')}}
   group: tests-${{ github.workflow }}-${{ github.ref }}
 
 jobs:
   security:
+    permissions:
+      contents: read
     name: Security Checks (PHP ${{ matrix.php }}, OS ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
@@ -18,16 +23,16 @@ jobs:
         os: [ ubuntu-latest ]
     steps:
       - name: Set up PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, sockets, grpc, curl
 
       - name: Check Out Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Install dependencies with composer
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@5c2bcf28d7b060ef3c601d7b476d5430a7b46c27 # v4
         with:
           dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/static-analysis.yml

@@ -2,12 +2,17 @@ name: Static Analysis
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
 concurrency:
   cancel-in-progress: ${{ !contains(github.ref, 'release/')}}
   group: tests-${{ github.workflow }}-${{ github.ref }}
 
 jobs:
   psalm:
+    permissions:
+      contents: read
     name: Psalm Validation (PHP ${{ matrix.php }}, OS ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     continue-on-error: true
@@ -18,23 +23,25 @@ jobs:
         os: [ubuntu-latest]
     steps:
       - name: Set up PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom
 
       - name: Check Out Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
 
       - name: Install dependencies with composer
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@5c2bcf28d7b060ef3c601d7b476d5430a7b46c27 # v4
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
       - name: 🔍 Run Tests
         run: vendor/bin/psalm
 
   arch:
+    permissions:
+      contents: read
     name: Architecture tests
     runs-on: ${{ matrix.os }}
     continue-on-error: true
@@ -45,18 +52,18 @@ jobs:
         os: [ubuntu-latest]
     steps:
       - name: Set up PHP ${{ matrix.php }}
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom
 
       - name: Check Out Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
         with:
           fetch-depth: 1
 
       - name: Install dependencies with composer
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@5c2bcf28d7b060ef3c601d7b476d5430a7b46c27 # v4
         with:
           dependency-versions: ${{ matrix.dependencies }}
 

.github/workflows/testing.yml

@@ -2,19 +2,26 @@ name: Testing
 
 on: [push, pull_request]
 
+permissions:
+  contents: read
+
 concurrency:
   cancel-in-progress: ${{ !contains(github.ref, 'release/')}}
   group: tests-${{ github.workflow }}-${{ github.ref }}
 
 jobs:
   unit:
+    permissions:
+      contents: read
     name: Unit Testing
     uses: ./.github/workflows/run-test-suite.yml
     with:
       fail-fast: false
       test-command: composer test:unit
 
   functional:
+    permissions:
+      contents: read
     name: Functional Testing
     uses: ./.github/workflows/run-test-suite.yml
     with:
@@ -23,6 +30,8 @@ jobs:
       download-binaries: true
 
   acceptance-slow:
+    permissions:
+      contents: read
     name: Acceptance Testing (Slow)
     uses: ./.github/workflows/run-test-suite.yml
     with:
@@ -31,6 +40,8 @@ jobs:
       download-binaries: true
 
   acceptance-fast:
+    permissions:
+      contents: read
     name: Acceptance Testing (Fast)
     uses: ./.github/workflows/run-test-suite.yml
     with:

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

@@ -25,7 +25,7 @@
         "ext-curl": "*",
         "ext-json": "*",
         "google/common-protos": "^4.9",
-        "google/protobuf": "^4.31.1",
+        "google/protobuf": "^4.33.6 || ^5.34.0",
         "grpc/grpc": "^1.57",
         "internal/destroy": "^1.0",
         "internal/promise": "^3.4",
@@ -62,7 +62,7 @@
         "cweagans/composer-patches": "^2.0",
         "dereuromark/composer-prefer-lowest": "^0.1.10",
         "doctrine/annotations": "^1.14.4 || ^2.0.2",
-        "internal/dload": "^1.2.0",
+        "internal/dload": "^1.10.0",
         "internal/toml": "^1.0.3",
         "jetbrains/phpstorm-attributes": "dev-master",
         "laminas/laminas-code": "^4.16",