GPII-3138: Update snapsets in data base

README.md

@@ -98,14 +98,35 @@ have set the `NODE_ENV` variable.
 
 ### Convert Preferences Data
 
-GPII has 2 set of preferences JSON5 data files:
+GPII has two sets of source preferences JSON5 data files, located at `%gpii-universal/testData/preferences` and
+`%gpii-universal/tests/data/preferences/`.  These are converted and used in various configurations.
 
-* The preferences files for running GPII are located at %gpii-universal/testData/preferences
-* The preferences files for running node tests are located at %gpii-universal/tests/data/preferences
+The preferences files in `%gpii-universaluniversal/testData/preferences/` are converted into both `snapset` and
+`user` preferences:
 
-When any preferences file in either one of these 2 directories are modified, running `npm run postinstall` will generate
-gpiiKeys.json and prefsSafes.json, the files that are in the structure to be loaded into PouchDB/CouchDB, based off
-these directories. This step is needed for the modification to be applied to GPII.
+* `%gpii-universal/build/dbData/snapset/gpiiKeys.json`
+* `%gpii-universal/build/dbData/snapset/prefsSafes.json`
+* `%gpii-universal/build/dbData/user/gpiiKeys.json`
+* `%gpii-universal/build/dbData/user/prefsSafes.json`
+
+The above `snapset` preferences safes and GPII keys are:
+
+1. loaded into the production and the staging CouchDB in cloud environments.
+2. loaded into the PouchDB when GPII runs locally, regardless of which configuration is used.
+
+The above `user` preferences are loaded into the local PouchDB for running GPII integration tests.
+
+The preferences in `%gpii-universal/tests/data/preferences/` are converted into `user` preferences:
+
+* `%gpii-universal/build/tests/dbData/user/gpiiKeys.json`
+* `%gpii-universal/build/tests/dbData/user/prefsSafes.json`
+
+These `user` preferences and the above `snapset` preferences are used with a PouchDB when GPII runs in a development configuration.
+
+When any preferences file in either one of the two source directories (`%gpii-universaluniversal/testData/preferences/`
+or `%gpii-universal/tests/data/preferences/`) are modified, running `npm run postinstall` will generate
+gpiiKeys.json and prefsSafes.json files, whose contents are structured for loading into PouchDB/CouchDB.
+This step is needed for any preferences modifications that are to be applied to GPII.
 
 ### Running browser tests
 

package.json

@@ -78,6 +78,6 @@
         "test:vagrantProduction": "vagrant ssh -c 'cd /home/vagrant/sync/universal; DISPLAY=:0; ./scripts/vagrantCloudBasedContainers.sh'",
         "posttest": "node node_modules/nyc/bin/nyc.js report -r text-summary -r html --report-dir reports --temp-directory coverage",
         "start": "node gpii.js",
-        "postinstall": "node scripts/browserifyTestDependency.js && node scripts/convertPrefs.js testData/preferences/ build/dbData/ && node scripts/convertPrefs.js tests/data/preferences/ build/tests/dbData/"
+        "postinstall": "node scripts/browserifyTestDependency.js && node scripts/convertPrefs.js testData/preferences/ build/dbData/snapset/ snapset && node scripts/convertPrefs.js testData/preferences/ build/dbData/user/ user && node scripts/convertPrefs.js tests/data/preferences/ build/tests/dbData/ user"
     }
 }

scripts/convertPrefs.js

@@ -11,10 +11,10 @@ https://github.com/GPII/universal/blob/master/LICENSE.txt
 // This script reads files from an input directory that contains preferences JSON5 files and convert them to JSON files of GPII keys and
 // preferences safes suitable for direct loading into CouchDB or PouchDB, which comply with the new GPII data model:
 // https://wiki.gpii.net/w/Keys,_KeyTokens,_and_Preferences in the target directory
-// Usage: node scripts/convertPrefs.js {input_path} {target_path}
+// Usage: node scripts/convertPrefs.js {input_path} {target_path} {prefsSafeType}, where {prefsSafeType} is one of "snapset" or "user" and defaults to "user"
 //
 // A sample command that runs this script in the universal root directory:
-// node scripts/convertPrefs.js testData/preferences/ build/dbData/
+// node scripts/convertPrefs.js testData/preferences/ build/dbData/ snapset
 
 "use strict";
 
@@ -25,13 +25,19 @@ var fs = require("fs"),
 
 var inputDir = process.argv[2];
 var targetDir = process.argv[3];
+var prefsSafeType = process.argv[4] || "user";
 
+if (prefsSafeType !== "snapset" && prefsSafeType !== "user") {
+    console.log("Usage: node scripts/convertPrefs.js InputFolder OutputFolder PrefsSafeType");
+    console.log("  where PrefsSafeType, is one of 'snapset' or 'user' (defaults to 'user')");
+    process.exit(1);
+}
 var prefsSafes = [];
 var gpiiKeys = [];
 
 var filenames = fs.readdirSync(inputDir);
 
-console.log("Converting preferences data in the source directory " + inputDir + " to the target directory " + targetDir + " ...");
+console.log("Converting preferences data in the source directory " + inputDir + " to the target directory " + targetDir + " as " + prefsSafeType + " Prefs Safes ...");
 
 // Read and loop thru json5 files in the input directory
 rimraf(targetDir, function () {
@@ -60,7 +66,7 @@ rimraf(targetDir, function () {
                     "_id": prefsSafeId,
                     "type": "prefsSafe",
                     "schemaVersion": "0.1",
-                    "prefsSafeType": "user",
+                    "prefsSafeType": prefsSafeType,
                     "name": gpiiKey,
                     "password": null,
                     "email": null,