Change populate to populateEntryRule

Author: bidoubiwa

README.md

@@ -350,11 +350,11 @@ module.exports = {
 
 [See resources](./resources/meilisearch-settings) for more settings examples.
 
-#### 👥 Populate
+#### 👥 Populate entry rule
 
 Content-types in Strapi may have relationships with other content-types. To ensure that these links are fetched and added to an entry correctly from your Strapi database, the correct populate rule must be provided ([see documentation](https://docs-next.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/entity-service/populate.html#basic-populating)).
 
-To communicate the populate rule, use the `populate` setting on the according content-type in the plugin's settings.
+To communicate the populate rule, use the `populateEntryRule` setting on the according content-type in the plugin's settings.
 
 **For example**
 
@@ -367,7 +367,7 @@ module.exports = {
   meilisearch: {
     config: {
       restaurant: {
-        populate: ['repeatableComponent.categories', 'categories'],
+        populateEntryRule: ['repeatableComponent.categories', 'categories'],
       }
     }
   },

server/__tests__/configuration-validation.test.js

@@ -212,46 +212,46 @@ describe('Test plugin configuration', () => {
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(0)
   })
 
-  test('Test populate with wrong type', async () => {
+  test('Test populateEntryRule with wrong type', async () => {
     validateConfiguration({
       restaurant: {
-        populate: 0,
+        populateEntryRule: 0,
       },
     })
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(1)
     expect(fakeStrapi.log.error).toHaveBeenCalledWith(
-      'the "populate" param of "restaurant" should be an object/array/string'
+      'the "populateEntryRule" param of "restaurant" should be an object/array/string'
     )
   })
 
-  test('Test populate with function', async () => {
+  test('Test populateEntryRule with function', async () => {
     validateConfiguration({
       restaurant: {
-        populate: () => {},
+        populateEntryRule: () => {},
       },
     })
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(1)
     expect(fakeStrapi.log.error).toHaveBeenCalledWith(
-      'the "populate" param of "restaurant" should be an object/array/string'
+      'the "populateEntryRule" param of "restaurant" should be an object/array/string'
     )
   })
 
-  test('Test populate with empty object', async () => {
+  test('Test populateEntryRule with empty object', async () => {
     validateConfiguration({
       restaurant: {
-        populate: {},
+        populateEntryRule: {},
       },
     })
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)
     expect(fakeStrapi.log.error).toHaveBeenCalledTimes(0)
   })
 
-  test('Test populate with undefined', async () => {
+  test('Test populateEntryRule with undefined', async () => {
     validateConfiguration({
       restaurant: {
-        populate: undefined,
+        populateEntryRule: undefined,
       },
     })
     expect(fakeStrapi.log.warn).toHaveBeenCalledTimes(0)

server/configuration-validation.js

@@ -47,7 +47,7 @@ function validateCollectionConfiguration({ configuration, collection }) {
     'transformEntry',
     'settings',
     'filterEntry',
-    'populate',
+    'populateEntryRule',
   ]
 
   if (configuration === undefined) {
@@ -100,15 +100,15 @@ function validateCollectionConfiguration({ configuration, collection }) {
   }
 
   if (
-    configuration.populate !== undefined &&
-    !isObject(configuration.populate) &&
-    !Array.isArray(configuration.populate) &&
-    typeof configuration.populate !== 'string'
+    configuration.populateEntryRule !== undefined &&
+    !isObject(configuration.populateEntryRule) &&
+    !Array.isArray(configuration.populateEntryRule) &&
+    typeof configuration.populateEntryRule !== 'string'
   ) {
     strapi.log.error(
-      `the "populate" param of "${collection}" should be an object/array/string`
+      `the "populateEntryRule" param of "${collection}" should be an object/array/string`
     )
-    delete configuration.populate
+    delete configuration.populateEntryRule
   }
 
   Object.keys(configuration).forEach(attribute => {

server/services/lifecycle/lifecycle.js

@@ -28,7 +28,7 @@ module.exports = ({ strapi }) => {
           const entry = await contentTypeService.getEntry({
             contentType: contentTypeUid,
             id: result.id,
-            populate: meilisearch.populateRule({ contentType }),
+            populate: meilisearch.populateEntryRule({ contentType }),
           })
 
           meilisearch
@@ -58,7 +58,7 @@ module.exports = ({ strapi }) => {
           const entry = await contentTypeService.getEntry({
             contentType: contentTypeUid,
             id: result.id,
-            populate: meilisearch.populateRule({ contentType }),
+            populate: meilisearch.populateEntryRule({ contentType }),
           })
 
           meilisearch

server/services/meilisearch/config.js

@@ -36,14 +36,14 @@ module.exports = ({ strapi }) => {
     },
 
     /**
-     * Get the populate rules to apply when fetching entries in the Strapi database.
+     * Get the populate rule of a content-type that is applied when fetching entries in the Strapi database.
      *
      * @param {object} options
      * @param {string} options.contentType - ContentType name.
      *
      * @return {String} - Populate rule.
      */
-    populateRule: function ({ contentType }) {
+    populateEntryRule: function ({ contentType }) {
       const collection = contentTypeService.getCollectionName({ contentType })
       const contentTypeConfig = meilisearchConfig[collection] || {}
 

server/services/meilisearch/connector.js

@@ -286,7 +286,7 @@ module.exports = ({ strapi, adapter, config }) => {
       const tasksUids = await contentTypeService.actionInBatches({
         contentType,
         callback: addDocuments,
-        populate: config.populateRule({ contentType }),
+        populate: config.populateEntryRule({ contentType }),
       })
 
       await store.addIndexedContentType({ contentType })
@@ -345,7 +345,7 @@ module.exports = ({ strapi, adapter, config }) => {
         await contentTypeService.actionInBatches({
           contentType,
           callback: deleteEntries,
-          populate: config.populateRule({ contentType }),
+          populate: config.populateEntryRule({ contentType }),
         })
       } else {
         const { apiKey, host } = await store.getCredentials()