Analytics Page PHP client v2 compatibility (#967)

Author: bsuravech

Helper/AnalyticsHelper.php

@@ -3,8 +3,9 @@
 namespace Algolia\AlgoliaSearch\Helper;
 
 use Algolia\AlgoliaSearch\AnalyticsClient;
+use Algolia\AlgoliaSearch\Config\AnalyticsConfig;
 use Algolia\AlgoliaSearch\DataProvider\Analytics\IndexEntityDataProvider;
-use AlgoliaSearch\Analytics;
+use Algolia\AlgoliaSearch\RequestOptions\RequestOptionsFactory;
 
 class AnalyticsHelper
 {
@@ -48,8 +49,11 @@ class AnalyticsHelper
     private $analyticsClient;
 
     /**
-     * AnalyticsHelper constructor.
-     *
+     * @var AnalyticsConfig
+     */
+    private $analyticsConfig;
+
+    /**
      * @param AlgoliaHelper $algoliaHelper
      * @param ConfigHelper $configHelper
      * @param IndexEntityDataProvider $entityHelper
@@ -82,6 +86,11 @@ private function setupAnalyticsClient()
             $this->configHelper->getApplicationID(),
             $this->configHelper->getAPIKey()
         );
+
+        $this->analyticsConfig = AnalyticsConfig::create(
+            $this->configHelper->getApplicationID(),
+            $this->configHelper->getAPIKey()
+        );
     }
 
     /**
@@ -350,9 +359,16 @@ private function fetch($path, array $params)
                 throw new \Magento\Framework\Exception\LocalizedException($msg);
             }
 
-            $response = $this->analyticsClient->custom('GET', $path, $params);
+            $this->setupAnalyticsClient();
+
+            $requestOptions = new RequestOptionsFactory($this->analyticsConfig);
+            $requestOptions = $requestOptions->create([]);
+
+            $requestOptions->addQueryParameters($params);
+
+            $response = $this->analyticsClient->custom('GET', $path, $requestOptions);
         } catch (\Exception $e) {
-            $this->errors[] = $e->getMessage();
+            $this->errors[] = $e->getMessage() . ': ' . $path;
             $this->logger->log($e->getMessage());
 
             $this->fetchError = true;

ViewModel/Adminhtml/Analytics/Overview.php

@@ -44,8 +44,6 @@ public function __construct(
         $this->backendView = $backendView;
         $this->analyticsHelper = $analyticsHelper;
         $this->indexEntityDataProvider = $indexEntityDataProvider;
-
-        $this->getTotalCountOfSearches();
     }
 
     /**
@@ -56,6 +54,14 @@ public function getBackendView()
         return $this->backendView;
     }
 
+    public function getTimeZone()
+    {
+        return $this->backendView->getDateTime()->getConfigTimezone(
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
+            $this->getStore()->getId()
+        );
+    }
+
     /**
      * @throws NoSuchEntityException
      *
@@ -80,13 +86,13 @@ public function getAnalyticsParams($additional = [])
         if (empty($this->analyticsParams)) {
             $params = ['index' => $this->getIndexName()];
             if ($formData = $this->getBackendView()->getBackendSession()->getAlgoliaAnalyticsFormData()) {
+                $dateTime = $this->getBackendView()->getDateTime();
+                $timeZone = $this->getTimeZone();
                 if (isset($formData['from']) && $formData['from'] !== '') {
-                    $params['startDate'] = date('Y-m-d', $this->getBackendView()->getDateTime()
-                        ->date($formData['from'])->getTimestamp());
+                    $params['startDate'] = $dateTime->date($formData['from'], $timeZone, true, false)->format('Y-m-d');
                 }
                 if (isset($formData['to']) && $formData['to'] !== '') {
-                    $params['endDate'] = date('Y-m-d', $this->getBackendView()->getDateTime()
-                        ->date($formData['to'])->getTimestamp());
+                    $params['endDate'] = $dateTime->date($formData['to'], $timeZone, true, false)->format('Y-m-d');
                 }
             }
 
@@ -296,14 +302,18 @@ public function getNoResultSearches()
     }
 
     /**
+     * @throws NoSuchEntityException
+     *
      * @return bool
      */
     public function checkIsValidDateRange()
     {
         if ($formData = $this->getBackendView()->getBackendSession()->getAlgoliaAnalyticsFormData()) {
             if (isset($formData['from']) && !empty($formData['from'])) {
-                $startDate = $this->getBackendView()->getDateTime()->date($formData['from']);
-                $diff = date_diff($startDate, $this->getBackendView()->getDateTime()->date());
+                $dateTime = $this->getBackendView()->getDateTime();
+                $timeZone = $this->getTimeZone();
+                $startDate = $dateTime->date($formData['from'], $timeZone, true, false);
+                $diff = date_diff($startDate, $dateTime->date(null, $timeZone, true, null));
 
                 if ($diff->days > $this->getAnalyticRetentionDays()) {
                     return false;

view/adminhtml/layout/algolia_algoliasearch_analytics_index.xml

@@ -21,7 +21,7 @@
             </block>
         </referenceContainer>
         <referenceContainer name="content">
-            <block class="Magento\Backend\Block\Template" name="analytics_overview" template="Algolia_AlgoliaSearch::analytics/overview.phtml">
+            <block class="Magento\Backend\Block\Template" name="analytics.overview" template="Algolia_AlgoliaSearch::analytics/overview.phtml">
                 <arguments>
                     <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Analytics\Overview</argument>
                 </arguments>

view/adminhtml/layout/default.xml

@@ -5,6 +5,10 @@
     </head>
 
     <referenceBlock name="before.body.end">
-        <block class="Magento\Backend\Block\Template" name="algolia_tracking" template="Algolia_AlgoliaSearch::tracking.phtml" />
+        <block class="Magento\Backend\Block\Template" name="algolia.tracking" template="Algolia_AlgoliaSearch::tracking.phtml">
+            <arguments>
+                <argument name="view_model" xsi:type="object">Algolia\AlgoliaSearch\ViewModel\Adminhtml\Common</argument>
+            </arguments>
+        </block>
     </referenceBlock>
 </page>

view/adminhtml/templates/tracking.phtml

@@ -1,4 +1,12 @@
+<?php
+/** @var \Magento\Backend\Block\Template $block */
+/** @var \Algolia\AlgoliaSearch\ViewModel\Adminhtml\Common $viewModel */
+$view = $block->getViewModel();
+$applicationId = $view->getApplicationId();
+?>
+
 <script>
+var algoliaAppId = '<?php echo $block->escapeJs($applicationId) ?>';
 var algoliaEventsTracking = {
 
     eventsToTrack: [
@@ -359,7 +367,7 @@ var algoliaEventsTracking = {
         data = data || {};
 
         const postData = JSON.stringify({
-            appId: applicationId,
+            appId: algoliaAppId,
             eventName: eventName,
             data: data
         });