Deprecate Query.toESQuery and Query.toESQueryString in favor of Query…

….toOpenSearchQuery and Query.toOpenSearchQueryString Also: * Fix naming conventions in OuiSearchBar code and docs Signed-off-by: Miki <miki@amazon.com>
AMoo-Miki · Oct 2, 2024 · d1c9815 · d1c9815
1 parent f1c2099
commit d1c9815
Show file tree

Hide file tree

Showing 11 changed files with 187 additions and 154 deletions.
diff --git a/src-docs/src/views/search_bar/props_info.js b/src-docs/src/views/search_bar/props_info.js
@@ -72,12 +72,12 @@ export const propsInfo = {
               'static (query: #Query | string, items: Object[], options?: #ExecuteQueryOptions) => Object[]',
           },
         },
-        toESQuery: {
+        toOpenSearchQuery: {
           description:
-            'Builds and returns an Elasticsearch query object out of the given query',
+            'Builds and returns an OpenSearch query object out of the given query',
           type: {
             name:
-              'static (query: #Query | string, options?: #ToESQueryOptions) => ESQuery',
+              'static (query: #Query | string, options?: #ToOpenSearchQueryOptions) => OpenSearchQuery',
           },
         },
       },
@@ -458,21 +458,21 @@ export const propsInfo = {
     },
   },
 
-  ToESQueryOptions: {
+  ToOpenSearchQueryOptions: {
     __docgenInfo: {
       _ouiObjectType: 'type',
       props: {
         extraMustQueries: {
           description:
             'An array of additional queries to add as a `must` clause to the generated query',
           required: false,
-          type: { name: 'ESQuery[]' },
+          type: { name: 'OpenSearchQuery[]' },
         },
         extraMustNotQueries: {
           description:
             'An array of additional queries to add as a `must_not` clause to the generated query',
           required: false,
-          type: { name: 'ESQuery[]' },
+          type: { name: 'OpenSearchQuery[]' },
         },
       },
     },

diff --git a/src-docs/src/views/search_bar/search_bar.js b/src-docs/src/views/search_bar/search_bar.js
@@ -253,39 +253,41 @@ export const SearchBar = () => {
     return <OuiBasicTable items={queriedItems} columns={columns} />;
   };
 
-  let esQueryDsl;
-  let esQueryString;
+  let opensearchQueryDsl;
+  let opensearchQueryString;
 
   try {
-    esQueryDsl = OuiSearchBar.Query.toESQuery(query);
+    opensearchQueryDsl = OuiSearchBar.Query.toOpenSearchQuery(query);
   } catch (e) {
-    esQueryDsl = e.toString();
+    opensearchQueryDsl = e.toString();
   }
   try {
-    esQueryString = OuiSearchBar.Query.toESQueryString(query);
+    opensearchQueryString = OuiSearchBar.Query.toOpenSearchQueryString(query);
   } catch (e) {
-    esQueryString = e.toString();
+    opensearchQueryString = e.toString();
   }
 
   const content = renderError() || (
     <OuiFlexGroup>
       <OuiFlexItem grow={4}>
         <OuiTitle size="s">
-          <h3>Elasticsearch Query String</h3>
+          <h3>OpenSearch Query String</h3>
         </OuiTitle>
         <OuiSpacer size="s" />
         <OuiCodeBlock language="js">
-          {esQueryString ? esQueryString : ''}
+          {opensearchQueryString ? opensearchQueryString : ''}
         </OuiCodeBlock>
 
         <OuiSpacer size="l" />
 
         <OuiTitle size="s">
-          <h3>Elasticsearch Query DSL</h3>
+          <h3>OpenSearch Query DSL</h3>
         </OuiTitle>
         <OuiSpacer size="s" />
         <OuiCodeBlock language="js">
-          {esQueryDsl ? JSON.stringify(esQueryDsl, null, 2) : ''}
+          {opensearchQueryDsl
+            ? JSON.stringify(opensearchQueryDsl, null, 2)
+            : ''}
         </OuiCodeBlock>
       </OuiFlexItem>
 

diff --git a/src-docs/src/views/search_bar/search_bar_filters.js b/src-docs/src/views/search_bar/search_bar_filters.js
@@ -240,28 +240,32 @@ export const SearchBarFilters = () => {
     return <OuiBasicTable items={queriedItems} columns={columns} />;
   };
 
-  const esQueryDsl = OuiSearchBar.Query.toESQuery(query);
-  const esQueryString = OuiSearchBar.Query.toESQueryString(query);
+  const opensearchQueryDsl = OuiSearchBar.Query.toOpenSearchQuery(query);
+  const opensearchQueryString = OuiSearchBar.Query.toOpenSearchQueryString(
+    query
+  );
 
   const content = renderError() || (
     <OuiFlexGroup>
       <OuiFlexItem grow={4}>
         <OuiTitle size="s">
-          <h3>Elasticsearch Query String</h3>
+          <h3>OpenSearch Query String</h3>
         </OuiTitle>
         <OuiSpacer size="s" />
         <OuiCodeBlock language="js">
-          {esQueryString ? esQueryString : ''}
+          {opensearchQueryString ? opensearchQueryString : ''}
         </OuiCodeBlock>
 
         <OuiSpacer size="l" />
 
         <OuiTitle size="s">
-          <h3>Elasticsearch Query DSL</h3>
+          <h3>OpenSearch Query DSL</h3>
         </OuiTitle>
         <OuiSpacer size="s" />
         <OuiCodeBlock language="js">
-          {esQueryDsl ? JSON.stringify(esQueryDsl, null, 2) : ''}
+          {opensearchQueryDsl
+            ? JSON.stringify(opensearchQueryDsl, null, 2)
+            : ''}
         </OuiCodeBlock>
       </OuiFlexItem>
 

diff --git a/src/components/search_bar/query/__snapshots__/ast_to_es_query_string.test.ts.snap b/src/components/search_bar/query/__snapshots__/ast_to_es_query_string.test.ts.snap
diff --git a/...pshots__/ast_to_es_query_dsl.test.ts.snap → .../ast_to_opensearch_query_dsl.test.ts.snap b/...pshots__/ast_to_es_query_dsl.test.ts.snap → .../ast_to_opensearch_query_dsl.test.ts.snap
@@ -1,20 +1,20 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`astToEsQueryDsl ast - '' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - '' 1`] = `
 Object {
   "match_all": Object {},
 }
 `;
 
-exports[`astToEsQueryDsl ast - '-group:es group:kibana -group:beats group:logstash' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - '-group:opensearch group:dashboards -group:beats group:logstash' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
       Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "kibana logstash",
+            "query": "dashboards logstash",
           },
         },
       },
@@ -24,7 +24,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "es beats",
+            "query": "opensearch beats",
           },
         },
       },
@@ -33,7 +33,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - 'is:online group:kibana john' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - 'is:online group:dashboards john' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -46,7 +46,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "kibana",
+            "query": "dashboards",
           },
         },
       },
@@ -60,7 +60,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - 'john -doe is:online group:eng group:es -group:kibana -is:active' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - 'john -doe is:online group:eng group:opensearch -group:dashboards -is:active' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -73,7 +73,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "eng es",
+            "query": "eng opensearch",
           },
         },
       },
@@ -98,7 +98,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "kibana",
+            "query": "dashboards",
           },
         },
       },
@@ -107,7 +107,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - 'john -sales' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - 'john -sales' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -128,7 +128,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - 'john group:(eng or "marketing org") -group:"kibana team" 1`] = `
+exports[`astToOpenSearchQueryDsl ast - 'john group:(eng or "marketing org") -group:"dashboards team" 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -160,15 +160,15 @@ Object {
     "must_not": Array [
       Object {
         "match_phrase": Object {
-          "group": "kibana team",
+          "group": "dashboards team",
         },
       },
     ],
   },
 }
 `;
 
-exports[`astToEsQueryDsl ast - 'john group:(eng or es) -group:kibana' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - 'john group:(eng or opensearch) -group:dashboards' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -181,7 +181,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "or",
-            "query": "eng es",
+            "query": "eng opensearch",
           },
         },
       },
@@ -191,7 +191,7 @@ Object {
         "match": Object {
           "group": Object {
             "operator": "and",
-            "query": "kibana",
+            "query": "dashboards",
           },
         },
       },
@@ -200,7 +200,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - (name:john OR name:fred) 1`] = `
+exports[`astToOpenSearchQueryDsl ast - (name:john OR name:fred) 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -243,7 +243,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - (name:john) 1`] = `
+exports[`astToOpenSearchQueryDsl ast - (name:john) 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -272,7 +272,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - -count<=4 size<5 age>=3 -number>9 1`] = `
+exports[`astToOpenSearchQueryDsl ast - -count<=4 size<5 age>=3 -number>9 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -311,7 +311,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - count>3 1`] = `
+exports[`astToOpenSearchQueryDsl ast - count>3 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -327,7 +327,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - date:'2004-03' -date<'2004-03-10' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - date:'2004-03' -date<'2004-03-10' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -350,7 +350,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - date>'2004-02' -otherDate>='2004-03-10' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - date>'2004-02' -otherDate>='2004-03-10' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -375,7 +375,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - date>='2004-03-22' 1`] = `
+exports[`astToOpenSearchQueryDsl ast - date>='2004-03-22' 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -391,7 +391,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - name:"First \\"Nickname\\" Last" 1`] = `
+exports[`astToOpenSearchQueryDsl ast - name:"First \\"Nickname\\" Last" 1`] = `
 Object {
   "bool": Object {
     "must": Array [
@@ -405,7 +405,7 @@ Object {
 }
 `;
 
-exports[`astToEsQueryDsl ast - name:john (is:enrolled OR Teacher) 1`] = `
+exports[`astToOpenSearchQueryDsl ast - name:john (is:enrolled OR Teacher) 1`] = `
 Object {
   "bool": Object {
     "must": Array [

diff --git a/src/components/search_bar/query/__snapshots__/ast_to_opensearch_query_string.test.ts.snap b/src/components/search_bar/query/__snapshots__/ast_to_opensearch_query_string.test.ts.snap
@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`astToOpenSearchQueryString ast - '*' 1`] = `"*"`;
+
+exports[`astToOpenSearchQueryString ast - '-group:opensearch group:dashboards -group:beats group:logstash' 1`] = `"-group:opensearch +group:dashboards -group:beats +group:logstash"`;
+
+exports[`astToOpenSearchQueryString ast - 'is:online group:dashboards john' 1`] = `"+online:true +group:dashboards +john"`;
+
+exports[`astToOpenSearchQueryString ast - 'john -doe is:online group:eng group:opensearch -group:dashboards -is:active' 1`] = `"+john -doe +online:true +group:eng +group:opensearch -group:dashboards +active:false"`;
+
+exports[`astToOpenSearchQueryString ast - 'john -sales' 1`] = `"+john -sales"`;
+
+exports[`astToOpenSearchQueryString ast - 'john group:(eng or "marketing org") -group:"dashboards team" 1`] = `"+john +(group:eng OR group:\\"marketing org\\") -group:\\"dashboards team\\""`;
+
+exports[`astToOpenSearchQueryString ast - 'john group:(eng or opensearch) -group:dashboards' 1`] = `"+john +(group:eng OR group:opensearch) -group:dashboards"`;
+
+exports[`astToOpenSearchQueryString ast - -count<=4 size<5 age>=3 -number>9 1`] = `"-count:<=4 +size:<5 +age:>=3 -number:>9"`;
+
+exports[`astToOpenSearchQueryString ast - count>3 1`] = `"+count:>3"`;
+
+exports[`astToOpenSearchQueryString ast - date:'2004-03' -date<'2004-03-10' 1`] = `"+date:(>=2004-03 AND <2004-04) -date:<2004-03-10"`;
+
+exports[`astToOpenSearchQueryString ast - date>'2004-02' -otherDate>='2004-03-10' 1`] = `"+date:>=2004-03 -date:>=2004-03-10"`;
+
+exports[`astToOpenSearchQueryString ast - date>='2004-03-22' 1`] = `"+date:>=2004-03-22"`;