Remove general autocomplete feature (#56000)

Author: heiskr

.github/workflows/index-autocomplete-search.yml

@@ -1,7 +1,7 @@
 name: Index autocomplete search in Elasticsearch
 
-# **What it does**: Indexes autocomplete data (general and AI search) into Elasticsearch.
-# **Why we have it**: So we can power the APIs for autocomplete.
+# **What it does**: Indexes AI search autocomplete data into Elasticsearch.
+# **Why we have it**: So we can power the APIs for AI search autocomplete.
 # **Who does it impact**: docs-engineering
 
 on:
@@ -40,11 +40,6 @@ jobs:
         if: ${{ github.event_name == 'pull_request' }}
         run: curl --fail --retry-connrefused --retry 5 -I http://localhost:9200
 
-      - name: Run general auto-complete indexing
-        env:
-          ELASTICSEARCH_URL: ${{ github.event_name == 'pull_request' && 'http://localhost:9200' || secrets.ELASTICSEARCH_URL }}
-        run: npm run index-general-autocomplete -- docs-internal-data
-
       - name: Run AI search auto-complete indexing
         env:
           ELASTICSEARCH_URL: ${{ github.event_name == 'pull_request' && 'http://localhost:9200' || secrets.ELASTICSEARCH_URL }}

package.json

@@ -49,9 +49,7 @@
     "general-search-scrape-server": "cross-env NODE_ENV=production PORT=4002 MINIMAL_RENDER=true CHANGELOG_DISABLED=true tsx src/frame/server.ts",
     "ghes-release-scrape-with-server": "cross-env GHES_RELEASE=1 start-server-and-test general-search-scrape-server 4002 general-search-scrape",
     "general-search-scrape-with-server": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test general-search-scrape-server 4002 general-search-scrape",
-    "index": "tsx src/search/scripts/index/index-cli autocomplete docs-internal-data",
     "index-ai-search-autocomplete": "tsx src/search/scripts/index/index-cli ai-search-autocomplete",
-    "index-general-autocomplete": "tsx src/search/scripts/index/index-cli general-autocomplete",
     "index-general-search": "tsx src/search/scripts/index/index-cli general-search",
     "index-test-fixtures": "./src/search/scripts/index-test-fixtures.sh",
     "labeler": "tsx .github/actions/labeler/labeler.ts",

src/search/README.md

@@ -22,19 +22,15 @@ You can also query our search endpoint directly at:
 
 ## Types of search
 
-Our backend currently supports 3 "types" of searching.
+Our backend currently supports 2 "types" of searching.
 
 All searches accept a `query` param, e.g. `?query=how` and return results based on their type:
 
 1. **general search**
   - Results: The pages of our sites that match the query, sorted by popularity
   - Example: Query = "clone" -> Results <URLs to Docs Page about cloning>
   - Endpoint: `/api/search/v1`
-2. **general autocomplete**
-  - Results: Potential terms that can be autocompleted from the query based on previous user searches
-  - Example: Query = "cl" -> A Result = "clone"
-  - Endpoint: `/api/search/autocomplete/v1`
-3. **AI search autocomplete**
+2. **AI search autocomplete**
   - Results: Human-readable full-sentence questions that best match the query. Questions are based on previous searches and popular pages
   - Example: Query = "How do I clone" -> A Result = "How do I clone a repository?"
   - Endpoint: `/api/search/ai-search-autocomplete/v1`
@@ -66,7 +62,7 @@ The preferred way to build and sync the search indices is to do so via the [GitH
 ### Actions workflow files
 
 - [`.github/workflows/index-general-search.yml`](/.github/workflows/index-general-search.yml) - Populates search indices for **general search** using the `main` branch every four hours. Search indices are stored in an internal-only Elasticsearch instance. To run it manually, click "Run workflow" button in the Actions tab.
-- [`.github/workflows/index-autocomplete-search.yml`](/.github/workflows/index-general-search.yml) - Populates search indices for both **general autocomplete** and **AI search autocomplete** using data from an internal repo. Runs daily. 
+- [`.github/workflows/index-autocomplete-search.yml`](/.github/workflows/index-general-search.yml) - Populates search indices for **AI search autocomplete** using data from an internal repo. Runs daily.
 
 ### Notable code files and directories
 

src/search/lib/elasticsearch-indexes.ts

@@ -15,10 +15,9 @@ export type SearchIndex = {
 
 /* Elasticsearch uses indexes to group categories of data
 
-  We currently have 3 top-level categories of indexes:
+  We currently have 2 top-level categories of indexes:
     1. General search: This is populated using data from all of our Docs pages
-    2. General autocomplete: This is populated using analytics search history in docs-internal-data
-    3. AI autocomplete: This is populated with human-readable questions using a GPT query in docs-internal-data
+    2. AI autocomplete: This is populated with human-readable questions using a GPT query in docs-internal-data
 
   This file is intended to be the source of truth for Docs Elasticsearch indexes.
 
@@ -34,10 +33,6 @@ const indexes: SearchIndexes = {
     prefix,
     type: 'general-search',
   },
-  generalAutocomplete: {
-    prefix,
-    type: 'general-autocomplete',
-  },
   aiSearchAutocomplete: {
     prefix,
     type: 'ai-search-autocomplete',

src/search/lib/get-elasticsearch-results/general-autocomplete.ts

@@ -11,9 +11,7 @@ import type { SearchRequestQueryParams } from '@/search/lib/search-request-param
 
 // Entry to this file, returns the query parameters to expect based on the type of search request
 export function getSearchRequestParamsObject(type: SearchTypes): SearchRequestQueryParams[] {
-  if (type === 'generalAutocomplete') {
-    return AUTOCOMPLETE_PARAMS_OBJ
-  } else if (type === 'aiSearchAutocomplete') {
+  if (type === 'aiSearchAutocomplete') {
     return AI_SEARCH_AUTOCOMPLETE_PARAMS_OBJ
   }
   return GENERAL_SEARCH_PARAMS_OBJ
@@ -136,11 +134,6 @@ const AI_SEARCH_AUTOCOMPLETE_PARAMS_OBJ: SearchRequestQueryParams[] = [
   { key: 'language', default_: 'en', validate: (language: string) => language === 'en' },
 ]
 
-const AUTOCOMPLETE_PARAMS_OBJ: SearchRequestQueryParams[] = [
-  ...SHARED_AUTOCOMPLETE_PARAMS_OBJ,
-  { key: 'language', default_: 'en', validate: (language: string) => language in languages },
-]
-
 function toBoolean(value: any): boolean {
   return value === 'true' || value === '1'
 }

src/search/lib/search-request-params/search-params-objects.ts

@@ -33,7 +33,6 @@ export interface ComputedSearchQueryParamsMap {
     toplevel: string[]
     aggregate: string[]
   }
-  generalAutocomplete: ComputedSearchQueryParams
   aiSearchAutocomplete: ComputedSearchQueryParams
 }
 

src/search/lib/search-request-params/types.ts

@@ -13,7 +13,6 @@ import {
   setFastlySurrogateKey,
   SURROGATE_ENUMS,
 } from '@/frame/middleware/set-fastly-surrogate-key.js'
-import { getAutocompleteSearchResults } from '@/search/lib/get-elasticsearch-results/general-autocomplete'
 import { getAISearchAutocompleteResults } from '@/search/lib/get-elasticsearch-results/ai-search-autocomplete'
 import { getSearchFromRequestParams } from '@/search/lib/search-request-params/get-search-from-request-params'
 import { getGeneralSearchResults } from '@/search/lib/get-elasticsearch-results/general-search'
@@ -59,39 +58,6 @@ router.get(
   }),
 )
 
-router.get(
-  '/autocomplete/v1',
-  catchMiddlewareError(async (req: Request, res: Response) => {
-    const {
-      indexName,
-      validationErrors,
-      searchParams: { query, size, debug },
-    } = getSearchFromRequestParams(req, 'generalAutocomplete')
-    if (validationErrors.length) {
-      return res.status(400).json(validationErrors[0])
-    }
-
-    const options = {
-      indexName,
-      query,
-      size,
-      debug,
-    }
-    try {
-      const { meta, hits } = await getAutocompleteSearchResults(options)
-
-      if (process.env.NODE_ENV !== 'development') {
-        searchCacheControl(res)
-        setFastlySurrogateKey(res, SURROGATE_ENUMS.MANUAL)
-      }
-
-      res.status(200).json({ meta, hits })
-    } catch (error) {
-      await handleGetSearchResultsError(req, res, error, options)
-    }
-  }),
-)
-
 router.get(
   '/ai-search-autocomplete/v1',
   catchMiddlewareError(async (req: Request, res: Response) => {
@@ -161,10 +127,6 @@ router.get('/', (req: Request, res: Response) => {
   res.redirect(307, req.originalUrl.replace('/search', '/search/v1'))
 })
 
-router.get('/autocomplete', (req: Request, res: Response) => {
-  res.redirect(307, req.originalUrl.replace('/search/autocomplete', '/search/autocomplete/v1'))
-})
-
 router.get('/ai-search-autocomplete', (req: Request, res: Response) => {
   res.redirect(
     307,

src/search/middleware/search-routes.ts

@@ -8,8 +8,7 @@ set -e
 # For general site-search
 npm run index-general-search -- src/search/tests/fixtures/search-indexes -l en -l ja -V ghec -V fpt --index-prefix tests
 
-# For general autocomplete search
-npm run index-general-autocomplete -- src/search/tests/fixtures/data -l en -l ja -v fpt -v ghec --index-prefix tests
+
 
 # For AI search autocomplete
 npm run index-ai-search-autocomplete -- src/search/tests/fixtures/data -l en -v fpt -v ghec --index-prefix tests

src/search/scripts/index-test-fixtures.sh

@@ -10,15 +10,14 @@ In production, the indexing happens in the GitHub workflows: `index-autocomplete
 
 Before running the indexing for **general search** you run the [scrape](../scrape/README.md) script to scrape page data into files.
 
-Before running the indexing for **general autocomplete** and **AI search autocomplete** you need to clone [docs-internal-data](https://github.com/github/docs-internal-data) to the root of this directory.
+Before running the indexing for **AI search autocomplete** you need to clone [docs-internal-data](https://github.com/github/docs-internal-data) to the root of this directory.
 
 There is a separate run command for indexing each type of search data:
 1. **general search**: `npm run index-general-search -- <scrape-directory>`
-2. **general autocomplete**: `npm run index-general-autocomplete -- docs-internal-data` (if `docs-internal-data` is cloned to root directory)
-3. **AI search autocomplete**: `npm run index-ai-search-autocomplete -- docs-internal-data` (if `docs-internal-data` is cloned to root directory)
+2. **AI search autocomplete**: `npm run index-ai-search-autocomplete -- docs-internal-data` (if `docs-internal-data` is cloned to root directory)
 
 To see the arguments accepted by any script, pass the `--help` argument, for example
 
 ```bash
-npm run index-general-autocomplete -- --help
+npm run index-ai-search-autocomplete -- --help
 ```