Polish & cleanup

Signed-off-by: Levko Kravets <[email protected]>
databricks · May 21, 2024 · 275bdbf · 275bdbf
1 parent d178684
commit 275bdbf
Show file tree

Hide file tree

Showing 29 changed files with 598 additions and 768 deletions.
diff --git a/lib/DBSQLClient.ts b/lib/DBSQLClient.ts
@@ -51,21 +51,21 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
 
   private readonly config: ClientConfig;
 
-  protected connectionProvider?: IConnectionProvider;
+  private connectionProvider?: IConnectionProvider;
 
-  protected authProvider?: IAuthentication;
+  private authProvider?: IAuthentication;
 
-  protected client?: IThriftClient;
+  private client?: IThriftClient;
 
   private readonly driver = new HiveDriver({
     context: this,
   });
 
   private readonly logger: IDBSQLLogger;
 
-  protected thrift: ThriftLibrary = thrift;
+  private thrift: ThriftLibrary = thrift;
 
-  protected sessions = new CloseableCollection<DBSQLSession>();
+  private readonly sessions = new CloseableCollection<DBSQLSession>();
 
   private static getDefaultLogger(): IDBSQLLogger {
     if (!this.defaultLogger) {
@@ -102,7 +102,7 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
     this.logger.log(LogLevel.info, 'Created DBSQLClient');
   }
 
-  protected getConnectionOptions(options: ConnectionOptions): IConnectionOptions {
+  private getConnectionOptions(options: ConnectionOptions): IConnectionOptions {
     return {
       host: options.host,
       port: options.port || 443,
@@ -116,7 +116,7 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
     };
   }
 
-  protected createAuthProvider(options: ConnectionOptions, authProvider?: IAuthentication): IAuthentication {
+  private createAuthProvider(options: ConnectionOptions, authProvider?: IAuthentication): IAuthentication {
     if (authProvider) {
       return authProvider;
     }
@@ -146,7 +146,7 @@ export default class DBSQLClient extends EventEmitter implements IDBSQLClient, I
     }
   }
 
-  protected createConnectionProvider(options: ConnectionOptions): IConnectionProvider {
+  private createConnectionProvider(options: ConnectionOptions): IConnectionProvider {
     return new HttpConnection(this.getConnectionOptions(options), this);
   }
 

diff --git a/lib/DBSQLOperation.ts b/lib/DBSQLOperation.ts
@@ -48,21 +48,21 @@ async function delay(ms?: number): Promise<void> {
 }
 
 export default class DBSQLOperation implements IOperation {
-  protected readonly context: IClientContext;
+  private readonly context: IClientContext;
 
-  protected readonly operationHandle: TOperationHandle;
+  private readonly operationHandle: TOperationHandle;
 
-  protected readonly _data: RowSetProvider;
+  private readonly _data: RowSetProvider;
 
-  protected readonly closeOperation?: TCloseOperationResp;
+  private readonly closeOperation?: TCloseOperationResp;
 
-  protected closed: boolean = false;
+  private closed: boolean = false;
 
-  protected cancelled: boolean = false;
+  private cancelled: boolean = false;
 
-  protected metadata?: TGetResultSetMetadataResp;
+  private metadata?: TGetResultSetMetadataResp;
 
-  protected state: number = TOperationState.INITIALIZED_STATE;
+  private state: TOperationState = TOperationState.INITIALIZED_STATE;
 
   public onClose?: () => void;
 
@@ -376,7 +376,7 @@ export default class DBSQLOperation implements IOperation {
     return this.metadata;
   }
 
-  protected async getResultHandler(): Promise<ResultSlicer<any>> {
+  private async getResultHandler(): Promise<ResultSlicer<any>> {
     const metadata = await this.fetchMetadata();
     const resultFormat = definedOrError(metadata.resultFormat);
 

diff --git a/lib/DBSQLSession.ts b/lib/DBSQLSession.ts
@@ -143,9 +143,9 @@ export default class DBSQLSession implements IDBSQLSession {
 
   private readonly sessionHandle: TSessionHandle;
 
-  protected isOpen = true;
+  private isOpen = true;
 
-  protected operations = new CloseableCollection<DBSQLOperation>();
+  private operations = new CloseableCollection<DBSQLOperation>();
 
   public onClose?: () => void;
 

diff --git a/lib/connection/auth/DatabricksOAuth/AuthorizationCode.ts b/lib/connection/auth/DatabricksOAuth/AuthorizationCode.ts
@@ -129,7 +129,7 @@ export default class AuthorizationCode {
     throw new AuthenticationError('Failed to start server: all ports are in use');
   }
 
-  protected createHttpServer(requestHandler: (req: IncomingMessage, res: ServerResponse) => void) {
+  private createHttpServer(requestHandler: (req: IncomingMessage, res: ServerResponse) => void) {
     return http.createServer(requestHandler);
   }
 

diff --git a/lib/connection/auth/DatabricksOAuth/index.ts b/lib/connection/auth/DatabricksOAuth/index.ts
@@ -16,16 +16,15 @@ export interface DatabricksOAuthOptions extends OAuthManagerOptions {
 export default class DatabricksOAuth implements IAuthentication {
   private readonly context: IClientContext;
 
-  protected readonly options: DatabricksOAuthOptions;
+  private readonly options: DatabricksOAuthOptions;
 
-  protected readonly manager: OAuthManager;
+  private manager?: OAuthManager;
 
   private readonly defaultPersistence = new OAuthPersistenceCache();
 
   constructor(options: DatabricksOAuthOptions) {
     this.context = options.context;
     this.options = options;
-    this.manager = this.createManager(this.options);
   }
 
   public async authenticate(): Promise<HeadersInit> {
@@ -35,10 +34,10 @@ export default class DatabricksOAuth implements IAuthentication {
 
     let token = await persistence.read(host);
     if (!token) {
-      token = await this.manager.getToken(scopes ?? defaultOAuthScopes);
+      token = await this.getManager().getToken(scopes ?? defaultOAuthScopes);
     }
 
-    token = await this.manager.refreshAccessToken(token);
+    token = await this.getManager().refreshAccessToken(token);
     await persistence.persist(host, token);
 
     return {
@@ -47,7 +46,10 @@ export default class DatabricksOAuth implements IAuthentication {
     };
   }
 
-  protected createManager(options: OAuthManagerOptions): OAuthManager {
-    return OAuthManager.getManager(options);
+  private getManager(): OAuthManager {
+    if (!this.manager) {
+      this.manager = OAuthManager.getManager(this.options);
+    }
+    return this.manager;
   }
 }
diff --git a/lib/connection/auth/PlainHttpAuthentication.ts b/lib/connection/auth/PlainHttpAuthentication.ts
@@ -10,13 +10,13 @@ interface PlainHttpAuthenticationOptions {
 }
 
 export default class PlainHttpAuthentication implements IAuthentication {
-  protected readonly context: IClientContext;
+  private readonly context: IClientContext;
 
-  protected readonly username: string;
+  private readonly username: string;
 
-  protected readonly password: string;
+  private readonly password: string;
 
-  protected readonly headers: HeadersInit;
+  private readonly headers: HeadersInit;
 
   constructor(options: PlainHttpAuthenticationOptions) {
     this.context = options.context;

diff --git a/lib/connection/connections/HttpConnection.ts b/lib/connection/connections/HttpConnection.ts
@@ -17,7 +17,7 @@ export default class HttpConnection implements IConnectionProvider {
 
   private readonly context: IClientContext;
 
-  protected headers: HeadersInit = {};
+  private headers: HeadersInit = {};
 
   private connection?: ThriftHttpConnection;
 

diff --git a/lib/connection/connections/HttpRetryPolicy.ts b/lib/connection/connections/HttpRetryPolicy.ts
@@ -10,11 +10,11 @@ function delay(milliseconds: number): Promise<void> {
 }
 
 export default class HttpRetryPolicy implements IRetryPolicy<HttpTransactionDetails> {
-  protected context: IClientContext;
+  private context: IClientContext;
 
-  protected startTime: number; // in milliseconds
+  private startTime: number; // in milliseconds
 
-  protected attempt: number;
+  private attempt: number;
 
   constructor(context: IClientContext) {
     this.context = context;

diff --git a/lib/result/ArrowResultConverter.ts b/lib/result/ArrowResultConverter.ts
@@ -24,9 +24,9 @@ type ArrowSchema = Schema<TypeMap>;
 type ArrowSchemaField = Field<DataType<Type, TypeMap>>;
 
 export default class ArrowResultConverter implements IResultsProvider<Array<any>> {
-  protected readonly context: IClientContext;
+  private readonly context: IClientContext;
 
-  public readonly source: IResultsProvider<ArrowBatch>;
+  private readonly source: IResultsProvider<ArrowBatch>;
 
   private readonly schema: Array<TColumnDesc>;
 

diff --git a/lib/result/ArrowResultHandler.ts b/lib/result/ArrowResultHandler.ts
@@ -6,11 +6,11 @@ import { ArrowBatch, hiveSchemaToArrowSchema } from './utils';
 import { LZ4 } from '../utils';
 
 export default class ArrowResultHandler implements IResultsProvider<ArrowBatch> {
-  protected readonly context: IClientContext;
+  private readonly context: IClientContext;
 
-  public readonly source: IResultsProvider<TRowSet | undefined>;
+  private readonly source: IResultsProvider<TRowSet | undefined>;
 
-  protected readonly arrowSchema?: Buffer;
+  private readonly arrowSchema?: Buffer;
 
   private readonly isLZ4Compressed: boolean;
 

diff --git a/lib/result/CloudFetchResultHandler.ts b/lib/result/CloudFetchResultHandler.ts
@@ -7,15 +7,15 @@ import { ArrowBatch } from './utils';
 import { LZ4 } from '../utils';
 
 export default class CloudFetchResultHandler implements IResultsProvider<ArrowBatch> {
-  protected readonly context: IClientContext;
+  private readonly context: IClientContext;
 
-  public readonly source: IResultsProvider<TRowSet | undefined>;
+  private readonly source: IResultsProvider<TRowSet | undefined>;
 
   private readonly isLZ4Compressed: boolean;
 
-  protected pendingLinks: Array<TSparkArrowResultLink> = [];
+  private pendingLinks: Array<TSparkArrowResultLink> = [];
 
-  protected downloadTasks: Array<Promise<ArrowBatch>> = [];
+  private downloadTasks: Array<Promise<ArrowBatch>> = [];
 
   constructor(
     context: IClientContext,

diff --git a/lib/result/JsonResultHandler.ts b/lib/result/JsonResultHandler.ts
@@ -6,7 +6,7 @@ import { getSchemaColumns, convertThriftValue, getColumnValue } from './utils';
 export default class JsonResultHandler implements IResultsProvider<Array<any>> {
   private readonly context: IClientContext;
 
-  public readonly source: IResultsProvider<TRowSet | undefined>;
+  private readonly source: IResultsProvider<TRowSet | undefined>;
 
   private readonly schema: Array<TColumnDesc>;
 
@@ -72,7 +72,7 @@ export default class JsonResultHandler implements IResultsProvider<Array<any>> {
     });
   }
 
-  protected isNull(nulls: Buffer, i: number): boolean {
+  private isNull(nulls: Buffer, i: number): boolean {
     const byte = nulls[Math.floor(i / 8)];
     const ofs = 2 ** (i % 8);
 

diff --git a/lib/result/ResultSlicer.ts b/lib/result/ResultSlicer.ts
@@ -10,7 +10,7 @@ export interface ResultSlicerFetchNextOptions extends ResultsProviderFetchNextOp
 export default class ResultSlicer<T> implements IResultsProvider<Array<T>> {
   private readonly context: IClientContext;
 
-  public readonly source: IResultsProvider<Array<T>>;
+  private readonly source: IResultsProvider<Array<T>>;
 
   private remainingResults: Array<T> = [];
 

diff --git a/lib/utils/CloseableCollection.ts b/lib/utils/CloseableCollection.ts
@@ -5,7 +5,7 @@ export interface ICloseable {
 }
 
 export default class CloseableCollection<T extends ICloseable> {
-  protected items = new Set<T>();
+  private items = new Set<T>();
 
   public add(item: T) {
     item.onClose = () => {

diff --git a/tests/unit/.stubs/ClientContextStub.ts b/tests/unit/.stubs/ClientContextStub.ts
@@ -26,8 +26,7 @@ export default class ClientContextStub implements IClientContext {
   }
 
   public getConfig(): ClientConfig {
-    // @ts-expect-error TS2341: Property getDefaultConfig is private and only accessible within class DBSQLClient
-    const defaultConfig = DBSQLClient.getDefaultConfig();
+    const defaultConfig = DBSQLClient['getDefaultConfig']();
     return {
       ...defaultConfig,
       ...this.configOverrides,