remove apikey and bearer auth (#111)

* remove apikey and bearer auth Issue Resolved: #110 Signed-off-by: Anan Zhuang <[email protected]> * change auth to username for child Signed-off-by: Anan Zhuang <[email protected]>
opensearch-project · Aug 6, 2021 · 705df17 · 705df17
1 parent 9e64c1b
commit 705df17
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 333 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -53,9 +53,7 @@ import {
   BaseConnectionPool,
   CloudConnectionPool,
   ResurrectEvent,
-  BasicAuth,
-  ApiKeyAuth,
-  BearerAuth
+  BasicAuth
 } from './lib/pool';
 import Serializer from './lib/Serializer';
 import Helpers from './lib/Helpers';
@@ -117,7 +115,7 @@ interface ClientOptions {
   opaqueIdPrefix?: string;
   generateRequestId?: generateRequestIdFn;
   name?: string | symbol;
-  auth?: BasicAuth | ApiKeyAuth | BearerAuth;
+  auth?: BasicAuth;
   context?: Context;
   proxy?: string | URL;
   enableMetaHeader?: boolean;

diff --git a/lib/Connection.d.ts b/lib/Connection.d.ts
@@ -33,7 +33,7 @@
 import { URL } from 'url';
 import { inspect, InspectOptions } from 'util'
 import { Readable as ReadableStream } from 'stream';
-import { ApiKeyAuth, BasicAuth } from './pool'
+import { BasicAuth } from './pool'
 import * as http from 'http'
 import * as https from 'https'
 import * as hpagent from 'hpagent'
@@ -49,7 +49,7 @@ export interface ConnectionOptions {
   agent?: AgentOptions | agentFn;
   status?: string;
   roles?: ConnectionRoles;
-  auth?: BasicAuth | ApiKeyAuth;
+  auth?: BasicAuth;
   proxy?: string | URL;
 }
 

diff --git a/lib/Connection.js b/lib/Connection.js
@@ -334,15 +334,7 @@ function resolve (host, path) {
 function prepareHeaders (headers = {}, auth) {
   if (auth != null && headers.authorization == null) {
     /* istanbul ignore else */
-    if (auth.apiKey) {
-      if (typeof auth.apiKey === 'object') {
-        headers.authorization = 'ApiKey ' + Buffer.from(`${auth.apiKey.id}:${auth.apiKey.api_key}`).toString('base64')
-      } else {
-        headers.authorization = `ApiKey ${auth.apiKey}`
-      }
-    } else if (auth.bearer) {
-      headers.authorization = `Bearer ${auth.bearer}`
-    } else if (auth.username && auth.password) {
+    if (auth.username && auth.password) {
       headers.authorization = 'Basic ' + Buffer.from(`${auth.username}:${auth.password}`).toString('base64')
     }
   }

diff --git a/lib/pool/index.d.ts b/lib/pool/index.d.ts
@@ -39,7 +39,7 @@ interface BaseConnectionPoolOptions {
   ssl?: SecureContextOptions;
   agent?: AgentOptions;
   proxy?: string | URL;
-  auth?: BasicAuth | ApiKeyAuth;
+  auth?: BasicAuth;
   emit: (event: string | symbol, ...args: any[]) => boolean;
   Connection: typeof Connection;
 }
@@ -58,24 +58,11 @@ interface getConnectionOptions {
   now?: number;
 }
 
-interface ApiKeyAuth {
-  apiKey:
-    | string
-    | {
-        id: string;
-        api_key: string;
-      }
-}
-
 interface BasicAuth {
   username: string;
   password: string;
 }
 
-interface BearerAuth {
-  bearer: string
-}
-
 interface resurrectOptions {
   now?: number;
   requestId: string;
@@ -100,7 +87,7 @@ declare class BaseConnectionPool {
   _ssl: SecureContextOptions | null;
   _agent: AgentOptions | null;
   _proxy: string | URL;
-  auth: BasicAuth | ApiKeyAuth;
+  auth: BasicAuth;
   Connection: typeof Connection;
   constructor(opts?: BaseConnectionPoolOptions);
   /**
@@ -217,9 +204,7 @@ export {
   // Interfaces
   ConnectionPoolOptions,
   getConnectionOptions,
-  ApiKeyAuth,
   BasicAuth,
-  BearerAuth,
   internals,
   resurrectOptions,
   ResurrectEvent,

diff --git a/test/types/client-options.test-d.ts b/test/types/client-options.test-d.ts
@@ -368,27 +368,6 @@ expectType<Client>(
   })
 )
 
-expectType<Client>(
-  new Client({
-    node: 'http://localhost:9200',
-    auth: {
-      apiKey: 'abcd'
-    }
-  })
-)
-
-expectType<Client>(
-  new Client({
-    node: 'http://localhost:9200',
-    auth: {
-      apiKey: {
-        api_key: 'foo',
-        id: 'bar'
-      }
-    }
-  })
-)
-
 expectError<errors.ConfigurationError>(
   // @ts-expect-error
   new Client({

diff --git a/test/unit/child.test.js b/test/unit/child.test.js
@@ -296,13 +296,8 @@ test('Should create a child client (name check)', t => {
 test('Should create a child client (auth check)', t => {
   t.plan(4)
 
-  let count = 0
   function handler (req, res) {
-    if (count++ === 0) {
-      t.match(req.headers, { authorization: 'Basic Zm9vOmJhcg==' })
-    } else {
-      t.match(req.headers, { authorization: 'ApiKey foobar' })
-    }
+    t.match(req.headers, { authorization: 'Basic Zm9vOmJhcg==' })
     res.setHeader('Content-Type', 'application/json;utf=8')
     res.end(JSON.stringify({ hello: 'world' }))
   }
@@ -317,7 +312,7 @@ test('Should create a child client (auth check)', t => {
     })
     const child = client.child({
       auth: {
-        apiKey: 'foobar'
+        username: 'foobar'
       }
     })