Fixed bug in OracleRest shredder/queryHandler and updated version to 1.2.4

Author: kentarokinebuchi

JSDOC.md

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

README.md

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

USAGE.md

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

docs/index.html

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

docs/queryHandlers.html

@@ -461,7 +461,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="queryHandlers.js.html">queryHandlers.js</a>, <a href="queryHandlers.js.html#line327">line 327</a>
+        <a href="queryHandlers.js.html">queryHandlers.js</a>, <a href="queryHandlers.js.html#line335">line 335</a>
     </li></ul></dd>
 
 

docs/queryHandlers.js.html

@@ -156,8 +156,16 @@ <h1 class="page-title">Source: queryHandlers.js</h1>
       return persistenceManager.getCache().hasMatch(request, {ignoreSearch: true}).then(function (hasMatch) {
         return persistenceStoreManager.openStore(storeName).then(function (store) {
           if (hasMatch) {
-            // query in the shredded data
-            return store.find(findQuery);
+            // check if it's a single row query. If so then we don't need to
+            // do a find.
+            return persistenceManager.getCache().match(request, {ignoreSearch: true}).then(function (response) {
+              if (response.headers.get('x-oracle-jscpt-resource-type') === 'single') {
+                return Promise.resolve();
+              } else {
+                // query in the shredded data
+                return store.find(findQuery);
+              }
+            });
           } else {
             // this might be a single row query so we need to parse the URL for an id based query
             var id = _getRequestUrlId(request);
@@ -202,7 +210,7 @@ <h1 class="page-title">Source: queryHandlers.js</h1>
                 var resourceType = dataArray[0].resourceType;
                 var transformedResults = {
                   name: storeName,
-                  data: results,
+                  data: results != null ? results : dataArray[0].data,
                   resourceType: resourceType
                 };
                 return unshredder([transformedResults], response).then(function (response) {

src/impl/defaultCacheHandler.js

@@ -409,6 +409,11 @@ define(['../persistenceUtils', '../persistenceStoreManager', './logger'],
       response.headers.get('x-oracle-jscpt-response-url') == null) {
       response.headers.set('x-oracle-jscpt-response-url', request.url);
     }
+    if (bodyAbstract && bodyAbstract.length === 1) {
+      if (bodyAbstract[0].resourceType === 'single') {
+        response.headers.set('x-oracle-jscpt-resource-type', 'single');
+      }
+    }
     var unshredder = this._getUnshredder(request);
     var shredder = this._getShredder(request);
     if (!unshredder || !shredder || !response || !bodyAbstract || !bodyAbstract.length) {

src/queryHandlers.js

@@ -128,8 +128,16 @@ define(['./persistenceManager', './persistenceStoreManager', './persistenceUtils
       return persistenceManager.getCache().hasMatch(request, {ignoreSearch: true}).then(function (hasMatch) {
         return persistenceStoreManager.openStore(storeName).then(function (store) {
           if (hasMatch) {
-            // query in the shredded data
-            return store.find(findQuery);
+            // check if it's a single row query. If so then we don't need to
+            // do a find.
+            return persistenceManager.getCache().match(request, {ignoreSearch: true}).then(function (response) {
+              if (response.headers.get('x-oracle-jscpt-resource-type') === 'single') {
+                return Promise.resolve();
+              } else {
+                // query in the shredded data
+                return store.find(findQuery);
+              }
+            });
           } else {
             // this might be a single row query so we need to parse the URL for an id based query
             var id = _getRequestUrlId(request);
@@ -174,7 +182,7 @@ define(['./persistenceManager', './persistenceStoreManager', './persistenceUtils
                 var resourceType = dataArray[0].resourceType;
                 var transformedResults = {
                   name: storeName,
-                  data: results,
+                  data: results != null ? results : dataArray[0].data,
                   resourceType: resourceType
                 };
                 return unshredder([transformedResults], response).then(function (response) {

test/queryHandlers/test.js

@@ -105,7 +105,13 @@ define(['persist/persistenceManager', 'persist/defaultResponseProxy', 'persist/q
         });
       });
       asyncTest('getOracleRestQueryHandler', function (assert) {
-        expect(52);
+        expect(54);
+        mockFetch.addRequestReply('GET', '/testOracleRestQuery/556', {
+          status: 200,
+          body: JSON.stringify({DepartmentId: 556, DepartmentName: 'BB', LocationId: 200, ManagerId: 300})
+        }, function () {
+          assert.ok(true, 'Mock Fetch received Request when online');
+        });
         mockFetch.addRequestReply('GET', '/testOracleRestQuery', {
           status: 200,
           body: JSON.stringify({items: [{DepartmentId: 1001, DepartmentName: 'ADFPM 1001 neverending', LocationId: 200, ManagerId: 300},
@@ -128,7 +134,10 @@ define(['persist/persistenceManager', 'persist/defaultResponseProxy', 'persist/q
           fetch('/testOracleRestQuery?q=DepartmentName=BB&offset=0&limit=10').then(function (response) {
               assert.ok(true, 'Received Response when offline');
               persistenceManager.forceOffline(false);
-              return fetch('/testOracleRestQuery').then(function (response) {
+              return fetch('/testOracleRestQuery');
+            }).then(function(){
+              assert.ok(true, 'Received Response when online');
+              return fetch('/testOracleRestQuery/556');
             }).then(function(){
               assert.ok(true, 'Received Response when online');
               persistenceManager.forceOffline(true);
@@ -256,5 +265,4 @@ define(['persist/persistenceManager', 'persist/defaultResponseProxy', 'persist/q
           });
         });
       });
-    });
-  });
+    });