[nodejs client] hookup js client with dashboards

1.change @elastic/elasticsearch to @opensearch-project/opensearch 2.add path in tsconfig.base.json to let nodejs types point to api/new.d.ts which is the new defined types 3.fix hookup issues in src/core/server/opensearch 4.fix hookup issues in src/core/server/core_usage_data_service.ts 5.fix hookup issues in src/core/server/saved_objects fix PR comments and add more explains to type mismatch Sub-Issue Resolved: opensearch-project#1193 Sub-Issue Resolved: opensearch-project#1224 Sub-Issue Resolved: opensearch-project#1216 Issue Resolved: opensearch-project#837 Signed-off-by: Anan Zhuang <ananzh@amazon.com>
ananzh · Mar 18, 2022 · 9d187ce · 9d187ce
1 parent 3c7e8d5
commit 9d187ce
Show file tree

Hide file tree

Showing 62 changed files with 346 additions and 658 deletions.
diff --git a/package.json b/package.json
@@ -106,7 +106,6 @@
   },
   "dependencies": {
     "@elastic/datemath": "5.0.3",
-    "@elastic/elasticsearch": "7.10.0-rc.1",
     "@elastic/eui": "29.3.2",
     "@elastic/good": "^9.0.1-kibana3",
     "@elastic/numeral": "^2.5.0",
@@ -123,6 +122,7 @@
     "@hapi/podium": "^4.1.3",
     "@hapi/vision": "^6.1.0",
     "@hapi/wreck": "^17.1.0",
+    "@opensearch-project/opensearch": "^1.0.2",
     "@osd/ace": "1.0.0",
     "@osd/analytics": "1.0.0",
     "@osd/apm-config-loader": "1.0.0",

diff --git a/packages/osd-opensearch/package.json b/packages/osd-opensearch/package.json
@@ -12,7 +12,7 @@
     "osd:watch": "node scripts/build --watch"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "7.10.0-rc.1",
+    "@opensearch-project/opensearch": "^1.0.2",
     "@osd/dev-utils": "1.0.0",
     "abort-controller": "^3.0.0",
     "chalk": "^4.1.0",

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -5,7 +5,7 @@
 ```ts
 
 import { Action } from 'history';
-import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
+import { ApiResponse } from '@opensearch-project/opensearch/lib/Transport';
 import Boom from '@hapi/boom';
 import { ConfigPath } from '@osd/config';
 import { EnvironmentMode } from '@osd/config';
@@ -17,7 +17,7 @@ import { ExclusiveUnion } from '@elastic/eui';
 import { History } from 'history';
 import { Href } from 'history';
 import { IconType } from '@elastic/eui';
-import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
+import { OpenSearchDashboardsClient } from '@opensearch-project/opensearch/api/opensearch_dashboards';
 import { Location } from 'history';
 import { LocationDescriptorObject } from 'history';
 import { Logger } from '@osd/logging';
@@ -33,9 +33,9 @@ import React from 'react';
 import { RecursiveReadonly } from '@osd/utility-types';
 import * as Rx from 'rxjs';
 import { ShallowPromise } from '@osd/utility-types';
-import { TransportRequestOptions } from '@elastic/elasticsearch/lib/Transport';
-import { TransportRequestParams } from '@elastic/elasticsearch/lib/Transport';
-import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
+import { TransportRequestOptions } from '@opensearch-project/opensearch/lib/Transport';
+import { TransportRequestParams } from '@opensearch-project/opensearch/lib/Transport';
+import { TransportRequestPromise } from '@opensearch-project/opensearch/lib/Transport';
 import { Type } from '@osd/config-schema';
 import { TypeOf } from '@osd/config-schema';
 import { UnregisterCallback } from 'history';

diff --git a/src/core/server/core_usage_data/core_usage_data_service.test.ts b/src/core/server/core_usage_data/core_usage_data_service.test.ts
@@ -89,7 +89,6 @@ describe('CoreUsageDataService', () => {
               'docs.count': 10,
               'docs.deleted': 10,
               'store.size': 1000,
-              'pri.store.size': 2000,
             },
           ],
         } as any);
@@ -98,7 +97,6 @@ describe('CoreUsageDataService', () => {
             {
               name: '.kibana_1',
               'docs.count': 20,
-              'docs.deleted': 20,
               'store.size': 2000,
               'pri.store.size': 4000,
             },
@@ -221,13 +219,13 @@ describe('CoreUsageDataService', () => {
                     "alias": ".kibana_task_manager",
                     "docsCount": 10,
                     "docsDeleted": 10,
-                    "primaryStoreSizeBytes": 2000,
+                    "primaryStoreSizeBytes": 0,
                     "storeSizeBytes": 1000,
                   },
                   Object {
                     "alias": ".kibana_task_manager",
                     "docsCount": 20,
-                    "docsDeleted": 20,
+                    "docsDeleted": 0,
                     "primaryStoreSizeBytes": 4000,
                     "storeSizeBytes": 2000,
                   },

diff --git a/src/core/server/core_usage_data/core_usage_data_service.ts b/src/core/server/core_usage_data/core_usage_data_service.ts
@@ -122,10 +122,12 @@ export class CoreUsageDataService implements CoreService<void, CoreUsageDataStar
                 index,
                 this.opensearchDashboardsConfig!.index
               ),
-              docsCount: stats['docs.count'],
-              docsDeleted: stats['docs.deleted'],
-              storeSizeBytes: stats['store.size'],
-              primaryStoreSizeBytes: stats['pri.store.size'],
+              docsCount: stats['docs.count'] ? parseInt(stats['docs.count'], 10) : 0,
+              docsDeleted: stats['docs.deleted'] ? parseInt(stats['docs.deleted'], 10) : 0,
+              storeSizeBytes: stats['store.size'] ? parseInt(stats['store.size'], 10) : 0,
+              primaryStoreSizeBytes: stats['pri.store.size']
+                ? parseInt(stats['pri.store.size'], 10)
+                : 0,
             };
           });
       })

diff --git a/src/core/server/http/integration_tests/core_service.test.mocks.ts b/src/core/server/http/integration_tests/core_service.test.mocks.ts
@@ -51,8 +51,8 @@ jest.doMock('elasticsearch', () => {
 });
 
 export const MockOpenSearchClient = jest.fn();
-jest.doMock('@elastic/elasticsearch', () => {
-  const real = jest.requireActual('@elastic/elasticsearch');
+jest.doMock('@opensearch-project/opensearch', () => {
+  const real = jest.requireActual('@opensearch-project/opensearch');
   return {
     ...real,
     Client: MockOpenSearchClient,

diff --git a/src/core/server/http/integration_tests/core_services.test.ts b/src/core/server/http/integration_tests/core_services.test.ts
@@ -42,7 +42,7 @@ import { errors as opensearchErrors } from 'elasticsearch';
 import { LegacyOpenSearchErrorHelpers } from '../../opensearch/legacy';
 
 import { opensearchClientMock } from '../../opensearch/client/mocks';
-import { ResponseError } from '@elastic/elasticsearch/lib/errors';
+import { ResponseError } from '@opensearch-project/opensearch/lib/errors';
 import * as osdTestServer from '../../../test_helpers/osd_server';
 import { InternalOpenSearchServiceStart } from '../../opensearch';
 

diff --git a/src/core/server/index.ts b/src/core/server/index.ts
@@ -307,8 +307,6 @@ export {
   SavedObjectsRepository,
   SavedObjectsDeleteByNamespaceOptions,
   SavedObjectsIncrementCounterOptions,
-  SavedObjectsComplexFieldMapping,
-  SavedObjectsCoreFieldMapping,
   SavedObjectsFieldMapping,
   SavedObjectsTypeMappingDefinition,
   SavedObjectsMappingProperties,

diff --git a/src/core/server/opensearch/client/client_config.ts b/src/core/server/opensearch/client/client_config.ts
@@ -33,7 +33,7 @@
 import { ConnectionOptions as TlsConnectionOptions } from 'tls';
 import { URL } from 'url';
 import { Duration } from 'moment';
-import { ClientOptions, NodeOptions } from '@elastic/elasticsearch';
+import { ClientOptions, NodeOptions } from '@opensearch-project/opensearch';
 import { OpenSearchConfig } from '../opensearch_config';
 import { DEFAULT_HEADERS } from '../default_headers';
 

diff --git a/src/core/server/opensearch/client/cluster_client.ts b/src/core/server/opensearch/client/cluster_client.ts
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-import { Client } from '@elastic/elasticsearch';
+import { Client } from '@opensearch-project/opensearch';
 import { Logger } from '../../logging';
 import { GetAuthHeaders, Headers, isOpenSearchDashboardsRequest, isRealRequest } from '../../http';
 import { ensureRawRequest, filterHeaders } from '../../http/router';

diff --git a/src/core/server/opensearch/client/configure_client.test.mocks.ts b/src/core/server/opensearch/client/configure_client.test.mocks.ts
@@ -36,8 +36,8 @@ jest.doMock('./client_config', () => ({
 }));
 
 export const ClientMock = jest.fn();
-jest.doMock('@elastic/elasticsearch', () => {
-  const actual = jest.requireActual('@elastic/elasticsearch');
+jest.doMock('@opensearch-project/opensearch', () => {
+  const actual = jest.requireActual('@opensearch-project/opensearch');
   return {
     ...actual,
     Client: ClientMock,

diff --git a/src/core/server/opensearch/client/configure_client.test.ts b/src/core/server/opensearch/client/configure_client.test.ts
@@ -32,8 +32,8 @@
 import { Buffer } from 'buffer';
 import { Readable } from 'stream';
 
-import { RequestEvent, errors } from '@elastic/elasticsearch';
-import { TransportRequestParams, RequestBody } from '@elastic/elasticsearch/lib/Transport';
+import { RequestEvent, errors } from '@opensearch-project/opensearch';
+import { TransportRequestParams, RequestBody } from '@opensearch-project/opensearch/lib/Transport';
 
 import { parseClientOptionsMock, ClientMock } from './configure_client.test.mocks';
 import { loggingSystemMock } from '../../logging/logging_system.mock';
@@ -131,7 +131,7 @@ describe('configureClient', () => {
   });
 
   describe('Client logging', () => {
-    it('logs error when the client emits an @elastic/elasticsearch error', () => {
+    it('logs error when the client emits an @opensearch-project/opensearch error', () => {
       const client = configureClient(config, { logger, scoped: false });
 
       const response = createApiResponse({ body: {} });

diff --git a/src/core/server/opensearch/client/configure_client.ts b/src/core/server/opensearch/client/configure_client.ts
@@ -31,8 +31,8 @@
  */
 import { Buffer } from 'buffer';
 import { stringify } from 'querystring';
-import { Client } from '@elastic/elasticsearch';
-import { RequestBody } from '@elastic/elasticsearch/lib/Transport';
+import { Client } from '@opensearch-project/opensearch';
+import { RequestBody } from '@opensearch-project/opensearch/lib/Transport';
 
 import { Logger } from '../../logging';
 import { parseClientOptions, OpenSearchClientConfig } from './client_config';

diff --git a/src/core/server/opensearch/client/errors.test.ts b/src/core/server/opensearch/client/errors.test.ts
@@ -34,8 +34,8 @@ import {
   ResponseError,
   ConnectionError,
   ConfigurationError,
-} from '@elastic/elasticsearch/lib/errors';
-import { ApiResponse } from '@elastic/elasticsearch';
+} from '@opensearch-project/opensearch/lib/errors';
+import { ApiResponse } from '@opensearch-project/opensearch';
 import { isResponseError, isUnauthorizedError } from './errors';
 
 const createApiResponseError = ({

diff --git a/src/core/server/opensearch/client/errors.ts b/src/core/server/opensearch/client/errors.ts
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-import { ResponseError } from '@elastic/elasticsearch/lib/errors';
+import { ResponseError } from '@opensearch-project/opensearch/lib/errors';
 
 export type UnauthorizedError = ResponseError & {
   statusCode: 401;

diff --git a/src/core/server/opensearch/client/mocks.test.ts b/src/core/server/opensearch/client/mocks.test.ts
@@ -54,7 +54,6 @@ describe('Mocked client', () => {
   });
 
   it('nested level API methods should be mocked', () => {
-    expectMocked(client.asyncSearch.get);
     expectMocked(client.nodes.info);
   });
 

diff --git a/src/core/server/opensearch/client/mocks.ts b/src/core/server/opensearch/client/mocks.ts
@@ -29,8 +29,8 @@
  * Modifications Copyright OpenSearch Contributors. See
  * GitHub history for details.
  */
-import { Client, ApiResponse } from '@elastic/elasticsearch';
-import { TransportRequestPromise } from '@elastic/elasticsearch/lib/Transport';
+import { Client, ApiResponse } from '@opensearch-project/opensearch';
+import { TransportRequestPromise } from '@opensearch-project/opensearch/lib/Transport';
 import { OpenSearchClient } from './types';
 import { ICustomClusterClient } from './cluster_client';
 
@@ -63,7 +63,7 @@ const createInternalClientMock = (): DeeplyMockedKeys<Client> => {
   };
 
   const mockify = (obj: Record<string, any>, omitted: string[] = []) => {
-    // the @elastic/elasticsearch::Client uses prototypical inheritance
+    // the @opensearch-project/opensearch::Client uses prototypical inheritance
     // so we have to crawl up the prototype chain and get all descriptors
     // to find everything that we should be mocking
     const descriptors = getAllPropertyDescriptors(obj);
@@ -176,9 +176,11 @@ const createErrorTransportRequestPromise = (err: any): MockedTransportRequestPro
   return promise as MockedTransportRequestPromise<never>;
 };
 
-function createApiResponse(opts: Partial<ApiResponse> = {}): ApiResponse {
+function createApiResponse<TResponse = Record<string, any>>(
+  opts: Partial<ApiResponse> = {}
+): ApiResponse<TResponse> {
   return {
-    body: {},
+    body: {} as any,
     statusCode: 200,
     headers: {},
     warnings: [],
-Original file line number
+Diff line change
@@ Expand Up / @@ -54,7 +54,6 @@ describe('Mocked client', () => { @@
       });
       it('nested level API methods should be mocked', () => {
-        expectMocked(client.asyncSearch.get);
         expectMocked(client.nodes.info);
       });
@@ Expand Down @@