Merge remote-tracking branch 'origin/main' into 9.0

Author: ezimuel

.buildkite/Dockerfile

@@ -1,4 +1,4 @@
-ARG PHP_VERSION=8.0-cli
+ARG PHP_VERSION=8.4-cli
 FROM php:${PHP_VERSION}
 
 WORKDIR /usr/src/app
@@ -39,4 +39,4 @@ RUN composer install --no-progress > /dev/null
 
 COPY . .
 
-CMD ["bash", ".buildkite/yaml-tests.sh"]
+CMD ["bash", ".buildkite/yaml-tests.sh"]

.buildkite/pipeline.yml

@@ -7,17 +7,16 @@ steps:
     env:
       PHP_VERSION: "{{ matrix.php }}"
       TEST_SUITE: "{{ matrix.suite }}"
-      STACK_VERSION: 8.16.0-SNAPSHOT
+      STACK_VERSION: 9.0.0-SNAPSHOT
+      BRANCH_CLIENT_TESTS: 9.0
     matrix:
       setup:
         suite:
-          - "free"
           - "platinum"
         php:
+          - "8.4-cli"
           - "8.3-cli"
           - "8.2-cli"
           - "8.1-cli"
-          - "8.0-cli"
-          - "7.4-cli"
     command: ./.buildkite/run-tests
     artifact_paths: "*.xml"

.buildkite/run-repository.sh

@@ -9,7 +9,7 @@ script_path=$(dirname $(realpath -s $0))
 source $script_path/functions/imports.sh
 set -euo pipefail
 
-PHP_VERSION=${PHP_VERSION-8.2-cli}
+PHP_VERSION=${PHP_VERSION-8.4-cli}
 ELASTICSEARCH_URL=${ELASTICSEARCH_URL-"$elasticsearch_url"}
 elasticsearch_container=${elasticsearch_container-}
 
@@ -18,6 +18,7 @@ echo -e "\033[34;1mINFO:\033[0m TEST_SUITE ${TEST_SUITE}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m URL ${ELASTICSEARCH_URL}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m CONTAINER ${elasticsearch_container}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m PHP_VERSION ${PHP_VERSION}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m BRANCH_CLIENT_TESTS ${BRANCH_CLIENT_TESTS}\033[0m"
 
 echo -e "\033[1m>>>>> Build docker container >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\033[0m"
 
@@ -40,7 +41,8 @@ docker run \
   --env TEST_SUITE=${TEST_SUITE} \
   --env PHP_VERSION=${PHP_VERSION} \
   --env ELASTICSEARCH_URL=${ELASTICSEARCH_URL} \
+  --env BRANCH_CLIENT_TESTS=${BRANCH_CLIENT_TESTS} \
   --ulimit nofile=65535:65535 \
   --name elasticsearch-php \
   --rm \
-  elastic/elasticsearch-php
+  elastic/elasticsearch-php

.buildkite/yaml-tests.sh

@@ -1,10 +1,16 @@
 #!/usr/bin/env bash
 
-# Checkout the YAML test from Elasticsearch tag
-php util/RestSpecRunner.php
+# Clone the elasticsearch-clients-tests repository
+git clone -b ${BRANCH_CLIENT_TESTS} https://github.com/elastic/elasticsearch-clients-tests.git tests/elasticsearch-clients-tests
 
-# Generate the YAML tests for PHPUnit
-php util/build_tests.php
+# Build the YAML tests
+php tests/build_es_tests.php tests/elasticsearch-clients-tests/tests stack tests/Yaml
 
 # Run YAML tests
-vendor/bin/phpunit -c "phpunit-yaml-${TEST_SUITE}-tests.xml"
+vendor/bin/phpunit -c "phpunit-yaml-stack-tests.xml"
+
+# Remove Yaml tests
+rm -rf tests/Yaml
+
+# Remove elasticsearch-clients-tests folder
+rm -rf tests/elasticsearch-clients-tests

.github/workflows/integration_test.yml

@@ -0,0 +1,50 @@
+name: PHP integration tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        php-version: [8.1, 8.2, 8.3, 8.4]
+        os: [ubuntu-latest]
+        es-version: [9.0.0-SNAPSHOT]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Use PHP ${{ matrix.php-version }}
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+        extensions: yaml, zip, curl
+        coverage: none
+      env:
+        COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+   
+    - name: Get composer cache directory
+      id: composercache
+      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.composercache.outputs.dir }}
+        key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.json') }}
+        restore-keys: ${{ runner.os }}-php-${{ matrix.php-version }}-
+
+    - name: Install dependencies
+      run: |
+        composer install --prefer-dist
+
+    - name: Run Elasticsearch using start-local
+      run: |
+        curl -fsSL https://elastic.co/start-local | sh -s -- -v ${{ matrix.es-version }} -esonly
+
+    - name: Integration tests
+      run: |
+        source elastic-start-local/.env
+        ELASTICSEARCH_URL="http://elastic:${ES_LOCAL_PASSWORD}@localhost:9200" TEST_SUITE="free" composer run-script integration-test

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: PHP test
+name: PHP tests
 
 on: [push, pull_request]
 
@@ -9,9 +9,9 @@ jobs:
 
     strategy:
       matrix:
-        php-version: [7.4, 8.0, 8.1, 8.2, 8.3, 8.4]
+        php-version: [8.1, 8.2, 8.3, 8.4]
         os: [ubuntu-latest]
-        es-version: [8.16-SNAPSHOT]
+        es-version: [9.0.0-SNAPSHOT]
 
     steps:
     - name: Checkout

.github/workflows/yaml_test.yml

@@ -0,0 +1,57 @@
+name: PHP YAML tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        php-version: [8.1, 8.2, 8.3, 8.4]
+        os: [ubuntu-latest]
+        es-version: [9.0.0-SNAPSHOT]
+        test-suite: [stack]
+        branch-client-tests: ["9.0"]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Use PHP ${{ matrix.php-version }}
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-version }}
+        extensions: yaml, zip, curl
+        coverage: none
+      env:
+        COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+   
+    - name: Get composer cache directory
+      id: composercache
+      run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: ${{ steps.composercache.outputs.dir }}
+        key: ${{ runner.os }}-php-${{ matrix.php-version }}-${{ hashFiles('**/composer.json') }}
+        restore-keys: ${{ runner.os }}-php-${{ matrix.php-version }}-
+
+    - name: Install dependencies
+      run: |
+        composer install --prefer-dist
+
+    - name: Run Elasticsearch using start-local
+      run: |
+        curl -fsSL https://elastic.co/start-local | sh -s -- -v ${{ matrix.es-version }} -esonly
+
+    - name: Build PHPUnit tests
+      run: |
+        git clone -b ${{ matrix.branch-client-tests }} https://github.com/elastic/elasticsearch-clients-tests.git tests/elasticsearch-clients-tests
+        php tests/build_es_tests.php tests/elasticsearch-clients-tests/tests ${{ matrix.test-suite }} tests/Yaml
+
+    - name: YAML tests
+      run: |
+        source elastic-start-local/.env
+        ELASTICSEARCH_URL="http://elastic:${ES_LOCAL_PASSWORD}@localhost:9200" TEST_SUITE="free" vendor/bin/phpunit -c "phpunit-yaml-${{ matrix.test-suite }}-tests.xml"

.gitignore

@@ -27,6 +27,7 @@ util/cache/
 util/*.zip
 util/output/
 util/rest-spec
+elastic-start-local/
 
 # Doctum docs generator
 /doctum.phar
@@ -35,6 +36,7 @@ util/doctum.phar
 # PHPUnit
 /phpunit.xml
 .phpunit.result.cache
+.phpunit.cache/
 
 # Code coverage
 build

BREAKING_CHANGES.md

@@ -1,3 +1,7 @@
+# 9.0
+
+- **Use of PHP 8.1+:** Starting from 9.0.0 the `elasticsearch-php` client requires PHP 8.1+.
+
 # 8.0
 
 This major release is a complete new PHP client for Elasticsearch. We build it from scratch!

CHANGELOG.md

@@ -1,3 +1,27 @@
+## Release 9.0.0
+
+- **Use of PHP 8.1+:** Starting from 9.0.0 the `elasticsearch-php` client requires PHP 8.1+.
+- **Compatibility with Elasticsearch 9.0:** All changes and additions to Elasticsearch APIs for its 9.0 release are reflected in this release.
+- **Serverless client merged in:** the `elastic/elasticsearch-serverless` client is being deprecated, and its functionality has been merged back into this client. This should have zero impact on the way the client works by default. If an endpoint is available in serverless, the PHP function will contains a `@group serverless` phpdoc attribute.
+If you try to use an endpoint that is not available in serverless you will get a `410` HTTP error with a message as follows:
+"this endpoint exists but is not available when running in serverless mode".
+The 9.0.0 client can recognize that it is communicating with a serverless instance if you are using a URL managed by Elastic (e.g. `*.elastic.cloud`).
+If you are using a proxy, the client will be able to recognize that the host is serverless from the first response. Alternatively, you can explicitly indicate that the host is serverless using the `Client::setServerless(true)` function (`false` by default).
+- **New transport library with PSR-18 cURL client as default:** we've removed the Guzzle dependency from the client. By default, the built-in cURL-based HTTP client will be used if no other PSR-18 compatible clients are detected. See release [9.0.0](https://github.com/elastic/elastic-transport-php/releases/tag/v9.0.0) of elastic-transport-php.
+
+## Release 8.17.1
+
+- Fix and improvements for PHPStan (rule level 5) #1442 (thanks @AJenbo)
+
+## Release 8.17.0
+
+- Updated the APIs to Elasticsearch [8.17.0](https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-8.17.0.html)
+
+## Release 8.16.0
+
+- Updated the APIs to Elasticsearch [8.16.0](https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-8.16.0.html)
+- Added the support of PHP 8.4 #1415 (thanks @ruudk)
+
 ## Release 8.15.0
 
 Updated the APIs to Elasticsearch [8.15.0](https://www.elastic.co/guide/en/elasticsearch/reference/current/release-notes-8.15.0.html) and added the support of OpenTelemetry.

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing to the PHP Elasticsearch Client
+
+If you have a bugfix or new feature that you would like to contribute to
+elasticsearch-php, please find or open an issue about it first. Talk about what
+you would like to do. It may be that somebody is already working on it, or that
+there are particular issues that you should know about before implementing the
+change.
+
+We enjoy working with contributors to get their code accepted. There are many
+approaches to fixing a problem and it is important to find the best approach
+before writing too much code.
+
+## Running Elasticsearch locally
+
+We've provided a script to start an Elasticsearch cluster of a certain version
+found at `.buildkite/run-elasticsearch.sh`.
+
+There are several environment variables that control integration tests:
+
+- `TEST_SUITE`: `free` or `platinum` for running Elasticsearch in different
+  versions.
+- `STACK_VERSION`: Version of Elasticsearch to use. These should be
+  the same as tags of `docker.elastic.co/elasticsearch/elasticsearch`
+  such as `8.0.0-SNAPSHOT`, `7.x-SNAPSHOT`, etc. Defaults to the
+  same `*-SNAPSHOT` version as the branch.
+
+**NOTE: You don't need to run the live integration tests for all changes. If
+you don't have Elasticsearch running locally the integration tests will be skipped.**
+
+## API Code Generation
+
+All API methods in `src/Endpoints` and in `src/Traits/ClientEndpointsTrait.php` are
+automatically generated from the [Elasticsearch specification](https://github.com/elastic/elasticsearch-specification)
+and [rest-api-spec](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/api).
+
+You can check if a PHP file has been generated searching for `@generated` tag
+in the source code (e.g. [here](https://github.com/elastic/elasticsearch-php/blob/main/src/Traits/ClientEndpointsTrait.php#L27)
+in the `ClientEndpointsTrait.php`).
+
+Any changes to these files should be avoid, you can submit to the Elasticsearch 
+specification project and will be imported the next time the client will be generated.
+The generator itself is currently a private project.
+
+## Contributing Code Changes
+
+The process for contributing to any of the Elasticsearch repositories is similar.
+
+1. Please make sure you have signed the [Contributor License
+   Agreement](http://www.elastic.co/contributor-agreement/). We are not
+   asking you to assign copyright to us, but to give us the right to distribute
+   your code without restriction. We ask this of all contributors in order to
+   assure our users of the origin and continuing existence of the code. You only
+   need to sign the CLA once.
+
+2. Run the linter and test suite to ensure your changes do not break existing code.
+   Run the last optional step only if you want to test your changes with the
+   integration tests. You need to specify the `STACK_VERSION` of Elasticsearch (e.g.
+   `8.17.0`), you can check the Elasticsearch versions [here](https://github.com/elastic/elasticsearch/releases).
+
+   ```
+   # Run PHPStan, see https://phpstan.org/
+   $ composer run-script phpstan
+   
+   # Run the unit tests
+   $ composer run-script test
+   
+   # Run the integration tests (optional)
+   $ STACK_VERSION="8.17.0" .buildkite/run-tests
+   ```
+
+3. Rebase your changes.
+   Update your local repository with the most recent code from the main
+   elasticsearch-php repository, and rebase your branch on top of the latest branch.
+   If you want to propose a change in the latest version, you need to use the `main`
+   branch. If you are proposing for `8.x` version you should use the latest
+   minor branch (e.g. `8.17`). If want to propose a change for the oldest versions
+   you need to use the `7.17` or `6.8.x` branches. Remember, we support only the latest
+   minor of the previous majour. For instance, if the latest version is `8.x` we
+   support the last minor of `7.x` (i.e. `7.17`).
+   We prefer your changes to be squashed into a single commit for easier
+   backporting.
+
+4. Submit a pull request. Push your local changes to your forked copy of the
+   repository and submit a pull request. In the pull request, describe what your
+   changes do and mention the number of the issue where discussion has taken
+   place, eg “Closes #123″.  Please consider adding or modifying tests related to
+   your changes.
+
+Then sit back and wait. There will probably be a discussion about the pull
+request and, if any changes are needed, we would love to work with you to get
+your pull request merged into elasticsearch-php.
+
+Thanks in advance for all your future contributions!