Merge remote-tracking branch 'act4/ACP2E-3340' into PR_13_OCT_2024

o-dubovyk · o-dubovyk · commit 28d239a6f59a · 2024-11-20T16:10:49.000-06:00
diff --git a/app/code/Magento/Fedex/Model/Carrier.php b/app/code/Magento/Fedex/Model/Carrier.php
@@ -934,6 +934,18 @@ protected function _getAccessToken(): string|null
         $apiKey = $this->getConfigData('api_key') ?? null;
         $secretKey = $this->getConfigData('secret_key') ?? null;
 
+        return $this->retrieveAccessToken($apiKey, $secretKey);
+    }
+
+    /**
+     * Make the call to get the access token
+     *
+     * @param string|null $apiKey
+     * @param string|null $secretKey
+     * @return string|null
+     */
+    private function retrieveAccessToken(?string $apiKey, ?string $secretKey): string|null
+    {
         if (!$apiKey || !$secretKey) {
             $this->_debug(__('Authentication keys are missing.'));
             return null;
@@ -955,9 +967,23 @@ protected function _getAccessToken(): string|null
         } elseif (!empty($response['access_token'])) {
             $accessToken = $response['access_token'];
         }
+
         return $accessToken;
     }
 
+    /**
+     * Get Access Token for Tracking Rest API
+     *
+     * @return string|null
+     */
+    private function getTrackingApiAccessToken(): string|null
+    {
+        $trackingApiKey = $this->getConfigData('tracking_api_key') ?? null;
+        $trackingSecretKey = $this->getConfigData('tracking_api_secret_key') ?? null;
+
+        return $this->retrieveAccessToken($trackingApiKey, $trackingSecretKey);
+    }
+
     /**
      * Send Curl Request
      *
@@ -1007,7 +1033,12 @@ protected function sendRequest($endpoint, $request, $accessToken = null): array|
      */
     protected function _getTrackingInformation($tracking): void
     {
-        $accessToken = $this->_getAccessToken();
+        if ($this->getConfigData('enabled_tracking_api')) {
+            $accessToken = $this->getTrackingApiAccessToken();
+        } else {
+            $accessToken = $this->_getAccessToken();
+        }
+
         if (!empty($accessToken)) {
 
             $trackRequest = [
diff --git a/app/code/Magento/Fedex/Test/Unit/Model/CarrierTest.php b/app/code/Magento/Fedex/Test/Unit/Model/CarrierTest.php
@@ -143,10 +143,6 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
 
-        $this->scope->expects($this->any())
-            ->method('getValue')
-            ->willReturnCallback([$this, 'scopeConfigGetValue']);
-
         $countryFactory = $this->getCountryFactory();
         $rateFactory = $this->getRateFactory();
         $storeManager = $this->getStoreManager();
@@ -254,6 +250,7 @@ public function testRequestToShipmentExceptionNoPackages(): void
     /**
      * @return void
      * @throws LocalizedException
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function testRequestToShipmentSuccess(): void
     {
@@ -293,6 +290,11 @@ public function testRequestToShipmentSuccess(): void
         ];
         $storeId = 1;
         $phoneNumber = '1234567890';
+
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+
         $request->expects($this->once())->method('getPackages')->willReturn($packages);
         $request->expects($this->exactly(3))->method('getStoreId')->willReturn($storeId);
         $request->expects($this->once())->method('setPackageId');
@@ -355,6 +357,10 @@ public function testRequestToShipmentSuccess(): void
 
     public function testSetRequestWithoutCity(): void
     {
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+
         $request = $this->getMockBuilder(RateRequest::class)
             ->disableOriginalConstructor()
             ->addMethods(['getDestCity'])
@@ -367,6 +373,10 @@ public function testSetRequestWithoutCity(): void
 
     public function testSetRequestWithCity(): void
     {
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+
         $request = $this->getMockBuilder(RateRequest::class)
             ->disableOriginalConstructor()
             ->addMethods(['getDestCity'])
@@ -391,8 +401,33 @@ public function scopeConfigGetValue(string $path): int|string|null
             'carriers/fedex/debug' => 1,
             'carriers/fedex/api_key' => 'TestApiKey',
             'carriers/fedex/secret_key' => 'TestSecretKey',
+            'carriers/fedex/enabled_tracking_api' => 0,
+            'carriers/fedex/rest_sandbox_webservices_url' => 'https://rest.sandbox.url/',
+            'carriers/fedex/rest_production_webservices_url' => 'https://rest.production.url/'
+        ];
+
+        return $pathMap[$path] ?? null;
+    }
+
+    /**
+     * Callback function, emulates getValue function for tracking api flow
+     *
+     * @param string $path
+     * @return int|string|null
+     */
+    public function scopeConfigGetValueForTracking(string $path): int|string|null
+    {
+        $pathMap = [
+            'carriers/fedex/showmethod' => 1,
+            'carriers/fedex/allowed_methods' => 'ServiceType',
+            'carriers/fedex/debug' => 1,
+            'carriers/fedex/api_key' => 'TestApiKey',
+            'carriers/fedex/secret_key' => 'TestSecretKey',
+            'carriers/fedex/enabled_tracking_api' => 1,
+            'carriers/fedex/tracking_api_key' => 'TestTrackingApiKey',
+            'carriers/fedex/tracking_api_secret_key' => 'TestTrackingSecretKey',
             'carriers/fedex/rest_sandbox_webservices_url' => 'https://rest.sandbox.url/',
-            'carriers/fedex/rest_production_webservices_url' => 'https://rest.production.url/',
+            'carriers/fedex/rest_production_webservices_url' => 'https://rest.production.url/'
         ];
 
         return $pathMap[$path] ?? null;
@@ -417,6 +452,10 @@ public function testCollectRatesRateAmountOriginBased(
             ->method('isSetFlag')
             ->willReturn(true);
 
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+
         $accessTokenResponse = $this->getAccessToken();
         $rateResponse = $this->getRateResponse($amount, $currencyCode, $rateType);
 
@@ -515,6 +554,10 @@ public function testCollectRatesErrorMessage(): void
             ->method('isSetFlag')
             ->willReturn(false);
 
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+
         $this->error->expects($this->once())
             ->method('setCarrier')
             ->with('fedex');
@@ -893,14 +936,25 @@ public function getAccessToken(): array
      * @param string $shipTimeStamp
      * @param string $expectedDate
      * @param string $expectedTime
+     * @param bool $trackingEnabled
      * @dataProvider shipDateDataProvider
      */
-    public function testGetTracking($tracking, $shipTimeStamp, $expectedDate, $expectedTime): void
+    public function testGetTracking($tracking, $shipTimeStamp, $expectedDate, $expectedTime, $trackingEnabled): void
     {
         $trackRequest = $this->getTrackRequest($tracking);
         $trackResponse = $this->getTrackResponse($shipTimeStamp, $expectedDate, $expectedTime);
         $accessTokenResponse = $this->getAccessToken();
 
+        if ($trackingEnabled) {
+            $this->scope->expects($this->atLeast(1))
+                ->method('getValue')
+                ->willReturnCallback([$this, 'scopeConfigGetValueForTracking']);
+        } else {
+            $this->scope->expects($this->any())
+                ->method('getValue')
+                ->willReturnCallback([$this, 'scopeConfigGetValue']);
+        }
+
         $this->serializer->method('serialize')->willReturn(json_encode($trackRequest));
         $this->serializer->expects($this->any())
             ->method('unserialize')
@@ -954,50 +1008,67 @@ public static function shipDateDataProvider(): array
                 'shipTimeStamp' => '2020-08-15T02:06:35+03:00',
                 'expectedDate' => '2014-01-09',
                 '18:31:00',
-                0,
+                false,
+                0
             ],
             'tracking1-again' => [
                 'tracking1',
                 'shipTimeStamp' => '2014-01-09T02:06:35+03:00',
                 'expectedDate' => '2014-01-09',
                 '18:31:00',
-                0,
+                false,
+                0
             ],
             'tracking2' => [
                 'tracking2',
                 'shipTimeStamp' => '2014-01-09T02:06:35+03:00',
                 'expectedDate' => '2014-01-09',
                 '23:06:35',
+                false,
+                0
             ],
             'tracking3' => [
                 'tracking3',
                 'shipTimeStamp' => '2014-01-09T14:06:35',
                 'expectedDate' => '2014-01-09',
                 '18:31:00',
+                false,
+                0
             ],
             'tracking4' => [
                 'tracking4',
                 'shipTimeStamp' => '2016-08-05 14:06:35',
                 'expectedDate' => null,
-                null,
+                '',
+                false,
             ],
             'tracking5' => [
                 'tracking5',
                 'shipTimeStamp' => '2016-08-05 14:06:35+00:00',
                 'expectedDate' => null,
-                null,
+                '',
+                false,
             ],
             'tracking6' => [
                 'tracking6',
                 'shipTimeStamp' => '2016-08-05',
                 'expectedDate' => null,
-                null,
+                '',
+                false,
             ],
             'tracking7' => [
                 'tracking7',
                 'shipTimeStamp' => '2016/08/05',
                 'expectedDate' => null,
-                null
+                '',
+                false,
+            ],
+            'tracking8' => [
+                'tracking8',
+                'shipTimestamp' => '2024-09-19T02:06:35+03:00',
+                'expectedDate' => '2024-09-21',
+                '18:31:00',
+                true
             ],
         ];
     }
diff --git a/app/code/Magento/Fedex/etc/adminhtml/system.xml b/app/code/Magento/Fedex/etc/adminhtml/system.xml
@@ -31,6 +31,24 @@
                     <label>Secret Key</label>
                     <backend_model>Magento\Config\Model\Config\Backend\Encrypted</backend_model>
                 </field>
+                <field id="enabled_tracking_api" translate="label" type="select" sortOrder="61" showInDefault="1" showInWebsite="1" canRestore="1">
+                    <label>Enable Tracking API credentials</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
+                <field id="tracking_api_key" translate="label" type="obscure" sortOrder="62" showInDefault="1" showInWebsite="1">
+                    <label>Tracking API Key</label>
+                    <backend_model>Magento\Config\Model\Config\Backend\Encrypted</backend_model>
+                    <depends>
+                        <field id="enabled_tracking_api">1</field>
+                    </depends>
+                </field>
+                <field id="tracking_api_secret_key" translate="label" type="obscure" sortOrder="63" showInDefault="1" showInWebsite="1">
+                    <label>Tracking API Secret Key</label>
+                    <backend_model>Magento\Config\Model\Config\Backend\Encrypted</backend_model>
+                    <depends>
+                        <field id="enabled_tracking_api">1</field>
+                    </depends>
+                </field>
                 <field id="sandbox_mode" translate="label" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" canRestore="1">
                     <label>Sandbox Mode</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
diff --git a/app/code/Magento/Fedex/etc/config.xml b/app/code/Magento/Fedex/etc/config.xml
@@ -12,6 +12,8 @@
                 <account backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
                 <api_key backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
                 <secret_key backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
+                <tracking_api_key backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
+                <tracking_api_secret_key backend_model="Magento\Config\Model\Config\Backend\Encrypted" />
                 <sandbox_mode>0</sandbox_mode>
                 <production_webservices_url><![CDATA[https://apis.fedex.com/]]></production_webservices_url>
                 <sandbox_webservices_url><![CDATA[https://apis-sandbox.fedex.com/]]></sandbox_webservices_url>
diff --git a/app/code/Magento/Fedex/i18n/en_US.csv b/app/code/Magento/Fedex/i18n/en_US.csv
@@ -88,3 +88,8 @@ Debug,Debug
 "Package Return Program","Package Return Program"
 "Regular Stop","Regular Stop"
 "Tag","Tag"
+"Api Key","Api Key"
+"Secret Key","Secret Key"
+"Enable Tracking API credentials","Enable Tracking API credentials"
+"Tracking API Key","Tracking API Key"
+"Tracking API Secret Key","Tracking API Secret Key"
