🐝 Add the ability to prefix algolia index names

This is in order to support multiple staging servers having their own
index inside one Algolia staging application.

baker/algolia/configureAlgolia.ts

@@ -11,8 +11,9 @@ import {
 } from "../../settings/serverSettings.js"
 import { countries } from "@ourworldindata/utils"
 import { SearchIndexName } from "../../site/search/searchTypes.js"
+import { getIndexName } from "../../site/search/searchClient.js"
 
-export const CONTENT_GRAPH_ALGOLIA_INDEX = "graph"
+export const CONTENT_GRAPH_ALGOLIA_INDEX = getIndexName("graph")
 
 export const getAlgoliaClient = (): SearchClient | undefined => {
     if (!ALGOLIA_ID || !ALGOLIA_SECRET_KEY) {
@@ -58,7 +59,7 @@ export const configureAlgolia = async () => {
         unretrievableAttributes: ["views_7d", "score"],
     }
 
-    const chartsIndex = client.initIndex(SearchIndexName.Charts)
+    const chartsIndex = client.initIndex(getIndexName(SearchIndexName.Charts))
 
     await chartsIndex.setSettings({
         ...baseSettings,
@@ -89,7 +90,7 @@ export const configureAlgolia = async () => {
         optionalWords: ["vs"],
     })
 
-    const pagesIndex = client.initIndex(SearchIndexName.Pages)
+    const pagesIndex = client.initIndex(getIndexName(SearchIndexName.Pages))
 
     await pagesIndex.setSettings({
         ...baseSettings,
@@ -112,7 +113,9 @@ export const configureAlgolia = async () => {
         disableExactOnAttributes: ["tags"],
     })
 
-    const explorersIndex = client.initIndex(SearchIndexName.Explorers)
+    const explorersIndex = client.initIndex(
+        getIndexName(SearchIndexName.Explorers)
+    )
 
     await explorersIndex.setSettings({
         ...baseSettings,

baker/algolia/indexChartsToAlgolia.ts

@@ -9,6 +9,8 @@ import { getAnalyticsPageviewsByUrlObj } from "../../db/model/Pageview.js"
 import { Link } from "../../db/model/Link.js"
 import { getRelatedArticles } from "../../db/model/Post.js"
 import { Knex } from "knex"
+import { ALGOLIA_INDEX_PREFIX } from "../../settings/clientSettings.js"
+import { getIndexName } from "../../site/search/searchClient.js"
 
 const computeScore = (record: Omit<ChartRecord, "score">): number => {
     const { numRelatedArticles, views_7d } = record
@@ -114,7 +116,7 @@ const indexChartsToAlgolia = async () => {
         return
     }
 
-    const index = client.initIndex(SearchIndexName.Charts)
+    const index = client.initIndex(getIndexName(SearchIndexName.Charts))
 
     await db.getConnection()
     const records = await getChartsRecords(db.knexInstance())

baker/algolia/indexExplorersToAlgolia.ts

@@ -14,6 +14,7 @@ import { chunkParagraphs } from "../chunk.js"
 import { SearchIndexName } from "../../site/search/searchTypes.js"
 import { Chart } from "../../db/model/Chart.js"
 import { Knex } from "knex"
+import { getIndexName } from "../../site/search/searchClient.js"
 
 type ExplorerBlockColumns = {
     type: "columns"
@@ -193,7 +194,7 @@ const indexExplorersToAlgolia = async () => {
     }
 
     try {
-        const index = client.initIndex(SearchIndexName.Explorers)
+        const index = client.initIndex(getIndexName(SearchIndexName.Explorers))
 
         const knex = db.knexInstance()
         const records = await getExplorerRecords(knex)

baker/algolia/indexToAlgolia.tsx

@@ -32,6 +32,7 @@ import {
     getPostsFromSnapshots,
 } from "../../db/model/Post.js"
 import { Knex } from "knex"
+import { ALGOLIA_INDEX_PREFIX } from "../../settings/clientSettings.js"
 
 interface TypeAndImportance {
     type: PageType
@@ -232,7 +233,7 @@ const indexToAlgolia = async (knex: Knex<any, any[]>) => {
         console.error(`Failed indexing pages (Algolia client not initialized)`)
         return
     }
-    const index = client.initIndex(SearchIndexName.Pages)
+    const index = client.initIndex(ALGOLIA_INDEX_PREFIX + SearchIndexName.Pages)
 
     await db.getConnection()
     const records = await getPagesRecords(knex)

settings/clientSettings.ts

@@ -44,6 +44,8 @@ export const WORDPRESS_URL: string = process.env.WORDPRESS_URL ?? ""
 
 export const ALGOLIA_ID: string = process.env.ALGOLIA_ID ?? ""
 export const ALGOLIA_SEARCH_KEY: string = process.env.ALGOLIA_SEARCH_KEY ?? ""
+export const ALGOLIA_INDEX_PREFIX: string =
+    process.env.ALGOLIA_INDEX_PREFIX ?? ""
 
 export const DONATE_API_URL: string =
     process.env.DONATE_API_URL ?? "http://localhost:8788/donation/donate"

site/search/Autocomplete.tsx

@@ -20,7 +20,11 @@ import {
 } from "../../settings/clientSettings.js"
 import { faSearch } from "@fortawesome/free-solid-svg-icons"
 import { FontAwesomeIcon } from "@fortawesome/react-fontawesome/index.js"
-import { DEFAULT_SEARCH_PLACEHOLDER } from "./searchClient.js"
+import {
+    DEFAULT_SEARCH_PLACEHOLDER,
+    getIndexName,
+    parseIndexName,
+} from "./searchClient.js"
 
 type BaseItem = Record<string, unknown>
 
@@ -64,7 +68,7 @@ const getItemUrl: AutocompleteSource<BaseItem>["getItemUrl"] = ({ item }) =>
 // The slugs we index to Algolia don't include the /grapher/ or /explorers/ directories
 // Prepend them with this function when we need them
 const prependSubdirectoryToAlgoliaItemUrl = (item: BaseItem): string => {
-    const indexName = item.__autocomplete_indexName as SearchIndexName
+    const indexName = parseIndexName(item.__autocomplete_indexName as string)
     const subdirectory = indexNameToSubdirectoryMap[indexName]
     return `${subdirectory}/${item.slug}`
 }
@@ -111,23 +115,23 @@ const AlgoliaSource: AutocompleteSource<BaseItem> = {
             searchClient,
             queries: [
                 {
-                    indexName: SearchIndexName.Pages,
+                    indexName: getIndexName(SearchIndexName.Pages),
                     query,
                     params: {
                         hitsPerPage: 2,
                         distinct: true,
                     },
                 },
                 {
-                    indexName: SearchIndexName.Charts,
+                    indexName: getIndexName(SearchIndexName.Charts),
                     query,
                     params: {
                         hitsPerPage: 2,
                         distinct: true,
                     },
                 },
                 {
-                    indexName: SearchIndexName.Explorers,
+                    indexName: getIndexName(SearchIndexName.Explorers),
                     query,
                     params: {
                         hitsPerPage: 1,
@@ -141,7 +145,9 @@ const AlgoliaSource: AutocompleteSource<BaseItem> = {
     templates: {
         header: () => <h5 className="overline-black-caps">Top Results</h5>,
         item: ({ item, components }) => {
-            const index = item.__autocomplete_indexName as SearchIndexName
+            const index = parseIndexName(
+                item.__autocomplete_indexName as string
+            )
             const indexLabel =
                 index === SearchIndexName.Charts
                     ? "Chart"

site/search/SearchPanel.tsx

@@ -171,6 +171,7 @@ function Filters({
     const { scopedResults } = useInstantSearch()
     if (isHidden) return null
 
+    // LARS: does this need updating too?
     const resultsByIndexName = keyBy(scopedResults, "indexId")
     const hitsLengthByIndexName = mapValues(resultsByIndexName, (results) =>
         get(results, ["results", "hits", "length"], 0)

site/search/searchClient.ts

@@ -1,5 +1,6 @@
 import {
     ALGOLIA_ID,
+    ALGOLIA_INDEX_PREFIX,
     ALGOLIA_SEARCH_KEY,
 } from "../../settings/clientSettings.js"
 import insightsClient, { InsightsClient } from "search-insights"
@@ -8,6 +9,7 @@ import {
     getPreferenceValue,
     PreferenceType,
 } from "../CookiePreferencesManager.js"
+import { SearchIndexName } from "./searchTypes.js"
 
 let insightsInitialized = false
 const getInsightsClient = (): InsightsClient => {
@@ -22,6 +24,14 @@ const getInsightsClient = (): InsightsClient => {
     return insightsClient
 }
 
+export const getIndexName = (index: SearchIndexName | string): string => {
+    return `${ALGOLIA_INDEX_PREFIX}${index}`
+}
+
+export const parseIndexName = (index: string): SearchIndexName => {
+    return index.substring(ALGOLIA_INDEX_PREFIX.length) as SearchIndexName
+}
+
 export const logSiteSearchClick = (
     event: Omit<InsightsSearchClickEvent, "eventName">
 ) => {