strapi-plugin-meilisearch 0.8.2 → 0.9.2

package/README.md

@@ -7,7 +7,7 @@
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
-  <a href="https://slack.meilisearch.com">Slack</a> |
+  <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
   <a href="https://docs.meilisearch.com/faq">FAQ</a>
@@ -530,7 +530,7 @@ If you are using [Strapi v3](https://github.com/strapi/strapi/tree/v3.6.9), plea
 
 **Supported Meilisearch versions**:
 
-This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
+This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/strapi-plugin-meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
 
 **Node / NPM versions**:
 

package/admin/src/Hooks/useCollection.js

@@ -73,7 +73,7 @@ export function useCollection() {
       refetchCollection()
       handleNotification({
         type: 'success',
-        message: 'Request to delete content-type is succesfull',
+        message: 'Request to delete content-type is successful',
         blockTransition: false,
       })
     }
@@ -96,7 +96,7 @@ export function useCollection() {
       refetchCollection()
       handleNotification({
         type: 'success',
-        message: 'Request to add a content-type is succesfull',
+        message: 'Request to add a content-type is successful',
         blockTransition: false,
       })
     }
@@ -119,7 +119,7 @@ export function useCollection() {
       refetchCollection()
       handleNotification({
         type: 'success',
-        message: 'Request to update content-type is succesfull',
+        message: 'Request to update content-type is successful',
         blockTransition: false,
       })
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-meilisearch",
-  "version": "0.8.2",
+  "version": "0.9.2",
   "description": "Synchronise and search in your Strapi content-types with Meilisearch",
   "scripts": {
     "playground:dev": "yarn --cwd ./playground && yarn --cwd ./playground dev",
@@ -25,7 +25,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@strapi/utils": "^4.5.2",
+    "@strapi/utils": "^4.5.4",
     "meilisearch": "^0.30.0"
   },
   "peerDependencies": {},

package/server/__tests__/meilisearch.test.js

@@ -109,4 +109,63 @@ describe('Tests content types', () => {
       },
     })
   })
+
+  test('sanitizes the private fields from the entries', async () => {
+    const pluginMock = jest.fn(() => ({
+      // This rewrites only the needed methods to reach the system under test (removeSensitiveFields)
+      service: jest.fn().mockImplementation(() => {
+        return {
+          async actionInBatches({ contentType = 'restaurant', callback }) {
+            await callback({
+              entries: [
+                { id: 1, title: 'title', secret: '123' },
+                { id: 2, title: 'abc', secret: '234' },
+              ],
+              contentType,
+            })
+          },
+          getCollectionName: ({ contentType }) => contentType,
+          addIndexedContentType: jest.fn(),
+          subscribeContentType: jest.fn(),
+          getCredentials: () => ({}),
+        }
+      }),
+    }))
+
+    const service = createMeilisearchService({
+      strapi: {
+        plugin: pluginMock,
+        contentTypes: {
+          restaurant: {
+            attributes: {
+              id: { private: false },
+              title: { private: false },
+              secret: { private: true },
+            },
+          },
+        },
+        config: { get: jest.fn(() => ({ restaurant: jest.fn() })) },
+      },
+    })
+
+    await service.addContentTypeInMeiliSearch({ contentType: 'restaurant' })
+
+    expect(Meilisearch().index).toHaveBeenCalledWith('restaurant')
+    expect(Meilisearch().index().addDocuments).toHaveBeenNthCalledWith(
+      1,
+      [
+        {
+          _meilisearch_id: 'restaurant-1',
+          id: 1,
+          title: 'title',
+        },
+        {
+          _meilisearch_id: 'restaurant-2',
+          id: 2,
+          title: 'abc',
+        },
+      ],
+      { primaryKey: '_meilisearch_id' }
+    )
+  })
 })

package/server/services/meilisearch/adapter.js

@@ -37,7 +37,7 @@ module.exports = ({ strapi }) => {
     addCollectionNamePrefix: function ({ contentType, entries }) {
       return entries.map(entry => ({
         ...entry,
-        id: this.addCollectionNamePrefixToId({
+        _meilisearch_id: this.addCollectionNamePrefixToId({
           entryId: entry.id,
           contentType,
         }),

package/server/services/meilisearch/client.js

@@ -12,5 +12,5 @@ const packageJson = require('../../../package.json')
 module.exports = config =>
   new Meilisearch({
     ...config,
-    clientAgents: [`Meilisearch Strapi ${packageJson.version}`],
+    clientAgents: [`Meilisearch Strapi (v${packageJson.version})`],
   })

package/server/services/meilisearch/config.js

@@ -188,10 +188,16 @@ module.exports = ({ strapi }) => {
      *
      * @return {Array<Object>} - Entries
      */
-    removeSensitiveFields: function ({ entries }) {
+    removeSensitiveFields: function ({ contentType, entries }) {
+      // TODO: should be persisted somewhere to make it more performant
+      const attrs = strapi.contentTypes[contentType].attributes
+      const privateFields = Object.entries(attrs).map(([field, schema]) =>
+        schema.private ? field : false
+      )
+
       return entries.map(entry => {
-        delete entry.createdBy
-        delete entry.updatedBy
+        privateFields.forEach(attr => delete entry[attr])
+
         return entry
       })
     },

package/server/services/meilisearch/connector.js

@@ -37,8 +37,11 @@ const sanitizeEntries = async function ({
     entries,
   })
 
-  // Remove nested
-  entries = await config.removeSensitiveFields({ entries })
+  // Remove sensitive fields (private = true)
+  entries = await config.removeSensitiveFields({
+    contentType,
+    entries,
+  })
 
   // Apply transformEntry plugin config.
   entries = await config.transformEntries({
@@ -130,7 +133,9 @@ module.exports = ({ strapi, adapter, config }) => {
             })
           )
         } else {
-          return client.index(indexUid).updateDocuments(sanitized)
+          return client
+            .index(indexUid)
+            .updateDocuments(sanitized, { primaryKey: '_meilisearch_id' })
         }
       })
     },
@@ -251,7 +256,9 @@ module.exports = ({ strapi, adapter, config }) => {
         adapter,
       })
 
-      const task = await client.index(indexUid).addDocuments(documents)
+      const task = await client
+        .index(indexUid)
+        .addDocuments(documents, { primaryKey: '_meilisearch_id' })
       await store.addIndexedContentType({ contentType })
 
       return task
@@ -285,7 +292,9 @@ module.exports = ({ strapi, adapter, config }) => {
         })
 
         // Add documents in Meilisearch
-        const task = await client.index(indexUid).addDocuments(documents)
+        const task = await client
+          .index(indexUid)
+          .addDocuments(documents, { primaryKey: '_meilisearch_id' })
 
         return task.taskUid
       }
@@ -314,9 +323,9 @@ module.exports = ({ strapi, adapter, config }) => {
       const indexUid = config.getIndexNameOfContentType({ contentType })
 
       // Fetch contentTypes that has the same indexName as the provided contentType
-      const contentTypesWithSameIndex = await config.listContentTypesWithCustomIndexName(
-        { indexUid }
-      )
+      const contentTypesWithSameIndex = await config
+        .listContentTypesWithCustomIndexName({ indexName: indexUid })
+        .map(contentTypeName => `api::${contentTypeName}.${contentTypeName}`)
 
       // get all contentTypes (not indexes) indexed in Meilisearch.
       const indexedContentTypes = await store.getIndexedContentTypes()
@@ -343,7 +352,7 @@ module.exports = ({ strapi, adapter, config }) => {
         }
       )
       if (indexedContentTypesWithSameIndex.length > 1) {
-        const deleteEntries = async (entries, contentType) => {
+        const deleteEntries = async ({ entries, contentType }) => {
           await this.deleteEntriesFromMeiliSearch({
             contentType,
             entriesId: entries.map(entry => entry.id),