Fixed bug in pouchDBStore and updated version to 1.2.3

Author: kentarokinebuchi

JSDOC.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.2 #
+# offline-persistence-toolkit 1.2.3 #
 
 ## Introduction ##
 

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.2 #
+# offline-persistence-toolkit 1.2.3 #
 
 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.2/min'
+      'persist' : 'js/libs/persist/v1.2.3/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.2/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.3/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.2/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.3/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.2/min'
+      'persist' : 'js/libs/persist/v1.2.3/min'
 
       // Other path mappings here
  }

USAGE.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.2.2 #
+# offline-persistence-toolkit 1.2.3 #
 
 # Introduction #
 

docs/index.html

@@ -43,7 +43,7 @@ <h3> </h3>
 
 
     <section>
-        <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>
+        <article><h1>offline-persistence-toolkit 1.2.3</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>

package.json

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

src/impl/keyValuePersistenceStore.js

@@ -197,24 +197,7 @@ define(["../PersistenceStore", "./storageUtils", "./logger"],
       if (!fieldsExpression) {
         returnObject = itemData.value;
       } else {
-        returnObject = {};
-        for (var index = 0; index < fieldsExpression.length; index++) {
-          var currentObject = returnObject;
-          var currentItemDataValue = itemData;
-          var field = fieldsExpression[index];
-          var paths = field.split('.');
-          for (var pathIndex = 0; pathIndex < paths.length; pathIndex++) {
-            currentItemDataValue = currentItemDataValue[paths[pathIndex]];
-            if (!currentObject[paths[pathIndex]] && pathIndex < paths.length - 1) {
-              currentObject[paths[pathIndex]] = {};
-            }
-            if (pathIndex === paths.length - 1) {
-              currentObject[paths[pathIndex]] = currentItemDataValue;
-            } else {
-              currentObject = currentObject[paths[pathIndex]];
-            }
-          }
-        }
+        returnObject = storageUtils.assembleObject(itemData, fieldsExpression);
       }
       return returnObject;
     };

src/impl/pouchDBPersistenceStore.js

@@ -160,22 +160,24 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
   PouchDBPersistenceStore.prototype.find = function (findExpression) {
     logger.log("Offline Persistence Toolkit pouchDBPersistenceStore: find() for expression: " +  JSON.stringify(findExpression));
     var self = this;
-    var modifiedFind = self._prepareFind(findExpression);
 
+    findExpression = findExpression || {};
+
     // if the find plugin is installed
     if (self._db.find) {
+      var modifiedFind = self._prepareFind(findExpression);
       return self._db.find(modifiedFind).then(function (result) {
         if (result && result.docs && result.docs.length) {
           var promises = result.docs.map(self._findResultCallback(modifiedFind.fields), self);
           return Promise.all(promises);
         } else {
-          return Promise.resolve([]);
+          return [];
         }
       }).catch(function (finderr) {
         if (finderr.status === 404 && finderr.message === 'missing') {
-          return Promise.resolve([]);
+          return [];
         } else {
-          return Promise.reject(finderr);
+          throw finderr;
         }
       });
     } else {
@@ -196,7 +198,13 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
 
           if (satisfiedRows.length) {
             var fixDocPromises = satisfiedRows.map(function(row) {
-              return self._fixBinaryValue(row.doc);
+              return self._fixBinaryValue(row.doc).then(function(fixedDoc){
+                if (findExpression.fields) {
+                  return storageUtils.assembleObject(fixedDoc, findExpression.fields);
+                } else {
+                  return fixedDoc.value;
+                }
+              });
             });
             return Promise.all(fixDocPromises);
           } else {
@@ -344,27 +352,26 @@ define(["../PersistenceStore", "../impl/storageUtils", "pouchdb", "./logger"],
   // understood by pouchdb find plugin.
   PouchDBPersistenceStore.prototype._prepareFind = function (findExpression) {
 
-    var modifiedExpression = findExpression || {};
+    var modifiedExpression = {};
 
     // ideally we should allow sort, but PouchDB-find-plugin
-    // has bug on that, so disable sorting at this time.
-    var sortFieldsArray = modifiedExpression.sort;
-    if (sortFieldsArray !== undefined) {
-      delete modifiedExpression.sort;
-    }
+    // has bug on that, so disable sorting at this time by
+    // not copy sort from original expression.
 
     // selector is required from pouchdb.find plugin, thus create a selector
     // property if no selector is explicitely defined in findExpression. The
     // default selector is {'_id': {$gt: null}} which selects everything.
-    var selector = modifiedExpression.selector;
+    var selector = findExpression.selector;
     if (!selector) {
       modifiedExpression.selector = {
         '_id': {'$gt': null}
       };
+    } else {
+      modifiedExpression.selector = selector;
     }
 
     // our key attribute maps to pouchdb documents' _id field.
-    var fields = modifiedExpression.fields;
+    var fields = findExpression.fields;
     if (fields && fields.length) {
       var modifiedFields = fields.map(function (x) {
         if (x === 'key') {

src/impl/storageUtils.js

@@ -297,9 +297,51 @@ define(['./logger'], function (logger) {
     return returnValue;
   };
 
+  /**
+   * Helper function that constructs an object out from value
+   * based on fields.
+   * @method
+   * @name assembleObject
+   * @param {object} value The original object to construct the return object
+   *                       from.
+   * @param {Array} fields An array of property names whose values
+   *                       should be included in the final contructed
+   *                       return object.
+   * @returns {object} the object that contains all the properties defined
+   *                   in fields array, the corresponding property
+   *                   value is obtained from value.
+   */
+  function assembleObject (value, fields) {
+    var returnObject;
+    if (!fields) {
+      returnObject = value;
+    } else {
+      returnObject = {};
+      for (var index = 0; index < fields.length; index++) {
+        var currentObject = returnObject;
+        var currentItemDataValue = value;
+        var field = fields[index];
+        var paths = field.split('.');
+        for (var pathIndex = 0; pathIndex < paths.length; pathIndex++) {
+          currentItemDataValue = currentItemDataValue[paths[pathIndex]];
+          if (!currentObject[paths[pathIndex]] && pathIndex < paths.length - 1) {
+            currentObject[paths[pathIndex]] = {};
+          }
+          if (pathIndex === paths.length - 1) {
+            currentObject[paths[pathIndex]] = currentItemDataValue;
+          } else {
+            currentObject = currentObject[paths[pathIndex]];
+          }
+        }
+      }
+    }
+    return returnObject;
+  };
+  
   return {
     satisfy: satisfy,
-    getValue: getValue
+    getValue: getValue,
+    assembleObject: assembleObject
   };
 });
 

test/storage/storagetest.js

@@ -7,7 +7,7 @@ define(['persist/persistenceStoreManager', 'persist/localPersistenceStoreFactory
 
   module('storagetest');
 
-  // helper function that compares expected result set with the actual result
+  // helper function that compares expected result set with the actxual result
   // set. Return true if they match, false otherwise. The expected/actual
   // result set are both arrays. They should contain the same number of
   // element, and each element should match. The order of the element in the
@@ -81,18 +81,27 @@ define(['persist/persistenceStoreManager', 'persist/localPersistenceStoreFactory
     if (!expected && !actual) {
       return true;
     } else if (expected && actual) {
-      if (typeof(expected) === 'object') {
+      if (typeof(expected) === 'object' && typeof(actual) === 'object') {
+        var keys = [];
         for (var key in expected) {
           if (expected.hasOwnProperty(key)) {
+            keys.push(key);
             var expectedValue = expected[key];
             var actualValue = actual[key];
             if (!matchObject(expectedValue, actualValue)) {
               return false;
             }
           }
         }
+        for (var actualKey in actual) {
+          if (actual.hasOwnProperty(actualKey)) {
+            if (keys.indexOf(actualKey) < 0) {
+              return false;
+            }
+          }
+        }
         return true;
-      } else{
+      } else {
         return (expected == actual);
       }
     } else {