Addressing static lint issues (#571)

sol-loup · strygo · web-flow · commit c82b54c2f686 · 2023-12-12T09:22:19.000-08:00
* Addressing static lint issues

* Remove catalog dep

* Adding Magento/Customer as a composer dep

* Fixing final phpcs issues

* Fixing dangling comma (php 7 compat)

* PHPSTan issue: method should return array but currently returns void

* autoformatting shipper file

* bad merge

---------

Co-authored-by: Steve Gordon &lt;stevegordon@meta.com&gt;
diff --git a/app/code/Meta/BusinessExtension/Block/Adminhtml/System/Config/ManualDataSyncEmpty.php b/app/code/Meta/BusinessExtension/Block/Adminhtml/System/Config/ManualDataSyncEmpty.php
@@ -30,17 +30,6 @@ class ManualDataSyncEmpty extends Field
      */
     protected $_template = 'Meta_BusinessExtension::system/config/manual_data_sync_empty.phtml';
 
-    /**
-     * @param Context $context
-     * @param array $data
-     */
-    public function __construct(
-        Context       $context,
-        array         $data = []
-    ) {
-        parent::__construct($context, $data);
-    }
-
     /**
      * Remove scope label
      *
diff --git a/app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/ReportClientError.php b/app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/ReportClientError.php
@@ -44,7 +44,7 @@ class ReportClientError extends AbstractAjax
     public function __construct(
         Context      $context,
         JsonFactory  $resultJsonFactory,
-        FBEHelper    $fbeHelper,
+        FBEHelper    $fbeHelper
     ) {
         parent::__construct($context, $resultJsonFactory, $fbeHelper);
         $this->fbeHelper = $fbeHelper;
@@ -80,5 +80,6 @@ public function executeForJson()
             $stackTrace,
             $loggingContext,
         );
+        return [];
     }
 }
diff --git a/app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php b/app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php
@@ -710,8 +710,8 @@ public function acknowledgeOrders($ordersRootId, array $orderIds)
      * Mark order items as shipped
      *
      * @param mixed $fbOrderId
-     * @param array $items
      * @param string $magentoShipmentId
+     * @param array $items
      * @param array $trackingInfo
      * @param array $fulfillmentAddressData
      * @return mixed|\Psr\Http\Message\ResponseInterface
diff --git a/app/code/Meta/BusinessExtension/Plugin/LoggingPluginBase.php b/app/code/Meta/BusinessExtension/Plugin/LoggingPluginBase.php
@@ -53,7 +53,7 @@ abstract class LoggingPluginBase
     public function __construct(
         FBEHelper                $fbeHelper,
         RequestInterface         $request,
-        StoreRepositoryInterface $storeRepository,
+        StoreRepositoryInterface $storeRepository
     ) {
         $this->fbeHelper = $fbeHelper;
         $this->request = $request;
@@ -74,7 +74,7 @@ public function wrapCallableWithErrorAndImpressionLogging(
         string   $log_prefix,
         $subject,
         callable $progress,
-        ...$args,
+        ...$args
     ) {
         return $this->wrapCallableWithLogging(
             true, // $should_log_errors
@@ -100,7 +100,7 @@ public function wrapCallableWithErrorLogging(
         string   $log_prefix,
         $subject,
         callable $progress,
-        ...$args,
+        ...$args
     ) {
         return $this->wrapCallableWithLogging(
             true, // $should_log_errors
@@ -130,7 +130,7 @@ private function wrapCallableWithLogging(
         string   $log_prefix,
         $subject,
         callable $progress,
-        ...$args,
+        ...$args
     ) {
         $classname = $this->getClassnameForLogging($subject);
         if (!str_starts_with($classname, "Meta\\")) {
diff --git a/app/code/Meta/Catalog/Model/ResourceModel/FacebookCatalogUpdate.php b/app/code/Meta/Catalog/Model/ResourceModel/FacebookCatalogUpdate.php
@@ -216,7 +216,7 @@ private function getChildProductLinks(array $parentIds)
     /**
      * Delete all the product update entries
      *
-     * @param $sku
+     * @param bool|int|string $sku
      * @return void
      */
     public function deleteUpdateProductEntries($sku): void
diff --git a/app/code/Meta/Catalog/Setup/Patch/Data/UpdateMetaCatalogSourceAttribute.php b/app/code/Meta/Catalog/Setup/Patch/Data/UpdateMetaCatalogSourceAttribute.php
@@ -62,6 +62,7 @@ private function updateAttribute()
     {
         $connection = $this->moduleDataSetup->getConnection();
         $tableName = $this->moduleDataSetup->getTable('eav_attribute');
+        // phpcs:disable
         $oldSourceModel = 'Facebook\BusinessExtension\Model\Config\Source\Product\GoogleProductCategory';
         $newSourceModel = \Meta\Catalog\Model\Config\Source\Product\GoogleProductCategory::class;
 
@@ -93,6 +94,7 @@ private function revertAttributeUpdate()
     {
         $connection = $this->moduleDataSetup->getConnection();
         $tableName = $this->moduleDataSetup->getTable('eav_attribute');
+        // phpcs:disable
         $oldSourceModel = 'Facebook\BusinessExtension\Model\Config\Source\Product\GoogleProductCategory';
         $newSourceModel = \Meta\Catalog\Model\Config\Source\Product\GoogleProductCategory::class;
         $connection->update(
diff --git a/app/code/Meta/Conversion/view/frontend/templates/pixel/search.phtml b/app/code/Meta/Conversion/view/frontend/templates/pixel/search.phtml
@@ -10,19 +10,19 @@ if ($block->getFacebookPixelID()) {
         {
             "*": {
                 "Meta_Conversion/js/metaPixelTracker" : {
-                    "url" : "<?= $block->escapeJs($trackerUrl); ?>",
-                    "payload": <?= json_encode([
-                        "eventName" => $block->getEventToObserveName(),
-                        "searchQuery" => $block->getSearchQuery()
+                    "url" : "<?= $block->escapeHtml($trackerUrl); ?>",
+                    "payload": <?= /* @noEscape */ json_encode([
+                        "eventName" => $block->escapeHtml($block->getEventToObserveName()),
+                        "searchQuery" => $block->escapeHtml($block->getSearchQuery())
                     ]) ?>,
-                    "browserEventData": <?= json_encode([
-                        'fbAgentVersion' => $block->getFacebookAgentVersion(),
-                        'fbPixelId' => $block->getFacebookPixelID(),
-                        'source' => $block->getSource(),
-                        'pluginVersion' => $block->getPluginVersion(),
+                    "browserEventData": <?= /* @noEscape */ json_encode([
+                        'fbAgentVersion' => $block->escapeHtml($block->getFacebookAgentVersion()),
+                        'fbPixelId' => $block->escapeHtml($block->getFacebookPixelID()),
+                        'source' => $block->escapeHtml($block->getSource()),
+                        'pluginVersion' => $block->escapeHtml($block->getPluginVersion()),
                         'track' => 'track',
                         'event' => 'Search',
-                        'payload' => ['search_string' => $block->getSearchQuery()]
+                        'payload' => ['search_string' => $block->escapeHtml($block->getSearchQuery())]
                     ]) ?>
                 }
             }
diff --git a/app/code/Meta/Conversion/view/frontend/templates/pixel/view_category.phtml b/app/code/Meta/Conversion/view/frontend/templates/pixel/view_category.phtml
@@ -10,19 +10,19 @@ if ($block->getFacebookPixelID()) {
         {
             "*": {
                 "Meta_Conversion/js/metaPixelTracker" : {
-                    "url" : "<?= $block->escapeJs($trackerUrl); ?>",
-                    "payload": <?= json_encode([
-                        "eventName" => $block->getEventToObserveName(),
-                        "categoryId" => $block->getCategoryId(),
+                    "url" : "<?= $block->escapeHtml($trackerUrl); ?>",
+                    "payload": <?= /* @noEscape */ json_encode([
+                        "eventName" => $block->escapeHtml($block->getEventToObserveName()),
+                        "categoryId" => $block->escapeHtml($block->getCategoryId()),
                     ]) ?>,
-                    "browserEventData": <?= json_encode([
-                        'fbAgentVersion' => $block->getFacebookAgentVersion(),
-                        'fbPixelId' => $block->getFacebookPixelID(),
-                        'source' => $block->getSource(),
-                        'pluginVersion' => $block->getPluginVersion(),
+                    "browserEventData": <?= /* @noEscape */ json_encode([
+                        'fbAgentVersion' => $block->escapeHtml($block->getFacebookAgentVersion()),
+                        'fbPixelId' => $block->escapeHtml($block->getFacebookPixelID()),
+                        'source' => $block->escapeHtml($block->getSource()),
+                        'pluginVersion' => $block->escapeHtml($block->getPluginVersion()),
                         'track' => 'trackCustom',
                         'event' => 'ViewCategory',
-                        'payload' => ['category_name' => $block->getCategoryName() ]
+                        'payload' => ['category_name' => $block->escapeHtml($block->getCategoryName()) ]
                     ]) ?>
                 }
             }
diff --git a/app/code/Meta/Sales/Cron/SyncOrders.php b/app/code/Meta/Sales/Cron/SyncOrders.php
@@ -63,8 +63,7 @@ public function __construct(
         SystemConfig          $systemConfig,
         CommerceHelper        $commerceHelper,
         FBEHelper             $fbeHelper
-    )
-    {
+    ) {
         $this->systemConfig = $systemConfig;
         $this->commerceHelper = $commerceHelper;
         $this->storeManager = $storeManager;
diff --git a/app/code/Meta/Sales/Helper/OrderHelper.php b/app/code/Meta/Sales/Helper/OrderHelper.php
@@ -38,6 +38,8 @@ class OrderHelper
     private $facebookOrderFactory;
 
     /**
+     * Constructor
+     *
      * @param OrderExtensionFactory $orderExtensionFactory
      * @param FacebookOrderInterfaceFactory $facebookOrderFactory
      */
diff --git a/app/code/Meta/Sales/Model/FacebookOrder.php b/app/code/Meta/Sales/Model/FacebookOrder.php
@@ -21,6 +21,7 @@
 namespace Meta\Sales\Model;
 
 use Magento\Framework\Model\AbstractModel;
+use Magento\Sales\Model\Order;
 use Meta\Sales\Api\Data\FacebookOrderInterface;
 use Meta\Sales\Model\ResourceModel\FacebookOrder as ResourceModel;
 
@@ -124,7 +125,7 @@ public function getSyncedShipments()
     public function updateSyncedShipment($magentoShipmentId, $trackingInfo)
     {
         $shipments = $this->getSyncedShipments();
-        $shipments[$magentoShipmentId] = self::encodeTrackingInfo($trackingInfo);
+        $shipments[$magentoShipmentId] = $this->encodeTrackingInfo($trackingInfo);
         $this->setData('synced_shipments', json_encode($shipments));
 
         return $this;
@@ -160,15 +161,15 @@ public function setExtraData(array $extraData)
      * @param array $trackingInfo
      * @return bool
      */
-    public static function isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)
+    public function isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo): bool
     {
         $syncedShipments = $order->getExtensionAttributes()->getSyncedShipments();
         if (!array_key_exists($magentoShipmentId, $syncedShipments)) {
             return true;
         }
 
         $syncedShipment = $syncedShipments[$magentoShipmentId];
-        return $syncedShipment !== FacebookOrder::encodeTrackingInfo($trackingInfo);
+        return $syncedShipment !== $this->encodeTrackingInfo($trackingInfo);
     }
 
     /**
@@ -177,7 +178,7 @@ public static function isSyncedShipmentOutOfSync($order, $magentoShipmentId, $tr
      * @param array $trackingInfo
      * @return string
      */
-    private static function encodeTrackingInfo($trackingInfo)
+    private function encodeTrackingInfo($trackingInfo): string
     {
         return $trackingInfo['carrier'] . '|' . $trackingInfo['tracking_number'];
     }
diff --git a/app/code/Meta/Sales/Model/Order/Shipper.php b/app/code/Meta/Sales/Model/Order/Shipper.php
@@ -20,6 +20,7 @@
 
 namespace Meta\Sales\Model\Order;
 
+use Exception;
 use GuzzleHttp\Exception\GuzzleException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Sales\Model\Order\Shipment;
@@ -65,25 +66,33 @@ class Shipper
      */
     private FBEHelper $fbeHelper;
 
+    /**
+     * @var FacebookOrder
+     */
+    private FacebookOrder $facebookOrder;
+
     /**
      * @param SystemConfig $systemConfig
      * @param GraphAPIAdapter $graphAPIAdapter
      * @param ShippingHelper $shippingHelper
      * @param OrderHelper $orderHelper
      * @param FBEHelper $fbeHelper
+     * @param FacebookOrder $facebookOrder
      */
     public function __construct(
         SystemConfig    $systemConfig,
         GraphAPIAdapter $graphAPIAdapter,
         ShippingHelper  $shippingHelper,
         OrderHelper     $orderHelper,
-        FBEHelper       $fbeHelper
+        FBEHelper       $fbeHelper,
+        FacebookOrder   $facebookOrder
     ) {
         $this->systemConfig = $systemConfig;
         $this->graphAPIAdapter = $graphAPIAdapter;
         $this->shippingHelper = $shippingHelper;
         $this->orderHelper = $orderHelper;
         $this->fbeHelper = $fbeHelper;
+        $this->facebookOrder = $facebookOrder;
     }
 
     /**
@@ -97,44 +106,6 @@ public function getOrderShipEvent($storeId = null)
         return $this->systemConfig->getOrderShipEvent($storeId);
     }
 
-    /**
-     * Get carrier code for facebook
-     *
-     * @param Track $track
-     * @return string
-     */
-    public function getCarrierCodeForFacebook(Track $track): string
-    {
-        return $this->shippingHelper->getCarrierCodeForFacebook($track);
-    }
-
-    /**
-     * Validate fulfillment address
-     *
-     * @param array $address
-     * @return void
-     * @throws LocalizedException
-     */
-    private function validateFulfillmentAddress(array $address)
-    {
-        $requiredFields = [
-            'street_1' => __('Street Address 1'),
-            'country' => __('Country'),
-            'state' => __('Region/State'),
-            'city' => __('City'),
-            'postal_code' => __('Zip/Postal Code')
-        ];
-        $missingFields = array_filter($requiredFields, function ($field) use ($address) {
-            return empty($address[$field]);
-        }, ARRAY_FILTER_USE_KEY);
-        if (!empty($missingFields)) {
-            throw new LocalizedException(__(
-                'Please provide the required fields: %1 in the Fulfillment Address section.',
-                implode(', ', array_values($missingFields))
-            ));
-        }
-    }
-
     /**
      * Mark order items as shipped
      *
@@ -172,7 +143,7 @@ public function markAsShipped(Shipment $shipment)
         }
 
         $magentoShipmentId = $shipment->getIncrementId();
-        if (!FacebookOrder::isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)) {
+        if (!$this->facebookOrder->isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)) {
             $this->fbeHelper->log("[markAsShipped] Shipment: {$shipment->getIncrementId()} - Skipping, in sync");
             return;
         }
@@ -210,7 +181,7 @@ public function markAsShipped(Shipment $shipment)
                 $trackingInfo,
                 $fulfillmentAddress
             );
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             // Validated the Meta API will throw if retailer ids provided are invalid
             // https://fburl.com/code/p523l7gm
             $this->markOrderItemsAsShipped(
@@ -237,6 +208,44 @@ public function markAsShipped(Shipment $shipment)
         // @todo Update order totals
     }
 
+    /**
+     * Get carrier code for facebook
+     *
+     * @param Track $track
+     * @return string
+     */
+    public function getCarrierCodeForFacebook(Track $track): string
+    {
+        return $this->shippingHelper->getCarrierCodeForFacebook($track);
+    }
+
+    /**
+     * Validate fulfillment address
+     *
+     * @param array $address
+     * @return void
+     * @throws LocalizedException
+     */
+    private function validateFulfillmentAddress(array $address)
+    {
+        $requiredFields = [
+            'street_1' => __('Street Address 1'),
+            'country' => __('Country'),
+            'state' => __('Region/State'),
+            'city' => __('City'),
+            'postal_code' => __('Zip/Postal Code')
+        ];
+        $missingFields = array_filter($requiredFields, function ($field) use ($address) {
+            return empty($address[$field]);
+        }, ARRAY_FILTER_USE_KEY);
+        if (!empty($missingFields)) {
+            throw new LocalizedException(__(
+                'Please provide the required fields: %1 in the Fulfillment Address section.',
+                implode(', ', array_values($missingFields))
+            ));
+        }
+    }
+
     /**
      * Mark facebook order items as shipped
      *
@@ -306,7 +315,7 @@ public function updateShipmentTracking(Shipment $shipment)
         ];
 
         $magentoShipmentId = $shipment->getIncrementId();
-        if (!FacebookOrder::isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)) {
+        if (!$this->facebookOrder->isSyncedShipmentOutOfSync($order, $magentoShipmentId, $trackingInfo)) {
             $this->fbeHelper->log(
                 "[updateShipmentTracking] Shipment: {$shipment->getIncrementId()} - Skipping, in sync"
             );
diff --git a/app/code/Meta/Sales/view/adminhtml/templates/order/view/tab/facebook.phtml b/app/code/Meta/Sales/view/adminhtml/templates/order/view/tab/facebook.phtml
diff --git a/app/code/Meta/Sales/view/adminhtml/templates/system/config/pull_orders.phtml b/app/code/Meta/Sales/view/adminhtml/templates/system/config/pull_orders.phtml

Original file line number	Diff line number	Diff line change
`@@ -216,7 +216,7 @@ private function getChildProductLinks(array $parentIds)`
`216`	`216`	`/**`
`217`	`217`	`* Delete all the product update entries`
`218`	`218`	`*`
`219`		`- * @param $sku`
	`219`	`+ * @param bool\|int\|string $sku`
`220`	`220`	`* @return void`
`221`	`221`	`*/`
`222`	`222`	`public function deleteUpdateProductEntries($sku): void`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ private function updateAttribute()`
`62`	`62`	`{`
`63`	`63`	`$connection = $this->moduleDataSetup->getConnection();`
`64`	`64`	`$tableName = $this->moduleDataSetup->getTable('eav_attribute');`
	`65`	`+ // phpcs:disable`
`65`	`66`	`$oldSourceModel = 'Facebook\BusinessExtension\Model\Config\Source\Product\GoogleProductCategory';`
`66`	`67`	`$newSourceModel = \Meta\Catalog\Model\Config\Source\Product\GoogleProductCategory::class;`
`67`	`68`
`@@ -93,6 +94,7 @@ private function revertAttributeUpdate()`
`93`	`94`	`{`
`94`	`95`	`$connection = $this->moduleDataSetup->getConnection();`
`95`	`96`	`$tableName = $this->moduleDataSetup->getTable('eav_attribute');`
	`97`	`+ // phpcs:disable`
`96`	`98`	`$oldSourceModel = 'Facebook\BusinessExtension\Model\Config\Source\Product\GoogleProductCategory';`
`97`	`99`	`$newSourceModel = \Meta\Catalog\Model\Config\Source\Product\GoogleProductCategory::class;`
`98`	`100`	`$connection->update(`