Merge pull request #3243 from artsy/mc-jones/refactor-generalize-search-naming

refactor: generalize search naming

Author: mc-jones

.env.oss

@@ -13,12 +13,10 @@ APP_URL=http://localhost:3005
 API_URL=http://localhost:3005/api
 FORCE_URL=https://staging.artsy.net
 ARTSY_URL=https://stagingapi.artsy.net
-SESSION_SECRET=p0s1tr0n
-ELASTICSEARCH_PORT=9200
-ELASTICSEARCH_URL=http://localhost:9200
-OPENSEARCH_URL=http://localhost:9200
-ELASTICSEARCH_INDEX_SUFFIX=development
-USE_OPENSEARCH=true
+SESSION_SECRET=p0s1tr0n # pragma: allowlist secret
+SEARCH_PORT=9200
+SEARCH_URL=http://localhost:9200
+SEARCH_INDEX_SUFFIX=development
 MONGOHQ_URL=mongodb://localhost:27017/positron
 GRAPHQL_ENDPOINT=https://metaphysics-staging.artsy.net # Needed to link Reaction: `yarn link @artsy/reaction`
 DEBUG=api,client,app

.env.test

@@ -6,11 +6,9 @@ FORCE_URL=http://localhost:5000/__gravity
 ARTSY_URL=http://localhost:5000/__gravity
 SESSION_SECRET=p0s1tr0n
 MONGOHQ_URL=mongodb://localhost:27017
-ELASTICSEARCH_URL=http://localhost:9200
-OPENSEARCH_URL=http://localhost:9200
-ELASTICSEARCH_INDEX_SUFFIX=test
-ELASTICSEARCH_PORT=9200
-USE_OPENSEARCH=true
+SEARCH_URL=http://localhost:9200
+SEARCH_INDEX_SUFFIX=test
+SEARCH_PORT=9200
 SALT=$2a$10$PJrPMBadu1NPdmnshBgFbe
 API_MAX=100
 API_PAGE_SIZE=10

.secrets.baseline

@@ -133,15 +133,6 @@
     }
   ],
   "results": {
-    ".env.oss": [
-      {
-        "type": "Secret Keyword",
-        "filename": ".env.oss",
-        "hashed_secret": "65910e06e1afc820523c9af5d194e7a85218c6d1",
-        "is_verified": false,
-        "line_number": 16
-      }
-    ],
     "src/api/apps/articles/test/integration.spec.ts": [
       {
         "type": "JSON Web Token",
@@ -170,5 +161,5 @@
       }
     ]
   },
-  "generated_at": "2025-07-24T13:28:20Z"
+  "generated_at": "2025-10-17T18:02:42Z"
 }

Brewfile

@@ -1,4 +1,4 @@
 tap 'artsy/formulas'
 tap 'mongodb/brew'
 brew 'mongodb-community@7.0', link: true, restart_service: true
-brew 'artsy/formulas/elasticsearch-full@7.17', restart_servicece: true
+brew 'opensearch', restart_service: true

README.md

@@ -71,7 +71,7 @@ If you are using Hokusai dev, edit the database as mentioned in this step, then
 
 `COMMIT_HASH=$(git rev-parse --short HEAD) hokusai dev start`
 
-This starts a new Docker Compose stack that boots MongoDB, ElasticSearch and Positron. Changes made to source-code are _not_ automatically reloaded. To shut down, press `ctrl+c` or execute `hokusai dev stop`.
+This starts a new Docker Compose stack that boots MongoDB, OpenSearch and Positron. Changes made to source-code are _not_ automatically reloaded. To shut down, press `ctrl+c` or execute `hokusai dev stop`.
 
 Positron should now be running at [http://localhost:3005/](http://localhost:3005/), open a browser and navigate to it. That will redirect you to staging, login as an Artsy administrator and it will redirect you to `http://localhost:3005` logged into Writer.
 

hokusai/development.yml

@@ -7,8 +7,8 @@ services:
     command: ["yarn", "dev"]
     environment:
       - MONGOHQ_URL=mongodb://positron-mongodb:27017/positron
-      - OPENSEARCH_URL=http://positron-opensearch:9200
-      - ELASTICSEARCH_INDEX_SUFFIX=development
+      - SEARCH_URL=http://positron-opensearch:9200
+      - SEARCH_INDEX_SUFFIX=development
       # SALT is an oss value. The '$' is escaped.
       - SALT=$$2a$$10$$PJrPMBadu1NPdmnshBgFbe
     env_file:

hokusai/test.yml

@@ -5,12 +5,11 @@ services:
 {% include 'templates/docker-compose-service.yml.j2' %}
     environment:
       - CI=true
-      - OPENSEARCH_URL=http://positron-opensearch:9200
-      - ELASTICSEARCH_INDEX_SUFFIX=test
+      - SEARCH_URL=http://positron-opensearch:9200
+      - SEARCH_INDEX_SUFFIX=test
       - MONGOHQ_URL=mongodb://positron-mongodb:27017/positron-test
       # SALT is an oss value. The '$' is escaped.
       - SALT=$$2a$$10$$PJrPMBadu1NPdmnshBgFbe
-      - USE_OPENSEARCH=true
     env_file: ../.env.test
     depends_on:
       - positron-mongodb

scripts/reindex_articles.coffee

@@ -4,7 +4,7 @@ path = require 'path'
 { indexForSearch } = Save = require '../src/api/apps/articles/model/distribute'
 Article = require '../src/api/apps/articles/model/index.js'
 ArticleModel = require '../src/api/models/article.coffee'
-search = require '../src/api/lib/elasticsearch'
+search = require '../src/api/lib/search_client'
 asyncLib = require 'async'
 { cloneDeep } = require 'lodash'
 
@@ -18,12 +18,11 @@ console.log('Starting article reindexing process...')
 console.log('Environment:', process.env.NODE_ENV || 'development')
 console.log('MongoDB URL:', process.env.MONGOHQ_URL ? 'Configured' : 'NOT CONFIGURED')
 
-# Log Elasticsearch configuration
-console.log('Elasticsearch Configuration:')
-console.log('  - URL:', process.env.ELASTICSEARCH_URL || process.env.OPENSEARCH_URL || 'NOT CONFIGURED')
+# Log Search configuration
+console.log('Search Configuration:')
+console.log('  - URL:', process.env.SEARCH_URL || 'NOT CONFIGURED')
 console.log('  - Index Name:', search.index)
-console.log('  - Index Suffix:', process.env.ELASTICSEARCH_INDEX_SUFFIX || 'production')
-console.log('  - Using OpenSearch:', search.isOpenSearch ? 'Yes' : 'No')
+console.log('  - Index Suffix:', process.env.SEARCH_INDEX_SUFFIX || 'production')
 
 main = ->
   startTime = Date.now()
@@ -98,7 +97,7 @@ indexWorker = (article, cb) ->
     console.log('  - Processing article:', article._id)
     articlePresent = Article.present(article)
     console.log('  - Article presented successfully')
-    console.log('  - Indexing to Elasticsearch:')
+    console.log('  - Indexing to search:')
     console.log('    * Document ID:', article.id?.toString() || article._id?.toString())
     console.log('    * Index Name:', search.index)
 
@@ -107,7 +106,7 @@ indexWorker = (article, cb) ->
         console.error('  - Error in indexForSearch:', err)
         cb(err)
       else
-        console.log('  - ✓ Article indexed on Elasticsearch:', article.id or article._id)
+        console.log('  - ✓ Article indexed for search:', article.id or article._id)
         console.log('    * Index:', search.index)
         console.log('    * Document ID:', article.id?.toString() || article._id?.toString())
         cb()

src/api/apps/articles/model/distribute.coffee

@@ -9,7 +9,7 @@
 } = process.env
 _ = require 'underscore'
 Backbone = require 'backbone'
-search = require '../../../lib/elasticsearch'
+search = require '../../../lib/search_client'
 async = require 'async'
 debug = require('debug') 'api'
 request = require 'superagent'
@@ -58,17 +58,15 @@ moment = require 'moment'
       search_boost: new Article(cloneDeep article).searchBoost()
       type: 'article'
     , (error, response) ->
-      console.log('ElasticsearchIndexingError: Article ' + article.id + ' : ' + error) if error
+      console.log('SearchIndexingError: Article ' + article.id + ' : ' + error) if error
       cb()
   )
 
 @removeFromSearch = (id) ->
   deleteParams =
     index: search.index
     id: id
-
-  # Only include type parameter for Elasticsearch
-  deleteParams.type = if search.isOpenSearch then '_doc' else 'article'
+    type: '_doc'
 
   search.client.delete(deleteParams, (error, response) ->
     console.log(error) if error

src/api/apps/articles/test/model/distribute.spec.ts

@@ -47,7 +47,6 @@ describe("Save", () => {
       Distribute.__set__("search", {
         client: searchStub,
         index: "test-index",
-        isOpenSearch: true,
       })
     }