nodebb-plugin-dbsearch 6.4.1 → 6.5.1

package/README.md

@@ -1,10 +1,15 @@
-# NodeBB Plugin DB Search
-
-A Plugin that lets users search posts and topics
-
-## Installation
-
-    npm install nodebb-plugin-dbsearch
-
-
-
+# NodeBB Plugin DB Search
+
+A Plugin that lets users search posts and topics
+
+## Installation
+
+    npm install nodebb-plugin-dbsearch
+
+## MongoDB read preference (replica set deployments)
+
+When the plugin is running on MongoDB, the ACP page exposes a **MongoDB Read Preference** selector that controls where the plugin's read queries (full-text search aggregations and indexed-document counts) are routed. The selector has no effect on the Postgres or Redis backends.
+
+Allowed values match the standard MongoDB read preference modes: `primary` (default), `primaryPreferred`, `secondary`, `secondaryPreferred`, `nearest`. Writes (indexing, removals) always go to the primary regardless of this setting.
+
+The default of `primary` keeps the original behavior. On a replica set, switching to `secondaryPreferred` (or `secondary`) offloads search load from the primary at the cost of slightly stale results due to replication lag — usually unnoticeable for full-text search but worth knowing for workflows that reindex and immediately query. On standalone deployments the driver transparently falls back to the primary, so the setting is a no-op.

package/lib/dbsearch.js

@@ -2,19 +2,19 @@
 
 const _ = require('lodash');
 
-const winston = require.main.require('winston');
-const nconf = require.main.require('nconf');
-
-const db = require.main.require('./src/database');
-const topics = require.main.require('./src/topics');
-const posts = require.main.require('./src/posts');
-const messaging = require.main.require('./src/messaging');
-const utils = require.main.require('./src/utils');
-const socketAdmin = require.main.require('./src/socket.io/admin');
-const batch = require.main.require('./src/batch');
-const plugins = require.main.require('./src/plugins');
-const categories = require.main.require('./src/categories');
-const pubsub = require.main.require('./src/pubsub');
+const winston = nodebb.require('winston');
+const nconf = nodebb.require('nconf');
+
+const db = nodebb.require('./src/database');
+const topics = nodebb.require('./src/topics');
+const posts = nodebb.require('./src/posts');
+const messaging = nodebb.require('./src/messaging');
+const utils = nodebb.require('./src/utils');
+const socketAdmin = nodebb.require('./src/socket.io/admin');
+const batch = nodebb.require('./src/batch');
+const plugins = nodebb.require('./src/plugins');
+const categories = nodebb.require('./src/categories');
+const pubsub = nodebb.require('./src/pubsub');
 
 const searchModule = require(`./${nconf.get('database')}`);
 
@@ -42,13 +42,21 @@ const languageLookup = {
 
 const defaultPostLimit = 500;
 const defaultTopicLimit = 500;
+const defaultMongoReadPreference = 'primary';
 
 let pluginConfig = {
 	postLimit: defaultPostLimit,
 	topicLimit: defaultTopicLimit,
 	excludeCategories: [],
+	mongoReadPreference: defaultMongoReadPreference,
 };
 
+function applyMongoReadPreference(pref) {
+	if (typeof searchModule.setReadPreference === 'function') {
+		searchModule.setReadPreference(pref);
+	}
+}
+
 const batchSize = 500;
 
 const search = module.exports;
@@ -62,16 +70,18 @@ function convertLanguageName(name) {
 
 search.init = async function (params) {
 	const { router } = params;
-	const routeHelpers = require.main.require('./src/routes/helpers');
+	const routeHelpers = nodebb.require('./src/routes/helpers');
 	routeHelpers.setupAdminPageRoute(router, '/admin/plugins/dbsearch', renderAdmin);
 
 	router.post('/api/admin/plugins/dbsearch/save', params.middleware.applyCSRF, save);
 
 	pluginConfig = await getPluginData();
+	applyMongoReadPreference(pluginConfig.mongoReadPreference);
 	await searchModule.createIndices(convertLanguageName(pluginConfig ? pluginConfig.indexLanguage || 'en' : 'en'));
 
 	pubsub.on('nodebb-plugin-dbsearch:settings:save', (data) => {
 		Object.assign(pluginConfig, data);
+		applyMongoReadPreference(pluginConfig.mongoReadPreference);
 	});
 };
 
@@ -496,10 +506,16 @@ async function renderAdmin(req, res) {
 
 async function save(req, res) {
 	if (utils.isNumber(req.body.postLimit) && utils.isNumber(req.body.topicLimit)) {
+		const allowed = searchModule.VALID_READ_PREFERENCES || [];
+		const mongoReadPreference = allowed.includes(req.body.mongoReadPreference) ?
+			req.body.mongoReadPreference :
+			defaultMongoReadPreference;
+
 		const data = {
 			postLimit: req.body.postLimit,
 			topicLimit: req.body.topicLimit,
 			excludeCategories: JSON.stringify(req.body.excludeCategories || []),
+			mongoReadPreference: mongoReadPreference,
 		};
 
 		await db.setObject('nodebb-plugin-dbsearch', data);
@@ -507,6 +523,7 @@ async function save(req, res) {
 		pluginConfig.postLimit = data.postLimit;
 		pluginConfig.topicLimit = data.topicLimit;
 		pluginConfig.excludeCategories = req.body.excludeCategories || [];
+		pluginConfig.mongoReadPreference = mongoReadPreference;
 		pubsub.publish('nodebb-plugin-dbsearch:settings:save', pluginConfig);
 		res.json('Settings saved!');
 	}
@@ -524,6 +541,7 @@ async function getPluginData() {
 	data.postLimit = data.postLimit || defaultPostLimit;
 	data.topicLimit = data.topicLimit || defaultTopicLimit;
 	data.indexLanguage = data.indexLanguage || 'en';
+	data.mongoReadPreference = data.mongoReadPreference || defaultMongoReadPreference;
 	data.working = parseInt(data.working, 10) || 0;
 
 	try {
@@ -550,6 +568,12 @@ async function getGlobalAndPluginData() {
 	plugin.languageSupported = languageSupported;
 	plugin.languages = languages;
 
+	plugin.mongoBackend = nconf.get('database') === 'mongo';
+	plugin.mongoReadPreferences = (searchModule.VALID_READ_PREFERENCES || []).map(value => ({
+		value,
+		selected: value === plugin.mongoReadPreference,
+	}));
+
 	plugin.allCategories = allCategories;
 	plugin.topicCount = parseInt(global.topicCount, 10);
 	plugin.postCount = parseInt(global.postCount, 10);

package/lib/mongo.js

@@ -1,8 +1,32 @@
 'use strict';
 
-const nconf = require.main.require('nconf');
+const nconf = nodebb.require('nconf');
 
-const db = require.main.require('./src/database');
+const db = nodebb.require('./src/database');
+
+const VALID_READ_PREFERENCES = [
+	'primary',
+	'primaryPreferred',
+	'secondary',
+	'secondaryPreferred',
+	'nearest',
+];
+
+let readPreference = 'primary';
+
+exports.VALID_READ_PREFERENCES = VALID_READ_PREFERENCES;
+
+exports.setReadPreference = function (pref) {
+	if (VALID_READ_PREFERENCES.includes(pref)) {
+		readPreference = pref;
+	} else {
+		readPreference = 'primary';
+	}
+};
+
+function readOptions() {
+	return readPreference === 'primary' ? {} : { readPreference };
+}
 
 function generateIndexName(indexSpec) {
 	return Object.entries(indexSpec)
@@ -137,7 +161,7 @@ exports.search = async function (key, data, limit) {
 	aggregate.push({ $limit: parseInt(limit, 10) });
 	aggregate.push({ $project: { _id: 1 } });
 
-	const results = await db.client.collection(`search${key}`).aggregate(aggregate).toArray();
+	const results = await db.client.collection(`search${key}`).aggregate(aggregate, readOptions()).toArray();
 	if (!results || !results.length) {
 		return [];
 	}
@@ -204,7 +228,7 @@ exports.chat.search = async (data, limit) => {
 		{ $sort: { score: { $meta: 'textScore' } } },
 		{ $limit: parseInt(limit, 10) },
 		{ $project: { _id: 1 } },
-	]).toArray();
+	], readOptions()).toArray();
 	if (!results || !results.length) {
 		return [];
 	}
@@ -227,13 +251,13 @@ function buildTextQuery(content, matchWords) {
 }
 
 exports.getIndexedTopicCount = async () => {
-	return await db.client.collection('searchtopic').estimatedDocumentCount();
+	return await db.client.collection('searchtopic').estimatedDocumentCount(readOptions());
 };
 
 exports.getIndexedPostCount = async () => {
-	return await db.client.collection('searchpost').estimatedDocumentCount();
+	return await db.client.collection('searchpost').estimatedDocumentCount(readOptions());
 };
 
 exports.getIndexedChatMessageCount = async () => {
-	return await db.client.collection('searchchat').estimatedDocumentCount();
+	return await db.client.collection('searchchat').estimatedDocumentCount(readOptions());
 };

package/lib/postgres.js

@@ -1,10 +1,10 @@
 'use strict';
 
-const winston = require.main.require('winston');
-const nconf = require.main.require('nconf');
+const winston = nodebb.require('winston');
+const nconf = nodebb.require('nconf');
 
-const db = require.main.require('./src/database');
-const pubsub = require.main.require('./src/pubsub');
+const db = nodebb.require('./src/database');
+const pubsub = nodebb.require('./src/pubsub');
 
 let searchLanguage = 'english';
 

package/lib/redis.js

@@ -2,9 +2,9 @@
 
 const redisSearch = require('redisearch');
 
-const async = require.main.require('async');
+const async = nodebb.require('async');
 
-const db = require.main.require('./src/database');
+const db = nodebb.require('./src/database');
 
 exports.createIndices = async function () {
 	db.postSearch = redisSearch.createSearch('nodebbpostsearch', db.client);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-dbsearch",
-  "version": "6.4.1",
+  "version": "6.5.1",
   "description": "A Plugin that lets users search posts and topics",
   "main": "index.js",
   "repository": {
@@ -23,10 +23,10 @@
     "redisearch": "^2.0.1"
   },
   "devDependencies": {
-    "eslint": "^10.0.3",
-    "eslint-config-nodebb": "^2.0.1"
+    "eslint": "^10.4.1",
+    "eslint-config-nodebb": "^2.0.2"
   },
   "nbbpm": {
-    "compatibility": "^4.9.0"
+    "compatibility": "^4.12.0"
   }
 }

package/public/admin.js

@@ -21,6 +21,7 @@ define('admin/plugins/dbsearch', [
 				topicLimit: $('#topicLimit').val(),
 				postLimit: $('#postLimit').val(),
 				excludeCategories: $('#exclude-categories').val(),
+				mongoReadPreference: $('#mongoReadPreference').val(),
 			}, function (data) {
 				if (typeof data === 'string') {
 					settings.toggleSaveSuccess($('#save'));

package/templates/admin/plugins/dbsearch.tpl

@@ -63,6 +63,17 @@
 							<label class="form-label">Post Limit</label>
 							<input id="postLimit" type="text" class="form-control" placeholder="Number of posts to return" value="{postLimit}">
 						</div>
+
+						<!-- IF mongoBackend -->
+						<div class="mb-3">
+							<label class="form-label">MongoDB Read Preference <i class="fa fa-circle-question" title="Routes search read queries (text search and indexed-document counts) to the chosen replica set member. secondaryPreferred can offload search load from the primary on replica set deployments; results may be slightly stale due to replication lag. Has no effect on standalone deployments." data-bs-toggle="tooltip"></i></label>
+							<select class="form-select" id="mongoReadPreference">
+								<!-- BEGIN mongoReadPreferences -->
+								<option value="{mongoReadPreferences.value}" <!-- IF mongoReadPreferences.selected -->selected<!-- ENDIF mongoReadPreferences.selected -->>{mongoReadPreferences.value}</option>
+								<!-- END mongoReadPreferences -->
+							</select>
+						</div>
+						<!-- ENDIF mongoBackend -->
 					</div>
 
 					<div class="col-6">

package/upgrades/dbsearch_change_integer_index.js

@@ -8,13 +8,13 @@ module.exports = {
 	timestamp: Date.UTC(2025, 0, 27),
 	method: async function () {
 		const { progress } = this;
-		const nconf = require.main.require('nconf');
+		const nconf = nodebb.require('nconf');
 		const mainDB = nconf.get('database');
 		if (mainDB === 'redis') {
 			// redis is not affected, since everything is string already
 			return;
 		}
-		const batch = require.main.require('./src/batch');
+		const batch = nodebb.require('./src/batch');
 		async function convertIdToString(collection, docs) {
 			await batch.processArray(docs, async (docs) => {
 				await db.client.collection(collection).deleteMany({

package/upgrades/dbsearch_change_mongodb_schema.js

@@ -1,14 +1,14 @@
 'use strict';
 
 
-const winston = require.main.require('winston');
+const winston = nodebb.require('winston');
 const db = module.parent.require('./database');
 
 module.exports = {
 	name: 'Changing dbsearch mongodb search schema to use _id',
 	timestamp: Date.UTC(2018, 10, 26),
 	method: async function () {
-		const nconf = require.main.require('nconf');
+		const nconf = nodebb.require('nconf');
 		const isMongo = nconf.get('database') === 'mongo';
 		if (!isMongo) {
 			return;

package/upgrades/dbsearch_mongodb_ts_index.js

@@ -8,8 +8,8 @@ module.exports = {
 	timestamp: Date.UTC(2025, 1, 18),
 	method: async function () {
 		const { progress } = this;
-		const nconf = require.main.require('nconf');
-		const batch = require.main.require('./src/batch');
+		const nconf = nodebb.require('nconf');
+		const batch = nodebb.require('./src/batch');
 		const isMongo = nconf.get('database') === 'mongo';
 		if (!isMongo) {
 			return;

package/upgrades/dbsearch_psql_cid_text_index.js

@@ -7,7 +7,7 @@ module.exports = {
 	name: 'Changing integer cid index to text for psql',
 	timestamp: Date.UTC(2025, 6, 8),
 	method: async function () {
-		const nconf = require.main.require('nconf');
+		const nconf = nodebb.require('nconf');
 		const mainDB = nconf.get('database');
 		if (mainDB !== 'postgres') {
 			return;