@jasonwch/nodebb-plugin-meilisearch-r 1.1.1 → 1.2.0

package/lib/client.js

@@ -0,0 +1,445 @@
+'use strict';
+
+const winston = nodebb.require('winston');
+const settings = nodebb.require('./src/meta/settings');
+const Topics = nodebb.require('./src/topics');
+const { drainPending } = require('./pending-queue');
+const {
+	EMBEDDER_NAME, buildEmbedderConfig, validateEmbedderConfig, deepEqual,
+	getAppliedConfig, getAppliedTaskUid, setAppliedConfigs, clearAppliedConfig,
+} = require('./embedder');
+const {
+	EMBEDDER_TASK_TIMEOUT_MS, EMBEDDER_TASK_BG_TIMEOUT_MS, EMBEDDER_TASK_BG_INTERVAL_MS,
+	MEILI_HTTP_TIMEOUT_MS,
+} = require('./constants');
+
+async function ensureIndex(plugin, uid, primaryKey) {
+	try {
+		await plugin.client.getIndex(uid);
+	} catch (e) {
+		await plugin.client.createIndex(uid, { primaryKey });
+	}
+}
+
+// Meilisearch settings/document mutations are enqueued tasks - the initial call resolving
+// just means Meilisearch accepted the request, not that it succeeded. waitForTask() itself
+// only ever throws on ITS OWN polling timeout (confirmed against the installed
+// meilisearch-js's TaskClient#waitForTask, node_modules/meilisearch/dist/index.js): a task
+// that fails on the server resolves normally with status "failed" and an `error` object, so
+// callers that don't check `.status` (as every waitForTask call in this plugin used to)
+// silently treat a failed settings/document change as if it had gone through.
+async function waitForSucceededTask(plugin, taskUidOrTask, options) {
+	const task = await plugin.client.tasks.waitForTask(taskUidOrTask, options);
+	if (task.status !== 'succeeded') {
+		throw new Error(task.error?.message || `Meilisearch task ${task.status}`);
+	}
+	return task;
+}
+
+// Module-level tracker for in-flight embedder background pollers. Keyed by taskUid so the
+// same task can't be polled twice (e.g. if updateEmbedders is somehow re-entered during
+// the 60s sync wait). Cleared on terminal status (success or failure) by the poller itself.
+const embedderPollers = new Set();
+
+// Background-verify an embedder task that exceeded the sync wait window. Per the Meilisearch
+// SDK (node_modules/meilisearch/dist/index.js:152), a poll timeout throws
+// MeilisearchTaskTimeOutError — task is still running server-side. Re-embedding every
+// document legitimately exceeds 60s on a forum of any size; the task may yet succeed.
+// Strategy: poll at a longer interval with a longer timeout; alert only on delayed failure.
+// On delayed success: update the persisted taskUid to null (sync-verified) so reattachPollers
+//   skips it on future restarts instead of hitting a 404 when Meilisearch purges task history.
+// On delayed failure: revert the optimistic fingerprint via clearAppliedConfig so the next
+//   save pushes fresh config, alert admins, flip plugin.healthy=false to defer subsequent
+//   writes to the pending queue.
+// On poll timeout (MeilisearchTaskTimeOutError): task is STILL RUNNING — do NOT clear the
+//   fingerprint (would re-open the double-paid-API-cost loop). Log and let the task continue
+//   server-side; if it ultimately fails, the next restart's reattachPollers will catch it.
+// On network error: task status is genuinely unknown — log warning but do NOT clear, since
+//   clearing on a transient blip would cause an unnecessary re-push. reattachPollers catches
+//   actual failures on the next restart.
+function startEmbedderPoller(plugin, plan, taskUid) {
+	if (embedderPollers.has(taskUid)) return;
+	embedderPollers.add(taskUid);
+	const startTime = Date.now();
+	const poll = async () => {
+		try {
+			const task = await plugin.client.tasks.waitForTask(taskUid, {
+				timeout: EMBEDDER_TASK_BG_TIMEOUT_MS,
+				interval: EMBEDDER_TASK_BG_INTERVAL_MS,
+			});
+			embedderPollers.delete(taskUid);
+			if (task.status !== 'succeeded') {
+				// Delayed failure: fingerprint was optimistically persisted at enqueue time
+				// (see plugin.updateEmbedders catch-block). Clear it so the next save pushes
+				// fresh config rather than silently skipping as "already applied".
+				await clearAppliedConfig(plugin, plan.indexName);
+				plugin.healthy = false;
+				plugin.notifyAdmins(`embedder:${plan.indexName}`, {
+					type: 'danger',
+					titleKey: '[[meilisearch:admin.semanticEmbedderDelayedFailed]]',
+					message: `${plan.indexName}: ${task.error?.message || `task ${task.status}`}`,
+				});
+			} else {
+				// Delayed success: mark taskUid as null (sync-verified) so reattachPollers
+				// skips this index on future restarts instead of hitting a 404 when Meilisearch
+				// purges task history (~24h). Fingerprint config is already correct — no change.
+				winston.info(`[plugin/meilisearch] Embedder task for "${plan.indexName}" succeeded after ${Date.now() - startTime}ms (background-poll)`);
+				await setAppliedConfigs(plugin, [{ indexName: plan.indexName, config: plan.config, taskUid: null }]);
+			}
+		} catch (err) {
+			embedderPollers.delete(taskUid);
+			if (err.name === 'MeilisearchTaskTimeOutError') {
+				// Poller's own 30-min timeout fired — task is STILL RUNNING server-side.
+				// Do NOT clear the fingerprint: that would make the next save re-push identical
+				// config, re-opening the double-paid-API-cost loop this whole mechanism prevents.
+				// The task will eventually succeed or fail; if NodeBB restarts before that,
+				// reattachPollers will pick it up via the persisted taskUid.
+				winston.warn(`[plugin/meilisearch] Embedder task ${taskUid} for "${plan.indexName}" still running after ${EMBEDDER_TASK_BG_TIMEOUT_MS}ms; giving up poll. Task continues server-side — reattachPollers will reconcile on next restart.`);
+				return;
+			}
+			// Network error or other non-timeout failure — task status is genuinely unknown.
+			// Don't clear the fingerprint on a transient blip (would cause unnecessary re-push).
+			// If the task actually failed, reattachPollers will catch it on the next restart
+			// via the persisted taskUid → getTask(uid) → status: "failed" → clearAppliedConfig.
+			winston.warn(`[plugin/meilisearch] Embedder poller for "${plan.indexName}" (task ${taskUid}) hit an error (non-fatal, fingerprint preserved): ${err.message}`);
+		}
+	};
+	poll().catch(err => winston.error(`[plugin/meilisearch] embedder poller crashed: ${err.message}`));
+}
+
+// Recover embedder pollers after process restart. embedderPollers (line 42) is module-level
+// in-memory; a NodeBB restart/crash/container-redeploy during the 30-min background-poller
+// window (EMBEDDER_TASK_BG_TIMEOUT_MS) wipes it. This sweep reads the persisted taskUid
+// (stored alongside each fingerprint in appliedEmbedders via setAppliedConfigs) and
+// reconciles directly via plugin.client.tasks.getTask(uid):
+//   succeeded → no-op (fingerprint correct, taskUid was null from sync-success path)
+//   enqueued/processing → reattach startEmbedderPoller (task still running server-side)
+//   failed → clearAppliedConfig + alert (Scenario A: task failed during downtime)
+//   404/network error → assume success, log warning (self-heals on next config change)
+// For old-format fingerprints (no taskUid), falls through to query-based sweep as fallback.
+async function reattachPollers(plugin) {
+	if (!plugin.client) return;
+	const ourIndexes = ['post', 'topic', 'chat_message'];
+	// Phase 1: Direct reconciliation via persisted taskUid (new-format fingerprints)
+	for (const indexName of ourIndexes) {
+		try {
+			const taskUid = await getAppliedTaskUid(plugin, indexName);
+			if (taskUid === undefined || taskUid === null) continue;
+			const task = await plugin.client.tasks.getTask(taskUid);
+			if (task.status === 'succeeded') continue;
+			if (task.status === 'enqueued' || task.status === 'processing') {
+				if (embedderPollers.has(taskUid)) continue;
+				const config = await buildEmbedderConfig(plugin, null, indexName);
+				winston.info(`[plugin/meilisearch] Reattaching embedder poller for "${indexName}" (task ${taskUid} still ${task.status})`);
+				startEmbedderPoller(plugin, { indexName, config }, taskUid);
+				continue;
+			}
+			// Task failed during downtime — clear stale fingerprint + alert
+			winston.warn(`[plugin/meilisearch] Embedder task ${taskUid} for "${indexName}" failed during downtime: ${task.error?.message || task.status}`);
+			await clearAppliedConfig(plugin, indexName);
+			plugin.healthy = false;
+			plugin.notifyAdmins(`embedder:${indexName}`, {
+				type: 'danger',
+				titleKey: '[[meilisearch:admin.semanticEmbedderDelayedFailed]]',
+				message: `${indexName}: ${task.error?.message || `task ${task.status}`}`,
+			});
+		} catch (err) {
+			// Non-fatal: taskUid may be 404 (purged from Meilisearch's ~24h history), or
+			// Meilisearch may be momentarily unreachable. Assume success — self-heals on next
+			// legitimate semantic-key change.
+			winston.warn(`[plugin/meilisearch] reattachPollers: could not reconcile taskUid for "${indexName}" (non-fatal): ${err.message}`);
+		}
+	}
+	// Phase 2: Query-based fallback for old-format fingerprints (no taskUid persisted).
+	// Catches in-flight embedder tasks that have a persisted fingerprint but no taskUid
+	// (pre-Option-1 format). Will be a no-op once all fingerprints are migrated to new format.
+	try {
+		const tasksResp = await plugin.client.tasks.getTasks({
+			statuses: ['enqueued', 'processing'],
+			types: ['settingsUpdate'],
+			limit: 50,
+		});
+		const candidates = [];
+		for (const t of (tasksResp.results || [])) {
+			if (!ourIndexes.includes(t.indexUid)) continue;
+			if (embedderPollers.has(t.uid)) continue;
+			if (!(t.details && t.details.embedders)) continue;
+			const tu = await getAppliedTaskUid(plugin, t.indexUid);
+			if (tu !== undefined) continue;  // new-format fingerprint — already reconciled in Phase 1
+			candidates.push(t);
+		}
+		if (!candidates.length) return;
+		winston.info(`[plugin/meilisearch] Query fallback: reattaching ${candidates.length} embedder poller(s) for old-format fingerprints`);
+		for (const task of candidates) {
+			const applied = await getAppliedConfig(plugin, task.indexUid);
+			if (applied === undefined) continue;
+			const config = await buildEmbedderConfig(plugin, null, task.indexUid);
+			startEmbedderPoller(plugin, { indexName: task.indexUid, config }, task.uid);
+		}
+	} catch (err) {
+		winston.warn(`[plugin/meilisearch] reattachPollers query fallback failed (non-fatal): ${err.message}`);
+	}
+}
+
+// MeiliSearch connection lifecycle: connecting, health checks, and index/settings sync.
+module.exports = function attachClient(plugin) {
+	plugin.patchTopicsSearch = function () {
+		if (Topics.__meiliOriginalSearch) { return; }
+		Topics.__meiliOriginalSearch = Topics.search;
+		Topics.search = async function (tid, term) {
+			if (!tid || !term || !String(term).trim()) { return []; }
+			return Topics.__meiliOriginalSearch.call(Topics, tid, term);
+		};
+	};
+
+	plugin.checkHealth = async function () {
+		try {
+			plugin.healthy = await plugin.client.isHealthy();
+			if (!plugin.healthy) {
+				winston.warn('[plugin/meilisearch] MeiliSearch host is unhealthy');
+			} else {
+				drainPending(plugin).catch(err => winston.error(`[plugin/meilisearch] drain failed: ${err.message}`));
+			}
+			return plugin.healthy;
+		} catch (err) {
+			plugin.healthy = false;
+			winston.warn(`[plugin/meilisearch] ${err.message}`);
+			return false;
+		}
+	};
+
+	// Ensure the chat_message index + filterable attributes exist, independent of reindex state.
+	// prepareSearch() returns early when `indexed=true`, so updateIndexSettings (which configures
+	// chat_message) is skipped on normal restarts — but indexMessage auto-creates the index via
+	// document add, leaving filterableAttributes empty. Without roomId/uid filterable, searchMessages
+	// would error on its filter clause. Idempotent + cheap (2 calls, settings deduped by Meilisearch).
+	plugin.ensureChatMessageIndex = async function () {
+		if (!plugin.client) return;
+		try {
+			await ensureIndex(plugin, 'chat_message', 'mid');
+			await plugin.client.index('chat_message').updateFilterableAttributes(['roomId', 'uid', 'timestamp']);
+		} catch (err) {
+			winston.error(`[plugin/meilisearch] ensureChatMessageIndex failed: ${err.message}`);
+			plugin.healthy = false;
+		}
+	};
+
+	plugin.prepareSearch = async function (data, connectionChanged = false) {
+		winston.debug(`[plugin/meilisearch] Connecting to MeiliSearch host: ${data?.host || await settings.getOne(plugin.id, 'host')}`);
+		const { Meilisearch } = await import('meilisearch');
+		plugin.client = new Meilisearch({
+			host: data?.host || await settings.getOne(plugin.id, 'host'),
+			apiKey: data?.apiKey || await settings.getOne(plugin.id, 'apiKey') || undefined,
+			timeout: MEILI_HTTP_TIMEOUT_MS,
+		});
+		if (plugin.healthCheckTask) clearInterval(plugin.healthCheckTask);
+		const intervalRaw = parseInt(data?.healthCheckInterval || await settings.getOne(plugin.id, 'healthCheckInterval'), 10);
+		const intervalSeconds = Number.isFinite(intervalRaw) && intervalRaw > 0
+			? Math.min(Math.max(intervalRaw, 10), 3600)
+			: 60;
+		plugin.healthCheckTask = setInterval(plugin.checkHealth, intervalSeconds * 1000);
+		// #15: Always sync plugin.healthy on (re)connect — otherwise it stays false from
+		// initialization until the first setInterval tick, causing stale "MeiliSearch
+		// Unreachable" warnings on save during the startup window (MS online, flag stale).
+		await plugin.checkHealth();
+		// G1: Recover in-flight embedder pollers after process restart (runs once on startup,
+		// not on every health-check tick — the sweep is unnecessary after the first run since
+		// embedderPollers Set is populated and deduplicates subsequent calls).
+		reattachPollers(plugin).catch(err => winston.warn(`[plugin/meilisearch] reattachPollers failed: ${err.message}`));
+		// #14: Don't auto-reindex after a failed reindex unless connection settings changed.
+		const indexed = await settings.getOne(plugin.id, 'indexed');
+		if (indexed) return;
+		if (!plugin.healthy || plugin.initializingOnAnotherInstance) return;
+		const lastResult = await settings.getOne(plugin.id, 'lastReindexResult') || {};
+		const allowAutoReindex = connectionChanged || lastResult.success !== false;
+		if (!allowAutoReindex) {
+			winston.warn('[plugin/meilisearch] Skipping auto-reindex: last reindex failed. Trigger manually from ACP.');
+			return;
+		}
+		await plugin.updateIndexSettings();
+		await plugin.updateEmbedders();
+		await plugin.reindex(false);
+	};
+
+	// Keyword-search index settings only (ranking rules, stop words, typo tolerance,
+	// synonyms, pagination). Deliberately does NOT touch embedders - see updateEmbedders
+	// below for why that has to stay a separate, independently-gated call.
+	plugin.updateIndexSettings = async (data) => {
+		await ensureIndex(plugin, 'post', 'pid');
+		await ensureIndex(plugin, 'topic', 'tid');
+		await ensureIndex(plugin, 'chat_message', 'mid');
+		data = {
+			maxDocuments: parseInt(data?.maxDocuments || await settings.getOne(plugin.id, 'maxDocuments') || 500, 10),
+			rankingRules: (data?.rankingRules || await settings.getOne(plugin.id, 'rankingRules'))?.map(value => value.rule),
+			stopWords: (data?.stopWords || await settings.getOne(plugin.id, 'stopWords'))?.map(value => value.word),
+			typoTolerance: ['on', true].includes(
+				data?.typoTolerance || await settings.getOne(plugin.id, 'typoTolerance') || undefined,
+			),
+			typoToleranceMinWordSizeOneTypo: parseInt(
+				data?.typoToleranceMinWordSizeOneTypo ||
+					await settings.getOne(plugin.id, 'typoToleranceMinWordSizeOneTypo') || 5,
+				10,
+			),
+			typoToleranceMinWordSizeTwoTypos: parseInt(
+				data?.typoToleranceMinWordSizeTwoTypos ||
+					await settings.getOne(plugin.id, 'typoToleranceMinWordSizeTwoTypos') || 9,
+				10,
+			),
+			typoToleranceDisableOnWords:
+				(data?.typoToleranceDisableOnWords || await settings.getOne(plugin.id, 'typoToleranceDisableOnWords') ||
+					undefined)?.map(value => value.word),
+			synonyms: Object.fromEntries(
+				(data?.synonyms || await settings.getOne(plugin.id, 'synonyms') || [])?.map((
+					{ word, synonyms },
+				) => [word, synonyms?.split(',').map(synonym => synonym.trim())]),
+			),
+		};
+		const postTask = await plugin.client.index('post').updateSettings({
+			filterableAttributes: ['tid', 'cid', 'uid', 'timestamp'],
+			sortableAttributes: ['timestamp', 'cid'],
+			searchableAttributes: ['content'],
+			pagination: {
+				maxTotalHits: data.maxDocuments,
+			},
+			rankingRules: data.rankingRules,
+			stopWords: data.stopWords,
+			typoTolerance: {
+				enabled: data.typoTolerance,
+				minWordSizeForTypos: {
+					oneTypo: data.typoToleranceMinWordSizeOneTypo,
+					twoTypos: data.typoToleranceMinWordSizeTwoTypos,
+				},
+				disableOnWords: data.typoToleranceDisableOnWords,
+			},
+			synonyms: data.synonyms,
+		});
+		const topicTask = await plugin.client.index('topic').updateSettings({
+			filterableAttributes: ['cid', 'uid', 'timestamp'],
+			sortableAttributes: ['cid', 'title', 'timestamp'],
+			searchableAttributes: ['title'],
+			pagination: {
+				maxTotalHits: data.maxDocuments,
+			},
+			rankingRules: data.rankingRules,
+			stopWords: data.stopWords,
+			typoTolerance: {
+				enabled: data.typoTolerance,
+				minWordSizeForTypos: {
+					oneTypo: data.typoToleranceMinWordSizeOneTypo,
+					twoTypos: data.typoToleranceMinWordSizeTwoTypos,
+				},
+				disableOnWords: data.typoToleranceDisableOnWords,
+			},
+			synonyms: data.synonyms,
+		});
+		const messageTask = await plugin.client.index('chat_message').updateSettings({
+			filterableAttributes: ['roomId', 'uid', 'timestamp'],
+			sortableAttributes: ['timestamp'],
+			searchableAttributes: ['content'],
+			pagination: {
+				maxTotalHits: data.maxDocuments,
+			},
+			rankingRules: data.rankingRules,
+			stopWords: data.stopWords,
+			typoTolerance: {
+				enabled: data.typoTolerance,
+				minWordSizeForTypos: {
+					oneTypo: data.typoToleranceMinWordSizeOneTypo,
+					twoTypos: data.typoToleranceMinWordSizeTwoTypos,
+				},
+				disableOnWords: data.typoToleranceDisableOnWords,
+			},
+			synonyms: data.synonyms,
+		});
+		return [postTask, topicTask, messageTask];
+	};
+
+	// Pushes (or removes) the "default" embedder on all three indexes based on the
+	// semantic search ACP settings. Meilisearch re-embeds every existing document
+	// through the (often paid) embedding API whenever an index's embedder config
+	// actually changes, so this is intentionally its own call rather than something
+	// updateIndexSettings does automatically - it must only run when semantic settings
+	// were deliberately changed (see lib/settings.js), or as part of an explicit
+	// reindex/connect flow, never as a side effect of unrelated settings (ranking rules,
+	// stop words, ...) being saved. Skips the network call entirely when the resolved
+	// config is identical to what was last pushed, as a second line of defense against
+	// needless re-embedding regardless of caller. Older/self-hosted Meilisearch instances
+	// without embedder support will reject the call; that's caught here so it never
+	// blocks the rest of the settings-save flow.
+	plugin.updateEmbedders = async (rawData) => {
+		// Pre-flight validation: fail fast with an admin-facing alert instead of letting
+		// Meilisearch reject the task server-side (which can take up to 60s on slow/unreachable
+		// embedding endpoints, leaving the ACP Save button stuck). Client-side validation in
+		// static/lib/admin.js is the primary UX path; this is defense-in-depth for reindex,
+		// prepareSearch-on-host-change, and any programmatic caller.
+		const validationError = await validateEmbedderConfig(plugin, rawData);
+		if (validationError) {
+			winston.warn(`[plugin/meilisearch] Embedder config validation failed: ${validationError}`);
+			plugin.notifyAdmins('embedder:validation', {
+				type: 'danger',
+				titleKey: '[[meilisearch:admin.semanticConfigInvalid]]',
+				message: validationError,
+			});
+			return;  // no fingerprint persisted, no task enqueued, save proceeds immediately
+		}
+		const indexNames = ['post', 'topic', 'chat_message'];
+		// Resolve configs + diff-against-applied first (read-only), THEN push and persist -
+		// keeps the three indexes from racing on the same shared "applied" bookkeeping object
+		// (parallel read-modify-write on one settings key would let one index's write silently
+		// clobber another's).
+		const plans = await Promise.all(indexNames.map(async (indexName) => {
+			const config = await buildEmbedderConfig(plugin, rawData, indexName);
+			const applied = await getAppliedConfig(plugin, indexName);
+			return { indexName, config, needsPush: applied === undefined || !deepEqual(config, applied) };
+		}));
+		const results = await Promise.all(plans.map(async (plan) => {
+			if (!plan.needsPush) return null;
+			try {
+				// updateEmbedders() only enqueues a Meilisearch task - a bad URL/model/response
+				// shape for "rest"/"openAi"-with-custom-url configs only surfaces once Meilisearch
+				// actually runs the task (e.g. its probe call to auto-detect dimensions), so this
+				// must wait for and check the task's real outcome, not just the enqueue response.
+				const enqueued = await plugin.client.index(plan.indexName).updateEmbedders({ [EMBEDDER_NAME]: plan.config });
+				try {
+					await waitForSucceededTask(plugin, enqueued.taskUid, {
+						timeout: EMBEDDER_TASK_TIMEOUT_MS,
+						interval: 200,
+					});
+				} catch (err) {
+					// Distinguish "task is still running" (poll timeout) from "task definitively failed"
+					// (Meili rejected the call, 4xx, malformed config, network error). Meilisearch SDK
+					// throws MeilisearchTaskTimeOutError (name property, see node_modules/meilisearch/dist/index.js:152)
+					// on poll timeout; this means the task is still running server-side and may yet succeed.
+					if (err.name === 'MeilisearchTaskTimeOutError') {
+						// Re-embedding every document legitimately exceeds 60s on a forum of any size.
+						// Optimistically persist the fingerprint so the next ACP save doesn't re-push
+						// identical config (which would double paid-API cost — the exact thing we're
+						// preventing). startEmbedderPoller verifies the real outcome.
+						winston.warn(`[plugin/meilisearch] Embedder task for "${plan.indexName}" still running after ${EMBEDDER_TASK_TIMEOUT_MS}ms; background-polling.`);
+						startEmbedderPoller(plugin, plan, enqueued.taskUid);
+						return { ...plan, taskUid: enqueued.taskUid };  // optimistic — taskUid for later reconciliation
+					}
+					throw err;  // real failure — outer catch handles alerting + return null
+				}
+				return { ...plan, taskUid: null };  // sync-verified success — no reconciliation needed
+			} catch (err) {
+				const reason = err.message;
+				winston.error(`[plugin/meilisearch] Failed to apply "${plan.indexName}" embedder (semantic search): ${reason}`);
+				plugin.notifyAdmins(`embedder:${plan.indexName}`, {
+					type: 'danger',
+					titleKey: '[[meilisearch:admin.semanticEmbedderFailed]]',
+					message: `${plan.indexName}: ${reason}`,
+				});
+				return null;
+			}
+		}));
+		const succeeded = results.filter(Boolean);
+		if (succeeded.length) {
+			await setAppliedConfigs(plugin, succeeded);
+		}
+	};
+};
+
+// Exposed so other call sites that enqueue Meilisearch tasks (lib/reindex.js) get the same
+// "actually check the task succeeded" behavior instead of trusting waitForTask() to throw.
+module.exports.waitForSucceededTask = waitForSucceededTask;

package/lib/constants.js

@@ -0,0 +1,42 @@
+'use strict';
+
+module.exports = {
+	REINDEX_BATCH_SIZE: 500,
+	PENDING_KEY: 'plugin:meilisearch:pending',
+	PENDING_MAX: 100000,
+	DRAIN_MAX: 500,
+	REINDEX_LOCK_KEY: 'plugin:meilisearch:reindex:lock',
+	REINDEX_LOCK_TTL: 3600,
+	LOCK_REFRESH_INTERVAL: 5 * 60 * 1000,
+	REPLAY_OPS: [
+		'indexPost', 'deindexPost', 'indexTopic', 'deindexTopic', 'deindexPostsPurge',
+		'deindexTopicsPurge', 'reindexTopicPosts', 'deindexTopicPosts', 'restoreTopic',
+		'changePostOwner', 'changeTopicOwner', 'onTopicMerge', 'onScheduledPublish',
+		'indexMessage', 'deindexMessage',
+	],
+	GLOBAL_CHAT_SEARCH_LIMIT: 200,
+	GLOBAL_CHAT_SEARCH_FETCH: 300,
+	MEMBERSHIP_CHUNK_SIZE: 100,
+	DECORATION_BATCH_SIZE: 10,
+	// Sync wait window for plugin.updateEmbedders' Meilisearch task before falling back to
+	// background poller. 60s keeps ACP save responsive; if the embedder task is still
+	// running server-side (re-embedding every doc legitimately exceeds 60s on a forum of
+	// any size), updateEmbedders persists the fingerprint optimistically and startEmbedderPoller
+	// verifies the eventual outcome.
+	EMBEDDER_TASK_TIMEOUT_MS: 60000,
+	// Background poller ceiling (60 min) and interval (5 s) for verifying embedder tasks
+	// that exceeded the sync wait window. 60 min covers re-embedding up to ~1M posts at
+	// OpenAI Tier 1 rate limits (1M TPM). For forums larger than that, the poller gives up
+	// and relies on reattachPollers to reconcile the task outcome on the next restart
+	// (within Meilisearch's ~24h task retention window). No double-paid-API-cost risk —
+	// fingerprint is preserved, not cleared, on poller timeout (see startEmbedderPoller
+	// MeilisearchTaskTimeOutError handling in lib/client.js).
+	EMBEDDER_TASK_BG_TIMEOUT_MS: 3600000,
+	EMBEDDER_TASK_BG_INTERVAL_MS: 5000,
+	// Meilisearch SDK client-side HTTP timeout. Caps every fetch() the SDK makes (including
+	// the initial enqueue POST for embedder tasks) at 30s — without this, the SDK uses no
+	// AbortSignal (node_modules/meilisearch/dist/index.js:340), so an unreachable Meilisearch
+	// host can leave plugin.updateEmbedders (and therefore the ACP Save button) stuck
+	// indefinitely.
+	MEILI_HTTP_TIMEOUT_MS: 30000,
+};

package/lib/defaults.js

@@ -0,0 +1,73 @@
+'use strict';
+
+const defaults = {
+	host: 'http://localhost:7700',
+	apiKey: undefined,
+	maxDocuments: undefined,
+	indexed: false,
+	rankingRules: [
+		{ rule: 'words' },
+		{ rule: 'typo' },
+		{ rule: 'proximity' },
+		{ rule: 'attribute' },
+		{ rule: 'sort' },
+		{ rule: 'exactness' },
+	],
+	stopWords: [],
+	typoTolerance: 'on',
+	typoToleranceMinWordSizeOneTypo: 5,
+	typoToleranceMinWordSizeTwoTypos: 9,
+	typoToleranceDisableOnWords: [],
+	synonyms: [],
+	healthCheckInterval: 60,
+	searchMinTermLength: 2,
+	globalChatSearchEnabled: 'on',
+	semanticSearchEnabled: 'off',
+	semanticSearchProvider: 'openAi',
+	semanticSearchApiKey: undefined,
+	semanticSearchModel: undefined,
+	semanticSearchUrl: undefined,
+	semanticSearchDimensions: undefined,
+	semanticSearchRatio: 0.5,
+	semanticSearchScoreThreshold: 0.2,
+	semanticSearchRestRequest: undefined,
+	semanticSearchRestResponse: undefined,
+	// Internal bookkeeping (not an ACP field): last embedder config actually pushed to
+	// Meilisearch per index, so unrelated settings saves can't re-trigger paid re-embedding.
+	appliedEmbedders: {},
+	lastReindexResult: {
+		success: false,
+		finishedAt: null,
+		topic_progress: { current: null, total: null },
+		post_progress: { current: null, total: null },
+		message_progress: { current: null, total: null },
+		skippedDeletedTopics: 0,
+		skippedDeletedPosts: 0,
+		skippedDeletedMessages: 0,
+		skippedSystemMessages: 0,
+		skippedOrphanMessages: 0,
+		error: null,
+	},
+};
+
+const breakingSettings = [
+	'maxDocuments',
+	'rankingRules',
+	'stopWords',
+	'typoTolerance',
+	'typoToleranceMinWordSizeOneTypo',
+	'typoToleranceMinWordSizeTwoTypos',
+	'typoToleranceDisableOnWords',
+	'typoToleranceDisableOnAttributes',
+	'synonyms',
+	'semanticSearchEnabled',
+	'semanticSearchProvider',
+	'semanticSearchApiKey',
+	'semanticSearchModel',
+	'semanticSearchUrl',
+	'semanticSearchDimensions',
+	'semanticSearchRestRequest',
+	'semanticSearchRestResponse',
+];
+
+module.exports = { defaults, breakingSettings };