nodebb-plugin-dbsearch 5.0.3 → 5.1.1

package/lib/mongo.js

@@ -1,115 +1,114 @@
-'use strict';
-
-const nconf = require.main.require('nconf');
-
-const db = require.main.require('./src/database');
-
-exports.createIndices = async function (language) {
-	const options = { background: true };
-	if (language && language !== 'en') {
-		options.default_language = language;
-	}
-
-	if (nconf.get('isPrimary') && !nconf.get('jobsDisabled')) {
-		await db.client.collection('searchtopic').createIndex({ content: 'text', uid: 1, cid: 1 }, options);
-		await db.client.collection('searchpost').createIndex({ content: 'text', uid: 1, cid: 1 }, options);
-	}
-};
-
-exports.changeIndexLanguage = async function (language) {
-	const indexSpec = { content: 'text', uid: 1, cid: 1 };
-	const options = { background: true };
-	if (language !== 'en') {
-		options.default_language = language;
-	}
-	await db.client.collection('searchtopic').dropIndex('content_text_uid_1_cid_1');
-	await db.client.collection('searchtopic').createIndex(indexSpec, options);
-	await db.client.collection('searchpost').dropIndex('content_text_uid_1_cid_1');
-	await db.client.collection('searchpost').createIndex(indexSpec, options);
-};
-
-exports.searchIndex = async function (key, data, ids) {
-	if (!ids.length) {
-		return;
-	}
-
-	ids = ids.map(id => parseInt(id, 10));
-
-	const bulk = db.client.collection('search' + key).initializeUnorderedBulkOp();
-	ids.forEach(function (id, index) {
-		const setData = {};
-
-		for (const field in data[index]) {
-			if (data[index].hasOwnProperty(field) && data[index][field]) {
-				setData[field] = data[index][field].toString();
-			}
-		}
-
-		bulk.find({ _id: id }).upsert().updateOne({ $set: setData });
-	});
-
-	await bulk.execute();
-};
-
-exports.search = async function (key, data, limit) {
-	const searchQuery = {};
-	if (data.content) {
-		let words = data.content.split(' ');
-		const allQuoted = data.content.startsWith('"') && data.content.endsWith('"');
-		if (data.matchWords === 'all' && !allQuoted) {
-			words = words.map(function (word) {
-				if (!word.startsWith('"') && !word.endsWith('"')) {
-					return '"' + word + '"';
-				}
-				return word;
-			});
-		}
-
-		searchQuery.$text = { $search: words.join(' ') };
-	}
-
-	if (Array.isArray(data.cid) && data.cid.length) {
-		if (data.cid.length > 1) {
-			searchQuery.cid = { $in: data.cid.map(String) };
-		} else {
-			searchQuery.cid = String(data.cid[0]);
-		}
-	}
-
-	if (Array.isArray(data.uid) && data.uid.length) {
-		if (data.uid.length > 1) {
-			searchQuery.uid = { $in: data.uid.map(String) };
-		} else {
-			searchQuery.uid = String(data.uid[0]);
-		}
-	}
-
-	var aggregate = [{ $match: searchQuery }];
-	if (searchQuery.$text) {
-		const sortQuery = { score: { $meta: 'textScore' } };
-		if (data.searchData.sortBy === 'timestamp' || data.searchData.sortBy === 'topic.timestamp') {
-			sortQuery._id = data.searchData.sortDirection === 'asc' ? 1 : -1;
-		}
-		aggregate.push({ $sort: sortQuery });
-	} else {
-		aggregate.push({ $sort: { _id: data.searchData.sortDirection === 'asc' ? 1 : -1 } });
-	}
-	aggregate.push({ $limit: parseInt(limit, 10) });
-	aggregate.push({ $project: { _id: 1 } });
-
-	const results = await db.client.collection('search' + key).aggregate(aggregate).toArray();
-	if (!results || !results.length) {
-		return [];
-	}
-	return results.map(item => item._id);
-};
-
-exports.searchRemove = async function (key, ids) {
-	if (!key || !ids.length) {
-		return;
-	}
-
-	ids = ids.map(id => parseInt(id, 10));
-
-	await db.client.collection('search' + key).removeMany({ _id: { $in: ids } });
-};
+'use strict';
+
+const nconf = require.main.require('nconf');
+
+const db = require.main.require('./src/database');
+
+exports.createIndices = async function (language) {
+	const options = { background: true };
+	if (language && language !== 'en') {
+		options.default_language = language;
+	}
+
+	if (nconf.get('isPrimary') && !nconf.get('jobsDisabled')) {
+		await db.client.collection('searchtopic').createIndex({ content: 'text', uid: 1, cid: 1 }, options);
+		await db.client.collection('searchpost').createIndex({ content: 'text', uid: 1, cid: 1 }, options);
+	}
+};
+
+exports.changeIndexLanguage = async function (language) {
+	const indexSpec = { content: 'text', uid: 1, cid: 1 };
+	const options = { background: true };
+	if (language !== 'en') {
+		options.default_language = language;
+	}
+	await db.client.collection('searchtopic').dropIndex('content_text_uid_1_cid_1');
+	await db.client.collection('searchtopic').createIndex(indexSpec, options);
+	await db.client.collection('searchpost').dropIndex('content_text_uid_1_cid_1');
+	await db.client.collection('searchpost').createIndex(indexSpec, options);
+};
+
+exports.searchIndex = async function (key, data, ids) {
+	if (!ids.length) {
+		return;
+	}
+
+	ids = ids.map(id => parseInt(id, 10));
+
+	const bulk = db.client.collection(`search${key}`).initializeUnorderedBulkOp();
+	ids.forEach((id, index) => {
+		const setData = {};
+		Object.keys(data[index]).forEach((field) => {
+			if (data[index].hasOwnProperty(field) && data[index][field]) {
+				setData[field] = data[index][field].toString();
+			}
+		});
+
+		bulk.find({ _id: id }).upsert().updateOne({ $set: setData });
+	});
+
+	await bulk.execute();
+};
+
+exports.search = async function (key, data, limit) {
+	const searchQuery = {};
+	if (data.content) {
+		let words = data.content.split(' ');
+		const allQuoted = data.content.startsWith('"') && data.content.endsWith('"');
+		if (data.matchWords === 'all' && !allQuoted) {
+			words = words.map((word) => {
+				if (!word.startsWith('"') && !word.endsWith('"')) {
+					return `"${word}"`;
+				}
+				return word;
+			});
+		}
+
+		searchQuery.$text = { $search: words.join(' ') };
+	}
+
+	if (Array.isArray(data.cid) && data.cid.length) {
+		if (data.cid.length > 1) {
+			searchQuery.cid = { $in: data.cid.map(String) };
+		} else {
+			searchQuery.cid = String(data.cid[0]);
+		}
+	}
+
+	if (Array.isArray(data.uid) && data.uid.length) {
+		if (data.uid.length > 1) {
+			searchQuery.uid = { $in: data.uid.map(String) };
+		} else {
+			searchQuery.uid = String(data.uid[0]);
+		}
+	}
+
+	const aggregate = [{ $match: searchQuery }];
+	if (searchQuery.$text) {
+		const sortQuery = { score: { $meta: 'textScore' } };
+		if (data.searchData.sortBy === 'timestamp' || data.searchData.sortBy === 'topic.timestamp') {
+			sortQuery._id = data.searchData.sortDirection === 'asc' ? 1 : -1;
+		}
+		aggregate.push({ $sort: sortQuery });
+	} else {
+		aggregate.push({ $sort: { _id: data.searchData.sortDirection === 'asc' ? 1 : -1 } });
+	}
+	aggregate.push({ $limit: parseInt(limit, 10) });
+	aggregate.push({ $project: { _id: 1 } });
+
+	const results = await db.client.collection(`search${key}`).aggregate(aggregate).toArray();
+	if (!results || !results.length) {
+		return [];
+	}
+	return results.map(item => item._id);
+};
+
+exports.searchRemove = async function (key, ids) {
+	if (!key || !ids.length) {
+		return;
+	}
+
+	ids = ids.map(id => parseInt(id, 10));
+
+	await db.client.collection(`search${key}`).deleteMany({ _id: { $in: ids } });
+};

package/lib/postgres.js

@@ -1,111 +1,111 @@
-'use strict';
-
-const winston = require.main.require('winston');
-const nconf = require.main.require('nconf');
-
-const db = require.main.require('./src/database');
-const pubsub = require.main.require('./src/pubsub');
-
-let searchLanguage = 'english';
-
-pubsub.on('dbsearch-language-changed', function (e) {
-	searchLanguage = e.data;
-});
-
-async function initDB() {
-	await db.pool.query('CREATE TABLE IF NOT EXISTS "searchtopic" ( "id" BIGINT NOT NULL PRIMARY KEY, "content" TEXT, "uid" BIGINT, "cid" BIGINT )');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchtopic__content" ON "searchtopic" USING GIN (to_tsvector(\'' + searchLanguage + '\', "content"))');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchtopic__uid" ON "searchtopic"("uid")');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchtopic__cid" ON "searchtopic"("cid")');
-	await db.pool.query('CREATE TABLE IF NOT EXISTS "searchpost" ( "id" BIGINT NOT NULL PRIMARY KEY, "content" TEXT, "uid" BIGINT, "cid" BIGINT )');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchpost__content" ON "searchpost" USING GIN (to_tsvector(\'' + searchLanguage + '\', "content"))');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchpost__uid" ON "searchpost"("uid")');
-	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchpost__cid" ON "searchpost"("cid")');
-}
-
-async function handleError(err) {
-	if (err && err.code === '42P01') {
-		winston.warn('dbsearch was not initialized');
-		await initDB();
-		return;
-	}
-
-	throw err;
-}
-
-exports.createIndices = async function (language) {
-	searchLanguage = language;
-	if (nconf.get('isPrimary') && !nconf.get('jobsDisabled')) {
-		await initDB();
-	}
-};
-
-exports.changeIndexLanguage = async function (language) {
-	searchLanguage = language;
-	pubsub.publish('dbsearch-language-changed', language);
-	await db.pool.query('DROP INDEX "idx__searchtopic__content"');
-	await db.pool.query('CREATE INDEX "idx__searchtopic__content" ON "searchtopic" USING GIN (to_tsvector(\'' + language + '\', "content"))');
-	await db.pool.query('DROP INDEX "idx__searchpost__content"');
-	await db.pool.query('CREATE INDEX "idx__searchpost__content" ON "searchpost" USING GIN (to_tsvector(\'' + language + '\', "content"))');
-};
-
-exports.searchIndex = async function (key, data, ids) {
-	if (!ids.length) {
-		return;
-	}
-
-	ids = ids.map(id => parseInt(id, 10));
-	try {
-		await db.pool.query({
-			name: 'dbsearch-searchIndex-' + key,
-			text: 'INSERT INTO "search' + key + '" SELECT d."id", d."data"->>\'content\' "content", (d."data"->>\'uid\')::bigint "uid", (d."data"->>\'cid\')::bigint "cid" FROM UNNEST($1::bigint[], $2::jsonb[]) d("id", "data") ON CONFLICT ("id") DO UPDATE SET "content" = COALESCE(EXCLUDED."content", "search' + key + '"."content"), "uid" = COALESCE(EXCLUDED."uid", "search' + key + '"."uid"), "cid" = COALESCE(EXCLUDED."cid", "search' + key + '"."cid")',
-			values: [ids, data],
-		});
-	} catch (err) {
-		winston.error('Error indexing ' + err.message);
-		await handleError(err);
-		await exports.searchIndex(key, data, ids);
-	}
-};
-
-exports.search = async function (key, data, limit) {
-	if (Array.isArray(data.uid) && data.uid.filter(Boolean).length) {
-		data.uid = data.uid.filter(Boolean);
-	} else {
-		data.uid = null;
-	}
-
-	if (Array.isArray(data.cid) && data.cid.filter(Boolean).length) {
-		data.cid = data.cid.filter(Boolean);
-	} else {
-		data.cid = null;
-	}
-	try {
-		const res = await db.pool.query({
-			name: 'dbsearch-search-' + key,
-			text: 'SELECT ARRAY(SELECT s."id" FROM "search' + key + '" s WHERE ($1::text IS NULL OR to_tsvector($5::regconfig, "content") @@ plainto_tsquery($5::regconfig, $1::text)) AND ($2::bigint[] IS NULL OR "uid" = ANY($2::bigint[])) AND ($3::bigint[] IS NULL OR "cid" = ANY($3::bigint[])) ORDER BY ts_rank_cd(to_tsvector($5::regconfig, "content"), plainto_tsquery($5::regconfig, $1::text)) DESC, s."id" ASC LIMIT $4::integer) r',
-			values: [data.content, data.uid, data.cid, parseInt(limit, 10), searchLanguage],
-		});
-		return res.rows[0].r;
-	} catch (err) {
-		await handleError(err);
-		return [];
-	}
-};
-
-exports.searchRemove = async function (key, ids) {
-	if (!key || !ids.length) {
-		return;
-	}
-
-	ids = ids.map(id => parseInt(id, 10));
-	try {
-		await db.pool.query({
-			name: 'dbsearch-searchRemove-' + key,
-			text: 'DELETE FROM "search' + key + '" s WHERE s."id" = ANY($1::bigint[])',
-			values: [ids],
-		});
-	} catch (err) {
-		await handleError(err);
-	}
-};
+'use strict';
+
+const winston = require.main.require('winston');
+const nconf = require.main.require('nconf');
+
+const db = require.main.require('./src/database');
+const pubsub = require.main.require('./src/pubsub');
+
+let searchLanguage = 'english';
+
+pubsub.on('dbsearch-language-changed', (e) => {
+	searchLanguage = e.data;
+});
+
+async function initDB() {
+	await db.pool.query('CREATE TABLE IF NOT EXISTS "searchtopic" ( "id" BIGINT NOT NULL PRIMARY KEY, "content" TEXT, "uid" BIGINT, "cid" BIGINT )');
+	await db.pool.query(`CREATE INDEX IF NOT EXISTS "idx__searchtopic__content" ON "searchtopic" USING GIN (to_tsvector('${searchLanguage}', "content"))`);
+	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchtopic__uid" ON "searchtopic"("uid")');
+	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchtopic__cid" ON "searchtopic"("cid")');
+	await db.pool.query('CREATE TABLE IF NOT EXISTS "searchpost" ( "id" BIGINT NOT NULL PRIMARY KEY, "content" TEXT, "uid" BIGINT, "cid" BIGINT )');
+	await db.pool.query(`CREATE INDEX IF NOT EXISTS "idx__searchpost__content" ON "searchpost" USING GIN (to_tsvector('${searchLanguage}', "content"))`);
+	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchpost__uid" ON "searchpost"("uid")');
+	await db.pool.query('CREATE INDEX IF NOT EXISTS "idx__searchpost__cid" ON "searchpost"("cid")');
+}
+
+async function handleError(err) {
+	if (err && err.code === '42P01') {
+		winston.warn('dbsearch was not initialized');
+		await initDB();
+		return;
+	}
+
+	throw err;
+}
+
+exports.createIndices = async function (language) {
+	searchLanguage = language;
+	if (nconf.get('isPrimary') && !nconf.get('jobsDisabled')) {
+		await initDB();
+	}
+};
+
+exports.changeIndexLanguage = async function (language) {
+	searchLanguage = language;
+	pubsub.publish('dbsearch-language-changed', language);
+	await db.pool.query('DROP INDEX "idx__searchtopic__content"');
+	await db.pool.query(`CREATE INDEX "idx__searchtopic__content" ON "searchtopic" USING GIN (to_tsvector('${language}', "content"))`);
+	await db.pool.query('DROP INDEX "idx__searchpost__content"');
+	await db.pool.query(`CREATE INDEX "idx__searchpost__content" ON "searchpost" USING GIN (to_tsvector('${language}', "content"))`);
+};
+
+exports.searchIndex = async function (key, data, ids) {
+	if (!ids.length) {
+		return;
+	}
+
+	ids = ids.map(id => parseInt(id, 10));
+	try {
+		await db.pool.query({
+			name: `dbsearch-searchIndex-${key}`,
+			text: `INSERT INTO "search${key}" SELECT d."id", d."data"->>'content' "content", (d."data"->>'uid')::bigint "uid", (d."data"->>'cid')::bigint "cid" FROM UNNEST($1::bigint[], $2::jsonb[]) d("id", "data") ON CONFLICT ("id") DO UPDATE SET "content" = COALESCE(EXCLUDED."content", "search${key}"."content"), "uid" = COALESCE(EXCLUDED."uid", "search${key}"."uid"), "cid" = COALESCE(EXCLUDED."cid", "search${key}"."cid")`,
+			values: [ids, data],
+		});
+	} catch (err) {
+		winston.error(`Error indexing ${err.stack}`);
+		await handleError(err);
+		await exports.searchIndex(key, data, ids);
+	}
+};
+
+exports.search = async function (key, data, limit) {
+	if (Array.isArray(data.uid) && data.uid.filter(Boolean).length) {
+		data.uid = data.uid.filter(Boolean);
+	} else {
+		data.uid = null;
+	}
+
+	if (Array.isArray(data.cid) && data.cid.filter(Boolean).length) {
+		data.cid = data.cid.filter(Boolean);
+	} else {
+		data.cid = null;
+	}
+	try {
+		const res = await db.pool.query({
+			name: `dbsearch-search-${key}`,
+			text: `SELECT ARRAY(SELECT s."id" FROM "search${key}" s WHERE ($1::text IS NULL OR to_tsvector($5::regconfig, "content") @@ plainto_tsquery($5::regconfig, $1::text)) AND ($2::bigint[] IS NULL OR "uid" = ANY($2::bigint[])) AND ($3::bigint[] IS NULL OR "cid" = ANY($3::bigint[])) ORDER BY ts_rank_cd(to_tsvector($5::regconfig, "content"), plainto_tsquery($5::regconfig, $1::text)) DESC, s."id" ASC LIMIT $4::integer) r`,
+			values: [data.content, data.uid, data.cid, parseInt(limit, 10), searchLanguage],
+		});
+		return res.rows[0].r;
+	} catch (err) {
+		await handleError(err);
+		return [];
+	}
+};
+
+exports.searchRemove = async function (key, ids) {
+	if (!key || !ids.length) {
+		return;
+	}
+
+	ids = ids.map(id => parseInt(id, 10));
+	try {
+		await db.pool.query({
+			name: `dbsearch-searchRemove-${key}`,
+			text: `DELETE FROM "search${key}" s WHERE s."id" = ANY($1::bigint[])`,
+			values: [ids],
+		});
+	} catch (err) {
+		await handleError(err);
+	}
+};

package/lib/redis.js

@@ -1,52 +1,52 @@
-'use strict';
-
-const util = require('util');
-const redisSearch = require('redisearch');
-const async = require.main.require('async');
-
-const db = require.main.require('./src/database');
-
-exports.createIndices = async function () {
-	db.postSearch = redisSearch.createSearch('nodebbpostsearch', db.client);
-	db.topicSearch = redisSearch.createSearch('nodebbtopicsearch', db.client);
-};
-
-exports.changeIndexLanguage = async function () {
-	// not supported
-};
-
-exports.searchIndex = async function (key, data, ids) {
-	const method = key === 'post' ? db.postSearch : db.topicSearch;
-
-	const indexData = ids.map((id, index) => ({ id: id, data: data[index] }));
-
-	await async.eachLimit(indexData, 500, async function (indexData) {
-		await method.index(indexData.data, indexData.id);
-	});
-};
-
-exports.search = async function (key, data, limit) {
-	const queryMethod = key === 'post' ? db.postSearch : db.topicSearch;
-
-	const query = {
-		matchWords: data.matchWords,
-		query: {
-			cid: data.cid,
-			uid: data.uid,
-			content: data.content,
-		},
-	};
-
-	return await queryMethod.query(query, 0, limit - 1);
-};
-
-exports.searchRemove = async function (key, ids) {
-	if (!key || !ids.length) {
-		return;
-	}
-	var method = key === 'post' ? db.postSearch : db.topicSearch;
-
-	await async.eachLimit(ids, 500, async function (ids) {
-		await method.remove(ids);
-	});
-};
+'use strict';
+
+const redisSearch = require('redisearch');
+
+const async = require.main.require('async');
+
+const db = require.main.require('./src/database');
+
+exports.createIndices = async function () {
+	db.postSearch = redisSearch.createSearch('nodebbpostsearch', db.client);
+	db.topicSearch = redisSearch.createSearch('nodebbtopicsearch', db.client);
+};
+
+exports.changeIndexLanguage = async function () {
+	// not supported
+};
+
+exports.searchIndex = async function (key, data, ids) {
+	const method = key === 'post' ? db.postSearch : db.topicSearch;
+
+	const indexData = ids.map((id, index) => ({ id: id, data: data[index] }));
+
+	await async.eachLimit(indexData, 500, async (indexData) => {
+		await method.index(indexData.data, indexData.id);
+	});
+};
+
+exports.search = async function (key, data, limit) {
+	const queryMethod = key === 'post' ? db.postSearch : db.topicSearch;
+
+	const query = {
+		matchWords: data.matchWords,
+		query: {
+			cid: data.cid,
+			uid: data.uid,
+			content: data.content,
+		},
+	};
+
+	return await queryMethod.query(query, 0, limit - 1);
+};
+
+exports.searchRemove = async function (key, ids) {
+	if (!key || !ids.length) {
+		return;
+	}
+	const method = key === 'post' ? db.postSearch : db.topicSearch;
+
+	await async.eachLimit(ids, 500, async (ids) => {
+		await method.remove(ids);
+	});
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodebb-plugin-dbsearch",
-  "version": "5.0.3",
+  "version": "5.1.1",
   "description": "A Plugin that lets users search posts and topics",
   "main": "index.js",
   "repository": {
@@ -22,11 +22,11 @@
     "redisearch": "^1.0.0"
   },
   "devDependencies": {
-    "eslint": "5.9.0",
-    "eslint-config-airbnb-base": "13.1.0",
-    "eslint-plugin-import": "2.14.0"
+    "eslint": "7.32.0",
+    "eslint-config-nodebb": "0.0.3",
+    "eslint-plugin-import": "2.25.2"
   },
   "nbbpm": {
-    "compatibility": "^1.15.3"
+    "compatibility": "^1.18.6"
   }
 }

package/plugin.json

@@ -4,9 +4,6 @@
     "description": "A Plugin that lets users search posts and topics",
     "url": "https://github.com/barisusakli/nodebb-plugin-dbsearch",
     "library": "./index.js",
-    "staticDirs": {
-        "dbsearch": "public"
-    },
     "upgrades": [
         "upgrades/dbsearch_change_mongodb_schema.js"
     ],
@@ -34,7 +31,7 @@
         { "hook": "filter:topic.search", "method": "filterSearchTopic" }
     ],
     "acpScripts": [
-        "lib/admin.js"
+        "public/admin.js"
     ],
-    "templates": "./public/templates"
+    "templates": "./templates"
 }

package/public/.eslintrc

@@ -0,0 +1,3 @@
+{
+	"extends": "nodebb/public"
+}