suppress es-search if ELASTICSEARCH_URL isn't configured (github#30096)

Peter Bengtsson · web-flow · commit fe80f4ae4dac · 2022-08-19T20:54:37.000Z
* suppress es-search if ELASTICSEARCH_URL isn't configured

* simplify

* simple 500 error instead
diff --git a/components/search/SearchError.tsx b/components/search/SearchError.tsx
@@ -13,7 +13,6 @@ export function SearchError({ error }: Props) {
 
   return (
     <div>
-      {' '}
       <Flash variant="danger" sx={{ margin: '3rem' }}>
         {t('search_error')}
         <br />
diff --git a/middleware/api/es-search.js b/middleware/api/es-search.js
@@ -1,6 +1,9 @@
 import { Client } from '@elastic/elasticsearch'
 
-const ELASTICSEARCH_URL = process.env.ELASTICSEARCH_URL || 'http://localhost:9200'
+// The reason this is exported is so the middleware endpoints can
+// find out if the environment variable has been set (and is truthy)
+// before attempting to call the main function in this file.
+export const ELASTICSEARCH_URL = process.env.ELASTICSEARCH_URL
 
 const isDevMode = process.env.NODE_ENV !== 'production'
 
diff --git a/middleware/api/search.js b/middleware/api/search.js
@@ -5,7 +5,7 @@ import languages from '../../lib/languages.js'
 import { allVersions } from '../../lib/all-versions.js'
 import { cacheControlFactory } from '../cache-control.js'
 import catchMiddlewareError from '../catch-middleware-error.js'
-import { getSearchResults } from './es-search.js'
+import { getSearchResults, ELASTICSEARCH_URL } from './es-search.js'
 
 // Used by the legacy search
 const versions = new Set(Object.values(searchVersions))
@@ -51,8 +51,28 @@ function convertLegacyVersionName(version) {
   return legacyEnterpriseServerVersions[version] || version
 }
 
+function notConfiguredMiddleware(req, res, next) {
+  if (!ELASTICSEARCH_URL) {
+    if (process.env.NODE_ENV === 'production') {
+      // Temporarily, this is OKish. The Docs Engineering team is
+      // currently working on setting up an Elasticsearch cloud
+      // instance that we can use. We don't currently have that,
+      // but this code is running in production. We just don't want
+      // to unnecessarily throw errors when it's actually a known thing.
+      return res.status(500).send('ELASTICSEARCH_URL not been set up yet')
+    }
+    throw new Error(
+      'process.env.ELASTICSEARCH_URL is not set. ' +
+        "If you're working on this locally, add `ELASTICSEARCH_URL=http://localhost:9200` in your .env file"
+    )
+  }
+
+  return next()
+}
+
 router.get(
   '/legacy',
+  notConfiguredMiddleware,
   catchMiddlewareError(async function legacySearch(req, res, next) {
     const { query, version, language, filters, limit: limit_ } = req.query
     if (filters) {
@@ -196,6 +216,7 @@ const validationMiddleware = (req, res, next) => {
 router.get(
   '/v1',
   validationMiddleware,
+  notConfiguredMiddleware,
   catchMiddlewareError(async function search(req, res, next) {
     const { indexName, query, page, size, debug, sort } = req.search
     const { meta, hits } = await getSearchResults({ indexName, query, page, size, debug, sort })
diff --git a/pages/search.tsx b/pages/search.tsx
@@ -21,6 +21,15 @@ export default function Page({ mainContext }: Props) {
 }
 
 export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
+  // The dedicated search results page depends on a working Elasticsearch,
+  // ultimately, but unfortunately, that might not be up and running.
+  // So if that's the case, which might be true in production (Aug 2022)
+  // or on an engineers local development, we basically pretend the
+  // page doesn't exist.
+  if (!process.env.ELASTICSEARCH_URL) {
+    return { notFound: true }
+  }
+
   const req = context.req as any
   const res = context.res as any
 
