Merge pull request #4031 from owid/explorer-lerna-package

🔨 extract explorers to lerna package

Makefile

@@ -297,9 +297,10 @@ update.chart-entities: itsJustJavascript
 reindex: itsJustJavascript
 	@echo '==> Reindexing search in Algolia'
 	node --enable-source-maps itsJustJavascript/baker/algolia/configureAlgolia.js
-	node --enable-source-maps itsJustJavascript/baker/algolia/indexToAlgolia.js
+	node --enable-source-maps itsJustJavascript/baker/algolia/indexPagesToAlgolia.js
 	node --enable-source-maps itsJustJavascript/baker/algolia/indexChartsToAlgolia.js
 	node --enable-source-maps itsJustJavascript/baker/algolia/indexExplorerViewsToAlgolia.js
+	node --enable-source-maps itsJustJavascript/baker/algolia/indexExplorerViewsAndChartsToAlgolia.js
 
 delete-algolia-index: itsJustJavascript
 	@echo '==> Deleting Algolia index'

_routes.json

@@ -1,5 +1,5 @@
 {
     "version": 1,
-    "include": ["/grapher/*", "/deleted/*", "/donation/*"],
+    "include": ["/grapher/*", "/deleted/*", "/donation/*", "/explorers/*"],
     "exclude": ["/grapher/_grapherRedirects.json"]
 }

adminSiteClient/AdminApp.tsx

@@ -35,7 +35,7 @@ import { AdminAppContext } from "./AdminAppContext.js"
 import { Base64 } from "js-base64"
 import { ExplorerCreatePage } from "../explorerAdminClient/ExplorerCreatePage.js"
 import { ExplorersIndexPage } from "../explorerAdminClient/ExplorersListPage.js"
-import { EXPLORERS_ROUTE_FOLDER } from "../explorer/ExplorerConstants.js"
+import { EXPLORERS_ROUTE_FOLDER } from "@ourworldindata/explorer"
 import { AdminLayout } from "./AdminLayout.js"
 import { BulkGrapherConfigEditorPage } from "./BulkGrapherConfigEditor.js"
 import { GdocsIndexPage, GdocsMatchProps } from "./GdocsIndexPage.js"

adminSiteClient/AdminLayout.tsx

@@ -11,7 +11,7 @@ import { FontAwesomeIcon } from "@fortawesome/react-fontawesome/index.js"
 import {
     DefaultNewExplorerSlug,
     EXPLORERS_ROUTE_FOLDER,
-} from "../explorer/ExplorerConstants.js"
+} from "@ourworldindata/explorer"
 import classNames from "classnames"
 
 @observer

adminSiteClient/ExplorerTagsPage.tsx

@@ -8,9 +8,9 @@ import { DbChartTagJoin } from "@ourworldindata/utils"
 import {
     GetAllExplorersRoute,
     GetAllExplorersTagsRoute,
-} from "../explorer/ExplorerConstants.js"
+    ExplorerProgram,
+} from "@ourworldindata/explorer"
 import { EditableTags } from "./EditableTags.js"
-import { ExplorerProgram } from "../explorer/ExplorerProgram.js"
 import cx from "classnames"
 
 type ExplorerWithTags = {

adminSiteClient/tsconfig.json

@@ -5,7 +5,6 @@
         "rootDir": "."
     },
     "references": [
-        { "path": "../explorer" },
         { "path": "../explorerAdminClient" },
         { "path": "../settings" },
         { "path": "../site" },

adminSiteServer/adminRouter.tsx

@@ -31,11 +31,9 @@ import {
     EXPLORERS_PREVIEW_ROUTE,
     GetAllExplorersRoute,
     GetAllExplorersTagsRoute,
-} from "../explorer/ExplorerConstants.js"
-import {
     ExplorerProgram,
     EXPLORER_FILE_SUFFIX,
-} from "../explorer/ExplorerProgram.js"
+} from "@ourworldindata/explorer"
 import fs from "fs-extra"
 import * as Post from "../db/model/Post.js"
 import {

adminSiteServer/apiRouter.ts

@@ -125,7 +125,7 @@ import { denormalizeLatestCountryData } from "../baker/countryProfiles.js"
 import {
     indexIndividualGdocPost,
     removeIndividualGdocPostFromIndex,
-} from "../baker/algolia/algoliaUtils.js"
+} from "../baker/algolia/utils/pages.js"
 import { References } from "../adminSiteClient/ChartEditor.js"
 import { DeployQueueServer } from "../baker/DeployQueueServer.js"
 import { FunctionalRouter } from "./FunctionalRouter.js"

adminSiteServer/mockSiteRouter.tsx

@@ -53,9 +53,11 @@ import {
     ImageMetadata,
 } from "@ourworldindata/utils"
 import { GIT_CMS_DIR } from "../gitCms/GitCmsConstants.js"
-import { EXPLORERS_ROUTE_FOLDER } from "../explorer/ExplorerConstants.js"
+import {
+    EXPLORERS_ROUTE_FOLDER,
+    explorerUrlMigrationsById,
+} from "@ourworldindata/explorer"
 import { getExplorerRedirectForPath } from "../explorerAdminServer/ExplorerRedirects.js"
-import { explorerUrlMigrationsById } from "../explorer/urlMigrations/ExplorerUrlMigrations.js"
 import { generateEmbedSnippet } from "../site/viteUtils.js"
 import {
     renderPreviewDataPageOrGrapherPage,

adminSiteServer/testPageRouter.tsx

@@ -34,7 +34,7 @@ import {
 } from "@ourworldindata/types"
 import { ExplorerAdminServer } from "../explorerAdminServer/ExplorerAdminServer.js"
 import { GIT_CMS_DIR } from "../gitCms/GitCmsConstants.js"
-import { ExplorerChartCreationMode } from "../explorer/ExplorerConstants.js"
+import { ExplorerChartCreationMode } from "@ourworldindata/explorer"
 import { getPlainRouteWithROTransaction } from "./plainRouterHelpers.js"
 import {
     ColorSchemes,

adminSiteServer/tsconfig.json

@@ -7,7 +7,6 @@
     "references": [
         { "path": "../site" },
         { "path": "../db" },
-        { "path": "../explorer" },
         { "path": "../explorerAdminServer" },
         { "path": "../gitCms" },
         { "path": "../adminSiteClient" },

baker/ExplorerBaker.tsx

@@ -1,19 +1,21 @@
 import fs from "fs-extra"
 import path from "path"
-import { ExplorerProgram } from "../explorer/ExplorerProgram.js"
-import { explorerUrlMigrationsById } from "../explorer/urlMigrations/ExplorerUrlMigrations.js"
+import {
+    ExplorerProgram,
+    ExplorerGrammar,
+    ColumnGrammar,
+    explorerUrlMigrationsById,
+} from "@ourworldindata/explorer"
 import { ExplorerAdminServer } from "../explorerAdminServer/ExplorerAdminServer.js"
 import { explorerRedirectTable } from "../explorerAdminServer/ExplorerRedirects.js"
 import { renderExplorerPage } from "./siteRenderers.js"
 import * as db from "../db/db.js"
 import { getVariableIdsByCatalogPath } from "../db/model/Variable.js"
-import { ExplorerGrammar } from "../explorer/ExplorerGrammar.js"
 import {
     CoreTable,
     ErrorValueTypes,
     isNotErrorValueOrEmptyCell,
 } from "@ourworldindata/core-table"
-import { ColumnGrammar } from "../explorer/ColumnGrammar.js"
 import { ColumnTypeNames } from "@ourworldindata/types"
 
 export const transformExplorerProgramToResolveCatalogPaths = async (

baker/SiteBaker.tsx

@@ -69,7 +69,7 @@ import {
     flushCache as redirectsFlushCache,
 } from "./redirects.js"
 import { bakeAllChangedGrapherPagesVariablesPngSvgAndDeleteRemovedGraphers } from "./GrapherBaker.js"
-import { EXPLORERS_ROUTE_FOLDER } from "../explorer/ExplorerConstants.js"
+import { EXPLORERS_ROUTE_FOLDER } from "@ourworldindata/explorer"
 import { GIT_CMS_DIR } from "../gitCms/GitCmsConstants.js"
 import {
     bakeAllExplorerRedirects,

baker/algolia/configureAlgolia.ts

@@ -159,6 +159,41 @@ export const configureAlgolia = async () => {
         ],
     })
 
+    const explorerViewsAndChartsIndex = client.initIndex(
+        getIndexName(SearchIndexName.ExplorerViewsAndCharts)
+    )
+
+    await explorerViewsAndChartsIndex.setSettings({
+        ...baseSettings,
+        searchableAttributes: [
+            "unordered(title)",
+            "unordered(slug)",
+            "unordered(variantName)",
+            "unordered(subtitle)",
+            "unordered(tags)",
+            "unordered(availableEntities)",
+        ],
+        ranking: ["typo", "words", "exact", "attribute", "custom", "proximity"],
+        customRanking: [
+            "desc(score)",
+            // For multiple explorer views with the same title, we want to avoid surfacing duplicates.
+            // So, rank a result with viewTitleIndexWithinExplorer=0 way more highly than one with 1, 2, etc.
+            "asc(viewTitleIndexWithinExplorer)",
+            "asc(titleLength)",
+        ],
+        attributesToSnippet: ["subtitle:24"],
+        attributeForDistinct: "id",
+        optionalWords: ["vs"],
+
+        // These lines below essentially demote matches in the `subtitle` and `availableEntities` fields:
+        // If we find a match (only) there, then it doesn't count towards `exact`, and is therefore ranked lower.
+        // We also disable prefix matching and typo tolerance on these.
+        disableExactOnAttributes: ["tags", "subtitle", "availableEntities"],
+        disableTypoToleranceOnAttributes: ["subtitle", "availableEntities"],
+        disablePrefixOnAttributes: ["subtitle"],
+        attributesForFaceting: ["tags", "availableEntities"],
+    })
+
     const synonyms = [
         ["owid", "our world in data"],
         ["kids", "children"],