AC-15461: Migration New Relic from REST v2 to NerdGraph (GraphQL)

Author: sandesh-as

app/code/Magento/NewRelicReporting/Model/Apm/Deployments.php

@@ -8,11 +8,10 @@
 use Laminas\Http\Exception\RuntimeException;
 use Laminas\Http\Request;
 use Magento\Framework\Exception\LocalizedException;
-use Magento\Framework\HTTP\LaminasClient;
 use Magento\Framework\HTTP\LaminasClientFactory;
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\NewRelicReporting\Model\Config;
-use Magento\NewRelicReporting\Model\NerdGraph\Client as NerdGraphClient;
+use Magento\NewRelicReporting\Model\Config\Source\ApiMode;
 use Magento\NewRelicReporting\Model\NerdGraph\DeploymentTracker;
 use Psr\Log\LoggerInterface;
 
@@ -21,10 +20,7 @@
  */
 class Deployments
 {
-    /**
-     * API mode constant for NerdGraph (GraphQL) API
-     */
-    private const NERDGRAPH = 'nerdgraph';
+
     /**
      * API URL for New Relic deployments
      */
@@ -43,22 +39,17 @@ class Deployments
     /**
      * @var LaminasClientFactory $clientFactory
      */
-    protected $clientFactory;
+    protected LaminasClientFactory $clientFactory;
 
     /**
      * @var SerializerInterface
      */
-    private $serializer;
-
-    /**
-     * @var NerdGraphClient
-     */
-    private $nerdGraphClient;
+    private SerializerInterface $serializer;
 
     /**
      * @var DeploymentTracker
      */
-    private $deploymentTracker;
+    private DeploymentTracker $deploymentTracker;
 
     /**
      * Constructor
@@ -67,22 +58,19 @@ class Deployments
      * @param LoggerInterface $logger
      * @param LaminasClientFactory $clientFactory
      * @param SerializerInterface $serializer
-     * @param NerdGraphClient $nerdGraphClient
      * @param DeploymentTracker $deploymentTracker
      */
     public function __construct(
         Config $config,
         LoggerInterface $logger,
         LaminasClientFactory $clientFactory,
         SerializerInterface $serializer,
-        NerdGraphClient $nerdGraphClient,
         DeploymentTracker $deploymentTracker
     ) {
         $this->config = $config;
         $this->logger = $logger;
         $this->clientFactory = $clientFactory;
         $this->serializer = $serializer;
-        $this->nerdGraphClient = $nerdGraphClient;
         $this->deploymentTracker = $deploymentTracker;
     }
 
@@ -100,6 +88,7 @@ public function __construct(
      * @param string|null $groupId Group ID (NerdGraph only)
      *
      * @return bool|string|array
+     * @throws LocalizedException
      */
     public function setDeployment(
         string      $description,
@@ -113,7 +102,7 @@ public function setDeployment(
         // Check API mode configuration
         $apiMode = $this->config->getApiMode();
 
-        if ($apiMode === self::NERDGRAPH) {
+        if ($apiMode === ApiMode::MODE_NERDGRAPH) {
             return $this->createNerdGraphDeployment(
                 $description,
                 $change,
@@ -137,7 +126,7 @@ public function setDeployment(
      * @param string|null $revision
      * @return bool|string
      */
-    private function createV2RestDeployment($description, $change, $user, $revision)
+    private function createV2RestDeployment(string $description, bool|string $change, bool|string $user, ?string $revision): bool|string
     {
         $apiUrl = $this->config->getNewRelicApiUrl();
         if (empty($apiUrl)) {
@@ -147,7 +136,6 @@ private function createV2RestDeployment($description, $change, $user, $revision)
 
         $apiUrl = sprintf($apiUrl, $this->config->getNewRelicAppId());
 
-        /** @var LaminasClient $client */
         $client = $this->clientFactory->create();
         $client->setUri($apiUrl);
         $client->setMethod(Request::METHOD_POST);
@@ -200,7 +188,7 @@ private function createV2RestDeployment($description, $change, $user, $revision)
      * @return array|false
      * @throws LocalizedException
      */
-    private function createNerdGraphDeployment($description, $change, $user, $revision, $commit, $deepLink, $groupId)
+    private function createNerdGraphDeployment(string $description, bool|string $change, bool|string $user, ?string $revision, ?string $commit, ?string $deepLink, ?string $groupId): false|array
     {
         return $this->deploymentTracker->createDeployment(
             $description,

app/code/Magento/NewRelicReporting/Model/NerdGraph/Client.php

@@ -80,7 +80,7 @@ public function query(string $query, array $variables = []): array
             $client->setMethod(Request::METHOD_POST);
             $client->setHeaders([
                 'Content-Type' => 'application/json',
-                'API-Key' => $apiKey
+                'Api-Key' => $apiKey
             ]);
 
             $requestBody = [
@@ -185,8 +185,11 @@ public function getEntityGuidFromApplication(?string $appName = null, ?string $a
             );
             return $firstEntity['guid'];
         } catch (\RuntimeException $e) {
-            $this->logger->error('Failed to get entity GUID: ' . $e->getMessage());
-            $this->logger->error('Search query was: ' . $searchQuery);
+            $this->logger->error(sprintf(
+                'Failed to get entity GUID. Search query: %s. Error: %s',
+                $searchQuery,
+                $e->getMessage()
+            ));
             return null;
         }
     }

app/code/Magento/NewRelicReporting/Model/NerdGraph/DeploymentTracker.php

@@ -69,7 +69,7 @@ public function createDeployment(
         ?string $commit = null,
         ?string $deepLink = null,
         ?string $groupId = null
-    ) {
+    ): false|array {
         try {
             // Get entity GUID - this is required for NerdGraph deployment tracking
             $entityGuid = $this->getEntityGuid();
@@ -121,21 +121,22 @@ public function createDeployment(
             $response = $this->nerdGraphClient->query($mutation, $variables);
 
             $deploymentData = $response['data']['changeTrackingCreateDeployment'] ?? null;
+            $deployedVersion = $variables['deployment']['version'];
             if ($deploymentData) {
                 $this->logger->info(
                     'NerdGraph deployment created successfully',
                     [
                         'deploymentId' => $deploymentData['deploymentId'],
                         'entityGuid' => $deploymentData['entityGuid'],
-                        'version' => $version,
+                        'version' => $deployedVersion,
                         'description' => $description
                     ]
                 );
 
                 return [
                     'deploymentId' => $deploymentData['deploymentId'],
                     'entityGuid' => $deploymentData['entityGuid'],
-                    'version' => $variables['deployment']['version'],
+                    'version' => $deployedVersion,
                     'description' => $description,
                     'changelog' => $changelog,
                     'user' => $user,
@@ -149,9 +150,6 @@ public function createDeployment(
             $this->logger->error('NerdGraph deployment creation failed: No deployment data in response');
             return false;
 
-        } catch (LocalizedException $e) {
-            // Re-throw configuration/migration errors so they reach the user
-            throw $e;
         } catch (\Exception $e) {
             $this->logger->error('NerdGraph deployment creation failed: ' . $e->getMessage());
             return false;