Updating to v1.5.5

Author: PeterBWu

.DS_Store

@@ -1,3 +1,3 @@
 dist
 node_modules
-temp
+temp

.gitignore

@@ -1,5 +1,47 @@
 /*global module:false*/
 module.exports = function (grunt) {
+  var fs = require('fs');
+  var path = require('path');
+
+  var karmaSetup = {
+    optSourceFolder : 'src/',
+    karmaTestFolder : 'test/karma-mocha-tests/',
+    karmaPreProcessorFiles : {},
+    karmaPreProcessorExcludedFiles : ['src/impl/fetch.js'],
+    karmaTestFiles : [],
+    testTasks : []
+  };
+
+  var helper = {
+    fetchFilesFromDirectory : function(directory, callback) {
+      fs.readdirSync(directory).forEach(file => {
+        var fullPath = path.join(directory, file);
+        if (fs.lstatSync(fullPath).isDirectory()) {
+          this.fetchFilesFromDirectory(fullPath, callback);
+         } else {
+          callback(fullPath, file);
+         }  
+      });
+    }
+  }
+
+  var generateKarmaPreProcessorFiles = function(file) {
+    if(!karmaSetup.karmaPreProcessorExcludedFiles.includes(file)) {
+      let _filePath = file.replace("src","dist/debug");
+      karmaSetup.karmaPreProcessorFiles[_filePath] = ['coverage'];
+    }
+  };
+
+  var setKarmaTestFiles = function(fileFullPath, fileName) {
+    var testFileData = {
+      testFile : null,
+      coverageFile : null
+    };
+    testFileData.testFile = fileFullPath;
+    testFileData.coverageFile = fileName.replace('.js','.json');
+    karmaSetup.karmaTestFiles.push(testFileData);
+  };
+
   // Project configuration.
   grunt.initConfig({
     // Metadata.
@@ -17,17 +59,19 @@ module.exports = function (grunt) {
       node_modules: 'node_modules',
       temp: 'temp',
       docs: 'docs',
-      config: 'config'
+      config: 'config',
+      karma_coverage: 'temp/coverage',
+      coverage_report: 'coverage'
     },
     banner: '/*! <%= pkg.title || pkg.name %> - v<%= pkg.version %> - ' +
       '<%= grunt.template.today("yyyy-mm-dd") %>\n' +
       '<%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' +
       '* Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' +
       ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */\n',
     copyRightBanner: '/**\n' +
-        ' * Copyright (c) 2017, Oracle and/or its affiliates.\n' +
-        ' * All rights reserved.\n' +
-        ' */\n',
+      ' * Copyright (c) 2017, Oracle and/or its affiliates.\n' +
+      ' * All rights reserved.\n' +
+      ' */\n',
     watch: {
       gruntfile: {
         files: '<%= jshint.gruntfile.src %>'
@@ -41,7 +85,9 @@ module.exports = function (grunt) {
         '<%= paths.docs %>',
         '<%= paths.temp %>'],
       bundles_debug: '<%= paths.dist_bundles_debug %>',
-      bundles_min: '<%= paths.dist_bundles_min %>'
+      bundles: '<%= paths.dist_bundles %>',
+      bundles_min: '<%= paths.dist_bundles_min %>',
+      karmaCoverage: '<%= paths.karma_coverage %>'
     },
     browserify: {
       pouchDB_browser_bundle: {
@@ -201,10 +247,6 @@ module.exports = function (grunt) {
           {
             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',
-            dest: 'coverage/dist/debug/bundles-config.js'
           }
         ]
       }
@@ -268,36 +310,6 @@ module.exports = function (grunt) {
           }
         ]
       },
-      config_coverage: {
-        files: [
-          {
-            expand: true,
-            cwd: 'config',
-            src: 'require-config-coverage.js',
-            dest: 'coverage/dist/debug'
-          }
-        ]
-      },
-      test_coverage: {
-        files: [
-          {
-            expand: true,
-            cwd: 'test',
-            src: '**',
-            dest: 'coverage/test'
-          }
-        ]
-      },
-      lib_coverage: {
-        files: [
-          {
-            expand: true,
-            cwd: 'lib',
-            src: '**',
-            dest: 'coverage/lib'
-          }
-        ]
-      },
       temp_debug: {
         files: [
           {
@@ -337,7 +349,7 @@ module.exports = function (grunt) {
             dest: '<%= paths.dist_min %>'
           }
         ]
-      },
+      }
     },
     jsdoc: {
       dist: {
@@ -389,29 +401,16 @@ module.exports = function (grunt) {
         }]
       }
     },
-    qunit: {
-      files: ['test/**/*.html'],
-      options: {
-        puppeteer: {
-          headless: true,
-          args: ['--disable-web-security']
-        }
-      }
-    },
-    run_java: {
-      jscover: {
-        command: 'java',
-        jarName: 'coverage/JSCover-all.jar',
-        javaArgs: '-fs dist/debug coverage/dist/debug --no-instrument=impl/sql-where-parser.min.js --no-instrument=impl/fetch.js --no-instrument=<%= pouchdb_bundle %>'
-      }
-    },
     shell: {
       start_test_server: {
         command: 'node ./test/lib/testServer/server.js',
         options: {
           stdout: true,
-          async: true,
+          async:true,
         }
+      },
+      karma_coverage_report: {
+        command: 'node_modules/nyc/bin/nyc.js -t <%= paths.karma_coverage %>/**/ report --reporter=html --report-dir=<%= coverage_report %>'
       }
     },
     usebanner:{
@@ -430,9 +429,19 @@ module.exports = function (grunt) {
            "!<%= paths.dist_min %>/**/fetch.js"],
         }
       }
+    },
+    karma: {
+      unit: {
+        configFile: 'karma.conf.js',
+        fileToTest: '',
+        karmaPreProcessorFiles: karmaSetup.karmaPreProcessorFiles,
+        browser: 'ChromeHeadless',
+        singleRun: true,
+        coverageDir: '<%= paths.karma_coverage %>'
+      }
     }
   });
-
+  
   // These plugins provide necessary tasks.
   grunt.loadNpmTasks('grunt-contrib-watch');
   grunt.loadNpmTasks('grunt-contrib-clean');
@@ -441,30 +450,25 @@ module.exports = function (grunt) {
   grunt.loadNpmTasks('grunt-jsdoc');
   grunt.loadNpmTasks('grunt-terser');
   grunt.loadNpmTasks('gruntify-eslint');
-  grunt.loadNpmTasks('grunt-contrib-qunit');
-  grunt.loadNpmTasks('grunt-run-java');
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('grunt-contrib-rename');
   grunt.loadNpmTasks('grunt-string-replace');
   grunt.loadNpmTasks('grunt-shell-spawn');
   grunt.loadNpmTasks('grunt-banner');
+  grunt.loadNpmTasks('grunt-karma');
 
   // Default task.
   grunt.registerTask('build', ['clean:all',
                               'browserify',
                               'eslint',
                               'copy:dist_debug',
                               'copy:dist_ext_lib',
-                              'copy:config_coverage',
-                              'copy:test_coverage',
-                              'copy:lib_coverage',
                               'copy:temp_debug',
                               'terser:minifyMinForBundleWithComments',
                               'terser:minifyMinForBundleWithoutComments',
                               'copy:temp_min',
                               'requirejs:compileBundles_min',
                               'requirejs:compileBundles_debug',
-                              'run_java',
                               'rename',
                               'string-replace',
                               'copy:dist_bundles_debug',
@@ -473,9 +477,65 @@ module.exports = function (grunt) {
                               'clean:bundles_debug',
                               'clean:bundles_min',
                               'usebanner',
-                              'shell:start_test_server',
-                              'qunit',
+                              'run-karma-mocha',
                               'jsdoc',
                               'copy:oracle_logo'
-  ]);
+                              ]);
+
+  function buildKarmaMochaTestTasks() {
+    karmaSetup.testTasks.push('clean:karmaCoverage');
+    karmaSetup.testTasks.push('shell:start_test_server');
+    karmaSetup.karmaTestFiles.forEach((file, index) => {
+      var taskName = 'run-karma-mocha-test-'+ (index+1);
+      karmaSetup.testTasks.push(taskName);
+      grunt.task.registerTask(taskName, function() {
+        grunt.config.set('karma.unit.fileToTest', file.testFile);
+        grunt.config.set('karma.unit.coverageFile', file.coverageFile);
+        grunt.task.run('karma');
+      });
+    })
+    karmaSetup.testTasks.push('shell:karma_coverage_report'); // Task to generate coverage report
+  }
+
+  function runTargetTestFiles(testFileParam) {
+    karmaSetup.karmaTestFiles = [];
+    var testFiles = testFileParam.split(',');
+    testFiles.forEach(file => {
+      var fileName = file+'.js',
+          filePath = karmaSetup.karmaTestFolder + fileName;
+      if(fs.existsSync(filePath)) {
+        setKarmaTestFiles(filePath, fileName);
+      }
+      else {
+        grunt.fail.warn(`No test file named ${fileName} exists in karma test directory`)
+      }
+    })
+  }
+
+
+  grunt.task.registerTask('run-karma-mocha', function() {
+    helper.fetchFilesFromDirectory(karmaSetup.karmaTestFolder, setKarmaTestFiles);
+    helper.fetchFilesFromDirectory(karmaSetup.optSourceFolder, generateKarmaPreProcessorFiles); // Generate Preprocessors for Karma
+
+    if(grunt.option('test')) {
+      var testFileParam = grunt.option('test');
+      if(typeof testFileParam === 'string')
+        runTargetTestFiles(testFileParam);
+      else 
+        grunt.fail.warn("No test file provided as input!!");
+    }
+    if(grunt.option('browser')) {
+      var browser = grunt.option('browser');
+      grunt.config.set('karma.unit.browser', browser);
+    }
+    if(typeof grunt.option('singleRun') === 'boolean')
+      grunt.config.set('karma.unit.singleRun', grunt.option('singleRun'));
+
+    buildKarmaMochaTestTasks(); // Generates batch of karma mocha tests
+    grunt.task.run(karmaSetup.testTasks);
+  });
+
+  grunt.task.registerTask('run-karma-coverage', function() {
+    grunt.task.run('run-karma-mocha');
+  });
 };

Gruntfile.js

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.5.4 #
+# offline-persistence-toolkit 1.5.3 #
 
 ## Introduction ##
 

JSDOC.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.5.4 #
+# offline-persistence-toolkit 1.5.5 #
 
 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.5.4/min'
+      'persist' : 'js/libs/persist/v1.5.5/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.5.4/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.5/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.5.4/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.5/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.2.2',
       'pouchfind': 'js/libs/pouchdb.find',
-      'persist' : 'js/libs/persist/v1.5.4/min'
+      'persist' : 'js/libs/persist/v1.5.5/min'
 
       // Other path mappings here
  }
@@ -305,23 +305,23 @@ The simpleJsonShredding implementation assumes that the response payload is eith
 As the structure of response payloads can vary from endpoint to endpoint, applications can also implement their own custom shredders and unshredders to meet their own needs.
 
 If the backend resource exposed through a collection endpoint allows delete, there are always race conditions where
-rows are deleted behind the scenes. If the resource is cached and shredded on the client, it is possible that even 
-though a row is deleted at the backend, it can still exist on the client. If queryHandler is configured to support 
+rows are deleted behind the scenes. If the resource is cached and shredded on the client, it is possible that even
+though a row is deleted at the backend, it can still exist on the client. If queryHandler is configured to support
 querying the shredded client data, that row that does not exist on server will be served from client cache. Application
-needs to accept that staleness is a possibility. There is one scenario that Offline Persistence Toolkit can help dealing 
+needs to accept that staleness is a possibility. There is one scenario that Offline Persistence Toolkit can help dealing
 with staleness is when a returned collection from server is known to be complete. A complete collection response contains
-all rows of the resources, thus any client side rows that are not in the list will be removed from the shredded store. 
+all rows of the resources, thus any client side rows that are not in the list will be removed from the shredded store.
 A complete collection response is a collection response that is either one of the following:
 
 1. It is a response that is served to a request which does not contain any query parameters
-2. It is a response that is served to a request which only contains offset or limit query parameters where offset is 0 
+2. It is a response that is served to a request which only contains offset or limit query parameters where offset is 0
    and the response contains less rows than the specified limit when limit is bigger than 0.
-   
+
 In order for Offline Persistence Toolkit to figure our the offset and limit of the request, queryHandler can
-have an optional method normalizeQueryParameter which takes a url and returns a structure as defined in 
+have an optional method normalizeQueryParameter which takes a url and returns a structure as defined in
 [NormalizedQuery](https://oracle.github.io/offline-persistence-toolkit/NormalizedQuery.html "NormalizedQuery").
 The two out-of-box queryHandlers support normalizeQueryParameter. Any custom queryHandler that would like to
-leverage this feature needs to implement normalizeQueryParameter. 
+leverage this feature needs to implement normalizeQueryParameter.
 
 
 ## Modifications: PUT and DELETE ##

README.md

@@ -1,4 +1,4 @@
-# offline-persistence-toolkit 1.5.4 #
+# offline-persistence-toolkit 1.5.5 #
 
 # Introduction #