Checkout openapi generator upgrade by ashwaniarya-adyen · Pull Request #937 · Adyen/adyen-php-api-library

ashwaniarya-adyen · 2026-09-14T14:41:47Z

Checkout openapi generator upgrade

gemini-code-assist

Code Review

This pull request upgrades the library's PHP requirement to ^8.1, updates dependencies, and introduces core services, configurations, and a large set of auto-generated model classes for the BinLookup and Checkout APIs. Key feedback includes addressing a critical missing import of AdyenException in BaseService.php that would cause runtime failures, fixing a regex range bug and a float-to-int precision issue in HeaderSelector.php, and adding error handling for fopen along with fixing a falsy stream-reading loop in ObjectSerializer.php. Additionally, it is recommended to adopt PHP 8.1's str_contains instead of strpos and correct a parameter type mismatch in HeaderSelector.php.

I am having trouble creating individual review comments. Click here to see my feedback.

src/Adyen/BaseService.php (3)

The AdyenException class is defined in the Adyen\\Exception namespace. Since BaseService is in the Adyen namespace, throwing AdyenException without importing it will result in a runtime Class \"Adyen\\AdyenException\" not found error. Please add a use statement to import Adyen\\Exception\\AdyenException.

namespace Adyen;

use Adyen\Exception\AdyenException;

src/Adyen/HeaderSelector.php (99)

In PHP's PCRE, an unescaped - between two characters in a character class defines a range. Here, +-^ defines a range from + (ASCII 43) to ^ (ASCII 94), which matches many unintended characters (such as /, @, A-Z, etc.). To match a literal -, it should be escaped as \\-.

        return preg_match('~^application/(json|[\w!#$&.+\-^_]+\+json)\s*(;|$)~', $searchString) === 1;

src/Adyen/HeaderSelector.php (176)

Casting the result of a float multiplication to (int) can lead to incorrect values due to floating-point precision issues in PHP. For example, (int)(\"0.58\" * 1000) evaluates to 579 instead of 580. Using round() before casting to (int) ensures correct rounding.

                'weight' => (int) round($outputArray[2] * 1000),

src/Adyen/Model/BinLookup/ObjectSerializer.php (461-465)

If fopen fails to open the file, it returns false. Writing to or closing a boolean value will trigger PHP warnings/errors. You should handle the failure of fopen explicitly.\n\nAdditionally, the loop condition while ($chunk = $data->read(200)) will terminate prematurely if a chunk of the stream is exactly \"0\", because \"0\" is falsy in PHP. The loop should check against '' explicitly.

            $file = fopen($filename, 'w');
            if ($file === false) {
                throw new \RuntimeException("Failed to open file for writing: " . $filename);
            }
            while (($chunk = $data->read(200)) !== '') {
                fwrite($file, $chunk);
            }
            fclose($file);

src/Adyen/BaseService.php (52)

Since PHP 8.1 is now required, you can use the more readable and type-safe str_contains() function instead of strpos() !== false.

        if (str_contains($url, "pal-")) {

src/Adyen/BaseService.php (60-62)

Since PHP 8.1 is now required, you can use the more readable and type-safe str_contains() function instead of strpos() !== false.

        if (str_contains($url, "checkout-")) {
            // Add live prefix for Checkout endpoints
            if (str_contains($url, "possdk")) {

src/Adyen/HeaderSelector.php (194)

The $currentWeight parameter is declared as float &$currentWeight, but it is always treated as an integer (initialized to 1000 and updated by getNextWeight(), which returns int). It should be typed as int &$currentWeight to maintain type consistency and avoid implicit float coercions.

    private function adjustWeight(array $headers, int &$currentWeight, bool $hasMoreThan28Headers): array

ashwaniarya-adyen · 2026-09-15T15:00:32Z

@@ -169,9 +171,9 @@ use {{modelPackage}}\ObjectSerializer;
     * @deprecated
    {{/isDeprecated}}
     */
-    public function {{operationId}}({{^exts.x-group-parameters}}{{#allParams}}{{dataType}} ${{paramName}}{{^isBodyParam}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{/isBodyParam}}, {{/allParams}}{{#servers}}{{#-first}}?int $hostIndex = null, array $variables = [], {{/-first}}{{/servers}}?\{{invokerPackage}}\RequestOptions $requestOptions = null{{/exts.x-group-parameters}}{{#exts.x-group-parameters}}$associative_array{{/exts.x-group-parameters}}): {{#returnType}}{{.}}{{/returnType}}{{^returnType}}void{{/returnType}}
+    public function {{operationId}}({{^exts.x-group-parameters}}{{#pathParams}}{{dataType}} ${{paramName}}, {{/pathParams}}{{#bodyParams}}{{dataType}} ${{paramName}}, {{/bodyParams}}{{#formParams}}{{#required}}{{#notRequiredOrIsNullable}}?{{/notRequiredOrIsNullable}}{{dataType}} ${{paramName}}, {{/required}}{{/formParams}}{{#queryParams}}{{#required}}{{#notRequiredOrIsNullable}}?{{/notRequiredOrIsNullable}}{{dataType}} ${{paramName}}, {{/required}}{{/queryParams}}{{#formParams}}{{^required}}?{{dataType}} ${{paramName}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}, {{/required}}{{/formParams}}{{#queryParams}}{{^required}}?{{dataType}} ${{paramName}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}, {{/required}}{{/queryParams}}{{#servers}}{{#-first}}?int $hostIndex = null, array $variables = [], {{/-first}}{{/servers}}?\{{invokerPackage}}\RequestOptions $requestOptions = null{{/exts.x-group-parameters}}{{#exts.x-group-parameters}}$associative_array{{/exts.x-group-parameters}}): {{#returnType}}{{.}}{{/returnType}}{{^returnType}}void{{/returnType}}


Earlier, parameters were generated in the same order as the API specification. This exposed the optional headers as a PHP method argument before the required request body, causing PHP 8.4 warnings and making it behave as required. The template now excludes header parameters from method arguments, places required parameters before optional ones, and handles headers through RequestOptions

ashwaniarya-adyen · 2026-09-15T15:03:00Z

@@ -241,7 +241,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par

        {{/parentSchema}}
        {{#vars}}
-        $this->setIfExists('{{name}}', $data ?? [], {{#defaultValue}}{{{defaultValue}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}});


The initial v7 generation automatically assigned default values from the API specification when creating a model. This caused fields that the user did not provide, to be included in outgoing requests. The previous Checkout version left unset fields as null and omitted them during serialization. This change restores that behavior.

ashwaniarya-adyen · 2026-09-15T15:05:28Z

-
-        // initialize service
-        $service = new \Adyen\Service\Checkout\PaymentsApi($client);
+        $client = $this->createMockSerializerClient($jsonFile, $httpStatus);


These tests previously created generated Checkout APIs using the legacy Adyen\Client. The v7-generated APIs now require an Adyen\Configuration and a Guzzle HTTP client separately. The tests now extend BaseTest and use its existing helpers to create both objects.

ashwaniarya-adyen · 2026-09-15T15:07:25Z

    {
-        $json = file_get_contents($jsonFile);
+        $json = $jsonFile !== null ? file_get_contents($jsonFile) : '';


This test helper previously required a JSON file. Some API calls return no response body, such as a successful delete request with status 204. The helper now allows no JSON file and uses an empty response instead.

ashwaniarya-adyen · 2026-09-15T15:08:32Z

-        $service = new RecurringApi($client);
-
-        $service->deleteTokenForStoredPaymentDetails("123");
+        $service->deleteTokenForStoredPaymentDetails("paymentMethodId", "shopperReference", "merchantAccount");


This test previously passed only the stored payment method ID. In Checkout v72, the shopper reference and merchant account are also required, so the test now provides all three values.

ashwaniarya-adyen · 2026-09-15T15:10:43Z

-        // And assert that the result is equal to a deep json encode/decode
-        #$this->assertEquals($result->toArray(), json_decode(json_encode($result->jsonSerialize()), true));
-        $this->assertEquals(ObjectSerializer::sanitizeForSerialization($result), json_decode(json_encode($result->jsonSerialize()), true));
+        $this->assertEquals(


This test previously compared an object with an array, so it failed even when both contained the same data. It now compares two arrays and correctly checks that toArray() returns the same data as JSON serialization.

ashwaniarya-adyen · 2026-09-21T11:23:31Z

        {{/vars}}
        {{#discriminator}}

        // Initialize discriminator property with the model name.
-        $this->container['{{discriminatorName}}'] = static::$openAPIModelName;
+        if (!array_key_exists('{{discriminatorName}}', $data ?? [])) {


The first v7 generation always replaced the model discriminator after loading constructor data. For example, a supplied payment method type of paypal was replaced by CheckoutPaymentMethod. The generated model name is now used only when the input does not already contain a type.

ashwaniarya-adyen · 2026-09-21T11:24:57Z

+     *
+     * @var string
+     */
+    protected string $libraryName = self::LIB_NAME;


The initial v7 configuration lost this information, so this PR adds the library name and version to Configuration.

ashwaniarya-adyen · 2026-09-21T11:26:16Z

    public function getUserAgent(): string
    {
-        return $this->userAgent;
+        $suffix = self::LIB_NAME . '/' . self::LIB_VERSION;


The initial v7 generation used OpenAPI-Generator/1.0.0/PHP as the User-Agent. This PR restores the SDK identity:
adyen-php-api-library/{version}
If an application name is configured, it is placed before the library identity.

ashwaniarya-adyen · 2026-09-21T11:27:20Z

@@ -670,9 +669,13 @@ use {{modelPackage}}\ObjectSerializer;
            $requestOptions
        );

+        $headers['adyen-library-name'] = $this->config->getLibraryName();


Compared with the initial generation, every request now includes adyen-library-name and adyen-library-version. This restores the identification headers used by the Adyen PHP library.

ashwaniarya-adyen · 2026-09-21T12:00:17Z

+     * @param object|null $requestModel
+     * @return object|null
+     */
+    protected function injectApplicationInfo(?object $requestModel): ?object


Restored the previous behavour. The initial v7 generation dropped it. The injectApplicationInfo() helper restores the old behavior, it handles applicationInfo set as an array or a model object and leaves any other merchant-provided fields untouched - here

ashwaniarya-adyen · 2026-09-21T12:01:24Z

        // for model (json/xml)
        {{#bodyParams}}
        if (isset(${{paramName}})) {
+            ${{paramName}} = $this->injectApplicationInfo(${{paramName}});


The request model is passed through injectApplicationInfo() before it is serialized. This ensures supported request bodies contain applicationInfo.adyenLibrary without adding the same logic manually to every generated operation.

ashwaniarya-adyen · 2026-09-21T12:04:13Z

     */
    public function setEnvironment(string $environment): self
    {
+        if (!in_array($environment, [Environment::TEST, Environment::LIVE], true)) {


The initial v7 changes accepted any environment string. This PR changes to only test and live are accepted. This prevents unsupported values.

ashwaniarya-adyen · 2026-09-21T12:05:21Z

          token: ${{ secrets.ADYEN_AUTOMATION_BOT_ACCESS_TOKEN }}
          develop-branch: main
-          version-files: src/Adyen/Client.php README.md
+          version-files: src/Adyen/Client.php src/Adyen/Configuration.php README.md


The release workflow now updates both Client.php and Configuration.php when creating a new release, until we removed Client.php completely

ashwaniarya-adyen · 2026-09-21T12:20:17Z

+    /**
+     * @covers \Adyen\BaseService::injectApplicationInfo
+     */
+    public function testInjectApplicationInfo()


Added test cases for injecting ApplicationInfo

ashwaniarya-adyen · 2026-09-21T12:31:25Z

+     *
+     * @var array{name: string, version: string}|null
+     */
+    protected ?array $adyenPaymentSource = null;


Earlier , adyenPaymentSource, externalPlatform, and merchantApplication were stored in the client configuration and added to applicationInfo, added them in Configuration

ashwaniarya-adyen · 2026-09-21T12:32:22Z

@@ -303,7 +305,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
        } else {
            $nullablesSetToNull = $this->getOpenAPINullablesSetToNull();
            $index = array_search('{{name}}', $nullablesSetToNull);
-            if ($index !== FALSE) {
+            if ($index !== false) {


Changes FALSE to lowercase false to follow the project PHP coding standard. This is formatting only and does not change the behavior.

ashwaniarya-adyen · 2026-09-21T12:53:39Z

Previously, most Checkout operations were tested in one large CheckoutTest. Split this into one test file for each generated API: Payments, Modifications, Orders, Donations, Payment Links, Recurring, and Utility. This makes it easier to find a test failure and update the affected API after a future regeneration.

Kept model-specific behavior in ModelBasedCheckoutTest. That file focuses on array-based construction, nested models, nullable fields, serialization, and discriminator values. The API test files focus on sending requests and reading responses.

The common setup is kept in BaseTest. It creates the Configuration, the mocked Guzzle client, and the HTTP response. It also supports operations that return HTTP 204 with no response body.

Where it makes sense for an operation, test three common ways of using the generated models:
- create the request with model setters and read the response as a model;
- create the request model from an array;
- convert the response to an array with toArray().

OpenAPI Generator 7 also creates several versions of each API operation. Testing every version for every endpoint would repeat the same generated template logic, so used representative operations:
- payments() covers the normal synchronous call;
- paymentsWithHttpInfo() verifies the response model, HTTP status, and response headers;
- paymentsAsync() verifies that the promise resolves to the expected model;
- paymentsAsyncWithHttpInfo() verifies the model, status, headers, and that RequestOptions such as the idempotency key are applied;
- deleteTokenForStoredPaymentDetailsWithHttpInfo() verifies a void operation returning HTTP 204;

The async error tests are present but currently skipped because error handling is being addressed separately in a different ticket.

sonarqubecloud · 2026-09-21T14:44:00Z

Quality Gate passed

Issues
482 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
65.9% Duplication on New Code

See analysis details on SonarQube Cloud

ashwaniarya-adyen self-assigned this Sep 14, 2026

ashwaniarya-adyen added the do not merge label Sep 14, 2026

ashwaniarya-adyen changed the base branch from main to openapi-generator-upgrade September 14, 2026 14:42

gemini-code-assist Bot reviewed Sep 14, 2026

View reviewed changes

ashwaniarya-adyen commented Sep 15, 2026

View reviewed changes

ashwaniarya-adyen commented Sep 21, 2026

View reviewed changes

ashwaniarya-adyen requested a review from gcatanese September 21, 2026 12:53

gcatanese added 7 commits September 21, 2026 16:37

Temp commit

9257bb6

Minor edit

21f3921

Customise templates

9a3fb88

Add shared classes

e0fc0b8

Update templates

93feaa8

Create shared classes

df8b3eb

Generate BinLookup

20e241f

gcatanese and others added 21 commits September 21, 2026 16:37

Deprecate previous BinLookup

3c22fe2

Add tests (removing unused tests)

d0be899

Skip tests affected by ongoing refactoring

7a4b1b3

Remove PHP 7.3 from GitHub action

6045f9e

Implement PR feedback

a9de663

Generate BinLookupApi after template update

ccdca7f

Code linting

4c2ed4c

Linting code and templates

0550494

Fix BinLookup v7 generation compatibility

4725436

Restore ctype extension requirement

47c024f

Fix optional parameter generation

ddeddc2

Fix optional parameter generation, removed additional checks

12e1f14

Fix address review comments

58a0e91

OpenAPI generator upgrade - Checkout

fd059c9

Fix Checkout v7 generation and model tests

24042b1

Fix removed unuseful comment

03a7b5e

Fix Update tests for checkoutAPI

441ecab

Fix restructured test packages

2663a9d

Fix OpenAPI Generator v7 compatibility regressions

06353da

Fix applicationInfo injection similar to older version

09e5516

Fix applicationInfo test refactored

8b61c56

ashwaniarya-adyen force-pushed the checkout-openapi-generator-upgrade branch from 8f8e89d to 8b61c56 Compare September 21, 2026 14:38

ashwaniarya-adyen force-pushed the openapi-generator-upgrade branch from 82a3216 to 8172c38 Compare September 21, 2026 14:38

Conversation

ashwaniarya-adyen commented Sep 14, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

src/Adyen/BaseService.php (3)

src/Adyen/HeaderSelector.php (99)

src/Adyen/HeaderSelector.php (176)

src/Adyen/Model/BinLookup/ObjectSerializer.php (461-465)

src/Adyen/BaseService.php (52)

src/Adyen/BaseService.php (60-62)

src/Adyen/HeaderSelector.php (194)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashwaniarya-adyen commented Sep 21, 2026

Uh oh!

sonarqubecloud Bot commented Sep 21, 2026

Quality Gate passed

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants