Installed AirBnB linter and ran --fix for trivial issues (#48)

nithinkdb · web-flow · commit 37c803538134 · 2022-08-19T22:38:27.000+03:00
* Installed AirBnB linter and ran --fix for trivial issues

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Changed package-lock, added script to auto lint

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Added prettier config

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Added linter, changed github workflow, and linted

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Updated script to remove unnecessary npx, updated fix script to run prettier write.

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Fixed commments

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

* Changed contributing.md

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;

Signed-off-by: nithinkdb &lt;nithin.krishnamurthi@databricks.com&gt;
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,19 @@
+{
+  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "overrides": [
+    {
+      "files": ["*.js", "*.ts"],
+      "rules": {
+        "class-methods-use-this": "off",
+        "no-underscore-dangle": "off",
+        "consistent-return": "off",
+        "no-param-reassign": "off",
+        "no-bitwise": "off",
+        "@typescript-eslint/no-throw-literal": "off"
+      }
+    }
+  ]
+}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -27,7 +27,8 @@ jobs:
       - name: Check code style
         run: |
           npm ci
-          npm run prettier:check
+          npm run prettier
+          npm run lint
 
   test:
     runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
@@ -5,5 +5,6 @@ node_modules
 .nyc_output
 coverage_e2e
 coverage_unit
-
+*.code-workspace
 dist
+*.DS_Store
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -100,16 +100,18 @@ npm run e2e
 Code style:
 
 ```bash
-npm run prettier:check
+npm run prettier
 npm run prettier:fix
+npm run lint
+npm run lint:fix
 ```
 
 ## Pull Request Process
 
 1. Update the [CHANGELOG](CHANGELOG.md) with details of your changes, if applicable.
 2. Add any appropriate tests.
 3. Make your code or other changes.
-4. Follow code style: `npm run prettier:fix`
+4. Follow code style: `npm run prettier:fix; npm run lint:fix`
 5. Review guidelines such as
    [How to write the perfect pull request][github-perfect-pr], thanks!
 
diff --git a/lib/DBSQLClient.ts b/lib/DBSQLClient.ts
@@ -1,5 +1,6 @@
 import thrift from 'thrift';
 
+import { EventEmitter } from 'events';
 import TCLIService from '../thrift/TCLIService';
 import TCLIService_types, { TOpenSessionReq } from '../thrift/TCLIService_types';
 import IDBSQLClient, { IDBSQLConnectionOptions } from './contracts/IDBSQLClient';
@@ -12,18 +13,22 @@ import IAuthentication from './connection/contracts/IAuthentication';
 import NoSaslAuthentication from './connection/auth/NoSaslAuthentication';
 import HttpConnection from './connection/connections/HttpConnection';
 import IConnectionOptions from './connection/contracts/IConnectionOptions';
-import { EventEmitter } from 'events';
 import StatusFactory from './factory/StatusFactory';
 import HiveDriverError from './errors/HiveDriverError';
 import { buildUserAgentString, definedOrError } from './utils';
 import PlainHttpAuthentication from './connection/auth/PlainHttpAuthentication';
 
 export default class DBSQLClient extends EventEmitter implements IDBSQLClient {
   private client: TCLIService.Client | null;
+
   private connection: IThriftConnection | null;
+
   private statusFactory: StatusFactory;
+
   private connectionProvider: IConnectionProvider;
+
   private authProvider: IAuthentication;
+
   private thrift = thrift;
 
   constructor() {
diff --git a/lib/DBSQLOperation/getResult.ts b/lib/DBSQLOperation/getResult.ts
@@ -6,9 +6,8 @@ import JsonResult from '../result/JsonResult';
 function getHandler(schema: TTableSchema | null, data: Array<TRowSet>): IOperationResult {
   if (schema === null) {
     return new NullResult();
-  } else {
-    return new JsonResult(schema, data);
   }
+  return new JsonResult(schema, data);
 }
 
 export default function getResult(schema: TTableSchema | null, data: Array<TRowSet>) {
diff --git a/lib/DBSQLOperation/index.ts b/lib/DBSQLOperation/index.ts
@@ -20,15 +20,21 @@ import getResult from './getResult';
 
 export default class DBSQLOperation implements IOperation {
   private driver: HiveDriver;
+
   private operationHandle: TOperationHandle;
+
   private schema: TTableSchema | null = null;
+
   private data: Array<TRowSet> = [];
+
   private statusFactory = new StatusFactory();
 
   private fetchType: number = 0;
 
   private _hasMoreRows: boolean = false;
+
   private state: number = TOperationState.INITIALIZED_STATE;
+
   private hasResultSet: boolean = false;
 
   constructor(driver: HiveDriver, operationHandle: TOperationHandle) {
@@ -65,15 +71,14 @@ export default class DBSQLOperation implements IOperation {
           return this.firstFetch(chunkSize);
         })
         .then((response) => this.processFetchResponse(response));
-    } else {
-      return this.nextFetch(chunkSize).then((response) => this.processFetchResponse(response));
     }
+    return this.nextFetch(chunkSize).then((response) => this.processFetchResponse(response));
   }
 
   async fetchAll(options?: IFetchOptions): Promise<Array<object>> {
-    let data: Array<object> = [];
+    const data: Array<object> = [];
     do {
-      let chunk = await this.fetchChunk(options);
+      const chunk = await this.fetchChunk(options); // eslint-disable-line no-await-in-loop
       if (chunk) {
         data.push(...chunk);
       }
@@ -88,8 +93,8 @@ export default class DBSQLOperation implements IOperation {
 
     await waitUntilReady(this, options.progress, options.callback);
 
-    return await this.fetch(options.maxRows).then(() => {
-      let data = getResult(this.getSchema(), this.getData());
+    return this.fetch(options.maxRows).then(() => {
+      const data = getResult(this.getSchema(), this.getData());
       this.flush();
       return Promise.resolve(data);
     });
@@ -128,9 +133,7 @@ export default class DBSQLOperation implements IOperation {
       .cancelOperation({
         operationHandle: this.operationHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   /**
@@ -142,9 +145,7 @@ export default class DBSQLOperation implements IOperation {
       .closeOperation({
         operationHandle: this.operationHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   finished(): boolean {
diff --git a/lib/DBSQLOperation/waitUntilReady.ts b/lib/DBSQLOperation/waitUntilReady.ts
@@ -7,7 +7,7 @@ async function isReady(
   progress?: boolean,
   callback?: OperationStatusCallback,
 ): Promise<boolean> {
-  let response = await operation.status(Boolean(progress));
+  const response = await operation.status(Boolean(progress));
 
   if (callback) {
     await Promise.resolve(callback(response));
@@ -46,7 +46,6 @@ export default async function waitUntilReady(
   }
   if (await isReady(operation, progress, callback)) {
     return;
-  } else {
-    return waitUntilReady(operation, progress, callback);
   }
+  return waitUntilReady(operation, progress, callback);
 }
diff --git a/lib/DBSQLSession.ts b/lib/DBSQLSession.ts
@@ -18,7 +18,9 @@ import { definedOrError } from './utils';
 
 export default class DBSQLSession implements IDBSQLSession {
   private driver: HiveDriver;
+
   private sessionHandle: TSessionHandle;
+
   private statusFactory: StatusFactory;
 
   constructor(driver: HiveDriver, sessionHandle: TSessionHandle) {
@@ -234,9 +236,7 @@ export default class DBSQLSession implements IDBSQLSession {
       .closeSession({
         sessionHandle: this.sessionHandle,
       })
-      .then((response) => {
-        return this.statusFactory.create(response.status);
-      });
+      .then((response) => this.statusFactory.create(response.status));
   }
 
   private createOperation(handle: TOperationHandle): IOperation {
diff --git a/lib/connection/auth/PlainHttpAuthentication.ts b/lib/connection/auth/PlainHttpAuthentication.ts
@@ -8,7 +8,9 @@ type HttpAuthOptions = AuthOptions & {
 
 export default class PlainHttpAuthentication implements IAuthentication {
   private username: string;
+
   private password: string;
+
   private headers: object;
 
   constructor(options: HttpAuthOptions) {
@@ -27,6 +29,6 @@ export default class PlainHttpAuthentication implements IAuthentication {
   }
 
   private getToken(username: string, password: string): string {
-    return 'Basic ' + Buffer.from(`${username}:${password}`).toString('base64');
+    return `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
   }
 }
diff --git a/lib/connection/connections/HttpConnection.ts b/lib/connection/connections/HttpConnection.ts
@@ -1,12 +1,12 @@
 import thrift from 'thrift';
 import https from 'https';
 
+import { IncomingMessage } from 'http';
 import IThriftConnection from '../contracts/IThriftConnection';
 import IConnectionProvider from '../contracts/IConnectionProvider';
 import IConnectionOptions, { Options } from '../contracts/IConnectionOptions';
 import IAuthentication from '../contracts/IAuthentication';
 import HttpTransport from '../transports/HttpTransport';
-import { IncomingMessage } from 'http';
 
 type NodeOptions = {
   ca?: Buffer | string;
@@ -17,6 +17,7 @@ type NodeOptions = {
 
 export default class HttpConnection implements IConnectionProvider, IThriftConnection {
   private thrift = thrift;
+
   private connection: any;
 
   connect(options: IConnectionOptions, authProvider: IAuthentication): Promise<IThriftConnection> {
@@ -51,13 +52,12 @@ export default class HttpConnection implements IConnectionProvider, IThriftConne
   isConnected(): boolean {
     if (this.connection) {
       return true;
-    } else {
-      return false;
     }
+    return false;
   }
 
   private getNodeOptions(options: Options): object {
-    const { ca, cert, key, https } = options;
+    const { ca, cert, key, https: useHttps } = options;
     const nodeOptions: NodeOptions = {};
 
     if (ca) {
@@ -70,21 +70,21 @@ export default class HttpConnection implements IConnectionProvider, IThriftConne
       nodeOptions.key = key;
     }
 
-    if (https) {
+    if (useHttps) {
       nodeOptions.rejectUnauthorized = false;
     }
 
     return nodeOptions;
   }
 
   private addCookieHandler() {
-    const responseCallback = this.connection.responseCallback;
+    const { responseCallback } = this.connection;
 
     this.connection.responseCallback = (response: IncomingMessage) => {
       if (Array.isArray(response.headers['set-cookie'])) {
-        let cookie = [this.connection.nodeOptions.headers['cookie']];
+        const cookie = [this.connection.nodeOptions.headers.cookie];
 
-        this.connection.nodeOptions.headers['cookie'] = cookie
+        this.connection.nodeOptions.headers.cookie = cookie
           .concat(response.headers['set-cookie'])
           .filter(Boolean)
           .join(';');
diff --git a/lib/connection/transports/HttpTransport.ts b/lib/connection/transports/HttpTransport.ts
@@ -23,9 +23,14 @@ export default class HttpTransport implements ITransport {
   }
 
   connect() {}
+
   addListener() {}
+
   removeListener() {}
+
   write() {}
+
   end() {}
+
   emit() {}
 }
diff --git a/lib/dto/InfoValue.ts b/lib/dto/InfoValue.ts
@@ -15,16 +15,19 @@ export default class InfoValue {
 
     if (infoValue.stringValue) {
       return infoValue.stringValue;
-    } else if (infoValue.smallIntValue) {
+    }
+    if (infoValue.smallIntValue) {
       return infoValue.smallIntValue;
-    } else if (infoValue.integerBitmask) {
+    }
+    if (infoValue.integerBitmask) {
       return infoValue.integerBitmask;
-    } else if (infoValue.integerFlag) {
+    }
+    if (infoValue.integerFlag) {
       return infoValue.integerFlag;
-    } else if (infoValue.lenValue) {
+    }
+    if (infoValue.lenValue) {
       return infoValue.lenValue;
-    } else {
-      return null;
     }
+    return null;
   }
 }
diff --git a/lib/dto/Status.ts b/lib/dto/Status.ts
@@ -6,7 +6,9 @@ type StatusData = {
 
 export default class Status {
   private isSuccess: boolean;
+
   private isExecuting: boolean;
+
   private infoMessages: Array<string>;
 
   constructor(data: StatusData) {
diff --git a/lib/errors/StatusError.ts b/lib/errors/StatusError.ts
@@ -2,8 +2,11 @@ import { TStatus } from '../../thrift/TCLIService_types';
 
 export default class StatusError implements Error {
   public name: string;
+
   public message: string;
+
   public code: number;
+
   public stack?: string;
 
   constructor(status: TStatus) {
diff --git a/lib/hive/Commands/BaseCommand.ts b/lib/hive/Commands/BaseCommand.ts
@@ -11,9 +11,8 @@ export default abstract class BaseCommand {
   executeCommand<Response>(request: object, command: Function | void): Promise<Response> {
     return new Promise((resolve, reject) => {
       if (typeof command !== 'function') {
-        return reject(
-          new HiveDriverError('Hive driver: the operation does not exist, try to choose another Thrift file.'),
-        );
+        reject(new HiveDriverError('Hive driver: the operation does not exist, try to choose another Thrift file.'));
+        return;
       }
 
       try {
diff --git a/lib/result/JsonResult.ts b/lib/result/JsonResult.ts
diff --git a/lib/utils/formatProgress.ts b/lib/utils/formatProgress.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,8 @@ import JsonResult from '../result/JsonResult';`
`6`	`6`	`function getHandler(schema: TTableSchema \| null, data: Array<TRowSet>): IOperationResult {`
`7`	`7`	`if (schema === null) {`
`8`	`8`	`return new NullResult();`
`9`		`- } else {`
`10`		`- return new JsonResult(schema, data);`
`11`	`9`	`}`
	`10`	`+ return new JsonResult(schema, data);`
`12`	`11`	`}`
`13`	`12`
`14`	`13`	`export default function getResult(schema: TTableSchema \| null, data: Array<TRowSet>) {`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ async function isReady(`
`7`	`7`	`progress?: boolean,`
`8`	`8`	`callback?: OperationStatusCallback,`
`9`	`9`	`): Promise<boolean> {`
`10`		`- let response = await operation.status(Boolean(progress));`
	`10`	`+ const response = await operation.status(Boolean(progress));`
`11`	`11`
`12`	`12`	`if (callback) {`
`13`	`13`	`await Promise.resolve(callback(response));`
`@@ -46,7 +46,6 @@ export default async function waitUntilReady(`
`46`	`46`	`}`
`47`	`47`	`if (await isReady(operation, progress, callback)) {`
`48`	`48`	`return;`
`49`		`- } else {`
`50`		`- return waitUntilReady(operation, progress, callback);`
`51`	`49`	`}`
	`50`	`+ return waitUntilReady(operation, progress, callback);`
`52`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,9 @@ type HttpAuthOptions = AuthOptions & {`
`8`	`8`
`9`	`9`	`export default class PlainHttpAuthentication implements IAuthentication {`
`10`	`10`	`private username: string;`
	`11`	`+`
`11`	`12`	`private password: string;`
	`13`	`+`
`12`	`14`	`private headers: object;`
`13`	`15`
`14`	`16`	`constructor(options: HttpAuthOptions) {`
`@@ -27,6 +29,6 @@ export default class PlainHttpAuthentication implements IAuthentication {`
`27`	`29`	`}`
`28`	`30`
`29`	`31`	`private getToken(username: string, password: string): string {`
`30`		- return 'Basic ' + Buffer.from(`${username}:${password}`).toString('base64');
	`32`	+ return `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`;
`31`	`33`	`}`
`32`	`34`	`}`