Skip to content

Commit 5a89487

Browse files
committed
fix(store): fix traversed duplicating keys
fixes solidjs#840
1 parent 10183a0 commit 5a89487

3 files changed

Lines changed: 116 additions & 33 deletions

File tree

‎packages/solid/store/src/server.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,20 @@ export function updatePath(current: any, path: any[], traversed: (number | strin
4040
if (Array.isArray(part)) {
4141
// Ex. update('data', [2, 23], 'label', l => l + ' !!!');
4242
for (let i = 0; i < part.length; i++) {
43-
updatePath(current, [part[i]].concat(path), [part[i]].concat(traversed));
43+
updatePath(current, [part[i]].concat(path), traversed);
4444
}
4545
return;
4646
} else if (isArray && partType === "function") {
4747
// Ex. update('data', i => i.id === 42, 'label', l => l + ' !!!');
4848
for (let i = 0; i < current.length; i++) {
49-
if (part(current[i], i))
50-
updatePath(current, [i].concat(path), ([i] as (number | string)[]).concat(traversed));
49+
if (part(current[i], i)) updatePath(current, [i].concat(path), traversed);
5150
}
5251
return;
5352
} else if (isArray && partType === "object") {
5453
// Ex. update('data', { from: 3, to: 12, by: 2 }, 'label', l => l + ' !!!');
5554
const { from = 0, to = current.length - 1, by = 1 } = part;
5655
for (let i = from; i <= to; i += by) {
57-
updatePath(current, [i].concat(path), ([i] as (number | string)[]).concat(traversed));
56+
updatePath(current, [i].concat(path), traversed);
5857
}
5958
return;
6059
} else if (path.length > 1) {

‎packages/solid/store/src/store.ts‎

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -180,21 +180,20 @@ export function updatePath(current: StoreNode, path: any[], traversed: (keyof an
180180
if (Array.isArray(part)) {
181181
// Ex. update('data', [2, 23], 'label', l => l + ' !!!');
182182
for (let i = 0; i < part.length; i++) {
183-
updatePath(current, [part[i]].concat(path), [part[i]].concat(traversed));
183+
updatePath(current, [part[i]].concat(path), traversed);
184184
}
185185
return;
186186
} else if (isArray && partType === "function") {
187187
// Ex. update('data', i => i.id === 42, 'label', l => l + ' !!!');
188188
for (let i = 0; i < current.length; i++) {
189-
if (part(current[i], i))
190-
updatePath(current, [i].concat(path), [i as keyof any].concat(traversed));
189+
if (part(current[i], i)) updatePath(current, [i].concat(path), traversed);
191190
}
192191
return;
193192
} else if (isArray && partType === "object") {
194193
// Ex. update('data', { from: 3, to: 12, by: 2 }, 'label', l => l + ' !!!');
195194
const { from = 0, to = current.length - 1, by = 1 } = part;
196195
for (let i = from; i <= to; i += by) {
197-
updatePath(current, [i].concat(path), [i as keyof any].concat(traversed));
196+
updatePath(current, [i].concat(path), traversed);
198197
}
199198
return;
200199
} else if (path.length > 1) {
@@ -220,10 +219,24 @@ export type DeepReadonly<T> = {
220219
readonly [K in keyof T]: T[K] extends NotWrappable ? T[K] : DeepReadonly<T[K]>;
221220
};
222221

223-
export type StoreSetter<T> =
222+
type PartToKey<T extends Part<any>> = [T] extends [never]
223+
? never
224+
: T extends keyof any
225+
? T
226+
: T extends (keyof any)[]
227+
? T[number]
228+
: number;
229+
230+
type PartsToKeys<T extends [...Part<any>[]]> = Omit<
231+
{
232+
[I in keyof T]: PartToKey<T[I]>;
233+
},
234+
number
235+
> & { length: T["length"] };
236+
export type StoreSetter<T, U extends Part<any>[]> =
224237
| T
225238
| Partial<T>
226-
| ((prevState: T, traversed?: (keyof any)[]) => Partial<T> | void);
239+
| ((prevState: DeepReadonly<T>, traversed: PartsToKeys<U>) => Partial<DeepReadonly<T>> | void);
227240

228241
export type StorePathRange = { from?: number; to?: number; by?: number };
229242

@@ -252,13 +265,14 @@ export type Next<T, K extends Part<T>> = [K] extends [never]
252265

253266
export type WrappableNext<T, K extends Part<T>> = Exclude<Next<T, K>, NotWrappable>;
254267

255-
type DistributeRest<T, K extends Part<T>> = K extends K ? [K, ...Rest<Next<T, K>>] : never;
256-
export type Rest<T> = 0 extends 1 & T
268+
type DistributeRest<T, U extends Part<any>[], K extends Part<T>> = K extends K
269+
? [K, ...Rest<Next<T, K>, [K, ...U]>]
270+
: never;
271+
export type Rest<T, U extends Part<any>[]> = 0 extends 1 & T
257272
? [...(keyof any)[], any]
258-
: [StoreSetter<T>] | (T extends NotWrappable ? never : DistributeRest<T, Part<T>>);
273+
: [StoreSetter<T, U>] | (T extends NotWrappable ? never : DistributeRest<T, U, Part<T>>);
259274

260-
export type SetStoreFunction<T> = _SetStoreFunction<Store<T>>;
261-
interface _SetStoreFunction<T> {
275+
export interface SetStoreFunction<T> {
262276
<
263277
K1 extends Part<T>,
264278
K2 extends Part<T1>,
@@ -282,7 +296,7 @@ interface _SetStoreFunction<T> {
282296
k6: K6,
283297
k7: K7,
284298
// this cannot infer ArrayFilterFn
285-
...rest: Rest<Next<T6, K7>>
299+
...rest: Rest<Next<T6, K7>, [K7, K6, K5, K4, K3, K2, K1]>
286300
): void;
287301
<
288302
K1 extends Part<T>,
@@ -306,7 +320,7 @@ interface _SetStoreFunction<T> {
306320
k5: K5,
307321
k6: K6,
308322
k7: K7,
309-
setter: StoreSetter<Next<T6, K7>>
323+
setter: StoreSetter<Next<T6, K7>, [K7, K6, K5, K4, K3, K2, K1]>
310324
): void;
311325
<
312326
K1 extends Part<T>,
@@ -327,7 +341,7 @@ interface _SetStoreFunction<T> {
327341
k4: K4,
328342
k5: K5,
329343
k6: K6,
330-
setter: StoreSetter<Next<T5, K6>>
344+
setter: StoreSetter<Next<T5, K6>, [K6, K5, K4, K3, K2, K1]>
331345
): void;
332346
<
333347
K1 extends Part<T>,
@@ -345,7 +359,7 @@ interface _SetStoreFunction<T> {
345359
k3: K3,
346360
k4: K4,
347361
k5: K5,
348-
setter: StoreSetter<Next<T4, K5>>
362+
setter: StoreSetter<Next<T4, K5>, [K5, K4, K3, K2, K1]>
349363
): void;
350364
<
351365
K1 extends Part<T>,
@@ -360,7 +374,7 @@ interface _SetStoreFunction<T> {
360374
k2: K2,
361375
k3: K3,
362376
k4: K4,
363-
setter: StoreSetter<Next<T3, K4>>
377+
setter: StoreSetter<Next<T3, K4>, [K4, K3, K2, K1]>
364378
): void;
365379
<
366380
K1 extends Part<T>,
@@ -372,15 +386,15 @@ interface _SetStoreFunction<T> {
372386
k1: K1,
373387
k2: K2,
374388
k3: K3,
375-
setter: StoreSetter<Next<T2, K3>>
389+
setter: StoreSetter<Next<T2, K3>, [K3, K2, K1]>
376390
): void;
377391
<K1 extends Part<T>, K2 extends Part<T1>, T1 extends WrappableNext<T, K1>>(
378392
k1: K1,
379393
k2: K2,
380-
setter: StoreSetter<Next<T1, K2>>
394+
setter: StoreSetter<Next<T1, K2>, [K2, K1]>
381395
): void;
382-
<K extends Part<T>>(k: K, setter: StoreSetter<Next<T, K>>): void;
383-
(setter: StoreSetter<T>): void;
396+
<K extends Part<T>>(k: K, setter: StoreSetter<Next<T, K>, [K]>): void;
397+
(setter: StoreSetter<T, []>): void;
384398
}
385399

386400
/**

‎packages/solid/store/test/store.spec.ts‎

Lines changed: 79 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,10 @@ describe("Simple setState modes", () => {
8585

8686
test("Top level state function merge", () => {
8787
const [state, setState] = createStore({ starting: 1, ending: 1 });
88-
setState(s => ({ ending: s.starting + 1 }));
88+
setState((s, t) => {
89+
expect(t).toStrictEqual([]);
90+
return { ending: s.starting + 1 };
91+
});
8992
expect(state.starting).toBe(1);
9093
expect(state.ending).toBe(2);
9194
});
@@ -99,7 +102,10 @@ describe("Simple setState modes", () => {
99102

100103
test("Nested state function merge", () => {
101104
const [state, setState] = createStore({ data: { starting: 1, ending: 1 } });
102-
setState("data", d => ({ ending: d.starting + 1 }));
105+
setState("data", (d, t) => {
106+
expect(t).toStrictEqual(["data"]);
107+
return { ending: d.starting + 1 };
108+
});
103109
expect(state.data.starting).toBe(1);
104110
expect(state.data.ending).toBe(2);
105111
});
@@ -122,7 +128,13 @@ describe("Simple setState modes", () => {
122128
describe("Array setState modes", () => {
123129
test("Update Specific", () => {
124130
const [state, setState] = createStore({ rows: [1, 2, 3, 4, 5] });
125-
setState("rows", [1, 3], r => r * 2);
131+
setState("rows", [1, 3], (r, t) => {
132+
// @ts-ignore traversed types are wrong and incomplete
133+
expect(typeof t[0]).toBe("number");
134+
// @ts-ignore
135+
expect(t[1]).toBe("rows");
136+
return r * 2;
137+
});
126138
expect(state.rows[0]).toBe(1);
127139
expect(state.rows[1]).toBe(4);
128140
expect(state.rows[2]).toBe(3);
@@ -135,7 +147,13 @@ describe("Array setState modes", () => {
135147
setState(
136148
"rows",
137149
(r, i) => Boolean(i % 2),
138-
r => r * 2
150+
(r, t) => {
151+
// @ts-ignore
152+
expect(typeof t[0]).toBe("number");
153+
// @ts-ignore
154+
expect(t[1]).toBe("rows");
155+
return r * 2;
156+
}
139157
);
140158
expect(state.rows[0]).toBe(1);
141159
expect(state.rows[1]).toBe(4);
@@ -145,7 +163,13 @@ describe("Array setState modes", () => {
145163
});
146164
test("Update traversal range", () => {
147165
const [state, setState] = createStore({ rows: [1, 2, 3, 4, 5] });
148-
setState("rows", { from: 1, to: 4, by: 2 }, r => r * 2);
166+
setState("rows", { from: 1, to: 4, by: 2 }, (r, t) => {
167+
// @ts-ignore
168+
expect(typeof t[0]).toBe("number");
169+
// @ts-ignore
170+
expect(t[1]).toBe("rows");
171+
return r * 2;
172+
});
149173
expect(state.rows[0]).toBe(1);
150174
expect(state.rows[1]).toBe(4);
151175
expect(state.rows[2]).toBe(3);
@@ -154,7 +178,13 @@ describe("Array setState modes", () => {
154178
});
155179
test("Update traversal range defaults", () => {
156180
const [state, setState] = createStore({ rows: [1, 2, 3, 4, 5] });
157-
setState("rows", {}, r => r * 2);
181+
setState("rows", {}, (r, t) => {
182+
// @ts-ignore
183+
expect(typeof t[0]).toBe("number");
184+
// @ts-ignore
185+
expect(t[1]).toBe("rows");
186+
return r * 2;
187+
});
158188
expect(state.rows[0]).toBe(2);
159189
expect(state.rows[1]).toBe(4);
160190
expect(state.rows[2]).toBe(6);
@@ -524,14 +554,54 @@ describe("Nested Classes", () => {
524554
setStore("list", [2, 3], 4);
525555
};
526556

557+
// traversed contains the correct types of keys
558+
() => {
559+
const [, setStore] = createStore({ a: [{ b: 1 }] });
560+
setStore((v, t) => {
561+
const expectedT: [] = t;
562+
t = [] as [];
563+
});
564+
setStore("a", (v, t) => {
565+
const expectedT: ["a"] = t;
566+
t = ["a"];
567+
});
568+
setStore("a", 0, (v, t) => {
569+
const expectedT: [0, "a"] = t;
570+
t = [0, "a"];
571+
});
572+
// array of keys
573+
setStore(["a"], [0], (v, t) => {
574+
const expectedT: [number, "a"] = t;
575+
t = [0, "a"];
576+
});
577+
// callback
578+
setStore(
579+
["a"],
580+
() => true,
581+
(v, t) => {
582+
const expectedT: [number, "a"] = t;
583+
t = [0, "a"];
584+
}
585+
);
586+
// { from, to, by }
587+
setStore(["a"], {}, (v, t) => {
588+
const expectedT: [number, "a"] = t;
589+
t = [0, "a"];
590+
});
591+
};
592+
527593
// fallback overload correctly infers keys and setter
528594
() => {
529595
const [, setStore] = createStore({
530596
a: { b: { c: { d: { e: { f: { g: { h: { i: { j: { k: 1 } } } } } } } } } }
531597
});
532-
setStore("a", "b", "c", "d", "e", "f", "g", "h", "i", "j", v => ({
533-
k: 2
534-
}));
598+
setStore("a", "b", "c", "d", "e", "f", "g", "h", "i", "j", (v, t) => {
599+
const expectedT: ["j", "i", "h", "g", "f", "e", "d", "c", "b", "a"] = t;
600+
t = ["j", "i", "h", "g", "f", "e", "d", "c", "b", "a"];
601+
return {
602+
k: 2
603+
};
604+
});
535605
};
536606

537607
// tuples are correctly typed

0 commit comments

Comments
 (0)