Ratings and reviews feed upload cron job (#859)

* Setting up cron job for ratings and reviews feed upload

* Casting store->getId as int

* Magento -> magento for aggregator

* Removing country from feed upload as there is no way in Magento to get the country directly associated with the particular review.

---------

Co-authored-by: Noah Ostrowski <[email protected]>

Author: nrostrow-meta

app/code/Meta/Catalog/Cron/RatingsAndReviewsFeedUploadCron.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Catalog\Cron;
+
+use Meta\BusinessExtension\Helper\FBEHelper;
+use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+use Meta\Catalog\Model\Product\Feed\Method\RatingsAndReviewsFeedApi;
+
+class RatingsAndReviewsFeedUploadCron
+{
+    /**
+     * @var RatingsAndReviewsFeedApi
+     */
+    private RatingsAndReviewsFeedApi $ratingsAndReviewsFeedApi;
+
+    /**
+     * @var SystemConfig
+     */
+    private SystemConfig $systemConfig;
+
+    /**
+     * @var FBEHelper
+     */
+    private FBEHelper $fbeHelper;
+
+    /**
+     * RatingsAndReviewsFeedUploadCron constructor
+     *
+     * @param RatingsAndReviewsFeedApi $ratingsAndReviewsFeedApi
+     * @param SystemConfig $systemConfig
+     * @param FBEHelper $fbeHelper
+     */
+    public function __construct(
+        RatingsAndReviewsFeedApi  $ratingsAndReviewsFeedApi,
+        SystemConfig              $systemConfig,
+        FBEHelper                 $fbeHelper
+    ) {
+        $this->ratingsAndReviewsFeedApi = $ratingsAndReviewsFeedApi;
+        $this->systemConfig = $systemConfig;
+        $this->fbeHelper = $fbeHelper;
+    }
+
+    /**
+     * Sync ratings and reviews from Magento platform to Meta through feed upload API
+     *
+     * @return void
+     */
+    public function execute()
+    {
+        foreach ($this->systemConfig->getAllFBEInstalledStores() as $store) {
+            $storeId = (int)$store->getId();
+            try {
+                if ($this->systemConfig->isCatalogSyncEnabled($storeId)) {
+                    $this->ratingsAndReviewsFeedApi->execute($storeId);
+                }
+            } catch (\Throwable $e) {
+                $this->fbeHelper->logExceptionImmediatelyToMeta(
+                    $e,
+                    [
+                      'store_id' => $storeId,
+                      'event' => 'ratings_and_reviews_sync',
+                      'event_type' => 'cron_job',
+                      'catalog_id' => $this->systemConfig->getCatalogId($storeId),
+                    ]
+                );
+            }
+        }
+    }
+}

app/code/Meta/Catalog/Model/Product/Feed/Method/RatingsAndReviewsFeedApi.php

@@ -120,7 +120,7 @@ public function execute(int $storeId): mixed
             $ratingsAndReviewsData = [];
 
             // Fetch store data
-            $ratingsAndReviewsData['aggregator'] = "Magento";
+            $ratingsAndReviewsData['aggregator'] = "magento";
             $storeData = [
                 'name' => $store->getName(),
                 'id' => $this->systemConfig->getCommerceAccountId($storeId),
@@ -132,7 +132,6 @@ public function execute(int $storeId): mixed
             $reviewCollection = $this->reviewCollectionFactory->create()
                 ->addStoreFilter($storeId)
                 ->addStatusFilter(Review::STATUS_APPROVED);
-            $countryCode = $store->getConfig('general/country/default');
             $reviews = [];
             foreach ($reviewCollection as $review) {
                 $reviewData = [
@@ -141,7 +140,6 @@ public function execute(int $storeId): mixed
                     'title' => $review->getTitle(),
                     'content' => $review->getDetail(),
                     'createdAt' => $review->getCreatedAt(),
-                    'country' => $countryCode,
                     'reviewer' => [
                         'name' => $review->getNickname(),
                         'reviewerID' => $review->getCustomerId()
@@ -278,7 +276,6 @@ private function generateCsvString($ratingsAndReviewsData): string
             "title",
             "content",
             "created_at",
-            "country",
             "reviewer.name",
             "reviewer.reviewerID",
             "product.name",
@@ -298,7 +295,6 @@ private function generateCsvString($ratingsAndReviewsData): string
                 $review['title'],
                 $review['content'],
                 $review['createdAt'],
-                $review['country'],
                 $review['reviewer']['name'],
                 $review['reviewer']['reviewerID'],
                 $review['product']['name'],

app/code/Meta/Catalog/etc/crontab.xml

@@ -19,5 +19,8 @@
         <job name="facebook_automation_log_catalog_setup" instance="Meta\Catalog\Cron\LogCatalogSetup" method="execute">
             <schedule>0 4 * * 0</schedule>
         </job>
+        <job name="facebook_automation_ratings_and_reviews_feed_upload_cron" instance="Meta\Catalog\Cron\RatingsAndReviewsFeedUploadCron" method="execute">
+            <schedule>0 4 * * 6</schedule>
+        </job>
     </group>
 </config>