Fix App Assurance Remediation: PHPStan issues (#793)

pradeepkanaka · Pradeep Kanaka · web-flow · commit 6af029a7ef55 · 2024-11-07T13:59:31.000-08:00
* Fix phpstan issues

* Fix: Kodiak: Security Findings

* Fix Console Error logs

---------

Co-authored-by: Pradeep Kanaka &lt;pradeepkanaka@RP-pradeepkanaka.local&gt;
diff --git a/app/code/Meta/BusinessExtension/Model/MBEInstalls.php b/app/code/Meta/BusinessExtension/Model/MBEInstalls.php
@@ -172,7 +172,9 @@ private function savePixelId($pixelId, $storeId)
                 $storeId
             );
             $this->fbeHelper->fetchAndSaveAAMSettings($pixelId, $storeId);
-            $this->fbeHelper->log("Saved fbe_installs pixel_id --- {$pixelId} for storeId: {$storeId}");
+            $this->fbeHelper->log(
+                "Saved fbe_installs pixel_id --- " . json_encode($pixelId) . " for storeId: {$storeId}"
+            );
         } else {
             $this->systemConfig->saveConfig(
                 SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PIXEL_ID,
diff --git a/app/code/Meta/BusinessExtension/Model/System/Config.php b/app/code/Meta/BusinessExtension/Model/System/Config.php
@@ -166,7 +166,8 @@ class Config
     private ?string $version = '1.3.5-dev';
 
     /**
-     * @method                                       __construct
+     * Config class constructor
+     *
      * @param                                        StoreManagerInterface    $storeManager
      * @param                                        ScopeConfigInterface     $scopeConfig
      * @param                                        ResourceConfig           $resourceConfig
@@ -279,7 +280,6 @@ public function getPromotionsUrl($storeId = null): string
     /**
      * Is single store mode
      *
-     * @method isSingleStoreMode
      * @return bool
      */
     public function isSingleStoreMode(): bool
@@ -413,7 +413,7 @@ public function shouldUseDefaultFulfillmentAddress($scopeId = null, $scope = nul
      * Get fulfillment address
      *
      * @param  int $scopeId
-     * @param  int $scope
+     * @param  string $scope
      * @return array
      */
     public function getFulfillmentAddress($scopeId = null, $scope = ScopeInterface::SCOPE_STORES): array
@@ -622,7 +622,7 @@ public function getExternalBusinessId($scopeId = null, $scope = null)
      * Get pixel id
      *
      * @param  int $scopeId
-     * @param  int $scope
+     * @param  string $scope
      * @return mixed
      */
     public function getPixelId($scopeId = null, $scope = ScopeInterface::SCOPE_STORES)
@@ -714,7 +714,7 @@ public function getCommerceAccountId($scopeId = null, $scope = null)
      * Get commerce partner integration ID
      *
      * @param  int $scopeId
-     * @param  int $scope
+     * @param  string $scope
      * @return mixed|null
      */
     public function getCommercePartnerIntegrationId($scopeId = null, $scope = ScopeInterface::SCOPE_STORES)
@@ -789,7 +789,7 @@ public function getShippingMethodsMap($storeId = null): array
      * Get shipping methods label map
      *
      * @param  int|null $storeId
-     * @return array|null
+     * @return array
      */
     public function getShippingMethodsLabelMap($storeId = null): array
     {
diff --git a/app/code/Meta/BusinessExtension/Setup/Patch/Data/ModifyMetaCronjobExecution.php b/app/code/Meta/BusinessExtension/Setup/Patch/Data/ModifyMetaCronjobExecution.php
@@ -65,6 +65,8 @@ public function apply()
         );
 
         $this->moduleDataSetup->getConnection()->endSetup();
+
+        return $this;
     }
 
     /**
diff --git a/app/code/Meta/Catalog/Model/Product/Feed/Builder/AdditionalAttributes.php b/app/code/Meta/Catalog/Model/Product/Feed/Builder/AdditionalAttributes.php
@@ -22,7 +22,7 @@
 
 use Exception;
 use Magento\Catalog\Model\Product;
-use Magento\Catalog\Model\ResourceModel\Eav\Attribute;
+use Magento\Catalog\Model\ResourceModel\Eav\AttributeFactory;
 use Magento\Catalog\Setup\CategorySetup;
 use Meta\BusinessExtension\Helper\FBEHelper;
 
@@ -35,18 +35,18 @@ class AdditionalAttributes
     private $fbeHelper;
 
     /**
-     * @var Attribute
+     * @var AttributeFactory
      */
     private $attributeFactory;
 
     /**
      * Constructor
      *
-     * @param Attribute $attributeFactory
+     * @param AttributeFactory $attributeFactory
      * @param FBEHelper $fbeHelper
      */
     public function __construct(
-        Attribute       $attributeFactory,
+        AttributeFactory $attributeFactory,
         FBEHelper       $fbeHelper
     ) {
         $this->fbeHelper = $fbeHelper;
@@ -183,7 +183,7 @@ function ($attributeList) {
     private function getAttributeList(callable $attributeFilterFn): array
     {
         $attributes = [];
-        $attributeList = $this->attributeFactory->getCollection();
+        $attributeList = $this->attributeFactory->create()->getCollection();
         if ($attributeList) {
             if ($attributeFilterFn) {
                 $attributeFilterFn($attributeList);
diff --git a/app/code/Meta/Catalog/Observer/ProcessCategoryAfterSaveEventObserver.php b/app/code/Meta/Catalog/Observer/ProcessCategoryAfterSaveEventObserver.php
@@ -24,6 +24,7 @@
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Message\ManagerInterface;
+use Magento\Catalog\Model\Category;
 use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Meta\Catalog\Model\Category\CategoryCollection;
diff --git a/app/code/Meta/Catalog/Plugin/FacebookCatalogDeletePlugin.php b/app/code/Meta/Catalog/Plugin/FacebookCatalogDeletePlugin.php
@@ -31,7 +31,7 @@ class FacebookCatalogDeletePlugin
 {
 
     /**
-     * @var FacebokoCatalogUpdate
+     * @var FacebookCatalogUpdate
      */
     private $catalogUpdateResourceModel;
 
diff --git a/app/code/Meta/Catalog/Setup/Patch/Data/AddCategoryAttributes.php b/app/code/Meta/Catalog/Setup/Patch/Data/AddCategoryAttributes.php
@@ -7,6 +7,7 @@
 use Magento\Catalog\Model\Category;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 use Magento\Eav\Setup\EavSetupFactory;
+use Magento\Eav\Setup\EavSetup;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Meta\Catalog\Setup\MetaCatalogAttributes;
 
diff --git a/app/code/Meta/Conversion/Block/Pixel/InitiateCheckout.php b/app/code/Meta/Conversion/Block/Pixel/InitiateCheckout.php
@@ -180,11 +180,12 @@ public function getQuote(): Quote
     public function getContentCategory(): string
     {
         $items = $this->getQuote()->getAllVisibleItems();
+        $contentCategory = '';
         foreach ($items as $item) {
             $product = $item->getProduct();
             $contentCategory =  $this->magentoDataHelper->getCategoriesForProduct($product);
         }
-        return $contentCategory;/** @phpstan-ignore-line */
+        return $contentCategory;
     }
 
     /**
diff --git a/app/code/Meta/Conversion/Block/Pixel/Purchase.php b/app/code/Meta/Conversion/Block/Pixel/Purchase.php
@@ -178,7 +178,7 @@ public function getContentName()
         if ($order) {
             $items = $order->getAllVisibleItems();
             foreach ($items as $item) {
-                /** @var Product $product */
+                /** @var Product $item */
                 $productName[] = $item->getName();
             }
         }
diff --git a/app/code/Meta/Conversion/Block/Pixel/ViewContent.php b/app/code/Meta/Conversion/Block/Pixel/ViewContent.php
@@ -21,6 +21,7 @@
 namespace Meta\Conversion\Block\Pixel;
 
 use Exception;
+use Magento\Catalog\Block\Product\View;
 use Magento\Catalog\Helper\Data as CatalogHelper;
 use Magento\Catalog\Model\Product;
 use Meta\BusinessExtension\Helper\FBEHelper;
@@ -205,6 +206,7 @@ public function getProductId()
     public function getCurrentProduct()
     {
         try {
+            /** @var View $block */
             $block = $this->getLayout()->getBlock('product.info');
             return $block ? $block->getProduct() : $this->catalogHelper->getProduct();
         } catch (Exception $e) {
diff --git a/app/code/Meta/Conversion/Helper/AAMFieldsExtractorHelper.php b/app/code/Meta/Conversion/Helper/AAMFieldsExtractorHelper.php
@@ -20,6 +20,7 @@
 
 namespace Meta\Conversion\Helper;
 
+use FacebookAds\Object\ServerSide\UserData;
 use Magento\Customer\Model\Customer;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
@@ -205,7 +206,7 @@ public function setUserData($event, $userDataArray = null, $customer = null)
         if (empty($userDataArray)) {
             return $event;
         }
-
+        /** @var UserData $userData */
         $userData = $event->getUserData();
         if (array_key_exists(AAMSettingsFields::EMAIL, $userDataArray)
         ) {
diff --git a/app/code/Meta/Conversion/Helper/ServerEventFactory.php b/app/code/Meta/Conversion/Helper/ServerEventFactory.php
@@ -146,6 +146,7 @@ private function isValidIpAddress($ipAddress)
      */
     private function addCustomData($event, $data)
     {
+        /** @var CustomData $custom_data */
         $custom_data = $event->getCustomData();
 
         foreach ($this->customDataMapping as $field => $setter) {
diff --git a/app/code/Meta/Conversion/Helper/ServerSideHelper.php b/app/code/Meta/Conversion/Helper/ServerSideHelper.php
@@ -26,6 +26,7 @@
 use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use FacebookAds\Api;
+use FacebookAds\Object\ServerSide\Event;
 use FacebookAds\Object\ServerSide\EventRequestAsync;
 use GuzzleHttp\Exception\RequestException;
 
diff --git a/app/code/Meta/Conversion/Model/Tracker/InitiateCheckout.php b/app/code/Meta/Conversion/Model/Tracker/InitiateCheckout.php
@@ -134,7 +134,7 @@ private function getCartCategories(CartInterface $quote): string
             $categoryNames[] = $category->getName();
         }
         
-        return implode(',', $categoryNames); /** @phpstan-ignore-line */
+        return implode(',', $categoryNames);
     }
 
     /**
diff --git a/app/code/Meta/Conversion/Model/Tracker/Purchase.php b/app/code/Meta/Conversion/Model/Tracker/Purchase.php
@@ -288,7 +288,7 @@ private function getContentName(OrderInterface $order)
         if ($order) {
             $items = $order->getAllVisibleItems();
             foreach ($items as $item) {
-                /** @var Product $product */
+                /** @var Product $item */
                 $productName[] = $item->getName();
             }
         }
diff --git a/app/code/Meta/Sales/Api/CreateOrderApiInterface.php b/app/code/Meta/Sales/Api/CreateOrderApiInterface.php
@@ -45,7 +45,7 @@ interface CreateOrderApiInterface
      * @param  CreateOrderApiProductItemInterface[]   $productItems
      * @param  CreateOrderApiShipmentDetailsInterface $shipmentDetails
      * @param  AddressInterface                       $billingAddress
-     * @param  string|null                            $channel
+     * @param  string                                 $channel
      * @param  bool                                   $buyerRemarketingOptIn
      * @param  bool                                   $createInvoice
      * @return \Magento\Sales\Api\Data\OrderInterface
diff --git a/app/code/Meta/Sales/Api/UpdateCartItemApiInterface.php b/app/code/Meta/Sales/Api/UpdateCartItemApiInterface.php
@@ -33,10 +33,7 @@ interface UpdateCartItemApiInterface
      * @param  string                                    $externalBusinessId
      * @param  \Magento\Quote\Api\Data\CartItemInterface $cartItem
      * @return \Magento\Quote\Api\Data\CartItemInterface
-     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
-     * @throws \Magento\Framework\Exception\CouldNotSaveException
-     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Exception
      */
     public function updateCartItem(string $externalBusinessId, CartItemInterface $cartItem): CartItemInterface;
 }
diff --git a/app/code/Meta/Sales/Block/Adminhtml/Order/View/Tab/Facebook.php b/app/code/Meta/Sales/Block/Adminhtml/Order/View/Tab/Facebook.php
@@ -20,6 +20,7 @@
 
 namespace Meta\Sales\Block\Adminhtml\Order\View\Tab;
 
+use Magento\Sales\Block\Adminhtml\Order\View\Tab\Info;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Magento\Backend\Block\Template;
 use Magento\Backend\Block\Template\Context;
@@ -68,7 +69,10 @@ public function __construct(
      */
     public function getOrder()
     {
-        return $this->getLayout()->getBlock('order_tab_info')->getOrder();
+        /** @var Info $orderTabInfo */
+        $orderTabInfo = $this->getLayout()->getBlock('order_tab_info');
+        
+        return $orderTabInfo->getOrder();
     }
 
     /**
diff --git a/app/code/Meta/Sales/Helper/CommerceHelper.php b/app/code/Meta/Sales/Helper/CommerceHelper.php
@@ -141,7 +141,7 @@ public function __construct(
      * Get facebook order by facebook order id
      *
      * @param string $facebookOrderId
-     * @return void
+     * @return FacebookOrderInterface
      */
     private function getFacebookOrder(string $facebookOrderId): FacebookOrderInterface
     {
@@ -377,7 +377,7 @@ public function pullCancelledOrders(int $storeId): array
                     // Get cancellation details for each order (assuming a method exists in GraphAPIAdapter)
                     $cancellationDetails = $this->graphAPIAdapter->getCancellations($facebookOrderId)[0];
                     // Process cancellations (you would need to create a method to handle this)
-                    $wasOrderCancelled = $this->createCancellation->execute($orderData, $cancellationDetails, $storeId);
+                    $wasOrderCancelled = $this->createCancellation->execute($orderData, $cancellationDetails);
                     if ($wasOrderCancelled) {
                         $cancelledOrdersDetails[$facebookOrderId] = $cancellationDetails;
                     }
diff --git a/app/code/Meta/Sales/Helper/ShippingHelper.php b/app/code/Meta/Sales/Helper/ShippingHelper.php
@@ -25,7 +25,7 @@ class ShippingHelper extends AbstractHelper
     private $logger;
 
     /**
-     * @var string[string] Supported carrier names by carrier code.
+     * @var array
      */
     private $supportedShippingCarriers = [];
 
diff --git a/app/code/Meta/Sales/Model/Api/CreateCartApi.php b/app/code/Meta/Sales/Model/Api/CreateCartApi.php
@@ -108,9 +108,7 @@ public function createCart(string $externalBusinessId): string
         $this->authenticator->authenticateRequest();
         $storeId = $this->orderHelper->getStoreIdByExternalBusinessId($externalBusinessId);
 
-        /**
-         * @var $quoteIdMask \Magento\Quote\Model\QuoteIdMask
-         */
+        /** @var QuoteIdMask $quoteIdMask */
         $quoteIdMask = $this->quoteIdMaskFactory->create();
 
         /**
diff --git a/app/code/Meta/Sales/Model/Api/DiscountRuleApi.php b/app/code/Meta/Sales/Model/Api/DiscountRuleApi.php
@@ -74,7 +74,7 @@ public function __construct(
      *
      * @param string $externalBusinessId
      * @param RuleInterface $rule
-     * @return int
+     * @return string
      * @throws LocalizedException
      */
     public function createRule(string $externalBusinessId, RuleInterface $rule): string
diff --git a/app/code/Meta/Sales/Model/Api/UpdateCartItemApi.php b/app/code/Meta/Sales/Model/Api/UpdateCartItemApi.php
@@ -73,10 +73,7 @@ public function __construct(
      * @param  string                                    $externalBusinessId
      * @param  \Magento\Quote\Api\Data\CartItemInterface $cartItem
      * @return \Magento\Quote\Api\Data\CartItemInterface
-     * @throws \Magento\Framework\Exception\UnauthorizedTokenException
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
-     * @throws \Magento\Framework\Exception\CouldNotSaveException
-     * @throws \Magento\Framework\Exception\InputException
+     * @throws \Exception
      */
     public function updateCartItem(string $externalBusinessId, CartItemInterface $cartItem): CartItemInterface
     {
diff --git a/app/code/Meta/Sales/Model/Order/CreateCancellation.php b/app/code/Meta/Sales/Model/Order/CreateCancellation.php
@@ -163,7 +163,10 @@ private function getOrder(array $data): ?Order
                 $magentoOrder = $this->orderRepository->get($magentoOrderId);
                 return $magentoOrder;
             } catch (\Exception $e) {
-                $this->logger->debug($e);
+                $this->logger->debug(
+                    $e->getMessage(),
+                    ['exception' => $e, 'trace' => $e->getTraceAsString()]
+                );
             }
         }
         // In the case of any failure or missing order, simply bail and return null.
diff --git a/app/code/Meta/Sales/Model/Order/CreateRefund.php b/app/code/Meta/Sales/Model/Order/CreateRefund.php
@@ -216,9 +216,12 @@ public function execute(array $facebookOrderData, array $facebookRefundData, int
             // to do this -- TODO, revisit this code.
             $magentoOrder->setBaseTotalPaid($orderTotal);
             $magentoOrder->setTaxRefunded($this->localeFormat->getNumber(-$tax));
-            $this->creditMemoService->refund($creditMemo, true, false);
+            $this->creditMemoService->refund($creditMemo, true);
         } catch (\Exception $exception) {
-            $this->logger->debug($exception);
+            $this->logger->debug(
+                $exception->getMessage(),
+                ['exception' => $exception, 'trace' => $exception->getTraceAsString()]
+            );
         }
 
         $magentoOrder->setStatus(Order::STATE_CLOSED);
diff --git a/app/code/Meta/Sales/Observer/Order/ShipmentObserver.php b/app/code/Meta/Sales/Observer/Order/ShipmentObserver.php
@@ -123,13 +123,12 @@ protected function getStoreId(Observer $observer)
     protected function getShipment(Observer $observer)
     {
         $event = $observer->getEvent()->getName();
-
-        /**
-         * @var Shipment $shipment
-         */
+        
         if ($event == Shipper::MAGENTO_EVENT_SHIPMENT_SAVE_AFTER) {
+            /** @var Shipment $shipment */
             $shipment = $observer->getEvent()->getShipment();
         } elseif ($event == Shipper::MAGENTO_EVENT_TRACKING_SAVE_AFTER) {
+            /** @var Shipment $shipment */
             $shipment = $observer->getEvent()->getTrack()->getShipment();
         } else {
             $shipment = null;
diff --git a/app/code/Meta/Sales/Plugin/ShippingData.php b/app/code/Meta/Sales/Plugin/ShippingData.php
@@ -38,7 +38,7 @@ class ShippingData
     /**
      * @var int
      */
-    private int $storeId;
+    private int $storeId = 0;
 
     public const ATTR_ENABLED = 'enabled';
     public const ATTR_TITLE = 'title';

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,8 @@ public function apply()`
`65`	`65`	`);`
`66`	`66`
`67`	`67`	`$this->moduleDataSetup->getConnection()->endSetup();`
	`68`	`+`
	`69`	`+ return $this;`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class FacebookCatalogDeletePlugin`
`31`	`31`	`{`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * @var FacebokoCatalogUpdate`
	`34`	`+ * @var FacebookCatalogUpdate`
`35`	`35`	`*/`
`36`	`36`	`private $catalogUpdateResourceModel;`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -180,11 +180,12 @@ public function getQuote(): Quote`
`180`	`180`	`public function getContentCategory(): string`
`181`	`181`	`{`
`182`	`182`	`$items = $this->getQuote()->getAllVisibleItems();`
	`183`	`+ $contentCategory = '';`
`183`	`184`	`foreach ($items as $item) {`
`184`	`185`	`$product = $item->getProduct();`
`185`	`186`	`$contentCategory = $this->magentoDataHelper->getCategoriesForProduct($product);`
`186`	`187`	`}`
`187`		`- return $contentCategory;/** @phpstan-ignore-line */`
	`188`	`+ return $contentCategory;`
`188`	`189`	`}`
`189`	`190`
`190`	`191`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ public function getContentName()`
`178`	`178`	`if ($order) {`
`179`	`179`	`$items = $order->getAllVisibleItems();`
`180`	`180`	`foreach ($items as $item) {`
`181`		`- /** @var Product $product */`
	`181`	`+ /** @var Product $item */`
`182`	`182`	`$productName[] = $item->getName();`
`183`	`183`	`}`
`184`	`184`	`}`