Wrap error

Author: schmidt-sebastian

packages/firestore/package.json

@@ -20,8 +20,8 @@
     "test:all": "run-p test:browser test:travis test:minified",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
-    "test:node": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --file test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
-    "test:node:prod": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --file test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
+    "test:node": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
+    "test:node:prod": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
     "test:node:persistence": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
     "test:node:persistence:prod": "USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
     "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",

packages/firestore/src/local/simple_db.ts

@@ -406,6 +406,18 @@ export interface IterateOptions {
   reverse?: boolean;
 }
 
+/** An error that wraps exceptions that thrown during IndexedDB execution. */
+export class IndexedDbTransactionError extends FirestoreError {
+  name = 'IndexedDbTransactionError';
+
+  constructor(cause: Error) {
+    super(
+      Code.UNKNOWN,
+      'IndexedDB transaction failed with environment error: ' + cause
+    );
+  }
+}
+
 /**
  * Wraps an IDBTransaction and exposes a store() method to get a handle to a
  * specific object store.
@@ -432,7 +444,9 @@ export class SimpleDbTransaction {
     };
     this.transaction.onabort = () => {
       if (transaction.error) {
-        this.completionDeferred.reject(transaction.error);
+        this.completionDeferred.reject(
+          new IndexedDbTransactionError(transaction.error)
+        );
       } else {
         this.completionDeferred.resolve();
       }
@@ -441,7 +455,7 @@ export class SimpleDbTransaction {
       const error = checkForAndReportiOSError(
         (event.target as IDBRequest).error!
       );
-      this.completionDeferred.reject(error);
+      this.completionDeferred.reject(new IndexedDbTransactionError(error));
     };
   }
 

packages/firestore/src/util/async_queue.ts

@@ -21,6 +21,7 @@ import { logDebug, logError } from './log';
 import { CancelablePromise, Deferred } from './promise';
 import { ExponentialBackoff } from '../remote/backoff';
 import { PlatformSupport } from '../platform/platform';
+import { IndexedDbTransactionError } from '../local/simple_db';
 
 const LOG_TAG = 'AsyncQueue';
 
@@ -319,7 +320,7 @@ export class AsyncQueue {
    * Enqueue a retryable operation.
    *
    * A retryable operation is rescheduled with backoff if it fails with a
-   * DOMException or a DOMError (the error types used by IndexedDB). All
+   * SimpleDbTransactionError (the error type used by SimpleDb). All
    * retryable operations are executed in order and only run if all prior
    * operations were retried successfully.
    */
@@ -338,13 +339,7 @@ export class AsyncQueue {
           deferred.resolve();
           this.backoff.reset();
         } catch (e) {
-          // We only retry errors that match the ones thrown by IndexedDB (see
-          // https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction/error)
-          if (
-            (typeof DOMException !== 'undefined' &&
-              e instanceof DOMException) ||
-            (typeof DOMError !== 'undefined' && e instanceof DOMError)
-          ) {
+          if (e.name === 'IndexedDbTransactionError') {
             logDebug(LOG_TAG, 'Operation failed with retryable error: ' + e);
             this.backoff.backoffAndRun(retryingOp);
           } else {

packages/firestore/test/unit/specs/spec_test_components.ts

@@ -35,6 +35,7 @@ import { TargetCache } from '../../../src/local/target_cache';
 import { RemoteDocumentCache } from '../../../src/local/remote_document_cache';
 import { IndexManager } from '../../../src/local/index_manager';
 import { PersistencePromise } from '../../../src/local/persistence_promise';
+import { IndexedDbTransactionError } from '../../../src/local/simple_db';
 import { debugAssert } from '../../../src/util/assert';
 import {
   MemoryEagerDelegate,
@@ -113,7 +114,9 @@ export class MockPersistence implements Persistence {
     ) => PersistencePromise<T>
   ): Promise<T> {
     if (this.injectFailures) {
-      return Promise.reject(new DOMException('Simulated retryable error'));
+      return Promise.reject(
+        new IndexedDbTransactionError(new Error('Simulated retryable error'))
+      );
     } else {
       return this.delegate.runTransaction(action, mode, transactionOperation);
     }

packages/firestore/test/unit/util/async_queue.test.ts

@@ -23,6 +23,7 @@ import { Code } from '../../../src/util/error';
 import { getLogLevel, setLogLevel, LogLevel } from '../../../src/util/log';
 import { Deferred, Rejecter, Resolver } from '../../../src/util/promise';
 import { fail } from '../../../src/util/assert';
+import { IndexedDbTransactionError } from '../../../src/local/simple_db';
 
 use(chaiAsPromised);
 
@@ -217,7 +218,9 @@ describe('AsyncQueue', () => {
     queue.enqueueRetryable(async () => {
       doStep(1);
       if (completedSteps.length === 1) {
-        throw new DOMException('Simulated retryable error');
+        throw new IndexedDbTransactionError(
+          new Error('Simulated retryable error')
+        );
       }
     });
     await queue.runDelayedOperationsEarly(TimerId.AsyncQueueRetry);
@@ -265,7 +268,9 @@ describe('AsyncQueue', () => {
     queue.enqueueRetryable(async () => {
       doStep(1);
       if (completedSteps.length === 1) {
-        throw new DOMException('Simulated retryable error');
+        throw new IndexedDbTransactionError(
+          new Error('Simulated retryable error')
+        );
       }
     });
 
@@ -291,7 +296,9 @@ describe('AsyncQueue', () => {
       doStep(1);
       if (completedSteps.length > 1) {
       } else {
-        throw new DOMException('Simulated retryable error');
+        throw new IndexedDbTransactionError(
+          new Error('Simulated retryable error')
+        );
       }
     });
     queue.enqueueRetryable(async () => {

packages/firestore/test/util/node_persistence.ts

@@ -58,11 +58,3 @@ if (process.env.USE_MOCK_PERSISTENCE === 'YES') {
 
   globalAny.Event = Event;
 }
-
-if (typeof DOMException === 'undefined') {
-  // Define DOMException as it is used in tests
-  class DOMException {
-    constructor(readonly message: string) {}
-  }
-  globalAny.DOMException = DOMException;
-}