Add Ability To Separate Frontend / Adminhtml in New Relic

 - Minor improvements

Author: ishakhsuvarov

app/code/Magento/NewRelicReporting/Plugin/StatePlugin.php

@@ -13,6 +13,9 @@
 use Magento\NewRelicReporting\Model\NewRelicWrapper;
 use Psr\Log\LoggerInterface;
 
+/**
+ * Handles setting which, when enabled, reports frontend and adminhtml as separate apps to New Relic.
+ */
 class StatePlugin
 {
     /**
@@ -33,6 +36,7 @@ class StatePlugin
     /**
      * @param Config $config
      * @param NewRelicWrapper $newRelicWrapper
+     * @param LoggerInterface $logger
      */
     public function __construct(
         Config $config,
@@ -49,46 +53,48 @@ public function __construct(
      *
      * @param State $subject
      * @param null $result
-     * @return void
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @return mixed
      */
-    public function afterSetAreaCode(State $state, $result)
+    public function afterSetAreaCode(State $subject, $result)
     {
         if (!$this->shouldSetAppName()) {
             return $result;
         }
 
         try {
-            $this->newRelicWrapper->setAppName($this->appName($state));
+            $this->newRelicWrapper->setAppName($this->appName($subject));
         } catch (LocalizedException $e) {
             $this->logger->critical($e);
             return $result;
         }
+
+        return $result;
     }
 
-    private function appName(State $state)
+    /**
+     * @param State $state
+     * @return string
+     * @throws LocalizedException
+     */
+    private function appName(State $state): string
     {
         $code = $state->getAreaCode();
         $current = $this->config->getNewRelicAppName();
 
         return $current . ';' . $current . '_' . $code;
     }
 
-    private function shouldSetAppName()
+    /**
+     * Check if app name should be set.
+     *
+     * @return bool
+     */
+    private function shouldSetAppName(): bool
     {
-        if (!$this->config->isNewRelicEnabled()) {
-            return false;
-        }
-
-        if (!$this->config->getNewRelicAppName()) {
-            return false;
-        }
-
-        if (!$this->config->isSeparateApps()) {
-            return false;
-        }
-
-        return true;
+        return (
+            $this->config->isSeparateApps() &&
+            $this->config->getNewRelicAppName() &&
+            $this->config->isNewRelicEnabled()
+        );
     }
 }

dev/tests/integration/testsuite/Magento/NewRelicReporting/Plugin/SeparateAppsTest.php

@@ -12,13 +12,19 @@
 use Magento\TestFramework\ObjectManager;
 use Magento\TestFramework\Helper\Bootstrap;
 
+/**
+ * Class SeparateAppsTest
+ */
 class SeparateAppsTest extends \PHPUnit\Framework\TestCase
 {
     /**
      * @var ObjectManager
      */
     private $objectManager;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->objectManager = Bootstrap::getObjectManager();
@@ -46,4 +52,25 @@ public function testAppNameIsSetWhenConfiguredCorrectly()
 
         $state->setAreaCode('90210');
     }
+
+    /**
+     * @magentoConfigFixture default/newrelicreporting/general/enable 1
+     * @magentoConfigFixture default/newrelicreporting/general/app_name beverly_hills
+     * @magentoConfigFixture default/newrelicreporting/general/separate_apps 0
+     */
+    public function testAppNameIsNotSetWhenDisabled()
+    {
+        $newRelicWrapper = $this->getMockBuilder(NewRelicWrapper::class)
+            ->setMethods(['setAppName'])
+            ->getMock();
+
+        $this->objectManager->configure([NewRelicWrapper::class => ['shared' => true]]);
+        $this->objectManager->addSharedInstance($newRelicWrapper, NewRelicWrapper::class);
+
+        $newRelicWrapper->expects($this->never())->method('setAppName');
+
+        $state = $this->objectManager->get(State::class);
+
+        $state->setAreaCode('90210');
+    }
 }