[PECO-319] Pending status should not be considered error (#59)

* [PECO-319] PENDING_STATE should not trigger error

Signed-off-by: Levko Kravets <[email protected]>

* Add slight delay between requests when waiting for query completion

Signed-off-by: Levko Kravets <[email protected]>

Signed-off-by: Levko Kravets <[email protected]>

Author: kravets-levko

lib/DBSQLOperation/OperationStatusHelper.ts

@@ -4,6 +4,14 @@ import StatusFactory from '../factory/StatusFactory';
 import { OperationStatusCallback } from '../contracts/IOperation';
 import OperationStateError from '../errors/OperationStateError';
 
+async function delay(ms?: number): Promise<void> {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve();
+    }, ms);
+  });
+}
+
 export default class OperationStatusHelper {
   private driver: HiveDriver;
 
@@ -32,6 +40,7 @@ export default class OperationStatusHelper {
   private isInProgress(response: TGetOperationStatusResp) {
     switch (response.operationState) {
       case TOperationState.INITIALIZED_STATE:
+      case TOperationState.PENDING_STATE:
       case TOperationState.RUNNING_STATE:
         return true;
       default:
@@ -77,6 +86,8 @@ export default class OperationStatusHelper {
     switch (response.operationState) {
       case TOperationState.INITIALIZED_STATE:
         return false;
+      case TOperationState.PENDING_STATE:
+        return false;
       case TOperationState.RUNNING_STATE:
         return false;
       case TOperationState.FINISHED_STATE:
@@ -87,8 +98,6 @@ export default class OperationStatusHelper {
         throw new OperationStateError('The operation was closed by a client', response);
       case TOperationState.ERROR_STATE:
         throw new OperationStateError('The operation failed due to an error', response);
-      case TOperationState.PENDING_STATE:
-        throw new OperationStateError('The operation is in a pending state', response);
       case TOperationState.TIMEDOUT_STATE:
         throw new OperationStateError('The operation is in a timed out state', response);
       case TOperationState.UKNOWN_STATE:
@@ -103,6 +112,7 @@ export default class OperationStatusHelper {
     }
     const isReady = await this.isReady(progress, callback);
     if (!isReady) {
+      await delay(100); // add some delay between status requests
       return this.waitUntilReady(progress, callback);
     }
   }

tests/unit/DBSQLOperation.test.js

@@ -404,30 +404,34 @@ describe('DBSQLOperation', () => {
   });
 
   describe('finished', () => {
-    it('should wait for finished state', async () => {
-      const attemptsUntilFinished = 3;
-
-      const handle = new OperationHandleMock();
-      const driver = new DriverMock();
-      driver.getOperationStatusResp.operationState = TOperationState.RUNNING_STATE;
-      sinon
-        .stub(driver, 'getOperationStatus')
-        .callThrough()
-        .onCall(attemptsUntilFinished - 1) // count is zero-based
-        .callsFake((...args) => {
-          driver.getOperationStatusResp.operationState = TOperationState.FINISHED_STATE;
-          return driver.getOperationStatus.wrappedMethod.apply(driver, args);
-        });
-
-      const operation = new DBSQLOperation(driver, handle);
-
-      expect(operation._status.state).to.equal(TOperationState.INITIALIZED_STATE);
+    [TOperationState.INITIALIZED_STATE, TOperationState.RUNNING_STATE, TOperationState.PENDING_STATE].forEach(
+      (operationState) => {
+        it(`should wait for finished state starting from TOperationState.${TOperationState[operationState]}`, async () => {
+          const attemptsUntilFinished = 3;
+
+          const handle = new OperationHandleMock();
+          const driver = new DriverMock();
+          driver.getOperationStatusResp.operationState = operationState;
+          sinon
+            .stub(driver, 'getOperationStatus')
+            .callThrough()
+            .onCall(attemptsUntilFinished - 1) // count is zero-based
+            .callsFake((...args) => {
+              driver.getOperationStatusResp.operationState = TOperationState.FINISHED_STATE;
+              return driver.getOperationStatus.wrappedMethod.apply(driver, args);
+            });
+
+          const operation = new DBSQLOperation(driver, handle);
+
+          expect(operation._status.state).to.equal(TOperationState.INITIALIZED_STATE);
 
-      await operation.finished();
+          await operation.finished();
 
-      expect(driver.getOperationStatus.callCount).to.be.equal(attemptsUntilFinished);
-      expect(operation._status.state).to.equal(TOperationState.FINISHED_STATE);
-    });
+          expect(driver.getOperationStatus.callCount).to.be.equal(attemptsUntilFinished);
+          expect(operation._status.state).to.equal(TOperationState.FINISHED_STATE);
+        });
+      },
+    );
 
     it('should pick up finished state from directResults', async () => {
       const handle = new OperationHandleMock();
@@ -473,7 +477,6 @@ describe('DBSQLOperation', () => {
       TOperationState.CLOSED_STATE,
       TOperationState.ERROR_STATE,
       TOperationState.UKNOWN_STATE,
-      TOperationState.PENDING_STATE,
       TOperationState.TIMEDOUT_STATE,
     ].forEach((operationState) => {
       it(`should throw an error in case of a TOperationState.${TOperationState[operationState]}`, async () => {