@wildwinter/toolkit 0.1.0 → 0.2.1

package/conformance/extensions/merge.json

@@ -0,0 +1,154 @@
+{
+  "about": "The merge. `tree` cases run mergeTree with a strategy given as data, expecting the merged value and each clash's path and kind. `data` cases run mergeExtensionData over extension shards, with the manifest (or null for none), expecting the merged shard, `unresolved` mark included. A base of {} is a shard that did not exist at the base.",
+  "tree": [
+    { "name": "atomic: one side's change wins", "strategy": { "kind": "atomic" },
+      "base": 1, "ours": 1, "theirs": 2, "merged": 2, "conflicts": [] },
+    { "name": "atomic: the same change on both sides is no clash", "strategy": { "kind": "atomic" },
+      "base": 1, "ours": 3, "theirs": 3, "merged": 3, "conflicts": [] },
+    { "name": "atomic: two different changes clash and keep ours", "strategy": { "kind": "atomic" },
+      "base": 1, "ours": 2, "theirs": 3, "merged": 2, "conflicts": [{ "path": "", "kind": "both-changed" }] },
+    { "name": "atomic: objects compare by content, not key order", "strategy": { "kind": "atomic" },
+      "base": { "a": 1, "b": 2 }, "ours": { "b": 2, "a": 1 }, "theirs": { "a": 1, "b": 3 }, "merged": { "a": 1, "b": 3 }, "conflicts": [] },
+    { "name": "map: different keys merge", "strategy": { "kind": "map", "of": { "kind": "atomic" } },
+      "base": { "a": 1 }, "ours": { "a": 1, "b": 2 }, "theirs": { "a": 5, "c": 3 }, "merged": { "a": 5, "b": 2, "c": 3 }, "conflicts": [] },
+    { "name": "map: a delete against an edit clashes", "strategy": { "kind": "map", "of": { "kind": "atomic" } },
+      "base": { "a": 1 }, "ours": {}, "theirs": { "a": 2 }, "merged": {}, "conflicts": [{ "path": ".a", "kind": "delete-vs-edit" }] },
+    { "name": "set: additions union, deletions respected", "strategy": { "kind": "set" },
+      "base": ["a", "b"], "ours": ["a", "b", "c"], "theirs": ["b", "d"], "merged": ["b", "c", "d"], "conflicts": [] },
+    { "name": "keyed, sorted: union by key, each item merged", "strategy": { "kind": "keyed", "key": "id", "of": { "kind": "object", "fields": {} } },
+      "base": [{ "id": "b", "n": 1, "m": 1 }],
+      "ours": [{ "id": "c" }, { "id": "b", "n": 2, "m": 1 }],
+      "theirs": [{ "id": "b", "n": 1, "m": 2 }, { "id": "a" }],
+      "merged": [{ "id": "a" }, { "id": "b", "n": 2, "m": 2 }, { "id": "c" }], "conflicts": [] },
+    { "name": "keyed: the same key added twice differently clashes", "strategy": { "kind": "keyed", "key": "id", "of": { "kind": "atomic" } },
+      "base": [], "ours": [{ "id": "a", "n": 1 }], "theirs": [{ "id": "a", "n": 2 }],
+      "merged": [{ "id": "a", "n": 1 }], "conflicts": [{ "path": "[a]", "kind": "added-both" }] },
+    { "name": "keyed: a delete against an edit clashes and keeps ours", "strategy": { "kind": "keyed", "key": "id", "of": { "kind": "atomic" } },
+      "base": [{ "id": "a", "n": 1 }], "ours": [], "theirs": [{ "id": "a", "n": 2 }],
+      "merged": [], "conflicts": [{ "path": "[a]", "kind": "delete-vs-edit" }] },
+    { "name": "keyed, preserved: theirs reordered, ours added; the order is theirs with ours's addition after its neighbour",
+      "strategy": { "kind": "keyed", "key": "id", "order": "preserve", "of": { "kind": "atomic" } },
+      "base": [{ "id": "a" }, { "id": "b" }, { "id": "c" }],
+      "ours": [{ "id": "a" }, { "id": "x" }, { "id": "b" }, { "id": "c" }],
+      "theirs": [{ "id": "c" }, { "id": "a" }, { "id": "b" }],
+      "merged": [{ "id": "c" }, { "id": "a" }, { "id": "x" }, { "id": "b" }], "conflicts": [] },
+    { "name": "keyed, preserved: an addition at the front stays at the front",
+      "strategy": { "kind": "keyed", "key": "id", "order": "preserve", "of": { "kind": "atomic" } },
+      "base": [{ "id": "a" }], "ours": [{ "id": "a" }], "theirs": [{ "id": "z" }, { "id": "a" }],
+      "merged": [{ "id": "z" }, { "id": "a" }], "conflicts": [] },
+    { "name": "keyed, preserved: both reordered differently clashes and keeps ours",
+      "strategy": { "kind": "keyed", "key": "id", "order": "preserve", "of": { "kind": "atomic" } },
+      "base": [{ "id": "a" }, { "id": "b" }, { "id": "c" }],
+      "ours": [{ "id": "b" }, { "id": "a" }, { "id": "c" }],
+      "theirs": [{ "id": "a" }, { "id": "c" }, { "id": "b" }],
+      "merged": [{ "id": "b" }, { "id": "a" }, { "id": "c" }], "conflicts": [{ "path": ":order", "kind": "both-changed" }] },
+    { "name": "object: named keys by their strategy, others atomic", "strategy": { "kind": "object", "fields": { "tags": { "kind": "set" } } },
+      "base": { "tags": ["a"], "n": 1 }, "ours": { "tags": ["a", "b"], "n": 2 }, "theirs": { "tags": ["c"], "n": 1 },
+      "merged": { "n": 2, "tags": ["b", "c"] }, "conflicts": [] },
+    { "name": "object: other keys take `other` when it is given", "strategy": { "kind": "object", "fields": {}, "other": { "kind": "map", "of": { "kind": "atomic" } } },
+      "base": { "k": { "a": 1 } }, "ours": { "k": { "a": 2 } }, "theirs": { "k": { "a": 1, "b": 1 } },
+      "merged": { "k": { "a": 2, "b": 1 } }, "conflicts": [] },
+    { "name": "a value whose shape no longer fits its strategy merges as one value", "strategy": { "kind": "map", "of": { "kind": "atomic" } },
+      "base": { "a": 1 }, "ours": "gone", "theirs": { "a": 2 }, "merged": "gone", "conflicts": [{ "path": "", "kind": "both-changed" }] }
+  ],
+  "manifest": {
+    "schema": "wildwinter/extension@0", "id": "probe", "name": "Probe", "version": "1.0.0",
+    "targets": { "storylets": {
+      "card": { "fields": [
+        { "name": "note", "type": "text" },
+        { "name": "loud", "type": "boolean" },
+        { "name": "marks", "type": "flags", "values": ["a", "b", "c"] },
+        { "name": "cue", "type": "record", "fields": [{ "name": "sound", "type": "text" }, { "name": "gain", "type": "number" }] },
+        { "name": "perf", "type": "map", "key": { "type": "reference", "to": "tag" }, "of": { "type": "record", "fields": [{ "name": "look", "type": "text" }, { "name": "gesture", "type": "text" }] } },
+        { "name": "beats", "type": "list", "id": "id", "of": { "type": "record", "fields": [{ "name": "id", "type": "text" }, { "name": "at", "type": "number" }] } },
+        { "name": "words", "type": "list", "of": { "type": "text" } }
+      ] }
+    } }
+  },
+  "data": [
+    { "name": "different nodes never clash",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" }, "c_2": { "note": "z" } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" }, "c_2": { "note": "z" } } } } },
+    { "name": "different fields of one node merge",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a", "loud": true } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "loud": true, "note": "b" } } } } },
+    { "name": "flags merge value by value",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "marks": ["a"] } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "marks": ["a", "b"] } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "marks": ["c"] } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "marks": ["b", "c"] } } } } },
+    { "name": "a record merges field by field",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "cue": { "sound": "bell", "gain": 1 } } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "cue": { "sound": "gong", "gain": 1 } } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "cue": { "sound": "bell", "gain": 2 } } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "cue": { "gain": 2, "sound": "gong" } } } } } },
+    { "name": "a map merges key by key, then by the value's type: different characters merge, one character's two looks clash",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "perf": { "v_ann": { "look": "down" }, "v_bo": { "look": "up" } } } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "perf": { "v_ann": { "look": "left" }, "v_bo": { "look": "up", "gesture": "shrug" } } } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "perf": { "v_ann": { "look": "right" }, "v_bo": { "look": "away" } } } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "perf": { "v_ann": { "look": "left" }, "v_bo": { "gesture": "shrug", "look": "away" } } } } },
+        "unresolved": [{ "path": "entries.card.c_1.perf.v_ann.look", "kind": "both-changed", "base": "down", "ours": "left", "theirs": "right" }] } },
+    { "name": "a list with ids merges by id and keeps the authored order",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "beats": [{ "id": "b2", "at": 1 }, { "id": "b1", "at": 2 }] } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "beats": [{ "id": "b2", "at": 5 }, { "id": "b1", "at": 2 }] } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "beats": [{ "id": "b2", "at": 1 }, { "id": "b1", "at": 2 }, { "id": "b0", "at": 9 }] } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "beats": [{ "id": "b2", "at": 5 }, { "id": "b1", "at": 2 }, { "id": "b0", "at": 9 }] } } } } },
+    { "name": "a list without ids merges whole",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "words": ["a"] } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "words": ["a", "b"] } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "words": ["c", "a"] } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "words": ["a", "b"] } } },
+        "unresolved": [{ "path": "entries.card.c_1.words", "kind": "both-changed", "base": ["a"], "ours": ["a", "b"], "theirs": ["c", "a"] }] } },
+    { "name": "a node's entry deleted on one side while edited on the other clashes, keeps ours, and the mark holds theirs",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } } },
+      "ours": { "extension": "probe", "entries": { "card": {} } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" } } } },
+      "merged": { "extension": "probe", "entries": { "card": {} },
+        "unresolved": [{ "path": "entries.card.c_1", "kind": "delete-vs-edit", "base": { "note": "a" }, "theirs": { "note": "b" } }] } },
+    { "name": "without the manifest, a node's whole entry merges as one value",
+      "manifest": null,
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" }, "c_2": { "note": "a" } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" }, "c_2": { "note": "a" } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a", "loud": true }, "c_2": { "note": "z" } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" }, "c_2": { "note": "z" } } },
+        "unresolved": [{ "path": "entries.card.c_1", "kind": "both-changed", "base": { "note": "a" }, "ours": { "note": "b" }, "theirs": { "loud": true, "note": "a" } }] } },
+    { "name": "a kind the manifest does not target merges per node as one value",
+      "base": { "extension": "probe", "entries": { "deck": { "k_1": { "x": 1 } } } },
+      "ours": { "extension": "probe", "entries": { "deck": { "k_1": { "x": 2 } } } },
+      "theirs": { "extension": "probe", "entries": { "deck": { "k_1": { "x": 1 }, "k_2": { "x": 3 } } } },
+      "merged": { "extension": "probe", "entries": { "deck": { "k_1": { "x": 2 }, "k_2": { "x": 3 } } } } },
+    { "name": "a shard added on both sides merges two-sided",
+      "base": {},
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } } },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_2": { "note": "b" } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" }, "c_2": { "note": "b" } } } } },
+    { "name": "a mark already on one side is carried until it is resolved",
+      "base": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } } },
+      "ours": { "extension": "probe", "entries": { "card": { "c_1": { "note": "a" } } },
+        "unresolved": [{ "path": "entries.card.c_9.note", "kind": "both-changed", "ours": "x", "theirs": "y" }] },
+      "theirs": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" } } } },
+      "merged": { "extension": "probe", "entries": { "card": { "c_1": { "note": "b" } } },
+        "unresolved": [{ "path": "entries.card.c_9.note", "kind": "both-changed", "ours": "x", "theirs": "y" }] } },
+    { "name": "a mark one side resolved stays resolved",
+      "base": { "extension": "probe", "entries": { "card": {} },
+        "unresolved": [{ "path": "entries.card.c_9.note", "kind": "both-changed", "ours": "x", "theirs": "y" }] },
+      "ours": { "extension": "probe", "entries": { "card": { "c_9": { "note": "x" } } } },
+      "theirs": { "extension": "probe", "entries": { "card": {} },
+        "unresolved": [{ "path": "entries.card.c_9.note", "kind": "both-changed", "ours": "x", "theirs": "y" }] },
+      "merged": { "extension": "probe", "entries": { "card": { "c_9": { "note": "x" } } } } }
+  ],
+  "unresolved": [
+    { "name": "a shard with no mark passes", "shard": { "extension": "probe", "entries": {} }, "problems": [] },
+    { "name": "a shard carrying the mark is refused, once per clash",
+      "shard": { "extension": "probe", "entries": {}, "unresolved": [
+        { "path": "entries.card.c_1.note", "kind": "both-changed", "ours": "a", "theirs": "b" },
+        { "path": "entries.card.c_2", "kind": "delete-vs-edit", "theirs": {} }
+      ] },
+      "problems": [{ "path": "entries.card.c_1.note", "code": "unresolved" }, { "path": "entries.card.c_2", "code": "unresolved" }] },
+    { "name": "an empty mark is still a mark", "shard": { "unresolved": [] }, "problems": [{ "path": "unresolved", "code": "unresolved" }] }
+  ]
+}