@oracle/oraclejet 20.1.0 → 20.1.2

package/dist/js/libs/persist/debug/impl/pouchDBPersistenceStore.js

@@ -97,18 +97,63 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
         }
       };
       // createIndex if using the find plugin
-      return self._db.createIndex(indexSyntax).catch(function(error) {
+      return self._withIdbTimeout(self._db.createIndex(indexSyntax), 'createIndex').catch(function(error) {
         logger.error("creating index on " + self._index.toString() + " failed with error " + error);
       });
     }
   };
 
+  Object.defineProperty(PouchDBPersistenceStore.prototype, '_idbOpTimeoutMs', {
+    value: 2000, // default 2s safety timeout
+    writable: true
+  });
+
+  /** 
+   * Internal helper to avoid hangs
+   * In certain browsers/modes (notably Safari Private/Incognito), IndexedDB operations can never resolve/reject, causing PouchDB's internal taskqueue
+   * To avoid indefinite hangs in our API, wrap IDB-backed calls with a timeout and fail fast/gracefully.
+  */
+  Object.defineProperty(PouchDBPersistenceStore.prototype, '_idbOpTimeout', {
+    value: false,
+    writable: true
+  });
+
+  PouchDBPersistenceStore.prototype._withIdbTimeout = function (promise, opName) {
+    var self = this;
+    var createTimeoutError = function () {
+      return { name: 'IDBTimeout', message: opName + ' failed due to IndexedDB timeout' };
+    };
+    if (self._idbOpTimeout) {
+      return Promise.reject(createTimeoutError());
+    }
+    var timer = null;
+    var clearTimer = function () {
+      if (timer !== null) {
+        clearTimeout(timer);
+        timer = null;
+      }
+    };
+    var timedOut = new Promise(function (_, reject) {
+      timer = setTimeout(function () {
+        self._idbOpTimeout = true; // set the flag to true to avoid future calls to pouchDB, which will likely fail/hang as well if the first one timed out, and to fail fast on future calls rather than waiting on the timeout again
+        reject(createTimeoutError()); // (possibly Safari Private Browsing)
+      }, self._idbOpTimeoutMs);
+    });
+    return Promise.race([Promise.resolve(promise), timedOut]).then(function (result) {
+      clearTimer();
+      return result;
+    }, function (error) {
+      clearTimer();
+      throw error;
+    });
+  };
+
   PouchDBPersistenceStore.prototype.upsert = function (key, metadata, value, expectedVersionIdentifier) {
     logger.log("Offline Persistence Toolkit pouchDBPersistenceStore: upsert() for key: " + key);
     var self = this;
     var docId = key.toString();
 
-    return self._db.get(docId).then(function (doc) {
+    return self._withIdbTimeout(self._db.get(docId), 'get').then(function (doc) {
       // document exists already, update it if its versionIdentifier value
       // is the same as the expected value. Otherwise, throw conflict error
       if (!_verifyVersionIdentifier(expectedVersionIdentifier, doc)) {
@@ -145,7 +190,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       dbdoc._rev = existingDoc._rev;
     }
     var self = this;
-    return self._db.put(dbdoc).then(function(addeddoc) {
+    return self._withIdbTimeout(self._db.put(dbdoc), 'put').then(function(addeddoc) {
       return self._addAttachments(docId, addeddoc.rev, attachmentParts);
     }).catch(function(puterr) {
       if (puterr.status === 409) {
@@ -183,7 +228,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
         } else {
           blob = new Blob([attachment.value]);
         }
-        return self._db.putAttachment(docId, attachment.path, docRev, blob, 'binary')
+        return self._withIdbTimeout(self._db.putAttachment(docId, attachment.path, docRev, blob, 'binary'), 'putAttachment')
       }, this);
       return Promise.all(promises).catch(function(error) {
         logger.error("store: " + self._name + " failed add attachment for doc " + docId);
@@ -212,7 +257,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
           metadata: element.metadata,
           value: fullbinaryData ? null : value
         };
-        return self._db.get(docId).then(function(existdoc) {
+        return self._withIdbTimeout(self._db.get(docId), 'get').then(function(existdoc) {
           doc["_rev"] = existdoc["_rev"];
           return doc;
         }).catch(function(error) {
@@ -226,7 +271,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       });
 
       return Promise.all(dbpromises).then(function(dbdocs) {
-        return self._db.bulkDocs(dbdocs);
+        return self._withIdbTimeout(self._db.bulkDocs(dbdocs), 'bulkDocs');
       }).then(function(results) {
         var promises = [];
         results.forEach(function(result, index) {
@@ -257,7 +302,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
     // if the find plugin is installed
     if (self._db.find) {
       var modifiedFind = self._prepareFind(findExpression);
-      return self._db.find(modifiedFind).then(function (result) {
+      return self._withIdbTimeout(self._db.find(modifiedFind), 'find').then(function (result) {
         if (result && result.docs && result.docs.length) {
           var promises = result.docs.map(self._findResultCallback(modifiedFind.fields), self);
           return Promise.all(promises);
@@ -273,7 +318,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       });
     } else {
       // get all rows and use our own find logic
-      return self._db.allDocs({include_docs: true}).then(function (result) {
+      return self._withIdbTimeout(self._db.allDocs({include_docs: true}), 'allDocs').then(function (result) {
         if (result && result.rows && result.rows.length) {
           // filter on the rows first before _fixBinaryValue which adds binary
           // back to the document. This assumes the search criteria should
@@ -346,7 +391,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
     } else {
       var self = this;
       var filename = Object.keys(attachments)[0];
-      return self._db.getAttachment(docId, filename).then(function (blob) {
+      return self._withIdbTimeout(self._db.getAttachment(docId, filename), 'getAttachment').then(function (blob) {
         if (filename === 'rootpath') {
           doc.value = blob;
         } else {
@@ -369,7 +414,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
     var self = this;
     var docId = key.toString();
 
-    return self._db.get(docId, {attachments: true}).then(function (doc) {
+    return self._withIdbTimeout(self._db.get(docId, {attachments: true}), 'get').then(function (doc) {
       return self._fixBinaryValue(doc);
     }).then(function(fixedDoc) {
       return fixedDoc.value;
@@ -389,8 +434,8 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       return Promise.resolve(false);
     }
     var docId = key.toString();
-    return self._db.get(docId).then(function (doc) {
-      return self._db.remove(doc);
+    return self._withIdbTimeout(self._db.get(docId), 'get').then(function (doc) {
+      return self._withIdbTimeout(self._db.remove(doc), 'remove');
     }).then(function () {
       return true;
     }).catch(function (err) {
@@ -414,7 +459,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
           var docsToDelete = entries.map(function(doc) {
             return {'_id': doc['_id'], '_rev': doc['_rev'], '_deleted': true};
           });
-          return self._db.bulkDocs(docsToDelete);
+          return self._withIdbTimeout(self._db.bulkDocs(docsToDelete), 'bulkDocs');
         } else {
           return;
         }
@@ -422,7 +467,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
         logger.error("store: " + self._name + " error deleting....");
       });
     } else {
-      return self._db.destroy().then(function () {
+      return self._withIdbTimeout(self._db.destroy(), 'destroy').then(function () {
         var dbname = self._name + self._version;
         if (self._dbOptions) {
           self._db = new PouchDB(dbname, self._dbOptions);
@@ -439,8 +484,9 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
   PouchDBPersistenceStore.prototype.keys = function () {
     logger.log("Offline Persistence Toolkit pouchDBPersistenceStore: keys()");
     var self = this;
-
-    return self._db.allDocs().then(function (result) {
+    // Protect against Safari Private Browsing IndexedDB hangs by timing out
+    // and returning an empty key set rather than hanging forever.
+    return self._withIdbTimeout(self._db.allDocs(), 'allDocs').then(function (result) {
       var rows = result.rows;
       var keysArray = [];
       if (rows && rows.length) {
@@ -452,7 +498,9 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       }
       return keysArray;
     }).catch(function(error) {
-      logger.error("store: " + self._name + " error getting all the docs for keys ");
+      logger.error("store: " + self._name + " error getting all the docs for keys ", error);
+      // fail-soft: return empty set so callers don't hang forever
+      return [];
     });
   };
 
@@ -545,7 +593,7 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
   PouchDBPersistenceStore.prototype.updateKey = function(currentKey, newKey) {
     logger.log("Offline Persistence Toolkit PouchDBPersistenceStore: updateKey() with currentKey: " + currentKey + " and new key: " + newKey);
     var self = this;
-    return self._db.get(currentKey).then(function (existingValue) {
+    return self._withIdbTimeout(self._db.get(currentKey), 'get').then(function (existingValue) {
       if (existingValue) {
         return self.upsert(newKey, existingValue.metadata, existingValue.value);
       } else {