Merge pull request #1031 from algolia/develop

Develop

Author: damcou

.styleci.yml

@@ -1,7 +1,5 @@
 preset: PSR2
 
-linting: true
-
 enabled:
   - long_array_syntax
 

.travis.yml

@@ -17,7 +17,7 @@ install:
   - composer install --no-scripts
 
 before_script:
-  - wget http://api-key-dealer.herokuapp.com/clients/algolia-keys && chmod +x algolia-keys
+  - wget https://alg.li/algolia-keys && chmod +x algolia-keys
 
 script:
   - eval $(./algolia-keys export) && dev/runTests.sh -a $ALGOLIA_APPLICATION_ID -k $ALGOLIA_API_KEY -s $ALGOLIA_SEARCH_API_KEY -b http://magento.local -p TRAVIS_M1_ -v 193

CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGE LOG
 
+## 1.14.0
+
+### FEATURES
+- [Click & Conversion analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/) (#1027) - [Documentation](https://community.algolia.com/magento/doc/m1/click-analytics/) 
+- Facet query rules (#1025) 
+- Add option to index empty categories (#992)
+- Search for facet values (#1020) 
+
+
+### UPDATES
+- Show longest attribute when the record is skipped (#976)
+- Add CSS classes to InstantSearch widget containers (#977 )
+- Hide the instant-search selector on algoliaConfig variable (#981)
+- Escape JS suggestions in autocomplete menu (#984)
+- Never index SID in URL (#985)
+- Skip rebuilding CMS page(s) when the extension has not been configured (#1000)
+- Add "filters" rule to ranking formula (#1005)
+- Display default price when customer group is 0 (#1011)
+- Automatically delete unused replica indices (#1019) 
+- Remove category from indexes of all store views (#1028) 
+
+### FIXES
+- Fix configurable products' prices (#978)
+- Fix bug #979 (#980) 
+- Fix expired special prices (#988)
+- Fix special price with customer groups (#997)
+- Fix buggy behavior on iOS (#1009)
+
+
 ## 1.13.0
 
 ### FEATURES

README.md

@@ -1,7 +1,7 @@
 Algolia Search for Magento 1.6+
 ==================
 
-![Latest version](https://img.shields.io/badge/latest-1.13.0-green.svg)
+![Latest version](https://img.shields.io/badge/latest-1.14.0-green.svg)
 
 [![Build Status](https://travis-ci.org/algolia/algoliasearch-magento.svg?branch=master)](https://travis-ci.org/algolia/algoliasearch-magento)
 ![PHP >= 5.3](https://img.shields.io/badge/php-%3E=5.3-green.svg)

app/code/community/Algolia/Algoliasearch/Block/System/Config/Form/Field/Facets.php

@@ -41,6 +41,22 @@ public function __construct()
                     'label' => 'Label',
                     'style' => 'width: 100px;',
                 ),
+                'searchable' => array(
+                    'label' => 'Searchable?',
+                    'options' => array(
+                        '1' => 'Yes',
+                        '2' => 'No'
+                    ),
+                    'rowMethod' => 'getSearchable',
+                ),
+                'create_rule' => array(
+                    'label'  => 'Create Query rule?',
+                    'options' => array(
+                        '1' => 'Yes',
+                        '2' => 'No'
+                    ),
+                    'rowMethod' => 'getCreateRule',
+                ),
             ),
             'buttonLabel' => 'Add Facet',
             'addAfter'    => false,

app/code/community/Algolia/Algoliasearch/Helper/Algoliahelper.php

@@ -47,6 +47,11 @@ public function resetCredentialsFromConfig()
         }
     }
 
+    public function getClient()
+    {
+        return $this->client;
+    }
+
     public function generateSearchSecuredApiKey($key, $params = array())
     {
         return $this->client->generateSecuredApiKey($key, $params);
@@ -116,12 +121,17 @@ public function moveIndex($tmpIndexName, $indexName)
         $this->lastTaskId = $res['taskID'];
     }
 
+    public function getSettings($indexName)
+    {
+        return $this->getIndex($indexName)->getSettings();
+    }
+
     public function mergeSettings($indexName, $settings)
     {
         $onlineSettings = array();
 
         try {
-            $onlineSettings = $this->getIndex($indexName)->getSettings();
+            $onlineSettings = $this->getSettings($indexName);
         } catch (\Exception $e) {
         }
 
@@ -261,13 +271,20 @@ public function copyQueryRules($fromIndexName, $toIndexName)
         $this->lastTaskId = $res['taskID'];
     }
 
-    public function waitLastTask()
+    public function waitLastTask($lastUsedIndexName = null, $lastTaskId = null)
     {
-        if (!isset($this->lastUsedIndexName) || !isset($this->lastTaskId)) {
+        if ($lastUsedIndexName === null && isset($this->lastUsedIndexName)) {
+            $lastUsedIndexName = $this->lastUsedIndexName;
+        }
+
+        if ($lastTaskId === null && isset($this->lastTaskId)) {
+            $lastTaskId = $this->lastTaskId;
+        }
+        if (!$lastUsedIndexName || !$lastTaskId) {
             return;
         }
 
-        $this->client->initIndex($this->lastUsedIndexName)->waitTask($this->lastTaskId);
+        $this->client->initIndex($lastUsedIndexName)->waitTask($lastTaskId);
     }
 
     private function prepareRecords(&$objects, $indexName)
@@ -282,26 +299,34 @@ private function prepareRecords(&$objects, $indexName)
 
             $previousObject = $object;
 
-            $this->handleTooBigRecord($object);
-
-            if ($previousObject !== $object) {
-                $modifiedIds[] = $indexName.' objectID('.$previousObject['objectID'].')';
-            }
+            $object = $this->handleTooBigRecord($object);
 
             if ($object === false) {
+                $longestAttribute = $this->getLongestAttribute($previousObject);
+                $modifiedIds[] = $indexName.' - ID '.$previousObject['objectID'].' - skipped - longest attribute: '.$longestAttribute;
+
                 unset($objects[$key]);
-                continue;
+            } elseif ($previousObject !== $object) {
+                $modifiedIds[] = $indexName.' - ID '.$previousObject['objectID'].' - truncated';
             }
         }
 
         if (!empty($modifiedIds)) {
+            $separator = php_sapi_name() === 'cli' ? "\n" : '<br>';
+
+            $errorMessage = 'Algolia reindexing: You have some records which are too big to be indexed in Algolia. They have either been truncated (removed attributes: '.implode(', ', $this->potentiallyLongAttributes).') or skipped completely: '.$separator.implode($separator, $modifiedIds);
+
             /** @var Mage_Adminhtml_Model_Session $session */
             $session = Mage::getSingleton('adminhtml/session');
-            $session->addWarning('Algolia reindexing : You have some records ('.implode(',', $modifiedIds).') that are too big. They have either been truncated or skipped.');
+            $session->addWarning($errorMessage);
+
+            if (php_sapi_name() === 'cli') {
+                echo $errorMessage . "\n";
+            }
         }
     }
 
-    public function handleTooBigRecord(&$object)
+    public function handleTooBigRecord($object)
     {
         $size = mb_strlen(json_encode($object));
 
@@ -318,5 +343,35 @@ public function handleTooBigRecord(&$object)
                 $object = false;
             }
         }
+
+        return $object;
+    }
+
+    private function getLongestAttribute($object)
+    {
+        $maxLength = 0;
+        $longestAttribute = '';
+
+        foreach ($object as $attribute => $value) {
+            $attributeLenght = mb_strlen(json_encode($value));
+
+            if ($attributeLenght > $maxLength) {
+                $longestAttribute = $attribute;
+
+                $maxLength = $attributeLenght;
+            }
+        }
+
+        return $longestAttribute;
+    }
+
+    public function getLastIndexName()
+    {
+        return $this->lastUsedIndexName;
+    }
+
+    public function getLastTaskId()
+    {
+        return $this->lastTaskId;
     }
 }

app/code/community/Algolia/Algoliasearch/Helper/Config.php

@@ -47,6 +47,7 @@ class Algolia_Algoliasearch_Helper_Config extends Mage_Core_Helper_Abstract
     const INDEX_PRODUCT_COUNT = 'algoliasearch/categories/index_product_count';
     const CATEGORY_CUSTOM_RANKING = 'algoliasearch/categories/custom_ranking_category_attributes';
     const SHOW_CATS_NOT_INCLUDED_IN_NAVIGATION = 'algoliasearch/categories/show_cats_not_included_in_navigation';
+    const INDEX_EMPTY_CATEGORIES = 'algoliasearch/categories/index_empty_categories';
 
     const IS_ACTIVE = 'algoliasearch/queue/active';
     const NUMBER_OF_ELEMENT_BY_PAGE = 'algoliasearch/queue/number_of_element_by_page';
@@ -59,10 +60,15 @@ class Algolia_Algoliasearch_Helper_Config extends Mage_Core_Helper_Abstract
     const XML_PATH_IMAGE_HEIGHT = 'algoliasearch/image/height';
     const XML_PATH_IMAGE_TYPE = 'algoliasearch/image/type';
 
-    const ENABLE_ANALYTICS = 'algoliasearch/analytics/enable_analytics';
-    const ANALYTICS_DELAY = 'algoliasearch/analytics/delay';
-    const ANALYTICS_TRIGGER_ON_UI_INTERACTION = 'algoliasearch/analytics/trigger_on_ui_interaction';
-    const ANALYTICS_PUSH_INITIAL_SEARCH = 'algoliasearch/analytics/push_initial_search';
+    const GA_ENABLE = 'algoliasearch/analytics/enable';
+    const GA_DELAY = 'algoliasearch/analytics/delay';
+    const GA_TRIGGER_ON_UI_INTERACTION = 'algoliasearch/analytics/trigger_on_ui_interaction';
+    const GA_PUSH_INITIAL_SEARCH = 'algoliasearch/analytics/push_initial_search';
+
+    const CC_ANALYTICS_ENABLE = 'algoliasearch/cc_analytics/enable';
+    const CC_ANALYTICS_IS_SELECTOR = 'algoliasearch/cc_analytics/is_selector';
+    const CC_CONVERSION_ANALYTICS_MODE = 'algoliasearch/cc_analytics/conversion_analytics_mode';
+    const CC_ADD_TO_CART_SELECTOR = 'algoliasearch/cc_analytics/add_to_cart_selector';
 
     const ENABLE_SYNONYMS = 'algoliasearch/synonyms/enable_synonyms';
     const SYNONYMS = 'algoliasearch/synonyms/synonyms';
@@ -113,6 +119,11 @@ public function showCatsNotIncludedInNavigation($storeId = null)
         return Mage::getStoreConfigFlag(self::SHOW_CATS_NOT_INCLUDED_IN_NAVIGATION, $storeId);
     }
 
+    public function shouldIndexEmptyCategories($storeId = null)
+    {
+        return Mage::getStoreConfigFlag(self::INDEX_EMPTY_CATEGORIES, $storeId);
+    }
+
     public function isDefaultSelector($storeId = null)
     {
         return '.algolia-search-input' === $this->getAutocompleteSelector($storeId);
@@ -465,6 +476,7 @@ public function getAttributesToRetrieve($group_id)
             $attributes[] = 'price.'.$currency.'.default_formated';
             $attributes[] = 'price.'.$currency.'.group_'.$group_id;
             $attributes[] = 'price.'.$currency.'.group_'.$group_id.'_formated';
+            $attributes[] = 'price.'.$currency.'.group_'.$group_id.'_original_formated';
             $attributes[] = 'price.'.$currency.'.special_from_date';
             $attributes[] = 'price.'.$currency.'.special_to_date';
         }
@@ -588,22 +600,42 @@ public function getExtensionVersion()
 
     public function isEnabledAnalytics($storeId = null)
     {
-        return Mage::getStoreConfigFlag(self::ENABLE_ANALYTICS, $storeId);
+        return Mage::getStoreConfigFlag(self::GA_ENABLE, $storeId);
     }
 
     public function getAnalyticsDelay($storeId = null)
     {
-        return (int) Mage::getStoreConfig(self::ANALYTICS_DELAY, $storeId);
+        return (int) Mage::getStoreConfig(self::GA_DELAY, $storeId);
     }
 
     public function getTriggerOnUIInteraction($storeId = null)
     {
-        return Mage::getStoreConfigFlag(self::ANALYTICS_TRIGGER_ON_UI_INTERACTION, $storeId);
+        return Mage::getStoreConfigFlag(self::GA_TRIGGER_ON_UI_INTERACTION, $storeId);
     }
 
     public function getPushInitialSearch($storeId = null)
     {
-        return Mage::getStoreConfigFlag(self::ANALYTICS_PUSH_INITIAL_SEARCH, $storeId);
+        return Mage::getStoreConfigFlag(self::GA_PUSH_INITIAL_SEARCH, $storeId);
+    }
+
+    public function isClickConversionAnalyticsEnabled($storeId = null)
+    {
+        return Mage::getStoreConfigFlag(self::CC_ANALYTICS_ENABLE, $storeId);
+    }
+
+    public function getClickConversionAnalyticsISSelector($storeId = null)
+    {
+        return Mage::getStoreConfig(self::CC_ANALYTICS_IS_SELECTOR, $storeId);
+    }
+
+    public function getConversionAnalyticsMode($storeId = null)
+    {
+        return Mage::getStoreConfig(self::CC_CONVERSION_ANALYTICS_MODE, $storeId);
+    }
+
+    public function getConversionAnalyticsAddToCartSelector($storeId = null)
+    {
+        return Mage::getStoreConfig(self::CC_ADD_TO_CART_SELECTOR, $storeId);
     }
 
     public function isEnabledSynonyms($storeId = null)

app/code/community/Algolia/Algoliasearch/Helper/Data.php

@@ -416,7 +416,7 @@ public function rebuildStoreCategoryIndexPage($storeId, $collectionDefault, $pag
 
             $categoryObject = $this->category_helper->getObject($category);
 
-            if ($categoryObject['product_count'] > 0) {
+            if ($this->config->shouldIndexEmptyCategories($storeId) === true || $categoryObject['product_count'] > 0) {
                 array_push($indexData, $categoryObject);
             }
         }
@@ -730,4 +730,39 @@ private function setExtraSettings($storeId, $saveToTmpIndicesToo)
             throw new \AlgoliaSearch\AlgoliaException('<br>'.implode('<br> ', $error));
         }
     }
+
+    public function deleteInactiveProducts($storeId)
+    {
+        $indexName = $this->product_helper->getIndexName($storeId);
+        $index = $this->algolia_helper->getIndex($indexName);
+
+        $objectIds = array();
+        $counter = 0;
+        foreach ($index->browse('', array('attributesToRetrieve' => array('objectID'))) as $hit) {
+            $objectIds[] = $hit['objectID'];
+            $counter++;
+
+            if ($counter === 1000) {
+                $this->deleteInactiveIds($storeId, $objectIds, $indexName);
+
+                $objectIds = array();
+                $counter = 0;
+            }
+        }
+
+        if (!empty($objectIds)) {
+            $this->deleteInactiveIds($storeId, $objectIds, $indexName);
+        }
+    }
+
+    private function deleteInactiveIds($storeId, $objectIds, $indexName)
+    {
+        $collection = $this->product_helper->getProductCollectionQuery($storeId, $objectIds);
+        $dbIds = $collection->getAllIds();
+        
+        $collection = null;
+
+        $idsToDeleteFromAlgolia = array_diff($objectIds, $dbIds);
+        $this->algolia_helper->deleteObjects($idsToDeleteFromAlgolia, $indexName);
+    }
 }