Merge #329

329: Improve settings implementation feature r=bidoubiwa a=bidoubiwa

# Pull Request

## What does this PR do?
Fixes #327

## PR checklist
Please check if your PR fulfills the following requirements:
- [ ] #327



Co-authored-by: Haye de Wit <[email protected]>
Co-authored-by: Charlotte Vermandel <[email protected]>

Author: 3 people

README.md

@@ -287,7 +287,30 @@ Resulting in `categories` being transformed like this in a `restaurant` entry.
 
 By transforming the `categories` into an array of names, it is now compatible with the [`filtering` feature](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#configuring-filters) in MeiliSearch.
 
+#### 🏗 Add MeiliSearch Settings
 
+Each index in MeiliSearch can be customized with specific settings. It is possible to add your [MeiliSearch settings](https://docs.meilisearch.com/reference/features/settings.html#settings) configuration to the indexes you create using `settings` field in your model's config.
+
+The settings are added when either: adding a collection to MeiliSearch or when updating a collection in MeiliSearch. The settings are not updated when documents are added through the [`listeners`](-apply-hooks).
+
+**For example**
+```js
+module.exports = {
+  meilisearch: {
+    settings: {
+      filterableAttributes: ['genres'],
+      distinctAttribute: null,
+      searchableAttributes: ['title', 'description', 'genres'],
+      synonyms: {
+        wolverine: ['xmen', 'logan'],
+        logan: ['wolverine', 'xmen']
+      }
+    }
+  },
+}
+```
+
+[See resources](./resources/meilisearch-settings) for more settings examples.
 
 ### 🕵️‍♀️ Start Searching <!-- omit in toc -->
 

connectors/__tests__/custom-index-name.tests.js

@@ -6,8 +6,11 @@ const createCollectionConnector = require('../collection')
 jest.mock('meilisearch')
 
 const addDocumentsMock = jest.fn(() => 10)
+const updateSettingsMock = jest.fn(() => 10)
+
 const mockIndex = jest.fn(() => ({
   addDocuments: addDocumentsMock,
+  updateSettings: updateSettingsMock,
 }))
 
 MeiliSearch.mockImplementation(() => {
@@ -50,7 +53,6 @@ const loggerMock = {
 describe('Test custom index names', () => {
   let storeConnector
   beforeEach(async () => {
-    jest.resetAllMocks()
     jest.clearAllMocks()
     jest.restoreAllMocks()
     storeConnector = createStoreConnector({

connectors/__tests__/entry-transformer.tests.js

@@ -6,8 +6,11 @@ const createCollectionConnector = require('../collection')
 jest.mock('meilisearch')
 
 const addDocumentsMock = jest.fn(() => 10)
+const updateSettingsMock = jest.fn(() => 10)
+
 const mockIndex = jest.fn(() => ({
   addDocuments: addDocumentsMock,
+  updateSettings: updateSettingsMock,
 }))
 
 MeiliSearch.mockImplementation(() => {
@@ -76,7 +79,6 @@ describe('Entry transformation', () => {
   })
 
   afterEach(() => {
-    jest.resetAllMocks()
     jest.clearAllMocks()
     jest.restoreAllMocks()
   })

connectors/__tests__/settings.tests.js

@@ -0,0 +1,159 @@
+const { MeiliSearch } = require('meilisearch')
+const createMeiliSearchConnector = require('../meilisearch')
+const createStoreConnector = require('../store')
+const createCollectionConnector = require('../collection')
+
+jest.mock('meilisearch')
+
+const addDocumentsMock = jest.fn(() => 10)
+const updateSettingsMock = jest.fn(() => 10)
+
+const mockIndex = jest.fn(() => ({
+  addDocuments: addDocumentsMock,
+  updateSettings: updateSettingsMock,
+}))
+
+MeiliSearch.mockImplementation(() => {
+  return {
+    getOrCreateIndex: () => {
+      return mockIndex
+    },
+    index: mockIndex,
+  }
+})
+
+const storeClientMock = {
+  set: jest.fn(() => 'test'),
+  get: jest.fn(() => 'test'),
+}
+
+const servicesMock = {
+  restaurant: {
+    count: jest.fn(() => {
+      return 11
+    }),
+    find: jest.fn(() => {
+      return [{ id: '1', collection: [{ name: 'one' }, { name: 'two' }] }]
+    }),
+  },
+}
+
+const transformEntryMock = jest.fn(function ({ entry }) {
+  const transformedEntry = {
+    ...entry,
+    collection: entry.collection.map(cat => cat.name),
+  }
+  return transformedEntry
+})
+
+const loggerMock = {
+  warn: jest.fn(() => 'test'),
+}
+
+describe('Test MeiliSearch settings', () => {
+  let storeConnector
+  beforeEach(async () => {
+    jest.clearAllMocks()
+    jest.restoreAllMocks()
+    storeConnector = createStoreConnector({
+      storeClient: storeClientMock,
+    })
+  })
+
+  test('Test not settings field in configuration', async () => {
+    const modelMock = {
+      restaurant: {
+        meilisearch: {
+          indexName: 'my_restaurant',
+          transformEntry: transformEntryMock,
+        },
+      },
+    }
+    const collectionConnector = createCollectionConnector({
+      logger: loggerMock,
+      models: modelMock,
+      services: servicesMock,
+    })
+    const meilisearchConnector = await createMeiliSearchConnector({
+      collectionConnector,
+      storeConnector,
+    })
+    const getIndexNameSpy = jest.spyOn(collectionConnector, 'getIndexName')
+    const getSettingsSpy = jest.spyOn(collectionConnector, 'getSettings')
+
+    await meilisearchConnector.addCollectionInMeiliSearch('restaurant')
+
+    expect(servicesMock.restaurant.count).toHaveBeenCalledTimes(1)
+
+    expect(getIndexNameSpy).toHaveBeenCalledWith('restaurant')
+    expect(getIndexNameSpy).toHaveReturnedWith('my_restaurant')
+    expect(getSettingsSpy).toHaveBeenCalledWith('restaurant')
+    expect(getSettingsSpy).toHaveReturnedWith({})
+  })
+
+  test('Test a empty setting object in configuration', async () => {
+    const modelMock = {
+      restaurant: {
+        meilisearch: {
+          indexName: 'my_restaurant',
+          transformEntry: transformEntryMock,
+          settings: {},
+        },
+      },
+    }
+    const collectionConnector = createCollectionConnector({
+      logger: loggerMock,
+      models: modelMock,
+      services: servicesMock,
+    })
+    const meilisearchConnector = await createMeiliSearchConnector({
+      collectionConnector,
+      storeConnector,
+    })
+    const getIndexNameSpy = jest.spyOn(collectionConnector, 'getIndexName')
+    const getSettingsSpy = jest.spyOn(collectionConnector, 'getSettings')
+
+    await meilisearchConnector.addCollectionInMeiliSearch('restaurant')
+
+    expect(servicesMock.restaurant.count).toHaveBeenCalledTimes(1)
+
+    expect(getIndexNameSpy).toHaveBeenCalledWith('restaurant')
+    expect(getIndexNameSpy).toHaveReturnedWith('my_restaurant')
+    expect(getSettingsSpy).toHaveBeenCalledWith('restaurant')
+    expect(getSettingsSpy).toHaveReturnedWith({})
+  })
+
+  test('Test a setting object with one field in configuration', async () => {
+    const modelMock = {
+      restaurant: {
+        meilisearch: {
+          indexName: 'my_restaurant',
+          transformEntry: transformEntryMock,
+          settings: {
+            searchableAttributes: ['*'],
+          },
+        },
+      },
+    }
+    const collectionConnector = createCollectionConnector({
+      logger: loggerMock,
+      models: modelMock,
+      services: servicesMock,
+    })
+    const meilisearchConnector = await createMeiliSearchConnector({
+      collectionConnector,
+      storeConnector,
+    })
+    const getIndexNameSpy = jest.spyOn(collectionConnector, 'getIndexName')
+    const getSettingsSpy = jest.spyOn(collectionConnector, 'getSettings')
+
+    await meilisearchConnector.addCollectionInMeiliSearch('restaurant')
+
+    expect(servicesMock.restaurant.count).toHaveBeenCalledTimes(1)
+
+    expect(getIndexNameSpy).toHaveBeenCalledWith('restaurant')
+    expect(getIndexNameSpy).toHaveReturnedWith('my_restaurant')
+    expect(getSettingsSpy).toHaveBeenCalledWith('restaurant')
+    expect(getSettingsSpy).toHaveReturnedWith({ searchableAttributes: ['*'] })
+  })
+})

connectors/collection.js

@@ -152,5 +152,26 @@ module.exports = ({ services, models, logger }) => {
       }
       return entries
     },
+
+    /**
+     * Returns MeiliSearch index settings from model definition.
+     * @param collection - Name of the Collection.
+     * @typedef Settings
+     * @type {import('meilisearch').Settings}
+     * @return {Settings} - MeiliSearch index settings
+     */
+    getSettings: function (collection) {
+      const model = models[collection].meilisearch || {}
+      const settings = model.settings || {}
+
+      if (typeof settings !== 'object') {
+        logger.warn(
+          `[MEILISEARCH]: "settings" provided in the model of the ${collection} must be an object.`
+        )
+        return {}
+      }
+
+      return settings
+    },
   }
 }

connectors/meilisearch/index.js

@@ -264,6 +264,10 @@ module.exports = async ({ storeConnector, collectionConnector }) => {
       const client = MeiliSearch({ apiKey, host })
       const indexUid = collectionConnector.getIndexName(collection)
 
+      // Get MeiliSearch Index settings from model
+      const settings = collectionConnector.getSettings(collection)
+      await client.index(indexUid).updateSettings(settings)
+
       // Callback function for batching action
       const addDocuments = async (entries, collection) => {
         if (entries.length === 0) {

cypress/integration/ui_spec.js

@@ -58,6 +58,7 @@ describe('Strapi Login flow', () => {
   })
 
   it('Add credentials', () => {
+    cy.removeNotifications()
     cy.get('input[name="MSHost"]').clear().type(host)
     cy.get('input[name="MSApiKey"]').clear().type(apiKey)
     cy.get('.credentials_button').click()
@@ -98,6 +99,7 @@ describe('Strapi Login flow', () => {
     })
     cy.contains('Reload needed', { timeout: 10000 })
     cy.reloadServer()
+    cy.removeNotifications()
   })
 
   it('Check for successfull listened in develop mode', () => {
@@ -205,6 +207,7 @@ describe('Strapi Login flow', () => {
       cy.contains('Reload needed', { timeout: 10000 })
     }
     cy.reloadServer()
+    cy.removeNotifications()
   })
 
   it('Check that collections are not in MeiliSearch anymore', () => {

playground/api/restaurant/models/restaurant.js

@@ -13,6 +13,9 @@ module.exports = {
       };
       return transformed;
     },
-    indexName: "my_restaurant"
+    indexName: "my_restaurant",
+    settings:  {
+      "searchableAttributes": ["*"]
+    }
   }
 }

resources/entries-transformers/dates-transformer.js

@@ -13,7 +13,7 @@ function dateToTimeStamp(date) {
 
 module.exports = {
   meilisearch: {
-    transformEntry(entry) {
+    transformEntry({ entry }) {
       const transformedEntry = {
         ...entry,
         // transform date format to timestamp

resources/entries-transformers/filter-compatibility.js

@@ -7,7 +7,7 @@
 
 module.exports = {
   meilisearch: {
-    transformEntry(entry) {
+    transformEntry({ entry }) {
       const transformedEntry = {
         ...entry,
         categories: entry.categories.map(cat => cat.name), // map to only have categories name