feature: paypal commerce agent

.php-cs-fixer.dist.php

@@ -24,7 +24,6 @@
         'general_phpdoc_annotation_remove' => ['annotations' => ['copyright', 'category']],
         'linebreak_after_opening_tag' => false,
         'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
-        'method_chaining_indentation' => true,
         'multiline_comment_opening_closing' => true,
         'multiline_whitespace_before_semicolons' => true,
         'native_function_invocation' => ['scope' => 'namespaced', 'strict' => false, 'exclude' => ['ini_get']],

composer.json

@@ -11,7 +11,7 @@
     ],
     "require": {
         "shopware/core": "~6.7.0@dev",
-        "shopware/paypal-sdk": "^1.6.2"
+        "shopware/paypal-sdk": "dev-feat/paypal-commerce-agent"
     },
     "extra": {
         "shopware-plugin-class": "Swag\\PayPal\\SwagPayPal",
@@ -42,6 +42,10 @@
             "npm run unit-setup --prefix ../../../src/Administration/Resources/app/administration",
             "npm run unit-watch --prefix src/Resources/app/administration"
         ],
+        "init:testdb": [
+            "@putenv FORCE_INSTALL=true",
+            "@phpunit --group=none --testsuite migration,unit,integration,devops"
+        ],
         "lint": [
             "@ecs-fix",
             "@phpstan",

phpstan-6.7.0.0.neon.dist

@@ -28,7 +28,9 @@ parameters:
     ignoreErrors:
         - message: '#.* method_exists\(\) with Shopware\\Core\\Checkout\\Order\\OrderEntity .*#'
           identifier: function.impossibleType
-          path: tests/Checkout/Document/Zugferd/ZugferdSubscriberTest.php
+          paths:
+            - tests/Checkout/Document/Zugferd/ZugferdSubscriberTest.php
+            - tests/AgentCommerce/SalesChannel/CheckoutRouteTest.php
 
         - identifier: symplify.noDynamicName
           path: tests/Pos/Mock/MessageBusMock.php
@@ -41,6 +43,26 @@ parameters:
             - tests/Storefront/Controller/ApplePayControllerTest.php
             - tests/Storefront/Data/CheckoutSubscriberTest.php
 
+        - message: '#^Class Shopware\\Core\\Checkout\\Payment\\Cart\\Error\\PaymentMethodBlockedError constructor invoked with 3 parameters, 1\-2 required\.$#'
+          identifier: arguments.count
+          count: 1
+          path: tests/AgentCommerce/Validation/ValidationIssuesTest.php
+
+        - message: '#^Class Shopware\\Core\\Checkout\\Shipping\\Cart\\Error\\ShippingMethodBlockedError constructor invoked with 3 parameters, 1 required\.$#'
+          identifier: arguments.count
+          count: 1
+          path: tests/AgentCommerce/Validation/ValidationIssuesTest.php
+
+        - message: '#^Class Shopware\\Storefront\\Checkout\\Cart\\Error\\PaymentMethodChangedError constructor invoked with 5 parameters, 2 required\.$#'
+          identifier: arguments.count
+          count: 1
+          path: tests/AgentCommerce/Validation/ValidationIssuesTest.php
+
+        - message: '#^Class Shopware\\Storefront\\Checkout\\Cart\\Error\\ShippingMethodChangedError constructor invoked with 5 parameters, 2 required\.$#'
+          identifier: arguments.count
+          count: 1
+          path: tests/AgentCommerce/Validation/ValidationIssuesTest.php
+
         - identifier: arguments.count
           message: '#.*PaymentMethodBlockedError.*#'
           paths:

phpstan-baseline.neon

@@ -161,3 +161,30 @@ parameters:
 			identifier: typePerfect.noMixedMethodCaller
 			count: 1
 			path: tests/Reporting/ScheduledTask/TurnoverReportingTaskHandlerTest.php
+
+		-
+			message: '#^Parameter \$contextService of method Swag\\PayPal\\AgentCommerce\\.*\:\:__construct\(\) has typehint with internal interface Shopware\\Core\\System\\SalesChannel\\Context\\SalesChannelContextServiceInterface\.$#'
+			identifier: parameter.internalInterface
+			paths:
+				- src/AgentCommerce/Util/FaviconLoader.php
+				- src/AgentCommerce/Routing/AgentRequestContextResolver.php
+				- src/AgentCommerce/SalesChannel/CreateCartRoute.php
+				- src/AgentCommerce/SalesChannel/UpdateCartRoute.php
+
+		-
+			message: '#^Property \$contextService references internal interface Shopware\\Core\\System\\SalesChannel\\Context\\SalesChannelContextServiceInterface in its type\.$#'
+			identifier: property.internalInterface
+			paths:
+				- src/AgentCommerce/Util/FaviconLoader.php
+				- src/AgentCommerce/Routing/AgentRequestContextResolver.php
+				- src/AgentCommerce/SalesChannel/AbstractAgentCommerceRoute.php
+				- src/AgentCommerce/SalesChannel/CreateCartRoute.php
+				- src/AgentCommerce/SalesChannel/UpdateCartRoute.php
+
+		-
+			message: '#^Call to method get\(\) of internal interface Shopware\\Core\\System\\SalesChannel\\Context\\SalesChannelContextServiceInterface from outside its root namespace Shopware\.$#'
+			identifier: method.internalInterface
+			paths:
+				- src/AgentCommerce/Util/FaviconLoader.php
+				- src/AgentCommerce/Routing/AgentRequestContextResolver.php
+				- src/AgentCommerce/SalesChannel/AbstractAgentCommerceRoute.php

phpstan.neon.dist

@@ -84,6 +84,35 @@ parameters:
             identifier: attribute.internalClass
             message: '#.*Shopware\\Core\\Framework\\Log\\Package#'
 
+        - # Ignore property type referencing internal Shopware\PayPalSDK classes
+            identifier: property.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Ignore instantiation of internal Shopware\PayPalSDK classes
+            identifier: new.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Ignore parameter typehint with internal Shopware\PayPalSDK classes
+            identifier: parameter.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Ignore return typehint with internal Shopware\PayPalSDK classes
+            identifier: return.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Ignore method class with internal Shopware\PayPalSDK classes
+            identifier: method.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Ignore class constant with internal Shopware\PayPalSDK classes
+            identifier: classConstant.internalClass
+            message: '#.*Shopware\\PayPalSDK\\.*#'
+
+        - # Has to be fixed upstream, but we can ignore it for now
+            message: '#Call to deprecated method __construct\(\) of class Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityDefinition#'
+            identifier: method.deprecated
+            path: 'tests/*'
+
         - # 6.8 deprecation
             identifier: method.deprecated
             message: '#__construct.*Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityDefinition.*#'
@@ -105,12 +134,13 @@ parameters:
 
         - # 6.8 deprecation - Parameter order still has to be changed
             identifier: method.deprecated
-            message: '#Call to deprecated method __construct\(\) of class .*\\PaymentMethodBlockedError#'
+            message: '#Call to deprecated method __construct\(\) of class .*\\(PaymentMethodBlockedError|ShippingMethodBlockedError|PaymentMethodChangedError|ShippingMethodChangedError)#'
             paths:
                 - src/Checkout/Cart/Validation/CartValidator.php
                 - tests/Checkout/PUI/PUISubscriberTest.php
                 - tests/Checkout/SalesChannel/MethodEligibilityRouteTest.php
                 - tests/Storefront/Data/CheckoutSubscriberTest.php
+                - tests/AgentCommerce/Validation/ValidationIssuesTest.php
 
         - # 6.8 deprecation - Will be removed
             message: '#Shopware\\Commercial\\Subscription\\Checkout\\Cart\\Recurring\\SubscriptionRecurringDataStruct#'
@@ -120,6 +150,11 @@ parameters:
                 - tests/Checkout/Method/ACDCHandlerTest.php
                 - tests/Checkout/Method/VenmoHandlerTest.php
 
+        - # 6.8 deprecation - new parameter addressId will be required
+            identifier: method.deprecated
+            message: '#Call to deprecated method __construct\(\) of class .*\\(AddressValidationError|BillingAddressBlockedError)#'
+            path: tests/AgentCommerce/Validation/ValidationIssuesTest.php
+
         - # 6.8 deprecation - reason:exception-change - Will throw \Shopware\Core\Framework\Util\UtilException instead of \Doctrine\DBAL\Exception\TableNotFoundException
             identifier: method.deprecated
             message: '#Call to deprecated method columnExists\(\) of class .*\\MigrationStep#'
@@ -128,6 +163,18 @@ parameters:
                 - src/Migration/Migration1675420139AddManagerDataToRun.php
                 - src/Migration/Migration1626082072AddStatusAndMessageCountToRun.php
 
+        - # 6.8 deprecation - reason:return-type-change - will use "strong" return type `mixed`
+            identifier: method.deprecated
+            message: '#Call to deprecated method getPayloadValue\(\) of class .*\\LineItem#'
+            paths:
+                - src/AgentCommerce/Util/PayPalCartTransformer.php
+                - src/AgentCommerce/Validation/ValidationIssues.php
+
+        - # 6.8 deprecation - Use the "defaults" property instead
+            identifier: method.deprecated
+            message: '#Call to deprecated method getDefaults\(\) of class Symfony\\Component\\Routing\\Attribute\\Route#'
+            path: tests/AgentCommerce/SalesChannel/DefaultRouteScopeTest.php
+
 rules:
     # Shopware core rules
     - Shopware\Core\DevOps\StaticAnalyze\PHPStan\Rules\Internal\InternalClassRule

src/AgentCommerce/Exception/AgentException.php

@@ -0,0 +1,172 @@
+<?php declare(strict_types=1);
+/*
+ * (c) shopware AG <info@shopware.com>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Swag\PayPal\AgentCommerce\Exception;
+
+use Shopware\Core\Framework\Log\Package;
+use Shopware\PayPalSDK\Struct\AgenticCommerce\V1\AgentErrorDetail;
+use Shopware\PayPalSDK\Struct\AgenticCommerce\V1\AgentErrorDetailCollection;
+use Symfony\Component\HttpFoundation\Response;
+
+#[Package('checkout')]
+class AgentException extends AgentHttpException
+{
+    public const INVALID_REQUEST = 'INVALID_REQUEST';
+    public const INVALID_CART_ID = 'INVALID_CART_ID';
+    public const CART_NOT_FOUND = 'CART_NOT_FOUND';
+    public const INTERNAL_SERVER_ERROR = 'INTERNAL_SERVER_ERROR';
+    public const SERVICE_UNAVAILABLE = 'SERVICE_UNAVAILABLE';
+    public const PAYMENT_PROCESSOR_UNAVAILABLE = 'PAYMENT_PROCESSOR_UNAVAILABLE';
+    public const PAYMENT_CAPTURE_FAILED = 'PAYMENT_CAPTURE_FAILED';
+    public const INVENTORY_SYSTEM_ERROR = 'INVENTORY_SYSTEM_ERROR';
+    public const ORDER_SYSTEM_ERROR = 'ORDER_SYSTEM_ERROR';
+
+    public static function requiredFieldsMissing(string ...$fields): self
+    {
+        $message = 'Required field \'{{ fields }}\' is missing';
+        $parameters = ['fields' => implode(', ', $fields)];
+        $details = new AgentErrorDetailCollection();
+
+        foreach ($fields as $field) {
+            $detail = (new AgentErrorDetail());
+            $detail->setField($field);
+            $detail->setIssue('MISSING_REQUIRED_FIELD');
+            $detail->setDescription(\sprintf('The field \'%s\' is required and cannot be empty', $field));
+
+            $details->add($detail);
+        }
+
+        return new self(
+            Response::HTTP_BAD_REQUEST,
+            self::INVALID_REQUEST,
+            $message,
+            $parameters,
+            $details
+        );
+    }
+
+    public static function requiredFieldInvalid(string $field, string $reason): self
+    {
+        $message = 'Required field \'{{ field }}\' is invalid: \'{{ reason }}\'';
+        $parameters = ['field' => $field, 'reason' => $reason];
+
+        $detail = new AgentErrorDetail();
+        $detail->setField($field);
+        $detail->setIssue('MISSING_REQUIRED_FIELD');
+        $detail->setDescription(\sprintf('The field \'%s\' is invalid: %s', $field, $reason));
+
+        return new self(
+            Response::HTTP_BAD_REQUEST,
+            self::INVALID_REQUEST,
+            $message,
+            $parameters,
+            new AgentErrorDetailCollection([$detail])
+        );
+    }
+
+    public static function invalidJSONFormat(): self
+    {
+        return new self(
+            Response::HTTP_BAD_REQUEST,
+            self::INVALID_REQUEST,
+            'Request body contains invalid JSON'
+        );
+    }
+
+    public static function unauthorized(string $message, ?\Throwable $previous = null): self
+    {
+        return new self(
+            Response::HTTP_UNAUTHORIZED,
+            self::INVALID_REQUEST,
+            $message,
+            previous: $previous,
+        );
+    }
+
+    public static function invalidCartId(): self
+    {
+        return new self(
+            Response::HTTP_BAD_REQUEST,
+            self::INVALID_CART_ID,
+            'Cart ID format is invalid. Expected format: CART-[a-zA-Z0-9]{32}'
+        );
+    }
+
+    public static function cartNotFound(string $token): self
+    {
+        return new self(
+            Response::HTTP_NOT_FOUND,
+            self::CART_NOT_FOUND,
+            'Cart with ID \'{{ token }}\' does not exist',
+            ['token' => $token]
+        );
+    }
+
+    public static function databaseConnectionFailure(): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::INTERNAL_SERVER_ERROR,
+            'A temporary system error occurred. Please try again later.'
+        );
+    }
+
+    public static function externalServiceFailure(): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::SERVICE_UNAVAILABLE,
+            'The payment processor is currently unavailable. Please try again later.'
+        );
+    }
+
+    public static function paymentProcessorUnavailable(): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::PAYMENT_PROCESSOR_UNAVAILABLE,
+            'Payment processing is temporarily unavailable'
+        );
+    }
+
+    public static function paymentCaptureFailed(string $message): self
+    {
+        $detail = (new AgentErrorDetail());
+        $detail->setField('payment_method');
+        $detail->setIssue('CAPTURE_FAILED');
+        $detail->setDescription($message);
+
+        $details = new AgentErrorDetailCollection([$detail]);
+
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::PAYMENT_CAPTURE_FAILED,
+            'Unable to capture payment at this time',
+            [],
+            $details
+        );
+    }
+
+    public static function inventorySystemError(): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::INVENTORY_SYSTEM_ERROR,
+            'Unable to reserve inventory for checkout'
+        );
+    }
+
+    public static function orderSystemError(?\Throwable $previous = null): self
+    {
+        return new self(
+            Response::HTTP_INTERNAL_SERVER_ERROR,
+            self::ORDER_SYSTEM_ERROR,
+            'Order could not be created due to system error',
+            previous: $previous,
+        );
+    }
+}

src/AgentCommerce/Exception/AgentHttpException.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ * (c) shopware AG <info@shopware.com>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Swag\PayPal\AgentCommerce\Exception;
+
+use Shopware\Core\Framework\HttpException;
+use Shopware\Core\Framework\Log\Package;
+use Shopware\PayPalSDK\Struct\AgenticCommerce\V1\AgentErrorDetailCollection;
+
+#[Package('checkout')]
+abstract class AgentHttpException extends HttpException
+{
+    public function __construct(
+        int $statusCode,
+        string $errorCode,
+        string $message,
+        array $parameters = [],
+        protected AgentErrorDetailCollection $details = new AgentErrorDetailCollection(),
+        ?\Throwable $previous = null
+    ) {
+        parent::__construct($statusCode, $errorCode, $message, $parameters, $previous);
+    }
+
+    public function getDetails(): AgentErrorDetailCollection
+    {
+        return $this->details;
+    }
+}