Enable pre onboarding and commerce plugin logging (#752)

* Adding new cron job to log enabled modules, removing that logging from catalog cron job, falling back to persist logs with client access token if access token is null

* Logging in LogCatalogSetup even if access token is null (will use client access token to persist log)

* Having EnabledModuleLogging cron job use system access token to persist log if possible

* Update cron job schedule to run once per week on Tuesday

* Fixing some issues

* Using ModuleList explicitly since it'll only return enabled modules

* Removing external_business_id from logging as it depends on storeId

* Updating array declaration per static test failure

---------

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

Author: nrostrow-meta

app/code/Meta/BusinessExtension/Cron/EnabledModuleLogging.php

@@ -0,0 +1,100 @@
+<?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\BusinessExtension\Cron;
+
+use Magento\Framework\Module\ModuleList;
+use Magento\Framework\App\ProductMetadataInterface;
+use Meta\BusinessExtension\Helper\GraphAPIAdapter;
+use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+
+class EnabledModuleLogging
+{
+    /**
+     * @var GraphAPIAdapter
+     */
+    private $graphAPIAdapter;
+
+    /**
+     * @var ModuleList
+     */
+    private $moduleList;
+
+    /**
+     * @var SystemConfig
+     */
+    private $systemConfig;
+
+    /**
+     * @var ProductMetadataInterface
+     */
+    private $productMetadata;
+
+    /**
+     * Construct
+     *
+     * @param GraphAPIAdapter           $graphAPIAdapter
+     * @param ModuleList                $moduleList
+     * @param SystemConfig              $systemConfig
+     * @param ProductMetadataInterface  $productMetadata
+     */
+    public function __construct(
+        GraphAPIAdapter             $graphAPIAdapter,
+        ModuleList                  $moduleList,
+        SystemConfig                $systemConfig,
+        ProductMetadataInterface    $productMetadata
+    ) {
+        $this->graphAPIAdapter = $graphAPIAdapter;
+        $this->moduleList = $moduleList;
+        $this->systemConfig = $systemConfig;
+        $this->productMetadata = $productMetadata;
+    }
+
+    /**
+     * Execute cron
+     */
+    public function execute()
+    {
+        $cmsIds = [];
+        $accessToken = null;
+        foreach ($this->systemConfig->getAllFBEInstalledStores() as $store) {
+            $storeId = $store->getId();
+            $cmsId = $this->systemConfig->getCommerceAccountId($storeId);
+            $cmsIds[] = $cmsId;
+            $storeAccessToken = $this->systemConfig->getAccessToken($storeId);
+            if ($storeAccessToken) {
+                $accessToken = $storeAccessToken;
+            }
+        }
+        $this->graphAPIAdapter->persistLogToMeta(
+            [
+                'event' => 'commerce_plugin_and_extension_logging',
+                'event_type' => 'enabled_modules',
+                'seller_platform_app_version' => $this->productMetadata->getVersion(),
+                'extra_data' => [
+                    'enabled_modules' => json_encode($this->moduleList->getNames()),
+                    'extension_version' => $this->systemConfig->getModuleVersion(),
+                    'cms_ids' => json_encode($cmsIds)
+                ]
+            ],
+            $accessToken
+        );
+    }
+}

app/code/Meta/BusinessExtension/Helper/GraphAPIAdapter.php

@@ -1024,7 +1024,7 @@ public function getFBEInstalls($accessToken, $externalBusinessId)
     public function persistLogToMeta($context, $accessToken = null)
     {
         $request = [
-            'access_token' => $accessToken ?? $this->accessToken,
+            'access_token' => $accessToken ?? $this->clientAccessToken,
             'event' => $this->getContextData($context, 'event'),
             'event_type' => $this->getContextData($context, 'event_type'),
             'commerce_merchant_settings_id' => $this->getContextData($context, 'commerce_merchant_settings_id'),

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

@@ -4,5 +4,8 @@
         <job name="facebook_automation_update_mbe_settings" instance="Meta\BusinessExtension\Cron\UpdateMBESettings" method="execute">
             <schedule>0 * * * *</schedule>
         </job>
+        <job name="enabled_module_logging" instance="Meta\BusinessExtension\Cron\EnabledModuleLogging" method="execute">
+            <schedule>0 0 * * 2</schedule>
+        </job>
     </group>
 </config>

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

@@ -21,7 +21,6 @@
 namespace Meta\Catalog\Cron;
 
 use Magento\Framework\App\ResourceConnection;
-use Magento\Framework\Module\FullModuleList;
 use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Helper\GraphAPIAdapter;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
@@ -37,44 +36,32 @@ class LogCatalogSetup
      * @var SystemConfig
      */
     private $systemConfig;
+
     /**
      * @var FBEHelper
      */
     private $fbeHelper;
 
-    /**
-     * @var FullModuleList
-     */
-    private $fullModuleList;
-
     /**
      * @var ResourceConnection
      */
     private $resourceConnection;
 
-    /**
-     * @var bool
-     */
-    private static $logInstalledModules = false;
-
     /**
      * @param GraphAPIAdapter    $graphAPIAdapter
      * @param SystemConfig       $systemConfig
      * @param FBEHelper          $fbeHelper
-     * @param FullModuleList     $fullModuleList
      * @param ResourceConnection $resourceConnection
      */
     public function __construct(
         GraphAPIAdapter $graphAPIAdapter,
         SystemConfig $systemConfig,
         FBEHelper $fbeHelper,
-        FullModuleList $fullModuleList,
         ResourceConnection $resourceConnection
     ) {
         $this->graphAPIAdapter = $graphAPIAdapter;
         $this->systemConfig = $systemConfig;
         $this->fbeHelper = $fbeHelper;
-        $this->fullModuleList = $fullModuleList;
         $this->resourceConnection = $resourceConnection;
     }
 
@@ -89,10 +76,6 @@ public function execute()
             $storeId = $store->getId();
             try {
                 $accessToken = $this->systemConfig->getAccessToken($storeId);
-                if (!$accessToken) {
-                    continue;
-                }
-
                 $this->graphAPIAdapter->persistLogToMeta(
                     [
                         'event' => 'log_catalog_setup_data',
@@ -106,10 +89,7 @@ public function execute()
                                     'group_count' => $this->queryGroupCount(),
                                     'breakdown' => $this->queryBreakdown(),
                                 ]
-                            ),
-                            'extensions' => self::$logInstalledModules
-                                ? json_encode($this->fullModuleList->getAll())
-                                : 'Logging installed modules not enabled'
+                            )
                         ]
                     ],
                     $accessToken