gpii-universal/scripts/convertPrefs.js

Cross platform, core components of the GPII personalization infrastructure.

/*!
Copyright 2018 OCAD University

Licensed under the New BSD license. You may not use this file except in
compliance with this License.

You may obtain a copy of the License at
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, 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} {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/ snapset

"use strict";

var fs = require("fs"),
    rimraf = require("rimraf"),
    mkdirp = require("mkdirp"),
    JSON5 = require("json5"),
    fluid = require("infusion"),
    gpii = fluid.registerNamespace("gpii");

require("./shared/prefsSetsDbUtils.js");
var inputDir = process.argv[2];
var targetDir = process.argv[3];
var prefsSafeType = process.argv[4] || "user";

if (process.argv.length < 4 || (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 + " as " + prefsSafeType + " Prefs Safes ...");

// Read and loop thru json5 files in the input directory
rimraf(targetDir, function () {
    mkdirp(targetDir, function () {
        filenames.forEach(function (filename) {
            if (filename.endsWith(".json5")) {
                try {
                    var gpiiKeyId = filename.substr(0, filename.length - 6);
                    var preferences = fs.readFileSync(inputDir + "/" + filename, "utf-8");
                    var keyData = gpii.prefsSetsDbUtils.generateKeyData(gpiiKeyId, JSON5.parse(preferences), prefsSafeType);
                    gpiiKeys.push(keyData.gpiiKey);
                    prefsSafes.push(keyData.prefsSafe);
                } catch (e) {
                    e.message += (" while converting preferences file " + filename);
                    throw e;
                }
            }
        });

        // Write the target files
        var prefsSafesFile = targetDir + "/prefsSafes.json";
        console.log("prefsSafesFile: " + prefsSafesFile);
        fs.writeFileSync(prefsSafesFile, JSON.stringify(prefsSafes, null, 4));

        var gpiiKeysFile = targetDir + "/gpiiKeys.json";
        fs.writeFileSync(gpiiKeysFile, JSON.stringify(gpiiKeys, null, 4));

        console.log("Finished converting preferences data in the source directory " + inputDir + " to the target directory " + targetDir);
    });
});