Skip to content

DBSQLOperation Refactoring (2 of 3) #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 26, 2023
Merged

DBSQLOperation Refactoring (2 of 3) #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 0 additions & 118 deletions lib/DBSQLOperation/OperationStatusHelper.ts
View file
Open in desktop

This file was deleted.

122 changes: 106 additions & 16 deletions lib/DBSQLOperation/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ import {
TGetResultSetMetadataResp,
TSparkRowSetType,
TCloseOperationResp,
TOperationState,
} from '../../thrift/TCLIService_types';
import Status from '../dto/Status';
import OperationStatusHelper from './OperationStatusHelper';
import FetchResultsHelper from './FetchResultsHelper';
import IDBSQLLogger, { LogLevel } from '../contracts/IDBSQLLogger';
import OperationStateError, { OperationStateErrorCode } from '../errors/OperationStateError';
Expand All @@ -33,6 +33,14 @@ interface DBSQLOperationConstructorOptions {
logger: IDBSQLLogger;
}

async function delay(ms?: number): Promise<void> {
return new Promise((resolve) => {
setTimeout(() => {
resolve();
}, ms);
});
}

export default class DBSQLOperation implements IOperation {
private readonly driver: HiveDriver;

Expand All @@ -42,8 +50,6 @@ export default class DBSQLOperation implements IOperation {

public onClose?: () => void;

private readonly _status: OperationStatusHelper;

private readonly _data: FetchResultsHelper;

private readonly closeOperation?: TCloseOperationResp;
Expand All @@ -54,6 +60,14 @@ export default class DBSQLOperation implements IOperation {

private metadata?: TGetResultSetMetadataResp;

private state: number = TOperationState.INITIALIZED_STATE;

// Once operation is finished or fails - cache status response, because subsequent calls
// to `getOperationStatus()` may fail with irrelevant errors, e.g. HTTP 404
private operationStatus?: TGetOperationStatusResp;

private hasResultSet: boolean = false;

private resultHandler?: IOperationResult;

constructor(
Expand All @@ -68,7 +82,11 @@ export default class DBSQLOperation implements IOperation {

const useOnlyPrefetchedResults = Boolean(directResults?.closeOperation);

this._status = new OperationStatusHelper(this.driver, this.operationHandle, directResults?.operationStatus);
this.hasResultSet = operationHandle.hasResultSet;
if (directResults?.operationStatus) {
this.processOperationStatusResponse(directResults.operationStatus);
}

this.metadata = directResults?.resultSetMetadata;
this._data = new FetchResultsHelper(
this.driver,
Expand Down Expand Up @@ -117,7 +135,7 @@ export default class DBSQLOperation implements IOperation {
public async fetchChunk(options?: FetchOptions): Promise<Array<object>> {
await this.failIfClosed();

if (!this._status.hasResultSet) {
if (!this.hasResultSet) {
return [];
}

Expand Down Expand Up @@ -146,7 +164,17 @@ export default class DBSQLOperation implements IOperation {
public async status(progress: boolean = false): Promise<TGetOperationStatusResp> {
await this.failIfClosed();
this.logger?.log(LogLevel.debug, `Fetching status for operation with id: ${this.getId()}`);
return this._status.status(progress);

if (this.operationStatus) {
return this.operationStatus;
}

const response = await this.driver.getOperationStatus({
operationHandle: this.operationHandle,
getProgressUpdate: progress,
});

return this.processOperationStatusResponse(response);
}

/**
Expand Down Expand Up @@ -220,7 +248,7 @@ export default class DBSQLOperation implements IOperation {
public async getSchema(options?: GetSchemaOptions): Promise<TTableSchema | null> {
await this.failIfClosed();

if (!this._status.hasResultSet) {
if (!this.hasResultSet) {
return null;
}

Expand All @@ -247,18 +275,58 @@ export default class DBSQLOperation implements IOperation {
}

private async waitUntilReady(options?: WaitUntilReadyOptions) {
try {
await this._status.waitUntilReady(options);
} catch (error) {
if (error instanceof OperationStateError) {
if (error.errorCode === OperationStateErrorCode.Canceled) {
if (this.state === TOperationState.FINISHED_STATE) {
return;
}

let isReady = false;

while (!isReady) {
// eslint-disable-next-line no-await-in-loop
const response = await this.status(Boolean(options?.progress));

if (options?.callback) {
// eslint-disable-next-line no-await-in-loop
await Promise.resolve(options.callback(response));
}

switch (response.operationState) {
// For these states do nothing and continue waiting
case TOperationState.INITIALIZED_STATE:
case TOperationState.PENDING_STATE:
case TOperationState.RUNNING_STATE:
break;

// Operation is completed, so exit the loop
case TOperationState.FINISHED_STATE:
isReady = true;
break;

// Operation was cancelled, so set a flag and exit the loop (throw an error)
case TOperationState.CANCELED_STATE:
this.cancelled = true;
}
if (error.errorCode === OperationStateErrorCode.Closed) {
throw new OperationStateError(OperationStateErrorCode.Canceled, response);

// Operation was closed, so set a flag and exit the loop (throw an error)
case TOperationState.CLOSED_STATE:
this.closed = true;
}
throw new OperationStateError(OperationStateErrorCode.Closed, response);

// Error states - throw and exit the loop
case TOperationState.ERROR_STATE:
throw new OperationStateError(OperationStateErrorCode.Error, response);
case TOperationState.TIMEDOUT_STATE:
throw new OperationStateError(OperationStateErrorCode.Timeout, response);
case TOperationState.UKNOWN_STATE:
default:
throw new OperationStateError(OperationStateErrorCode.Unknown, response);
}

// If not ready yet - make some delay before the next status requests
if (!isReady) {
// eslint-disable-next-line no-await-in-loop
await delay(100);
}
throw error;
}
}

Expand Down Expand Up @@ -301,4 +369,26 @@ export default class DBSQLOperation implements IOperation {

return this.resultHandler;
}

private processOperationStatusResponse(response: TGetOperationStatusResp) {
Status.assert(response.status);

this.state = response.operationState ?? this.state;

if (typeof response.hasResultSet === 'boolean') {
this.hasResultSet = response.hasResultSet;
}

const isInProgress = [
TOperationState.INITIALIZED_STATE,
TOperationState.PENDING_STATE,
TOperationState.RUNNING_STATE,
].includes(this.state);

if (!isInProgress) {
this.operationStatus = response;
}

return response;
}
}
Loading