Change the onboarding process to "without return URL & return button"

Author: mariolorenz

CHANGELOG.md

@@ -4,10 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.3.12] - 2024-??-??
+## [1.3.12] - 2025-??-??
 
 - add possibility to ignore cached tokens. It helps e.g. for webhook registration
 - Update Client Version v1.0.12
+- Change the onboarding process to "without return URL & return button"
 
 ## [1.3.11] - 2024-09-12
 

metadata.php

@@ -58,7 +58,7 @@
         'en' => 'Use of the online payment service from PayPal. Documentation: <a href="https://docs.oxid-esales.com/modules/paypal-checkout/en/latest/" target="_blank">PayPal Checkout</a>'
     ],
     'thumbnail' => 'out/img/paypal.png',
-    'version' => '1.3.12-rc.1',
+    'version' => '1.3.12-rc.2',
     'author' => 'OXID eSales AG',
     'url' => 'https://www.oxid-esales.com',
     'email' => 'info@oxid-esales.com',

out/src/js/paypal-admin.min.js

@@ -44,7 +44,8 @@ function onboardedCallbackSandbox(authCode, sharedId)
 
 function callConfigControllerAutoConfigurationFromCallback(authCode, sharedId, isSandBox)
 {
-    fetch(window.selfLink + 'cl=oscpaypalconfig&fnc=autoConfigurationFromCallback', {
+    const sandboxSnippet = isSandBox ? '&XDEBUG_SESSION_START=1' : '';
+    fetch(window.selfLink + 'cl=oscpaypalconfig&fnc=autoConfigurationFromCallback' + sandboxSnippet, {
         method: 'POST',
         headers: {
             'content-type': 'application/json'
@@ -57,8 +58,8 @@ function callConfigControllerAutoConfigurationFromCallback(authCode, sharedId, i
     })
     .then(
         function (response) {
-            if (response.status !== 200) {
-                return;
+            if (response.status === 200) {
+                window.location.reload();
             }
         }
     )

resources/build/js/paypal-admin.js

@@ -7,7 +7,8 @@ module.exports = {
         browser: true,
         globals: {
             jQuery: true
-        }
+        },
+        esversion: 9
     },
     moduleproduction: {
         src: [

resources/grunt/jshint.js

@@ -34,7 +34,8 @@ class PayPalConfigController extends AdminController
     /**
      * @var string Current class template name.
      */
-    protected $_sThisTemplate = 'oscpaypalconfig.tpl'; // phpcs:ignore PSR2.Classes.PropertyDeclaration
+    // phpcs:ignore PSR2.Classes.PropertyDeclaration
+    protected $_sThisTemplate = 'oscpaypalconfig.tpl';
 
     /**
      * @return string
@@ -110,17 +111,12 @@ private function buildSignUpLink(
         $localeCode = $lang->getLanguageAbbr() . '-' . $countryCode;
 
         $partnerLogoUrl = Registry::getConfig()->getOutUrl(null, true) . 'admin/img/loginlogo.png';
-        $returnToPartnerUrl = $config->getAdminUrlForJSCalls() .
-            'cl=oscpaypalconfig&fnc=returnFromSignup' .
-            '&isSandbox=' . ($isSandbox ? '1' : '0')
-        ;
 
         $params = [
             'partnerClientId' => $partnerClientId,
             'partnerId' => $partnerId,
             'partnerLogoUrl' => $partnerLogoUrl,
-            'returnToPartnerUrl' => $returnToPartnerUrl,
-            'product' => 'ppcp',
+            'product' => 'PPCP',
             'secondaryProducts' => 'payment_methods',
             'capabilities' => 'PAY_UPON_INVOICE',
             'integrationType' => 'FO',
@@ -163,10 +159,9 @@ public function createNonce(): string
     public function save()
     {
         $confArr = Registry::getRequest()->getRequestEscapedParameter('conf');
-        $shopId = Registry::getConfig()->getShopId();
 
         $confArr = $this->handleSpecialFields($confArr);
-        $this->saveConfig($confArr, $shopId);
+        $this->saveConfig($confArr);
         $this->checkEligibility();
         parent::save();
     }
@@ -175,9 +170,8 @@ public function save()
      * Saves configuration values
      *
      * @param array $conf
-     * @param int $shopId
      */
-    protected function saveConfig(array $conf, int $shopId)
+    protected function saveConfig(array $conf)
     {
         foreach ($conf as $confName => $value) {
             $this->getServiceFromContainer(ModuleSettings::class)->save($confName, $value);
@@ -347,32 +341,12 @@ public function autoConfigurationFromCallback()
             $logger->error($exception->getMessage(), [$exception]);
         }
 
-        $result = [];
-        header('Content-Type: application/json; charset=UTF-8');
-        Registry::getUtils()->showMessageAndExit(json_encode($result));
-    }
-
-    public function returnFromSignup()
-    {
-        $config = new Config();
-        $request = Registry::getRequest();
-        if (
-            ('true' === (string)$request->getRequestParameter('permissionsGranted')) &&
-            ('true' === (string)$request->getRequestParameter('consentStatus'))
-        ) {
-            /** @var ModuleSettings $moduleSettings */
-            $moduleSettings = $this->getServiceFromContainer(ModuleSettings::class);
-            $isSandbox = (string)$request->getRequestParameter('isSandbox');
-            $isSandbox = $isSandbox === '1';
-            $moduleSettings->saveMerchantId($request->getRequestParameter('merchantIdInPayPal'), $isSandbox);
-        }
-
         $this->autoConfiguration();
         $this->registerWebhooks();
 
-        $url = $config->getAdminUrlForJSCalls() . 'cl=oscpaypalconfig';
-
-        Registry::getUtils()->redirect($url, false, 302);
+        $result = [];
+        header('Content-Type: application/json; charset=UTF-8');
+        Registry::getUtils()->showMessageAndExit(json_encode($result));
     }
 
     /**

src/Controller/Admin/PayPalConfigController.php

@@ -24,7 +24,6 @@ class Onboarding
 
     public function autoConfigurationFromCallback(): array
     {
-        $credentials = [];
         try {
             $paypalConfig = oxNew(PayPalConfig::class);
             //fetch and save credentials
@@ -90,23 +89,16 @@ public function saveSandboxMode(bool $isSandbox)
         $moduleSettings->saveSandboxMode($isSandbox);
     }
 
-    public function saveCredentials(array $credentials): array
+    public function saveCredentials(array $credentials)
     {
-        if (
-            !isset($credentials['client_id']) ||
-            !isset($credentials['client_secret'])
-        ) {
+        if (!isset($credentials['client_id'], $credentials['client_secret'], $credentials['payer_id'])) {
             throw OnboardingException::mandatoryDataNotFound();
         }
 
         $moduleSettings = $this->getServiceFromContainer(ModuleSettings::class);
         $moduleSettings->saveClientId($credentials['client_id']);
         $moduleSettings->saveClientSecret($credentials['client_secret']);
-
-        return [
-            'client_id' => $moduleSettings->getClientId(),
-            'client_secret' => $moduleSettings->getClientSecret()
-        ];
+        $moduleSettings->saveMerchantId($credentials['payer_id']);
     }
 
     public function getOnboardingClient(bool $isSandbox, bool $withCredentials = false): ApiOnboardingClient

src/Core/Onboarding/Onboarding.php

@@ -389,19 +389,16 @@ public function saveClientSecret(string $clientSecret)
         }
     }
 
-    public function saveMerchantId($merchantId, $isSandbox = null)
+    public function saveMerchantId($merchantId)
     {
-        $logger = new PayPalLogger();
-        $isSandbox = !is_null($isSandbox) ? $isSandbox : $this->isSandbox();
-        if ($isSandbox) {
+        if ($this->isSandbox()) {
             $this->save('oscPayPalSandboxClientMerchantId', $merchantId);
-            $logger->info(sprintf('Saving Sandbox Merchant ID %s from onboarding', $merchantId));
-        }
-
-        if (!$isSandbox) {
+        } else {
             $this->save('oscPayPalClientMerchantId', $merchantId);
-            $logger->info(sprintf('Saving Live  Merchant ID %s from onboarding', $merchantId));
         }
+
+        $logger = new PayPalLogger();
+        $logger->debug(sprintf('Saving Merchant ID %s from onboarding', $merchantId));
     }
 
     public function saveAcdcEligibility(bool $eligibility)

src/Service/ModuleSettings.php

@@ -92,9 +92,6 @@ public function testOnboardingSandboxMode(AcceptanceTester $I): void
         $I->waitForElement("//a[contains(@href, 'cl=oscpaypalonboarding')]", 20);
         $I->waitForElementClickable("//a[contains(@href, 'cl=oscpaypalonboarding')]");
         $href = $I->grabAttributeFrom("//a[contains(@href, 'cl=oscpaypalonboarding')]", 'href');
-        $I->assertStringContainsString('returnFromSignup', $href);
-        $I->amOnUrl($href);
-        $I->see('You can now close the window');
 
         //NOTE: in case of non ssl url, the webhook cannot be created, so webhook part depends on test environment
         //locally we will still see a note, that the module is inactive