#49 Impl. LocalizedException SHOULD only be thrown in View

Author: Lars Roettig

Magento/Sniffs/Exceptions/LocalizedThrowSniff.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Sniffs\Exceptions;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Detects possible direct throws of Exceptions.
+ */
+class LocalizedThrowSniff implements Sniff
+{
+
+    protected $presentationLayerKeys = ['Controller', 'Block', 'ViewModel'];
+
+    /**
+     * String representation of warning.
+     */
+    protected $warningMessage = 'LocalizedException SHOULD only be thrown in the Presentation layer.';
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    protected $warningCode = 'LocalizedThrow';
+
+    /**
+     * @inheritdoc
+     */
+    public function register()
+    {
+        return [T_THROW];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        $lineEnd = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $stackPtr);
+        $exceptionType = $phpcsFile->getTokensAsString($stackPtr, $lineEnd);
+
+        // throw is not a LocalizedException nothing to do
+        if (strpos($exceptionType, 'LocalizedException') === false) {
+            return;
+        }
+
+        $nameSpaceTag = $phpcsFile->findPrevious(T_NAMESPACE, $stackPtr, 0);
+        if ($nameSpaceTag === false) {
+            // no namespace nothing to do
+            return;
+        }
+
+        $lineEnd = $phpcsFile->findNext(T_SEMICOLON, $nameSpaceTag);
+        $nameSpaceString = $phpcsFile->getTokensAsString($nameSpaceTag, $lineEnd);
+
+        $isPresentationLayer = false;
+        foreach ($this->presentationLayerKeys as $layerKey) {
+            if (strpos($nameSpaceString, $layerKey) !== false) {
+                $isPresentationLayer = true;
+                break;
+            }
+        }
+
+        if (!$isPresentationLayer) {
+            $phpcsFile->addWarning(
+                $this->warningMessage,
+                $stackPtr,
+                $this->warningCode
+            );
+        }
+    }
+}

Magento/Tests/Exceptions/LocalizedThrowUnitTest.1.inc

@@ -0,0 +1,28 @@
+<?php
+/**
+ *
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Controller\Product;
+
+use Magento\Framework\App\Action\HttpPostActionInterface as HttpPostActionInterface;
+use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface;
+use Magento\Framework\App\Action\Context;
+use Magento\Framework\View\Result\PageFactory;
+use Magento\Catalog\Controller\Product as ProductAction;
+
+/**
+ * View a product on storefront. Needs to be accessible by POST because of the store switching.
+ */
+class View extends ProductAction implements HttpGetActionInterface, HttpPostActionInterface
+{
+    /**
+     *
+     */
+    public function execute()
+    {
+        throw new LocalizedException(__('%1 doesn\'t exists'));
+    }
+}

Magento/Tests/Exceptions/LocalizedThrowUnitTest.2.inc

@@ -0,0 +1,22 @@
+<?php
+/**
+ *
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model\Test\SubFolder;
+
+/**
+ * Class Product
+ */
+class Product
+{
+    public function execute()
+    {
+        // rule should find this
+        throw new LocalizedException(__('Cant find %1 doesn\'t exists'));
+    }
+}
+
+

Magento/Tests/Exceptions/LocalizedThrowUnitTest.3.inc

@@ -0,0 +1,20 @@
+<?php
+/**
+ *
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Block\Test\SubFolder;
+
+
+/**
+ * Class Product
+ */
+class Product
+{
+    public function execute()
+    {
+        throw new LocalizedException(__('Cant find %1 doesn\'t exists'));
+    }
+}

Magento/Tests/Exceptions/LocalizedThrowUnitTest.4.inc

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Class Product
+ */
+class TestViewModel
+{
+    public function execute()
+    {
+        throw new \Magento\Framework\Exception\LocalizedException(__('Oops'));
+    }
+}
+
+

Magento/Tests/Exceptions/LocalizedThrowUnitTest.5.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Magento\Catalog\Model\Test\SubFolder;
+
+class Foo
+{
+    public function execute()
+    {
+        throw new \InvalidArgumentException(__('Oops'));
+    }
+}
+
+

Magento/Tests/Exceptions/LocalizedThrowUnitTest.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Tests\Exceptions;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Class NamespaceUnitTest
+ */
+class LocalizedThrowUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList()
+    {
+        return [
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList($testFile = '')
+    {
+        if ($testFile === 'LocalizedThrowUnitTest.2.inc') {
+            return [
+               18 => 1
+            ];
+        }
+
+        return [];
+    }
+}

Magento/ruleset.xml

@@ -195,6 +195,10 @@
         <severity>7</severity>
         <type>warning</type>
     </rule>
+    <rule ref="Magento.Exceptions.LocalizedThrow">
+        <severity>7</severity>
+        <type>warning</type>
+    </rule>
     <rule ref="Magento.PHP.LiteralNamespaces">
         <severity>7</severity>
         <type>warning</type>