firestore-meilisearch 0.1.0

package/functions/src/index.ts

@@ -0,0 +1,103 @@
+'use strict'
+/*
+ * Copyright 2022 Meilisearch
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as functions from 'firebase-functions'
+import { Change } 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'
+
+const index = initMeilisearchIndex(config.meilisearch)
+
+logs.init()
+
+/**
+ * IndexingWorker is responsible for aggregating a defined field from a Firestore collection into a Meilisearch index.
+ * It is controlled by a Firestore handler.
+ */
+export const indexingWorker = functions.handler.firestore.document.onWrite(
+  async (change: Change<DocumentSnapshot>): Promise<void> => {
+    logs.start()
+    const changeType = getChangeType(change)
+    const documentId = getChangedDocumentId(change)
+
+    switch (changeType) {
+      case ChangeType.CREATE:
+        await handleAddDocument(documentId, change.after)
+        break
+      case ChangeType.DELETE:
+        await handleDeleteDocument(documentId)
+        break
+      case ChangeType.UPDATE:
+        await handleUpdateDocument(documentId, change.after)
+        break
+    }
+    logs.complete()
+  }
+)
+
+/**
+ * Handle addition of a document in the Meilisearch index.
+ * @param {string} documentId Document id to add.
+ * @param {Change} snapshot Snapshot of the data contained in the document read from your Firestore database.
+ */
+async function handleAddDocument(
+  documentId: string,
+  snapshot: DocumentSnapshot
+): Promise<void> {
+  try {
+    const document = adaptDocument(documentId, snapshot)
+    await index.addDocuments([document], { primaryKey: '_firestore_id' })
+    logs.addDocument(documentId, document)
+  } catch (e) {
+    logs.error(e as Error)
+  }
+}
+
+/**
+ * Handle deletion of a document in the Meilisearch index.
+ * @param {string} documentId Document id to delete.
+ */
+async function handleDeleteDocument(documentId: string): Promise<void> {
+  try {
+    await index.deleteDocument(documentId)
+    logs.deleteDocument(documentId)
+  } catch (e) {
+    logs.error(e as Error)
+  }
+}
+
+/**
+ * Handle update of a document in the Meilisearch index.
+ * @param {string} documentId Document id to update.
+ * @param {Change} after Snapshot of the data contained in the document read from your Firestore database.
+ */
+async function handleUpdateDocument(
+  documentId: string,
+  after: DocumentSnapshot
+): Promise<void> {
+  try {
+    const document = adaptDocument(documentId, after)
+    await index.updateDocuments([document])
+    logs.updateDocument(documentId, document)
+  } catch (e) {
+    logs.error(e as Error)
+  }
+}

package/functions/src/logs.ts

@@ -0,0 +1,107 @@
+'use strict'
+/*
+ * Copyright 2022 Meilisearch
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { logger } from 'firebase-functions'
+import { config } from './config'
+
+/**
+ * Initialization logger.
+ */
+export function init() {
+  logger.log('Initializing extension with configuration', config)
+}
+
+/**
+ * Start logger.
+ */
+export function start() {
+  logger.log('Started execution of extension with configuration', config)
+}
+
+/**
+ * Error logger.
+ * @param {Error} err
+ */
+export function error(err: Error) {
+  logger.error('Unhandled error occurred during processing:', err)
+}
+
+/**
+ * Complete logger.
+ */
+export function complete() {
+  logger.log('Completed execution of extension')
+}
+
+/**
+ * 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>) {
+  logger.info(
+    `Creating new document ${id} in Meilisearch index ${config.meilisearch.indexUid}`,
+    data
+  )
+}
+
+/**
+ * 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>) {
+  logger.info(
+    `Updating document ${id} in Meilisearch index ${config.meilisearch.indexUid}`,
+    data
+  )
+}
+
+/**
+ * Log a deletion of a document.
+ * @param {string} id Document id deleted.
+ */
+export function deleteDocument(id: string) {
+  logger.info(
+    `Deleting document ${id} in Meilisearch index ${config.meilisearch.indexUid}`
+  )
+}
+
+/**
+ * Log a modification of geoPoint based on whether or not it has the correct naming to enable `geosearch` in Meilisearch.
+ * @param {boolean} hasGeoField a boolean value that indicates whether the field is correctly named to enable `geosearch` in Meilisearch.
+ */
+export function infoGeoPoint(hasGeoField: boolean) {
+  if (hasGeoField) {
+    logger.info(
+      `A GeoPoint was found with the field name '_geo' for compatibility with Meilisearch the field 'latitude' was renamed to 'lat' and the field 'longitude' to 'lng'`
+    )
+  } else {
+    logger.info(
+      `A GeoPoint was found without the field name '_geo' if you want to use the geoSearch with Meilisearch rename it to '_geo'`
+    )
+  }
+}
+
+/**
+ * Importation data logger.
+ * @param {number} total
+ * @param {number} batches
+ */
+export function importData(total: number, batches: number) {
+  logger.info(`Imported ${total} documents in ${batches} batches.`)
+}

package/functions/src/meilisearch/create-index.ts

@@ -0,0 +1,20 @@
+import { MeiliSearch, Index } from 'meilisearch'
+import { MeilisearchConfig } from '../types'
+
+/**
+ * initMeilisearchIndex
+ * @param {MeilisearchConfig} - Meilisearch configuration
+ * @return {Index}
+ */
+export function initMeilisearchIndex({
+  host,
+  apiKey,
+  indexUid,
+}: MeilisearchConfig): Index {
+  const client = new MeiliSearch({
+    host,
+    apiKey,
+  })
+
+  return client.index(indexUid)
+}

package/functions/src/types.ts

@@ -0,0 +1,8 @@
+export type { Index } from 'meilisearch'
+
+export type MeilisearchConfig = {
+  host: string
+  apiKey: string
+  indexUid: string
+  fieldsToIndex?: string
+}

package/functions/src/util.ts

@@ -0,0 +1,63 @@
+'use strict'
+/*
+ * Copyright 2022 Meilisearch
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
+import { Change } from 'firebase-functions'
+import { config } from './config'
+
+export enum ChangeType {
+  CREATE,
+  DELETE,
+  UPDATE,
+}
+
+/**
+ * Get type of the modification perform on a document.
+ * @param {Change<T>} change The Functions interface for events that change state.
+ * @return {ChangeType} Final type of the event.
+ */
+export function getChangeType(change: Change<DocumentSnapshot>): ChangeType {
+  if (!change.after.exists) {
+    return ChangeType.DELETE
+  }
+  if (!change.before.exists) {
+    return ChangeType.CREATE
+  }
+  return ChangeType.UPDATE
+}
+
+/**
+ * Get final id of a document after modification.
+ * @param {Change<T>} change The Functions interface for events that change state.
+ * @return {string} Final state type of the event.
+ */
+export function getChangedDocumentId(change: Change<DocumentSnapshot>): string {
+  if (change.after.exists) {
+    return change.after.id
+  }
+  return change.before.id
+}
+
+/**
+ * Returns the MEILISEARCH_FIELDS_TO_INDEX value from the config file and formats it.
+ * @return {string[]} An array of fields.
+ */
+export function getFieldsToIndex(): string[] {
+  return config.meilisearch.fieldsToIndex
+    ? config.meilisearch.fieldsToIndex.split(/[ ,]+/)
+    : []
+}

package/functions/src/version.ts

@@ -0,0 +1 @@
+export const version = '0.1.0'

package/functions/tsconfig.eslint.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./__tests__/**/*.ts",
+    "./**/*.js",
+    ".eslintrc.js",
+  ],
+  "exclude": []
+}

package/functions/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "module": "commonjs",
+    "noImplicitReturns": true,
+    "noImplicitAny": false,
+    "outDir": "lib",
+    "sourceMap": false,
+    "strict": true,
+    "target": "es2018",
+    "types": [
+      "jest",
+      "node",
+    ]
+  },
+  "compileOnSave": true,
+  "include": [
+    "src",
+  ],
+  "exclude": [
+    "node_modules",
+  ]
+}