Merge branch 'master' into mrschmidt/nomultitab

Author: schmidt-sebastian

packages-exp/app-exp/package.json

@@ -24,9 +24,9 @@
   },
   "dependencies": {
     "@firebase/app-types-exp": "0.800.0",
-    "@firebase/util": "0.2.43",
-    "@firebase/logger": "0.2.0",
-    "@firebase/component": "0.1.8",
+    "@firebase/util": "0.2.44",
+    "@firebase/logger": "0.2.1",
+    "@firebase/component": "0.1.9",
     "tslib": "1.11.1"
   },
   "license": "Apache-2.0",

packages/firestore/package.json

@@ -50,6 +50,8 @@
     "@firebase/app-types": "0.x"
   },
   "devDependencies": {
+    "@types/json-stable-stringify": "1.0.32",
+    "json-stable-stringify": "1.0.1",
     "protobufjs": "6.8.9",
     "rollup": "2.0.6",
     "rollup-plugin-copy-assets": "1.1.0",

packages/firestore/test/unit/specs/describe_spec.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2017 Google Inc.
+ * Copyright 2017 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,11 +19,14 @@ import { ExclusiveTestFunction, PendingTestFunction } from 'mocha';
 
 import { IndexedDbPersistence } from '../../../src/local/indexeddb_persistence';
 import { assert } from '../../../src/util/assert';
+import { primitiveComparator } from '../../../src/util/misc';
 import { addEqualityMatcher } from '../../util/equality_matcher';
 
 import { SpecBuilder } from './spec_builder';
 import { SpecStep } from './spec_test_runner';
 
+import * as stringify from 'json-stable-stringify';
+
 // Disables all other tests; useful for debugging. Multiple tests can have
 // this tag and they'll all be run (but all others won't).
 const EXCLUSIVE_TAG = 'exclusive';
@@ -242,7 +245,65 @@ export function describeSpec(
   } else {
     specsInThisTest = {};
     builder();
-    const output = JSON.stringify(specsInThisTest, null, 2);
+    // Note: We use json-stable-stringify instead of JSON.stringify() to ensure
+    // that the generated JSON does not produce diffs merely due to the order
+    // of the keys in an object changing.
+    const output = stringify(specsInThisTest, {
+      space: 2,
+      cmp: stringifyComparator
+    });
     writeJSONFile(output);
   }
 }
+
+/**
+ * The key ordering overrides used when sorting keys in the generated JSON.
+ * If both keys being compared are present in this array then they should be
+ * ordered in the generated JSON in the same relative order of this array.
+ */
+const stringifyCustomOrdering = [
+  'comment',
+  'describeName',
+  'itName',
+  'tags',
+  'config',
+  'steps'
+];
+
+/**
+ * Assigns a "group number" to the given key in the generated JSON.
+ *
+ * Keys with lower group numbers should be ordered before keys with greater
+ * group numbers. Keys with equal group numbers should be ordered
+ * alphabetically.
+ */
+function stringifyGroup(s: string): number {
+  const index = stringifyCustomOrdering.indexOf(s);
+  if (index >= 0) {
+    return index;
+  } else if (!s.startsWith('expected')) {
+    return stringifyCustomOrdering.length;
+  } else {
+    return stringifyCustomOrdering.length + 1;
+  }
+}
+
+/**
+ * A comparator function for stringify() that sorts keys in the JSON output.
+ *
+ * In order to produce JSON that has somewhat-intuitively-ordered keys, this
+ * comparator intentionally deviates from pure alphabetic ordering, placing
+ * some logically-first keys before others.
+ */
+function stringifyComparator(
+  a: stringify.Element,
+  b: stringify.Element
+): number {
+  const aGroup = stringifyGroup(a.key);
+  const bGroup = stringifyGroup(b.key);
+  if (aGroup === bGroup) {
+    return primitiveComparator(a.key, b.key);
+  } else {
+    return primitiveComparator(aGroup, bGroup);
+  }
+}

yarn.lock

@@ -2121,6 +2121,11 @@
   resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.3.tgz#bdfd69d61e464dcc81b25159c270d75a73c1a636"
   integrity sha512-Il2DtDVRGDcqjDtE+rF8iqg1CArehSK84HZJCT7AMITlyXRBpuPhqGLDQMowraqqu1coEaimg4ZOqggt6L6L+A==
 
+"@types/[email protected]":
+  version "1.0.32"
+  resolved "https://registry.npmjs.org/@types/json-stable-stringify/-/json-stable-stringify-1.0.32.tgz#121f6917c4389db3923640b2e68de5fa64dda88e"
+  integrity sha512-q9Q6+eUEGwQkv4Sbst3J4PNgDOvpuVuKj79Hl/qnmBMEIPzB5QoFRUtjcgcg2xNUZyYUGXBk5wYIBKHt0A+Mxw==
+
 "@types/long@*", "@types/long@^4.0.0":
   version "4.0.0"
   resolved "https://registry.npmjs.org/@types/long/-/long-4.0.0.tgz#719551d2352d301ac8b81db732acb6bdc28dbdef"
@@ -8924,6 +8929,13 @@ json-stable-stringify-without-jsonify@^1.0.1:
   resolved "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651"
   integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=
 
+[email protected]:
+  version "1.0.1"
+  resolved "https://registry.npmjs.org/json-stable-stringify/-/json-stable-stringify-1.0.1.tgz#9a759d39c5f2ff503fd5300646ed445f88c4f9af"
+  integrity sha1-mnWdOcXy/1A/1TAGRu1EX4jE+a8=
+  dependencies:
+    jsonify "~0.0.0"
+
 json-stable-stringify@~0.0.0:
   version "0.0.1"
   resolved "https://registry.npmjs.org/json-stable-stringify/-/json-stable-stringify-0.0.1.tgz#611c23e814db375527df851193db59dd2af27f45"