1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
import {
fromJS,
List,
Map,
merge,
mergeDeep,
mergeDeepWith,
Record,
Set,
} from 'immutable';
describe('merge', () => {
it('merges two maps', () => {
const m1 = Map({ a: 1, b: 2, c: 3 });
const m2 = Map({ d: 10, b: 20, e: 30 });
expect(m1.merge(m2)).toEqual(Map({ a: 1, b: 20, c: 3, d: 10, e: 30 }));
});
it('can merge in an explicitly undefined value', () => {
const m1 = Map({ a: 1, b: 2 });
const m2 = Map({ a: undefined as any });
expect(m1.merge(m2)).toEqual(Map({ a: undefined, b: 2 }));
});
it('merges two maps with a merge function', () => {
const m1 = Map({ a: 1, b: 2, c: 3 });
const m2 = Map({ d: 10, b: 20, e: 30 });
expect(m1.mergeWith((a: any, b: any) => a + b, m2)).toEqual(
Map({ a: 1, b: 22, c: 3, d: 10, e: 30 })
);
});
it('throws typeError without merge function', () => {
const m1 = Map({ a: 1, b: 2, c: 3 });
const m2 = Map({ d: 10, b: 20, e: 30 });
// @ts-expect-error
expect(() => m1.mergeWith(1, m2)).toThrowError(TypeError);
});
it('provides key as the third argument of merge function', () => {
const m1 = Map({ id: 'temp', b: 2, c: 3 });
const m2 = Map({ id: 10, b: 20, e: 30 });
const add = (a: any, b: any) => a + b;
expect(
m1.mergeWith((a, b, key) => (key !== 'id' ? add(a, b) : b), m2)
).toEqual(Map({ id: 10, b: 22, c: 3, e: 30 }));
});
it('deep merges two maps', () => {
const m1 = fromJS({ a: { b: { c: 1, d: 2 } } }) as Map<string, any>;
const m2 = fromJS({ a: { b: { c: 10, e: 20 }, f: 30 }, g: 40 });
expect(m1.mergeDeep(m2)).toEqual(
fromJS({ a: { b: { c: 10, d: 2, e: 20 }, f: 30 }, g: 40 })
);
});
it('merge uses === for return-self optimization', () => {
const date1 = new Date(1234567890000);
// Value equal, but different reference.
const date2 = new Date(1234567890000);
const m = Map().set('a', date1);
expect(m.merge({ a: date2 })).not.toBe(m);
expect(m.merge({ a: date1 })).toBe(m);
});
it('deep merge uses === for return-self optimization', () => {
const date1 = new Date(1234567890000);
// Value equal, but different reference.
const date2 = new Date(1234567890000);
const m = Map().setIn(['a', 'b', 'c'], date1);
expect(m.mergeDeep({ a: { b: { c: date2 } } })).not.toBe(m);
expect(m.mergeDeep({ a: { b: { c: date1 } } })).toBe(m);
});
it('deep merges raw JS', () => {
const m1 = fromJS({ a: { b: { c: 1, d: 2 } } }) as Map<string, any>;
const js = { a: { b: { c: 10, e: 20 }, f: 30 }, g: 40 };
expect(m1.mergeDeep(js)).toEqual(
fromJS({ a: { b: { c: 10, d: 2, e: 20 }, f: 30 }, g: 40 })
);
});
it('deep merges raw JS with a merge function', () => {
const m1 = fromJS({ a: { b: { c: 1, d: 2 } } }) as Map<string, any>;
const js = { a: { b: { c: 10, e: 20 }, f: 30 }, g: 40 };
expect(m1.mergeDeepWith((a: any, b: any) => a + b, js)).toEqual(
fromJS({ a: { b: { c: 11, d: 2, e: 20 }, f: 30 }, g: 40 })
);
});
it('deep merges raw JS into raw JS with a merge function', () => {
const js1 = { a: { b: { c: 1, d: 2 } } };
const js2 = { a: { b: { c: 10, e: 20 }, f: 30 }, g: 40 };
expect(mergeDeepWith((a: any, b: any) => a + b, js1, js2)).toEqual({
a: { b: { c: 11, d: 2, e: 20 }, f: 30 },
g: 40,
});
});
it('deep merges collections into raw JS with a merge function', () => {
const js = { a: { b: { c: 1, d: 2 } } };
const m = fromJS({ a: { b: { c: 10, e: 20 }, f: 30 }, g: 40 });
expect(mergeDeepWith((a: any, b: any) => a + b, js, m)).toEqual({
a: { b: { c: 11, d: 2, e: 20 }, f: 30 },
g: 40,
});
});
it('returns self when a deep merges is a no-op', () => {
const m1 = fromJS({ a: { b: { c: 1, d: 2 } } }) as Map<string, any>;
expect(m1.mergeDeep({ a: { b: { c: 1 } } })).toBe(m1);
});
it('returns arg when a deep merges is a no-op', () => {
const m1 = fromJS({ a: { b: { c: 1, d: 2 } } });
expect(Map().mergeDeep(m1)).toBe(m1);
});
it('returns self when a deep merges is a no-op on raw JS', () => {
const m1 = { a: { b: { c: 1, d: 2 } } };
expect(mergeDeep(m1, { a: { b: { c: 1 } } })).toBe(m1);
});
it('can overwrite existing maps', () => {
expect(
(
fromJS({ a: { x: 1, y: 1 }, b: { x: 2, y: 2 } }) as Map<string, any>
).merge({
a: null,
b: Map({ x: 10 }),
})
).toEqual(fromJS({ a: null, b: { x: 10 } }));
expect(
(
fromJS({ a: { x: 1, y: 1 }, b: { x: 2, y: 2 } }) as Map<string, any>
).mergeDeep({
a: null,
b: { x: 10 },
})
).toEqual(fromJS({ a: null, b: { x: 10, y: 2 } }));
});
it('can overwrite existing maps with objects', () => {
const m1 = fromJS({ a: { x: 1, y: 1 } }) as Map<string, any>; // deep conversion.
const m2 = Map({ a: { z: 10 } }); // shallow conversion to Map.
// Raw object simply replaces map.
expect(m1.merge(m2).get('a')).toEqual({ z: 10 }); // raw object.
// However, mergeDeep will merge that value into the inner Map.
expect(m1.mergeDeep(m2).get('a')).toEqual(Map({ x: 1, y: 1, z: 10 }));
});
it('merges map entries with List and Set values', () => {
const initial = Map({
a: Map({ x: 10, y: 20 }),
b: List([1, 2, 3]),
c: Set([1, 2, 3]),
});
const additions = Map({
a: Map({ y: 50, z: 100 }),
b: List([4, 5, 6]),
c: Set([4, 5, 6]),
});
expect(initial.mergeDeep(additions)).toEqual(
Map({
a: Map({ x: 10, y: 50, z: 100 }),
b: List([1, 2, 3, 4, 5, 6]),
c: Set([1, 2, 3, 4, 5, 6]),
})
);
});
it('merges map entries with new values', () => {
const initial = Map({ a: List([1]) });
// Note: merge and mergeDeep do not deeply coerce values, they only merge
// with what's there prior.
expect(initial.merge({ b: [2] } as any)).toEqual(
Map({ a: List([1]), b: [2] })
);
expect(initial.mergeDeep({ b: [2] } as any)).toEqual(
fromJS(Map({ a: List([1]), b: [2] }))
);
});
it('maintains JS values inside immutable collections', () => {
const m1 = fromJS({ a: { b: { imm: 'map' } } }) as Map<string, any>;
const m2 = m1.mergeDeep(Map({ a: Map({ b: { plain: 'obj' } }) }));
expect(m1.getIn(['a', 'b'])).toEqual(Map([['imm', 'map']]));
// However mergeDeep will merge that value into the inner Map
expect(m2.getIn(['a', 'b'])).toEqual(Map({ imm: 'map', plain: 'obj' }));
});
it('merges plain Objects', () => {
expect(merge({ x: 1, y: 1 }, { y: 2, z: 2 }, Map({ z: 3, q: 3 }))).toEqual({
x: 1,
y: 2,
z: 3,
q: 3,
});
});
it('merges plain Arrays', () => {
expect(merge([1, 2], [3, 4], List([5, 6]))).toEqual([1, 2, 3, 4, 5, 6]);
});
it('merging plain Array returns self after no-op', () => {
const a = [1, 2, 3];
expect(merge(a, [], [])).toBe(a);
});
it('merges records with a size property set to 0', () => {
const Sizable = Record({ size: 0 });
expect(Sizable().merge({ size: 123 }).size).toBe(123);
});
it('mergeDeep merges partial conflicts', () => {
const a = fromJS({
ch: [
{
code: 8,
},
],
banana: 'good',
}) as Map<unknown, unknown>;
const b = fromJS({
ch: {
code: 8,
},
apple: 'anti-doctor',
});
expect(
a.mergeDeep(b).equals(
fromJS({
ch: {
code: 8,
},
apple: 'anti-doctor',
banana: 'good',
})
)
).toBe(true);
});
const map = { type: 'Map', value: Map({ b: 5, c: 9 }) };
const object = { type: 'object', value: { b: 7, d: 12 } };
const RecordFactory = Record({ a: 1, b: 2 });
const record = { type: 'Record', value: RecordFactory({ b: 3 }) };
const list = { type: 'List', value: List(['5']) };
const array = { type: 'array', value: ['9'] };
const set = { type: 'Set', value: Set('3') };
const incompatibleTypes = [
[map, list],
[map, array],
[map, set],
[object, list],
[object, array],
[object, set],
[record, list],
[record, array],
[record, set],
[list, set],
];
for (const [
{ type: type1, value: value1 },
{ type: type2, value: value2 },
] of incompatibleTypes) {
it(`mergeDeep and Map#mergeDeep replaces ${type1} and ${type2} with each other`, () => {
const aObject = { a: value1 };
const bObject = { a: value2 };
expect(mergeDeep(aObject, bObject)).toEqual(bObject);
expect(mergeDeep(bObject, aObject)).toEqual(aObject);
const aMap = Map({ a: value1 }) as Map<unknown, unknown>;
const bMap = Map({ a: value2 }) as Map<unknown, unknown>;
expect(aMap.mergeDeep(bMap).equals(bMap)).toBe(true);
expect(bMap.mergeDeep(aMap).equals(aMap)).toBe(true);
});
}
const compatibleTypesAndResult = [
[map, object, Map({ b: 7, c: 9, d: 12 })],
[map, record, Map({ a: 1, b: 3, c: 9 })],
[object, map, { b: 5, c: 9, d: 12 }],
[object, record, { a: 1, b: 3, d: 12 }],
[record, map, RecordFactory({ b: 5 })],
[record, object, RecordFactory({ b: 7 })],
[list, array, List(['5', '9'])],
[array, list, ['9', '5']],
[map, { type: 'Map', value: Map({ b: 7 }) }, Map({ b: 7, c: 9 })],
[object, { type: 'object', value: { d: 3 } }, { b: 7, d: 3 }],
[
record,
{ type: 'Record', value: RecordFactory({ a: 3 }) },
RecordFactory({ a: 3, b: 2 }),
],
[list, { type: 'List', value: List(['12']) }, List(['5', '12'])],
[array, { type: 'array', value: ['3'] }, ['9', '3']],
[set, { type: 'Set', value: Set(['3', '5']) }, Set(['3', '5'])],
] as const;
it('Map#mergeDeep replaces nested List with Map and Map with List', () => {
const a = Map({ a: List([Map({ x: 1 })]) }) as Map<unknown, unknown>;
const b = Map({ a: Map([[0, Map({ y: 2 })]]) }) as Map<unknown, unknown>;
expect(a.mergeDeep(b).equals(b)).toBe(true);
expect(b.mergeDeep(a).equals(a)).toBe(true);
});
it('functional mergeDeep replaces nested array with Map', () => {
const a = { a: [{ x: 1 }] };
const b = Map({ a: Map([[0, Map({ y: 2 })]]) });
expect(mergeDeep(a, b)).toEqual({ a: Map([[0, Map({ y: 2 })]]) });
});
});
|