feat: add sortableAttributes for createdAt/updatedAt in MeiliSearch indexes

Author: mac-eochaidh

api/db/indexSync.js

@@ -81,6 +81,44 @@ async function deleteDocumentsWithoutUserField(index, indexName) {
   return deletedCount;
 }
 
+/**
+ * Checks and configures a MeiliSearch index with required filterable and sortable attributes
+ * @param {import('meilisearch').Index} index - MeiliSearch index instance
+ * @param {string} indexName - Name of the index for logging
+ * @returns {Promise<boolean>} - Whether settings were updated
+ */
+async function checkAndConfigureIndex(index, indexName) {
+  try {
+    const settings = await index.getSettings();
+    const requiredFilterable = ['user'];
+    const requiredSortable = ['createdAt', 'updatedAt'];
+
+    const hasAllFilterable = requiredFilterable.every((attr) =>
+      settings.filterableAttributes?.includes(attr),
+    );
+    const hasAllSortable = requiredSortable.every((attr) =>
+      settings.sortableAttributes?.includes(attr),
+    );
+
+    if (!hasAllFilterable || !hasAllSortable) {
+      logger.info(`[indexSync] Configuring ${indexName} index for filtering and sorting...`);
+      await index.updateSettings({
+        filterableAttributes: requiredFilterable,
+        sortableAttributes: requiredSortable,
+      });
+      logger.info(
+        `[indexSync] ${indexName} index configured for user filtering and timestamps sortable`,
+      );
+      return true;
+    }
+  } catch (error) {
+    if (error.code !== 'index_not_found') {
+      logger.warn(`[indexSync] Could not check/update ${indexName} index settings:`, error.message);
+    }
+  }
+  return false;
+}
+
 /**
  * Ensures indexes have proper filterable attributes configured and checks if documents have user field
  * @param {MeiliSearch} client - MeiliSearch client instance
@@ -92,67 +130,41 @@ async function ensureFilterableAttributes(client) {
 
   try {
     // Check and update messages index
-    try {
-      const messagesIndex = client.index('messages');
-      const settings = await messagesIndex.getSettings();
-
-      if (!settings.filterableAttributes || !settings.filterableAttributes.includes('user')) {
-        logger.info('[indexSync] Configuring messages index to filter by user...');
-        await messagesIndex.updateSettings({
-          filterableAttributes: ['user'],
-        });
-        logger.info('[indexSync] Messages index configured for user filtering');
-        settingsUpdated = true;
-      }
+    const messagesIndex = client.index('messages');
+    if (await checkAndConfigureIndex(messagesIndex, 'messages')) {
+      settingsUpdated = true;
+    }
 
-      // Check if existing documents have user field indexed
-      try {
-        const searchResult = await messagesIndex.search('', { limit: 1 });
-        if (searchResult.hits.length > 0 && !searchResult.hits[0].user) {
-          logger.info(
-            '[indexSync] Existing messages missing user field, will clean up orphaned documents...',
-          );
-          hasOrphanedDocs = true;
-        }
-      } catch (searchError) {
-        logger.debug('[indexSync] Could not check message documents:', searchError.message);
-      }
-    } catch (error) {
-      if (error.code !== 'index_not_found') {
-        logger.warn('[indexSync] Could not check/update messages index settings:', error.message);
+    // Check if existing documents have user field indexed
+    try {
+      const searchResult = await messagesIndex.search('', { limit: 1 });
+      if (searchResult.hits.length > 0 && !searchResult.hits[0].user) {
+        logger.info(
+          '[indexSync] Existing messages missing user field, will clean up orphaned documents...',
+        );
+        hasOrphanedDocs = true;
       }
+    } catch (searchError) {
+      logger.debug('[indexSync] Could not check message documents:', searchError.message);
     }
 
     // Check and update conversations index
-    try {
-      const convosIndex = client.index('convos');
-      const settings = await convosIndex.getSettings();
-
-      if (!settings.filterableAttributes || !settings.filterableAttributes.includes('user')) {
-        logger.info('[indexSync] Configuring convos index to filter by user...');
-        await convosIndex.updateSettings({
-          filterableAttributes: ['user'],
-        });
-        logger.info('[indexSync] Convos index configured for user filtering');
-        settingsUpdated = true;
-      }
+    const convosIndex = client.index('convos');
+    if (await checkAndConfigureIndex(convosIndex, 'convos')) {
+      settingsUpdated = true;
+    }
 
-      // Check if existing documents have user field indexed
-      try {
-        const searchResult = await convosIndex.search('', { limit: 1 });
-        if (searchResult.hits.length > 0 && !searchResult.hits[0].user) {
-          logger.info(
-            '[indexSync] Existing conversations missing user field, will clean up orphaned documents...',
-          );
-          hasOrphanedDocs = true;
-        }
-      } catch (searchError) {
-        logger.debug('[indexSync] Could not check conversation documents:', searchError.message);
-      }
-    } catch (error) {
-      if (error.code !== 'index_not_found') {
-        logger.warn('[indexSync] Could not check/update convos index settings:', error.message);
+    // Check if existing documents have user field indexed
+    try {
+      const searchResult = await convosIndex.search('', { limit: 1 });
+      if (searchResult.hits.length > 0 && !searchResult.hits[0].user) {
+        logger.info(
+          '[indexSync] Existing conversations missing user field, will clean up orphaned documents...',
+        );
+        hasOrphanedDocs = true;
       }
+    } catch (searchError) {
+      logger.debug('[indexSync] Could not check conversation documents:', searchError.message);
     }
 
     // If either index has orphaned documents, clean them up (but don't force resync)