Updating to version 1.5.1

Author: PeterBWu

JSDOC.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.9 #
+# offline-persistence-toolkit 1.5.1 #
 
 ## Introduction ##
 

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.9 #
+# offline-persistence-toolkit 1.5.1 #
 
 offline-persistence-toolkit is a client-side JavaScript library that provides caching and offline support at the HTTP request layer. This support is transparent to the user and is done through the Fetch API and an XHR adapter. HTTP requests made while the client device is offline are captured for replay when connection to the server is restored. Additional capabilities include a persistent storage layer, synchronization manager, binary data support and various configuration APIs for customizing the default behavior. This framework can be used in both ServiceWorker and non-ServiceWorker contexts within web and hybrid mobile apps.
 
@@ -58,16 +58,16 @@ If your app uses [RequireJS](http://www.requirejs.org/ "RequireJS"), update the
 ```javascript
   requirejs.config({
     paths: {
-      'persist' : 'js/libs/persist/v1.4.9/min'
+      'persist' : 'js/libs/persist/v1.5.1/min'
 
       // Other path mappings here
  }
 ```
-For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist' : 'js/libs/persist/v1.4.9/min'` entry to the list of paths.
+For Oracle JET apps, also open `appDir/src/js/main-release-paths.json` and add the `'persist' : 'js/libs/persist/v1.5.1/min'` entry to the list of paths.
 
 You can choose the name of the paths prefix. That is, you can use a different value to the ‘persist’ value shown in the examples.
 
-It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.4.9/min'`.
+It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.5.1/min'`.
 
 Versions of the toolkit are also available on CDN under the latest JET release. e.g.
 
@@ -91,7 +91,7 @@ And again, if you are using RequireJS, you will need to map paths for these pack
     paths: {
       'pouchdb': 'js/libs/pouchdb-7.0.0',
       'pouchfind': 'js/libs/pouchdb.find',
-      'persist' : 'js/libs/persist/v1.4.9/min'
+      'persist' : 'js/libs/persist/v1.5.1/min'
 
       // Other path mappings here
  }

USAGE.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.4.9 #
+# offline-persistence-toolkit 1.5.1 #
 
 # Introduction #
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oracle/offline-persistence-toolkit",
   "title": "Offline Persistence Toolkit",
-  "version": "1.4.9",
+  "version": "1.5.1",
   "description": "Offline Persistence Toolkit by Oracle Corp.",
   "author": "oraclejet",
   "license": "UPL-1.0",

src/impl/OfflineCache.js

@@ -36,20 +36,16 @@ define(["./defaultCacheHandler", "../persistenceStoreManager", "../persistenceUt
 
     this._name = name;
     this._storeName = storeName;
+    // the names of all the shredded stores associated
+    // with this cache. We need them when clear() is
+    // called since we need to clear all the shredded
+    // stores as well.
+    this._shreddedNamesStoreName = this._storeName + '_OPT_INT_SHRED_STORE_NAMES_';
     this._store = null;
 
     // in-memory cache of all the keys in the store, for quick lookup.
     this._cacheKeys = [];
     this._createStorePromise;
-
-    // the names of all the shredded stores associated
-    // with this cache. We need them when clear() is
-    // called since we need to clear all the shredded
-    // stores as well.
-    Object.defineProperty(this, '_STORE_NAMES_', {
-      value: '_OPT_INT_SHRED_STORE_NAMES_',
-      writable: false
-    });
   }
 
   /**
@@ -312,6 +308,29 @@ define(["./defaultCacheHandler", "../persistenceStoreManager", "../persistenceUt
     }
   }
 
+    /**
+   * Return the persistent store.
+   * @returns {Object} The persistent store.
+   */
+  OfflineCache.prototype._getShreddedNamesStore = function () {
+    var self = this;
+    if (self._shreddedNamesStore) {
+      return Promise.resolve(self._shreddedNamesStore);
+    }
+    if (self._createShreddedNamesStorePromise) {
+      return self._createShreddedNamesStorePromise;
+    } else {
+      self._createShreddedNamesStorePromise = persistenceStoreManager.openStore(self._shreddedNamesStoreName, {
+        index: ["metadata.baseUrl", "metadata.url", "metadata.created"],
+        skipMetadata: true
+     }).then(function (store) {
+        self._shreddedNamesStore = store;
+        return self._shreddedNamesStore;
+      });
+      return self._createShreddedNamesStorePromise;
+    }
+  }
+
   /**
    * Perform vary header check and return the first match among all the
    * cacheEntries.
@@ -493,16 +512,18 @@ define(["./defaultCacheHandler", "../persistenceStoreManager", "../persistenceUt
             cacheKey = null;
             return;
           }
-          self._updateShreddedStoreNames(shreddedPayload.map(function(entry) {
-            return entry.name;
-          }));
           var storePromises = [];
           requestResponsePair.value.responseData.bodyAbstract = _buildBodyAbstract(shreddedPayload);
           storePromises.push(cacheStore.upsert(requestResponsePair.key,
                                                requestResponsePair.metadata,
                                                requestResponsePair.value));
           storePromises.push(cacheHandler.cacheShreddedData(shreddedPayload));
-          return Promise.all(storePromises);
+
+          return self._updateShreddedStoreNames(shreddedPayload.map(function(entry) {
+            return entry.name;
+          })).then(function() {
+            return Promise.all(storePromises);
+          });
         });
       }
     }).then(function() {
@@ -515,41 +536,33 @@ define(["./defaultCacheHandler", "../persistenceStoreManager", "../persistenceUt
   };
 
   OfflineCache.prototype._updateShreddedStoreNames = function (storeNames) {
-    if (!storeNames) {
-      localStorage.setItem(this._STORE_NAMES_, "");
-      return;
-    }
-    var storeageData = localStorage.getItem(this._STORE_NAMES_);
-    if (!storeageData) {
-      storeageData = JSON.stringify(storeNames);
-    } else {
-      var existingStoreNames;
-      try {
-        existingStoreNames = JSON.parse(storeageData);
-      } catch(exc) {
-        existingStoreNames = [];
+    return this._getShreddedNamesStore().then(function(store) {
+      if (!storeNames) {
+        return store.delete();
+      } else {
+        return store.keys().then(function(keys) {
+          var keysToAdd = [];
+          storeNames.forEach(function(storeName) {
+            if (keys.indexOf(storeName) < 0) {
+              keysToAdd.push(storeName);
+            }
+          });
+          if (keysToAdd.length > 0) {
+            var rowsToAdd = [];
+            keysToAdd.forEach(function(key) {
+              rowsToAdd.push({key: key, metadata: {}, value: {}});
+            });
+            return store.upsertAll(rowsToAdd);
+          }
+        });
       }
-      storeNames.forEach(function (storeName) {
-        if (existingStoreNames.indexOf(storeName) < 0) {
-          existingStoreNames.push(storeName);
-        }
-      });
-      storeageData = JSON.stringify(existingStoreNames);
-    }
-    localStorage.setItem(this._STORE_NAMES_, storeageData);
+    });
   };
 
   OfflineCache.prototype._getShreddedStoreNames = function () {
-    var storeNames = [];
-    var storeageData = localStorage.getItem(this._STORE_NAMES_);
-    if (storeageData) {
-      try {
-        storeNames = JSON.parse(storeageData);
-      } catch (exc) {
-        logger.log("error getting shredded store names from localStorage");
-      }
-    }
-    return storeNames;
+    return this._getShreddedNamesStore().then(function(store) {
+      return store.keys();
+    });
   };
 
   function _buildBodyAbstract (shreddedPayload) {
@@ -796,15 +809,17 @@ define(["./defaultCacheHandler", "../persistenceStoreManager", "../persistenceUt
     return self._getStore().then(function(cacheStore) {
       var deletePromiseArray = [];
       deletePromiseArray.push(cacheStore.delete());
-      var storeNames = self._getShreddedStoreNames();
-      storeNames.forEach(function(storeName) {
-        deletePromiseArray.push(persistenceStoreManager.deleteStore(storeName));
-        return;
-      });
-      return Promise.all(deletePromiseArray).then(function(results) {
-        self._updateShreddedStoreNames(null);
-        self._cacheKeys = [];
-        return true;
+      return self._getShreddedStoreNames().then(function(storeNames) {
+        storeNames.forEach(function(storeName) {
+          deletePromiseArray.push(persistenceStoreManager.deleteStore(storeName));
+          return;
+        });
+        return Promise.all(deletePromiseArray).then(function(results) {
+          return self._updateShreddedStoreNames(null);
+        }).then(function() {
+          self._cacheKeys = [];
+          return true;
+        });
       });
     }).catch(function(error) {
       logger.log("Offline Persistence Toolkit OfflineCache: clear() error");

src/persistenceManager.js

@@ -408,7 +408,9 @@ define(['./impl/PersistenceXMLHttpRequest', './impl/PersistenceSyncManager', './
       // save off the browser fetch and XHR only in browser context.
       // also add listeners for browser online
       // Don't do it for Service Workers
-      if (_isSafari()) {
+      if (_isSafari() &&
+        !persistenceManager._browserRequestConstructor &&
+        !persistenceManager._persistenceRequestConstructor) {
         logger.log("Offline Persistence Toolkit PersistenceManager: Replacing Safari Browser APIs");
         // using self to refer to both the "window" and the "self" context
         // of serviceworker
@@ -421,7 +423,8 @@ define(['./impl/PersistenceXMLHttpRequest', './impl/PersistenceSyncManager', './
           writable: false
         });
         self['Request'] = persistenceManager._persistenceRequestConstructor;
-        if (!_isBrowserContext()) {
+        if (!_isBrowserContext() && 
+          !persistenceManager._browserFetchFunc) {
           // replace serviceWorker's fetch with this wrapper to unwrap safari request in sw
           Object.defineProperty(persistenceManager, '_browserFetchFunc', {
             value: self.fetch,

src/queryHandlers.js

@@ -329,9 +329,9 @@ define(['./persistenceManager', './persistenceStoreManager', './persistenceUtils
                   };
                   break;
                 case 'LIKE':
-                  rhsOp = rhsOp.replace('%', '.+');
+                  rhsOp = rhsOp.replace(/%/g, '.*');
                   returnExp[lhsOp] = {
-                    $regex: rhsOp
+                    $regex: RegExp(rhsOp,'i')
                   };
                   break;
                 case 'BETWEEN':

test/queryHandlers/test.js

@@ -143,7 +143,7 @@ define(['persist/persistenceManager', 'persist/defaultResponseProxy', 'persist/q
       });
       QUnit.test('getOracleRestQueryHandler', function (assert) {
         var done = assert.async();
-        assert.expect(84);
+        assert.expect(96);
         mockFetch.addRequestReply('GET', '/testOracleRestQuery/556', {
           status: 200,
           body: JSON.stringify({DepartmentId: 556, DepartmentName: 'BB', establishedDate: '2010-01-01T08:30:40Z', LocationId: 200, ManagerId: 300})
@@ -254,6 +254,38 @@ define(['persist/persistenceManager', 'persist/defaultResponseProxy', 'persist/q
               return response.json();
             }).then(function (responseData) {
               assert.ok(responseData.items.length == 1 && responseData.items[0].DepartmentName == 'BB', 'Returned the correct department');
+              return fetch("/testOracleRestQuery?q=DepartmentName%20LIKE%20%27BB%25%27&offset=0&limit=10");
+            }).then(function (response) {
+              assert.ok(true, 'Received Response when offline');
+              return response.json();
+            }).then(function (responseData) {
+              assert.ok(responseData.items.length == 1 && responseData.items[0].DepartmentName == 'BB', 'Returned the correct department');
+              return fetch("/testOracleRestQuery?q=DepartmentName%20LIKE%20%27aDmInIsTrAtIoN%25%27&offset=0&limit=10");
+            }).then(function (response) {
+              assert.ok(true, 'Received Response when offline');
+              return response.json();
+            }).then(function (responseData) {
+              assert.ok(responseData.items.length == 1 && responseData.items[0].DepartmentName == 'Administration', 'Returned the correct department');
+              return fetch("/testOracleRestQuery?q=DepartmentName%20LIKE%20%27rAtIoN%25%27&offset=0&limit=10");
+            }).then(function (response) {
+              assert.ok(true, 'Received Response when offline');
+              return response.json();
+            }).then(function (responseData) {
+              assert.ok(responseData.items.length == 1 && responseData.items[0].DepartmentName == 'Administration', 'Returned the correct department');
+              return fetch("/testOracleRestQuery?q=DepartmentName%20LIKE%20%27aDmInIs%25%27&offset=0&limit=10");
+            }).then(function (response) {
+              assert.ok(true, 'Received Response when offline');
+              return response.json();
+            }).then(function (responseData) {
+              assert.ok(responseData.items.length == 1 && responseData.items[0].DepartmentName == 'Administration', 'Returned the correct department');
+              return fetch("/testOracleRestQuery?q=DepartmentName%20LIKE%20%27aD%25%27&offset=0&limit=10");
+            }).then(function (response) {
+              assert.ok(true, 'Received Response when offline');
+              return response.json();
+            }).then(function (responseData) {
+              assert.ok(responseData.items.length == 2 , 'Returned the correct department');
+              assert.ok(responseData.items[0].DepartmentName == 'Administration' || responseData.items[1].DepartmentName == 'Administration', 'Returned the correct department');
+              assert.ok(responseData.items[1].DepartmentName == 'ADFPM 1001 neverending' || responseData.items[0].DepartmentName == 'ADFPM 1001 neverending', 'Returned the correct department');
               return fetch("/testOracleRestQuery?q=DepartmentId%20BETWEEN%2010%20AND%201001&offset=0&limit=10");
             }).then(function (response) {
               assert.ok(true, 'Received Response when offline');