feat: add local environment toggle (#463)

cyl3x · cyl3x · commit 4da829c165ec · 2025-12-10T09:41:13.000+01:00
diff --git a/.bc-exclude.php b/.bc-exclude.php
@@ -9,5 +9,7 @@
         \preg_quote('An enum expression Monolog\Level::Debug is not supported in class Monolog\Handler\AbstractHandler'),
         // Storefront package is not installed
         \preg_quote('"Shopware\Storefront\Framework\Cookie\CookieProviderInterface" could not be found in the located source'),
+        // internal const
+        \preg_quote('Value of constant Swag\PayPal\Setting\Settings::DEFAULT_VALUES changed from array') . '.*',
     ],
 ];
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # REPLACE_GLOBALLY_WITH_NEXT_VERSION
 - Fixes an issue, where cookies are added even though associated payment methods are not active (shopware/SwagPayPal#457)
+- Added setting to mark the shop as local environment to preventing connection issues when testing in a non public accessable environment (shopware/SwagPayPal#463)
 
 # 9.9.0
 - Fixes an issue, where Paypal Express Checkout does not recalculate cart price after changing shipping country (shopware/SwagPayPal#342)
diff --git a/CHANGELOG_de-DE.md b/CHANGELOG_de-DE.md
@@ -1,5 +1,6 @@
 # REPLACE_GLOBALLY_WITH_NEXT_VERSION
 - Behebt ein Problem, bei dem Cookies geladen wurden, obwohl die zugehörigen Zahlungsarten nicht aktiv sind (shopware/SwagPayPal#457)
+- Fügt eine Einstellung hinzu, um den Shop als lokale Umgebung zu kennzeichnen, um Verbindungsprobleme beim Testen in einer nicht öffentlich zugänglichen Umgebung zu vermeiden (shopware/SwagPayPal#463)
 
 # 9.9.0
 - Behebt ein Problem, bei dem der Warenkorbpreis beim Verändern des Versandlandes im Express Checkout nicht angepasst wurde (shopware/SwagPayPal#342)
diff --git a/src/Checkout/ExpressCheckout/SalesChannel/ExpressCreateOrderRoute.php b/src/Checkout/ExpressCheckout/SalesChannel/ExpressCreateOrderRoute.php
@@ -14,6 +14,7 @@
 use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
 use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
 use Shopware\Core\System\SalesChannel\SalesChannelContext;
+use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Swag\PayPal\Checkout\Cart\Service\CartPriceService;
 use Swag\PayPal\Checkout\Exception\OrderZeroValueException;
 use Swag\PayPal\Checkout\TokenResponse;
@@ -22,6 +23,7 @@
 use Swag\PayPal\RestApi\V2\Api\Order\ApplicationContext;
 use Swag\PayPal\RestApi\V2\Api\Order\PaymentSource\Common\Attributes\OrderUpdateCallbackConfig;
 use Swag\PayPal\RestApi\V2\Resource\OrderResource;
+use Swag\PayPal\Setting\Settings;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Attribute\Route;
@@ -40,6 +42,7 @@ public function __construct(
         private readonly PayPalOrderBuilder $paypalOrderBuilder,
         private readonly OrderResource $orderResource,
         private readonly CartPriceService $cartPriceService,
+        private readonly SystemConfigService $systemConfigService,
         private readonly RouterInterface $router,
         private readonly LoggerInterface $logger,
     ) {
@@ -80,17 +83,21 @@ public function createPayPalOrder(Request $request, SalesChannelContext $salesCh
                 $experienceContext->setUserAction(ApplicationContext::USER_ACTION_CONTINUE);
 
                 // Configure shipping callback for dynamic price recalculation
-                $callbackConfig = new OrderUpdateCallbackConfig();
-                $callbackUrl = $this->router->generate(
-                    'store-api.paypal.express.shipping_callback',
-                    ['salesChannelId' => $salesChannelContext->getSalesChannelId(), 'token' => $salesChannelContext->getToken()],
-                    UrlGeneratorInterface::ABSOLUTE_URL,
-                );
-                $callbackConfig->setCallbackUrl($callbackUrl);
-                $callbackConfig->setCallbackEvents([OrderUpdateCallbackConfig::CALLBACK_EVENT_SHIPPING_OPTIONS]);
-                $experienceContext->setOrderUpdateCallbackConfig($callbackConfig);
+                if (!$this->systemConfigService->getBool(Settings::IS_LOCAL_ENVIRONMENT, $salesChannelContext->getSalesChannelId())) {
+                    $callbackConfig = new OrderUpdateCallbackConfig();
+                    $callbackUrl = $this->router->generate(
+                        'store-api.paypal.express.shipping_callback',
+                        ['salesChannelId' => $salesChannelContext->getSalesChannelId(), 'token' => $salesChannelContext->getToken()],
+                        UrlGeneratorInterface::ABSOLUTE_URL,
+                    );
+                    $callbackConfig->setCallbackUrl($callbackUrl);
+                    $callbackConfig->setCallbackEvents([OrderUpdateCallbackConfig::CALLBACK_EVENT_SHIPPING_OPTIONS]);
+                    $experienceContext->setOrderUpdateCallbackConfig($callbackConfig);
 
-                $this->logger->debug('Configured shipping callback', ['callbackUrl' => $callbackUrl]);
+                    $this->logger->debug('Configured shipping callback', ['callbackUrl' => $callbackUrl]);
+                } else {
+                    $this->logger->debug('Skipped shipping callback due to being disabled in system config');
+                }
             }
 
             $orderResponse = $this->orderResource->create(
diff --git a/src/Resources/app/administration/src/app/snippet/de-DE.json b/src/Resources/app/administration/src/app/snippet/de-DE.json
@@ -79,7 +79,8 @@
       "vaultingEnabledACDC": "Vaulting für Kredit- und Debitkarten-Zahlungen verwenden",
       "vaultingEnabledVenmo": "Vaulting für Venmo-Zahlungen verwenden",
       "crossBorderMessagingEnabled" : "Länderübergreifende Lokalisierung der \"Später bezahlen\"-Nachricht aktivieren",
-      "crossBorderBuyerCountry" : "Lokalisierung"
+      "crossBorderBuyerCountry" : "Lokalisierung",
+      "isLocalEnvironment": "Lokale Entwicklungsumgebung"
     },
     "helpText": {
       "clientId": "Die Client-ID der REST-API, die das Plugin dazu verwendet, sich mit der PayPal-API zu authentifizieren.",
diff --git a/src/Resources/app/administration/src/app/snippet/en-GB.json b/src/Resources/app/administration/src/app/snippet/en-GB.json
@@ -79,7 +79,8 @@
       "vaultingEnabledACDC": "Enable Vaulting for credit and debit cards",
       "vaultingEnabledVenmo": "Enable Vaulting for Venmo payments",
       "crossBorderMessagingEnabled" : "Enable cross-border localization of Pay Later message",
-      "crossBorderBuyerCountry" : "Localization"
+      "crossBorderBuyerCountry" : "Localization",
+      "isLocalEnvironment": "Local development environment"
     },
     "helpText": {
       "clientId": "The REST API client ID is used to authenticate this plugin with the PayPal API.",
diff --git a/src/Resources/app/administration/src/constant/swag-paypal-settings.constant.ts b/src/Resources/app/administration/src/constant/swag-paypal-settings.constant.ts
@@ -140,6 +140,7 @@ export const SYSTEM_CONFIGS = [
     'SwagPayPal.settings.webhookId',
     'SwagPayPal.settings.webhookExecuteToken',
 
+    'SwagPayPal.settings.isLocalEnvironment',
 
     /**
      * @deprecated tag:v10.0.0 - Will be removed without replacement.
diff --git a/src/Resources/app/administration/src/module/swag-paypal-settings/snippet/de-DE.json b/src/Resources/app/administration/src/module/swag-paypal-settings/snippet/de-DE.json
@@ -103,6 +103,10 @@
       "info": "Mit länderübergreifende Nachrichten für \"Später bezahlen\" wird die \"Später bezahlen\"-Nachricht in der Sprache des Kunden anzeigt. Diese Funktion ist nur für bestimmte Länder verfügbar. {0}",
       "buyerCountryAuto": "Automatische Bestimmung",
       "buyerCountryOverride": "Lokalisierung"
+    },
+    "environment": {
+      "title": "Umgebung",
+      "info": "PayPal sendet Bestellstatus-Updates über Webhooks an den Shop und fordert außerdem eine Neuberechnung des Warenkorbs an, wenn Kunden Änderungen in der PayPal Express Checkout-Benutzeroberfläche vornehmen. Wenn der Shop nicht öffentlich zugänglich ist (z. B. wenn es sich um eine Entwicklungs-/Staging-Umgebung handelt oder eine Authentifizierung erfordert), kannst du diese Instanz als \"lokale Umgebung\" kennzeichnen, um Verbindungsfehler zu vermeiden.\nBitte beachte, dass alle Webhook-Listener beim Speichern deregistriert werden."
     }
   },
   "swag-paypal-settings-sales-channel-switch": {
diff --git a/src/Resources/app/administration/src/module/swag-paypal-settings/snippet/en-GB.json b/src/Resources/app/administration/src/module/swag-paypal-settings/snippet/en-GB.json
@@ -103,6 +103,10 @@
       "info": "Pay Later messaging is a feature that allows you to display a Pay Later message in the language of the customer. This feature is only available for certain countries. {0}",
       "buyerCountryAuto": "Automatic determination",
       "buyerCountryOverride": "Localization"
+    },
+    "environment": {
+      "title": "Environment",
+      "info": "PayPal will send order status updates to the shop via webhooks, and will also request cart recalculations when customers make changes in the PayPal Express Checkout UI. If the shop is not publicly accessible (e.g. if it is in a development/staging environment, or if it requires authentication), you can mark this instance as a \"local environment\" to prevent connection errors.\nPlease note that any webhook listener will be deregistered when saving."
     }
   },
   "swag-paypal-settings-sales-channel-switch": {
diff --git a/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.html.twig b/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.html.twig
@@ -1,3 +1,16 @@
+<sw-card
+    class="swag-paypal-settings-environment"
+    position-identifier="swag-paypal-settings-environment"
+    :title="$t('swag-paypal-settings.environment.title')"
+    :is-loading="settingsStore.isLoading"
+>
+    <span class="swag-paypal-settings-environment__info-text">
+        {{ $t('swag-paypal-settings.environment.info') }}
+    </span>
+
+    <swag-paypal-setting path="SwagPayPal.settings.isLocalEnvironment" />
+</sw-card>
+
 {% block swag_paypal_settings_webhook %}
 <swag-paypal-settings-webhook />
 {% endblock %}
diff --git a/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.scss b/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.scss
@@ -1,6 +1,6 @@
 @import "~scss/variables";
 
-.swag-paypal-settings-cross-border {
+.swag-paypal-settings-cross-border, .swag-paypal-settings-environment {
     &__titles {
         font-size: $font-size-m;
         font-weight: $font-weight-semi-bold;
@@ -12,7 +12,7 @@
 
     .sw-card__content {
         display: grid;
-        gap: 8px;
+        gap: 16px;
         font-size: $font-size-xs;
         line-height: $line-height-sm;
     }
diff --git a/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.spec.ts b/src/Resources/app/administration/src/module/swag-paypal-settings/view/swag-paypal-settings-advanced/swag-paypal-settings-advanced.spec.ts
@@ -40,6 +40,7 @@ describe('swag-paypal-settings-advanced', () => {
             .filter((cl) => cl.startsWith('swag-paypal'));
 
         expect(cardClasses).toEqual([
+            'swag-paypal-settings-environment',
             'swag-paypal-settings-cross-border',
         ]);
     });
@@ -51,6 +52,7 @@ describe('swag-paypal-settings-advanced', () => {
         const settings = Object.fromEntries(components.map((el) => [el.props().path, el]));
 
         expect(Object.keys(settings)).toEqual([
+            'SwagPayPal.settings.isLocalEnvironment',
             'SwagPayPal.settings.crossBorderMessagingEnabled',
             'SwagPayPal.settings.crossBorderBuyerCountry',
         ]);
@@ -62,7 +64,7 @@ describe('swag-paypal-settings-advanced', () => {
     it('should have cross-border information', async () => {
         const wrapper = await createWrapper();
 
-        const alert = wrapper.find('.sw-alert');
+        const alert = wrapper.find('.swag-paypal-settings-cross-border .sw-alert');
 
         expect(alert.exists()).toBe(true);
         expect(alert.classes()).toContain('swag-paypal-settings-cross-border__warning-text');
@@ -72,4 +74,13 @@ describe('swag-paypal-settings-advanced', () => {
         expect(info.exists()).toBe(true);
         expect(info.text()).toBe('swag-paypal-settings.crossBorder.info');
     });
+
+    it('should have paypal-callback information', async () => {
+        const wrapper = await createWrapper();
+
+        const info = wrapper.find('.swag-paypal-settings-environment__info-text');
+
+        expect(info.exists()).toBe(true);
+        expect(info.text()).toBe('swag-paypal-settings.environment.info');
+    });
 });
diff --git a/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/index.ts b/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/index.ts
@@ -0,0 +1,36 @@
+import type * as PayPal from 'SwagPayPal/types';
+import template from './swag-paypal-local-environment.html.twig';
+import './swag-paypal-local-environment.scss';
+
+/**
+ * @deprecated tag:v10.0.0 - Will be replaced by `swag-paypal-settings-advanced`
+ */
+export default Shopware.Component.wrapComponentConfig({
+    template,
+
+    inject: [
+        'acl',
+    ],
+
+    props: {
+        isLoading: {
+            type: Boolean,
+            required: false,
+            default: false,
+        },
+        actualConfigData: {
+            type: Object as PropType<Record<string, PayPal.SystemConfig>>,
+            required: true,
+            default: () => { return {}; },
+        },
+        allConfigs: {
+            type: Object as PropType<Record<string, PayPal.SystemConfig>>,
+            required: true,
+        },
+        selectedSalesChannelId: {
+            type: String,
+            required: false,
+            default: null,
+        },
+    },
+});
diff --git a/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/swag-paypal-local-environment.html.twig b/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/swag-paypal-local-environment.html.twig
@@ -0,0 +1,27 @@
+<sw-card
+    class="swag-paypal-local-environment"
+    position-identifier="swag-paypal-local-environment"
+    :title="$t('swag-paypal-settings.environment.title')"
+    :is-loading="isLoading"
+>
+    <span class="swag-paypal-local-environment__info-text">
+        {{ $t('swag-paypal-settings.environment.info') }}
+    </span>
+
+    <swag-paypal-inherit-wrapper
+        v-bind="{ actualConfigData, allConfigs, selectedSalesChannelId }"
+        path="SwagPayPal.settings.isLocalEnvironment"
+    >
+        <template #content="props">
+            <sw-switch-field
+                name="SwagPayPal.settings.isLocalEnvironment"
+                :mapInheritance="props"
+                :label="$tc('swag-paypal-setting.label.isLocalEnvironment')"
+                :disabled="isLoading || props.isInherited || !acl.can('swag_paypal.editor')"
+                :value="props.currentValue"
+                bordered
+                @update:value="props.updateCurrentValue"
+            />
+        </template>
+    </swag-paypal-inherit-wrapper>
+</sw-card>
diff --git a/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/swag-paypal-local-environment.scss b/src/Resources/app/administration/src/module/swag-paypal/components/swag-paypal-local-environment/swag-paypal-local-environment.scss
@@ -0,0 +1,18 @@
+@import "~scss/variables";
+
+.swag-paypal-local-environment {
+    &__warning-text {
+        width: 100%;
+    }
+
+    .sw-card__content {
+        display: grid;
+        gap: 16px;
+        font-size: $font-size-xs;
+        line-height: $line-height-sm;
+    }
+
+    .sw-field--switch {
+        margin: 0;
+    }
+}
diff --git a/src/Resources/app/administration/src/module/swag-paypal/index.ts b/src/Resources/app/administration/src/module/swag-paypal/index.ts
@@ -20,6 +20,7 @@ Shopware.Component.register('swag-paypal-settings-icon', () => import('./compone
 Shopware.Component.register('swag-paypal-spb', () => import('./components/swag-paypal-spb'));
 Shopware.Component.register('swag-paypal-vaulting', () => import('./components/swag-paypal-vaulting'));
 Shopware.Component.register('swag-paypal-webhook', () => import('./components/swag-paypal-webhook'));
+Shopware.Component.register('swag-paypal-local-environment', () => import('./components/swag-paypal-local-environment'));
 Shopware.Component.register('swag-paypal', () => import('./page/swag-paypal'));
 
 const { Module } = Shopware;
diff --git a/src/Resources/app/administration/src/module/swag-paypal/page/swag-paypal/swag-paypal.html.twig b/src/Resources/app/administration/src/module/swag-paypal/page/swag-paypal/swag-paypal.html.twig
@@ -139,6 +139,16 @@
 
                 {% block swag_paypal_content_card_channel_config_cards %}
                 <template #content="{ actualConfigData, allConfigs, selectedSalesChannelId }">
+                    {% block swag_paypal_content_card_channel_config_local_environment %}
+                    <swag-paypal-local-environment
+                        v-if="tab === 'advanced'"
+                        :isLoading="isLoading"
+                        :actual-config-data="actualConfigData"
+                        :all-configs="allConfigs"
+                        :selected-sales-channel-id="selectedSalesChannelId"
+                    />
+                    {% endblock %}
+
                     {% block swag_paypal_content_card_channel_config_webhook %}
                     <swag-paypal-webhook
                         v-if="tab === 'advanced'"
diff --git a/src/Resources/app/administration/src/types/system-config.ts b/src/Resources/app/administration/src/types/system-config.ts
@@ -73,6 +73,8 @@ export declare type SystemConfig = {
 
     'SwagPayPal.settings.crossBorderMessagingEnabled'?: boolean;
     'SwagPayPal.settings.crossBorderBuyerCountry'?: typeof COUNTRY_OVERRIDES[number] | null;
+
+    'SwagPayPal.settings.isLocalEnvironment'?: boolean;
 };
 
 /**
@@ -139,4 +141,6 @@ export const SystemConfigDefinition: Record<SYSTEM_CONFIG, 'string' | 'boolean'
 
     'SwagPayPal.settings.crossBorderMessagingEnabled': 'boolean',
     'SwagPayPal.settings.crossBorderBuyerCountry': 'string',
+
+    'SwagPayPal.settings.isLocalEnvironment': 'boolean',
 };
diff --git a/src/Resources/config/services/express_checkout.xml b/src/Resources/config/services/express_checkout.xml
@@ -40,6 +40,7 @@
             <argument type="service" id="Swag\PayPal\OrdersApi\Builder\PayPalOrderBuilder"/>
             <argument type="service" id="Swag\PayPal\RestApi\V2\Resource\OrderResource"/>
             <argument type="service" id="Swag\PayPal\Checkout\Cart\Service\CartPriceService"/>
+            <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
             <argument type="service" id="router"/>
             <argument type="service" id="monolog.logger.paypal"/>
         </service>
diff --git a/src/Setting/Settings.php b/src/Setting/Settings.php
@@ -75,6 +75,7 @@ final class Settings
     public const VAULTING_ENABLED_ACDC = self::SYSTEM_CONFIG_DOMAIN . 'vaultingEnabledACDC';
 
     public const VAULTING_ENABLED_VENMO = self::SYSTEM_CONFIG_DOMAIN . 'vaultingEnabledVenmo';
+    public const IS_LOCAL_ENVIRONMENT = self::SYSTEM_CONFIG_DOMAIN . 'isLocalEnvironment';
 
     /**
      * @internal these may change at any time
@@ -114,6 +115,7 @@ final class Settings
         self::VAULTING_ENABLED_VENMO => false,
         self::CROSS_BORDER_MESSAGING_ENABLED => false,
         self::CROSS_BORDER_BUYER_COUNTRY => null,
+        self::IS_LOCAL_ENVIRONMENT => false,
     ];
 
     /**
diff --git a/src/Webhook/Registration/WebhookSystemConfigHelper.php b/src/Webhook/Registration/WebhookSystemConfigHelper.php
@@ -74,7 +74,8 @@ public function checkWebhookBefore(array $newData): array
                 continue;
             }
 
-            if (!$this->configHasChangedSettings($newSettings, $oldActualSettings)) {
+            $isLocalEnvironment = $newSettings[Settings::IS_LOCAL_ENVIRONMENT] ?? $this->systemConfigService->getBool(Settings::IS_LOCAL_ENVIRONMENT, $salesChannelId);
+            if (!$isLocalEnvironment && !$this->configHasChangedSettings($newSettings, $oldActualSettings)) {
                 // No writing of new credentials in this Sales Channel
                 continue;
             }
@@ -105,6 +106,10 @@ public function checkWebhookAfter(array $salesChannelIds): array
                 $salesChannelId = null;
             }
 
+            if ($this->systemConfigService->get(Settings::IS_LOCAL_ENVIRONMENT, $salesChannelId)) {
+                continue;
+            }
+
             $newSettings = $this->fetchSettings($salesChannelId);
             if (empty(\array_filter($newSettings))) {
                 // has no own valid configuration
diff --git a/tests/Checkout/ExpressCheckout/SalesChannel/ExpressCreateOrderRouteTest.php b/tests/Checkout/ExpressCheckout/SalesChannel/ExpressCreateOrderRouteTest.php
diff --git a/tests/Webhook/Registration/WebhookSystemConfigHelperTest.php b/tests/Webhook/Registration/WebhookSystemConfigHelperTest.php
