Merge remote-tracking branch 'origin/ACP2E-3930' into PR_2025_05_28

chittima · chittima · commit 2d20a6991ffc · 2025-06-02T17:35:57.000-05:00
diff --git a/app/code/Magento/Fedex/Model/Carrier.php b/app/code/Magento/Fedex/Model/Carrier.php
@@ -20,6 +20,7 @@
 use Magento\Shipping\Model\Carrier\AbstractCarrier;
 use Magento\Shipping\Model\Carrier\AbstractCarrierOnline;
 use Magento\Shipping\Model\Rate\Result;
+use Magento\Framework\App\CacheInterface;
 
 /**
  * Fedex shipping implementation
@@ -174,6 +175,11 @@ class Carrier extends AbstractCarrierOnline implements \Magento\Shipping\Model\C
      */
     private $decoderInterface;
 
+    /**
+     * @var CacheInterface
+     */
+    private $cache;
+
     /**
      * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
      * @param \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory
@@ -194,6 +200,7 @@ class Carrier extends AbstractCarrierOnline implements \Magento\Shipping\Model\C
      * @param \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory
      * @param \Magento\Framework\HTTP\Client\CurlFactory $curlFactory
      * @param \Magento\Framework\Url\DecoderInterface $decoderInterface
+     * @param CacheInterface $cache
      * @param array $data
      * @param Json|null $serializer
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -218,6 +225,7 @@ public function __construct(
         \Magento\Catalog\Model\ResourceModel\Product\CollectionFactory $productCollectionFactory,
         CurlFactory $curlFactory,
         DecoderInterface $decoderInterface,
+        CacheInterface $cache,
         array $data = [],
         ?Json $serializer = null
     ) {
@@ -244,6 +252,7 @@ public function __construct(
         $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
         $this->curlFactory = $curlFactory;
         $this->decoderInterface = $decoderInterface;
+        $this->cache = $cache;
     }
 
     /**
@@ -962,11 +971,14 @@ protected function _getAccessToken(): string|null
      */
     private function retrieveAccessToken(?string $apiKey, ?string $secretKey): string|null
     {
-        if (!$apiKey || !$secretKey) {
-            $this->_debug(__('Authentication keys are missing.'));
+        if (!$this->areAuthKeysValid($apiKey, $secretKey)) {
             return null;
         }
-
+        $cacheKey = 'fedex_access_token_' . hash('sha256', $apiKey . $secretKey);
+        $cacheType = 'fedex_api';
+        if ($cachedToken = $this->getCachedAccessToken($cacheKey)) {
+            return $cachedToken;
+        }
         $requestArray = [
             'grant_type' => self::AUTHENTICATION_GRANT_TYPE,
             'client_id' => $apiKey,
@@ -980,13 +992,57 @@ private function retrieveAccessToken(?string $apiKey, ?string $secretKey): strin
         if (!empty($response['errors'])) {
             $debugData = ['request_type' => 'Access Token Request', 'result' => $response];
             $this->_debug($debugData);
-        } elseif (!empty($response['access_token'])) {
+        } elseif (!empty($response['access_token']) && isset($response['expires_in'])) {
             $accessToken = $response['access_token'];
+            $expiresAt = time() + (int)$response['expires_in'];
+            $cacheData = [
+                'access_token' => $accessToken,
+                'expires_at' => $expiresAt
+            ];
+            $this->cache->save(json_encode($cacheData), $cacheKey, [$cacheType], (int)$response['expires_in']);
         }
 
         return $accessToken;
     }
 
+    /**
+     * Validate apiKey and secretKey
+     *
+     * @param string|null $apiKey
+     * @param string|null $secretKey
+     * @return bool
+     */
+    private function areAuthKeysValid(?string $apiKey, ?string $secretKey): bool
+    {
+        if (!$apiKey || !$secretKey) {
+            $this->_debug(__('Authentication keys are missing.'));
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Retrieve access token from cache
+     *
+     * @param string $cacheKey
+     * @return string|null
+     */
+    private function getCachedAccessToken(string $cacheKey): ?string
+    {
+        $cachedData = $this->cache->load($cacheKey);
+        if (!$cachedData) {
+            return null;
+        }
+
+        $cachedData = json_decode($cachedData, true);
+        $currentTime = time();
+        if (isset($cachedData['access_token'], $cachedData['expires_at']) && $currentTime < $cachedData['expires_at']) {
+            return $cachedData['access_token'];
+        }
+
+        return null;
+    }
+
     /**
      * Get Access Token for Tracking Rest API
      *
diff --git a/app/code/Magento/Fedex/Test/Unit/Model/CarrierTest.php b/app/code/Magento/Fedex/Test/Unit/Model/CarrierTest.php
@@ -22,6 +22,7 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\HTTP\Client\Curl;
 use Magento\Framework\HTTP\Client\CurlFactory;
+use Magento\Framework\HTTP\ClientInterface;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
@@ -49,6 +50,7 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Magento\Catalog\Api\Data\ProductInterface;
+use Magento\Framework\App\CacheInterface;
 
 /**
  * CarrierTest contains units test for Fedex carrier methods
@@ -102,11 +104,6 @@ class CarrierTest extends TestCase
      */
     private Json $serializer;
 
-    /**
-     * @var LoggerInterface|MockObject
-     */
-    private LoggerInterface $logger;
-
     /**
      * @var CurrencyFactory|MockObject
      */
@@ -132,6 +129,11 @@ class CarrierTest extends TestCase
      */
     private DecoderInterface $decoderInterface;
 
+    /**
+     * @var CacheInterface|MockObject
+     */
+    private $cacheMock;
+
     /**
      * @return void
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
@@ -189,7 +191,7 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->logger = $this->getMockForAbstractClass(LoggerInterface::class);
+        $logger = $this->getMockForAbstractClass(LoggerInterface::class);
 
         $this->curlFactory = $this->getMockBuilder(CurlFactory::class)
             ->disableOriginalConstructor()
@@ -206,13 +208,16 @@ protected function setUp(): void
             ->onlyMethods(['decode'])
             ->getMock();
 
+        $this->cacheMock = $this->getMockBuilder(CacheInterface::class)
+            ->onlyMethods(['load', 'save'])
+            ->getMockForAbstractClass();
         $this->carrier = $this->getMockBuilder(Carrier::class)
             ->addMethods(['rateRequest'])
             ->setConstructorArgs(
                 [
                     'scopeConfig' => $this->scope,
                     'rateErrorFactory' => $this->errorFactory,
-                    'logger' => $this->logger,
+                    'logger' => $logger,
                     'xmlSecurity' => new Security(),
                     'xmlElFactory' => $elementFactory,
                     'rateFactory' => $rateFactory,
@@ -229,6 +234,7 @@ protected function setUp(): void
                     'productCollectionFactory' => $this->collectionFactory,
                     'curlFactory' => $this->curlFactory,
                     'decoderInterface' => $this->decoderInterface,
+                    'cache' => $this->cacheMock,
                     'data' => [],
                     'serializer' => $this->serializer,
                 ]
@@ -1064,6 +1070,173 @@ public function testGetCodeWithDropoffTypeNoCode(): void
         $this->assertEquals(__('Regular Pickup'), $result['REGULAR_PICKUP']);
     }
 
+    /**
+     * Test get access token from cache
+     */
+    public function testCollectRatesWithCachedAccessToken(): void
+    {
+        $apiKey = 'TestApiKey';
+        $secretKey = 'TestSecretKey';
+        $accessToken = 'CachedTestAccessToken';
+        $cacheKey = 'fedex_access_token_' . hash('sha256', $apiKey . $secretKey);
+        $expiresAt = time() + 3600;
+        $cachedData = json_encode([
+            'access_token' => $accessToken,
+            'expires_at' => $expiresAt
+        ]);
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+        $this->scope->expects($this->exactly(2))
+            ->method('isSetFlag')
+            ->willReturn(true);
+
+        $this->cacheMock->expects($this->once())
+            ->method('load')
+            ->with($cacheKey)
+            ->willReturn($cachedData);
+
+        $rateResponseMock = [
+            'output' => [
+                'rateReplyDetails' => [
+                    [
+                        'serviceType' => 'FEDEX_GROUND',
+                        'ratedShipmentDetails' => [
+                            [
+                                'totalNetCharge' => '28.75',
+                                'currency' => 'USD',
+                                'ratedPackages' => [
+                                    ['packageRateDetail' => ['rateType' => 'RATED_ACCOUNT_PACKAGE']]
+                                ]
+                            ]
+                        ]
+                    ]
+                ]
+            ]
+        ];
+        $this->serializer->expects($this->once())
+            ->method('serialize')
+            ->willReturn(json_encode(['mocked_request' => 'data']));
+        $this->serializer->expects($this->once())
+            ->method('unserialize')
+            ->willReturn($rateResponseMock);
+        $this->curlFactory->expects($this->once())
+            ->method('create')
+            ->willReturn($this->curlClient);
+        $this->curlClient->expects($this->once())
+            ->method('setHeaders')
+            ->willReturnSelf();
+        $this->curlClient->expects($this->once())
+            ->method('post')
+            ->willReturnSelf();
+        $this->curlClient->expects($this->once())
+            ->method('getBody')
+            ->willReturn(json_encode($rateResponseMock));
+        $request = $this->getMockBuilder(RateRequest::class)
+            ->addMethods(['getBaseCurrency', 'getPackageWeight'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $request->method('getPackageWeight')
+            ->willReturn(10.0);
+        $result = $this->carrier->collectRates($request);
+        $this->assertInstanceOf(RateResult::class, $result);
+        $rates = $result->getAllRates();
+        $this->assertNotEmpty($rates);
+    }
+
+    /**
+     * Test getTracking when a new access token is requested and saved to cache
+     */
+    public function testGetTrackingWithNewAccessTokenSavedToCache(): void
+    {
+        $apiKey = 'TestApiKey';
+        $secretKey = 'TestSecretKey';
+        $accessToken = 'NewTrackingTestAccessToken';
+        $cacheKey = 'fedex_access_token_' . hash('sha256', $apiKey . $secretKey);
+        $expiresIn = 3600;
+        $cacheType = 'fedex_api';
+        $tokenResponse = [
+            'access_token' => $accessToken,
+            'expires_in' => $expiresIn
+        ];
+        $trackingNumber = '123456789012';
+        $this->scope->expects($this->any())
+            ->method('getValue')
+            ->willReturnCallback([$this, 'scopeConfigGetValue']);
+        $this->cacheMock->expects($this->once())
+            ->method('load')
+            ->with($cacheKey)
+            ->willReturn(false);
+        $this->cacheMock->expects($this->once())
+            ->method('save')
+            ->with(
+                $this->callback(function ($data) use ($accessToken, $expiresIn) {
+                    $decoded = json_decode($data, true);
+                    return $decoded['access_token'] === $accessToken &&
+                        $decoded['expires_at'] <= (time() + $expiresIn) &&
+                        $decoded['expires_at'] > time();
+                }),
+                $cacheKey,
+                [$cacheType],
+                $expiresIn
+            )
+            ->willReturn(true);
+        $curlTokenClient = $this->createMock(ClientInterface::class);
+        $this->curlFactory->expects($this->exactly(2))
+            ->method('create')
+            ->willReturnOnConsecutiveCalls($curlTokenClient, $this->curlClient);
+        $curlTokenClient->expects($this->once())
+            ->method('setHeaders')
+            ->willReturnSelf();
+        $curlTokenClient->expects($this->once())
+            ->method('post')
+            ->willReturnSelf();
+        $curlTokenClient->expects($this->once())
+            ->method('getBody')
+            ->willReturn(json_encode($tokenResponse));
+        $trackingResponse = $this->getTrackingResponse();
+        $trackingStatusMock = $this->getMockBuilder(Status::class)
+            ->addMethods(['setCarrier', 'setCarrierTitle', 'setTracking'])
+            ->onlyMethods(['addData'])
+            ->getMock();
+        $this->statusFactory->expects($this->once())
+            ->method('create')
+            ->willReturn($trackingStatusMock);
+        $trackingStatusMock->expects($this->once())
+            ->method('setCarrier')
+            ->with(Carrier::CODE)
+            ->willReturnSelf();
+        $trackingStatusMock->expects($this->once())
+            ->method('setCarrierTitle')
+            ->willReturnSelf();
+        $trackingStatusMock->expects($this->once())
+            ->method('setTracking')
+            ->with($trackingNumber)
+            ->willReturnSelf();
+        $trackingStatusMock->expects($this->once())
+            ->method('addData')
+            ->willReturnSelf();
+        $this->serializer->expects($this->once())
+            ->method('serialize')
+            ->willReturn(json_encode($this->getTrackRequest($trackingNumber)));
+        $this->serializer->expects($this->exactly(2))
+            ->method('unserialize')
+            ->willReturnOnConsecutiveCalls($tokenResponse, $trackingResponse);
+        $this->curlClient->expects($this->once())
+            ->method('setHeaders')
+            ->willReturnSelf();
+        $this->curlClient->expects($this->once())
+            ->method('post')
+            ->willReturnSelf();
+        $this->curlClient->expects($this->once())
+            ->method('getBody')
+            ->willReturn(json_encode($trackingResponse));
+        $trackings = [$trackingNumber];
+        $result = $this->carrier->getTracking($trackings);
+        $this->assertInstanceOf(Result::class, $result);
+        $trackingsResult = $result->getAllTrackings();
+        $this->assertNotEmpty($trackingsResult);
+    }
     /**
      * Gets list of variations for testing ship date.
      *
@@ -1314,4 +1487,29 @@ private function getShipmentRequestMock(): MockObject
             ])
             ->getMock();
     }
+
+    /**
+     * @return array
+     */
+    private function getTrackingResponse(): array
+    {
+        return  [
+                'output' => [
+                    'completeTrackResults' => [
+                        [
+                            'trackingNumber' => '123456789012',
+                            'trackResults' => [
+                                [
+                                    'trackingNumberInfo' => ['trackingNumber' => '123456789012'],
+                                    'statusDetail' => ['description' => 'Delivered'],
+                                    'dateAndTimes' => [
+                                        ['type' => 'ACTUAL_DELIVERY', 'dateTime' => '2025-05-20T10:00:00Z']
+                                    ]
+                                ]
+                            ]
+                        ]
+                    ]
+                ]
+            ];
+    }
 }
