feat(configuration-validation): allow indexName to be a string

to avoid breaking change

Author: L-Weisz

README.md

@@ -221,7 +221,22 @@ To link a single collection to multiple indexes, you can assign an array of inde
 
 **Example 1: Linking a Single Collection to a Single Index**
 
-In the following example, the `restaurant` content-type in Meilisearch is called `my_restaurant` instead of the default `restaurant`.
+In the following examples, the `restaurant` content-type in Meilisearch is called `my_restaurant` instead of the default `restaurant`.
+
+```js
+// config/plugins.js
+
+module.exports = () => ({
+  //...
+  meilisearch: {
+    config: {
+      restaurant: {
+        indexName: "my_restaurants",
+      }
+    }
+  }
+})
+```
 
 ```js
 // config/plugins.js

server/__tests__/configuration-validation.test.js

@@ -113,7 +113,7 @@ describe('Test plugin configuration', () => {
     expect(strapiMock.log.error).toHaveBeenCalledTimes(0)
   })
 
-  test('Test indexName with string', async () => {
+  test('Test indexName with empty string', async () => {
     validatePluginConfig({
       restaurant: {
         indexName: '',
@@ -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 array of strings',
+      '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', async () => {
+  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)

server/configuration-validation.js

@@ -182,10 +182,21 @@ function CollectionConfig({ collectionName, configuration }) {
 
   return {
     validateIndexName() {
-      // indexName is either undefined or a non empty array of string
-      if (indexName !== undefined && !Array.isArray(indexName)) {
+      // indexName is either undefined, a non-empty string, or a non-empty array of non-empty strings
+      const isStringAndNotEmpty =
+        typeof indexName === 'string' && indexName !== ''
+
+      const isArrayWithNonEmptyStrings =
+        Array.isArray(indexName) &&
+        indexName.length > 0 &&
+        indexName.every(name => typeof name === 'string' && name !== '')
+
+      if (
+        indexName !== undefined &&
+        !(isStringAndNotEmpty || isArrayWithNonEmptyStrings)
+      ) {
         log.error(
-          `The "indexName" option of "${collectionName}" should be a non-empty array of strings`,
+          `The "indexName" option of "${collectionName}" should be a non-empty string or an array of non-empty strings`,
         )
       } else if (indexName !== undefined) {
         options.indexName = indexName