refactor: cache summary in topic hash

remove summary on new reply, edit, post purge/restore/delete/move and change owner

Author: barisusakli

lib/summary.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const db = require.main.require('./src/database');
 const batch = require.main.require('./src/batch');
 const topics = require.main.require('./src/topics');
 const posts = require.main.require('./src/posts');
@@ -37,6 +38,9 @@ function chunkPosts(posts, maxTokensPerChunk = 3000) {
 
 async function summarizeChunk(chunk, openai, settings) {
 	const threadText = formatPosts(chunk);
+	if (!threadText) {
+		return '';
+	}
 	const response = await openai.chat.completions.create({
 		model: settings.model || 'gpt-3.5-turbo',
 		messages: [
@@ -63,8 +67,8 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 	const chunkSummaries = [];
 
 	await batch.processArray(allPids, async function (pids) {
-		const postData = await posts.getPostsFields(pids, ['uid', 'content']);
-
+		let postData = await posts.getPostsFields(pids, ['uid', 'content', 'deleted']);
+		postData = postData.filter((p) => !p.deleted);
 		const missingUids = [];
 		postData.forEach((p) => {
 			if (!userMap.hasOwnProperty(p.uid)) {
@@ -93,6 +97,9 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 	}
 	// Final summary from all summaries
 	const finalInput = chunkSummaries.join("\n\n");
+	if (!finalInput) {
+		return '';
+	}
 	const finalResponse = await openai.chat.completions.create({
 		model: settings.model || 'gpt-3.5-turbo',
 		messages: [
@@ -109,4 +116,8 @@ exports.summarizeTopic = async function(tid, openai, settings) {
 	});
 
 	return finalResponse.choices[0].message.content.trim();
+};
+
+exports.clearTopicSummary = async function(tids) {
+	await db.deleteObjectFields(tids.map((tid) => `topic:${tid}`), ['openai:summary']);
 };

library.js

@@ -10,7 +10,6 @@ const controllers = require('./lib/controllers');
 const routeHelpers = require.main.require('./src/routes/helpers');
 const socketHelpers = require.main.require('./src/socket.io/helpers');
 const topics = require.main.require('./src/topics');
-const posts = require.main.require('./src/posts');
 const user = require.main.require('./src/user');
 const messaging = require.main.require('./src/messaging');
 const api = require.main.require('./src/api');
@@ -277,6 +276,38 @@ plugin.filterTopicThreadTools = async (hookData) => {
 	return hookData;
 };
 
+plugin.actionTopicReply = async (hookData) => {
+	await summary.clearTopicSummary([hookData.post.tid]);
+};
+
+plugin.actionPostEdit = async (hookData) => {
+	await summary.clearTopicSummary([hookData.post.tid]);
+};
+
+plugin.actionPostsPurge = async (hookData) => {
+	const { posts } = hookData;
+	const uniqTids = [...new Set(posts.map(p => p.tid))];
+	await summary.clearTopicSummary(uniqTids);
+};
+
+plugin.actionPostRestore = async (hookData) => {
+	await summary.clearTopicSummary([hookData.post.tid]);
+};
+
+plugin.actionPostDelete = async (hookData) => {
+	await summary.clearTopicSummary([hookData.post.tid]);
+};
+
+plugin.actionPostMove = async (hookData) => {
+	await summary.clearTopicSummary([hookData.post.tid, hookData.tid]);
+};
+
+plugin.actionPostChangeOwner = async (hookData) => {
+	const { posts } = hookData;
+	const uniqTids = [...new Set(posts.map(p => p.tid))];
+	await summary.clearTopicSummary(uniqTids);
+};
+
 socketPlugins.openai = {};
 
 socketPlugins.openai.summarizeTopic = async function (socket, data) {
@@ -289,5 +320,11 @@ socketPlugins.openai.summarizeTopic = async function (socket, data) {
 		return;
 	}
 
-	return summary.summarizeTopic(tid, openai, settings);
+	let openaiSummary = await topics.getTopicField(tid, 'openai:summary');
+	if (openaiSummary) {
+		return openaiSummary;
+	}
+	openaiSummary = await summary.summarizeTopic(tid, openai, settings);
+	await topics.setTopicField(tid, 'openai:summary', openaiSummary);
+	return openaiSummary;
 };

plugin.json

@@ -7,7 +7,15 @@
 		{ "hook": "filter:admin.header.build", "method": "addAdminNavigation" },
 		{ "hook": "action:mentions.notify", "method": "actionMentionsNotify" },
 		{ "hook": "action:messaging.save", "method": "actionMessagingSave" },
-		{ "hook": "filter:topic.thread_tools", "method": "filterTopicThreadTools" }
+		{ "hook": "filter:topic.thread_tools", "method": "filterTopicThreadTools" },
+
+		{ "hook": "action:topic.reply", "method": "actionTopicReply" },
+		{ "hook": "action:post.edit", "method": "actionPostEdit" },
+		{ "hook": "action:posts.purge", "method": "actionPostsPurge" },
+		{ "hook": "action:post.restore", "method": "actionPostRestore" },
+ 		{ "hook": "action:post.delete", "method": "actionPostDelete" },
+		{ "hook": "action:post.move", "method": "actionPostMove" },
+		{ "hook": "action:post.changeOwner", "method": "actionPostChangeOwner" }
 	],
 	"scripts": [
 		"./public/lib/main.js"