Updated to v1.2.2 and fixed bugs in pouchDB store

kentarokinebuchi · kentarokinebuchi · commit 62b4f4fb5049 · 2019-02-12T10:26:07.000-08:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -82,9 +82,9 @@ module.exports = function (grunt) {
             {
               name: 'persist/defaultResponseProxy',
               include: ['persist/simpleJsonShredding', 'persist/oracleRestJsonShredding', 'persist/simpleBinaryDataShredding', 'persist/queryHandlers'],
-              excludeShallow: ['persist/persistenceUtils', 
-                              'persist/impl/logger', 
-                              'persist/impl/PersistenceXMLHttpRequest', 
+              excludeShallow: ['persist/persistenceUtils',
+                              'persist/impl/logger',
+                              'persist/impl/PersistenceXMLHttpRequest',
                               'persist/persistenceStoreManager',
                               'persist/impl/defaultCacheHandler',
                               'persist/impl/PersistenceSyncManager',
@@ -129,9 +129,9 @@ module.exports = function (grunt) {
             {
               name: 'persist/defaultResponseProxy',
               include: ['persist/simpleJsonShredding', 'persist/oracleRestJsonShredding', 'persist/simpleBinaryDataShredding', 'persist/queryHandlers'],
-              excludeShallow: ['persist/persistenceUtils', 
-                              'persist/impl/logger', 
-                              'persist/impl/PersistenceXMLHttpRequest', 
+              excludeShallow: ['persist/persistenceUtils',
+                              'persist/impl/logger',
+                              'persist/impl/PersistenceXMLHttpRequest',
                               'persist/persistenceStoreManager',
                               'persist/impl/defaultCacheHandler',
                               'persist/impl/PersistenceSyncManager',
@@ -150,51 +150,55 @@ module.exports = function (grunt) {
       main: {
         files: [
           {
-            src: '<%= paths.dist_bundles %>/persist/persistenceManager.js', 
+            src: '<%= paths.dist_bundles %>/persist/persistenceManager.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-core-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles %>/persist/arrayPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles %>/persist/arrayPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-arraystore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles %>/persist/localPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles %>/persist/localPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-localstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles %>/persist/pouchDBPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles %>/persist/pouchDBPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-pouchdbstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles %>/persist/fileSystemPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles %>/persist/fileSystemPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-filesystemstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles %>/persist/defaultResponseProxy.js', 
+            src: '<%= paths.dist_bundles %>/persist/defaultResponseProxy.js',
             dest: '<%= paths.dist_bundles %>/persist/offline-persistence-toolkit-responseproxy-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles_debug %>/persist/persistenceManager.js', 
+            src: '<%= paths.dist_bundles_debug %>/persist/persistenceManager.js',
             dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-core-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles_debug %>/persist/localPersistenceStoreFactory.js', 
+		    src: '<%= paths.dist_bundles_debug %>/persist/arrayPersistenceStoreFactory.js',
+		    dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-arraystore-<%= pkg.version %>.js'
+          },
+          {
+            src: '<%= paths.dist_bundles_debug %>/persist/localPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-localstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles_debug %>/persist/pouchDBPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles_debug %>/persist/pouchDBPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-pouchdbstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles_debug %>/persist/fileSystemPersistenceStoreFactory.js', 
+            src: '<%= paths.dist_bundles_debug %>/persist/fileSystemPersistenceStoreFactory.js',
             dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-filesystemstore-<%= pkg.version %>.js'
           },
           {
-            src: '<%= paths.dist_bundles_debug %>/persist/defaultResponseProxy.js', 
+            src: '<%= paths.dist_bundles_debug %>/persist/defaultResponseProxy.js',
             dest: '<%= paths.dist_bundles_debug %>/persist/offline-persistence-toolkit-responseproxy-<%= pkg.version %>.js'
           },
           {
-            src: 'coverage/dist/debug/require-config-coverage.js', 
+            src: 'coverage/dist/debug/require-config-coverage.js',
             dest: 'coverage/dist/debug/bundles-config.js'
           }
         ]
diff --git a/JSDOC.md b/JSDOC.md
@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.1 #
+# offline-persistence-toolkit 1.2.2 #
 
 ## Introduction ##
 
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.1 #
+# offline-persistence-toolkit 1.2.2 #
 
 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.2.1/min'
+      'persist' : 'js/libs/persist/v1.2.2/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.2.1/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.2.2/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.2.1/min'`.
+It is recommended to add the version number as a convention in your application build step such as `'persist' : 'js/libs/persist/v1.2.2/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-6.3.4',
       'pouchfind': 'js/libs/pouchdb.find',
-      'persist' : 'js/libs/persist/v1.2.1/min'
+      'persist' : 'js/libs/persist/v1.2.2/min'
 
       // Other path mappings here
  }
diff --git a/USAGE.md b/USAGE.md
@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.1 #
+# offline-persistence-toolkit 1.2.2 #
 
 # Introduction #
 
diff --git a/docs/index.html b/docs/index.html
@@ -43,7 +43,7 @@ <h3> </h3>
 
 
     <section>
-        <article><h1>offline-persistence-toolkit 1.2.1</h1><h2>Introduction</h2><p>This document provides a reference to the offline-persistence-toolkit's JavaScript API. Links to JSDoc for each class can be found to the right.</p>
+        <article><h1>offline-persistence-toolkit 1.2.2</h1><h2>Introduction</h2><p>This document provides a reference to the offline-persistence-toolkit's JavaScript API. Links to JSDoc for each class can be found to the right.</p>
 <p>The toolkit's <a href="https://github.com/oracle/offline-persistence-toolkit/" title="README">README</a> file provides an overview of the toolkit’s capabilities. Having read that document, you can find more information about how to implement a range of common and advanced use cases with the toolkit in the
 <a href="https://github.com/oracle/offline-persistence-toolkit/blob/master/USAGE.md" title="Usage guide">Usage guide</a>.</p>
 <h2>License</h2><p>Copyright (c) 2017 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.</p></article>
diff --git a/docs/persistenceUtils.html b/docs/persistenceUtils.html
@@ -238,7 +238,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line463">line 463</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line465">line 465</a>
     </li></ul></dd>
     
 
@@ -732,7 +732,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line362">line 362</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line364">line 364</a>
     </li></ul></dd>
     
 
@@ -889,7 +889,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line236">line 236</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line238">line 238</a>
     </li></ul></dd>
     
 
@@ -1046,7 +1046,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line63">line 63</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line65">line 65</a>
     </li></ul></dd>
     
 
@@ -1203,7 +1203,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line293">line 293</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line295">line 295</a>
     </li></ul></dd>
     
 
@@ -1403,7 +1403,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line207">line 207</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line209">line 209</a>
     </li></ul></dd>
     
 
@@ -1583,7 +1583,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line331">line 331</a>
+        <a href="persistenceUtils.js.html">persistenceUtils.js</a>, <a href="persistenceUtils.js.html#line333">line 333</a>
     </li></ul></dd>
     
 
diff --git a/docs/persistenceUtils.js.html b/docs/persistenceUtils.js.html
@@ -72,9 +72,11 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
 
     var contentType = headers.get('Content-Type');
 
+    // the response is considered text type when contentType value is of
+    // pattern text/ or application/*json .
     if (contentType &amp;&amp;
-      (contentType.indexOf('text/') !== -1 ||
-       contentType.indexOf('application/json') !== -1)) {
+        (contentType.match(/.*text\/.*/) ||
+         contentType.match(/.*application\/.*json.*/))) {
       return true;
     }
     return false;
@@ -294,7 +296,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
       var formData = new FormData();
       var formPairs = body.formData;
       Object.keys(formPairs).forEach(function (pairkey) {
-        formData.append(pairkey, formPairs[pairkey]);
+        formData.append(pairkey, formPairs[pairkey]); // @XSSFalsePositive
       });
       targetObj.body = formData;
     }
@@ -307,7 +309,7 @@ <h1 class="page-title">Source: persistenceUtils.js</h1>
     Object.keys(data.headers).forEach(function (key) {
       if (key !== 'content-type' ||
         (!skipContentType &amp;&amp; key === 'content-type')) {
-        headers.append(key, data.headers[key]);
+        headers.append(key, data.headers[key]); // @XSSFalsePositive
       }
     });
 
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@oracle/offline-persistence-toolkit",
   "title": "Offline Persistence Toolkit",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Offline Persistence Toolkit by Oracle Corp.",
   "author": "oraclejet",
   "license": "UPL-1.0",
diff --git a/src/impl/PersistenceXMLHttpRequest.js b/src/impl/PersistenceXMLHttpRequest.js
@@ -477,7 +477,7 @@ define(['../persistenceUtils', './logger'], function (persistenceUtils, logger)
   function _getRequestHeaders(self) {
     var requestHeaders = new Headers();
     function appendRequestHeader(requestHeader) {
-      requestHeaders.append(requestHeader, self._requestHeaders[requestHeader]);
+      requestHeaders.append(requestHeader, self._requestHeaders[requestHeader]); // @XSSFalsePositive
     }
     Object.keys(self._requestHeaders).forEach(appendRequestHeader);
 
diff --git a/src/impl/fetch.js b/src/impl/fetch.js
@@ -105,15 +105,15 @@
 
     if (headers instanceof Headers) {
       headers.forEach(function(value, name) {
-        this.append(name, value)
+        this.append(name, value) // @XSSFalsePositive
       }, this)
     } else if (Array.isArray(headers)) {
       headers.forEach(function(header) {
-        this.append(header[0], header[1])
+        this.append(header[0], header[1]) // @XSSFalsePositive
       }, this)
     } else if (headers) {
       Object.getOwnPropertyNames(headers).forEach(function(name) {
-        this.append(name, headers[name])
+        this.append(name, headers[name]) // @XSSFalsePositive
       }, this)
     }
   }
@@ -377,7 +377,7 @@
         var split = bytes.split('=')
         var name = split.shift().replace(/\+/g, ' ')
         var value = split.join('=').replace(/\+/g, ' ')
-        form.append(decodeURIComponent(name), decodeURIComponent(value))
+        form.append(decodeURIComponent(name), decodeURIComponent(value)) // @XSSFalsePositive
       }
     })
     return form
@@ -393,7 +393,7 @@
       var key = parts.shift().trim()
       if (key) {
         var value = parts.join(':').trim()
-        headers.append(key, value)
+        headers.append(key, value) // @XSSFalsePositive
       }
     })
     return headers
diff --git a/src/impl/pouchDBPersistenceStore.js b/src/impl/pouchDBPersistenceStore.js
@@ -182,24 +182,32 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
       // get all rows and use our own find logic
       return self._db.allDocs({include_docs: true}).then(function (result) {
         if (result && result.rows && result.rows.length) {
-          var fixedDocPromises = result.rows.map(function(row) {
-            return self._fixValue(row.doc);
-          });
-          return Promise.all(fixedDocPromises).then(function(docs) {
-            var satisfiedRows = result.rows.filter(function(row) {
-              if (storageUtils.satisfy(findExpression.selector, row.doc)) {
-                return true;
-              }
-              return false;
-            });
-            var promises = satisfiedRows.map(function(row) {
-              return self._findResultCallback(modifiedFind.fields).bind(self)(row.doc);
+          // filter on the rows first before _fixBinaryValue which adds binary
+          // back to the document. This assumes the search criteria should
+          // not have any operator against the binary data. 
+          var satisfiedRows = result.rows.filter(function(row) {
+            var doc = row.doc;
+            self._fixKey(doc);
+            if (storageUtils.satisfy(findExpression.selector, doc)) {
+              return true;
+            }
+            return false;
+           });
+
+          if (satisfiedRows.length) {
+            var fixDocPromises = satisfiedRows.map(function(row) {
+              return self._fixBinaryValue(row.doc);
             });
-            return Promise.all(promises);
-          });
+            return Promise.all(fixDocPromises);
+          } else {
+            return [];
+          }
         } else {
-          return Promise.resolve([]);
+          return [];
         }
+      }).catch(function(err) {
+        logger.log("error retrieving all documents from pouch db, returns empty list as find operation.", err);
+        return [];
       });
     }
   };
@@ -217,16 +225,18 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
     };
   };
 
-  // invoked after document is retrieved. If the original value
-  // has binary data in it, we need to retrieve it back as attachments
-  // and add it back to the value part.
+  // invoked after document is retrieved. Fix the key and binary
+  // part of the value.
   PouchDBPersistenceStore.prototype._fixValue = function (doc) {
-    var docId = doc._id || doc.id || doc.key;
-
-    if (docId) {
-      doc.key = docId;
-    }
+    this._fixKey(doc);
+    return this._fixBinaryValue(doc);
+  };
 
+  // If the original value has binary data in it,
+  // we need to retrieve it back as attachments
+  // and add it back to the value part.
+  PouchDBPersistenceStore.prototype._fixBinaryValue = function (doc) {
+    var docId = doc._id || doc.id || doc.key;
     var attachments = doc._attachments;
     if (!attachments) {
       return Promise.resolve(doc);
@@ -245,6 +255,14 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
     }
   };
 
+  PouchDBPersistenceStore.prototype._fixKey = function (doc) {
+    var docId = doc._id || doc.id || doc.key;
+
+    if (docId) {
+      doc.key = docId;
+    }
+  };
+
   PouchDBPersistenceStore.prototype.findByKey = function (key) {
     logger.log("Offline Persistence Toolkit pouchDBPersistenceStore: findByKey() for key: " + key);
     var self = this;
diff --git a/src/persistenceUtils.js b/src/persistenceUtils.js

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# offline-persistence-toolkit 1.2.1 #`
	`1`	`+# offline-persistence-toolkit 1.2.2 #`
`2`	`2`
`3`	`3`	`## Introduction ##`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@oracle/offline-persistence-toolkit",`
`3`	`3`	`"title": "Offline Persistence Toolkit",`
`4`		`- "version": "1.2.1",`
	`4`	`+ "version": "1.2.2",`
`5`	`5`	`"description": "Offline Persistence Toolkit by Oracle Corp.",`
`6`	`6`	`"author": "oraclejet",`
`7`	`7`	`"license": "UPL-1.0",`
Original file line number	Diff line number	Diff line change
`@@ -477,7 +477,7 @@ define(['../persistenceUtils', './logger'], function (persistenceUtils, logger)`
`477`	`477`	`function _getRequestHeaders(self) {`
`478`	`478`	`var requestHeaders = new Headers();`
`479`	`479`	`function appendRequestHeader(requestHeader) {`
`480`		`- requestHeaders.append(requestHeader, self._requestHeaders[requestHeader]);`
	`480`	`+ requestHeaders.append(requestHeader, self._requestHeaders[requestHeader]); // @XSSFalsePositive`
`481`	`481`	`}`
`482`	`482`	`Object.keys(self._requestHeaders).forEach(appendRequestHeader);`
`483`	`483`