firestore-meilisearch 0.1.4 → 0.1.6

package/README.md

@@ -40,7 +40,7 @@ Note that this extension only listens for changes to _documents_ in a specific c
 Before installing this extension, you'll need to:
 
 - [Set up Cloud Firestore in your Firebase project](https://firebase.google.com/docs/firestore/quickstart)
-- Run a Meilisearch instance. There are many easy ways [to download and run a Meilisearch instance](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch)
+- Run a Meilisearch instance. [Learn more about Meilisearch cloud](https://www.meilisearch.com/pricing). Alternatively there are many other easy ways [to download and run a Meilisearch instance](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch)
 
 #### Data import format
 
@@ -119,7 +119,7 @@ firebase ext:install meilisearch/firestore-meilisearch --project=[your-project-i
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.27.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.27.0).
+This package only guarantees the compatibility with the [version v0.28.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.28.0).
 
 ## ⚙️ Development Workflow and Contributing
 

package/__tests__/functions.test.ts

@@ -1,10 +1,15 @@
 import * as firebaseFunctionsTestInit from 'firebase-functions-test'
 import mockedEnv from 'mocked-env'
 import { mocked } from 'ts-jest/utils'
-import { mockConsoleLog, mockConsoleInfo } from './__mocks__/console'
+import {
+  mockConsoleLog,
+  mockConsoleInfo,
+  mockConsoleError,
+} from './__mocks__/console'
 import { MeiliSearch } from 'meilisearch'
 import defaultEnvironment from './data/environment'
 import defaultDocument from './data/document'
+import { version } from '../src/version'
 
 jest.mock('meilisearch')
 
@@ -18,11 +23,9 @@ describe('extension', () => {
   // Mocking of Meilisearch package
   const mockedMeilisearch = mocked(MeiliSearch, true)
   const mockedAddDocuments = jest.fn()
-  const mockedUpdateDocuments = jest.fn()
   const mockedDeleteDocument = jest.fn()
   const mockedIndex = jest.fn(() => ({
     addDocuments: mockedAddDocuments,
-    updateDocuments: mockedUpdateDocuments,
     deleteDocument: mockedDeleteDocument,
   }))
   mockedMeilisearch.mockReturnValue({
@@ -52,6 +55,7 @@ describe('extension', () => {
     expect(mockedMeilisearch).toHaveBeenCalledWith({
       apiKey: defaultEnvironment.MEILISEARCH_API_KEY,
       host: defaultEnvironment.MEILISEARCH_HOST,
+      clientAgents: [`Meilisearch Firebase (v${version})`],
     })
     expect(mockConsoleLog).toBeCalledWith(
       'Initializing extension with configuration',
@@ -105,8 +109,7 @@ describe('extension', () => {
       expect(mockConsoleInfo).toBeCalledWith(
         `Creating new document ${
           afterSnapshot.id as string
-        } in Meilisearch index ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`,
-        { _firestore_id: defaultDocument.id, ...afterSnapshot.data() }
+        } in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
       )
       expect(mockedAddDocuments).toHaveBeenCalledWith(
         [
@@ -148,8 +151,7 @@ describe('extension', () => {
       expect(mockConsoleInfo).toBeCalledWith(
         `Creating new document ${
           afterSnapshot.id as string
-        } in Meilisearch index ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`,
-        { _firestore_id: defaultDocument.id, ...afterSnapshot.data() }
+        } in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
       )
       expect(mockedAddDocuments).toHaveBeenCalledWith(
         [
@@ -163,6 +165,37 @@ describe('extension', () => {
       )
     })
 
+    test('function run on creating document with unauthorized chars in document id', async () => {
+      const badId = '@@ !#'
+      const beforeSnapshot = firebaseMock.firestore.makeDocumentSnapshot(
+        {},
+        `collection/{}`
+      )
+      const afterSnapshot = firebaseMock.firestore.makeDocumentSnapshot(
+        { id: badId },
+        `collection/${badId}`
+      )
+      const documentChange = firebaseMock.makeChange(
+        beforeSnapshot,
+        afterSnapshot
+      )
+
+      await mockExport(documentChange, {
+        resource: {
+          name: 'test',
+        },
+      })
+
+      expect(mockConsoleInfo).toBeCalledWith(
+        `Creating new document ${
+          afterSnapshot.id as string
+        } in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
+      )
+      expect(mockConsoleError).toBeCalledWith(
+        `Could not create document with id: ${badId}. The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`
+      )
+    })
+
     test('function runs with updated data', async () => {
       const beforeSnapshot = firebaseMock.firestore.makeDocumentSnapshot(
         { foo: 'bar' },
@@ -189,13 +222,12 @@ describe('extension', () => {
         config
       )
       expect(mockConsoleInfo).toBeCalledWith(
-        `Updating document ${afterSnapshot.id as string} in Meilisearch index ${
-          defaultEnvironment.MEILISEARCH_INDEX_NAME
-        }`,
-        { _firestore_id: defaultDocument.id, ...afterSnapshot.data() }
+        `Updating document ${
+          afterSnapshot.id as string
+        } in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
       )
       expect(mockConsoleLog).toBeCalledWith('Completed execution of extension')
-      expect(mockedUpdateDocuments).toHaveBeenCalledWith([
+      expect(mockedAddDocuments).toHaveBeenCalledWith([
         {
           _firestore_id: defaultDocument.id,
           ...defaultDocument.document,
@@ -229,17 +261,12 @@ describe('extension', () => {
         config
       )
       expect(mockConsoleInfo).toBeCalledWith(
-        `Updating document ${afterSnapshot.id as string} in Meilisearch index ${
-          defaultEnvironment.MEILISEARCH_INDEX_NAME
-        }`,
-        {
-          _firestore_id: defaultDocument.id,
-          id: '12345',
-          ...afterSnapshot.data(),
-        }
+        `Updating document ${
+          afterSnapshot.id as string
+        } in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
       )
       expect(mockConsoleLog).toBeCalledWith('Completed execution of extension')
-      expect(mockedUpdateDocuments).toHaveBeenCalledWith([
+      expect(mockedAddDocuments).toHaveBeenCalledWith([
         {
           _firestore_id: defaultDocument.id,
           id: '12345',
@@ -271,7 +298,7 @@ describe('extension', () => {
         config
       )
       expect(mockConsoleInfo).toBeCalledWith(
-        `Deleting document ${defaultDocument.id} in Meilisearch index ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
+        `Deleting document ${defaultDocument.id} in Meilisearch index: ${defaultEnvironment.MEILISEARCH_INDEX_NAME}`
       )
       expect(mockConsoleLog).toBeCalledWith('Completed execution of extension')
       expect(mockedDeleteDocument).toHaveBeenCalledWith(defaultDocument.id)

package/lib/index.js

@@ -17,11 +17,13 @@ exports.indexingWorker = void 0;
  * limitations under the License.
  */
 const functions = require("firebase-functions");
+const firebase_functions_1 = require("firebase-functions");
 const create_index_1 = require("./meilisearch/create-index");
 const util_1 = require("./util");
 const logs = require("./logs");
 const adapter_1 = require("./adapter");
 const config_1 = require("./config");
+const validate_1 = require("./validate");
 const index = (0, create_index_1.initMeilisearchIndex)(config_1.config.meilisearch);
 logs.init();
 /**
@@ -52,9 +54,14 @@ exports.indexingWorker = functions.handler.firestore.document.onWrite(async (cha
  */
 async function handleAddDocument(documentId, snapshot) {
     try {
-        const document = (0, adapter_1.adaptDocument)(documentId, snapshot);
-        await index.addDocuments([document], { primaryKey: '_firestore_id' });
-        logs.addDocument(documentId, document);
+        logs.addDocument(documentId);
+        if ((0, validate_1.validateDocumentId)(documentId)) {
+            const document = (0, adapter_1.adaptDocument)(documentId, snapshot);
+            await index.addDocuments([document], { primaryKey: '_firestore_id' });
+        }
+        else {
+            firebase_functions_1.logger.error(`Could not create document with id: ${documentId}. The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`);
+        }
     }
     catch (e) {
         logs.error(e);
@@ -66,8 +73,13 @@ async function handleAddDocument(documentId, snapshot) {
  */
 async function handleDeleteDocument(documentId) {
     try {
-        await index.deleteDocument(documentId);
         logs.deleteDocument(documentId);
+        if ((0, validate_1.validateDocumentId)(documentId)) {
+            await index.deleteDocument(documentId);
+        }
+        else {
+            firebase_functions_1.logger.error(`Could not delete document with id: ${documentId}. The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`);
+        }
     }
     catch (e) {
         logs.error(e);
@@ -80,9 +92,14 @@ async function handleDeleteDocument(documentId) {
  */
 async function handleUpdateDocument(documentId, after) {
     try {
-        const document = (0, adapter_1.adaptDocument)(documentId, after);
-        await index.updateDocuments([document]);
-        logs.updateDocument(documentId, document);
+        logs.updateDocument(documentId);
+        if ((0, validate_1.validateDocumentId)(documentId)) {
+            const document = (0, adapter_1.adaptDocument)(documentId, after);
+            await index.addDocuments([document]);
+        }
+        else {
+            firebase_functions_1.logger.error(`Could not update document with id: ${documentId}.The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`);
+        }
     }
     catch (e) {
         logs.error(e);

package/lib/logs.js

@@ -50,19 +50,17 @@ exports.complete = complete;
 /**
  * Log an addition of a document.
  * @param {string} id Document id added.
- * @param {object} data Data contained in the document.
  */
-function addDocument(id, data) {
-    firebase_functions_1.logger.info(`Creating new document ${id} in Meilisearch index ${config_1.config.meilisearch.indexUid}`, data);
+function addDocument(id) {
+    firebase_functions_1.logger.info(`Creating new document ${id} in Meilisearch index: ${config_1.config.meilisearch.indexUid}`);
 }
 exports.addDocument = addDocument;
 /**
  * Log an update of a document.
  * @param {string} id Document id updated.
- * @param {object} data Data contained in the document.
  */
-function updateDocument(id, data) {
-    firebase_functions_1.logger.info(`Updating document ${id} in Meilisearch index ${config_1.config.meilisearch.indexUid}`, data);
+function updateDocument(id) {
+    firebase_functions_1.logger.info(`Updating document ${id} in Meilisearch index: ${config_1.config.meilisearch.indexUid}`);
 }
 exports.updateDocument = updateDocument;
 /**
@@ -70,7 +68,7 @@ exports.updateDocument = updateDocument;
  * @param {string} id Document id deleted.
  */
 function deleteDocument(id) {
-    firebase_functions_1.logger.info(`Deleting document ${id} in Meilisearch index ${config_1.config.meilisearch.indexUid}`);
+    firebase_functions_1.logger.info(`Deleting document ${id} in Meilisearch index: ${config_1.config.meilisearch.indexUid}`);
 }
 exports.deleteDocument = deleteDocument;
 /**

package/lib/meilisearch/agents.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructClientAgents = void 0;
+const version_1 = require("../version");
+const constructClientAgents = (clientAgents = []) => {
+    const firebaseAgent = `Meilisearch Firebase (v${version_1.version})`;
+    return clientAgents.concat(firebaseAgent);
+};
+exports.constructClientAgents = constructClientAgents;

package/lib/meilisearch/create-index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initMeilisearchIndex = void 0;
 const meilisearch_1 = require("meilisearch");
+const agents_1 = require("./agents");
 /**
  * initMeilisearchIndex
  * @param {MeilisearchConfig} - Meilisearch configuration
@@ -11,6 +12,7 @@ function initMeilisearchIndex({ host, apiKey, indexUid, }) {
     const client = new meilisearch_1.MeiliSearch({
         host,
         apiKey,
+        clientAgents: (0, agents_1.constructClientAgents)(),
     });
     return client.index(indexUid);
 }

package/lib/validate.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDocumentId = void 0;
+/**
+ * Validate if the format of the document id is compliant with Meilisearch.
+ * Based on this documentation: https://docs.meilisearch.com/learn/core_concepts/primary_key.html#formatting-the-document-id
+ *
+ * @param  {string} documentId Document id.
+ *
+ * @return {boolean} - Wether the document id is properly formatted (true) or not.
+ */
+function validateDocumentId(documentId) {
+    const wrongChars = documentId.search(/([^a-zA-Z0-9-_]+)/);
+    return wrongChars === -1;
+}
+exports.validateDocumentId = validateDocumentId;

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.1.4';
+exports.version = '0.1.6';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-meilisearch",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
@@ -25,7 +25,7 @@
     "firebase-admin": "^9.8.0",
     "firebase-functions": "^3.16.0",
     "inquirer": "^8.2.2",
-    "meilisearch": "^0.25.1"
+    "meilisearch": "^0.27.0"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.15.0",

package/src/index.ts

@@ -16,13 +16,14 @@
  */
 
 import * as functions from 'firebase-functions'
-import { Change } from 'firebase-functions'
+import { Change, logger } from 'firebase-functions'
 import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
 import { initMeilisearchIndex } from './meilisearch/create-index'
 import { getChangeType, getChangedDocumentId, ChangeType } from './util'
 import * as logs from './logs'
 import { adaptDocument } from './adapter'
 import { config } from './config'
+import { validateDocumentId } from './validate'
 
 const index = initMeilisearchIndex(config.meilisearch)
 
@@ -63,9 +64,15 @@ async function handleAddDocument(
   snapshot: DocumentSnapshot
 ): Promise<void> {
   try {
-    const document = adaptDocument(documentId, snapshot)
-    await index.addDocuments([document], { primaryKey: '_firestore_id' })
-    logs.addDocument(documentId, document)
+    logs.addDocument(documentId)
+    if (validateDocumentId(documentId)) {
+      const document = adaptDocument(documentId, snapshot)
+      await index.addDocuments([document], { primaryKey: '_firestore_id' })
+    } else {
+      logger.error(
+        `Could not create document with id: ${documentId}. The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`
+      )
+    }
   } catch (e) {
     logs.error(e as Error)
   }
@@ -77,8 +84,14 @@ async function handleAddDocument(
  */
 async function handleDeleteDocument(documentId: string): Promise<void> {
   try {
-    await index.deleteDocument(documentId)
     logs.deleteDocument(documentId)
+    if (validateDocumentId(documentId)) {
+      await index.deleteDocument(documentId)
+    } else {
+      logger.error(
+        `Could not delete document with id: ${documentId}. The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`
+      )
+    }
   } catch (e) {
     logs.error(e as Error)
   }
@@ -94,9 +107,15 @@ async function handleUpdateDocument(
   after: DocumentSnapshot
 ): Promise<void> {
   try {
-    const document = adaptDocument(documentId, after)
-    await index.updateDocuments([document])
-    logs.updateDocument(documentId, document)
+    logs.updateDocument(documentId)
+    if (validateDocumentId(documentId)) {
+      const document = adaptDocument(documentId, after)
+      await index.addDocuments([document])
+    } else {
+      logger.error(
+        `Could not update document with id: ${documentId}.The document id can only contain case-insensitive alphanumeric characters (abcDEF), hyphens (-) or underscores(_).`
+      )
+    }
   } catch (e) {
     logs.error(e as Error)
   }

package/src/logs.ts

@@ -50,24 +50,20 @@ export function complete() {
 /**
  * Log an addition of a document.
  * @param {string} id Document id added.
- * @param {object} data Data contained in the document.
  */
-export function addDocument(id: string, data: Record<string, any>) {
+export function addDocument(id: string) {
   logger.info(
-    `Creating new document ${id} in Meilisearch index ${config.meilisearch.indexUid}`,
-    data
+    `Creating new document ${id} in Meilisearch index: ${config.meilisearch.indexUid}`
   )
 }
 
 /**
  * Log an update of a document.
  * @param {string} id Document id updated.
- * @param {object} data Data contained in the document.
  */
-export function updateDocument(id: string, data: Record<string, any>) {
+export function updateDocument(id: string) {
   logger.info(
-    `Updating document ${id} in Meilisearch index ${config.meilisearch.indexUid}`,
-    data
+    `Updating document ${id} in Meilisearch index: ${config.meilisearch.indexUid}`
   )
 }
 
@@ -77,7 +73,7 @@ export function updateDocument(id: string, data: Record<string, any>) {
  */
 export function deleteDocument(id: string) {
   logger.info(
-    `Deleting document ${id} in Meilisearch index ${config.meilisearch.indexUid}`
+    `Deleting document ${id} in Meilisearch index: ${config.meilisearch.indexUid}`
   )
 }
 

package/src/meilisearch/agents.ts

@@ -0,0 +1,9 @@
+import { version } from '../version'
+
+export const constructClientAgents = (
+  clientAgents: string[] = []
+): string[] => {
+  const firebaseAgent = `Meilisearch Firebase (v${version})`
+
+  return clientAgents.concat(firebaseAgent)
+}

package/src/meilisearch/create-index.ts

@@ -1,5 +1,6 @@
 import { MeiliSearch, Index } from 'meilisearch'
 import { MeilisearchConfig } from '../types'
+import { constructClientAgents } from './agents'
 
 /**
  * initMeilisearchIndex
@@ -14,6 +15,7 @@ export function initMeilisearchIndex({
   const client = new MeiliSearch({
     host,
     apiKey,
+    clientAgents: constructClientAgents(),
   })
 
   return client.index(indexUid)

package/src/validate.ts

@@ -0,0 +1,13 @@
+/**
+ * Validate if the format of the document id is compliant with Meilisearch.
+ * Based on this documentation: https://docs.meilisearch.com/learn/core_concepts/primary_key.html#formatting-the-document-id
+ *
+ * @param  {string} documentId Document id.
+ *
+ * @return {boolean} - Wether the document id is properly formatted (true) or not.
+ */
+export function validateDocumentId(documentId: string) {
+  const wrongChars = documentId.search(/([^a-zA-Z0-9-_]+)/)
+
+  return wrongChars === -1
+}

package/src/version.ts

@@ -1 +1 @@
-export const version = '0.1.4'
+export const version = '0.1.6'