🔖 feat: Conversation Bookmarks (#3344)

* feat: add tags property in Conversation model

* feat: add ConversationTag model

* feat: add the tags parameter to getConvosByPage

* feat: add API route to ConversationTag

* feat: add types of ConversationTag

* feat: add data access functions for conversation tags

* feat: add Bookmark table component

* feat: Add an action to bookmark

* feat: add Bookmark nav component

* fix: failed test

* refactor: made 'Saved' tag a constant

* feat: add new bookmark to current conversation

* chore: Add comment

* fix: delete tag from conversations when it's deleted

* fix: Update the query cache when the tag title is changed.

* chore: fix typo

* refactor: add description of rebuilding bookmarks

* chore: remove unused variables

* fix: position when adding a new bookmark

* refactor: add comment, rename a function

* refactor: add a unique constraint in ConversationTag

* chore: add localizations

api/models/Conversation.js

@@ -73,13 +73,16 @@ module.exports = {
       throw new Error('Failed to save conversations in bulk.');
     }
   },
-  getConvosByPage: async (user, pageNumber = 1, pageSize = 25, isArchived = false) => {
+  getConvosByPage: async (user, pageNumber = 1, pageSize = 25, isArchived = false, tags) => {
     const query = { user };
     if (isArchived) {
       query.isArchived = true;
     } else {
       query.$or = [{ isArchived: false }, { isArchived: { $exists: false } }];
     }
+    if (Array.isArray(tags) && tags.length > 0) {
+      query.tags = { $in: tags };
+    }
     try {
       const totalConvos = (await Conversation.countDocuments(query)) || 1;
       const totalPages = Math.ceil(totalConvos / pageSize);

api/models/ConversationTag.js

@@ -0,0 +1,268 @@
+//const crypto = require('crypto');
+
+const logger = require('~/config/winston');
+const Conversation = require('./schema/convoSchema');
+const ConversationTag = require('./schema/conversationTagSchema');
+
+const SAVED_TAG = 'Saved';
+
+const updateTagsForConversation = async (user, conversationId, tags) => {
+  try {
+    const conversation = await Conversation.findOne({ user, conversationId });
+    if (!conversation) {
+      return { message: 'Conversation not found' };
+    }
+
+    const addedTags = tags.tags.filter((tag) => !conversation.tags.includes(tag));
+    const removedTags = conversation.tags.filter((tag) => !tags.tags.includes(tag));
+    for (const tag of addedTags) {
+      await ConversationTag.updateOne({ tag, user }, { $inc: { count: 1 } }, { upsert: true });
+    }
+    for (const tag of removedTags) {
+      await ConversationTag.updateOne({ tag, user }, { $inc: { count: -1 } });
+    }
+    conversation.tags = tags.tags;
+    await conversation.save({ timestamps: { updatedAt: false } });
+    return conversation.tags;
+  } catch (error) {
+    logger.error('[updateTagsToConversation] Error updating tags', error);
+    return { message: 'Error updating tags' };
+  }
+};
+
+const createConversationTag = async (user, data) => {
+  try {
+    const cTag = await ConversationTag.findOne({ user, tag: data.tag });
+    if (cTag) {
+      return cTag;
+    }
+
+    const addToConversation = data.addToConversation && data.conversationId;
+    const newTag = await ConversationTag.create({
+      user,
+      tag: data.tag,
+      count: 0,
+      description: data.description,
+      position: 1,
+    });
+
+    await ConversationTag.updateMany(
+      { user, position: { $gte: 1 }, _id: { $ne: newTag._id } },
+      { $inc: { position: 1 } },
+    );
+
+    if (addToConversation) {
+      const conversation = await Conversation.findOne({
+        user,
+        conversationId: data.conversationId,
+      });
+      if (conversation) {
+        const tags = [...(conversation.tags || []), data.tag];
+        await updateTagsForConversation(user, data.conversationId, { tags });
+      } else {
+        logger.warn('[updateTagsForConversation] Conversation not found', data.conversationId);
+      }
+    }
+
+    return await ConversationTag.findOne({ user, tag: data.tag });
+  } catch (error) {
+    logger.error('[createConversationTag] Error updating conversation tag', error);
+    return { message: 'Error updating conversation tag' };
+  }
+};
+
+const replaceOrRemoveTagInConversations = async (user, oldtag, newtag) => {
+  try {
+    const conversations = await Conversation.find({ user, tags: { $in: [oldtag] } });
+    for (const conversation of conversations) {
+      if (newtag && newtag !== '') {
+        conversation.tags = conversation.tags.map((tag) => (tag === oldtag ? newtag : tag));
+      } else {
+        conversation.tags = conversation.tags.filter((tag) => tag !== oldtag);
+      }
+      await conversation.save({ timestamps: { updatedAt: false } });
+    }
+  } catch (error) {
+    logger.error('[replaceOrRemoveTagInConversations] Error updating conversation tags', error);
+    return { message: 'Error updating conversation tags' };
+  }
+};
+
+const updateTagPosition = async (user, tag, newPosition) => {
+  try {
+    const cTag = await ConversationTag.findOne({ user, tag });
+    if (!cTag) {
+      return { message: 'Tag not found' };
+    }
+
+    const oldPosition = cTag.position;
+
+    if (newPosition === oldPosition) {
+      return cTag;
+    }
+
+    const updateOperations = [];
+
+    if (newPosition > oldPosition) {
+      // Move other tags up
+      updateOperations.push({
+        updateMany: {
+          filter: {
+            user,
+            position: { $gt: oldPosition, $lte: newPosition },
+            tag: { $ne: SAVED_TAG },
+          },
+          update: { $inc: { position: -1 } },
+        },
+      });
+    } else {
+      // Move other tags down
+      updateOperations.push({
+        updateMany: {
+          filter: {
+            user,
+            position: { $gte: newPosition, $lt: oldPosition },
+            tag: { $ne: SAVED_TAG },
+          },
+          update: { $inc: { position: 1 } },
+        },
+      });
+    }
+
+    // Update the target tag's position
+    updateOperations.push({
+      updateOne: {
+        filter: { _id: cTag._id },
+        update: { $set: { position: newPosition } },
+      },
+    });
+
+    await ConversationTag.bulkWrite(updateOperations);
+
+    return await ConversationTag.findById(cTag._id);
+  } catch (error) {
+    logger.error('[updateTagPosition] Error updating tag position', error);
+    return { message: 'Error updating tag position' };
+  }
+};
+module.exports = {
+  SAVED_TAG,
+  ConversationTag,
+  getConversationTags: async (user) => {
+    try {
+      const cTags = await ConversationTag.find({ user }).sort({ position: 1 }).lean();
+      cTags.sort((a, b) => (a.tag === SAVED_TAG ? -1 : b.tag === SAVED_TAG ? 1 : 0));
+
+      return cTags;
+    } catch (error) {
+      logger.error('[getShare] Error getting share link', error);
+      return { message: 'Error getting share link' };
+    }
+  },
+
+  createConversationTag,
+  updateConversationTag: async (user, tag, data) => {
+    try {
+      const cTag = await ConversationTag.findOne({ user, tag });
+      if (!cTag) {
+        return createConversationTag(user, data);
+      }
+
+      if (cTag.tag !== data.tag || cTag.description !== data.description) {
+        cTag.tag = data.tag;
+        cTag.description = data.description === undefined ? cTag.description : data.description;
+        await cTag.save();
+      }
+
+      if (data.position !== undefined && cTag.position !== data.position) {
+        await updateTagPosition(user, tag, data.position);
+      }
+
+      // update conversation tags properties
+      replaceOrRemoveTagInConversations(user, tag, data.tag);
+      return await ConversationTag.findOne({ user, tag: data.tag });
+    } catch (error) {
+      logger.error('[updateConversationTag] Error updating conversation tag', error);
+      return { message: 'Error updating conversation tag' };
+    }
+  },
+
+  deleteConversationTag: async (user, tag) => {
+    try {
+      const currentTag = await ConversationTag.findOne({ user, tag });
+      if (!currentTag) {
+        return;
+      }
+
+      await currentTag.deleteOne({ user, tag });
+
+      await replaceOrRemoveTagInConversations(user, tag, null);
+      return currentTag;
+    } catch (error) {
+      logger.error('[deleteConversationTag] Error deleting conversation tag', error);
+      return { message: 'Error deleting conversation tag' };
+    }
+  },
+
+  updateTagsForConversation,
+  rebuildConversationTags: async (user) => {
+    try {
+      const conversations = await Conversation.find({ user }).select('tags');
+      const tagCountMap = {};
+
+      // Count the occurrences of each tag
+      conversations.forEach((conversation) => {
+        conversation.tags.forEach((tag) => {
+          if (tagCountMap[tag]) {
+            tagCountMap[tag]++;
+          } else {
+            tagCountMap[tag] = 1;
+          }
+        });
+      });
+
+      const tags = await ConversationTag.find({ user }).sort({ position: -1 });
+
+      // Update existing tags and add new tags
+      for (const [tag, count] of Object.entries(tagCountMap)) {
+        const existingTag = tags.find((t) => t.tag === tag);
+        if (existingTag) {
+          existingTag.count = count;
+          await existingTag.save();
+        } else {
+          const newTag = new ConversationTag({ user, tag, count });
+          tags.push(newTag);
+          await newTag.save();
+        }
+      }
+
+      // Set count to 0 for tags that are not in the grouped tags
+      for (const tag of tags) {
+        if (!tagCountMap[tag.tag]) {
+          tag.count = 0;
+          await tag.save();
+        }
+      }
+
+      // Sort tags by position in descending order
+      tags.sort((a, b) => a.position - b.position);
+
+      // Move the tag with name "saved" to the first position
+      const savedTagIndex = tags.findIndex((tag) => tag.tag === SAVED_TAG);
+      if (savedTagIndex !== -1) {
+        const [savedTag] = tags.splice(savedTagIndex, 1);
+        tags.unshift(savedTag);
+      }
+
+      // Reassign positions starting from 0
+      tags.forEach((tag, index) => {
+        tag.position = index;
+        tag.save();
+      });
+      return tags;
+    } catch (error) {
+      logger.error('[rearrangeTags] Error rearranging tags', error);
+      return { message: 'Error rearranging tags' };
+    }
+  },
+};

api/models/schema/conversationTagSchema.js

@@ -0,0 +1,31 @@
+const mongoose = require('mongoose');
+
+const conversationTagSchema = mongoose.Schema(
+  {
+    tag: {
+      type: String,
+      index: true,
+    },
+    user: {
+      type: String,
+      index: true,
+    },
+    description: {
+      type: String,
+      index: true,
+    },
+    count: {
+      type: Number,
+      default: 0,
+    },
+    position: {
+      type: Number,
+      default: 0,
+    },
+  },
+  { timestamps: true },
+);
+
+conversationTagSchema.index({ tag: 1, user: 1 }, { unique: true });
+
+module.exports = mongoose.model('ConversationTag', conversationTagSchema);

api/models/schema/convoSchema.js

@@ -42,6 +42,11 @@ const convoSchema = mongoose.Schema(
     invocationId: {
       type: Number,
     },
+    tags: {
+      type: [String],
+      default: [],
+      meiliIndex: true,
+    },
   },
   { timestamps: true },
 );

api/models/schema/defaults.js

@@ -103,6 +103,10 @@ const conversationPreset = {
   spec: {
     type: String,
   },
+  tags: {
+    type: [String],
+    default: [],
+  },
   tools: { type: [{ type: String }], default: undefined },
   maxContextTokens: {
     type: Number,

api/server/index.js

@@ -94,6 +94,7 @@ const startServer = async () => {
   app.use('/api/share', routes.share);
   app.use('/api/roles', routes.roles);
 
+  app.use('/api/tags', routes.tags);
   app.use((req, res) => {
     res.sendFile(path.join(app.locals.paths.dist, 'index.html'));
   });

api/server/routes/convos.js

@@ -8,6 +8,7 @@ const requireJwtAuth = require('~/server/middleware/requireJwtAuth');
 const { forkConversation } = require('~/server/utils/import/fork');
 const { importConversations } = require('~/server/utils/import');
 const { createImportLimiters } = require('~/server/middleware');
+const { updateTagsForConversation } = require('~/models/ConversationTag');
 const getLogStores = require('~/cache/getLogStores');
 const { sleep } = require('~/server/utils');
 const { logger } = require('~/config');
@@ -30,8 +31,13 @@ router.get('/', async (req, res) => {
     return res.status(400).json({ error: 'Invalid page size' });
   }
   const isArchived = req.query.isArchived === 'true';
+  const tags = req.query.tags
+    ? Array.isArray(req.query.tags)
+      ? req.query.tags
+      : [req.query.tags]
+    : undefined;
 
-  res.status(200).send(await getConvosByPage(req.user.id, pageNumber, pageSize, isArchived));
+  res.status(200).send(await getConvosByPage(req.user.id, pageNumber, pageSize, isArchived, tags));
 });
 
 router.get('/:conversationId', async (req, res) => {
@@ -167,4 +173,9 @@ router.post('/fork', async (req, res) => {
   }
 });
 
+router.put('/tags/:conversationId', async (req, res) => {
+  const tag = await updateTagsForConversation(req.user.id, req.params.conversationId, req.body);
+  res.status(200).json(tag);
+});
+
 module.exports = router;

api/server/routes/index.js

@@ -21,6 +21,7 @@ const staticRoute = require('./static');
 const share = require('./share');
 const categories = require('./categories');
 const roles = require('./roles');
+const tags = require('./tags');
 
 module.exports = {
   search,
@@ -46,4 +47,5 @@ module.exports = {
   share,
   categories,
   roles,
+  tags,
 };

api/server/routes/tags.js

@@ -0,0 +1,44 @@
+const express = require('express');
+
+const {
+  getConversationTags,
+  updateConversationTag,
+  createConversationTag,
+  deleteConversationTag,
+  rebuildConversationTags,
+} = require('~/models/ConversationTag');
+const requireJwtAuth = require('~/server/middleware/requireJwtAuth');
+const router = express.Router();
+router.use(requireJwtAuth);
+
+router.get('/', async (req, res) => {
+  const tags = await getConversationTags(req.user.id);
+
+  if (tags) {
+    res.status(200).json(tags);
+  } else {
+    res.status(404).end();
+  }
+});
+
+router.post('/', async (req, res) => {
+  const tag = await createConversationTag(req.user.id, req.body);
+  res.status(200).json(tag);
+});
+
+router.post('/rebuild', async (req, res) => {
+  const tag = await rebuildConversationTags(req.user.id);
+  res.status(200).json(tag);
+});
+
+router.put('/:tag', async (req, res) => {
+  const tag = await updateConversationTag(req.user.id, req.params.tag, req.body);
+  res.status(200).json(tag);
+});
+
+router.delete('/:tag', async (req, res) => {
+  const tag = await deleteConversationTag(req.user.id, req.params.tag);
+  res.status(200).json(tag);
+});
+
+module.exports = router;