gecko-dev/toolkit/modules/CanonicalJSON.jsm
Mathieu Leplatre 28f6b2f7bc Bug 1250191 - Add a way to serialize JSON canonically. r=MattN
Based on Alexis Metaireau's patch.

MozReview-Commit-ID: 3H3SKWy5GgM

--HG--
extra : rebase_source : e09660d0e031e72093546df684229aae616b5a72
extra : amend_source : 9c02da14cd5ff7255f5afc4a7adc15786ab0f8b6
2016-04-18 12:02:42 +02:00

63 lines
2.1 KiB
JavaScript

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
this.EXPORTED_SYMBOLS = ["CanonicalJSON"];
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "jsesc",
"resource://gre/modules/third_party/jsesc/jsesc.js");
this.CanonicalJSON = {
/**
* Return the canonical JSON form of the passed source, sorting all the object
* keys recursively. Note that this method will cause an infinite loop if
* cycles exist in the source (bug 1265357).
*
* @param source
* The elements to be serialized.
*
* The output will have all unicode chars escaped with the unicode codepoint
* as lowercase hexadecimal.
*
* @usage
* CanonicalJSON.stringify(listOfRecords);
**/
stringify: function stringify(source) {
if (Array.isArray(source)) {
const jsonArray = source.map(x => typeof x === "undefined" ? null : x);
return `[${jsonArray.map(stringify).join(",")}]`;
}
if (typeof source === "number") {
if (source === 0) {
return (Object.is(source, -0)) ? "-0" : "0";
}
}
// Leverage jsesc library, mainly for unicode escaping.
const toJSON = (input) => jsesc(input, {lowercaseHex: true, json: true});
if (typeof source !== "object" || source === null) {
return toJSON(source);
}
// Dealing with objects, ordering keys.
const sortedKeys = Object.keys(source).sort();
const lastIndex = sortedKeys.length - 1;
return sortedKeys.reduce((serial, key, index) => {
const value = source[key];
// JSON.stringify drops keys with an undefined value.
if (typeof value === "undefined") {
return serial;
}
const jsonValue = value && value.toJSON ? value.toJSON() : value;
const suffix = index !== lastIndex ? "," : "";
const escapedKey = toJSON(key);
return serial + `${escapedKey}:${stringify(jsonValue)}${suffix}`;
}, "{") + "}";
},
};