Merge #916

916: Handle multiple index names in strapi config r=brunoocasali a=L-Weisz

# Pull Request

## Related issue
Fixes #651 

## What does this PR do?

This Pull Request introduces the capability to associate a single collection with multiple index names within Strapi's configuration. Previously, the indexName parameter was limited to a single string value, specifying one index per collection. Now, indexName can be defined as an array, enabling a collection to be indexed under multiple names simultaneously.

For example, the configuration can now be specified as:

Before: indexName: "my_restaurant"
After: indexName: "my_restaurant"  (after review, found a way to avoid the breaking change)
After: indexName: ["my_restaurant"]
After: indexName: ["my_restaurant", "all_restaurants"]
Additionally, this update includes the introduction of new tests to ensure that the expanded functionality does not disrupt existing features. An existing test was also corrected.

Important Changes:

**Limitation:** While indexName can now accept multiple values, all other configuration attributes remain uniform across the specified indexes. This means that any update to one index will apply identically to all indexes associated with a given collection, reflecting the same settings and data.


This enhancement provides greater flexibility in managing index names for collections within Strapi, streamlining the process of data organization and retrieval across multiple indexes.

### Result
![image](https://github.com/meilisearch/strapi-plugin-meilisearch/assets/117728108/33d6c8aa-8558-40d0-8fa4-14b3551811d1)
![image](https://github.com/meilisearch/strapi-plugin-meilisearch/assets/117728108/3baee28b-23a6-4766-a828-ebf52175c895)


## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Leah Weisz <[email protected]>
Co-authored-by: L-Weisz <[email protected]>

Author: meili-bors[bot]

README.md

@@ -217,9 +217,11 @@ Settings:
 
 By default, when indexing a content-type in Meilisearch, the index in Meilisearch has the same name as the content-type. This behavior can be changed by setting the `indexName` property in the configuration file of the plugin.
 
-**Example:**
+To link a single collection to multiple indexes, you can assign an array of index names to the `indexName` property.
 
-In the following example, the `restaurant` content-type in Meilisearch is called `my_restaurant` instead of the default `restaurant`.
+**Example 1: Linking a Single Collection to a Single Index**
+
+In the following examples, the `restaurant` content-type in Meilisearch is called `my_restaurant` instead of the default `restaurant`.
 
 ```js
 // config/plugins.js
@@ -236,6 +238,21 @@ module.exports = () => ({
 })
 ```
 
+```js
+// config/plugins.js
+
+module.exports = () => ({
+  //...
+  meilisearch: {
+    config: {
+      restaurant: {
+        indexName: ["my_restaurants"],
+      }
+    }
+  }
+})
+```
+
 It is possible to bind multiple content-types to the same index. They all have to share the same `indexName`.
 
 For example if `shoes` and `shirts` should be bound to the same index, they must have the same `indexName` in the plugin configuration:
@@ -248,10 +265,10 @@ module.exports = () => ({
   meilisearch: {
     config: {
       shirts: {
-        indexName: 'products',
+        indexName: ['products'],
       },
       shoes: {
-        indexName: 'products',
+        indexName: ['products'],
       },
     },
   },
@@ -260,6 +277,25 @@ module.exports = () => ({
 
 Now, on each entry addition from both `shoes` and `shirts` the entry is added in the `product` index of Meilisearch.
 
+**Example 2: Linking a Single Collection to Multiple Indexes**
+
+Suppose you want the `restaurant` content-type to be indexed under both `my_restaurants` and `all_food_places` indexes in Meilisearch. You can achieve this by setting the `indexName` property to an array containing both index names, as shown in the configuration below:
+
+```js
+// config/plugins.js
+
+module.exports = () => ({
+  //...
+  meilisearch: {
+    config: {
+      restaurant: {
+        indexName: ['my_restaurants', 'all_food_places'],
+      }
+    }
+  }
+})
+```
+
 
 **disclaimer**
 

playground/config/plugins.js

@@ -15,16 +15,16 @@ module.exports = ({ env }) => ({
             categories: entry.categories.map(category => category.name)
           };
         },
-        indexName: "my_restaurant",
+        indexName: ["my_restaurant"],
         settings:  {
           "searchableAttributes": ["*"]
         }
       },
       "about-us": {
-        indexName: "content",
+        indexName: ["content"],
       },
       homepage: {
-        indexName: "content",
+        indexName: ["content"],
       },
       // host: "http://localhost:7700",
       // apiKey: "masterKey"

resources/custom-index-name/custom-index-name.js

@@ -1,13 +1,14 @@
 // `shirts` and `pants` will be indexed in the same `products` index.
+// `tops` will also be indexed in a separate `tops` index.
 module.exports = () => ({
   //...
   meilisearch: {
     config: {
       shirts: {
-        indexName: 'products',
+        indexName: ['products', 'tops'],
       },
       pants: {
-        indexName: 'products',
+        indexName: ['products'],
       },
     },
   },

server/__mocks__/strapi.js

@@ -39,6 +39,10 @@ function createStrapiMock({
         ApiKeyIsFromConfigFile: true,
         HostIsFromConfigFile: true,
       }),
+      getIndexedContentTypes: () => [
+        'api::restaurant.restaurant',
+        'api::about.about',
+      ],
       actionInBatches: mockActionInBatches,
       addIndexedContentType: mockAddIndexedContentType,
       subscribeContentType: () => {

server/__tests__/configuration-validation.test.js

@@ -122,14 +122,50 @@ describe('Test plugin configuration', () => {
     expect(strapiMock.log.warn).toHaveBeenCalledTimes(0)
     expect(strapiMock.log.error).toHaveBeenCalledTimes(1)
     expect(strapiMock.log.error).toHaveBeenCalledWith(
-      'The "indexName" option of "restaurant" should be a non-empty string',
+      'The "indexName" option of "restaurant" should be a non-empty string or an array of non-empty strings',
     )
   })
 
   test('Test indexName with non-empty string', async () => {
     validatePluginConfig({
       restaurant: {
-        indexName: 'hello',
+        indexName: 'validName',
+      },
+    })
+    expect(strapiMock.log.warn).toHaveBeenCalledTimes(0)
+    expect(strapiMock.log.error).toHaveBeenCalledTimes(0)
+  })
+
+  test('Test indexName with empty array', async () => {
+    validatePluginConfig({
+      restaurant: {
+        indexName: [],
+      },
+    })
+    expect(strapiMock.log.warn).toHaveBeenCalledTimes(0)
+    expect(strapiMock.log.error).toHaveBeenCalledTimes(1)
+    expect(strapiMock.log.error).toHaveBeenCalledWith(
+      'The "indexName" option of "restaurant" should be a non-empty string or an array of non-empty strings',
+    )
+  })
+
+  test('Test indexName with non-empty array containing empty string', async () => {
+    validatePluginConfig({
+      restaurant: {
+        indexName: [''],
+      },
+    })
+    expect(strapiMock.log.warn).toHaveBeenCalledTimes(0)
+    expect(strapiMock.log.error).toHaveBeenCalledTimes(1)
+    expect(strapiMock.log.error).toHaveBeenCalledWith(
+      'The "indexName" option of "restaurant" should be a non-empty string or an array of non-empty strings',
+    )
+  })
+
+  test('Test indexName with non-empty array of strings', async () => {
+    validatePluginConfig({
+      restaurant: {
+        indexName: ['validName1', 'validName2'],
       },
     })
     expect(strapiMock.log.warn).toHaveBeenCalledTimes(0)