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

Author: sandesh-as

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

@@ -79,8 +79,8 @@ public function __construct(
      * Supports both v2 REST and NerdGraph APIs based on configuration
      *
      * @param string $description
-     * @param bool|string $change
-     * @param bool|string $user
+     * @param string|null $change
+     * @param string|null $user
      * @param string|null $revision
      * @param string|null $commit Git commit hash (NerdGraph only)
      * @param string|null $deepLink Deep link URL (NerdGraph only)
@@ -90,8 +90,8 @@ public function __construct(
      */
     public function setDeployment(
         string      $description,
-        bool|string $change = false,
-        bool|string $user = false,
+        ?string     $change = null,
+        ?string     $user = null,
         ?string     $revision = null,
         ?string     $commit = null,
         ?string     $deepLink = null,
@@ -178,15 +178,15 @@ private function createV2RestDeployment(string $description, bool|string $change
      * Create deployment using NerdGraph (GraphQL) API
      *
      * @param string $description
-     * @param bool|string $change
-     * @param bool|string $user
+     * @param string|null $change
+     * @param string|null $user
      * @param string|null $revision
      * @param string|null $commit
      * @param string|null $deepLink
      * @param string|null $groupId
      * @return array|false
      */
-    private function createNerdGraphDeployment(string $description, bool|string $change, bool|string $user, ?string
+    private function createNerdGraphDeployment(string $description, ?string $change, ?string $user, ?string
     $revision, ?string $commit, ?string $deepLink, ?string $groupId): false|array
     {
         return $this->deploymentTracker->createDeployment(

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

@@ -63,12 +63,12 @@ public function __construct(
      * @param string $query The GraphQL query string
      * @param array $variables Optional variables for the query
      * @return array The decoded response data
-     * @throws \RuntimeException on request or response errors
+     * @throws RuntimeException on request or response errors
      */
     public function query(string $query, array $variables = []): array
     {
         if (!$this->config->isNewRelicEnabled()) {
-            throw new \RuntimeException('New Relic is not enabled');
+            throw new RuntimeException('New Relic is not enabled');
         }
         try {
             // Use the same API key field for both v2 REST and NerdGraph modes
@@ -92,7 +92,7 @@ public function query(string $query, array $variables = []): array
             $response = $client->send();
         } catch (RuntimeException $e) {
             $this->logger->error('NerdGraph API request failed: ' . $e->getMessage());
-            throw new \RuntimeException('NerdGraph API request failed: ' . $e->getMessage(), 0, $e);
+            throw new RuntimeException('NerdGraph API request failed: ' . $e->getMessage(), 0, $e);
         }
 
         if ($response->getStatusCode() !== 200) {
@@ -102,7 +102,7 @@ public function query(string $query, array $variables = []): array
                 $response->getBody()
             );
             $this->logger->error($errorMsg);
-            throw new \RuntimeException($errorMsg);
+            throw new RuntimeException($errorMsg);
         }
 
         $responseData = $this->serializer->unserialize($response->getBody());
@@ -114,7 +114,7 @@ public function query(string $query, array $variables = []): array
             );
             $errorMsg = 'NerdGraph GraphQL errors: ' . implode(', ', $errorMessages);
             $this->logger->error($errorMsg);
-            throw new \RuntimeException($errorMsg);
+            throw new RuntimeException($errorMsg);
         }
 
         return $responseData;
@@ -135,7 +135,6 @@ public function getEntityGuidFromApplication(?string $appName = null, ?string $a
         $searchQuery = 'type = \'APPLICATION\'';
 
         if ($appName) {
-            // safer than addslashes
             $searchQuery .= sprintf(" AND name = '%s'", str_replace("'", "\\'", $appName));
         } elseif ($appId) {
             $searchQuery .= sprintf(" AND appId = '%s'", str_replace("'", "\\'", $appId));
@@ -184,7 +183,7 @@ public function getEntityGuidFromApplication(?string $appName = null, ?string $a
                 ' (GUID: ' . $firstEntity['guid'] . ')'
             );
             return $firstEntity['guid'];
-        } catch (\RuntimeException $e) {
+        } catch (RuntimeException $e) {
             $this->logger->error(sprintf(
                 'Failed to get entity GUID. Search query: %s. Error: %s',
                 $searchQuery,

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

@@ -88,7 +88,16 @@ public function createDeployment(
 
             $response = $this->nerdGraphClient->query($this->getDeploymentMutation(), $variables);
 
-            return $this->processDeploymentResponse($response, $variables, $description, $changelog, $user, $commit, $deepLink, $groupId);
+            return $this->processDeploymentResponse(
+                $response,
+                $variables,
+                $description,
+                $changelog,
+                $user,
+                $commit,
+                $deepLink,
+                $groupId
+            );
         } catch (\Exception $e) {
             $this->logger->error('NerdGraph deployment creation failed: ' . $e->getMessage());
             return false;
@@ -251,7 +260,7 @@ private function processDeploymentResponse(
     ): false|array {
         $deploymentData = $response['data']['changeTrackingCreateDeployment'] ?? null;
         $deployedVersion = $variables['deployment']['version'];
-        
+
         if ($deploymentData) {
             $this->logger->info(
                 'NerdGraph deployment created successfully',

app/code/Magento/NewRelicReporting/Test/Unit/Console/Command/DeployMarkerTest.php

@@ -7,16 +7,15 @@
 
 namespace Magento\NewRelicReporting\Test\Unit\Console\Command;
 
+use Exception;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\NewRelicReporting\Console\Command\DeployMarker;
 use Magento\NewRelicReporting\Model\Apm\Deployments;
 use Magento\NewRelicReporting\Model\Apm\DeploymentsFactory;
 use Magento\NewRelicReporting\Model\Config;
 use Magento\NewRelicReporting\Model\ServiceShellUser;
-use PHPUnit\Framework\MockObject\Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Console\Exception\ExceptionInterface;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\BufferedOutput;
 
@@ -62,10 +61,10 @@ class DeployMarkerTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->deploymentsFactoryMock = $this->createMock(DeploymentsFactory::class); // @phpstan-ignore-line
+        $this->deploymentsFactoryMock = $this->createMock(DeploymentsFactory::class);
         $this->deploymentMock = $this->createMock(Deployments::class);
-        $this->configMock = $this->createMock(Config::class); // @phpstan-ignore-line
-        $this->serviceShellUserMock = $this->createMock(ServiceShellUser::class); // @phpstan-ignore-line
+        $this->configMock = $this->createMock(Config::class);
+        $this->serviceShellUserMock = $this->createMock(ServiceShellUser::class);
         $this->inputMock = $this->createMock(InputInterface::class);
         $this->output = new BufferedOutput();
 
@@ -364,7 +363,7 @@ public function testExecuteWithGenericException()
 
         $this->deploymentMock->expects($this->once())
             ->method('setDeployment')
-            ->willThrowException(new \Exception($exceptionMessage));
+            ->willThrowException(new Exception($exceptionMessage));
 
         $result = $this->command->run($this->inputMock, $this->output);
 

app/code/Magento/NewRelicReporting/Test/Unit/Model/NerdGraph/ClientTest.php

@@ -60,10 +60,10 @@ class ClientTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->httpClientFactoryMock = $this->createMock(LaminasClientFactory::class); // @phpstan-ignore-line
-        $this->serializerMock = $this->createMock(SerializerInterface::class); // @phpstan-ignore-line
-        $this->configMock = $this->createMock(Config::class); // @phpstan-ignore-line
-        $this->loggerMock = $this->createMock(LoggerInterface::class); // @phpstan-ignore-line
+        $this->httpClientFactoryMock = $this->createMock(LaminasClientFactory::class);
+        $this->serializerMock = $this->createMock(SerializerInterface::class);
+        $this->configMock = $this->createMock(Config::class);
+        $this->loggerMock = $this->createMock(LoggerInterface::class);
         $this->httpClientMock = $this->createMock(LaminasClient::class);
         $this->responseMock = $this->createMock(Response::class);
 

app/code/Magento/NewRelicReporting/Test/Unit/Model/NerdGraph/DeploymentTrackerTest.php

@@ -47,9 +47,9 @@ class DeploymentTrackerTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->nerdGraphClientMock = $this->createMock(Client::class); // @phpstan-ignore-line
-        $this->configMock = $this->createMock(Config::class); // @phpstan-ignore-line
-        $this->loggerMock = $this->createMock(LoggerInterface::class); // @phpstan-ignore-line
+        $this->nerdGraphClientMock = $this->createMock(Client::class);
+        $this->configMock = $this->createMock(Config::class);
+        $this->loggerMock = $this->createMock(LoggerInterface::class);
 
         $this->deploymentTracker = new DeploymentTracker(
             $this->nerdGraphClientMock,

dev/tests/integration/testsuite/Magento/NewRelicReporting/Model/NerdGraph/DeploymentWorkflowTest.php

@@ -8,14 +8,18 @@
 namespace Magento\NewRelicReporting\Model\NerdGraph;
 
 use Magento\Framework\App\Config\MutableScopeConfigInterface;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\HTTP\LaminasClient;
+use Magento\Framework\HTTP\LaminasClientFactory;
 use Magento\Framework\ObjectManagerInterface;
+use Magento\Framework\Serialize\SerializerInterface;
 use Magento\NewRelicReporting\Model\Apm\Deployments;
 use Magento\NewRelicReporting\Model\Config;
 use Magento\NewRelicReporting\Model\NerdGraph\Client;
 use Magento\NewRelicReporting\Model\NerdGraph\DeploymentTracker;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 /**
  * Integration test for the complete deployment workflow
@@ -57,6 +61,7 @@ class DeploymentWorkflowTest extends TestCase
 
     protected function setUp(): void
     {
+        /** @phpstan-ignore-next-line */
         $this->objectManager = Bootstrap::getObjectManager();
         $this->config = $this->objectManager->get(Config::class);
         $this->mutableScopeConfig = $this->objectManager->get(MutableScopeConfigInterface::class);