fix(*): truncate autocomplete names and use central constant

discordjs · Dec 17, 2024 · 4269150 · 4269150
1 parent 67727fa
commit 4269150
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 11 deletions.
diff --git a/src/functions/autocomplete/algoliaAutoComplete.ts b/src/functions/autocomplete/algoliaAutoComplete.ts
@@ -5,7 +5,7 @@ import type { Response } from 'polka';
 import { fetch } from 'undici';
 import type { AlgoliaHit, AlgoliaSearchResult } from '../../types/algolia.js';
 import { compactAlgoliaObjectId } from '../../util/compactAlgoliaId.js';
-import { API_BASE_ALGOLIA, AUTOCOMPLETE_MAX_ITEMS } from '../../util/constants.js';
+import { API_BASE_ALGOLIA, AUTOCOMPLETE_MAX_ITEMS, AUTOCOMPLETE_MAX_NAME_LENGTH } from '../../util/constants.js';
 import { dedupeAlgoliaHits } from '../../util/dedupe.js';
 import { prepareHeader } from '../../util/respond.js';
 import { truncate } from '../../util/truncate.js';
@@ -54,10 +54,10 @@ function autoCompleteMap(elements: AlgoliaHit[]) {
 		.filter((element) => {
 			const value = compactAlgoliaObjectId(element.objectID);
 			// API restriction. Cannot resolve from truncated, so filtering here.
-			return value.length <= 100;
+			return value.length <= AUTOCOMPLETE_MAX_NAME_LENGTH;
 		})
 		.map((element) => ({
-			name: truncate(resolveHitToNamestring(element), 100, ''),
+			name: truncate(resolveHitToNamestring(element), AUTOCOMPLETE_MAX_NAME_LENGTH, ''),
 			value: compactAlgoliaObjectId(element.objectID),
 		}));
 }

diff --git a/src/functions/autocomplete/docsAutoComplete.ts b/src/functions/autocomplete/docsAutoComplete.ts
@@ -5,7 +5,7 @@ import type {
 } from 'discord-api-types/v10';
 import { ApplicationCommandOptionType, InteractionResponseType } from 'discord-api-types/v10';
 import type { Response } from 'polka';
-import { AUTOCOMPLETE_MAX_ITEMS, DJS_QUERY_SEPARATOR } from '../../util/constants.js';
+import { AUTOCOMPLETE_MAX_ITEMS, AUTOCOMPLETE_MAX_NAME_LENGTH, DJS_QUERY_SEPARATOR } from '../../util/constants.js';
 import { getCurrentMainPackageVersion, getDjsVersions } from '../../util/djsdocs.js';
 import { truncate } from '../../util/truncate.js';
 
@@ -169,7 +169,7 @@ export async function djsMeiliSearch(query: string, version: string) {
 	});
 
 	const docsResult = (await searchResult.json()) as any;
-	const hits = docsResult.results.flatMap((res: any) => res.hits).sort((one: any, other: any) => one.id - other.id);
+	const hits = docsResult.results.flatMap((res: any) => res.hits);
 
 	return {
 		...docsResult,
@@ -184,7 +184,11 @@ export async function djsMeiliSearch(query: string, version: string) {
 
 			return {
 				...hit,
-				autoCompleteName: truncate(`${hit.name}${hit.summary ? ` - ${sanitizeText(hit.summary)}` : ''}`, 100, ' '),
+				autoCompleteName: truncate(
+					`${hit.name}${hit.summary ? ` - ${sanitizeText(hit.summary)}` : ''}`,
+					AUTOCOMPLETE_MAX_NAME_LENGTH,
+					' ',
+				),
 				autoCompleteValue: parts.join(DJS_QUERY_SEPARATOR),
 				isMember,
 			};

diff --git a/src/functions/autocomplete/nodeAutoComplete.ts b/src/functions/autocomplete/nodeAutoComplete.ts
@@ -3,7 +3,7 @@ import { stringify } from 'node:querystring';
 import { InteractionResponseType } from 'discord-api-types/v10';
 import type { Response } from 'polka';
 import { fetch } from 'undici';
-import { API_BASE_ORAMA, AUTOCOMPLETE_MAX_ITEMS } from '../../util/constants.js';
+import { API_BASE_ORAMA, AUTOCOMPLETE_MAX_ITEMS, AUTOCOMPLETE_MAX_NAME_LENGTH } from '../../util/constants.js';
 import { prepareHeader } from '../../util/respond.js';
 import { truncate } from '../../util/truncate.js';
 
@@ -32,9 +32,9 @@ function autoCompleteMap(elements: OramaDocument[]) {
 	return elements.map((element) => {
 		const cleanSectionTitle = element.pageSectionTitle.replaceAll('`', '');
 		const name = truncate(`${element.pageTitle} > ${cleanSectionTitle}`, 90, '');
-		if (element.path.length > 100) {
+		if (element.path.length > AUTOCOMPLETE_MAX_NAME_LENGTH) {
 			return {
-				name: truncate(`[path too long] ${element.pageTitle} > ${cleanSectionTitle}`, 100, ''),
+				name: truncate(`[path too long] ${element.pageTitle} > ${cleanSectionTitle}`, AUTOCOMPLETE_MAX_NAME_LENGTH, ''),
 				value: element.pageTitle,
 			};
 		}

diff --git a/src/functions/node.ts b/src/functions/node.ts
@@ -9,7 +9,7 @@ import type { Response } from 'polka';
 import TurndownService from 'turndown';
 import { fetch } from 'undici';
 import type { NodeDocs } from '../types/NodeDocs.js';
-import { API_BASE_NODE, EMOJI_ID_NODE } from '../util/constants.js';
+import { API_BASE_NODE, AUTOCOMPLETE_MAX_NAME_LENGTH, EMOJI_ID_NODE } from '../util/constants.js';
 import { logger } from '../util/logger.js';
 import { prepareErrorResponse, prepareResponse } from '../util/respond.js';
 import { truncate } from '../util/truncate.js';
@@ -104,7 +104,7 @@ export async function nodeAutoCompleteResolve(res: Response, query: string, user
 
 	const text = paragraph.text().split('\n').join(' ');
 	const sentence = text.split(/[!.?](\s|$)/)?.[0];
-	const effectiveSentence = (sentence ?? truncate(text, 100, '')).trim();
+	const effectiveSentence = (sentence ?? truncate(text, AUTOCOMPLETE_MAX_NAME_LENGTH, '')).trim();
 
 	const contentParts = [
 		`<:node:${EMOJI_ID_NODE}> ${hyperlink(inlineCode(headingCode.length ? headingCode : heading), url.toString())}`,

diff --git a/src/util/constants.ts b/src/util/constants.ts
@@ -30,6 +30,7 @@ export const API_BASE_ALGOLIA = 'algolia.net' as const;
 export const API_BASE_DISCORD = 'https://discord.com/api/v9' as const;
 export const API_BASE_ORAMA = 'https://cloud.orama.run/v1' as const;
 export const AUTOCOMPLETE_MAX_ITEMS = 25;
+export const AUTOCOMPLETE_MAX_NAME_LENGTH = 100;
 export const MAX_MESSAGE_LENGTH = 4_000;
 export const REMOTE_TAG_URL = 'https://raw.githubusercontent.com/discordjs/discord-utils-bot/main/tags' as const;
 export const WEBSITE_URL_ROOT = 'https://discordjs.dev';