MAGE-1170: changes after review

Author: damcou

Api/Data/IndexOptionsInterface.php

@@ -31,7 +31,7 @@ public function getIndexSuffix(): ?string;
      *
      * @return bool
      */
-    public function isTmp(): bool;
+    public function isTemporaryIndex(): bool;
 
     /**
      * Get field: enforced_index_name

Model/IndexOptions.php

@@ -7,27 +7,45 @@
 
 class IndexOptions extends DataObject implements IndexOptionsInterface
 {
+    /**
+     * Return the current store_id; if the method returns null, the Magento default store will be used
+     *
+     * @return int|null
+     */
     public function getStoreId(): ?int
     {
         return $this->hasData(IndexOptionsInterface::STORE_ID) ?
             (int) $this->getData(IndexOptionsInterface::STORE_ID) :
             null;
     }
 
+    /**
+     * Suffix usually refers to the entity to index (_products, _categories, _pages, ...)
+     *
+     * @return string|null
+     */
     public function getIndexSuffix(): ?string
     {
         return $this->hasData(IndexOptionsInterface::INDEX_SUFFIX) ?
             (string) $this->getData(IndexOptionsInterface::INDEX_SUFFIX) :
             null;
     }
 
-    public function isTmp(): bool
+    /**
+     * Temporary indices can be used in case of full reindexing
+     *
+     * @return bool
+     */
+    public function isTemporaryIndex(): bool
     {
-        return $this->hasData(IndexOptionsInterface::IS_TMP) ?
-            (string) $this->getData(IndexOptionsInterface::IS_TMP) :
-            false;
+        return $this->hasData(IndexOptionsInterface::IS_TMP) && $this->getData(IndexOptionsInterface::IS_TMP);
     }
 
+    /**
+     * In case an enforced index name is used, this will override the index names fetched by the IndexNameFetcher service
+     *
+     * @return string|null
+     */
     public function getEnforcedIndexName(): ?string
     {
         return $this->hasData(IndexOptionsInterface::ENFORCED_INDEX_NAME) ?

Service/AlgoliaConnector.php

@@ -308,6 +308,8 @@ function ($id) {
     }
 
     /**
+     * Warning: This method can't be performed across two different applications
+     *
      * @param IndexOptions $fromIndexOptions
      * @param IndexOptions $toIndexOptions
      * @return void
@@ -560,6 +562,8 @@ public function deleteRule(
     }
 
     /**
+     * Warning: This method can't be performed across two different applications
+     *
      * @param IndexOptionsInterface $fromIndexOptions
      * @param IndexOptionsInterface $toIndexOptions
      * @return void
@@ -583,6 +587,8 @@ public function copySynonyms(IndexOptionsInterface $fromIndexOptions, IndexOptio
     }
 
     /**
+     * Warning: This method can't be performed across two different applications
+     *
      * @param IndexOptionsInterface $fromIndexOptions
      * @param IndexOptionsInterface $toIndexOptions
      * @return void
@@ -1062,6 +1068,7 @@ protected function getAlgoliaFiltersArrayWithoutCurrentRefinement($filters, $nee
      * @param IndexOptionsInterface $indexOptions
      * @return string|null
      * @throws NoSuchEntityException
+     * @throws AlgoliaException
      */
     protected function getIndexName(IndexOptionsInterface $indexOptions): ?string
     {
@@ -1070,13 +1077,13 @@ protected function getIndexName(IndexOptionsInterface $indexOptions): ?string
         }
 
         if (is_null($indexOptions->getIndexSuffix())) {
-            return null;
+            throw new AlgoliaException('Index suffix is mandatory in case no enforced index name is specified.');
         }
 
         return $this->indexNameFetcher->getIndexName(
             $indexOptions->getIndexSuffix(),
             $indexOptions->getStoreId(),
-            $indexOptions->isTmp()
+            $indexOptions->isTemporaryIndex()
         );
     }
 }